Appearance
VideoPlayOptions
Package: @erinjs/voice
Options for video playback via {@link LiveKitRtcConnection.playVideo}.
Properties
| Name | Type | Readonly | Optional | Description |
|---|---|---|---|---|
height | number | No | Yes | Output height for resolution override (FFmpeg path). |
loop | boolean | No | Yes | Loop video to keep stream continuously live (default: true). |
maxFramerate | number | No | Yes | Max framerate for encoding (default: 60). |
resolution | "480p" | "720p" | "1080p" | "1440p" | "4k" | No | Yes | Output resolution. When set, overrides width/height and maxFramerate. FFmpeg path only. |
source | "camera" | "screenshare" | No | Yes | Track source hint - camera or screenshare (default: camera). |
useFFmpeg | boolean | No | Yes | Use FFmpeg for decoding (avoids node-webcodecs; requires ffmpeg in PATH). |
videoBitrate | number | No | Yes | Max video bitrate in bps for encoding (default: 2_500_000). |
width | number | No | Yes | Output width for resolution override (FFmpeg path). |