RoomOptions class

Options used to modify the behavior of the Room.

Constructors

RoomOptions({CameraCaptureOptions defaultCameraCaptureOptions = const CameraCaptureOptions(), ScreenShareCaptureOptions defaultScreenShareCaptureOptions = const ScreenShareCaptureOptions(), AudioCaptureOptions defaultAudioCaptureOptions = const AudioCaptureOptions(), VideoPublishOptions defaultVideoPublishOptions = const VideoPublishOptions(), AudioPublishOptions defaultAudioPublishOptions = const AudioPublishOptions(), AudioOutputOptions defaultAudioOutputOptions = const AudioOutputOptions(), bool adaptiveStream = false, bool dynacast = false, bool stopLocalTrackOnUnpublish = true, E2EEOptions? e2eeOptions})
const

Properties

adaptiveStream → bool
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.
final
defaultAudioCaptureOptions → AudioCaptureOptions
Default options used when capturing video for a LocalAudioTrack.
final
defaultAudioOutputOptions → AudioOutputOptions
final
defaultAudioPublishOptions → AudioPublishOptions
Default options used when publishing a LocalAudioTrack.
final
defaultCameraCaptureOptions → CameraCaptureOptions
Default options used for LocalVideoTrack.createCameraTrack.
final
defaultScreenShareCaptureOptions → ScreenShareCaptureOptions
Default options used for LocalVideoTrack.createScreenShareTrack.
final
defaultVideoPublishOptions → VideoPublishOptions
Default options used when publishing a LocalVideoTrack.
final
dynacast → bool
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
final
e2eeOptions → E2EEOptions?
Options for end-to-end encryption.
final
hashCode → int
The hash code for this object.
read-onlyinherited
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
stopLocalTrackOnUnpublish → bool
Set this to false in case you would like to stop the track yourself. If you set this to false, make sure you call Track.stop. Defaults to true.
final

Methods

copyWith({CameraCaptureOptions? defaultCameraCaptureOptions, ScreenShareCaptureOptions? defaultScreenShareCaptureOptions, AudioCaptureOptions? defaultAudioCaptureOptions, VideoPublishOptions? defaultVideoPublishOptions, AudioPublishOptions? defaultAudioPublishOptions, AudioOutputOptions? defaultAudioOutputOptions, bool? adaptiveStream, bool? dynacast, bool? stopLocalTrackOnUnpublish, E2EEOptions? e2eeOptions}) → RoomOptions
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited