Options
All
  • Public
  • Public/Protected
  • All
Menu

if video or audio tracks are created as part of connect, it'll automatically publish those tracks to the room.

Hierarchy

Index

Properties

Optional adaptiveStream

adaptiveStream: boolean | AdaptiveStreamSettings

Optional audio

audio: boolean

capture and publish audio track on connect, defaults to false

If this option is used, you will not be notified if user denies capture permission.

Optional audioCaptureDefaults

audioCaptureDefaults: AudioCaptureOptions

default options to use when capturing user's audio

Optional autoManageVideo

autoManageVideo: boolean

alias for adaptiveStream

deprecated

Optional autoSubscribe

autoSubscribe: boolean

autosubscribe to room tracks upon connect, defaults to true

Optional dynacast

dynacast: boolean

Optional iceServers

iceServers: RTCIceServer[]

set ICE servers. When deployed correctly, LiveKit automatically uses the built-in TURN servers

Optional logLevel

logLevel: LogLevel | LogLevelDesc

configures LiveKit internal log level

Optional publishDefaults

publishDefaults: TrackPublishDefaults

default options to use when publishing tracks

Optional rtcConfig

rtcConfig: RTCConfiguration

use to override any RTCConfiguration options.

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 video

video: boolean

capture and publish video track on connect, defaults to false

If this option is used, you will not be notified if user denies capture permission.

Optional videoCaptureDefaults

videoCaptureDefaults: VideoCaptureOptions

default options to use when capturing user's video

Generated using TypeDoc