Option

data class Option

The Option class contains options for the Subscriber instance.

Properties

Link copied to clipboard

The strategy for managing degradation in audio and video quality to limit bandwidth usage.

Link copied to clipboard
val disableAudio: Boolean = false

A boolean option that determines whether audio playback should be completely disabled. Disabling unnecessary audio helps reduce audio-to-video synchronization delays.

Link copied to clipboard
val dtx: Boolean = false

Enables Discontinuous Transmission (DTX) on the publishing side to send audio only when a user’s voice is detected.

Link copied to clipboard

The list of source identifiers that should be excluded from playback.

Link copied to clipboard

Removes any playout delay on the media server sender side, minimizing the playout delay as much as possible.

Link copied to clipboard

The number of multiplexed audio tracks.

Link copied to clipboard
val pinnedSourceId: String? = null

A specific source to pin to prioritize its audio and video tracks for playback.

Link copied to clipboard

The file path for storing Real-Time Communication (RTC) event logs. Using this option requires having the rights upon the destination file path.

Link copied to clipboard
val statsDelayMs: Int = 1000

The delay for collecting and reporting statistical information, in milliseconds.

Link copied to clipboard
val stereo: Boolean = true

A boolean option that determines whether stereo audio playback should be enabled or disabled.

Link copied to clipboard

The minimum video jitter buffer delay for video playback, in milliseconds.

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Compares the contents of the Option objects with another.

Link copied to clipboard
open override fun hashCode(): Int

Returns the hash code of the contents of the Option class.