Interface

VideoPlayOptions

Options for video playback via LiveKitRtcConnection.

Properties

height?: number

Output height for resolution override (FFmpeg path).

loop?: boolean

Loop video to keep stream continuously live (default: true).

maxFramerate?: number

Max framerate for encoding (default: 60).

resolution?: '' | '' | '' | '' | ''

Output resolution. When set, overrides width/height and maxFramerate. FFmpeg path only.

source?: 'camera' | 'screenshare'

Track source hint - camera or screenshare (default: camera).

useFFmpeg?: boolean

Use FFmpeg for decoding (avoids node-webcodecs; requires ffmpeg in PATH).

videoBitrate?: number

Max video bitrate in bps for encoding (default: 2_500_000).

width?: number

Output width for resolution override (FFmpeg path).