Repository navigation
integrate livekit capture source-clock and source-pattern #274
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| data/welcome.wav filter=lfs diff=lfs merge=lfs -text | ||
| build.cmd whitespace=cr-at-eol | ||
| CMakePresets.json whitespace=cr-at-eol |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # Built-in capture sources | ||
|
|
||
| `CaptureSource` connects a Rust video producer to a regular C++ `VideoSource`. | ||
| Pattern and clock sources render offscreen on the GPU. Their frames stay in | ||
| Rust until they enter the WebRTC video source, so C++ does not send one FFI | ||
| request per frame. | ||
|
|
||
| The pattern source offers `Pattern::Gradient` and `Pattern::Logo`. The clock | ||
| source displays the local time with millisecond precision. | ||
|
|
||
| Only the repository's `*-tests` and `*-all` build presets enable | ||
| `LIVEKIT_ENABLE_CAPTURE`. Other presets and custom CMake configurations must set | ||
| `-DLIVEKIT_ENABLE_CAPTURE=ON`; otherwise source creation fails. A GPU adapter must be available at runtime. | ||
|
|
||
| Create a source, publish its video source as a local track, and start capture | ||
| after publication: | ||
|
|
||
| ```cpp | ||
| #include <livekit/livekit.h> | ||
|
|
||
| auto capture = livekit::CaptureSource::create( | ||
| livekit::PatternVideoSourceConfig{{1280, 720}, 30, livekit::Pattern::Gradient}).get(); | ||
| // For a local wall clock, use: | ||
| // livekit::CaptureSource::create(livekit::ClockVideoSourceConfig{{1280, 720}, 30}).get(); | ||
|
|
||
| auto track = livekit::LocalVideoTrack::createLocalVideoTrack("capture", capture->videoSource()); | ||
| auto participant = room.localParticipant().lock(); | ||
| participant->publishTrack(track, capture->publishOptions()); | ||
|
|
||
| capture->setOnFinishedCallback([](const livekit::CaptureResult& result) { | ||
| // Runs on the FFI callback thread. Hand work to another thread if it blocks. | ||
| }); | ||
| if (!capture->start()) { | ||
| // Handle the start failure. | ||
| } | ||
| ``` | ||
|
|
||
| The example assumes `room` is connected and the SDK is initialized. Keep | ||
| `capture` alive while its track is published. Call `stop()` to finish capture; | ||
| the callback reports the exit reason and number of captured frames. Destroying | ||
| the source also stops capture. The clock displays the local time of the machine | ||
| running the Rust FFI. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔴 Release bundles cannot create capture sources
Official release builds leave
LIVEKIT_ENABLE_CAPTUREoff, soCaptureSource::createcannot create either built-in source. The release workflow uses release-examples, not the capture-enabled test presets.Learn more
The public capture factories are always compiled, but the Rust implementation is gated by this CMake option. The official release workflow builds using the release-examples preset, which does not enable it. Consumers of a clean release bundle therefore cannot use either advertised source.
Example: A release built through
./build.sh release-examples --bundleincludesCaptureSource::create, but awaiting a pattern-source creation future fails because the Rust FFI was built withoutcapture-pattern.Recommended fix: Enable the capture features in release and example presets, including the presets used by
.github/workflows/make-release.ymland.github/workflows/builds.yml, or make capture support the default while explicitly allowing opt-out.Was this helpful? React with 👍 or 👎 to provide feedback.