atmoky Engage Server SDK is now available! Check out the documentation to learn more.
API Reference
Interfaces
TrackPublishOptions

TrackPublishOptions

Options when publishing tracks

Interface

audioBitrate

optional
max audio bitrate, defaults to
Type
number

backupCodec

optional
Type
undefined | { codec: undefined | undefined, encoding: VideoEncoding }

dtx

optional
dtx (Discontinuous Transmission of audio), enabled by default for mono tracks.
Type
boolean

forceStereo

optional
stereo audio track. defaults determined by capture channel count.
Type
boolean

name

optional
set a track name
Type
string

red

optional
red (Redundant Audio Data), enabled by default for mono tracks.
Type
boolean

scalabilityMode

optional
scalability mode for svc codecs, defaults to 'L3T3'. for svc codecs, simulcast is disabled.
Type
undefined

screenShareEncoding

optional
encoding parameters for screen share track

screenShareSimulcastLayers

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

simulcast

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

source

optional
Source of track, camera, microphone, or screen

stopMicTrackOnMute

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.
defaults to false
Type
boolean

videoCodec

optional
codec, defaults to vp8; for svc codecs, auto enable vp8 as backup. (TBD)
Type
undefined | undefined | undefined | undefined

videoEncoding

optional
encoding parameters for camera track

videoSimulcastLayers

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

atmoky Logo

© 2024 atmoky, GmbH.
All rights reserved.

We use cookies to measure and improve your browsing experience, and serve personalized ads or content.