AdaptiveStream lets LiveKit automatically manage quality of subscribed video tracks to optimize for bandwidth and CPU. When attached video elements are visible, it'll choose an appropriate resolution based on the size of largest video element it's attached to.
When none of the video elements are visible, it'll temporarily pause the data flow until they are visible again.
Optionalaudiodefault options to use when capturing user's audio
Optionalaudioaudio output for the room
OptionaldataOptions controlling data stream behavior for this room.
specifies whether the sdk should automatically disconnect the room on 'pagehide' and 'beforeunload' events
enable Dynacast, off by default. With Dynacast dynamically pauses video layers that are not being consumed by any subscribers, significantly reducing publishing CPU and bandwidth usage.
Dynacast will be enabled if SVC codecs (VP9/AV1) are used. Multi-codec simulcast requires dynacast
Optionale2eeOptional ExperimentalencryptionOptions for enabling end-to-end encryption.
Optional ExperimentalframeOptions for enabling frame metadata on video tracks. Frame metadata carries frame-level information such as user timestamps and frame IDs.
OptionalloggerOptionalpacketUse InternalRoomOptions.frameMetadata instead.
Optionalpublishdefault options to use when publishing tracks
policy to use when attempting to reconnect
will attempt to connect via single peer connection mode. falls back to dual peer connection mode if not available.
should local tracks be stopped when they are unpublished. defaults to true set this to false if you would prefer to clean up unpublished local tracks manually.
Optionalvideodefault options to use when capturing user's video
mix all audio tracks in web audio, helps to tackle some audio auto playback issues allows for passing in your own AudioContext instance, too
The resolved room options.
RoomOptionsis the partial form apps pass in.