Skip to content

Commit

Permalink
Document potential pitfall when creating LocalVideoTrack manually. (#556
Browse files Browse the repository at this point in the history
)
  • Loading branch information
davidliu authored Dec 12, 2024
1 parent dcbb36b commit d5464db
Showing 1 changed file with 5 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,11 @@ internal constructor(
/**
* Creates a video track, recording video through the camera with the given [options].
*
* Note: If using this in conjunction with [setCameraEnabled], ensure that your created
* camera track is published first before using [setCameraEnabled]. Otherwise, the LiveKit
* SDK will attempt to create its own camera track to manage, and will cause issues since
* generally only one camera session can be active at a time.
*
* @param name The name of the track
* @param options The capture options to use for this track, or [Room.videoTrackCaptureDefaults] if none is passed.
* @param videoProcessor A video processor to attach to this track that can modify the frames before publishing.
Expand Down

0 comments on commit d5464db

Please sign in to comment.