Option

data class Option

The Option class gathers customizable options for a stream.

Properties

Link copied to clipboard
val audioCodec: String? = null

The audio codec to use. By default, the SDK uses Opus.

Link copied to clipboard

The bitrate settings for publishing streams.

Link copied to clipboard

A boolean indicating which strategy the use in order to limit the bandwidth usage.

Link copied to clipboard
val dtx: Boolean = false

Enables discontinuous transmission on the publishing side, so audio data is sent only when a user’s voice is detected.

Link copied to clipboard
val priority: Int? = null

The priority of redundant streams that indicates the order in which backup streams should be broadcasted in the case of any problems with the primary stream. The higher the priority, the greater the chance of publishing the stream. The priority has to be an integer between -2,147,483,648 and 2,147,483,647 (inclusive).

Link copied to clipboard
val recordStream: Boolean = false

A boolean indicating whether the SDK should enable stream recording. Recording streams is possible only when recording is enabled in the publish token.

Link copied to clipboard

A custom file path output for the RTC events. The current calling application must have the rights upon the destination file path.

Link copied to clipboard
val sourceId: String? = null

A unique identifier of a source that is required to distinguish multiple quality layers of video sources.

Link copied to clipboard
val statsDelayMs: Int = 1000

The rate at which you want to receive reports with statistics.

Link copied to clipboard
val stereo: Boolean = true

A boolean indicating whether the SDK should enable stereo audio. True enables stereo, false disables it.

Link copied to clipboard
val videoCodec: String? = null

The video codec to use. By default, the SDK uses VP8.