Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions examples/local_video/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ For smoother local rendering, especially above 720p, run the publisher/subscribe

- list_devices: enumerate available cameras and their capabilities
- publisher: capture from a selected camera and publish a video track
- subscriber: connect to a room, subscribe to video tracks, and display in a window
- subscriber: connect to a room, subscribe to video tracks, and display each track in its own window

LiveKit connection can be provided via flags or environment variables:
- `--url` or `LIVEKIT_URL`
Expand Down Expand Up @@ -137,6 +137,8 @@ Subscriber flags (in addition to the common connection flags above):
- `--e2ee-key <key>`: Enable end-to-end decryption with the given shared key. Must match the key used by the publisher.

Notes:
- If the active video track is unsubscribed or unpublished, the app clears its state and will automatically attach to the next matching video track when it appears.
- The subscriber opens a separate window for every video track it is subscribed to. A small status panel in the main window shows the room, identity, filter, and the list of currently-displayed tracks.
- Closing a track's window unsubscribes from that publication. The window reappears automatically if the publisher republishes the track (or publishes a new one) and it still matches the optional `--participant` filter.
- If the active video track is unsubscribed or unpublished, its window is closed automatically.
- For E2EE to work, both publisher and subscriber must specify the same `--e2ee-key` value. If the keys don't match, the subscriber will not be able to decode the video.
- The timestamp overlay updates at ~2 Hz so the latency value is readable rather than flickering every frame.
Loading
Loading