Options
All
  • Public
  • Public/Protected
  • All
Menu

Options for when creating a new room

Hierarchy

  • RoomOptions

Index

Properties

Optional adaptiveStream

adaptiveStream: boolean | AdaptiveStreamSettings

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.

Optional audioCaptureDefaults

audioCaptureDefaults: AudioCaptureOptions

default options to use when capturing user's audio

Optional dynacast

dynacast: boolean

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.

Optional publishDefaults

publishDefaults: TrackPublishDefaults

default options to use when publishing tracks

Optional stopLocalTrackOnUnpublish

stopLocalTrackOnUnpublish: boolean

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.

Optional videoCaptureDefaults

videoCaptureDefaults: VideoCaptureOptions

default options to use when capturing user's video

Generated using TypeDoc