BitrateSettings

data class BitrateSettings

The BitrateSettings class allows customizing bitrate settings for publishing streams. Setting the minimum bitrate to a high value can result in inconsistent streams, especially considering network bandwidth limitations.

Properties

Link copied to clipboard
val disableBWE: Boolean = false

Disables the built-in bandwidth estimation algorithm to allow sending the maximum bitrate without any congestion control. When using this option, set the bitrate using the maxBitrateKbps option to force the implementation to consistently send data at that bitrate, irrespective of network bandwidth. Use this method only if you know your network can handle the bitrate you set.

Link copied to clipboard
val maxBitrateKbps: Int? = null

Sets the maximum bitrate for the publisher, in kilobits per second. The publisher's bitrate will attempt to always reach this value unless restricted by the publisher's available outbound bitrate. The default value is set to 2500 kbps.

Link copied to clipboard
val minBitrateKbps: Int? = null

Sets the minimum bitrate for the publisher, in kilobits per second. If the available outbound bitrate for the publisher is smaller than the defined value, the stream might not be able to attain that minimum bitrate, potentially resulting in choppy playback. The default value is set to 0 kbps.