TrackPublishOptions
Options when publishing tracks
Interface
audioBitrate
optional
max audio bitrate, defaults to
max audio bitrate, defaults to
Type
numberbackupCodec
optional
Type
undefined | { codec: undefined | undefined, encoding: VideoEncoding }dtx
optional
dtx (Discontinuous Transmission of audio), enabled by default for mono tracks.
dtx (Discontinuous Transmission of audio), enabled by default for mono tracks.
Type
booleanforceStereo
optional
stereo audio track. defaults determined by capture channel count.
stereo audio track. defaults determined by capture channel count.
Type
booleanname
optional
set a track name
set a track name
Type
stringred
optional
red (Redundant Audio Data), enabled by default for mono tracks.
red (Redundant Audio Data), enabled by default for mono tracks.
Type
booleanscalabilityMode
optional
scalability mode for svc codecs, defaults to 'L3T3'. for svc codecs, simulcast is disabled.
scalability mode for svc codecs, defaults to 'L3T3'. for svc codecs, simulcast is disabled.
Type
undefinedscreenShareEncoding
optional
encoding parameters for screen share track
encoding parameters for screen share track
Type
VideoEncodingscreenShareSimulcastLayers
optional
custom video simulcast layers for screen tracks Note: the layers need to be ordered from lowest to highest quality
custom video simulcast layers for screen tracks Note: the layers need to be ordered from lowest to highest quality
Type
VideoPreset[]simulcast
optional
use simulcast, defaults to true. When using simulcast, LiveKit will publish up to three versions of the stream at various resolutions.
use simulcast, defaults to true. When using simulcast, LiveKit will publish up to three versions of the stream at various resolutions.
Type
booleansource
optional
Source of track, camera, microphone, or screen
Source of track, camera, microphone, or screen
Type
Track.SourcestopMicTrackOnMute
optional
For local tracks, stop the underlying MediaStreamTrack when the track is muted (or paused) on some platforms, this option is necessary to disable the microphone recording indicator. Note: when this is enabled, and BT devices are connected, they will transition between profiles (e.g. HFP to A2DP) and there will be an audible difference in playback.
For local tracks, stop the underlying MediaStreamTrack when the track is muted (or paused) on some platforms, this option is necessary to disable the microphone recording indicator. Note: when this is enabled, and BT devices are connected, they will transition between profiles (e.g. HFP to A2DP) and there will be an audible difference in playback.
defaults to false
Type
booleanvideoCodec
optional
codec, defaults to vp8; for svc codecs, auto enable vp8 as backup. (TBD)
codec, defaults to vp8; for svc codecs, auto enable vp8 as backup. (TBD)
Type
undefined | undefined | undefined | undefinedvideoEncoding
optional
encoding parameters for camera track
encoding parameters for camera track
Type
VideoEncodingvideoSimulcastLayers
optional
custom video simulcast layers for camera tracks, defaults to h180, h360 You can specify up to two custom layers that will be used instead of the LiveKit default layers. Note: the layers need to be ordered from lowest to highest quality
custom video simulcast layers for camera tracks, defaults to h180, h360 You can specify up to two custom layers that will be used instead of the LiveKit default layers. Note: the layers need to be ordered from lowest to highest quality
Type
VideoPreset[]