AudioTrackPublishOptions

data class AudioTrackPublishOptions(val name: String? = null, val audioBitrate: Int? = null, val dtx: Boolean = true, val red: Boolean = true, val source: Track.Source? = null, val stream: String? = null, val preconnect: Boolean = false) : BaseAudioTrackPublishOptions, TrackPublishOptions

Options for publishing an audio track.

Constructors

Link copied to clipboard
constructor(name: String? = null, base: BaseAudioTrackPublishOptions, source: Track.Source? = null, stream: String? = null)
constructor(name: String? = null, audioBitrate: Int? = null, dtx: Boolean = true, red: Boolean = true, source: Track.Source? = null, stream: String? = null, preconnect: Boolean = false)

Properties

Link copied to clipboard
open override val audioBitrate: Int? = null

The target audioBitrate to use.

Link copied to clipboard
open override val dtx: Boolean = true

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

Link copied to clipboard
open override val name: String? = null

The name of the track.

Link copied to clipboard
open override val preconnect: Boolean = false

preconnect buffer, starts the audio track and buffers it prior to connection, in order to send it to agents that connect afterwards. Improves perceived connection time.

Link copied to clipboard
open override val red: Boolean = true

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

Link copied to clipboard
open override val source: Track.Source? = null

The source of a track, camera, microphone or screen.

Link copied to clipboard
open override val stream: String? = null

The stream name for the track. Audio and video tracks with the same stream name will be placed in the same MediaStream and offer better synchronization.