Add SDK Overview and Camera Stream Behavior and ICaptureFactory docs #106
Conversation
PhotonLabs-VR
changed the title
dfgHiatus
added
documentation
dfgHiatus
left a comment
dfgHiatus
left a comment
There was a problem hiding this comment.
Please omit the contents of your .vs, .yarn directories, as well as your .yarnrc.yml file. Thanks!
|
|
||
| # Overview of Baballonia SDK | ||
|
|
||
| The Baballonia SDK provides developers with the tools and interfaces necessary to integrate eye-tracking and face-tracking capabilities into their applications. This SDK is designed to work seamlessly with the Baballonia software, allowing for easy access to processed tracking data and raw camera streams. |
There was a problem hiding this comment.
While this statement isn't entirely false, it also isn't entirely true - the SDK exists to give developers the ability to add their own camera captures.
Say, you had an analog video source and you wanted to feed in into Baballonia. You would use the SDK for this.
| - Allows developers to safely produce and consume frames across multiple threads | ||
| ::: | ||
|
|
||
| This makes it possible for Baballonia to support: |
There was a problem hiding this comment.
| This makes it possible for Baballonia to support: | |
| Baballonia currently supports: |
|
|
||
| ### **2. Capture Factories (Plugin System)** | ||
|
|
||
| The SDK includes the `ICaptureFactory` interface, which allows developers to create custom camera capture sources as plugins. By implementing this interface, developers can define how their specific camera hardware integrates with the Baballonia application. |
There was a problem hiding this comment.
It would make more sense to introduce the Capture and ICaptureFactory together - one cannot exist without the other.
|
|
||
| Baballonia's core application queries all registered factories to determine which one can handle a given camera address. | ||
|
|
||
| This plugin-based structure lets you extend Baballonia with new device support **without modifying the main application**. |
There was a problem hiding this comment.
nit
| This plugin-based structure lets you extend Baballonia with new device support **without modifying the main application**. | |
| This plugin-based structure lets you extend Baballonia with new device support _without modifying the main application_. |
| - V4L2 devices on Linux | ||
| - Custom or experimental capture sources | ||
|
|
||
| <h3><b><i>All through the same interface.</i></b></h3> |
There was a problem hiding this comment.
nit
| <h3><b><i>All through the same interface.</i></b></h3> | |
| _All through the same interface._ |
|
|
||
| --- | ||
|
|
||
| ### **5. Software Extensibility** |
There was a problem hiding this comment.
I feel like this is a rehash of what has been already said? At this point as well we ought to provide a minimal example, say a Capture that grabs frames from Random Data, or an oscillating black/white frame.
|
|
||
| ### **Summary** | ||
|
|
||
| The Baballonia SDK provides a robust foundation for camera capture, frame handling, and tracking integration. Its abstraction layers and plugin-friendly architecture make it easy to extend Baballonia with new devices, add custom processing, or integrate tracking data into external applications. |
There was a problem hiding this comment.
Same here, this summary feels redundant.
| @@ -0,0 +1,19 @@ | |||
| --- | |||
There was a problem hiding this comment.
Delete this file, this has already been explained above and can be condensed.
| @@ -0,0 +1,53 @@ | |||
| --- | |||
There was a problem hiding this comment.
Delete this file, this has already been explained above and can be condensed.
|
Updated Fork |
2 participants
No description provided.