RoomOptions
Options for when creating a new room
Interface
adaptiveStream
optional
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.
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.
audioCaptureDefaults
optional
default options to use when capturing user's audio
default options to use when capturing user's audio
Type
AudioCaptureOptionsdisconnectOnPageLeave
optional
specifies whether the sdk should automatically disconnect the room on 'pagehide' and 'beforeunload' events
specifies whether the sdk should automatically disconnect the room on 'pagehide' and 'beforeunload' events
Type
booleandynacast
optional
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.
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.
Type
booleanpublishDefaults
optional
default options to use when publishing tracks
default options to use when publishing tracks
Type
TrackPublishDefaultsreconnectPolicy
optional
policy to use when attempting to reconnect
policy to use when attempting to reconnect
Type
ReconnectPolicystopLocalTrackOnUnpublish
optional
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.
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.
Type
booleanvideoCaptureDefaults
optional
default options to use when capturing user's video
default options to use when capturing user's video
Type
VideoCaptureOptions