Skip to content

Commit e45d01e

Browse files
committed
Update SDK overview and restore Capture/Factory pages
1 parent a74cb97 commit e45d01e

File tree

3 files changed

+14228
-18848
lines changed

3 files changed

+14228
-18848
lines changed

.yarn/install-state.gz

-40.4 KB
Binary file not shown.

docs/software/SDK/Baballonia Overview.mdx

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,13 @@ sidebar_position: 1
77

88
The Baballonia SDK provides developers with the tools and interfaces necessary to integrate eye-tracking and face-tracking capabilities into applications. It works seamlessly with the Baballonia desktop software, giving access to processed tracking data as well as raw camera streams.
99

10-
With the SDK, developers can build custom plugins, implement new capture sources, and develop integrations inside the Baballonia application—without modifying the core codebase.
11-
1210
---
1311

1412
## SDK Components
1513

16-
### 1. `Capture` Class
14+
### 1. [`Capture` Class](./Camera%20Stream%20Behavior.mdx)
1715

18-
`Capture` provides the framework that lets developers create their own camera capture sources. By extending the `Capture` class, you define exactly how your camera behaves and how it provides frames to Baballonia.
16+
`Capture` provides the framework that lets developers create their own camera capture sources. By extending the `Capture` class, you define how your camera behaves and how it provides frames to Baballonia.
1917

2018
Baballonia currently supports:
2119

@@ -26,18 +24,14 @@ Baballonia currently supports:
2624
- V4L2 devices on Linux
2725
- Custom or experimental capture sources
2826

29-
This system allows all of these devices to work through a unified interface inside of Baballonia.
30-
3127
---
3228

33-
### 2. `ICaptureFactory` Interface
29+
### 2. [`ICaptureFactory` Interface](./ICaptureFactory.mdx)
3430

3531
Every custom camera backend must provide a corresponding `ICaptureFactory`. A factory tells Baballonia:
3632

3733
- Whether it can connect to a given camera address (`CanConnect`)
3834
- How to construct the correct `Capture` implementation (`Create`)
3935
- What provider name should appear in the UI and logs (`GetProviderName`)
4036

41-
Baballonia never instantiates `Capture` classes directly.
42-
43-
The capture system and the `ICaptureFactory` are inseparable: a `Capture` implementation cannot function without a corresponding factory, and a factory has no purpose without a `Capture` implementation.
37+
The capture system and the factory work together: a `Capture` implementation requires an `ICaptureFactory`, and a factory has no purpose without its corresponding `Capture` implementation.

0 commit comments

Comments
 (0)