Options
All
  • Public
  • Public/Protected
  • All
Menu

Options when publishing tracks

Hierarchy

Index

Properties

Optional audioBitrate

audioBitrate: number

max audio bitrate, defaults to AudioPresets.speech

Optional dtx

dtx: boolean

dtx (Discontinuous Transmission of audio), defaults to true

Optional name

name: string

set a track name

Optional screenShareEncoding

screenShareEncoding: VideoEncoding

encoding parameters for screen share track

Optional screenShareSimulcastLayers

screenShareSimulcastLayers: VideoPreset[]

custom video simulcast layers for screen tracks Note: the layers need to be ordered from lowest to highest quality

Optional simulcast

simulcast: boolean

use simulcast, defaults to true. When using simulcast, LiveKit will publish up to three versions of the stream at various resolutions.

Optional source

source: Source

Source of track, camera, microphone, or screen

Optional stopMicTrackOnMute

stopMicTrackOnMute: boolean

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

Optional videoCodec

videoCodec: VideoCodec

codec, defaults to vp8

Optional videoEncoding

videoEncoding: VideoEncoding

encoding parameters for camera track

Optional videoSimulcastLayers

videoSimulcastLayers: VideoPreset[]

custom video simulcast layers for camera tracks, defaults to h180, h360, h540 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

Generated using TypeDoc