RTCRtpEncodingParameters.maxBitrate

The RTCRtpEncodingParameters dictionary's maxBitrate property specifies the maximum number of bits per second to allow a track encoded with this encoding to use.

Syntax

rtpEncodingParameters.maxBitrate = maxBitsPerSecond;

rtpEncodingParameters = {
  maxBitrate: maxBitsPerSecond
};

maxBitsPerSecond = rtpEncodingParameters.maxBitrate;

Value

An unsigned long integer value specifying the maximum bandwidth this encoding is permitted to use for a track of media it encodes in terms of bits per second. Other parameters may further reduce the bandwidth used by the track; for example, maxFramerate will, if set low enough, constrain the bandwidth as well.

In addition, there's no guarantee that the network interface can support the specified bandwidth, in which case the actual bandwidth will be lower.

This value is computed using the standard Transport Independent Application Specific Maximum (TIAS) bandwidth as defined by RFC 3890, section 6.2.2; this is the maximum bandwidth needed without considering protocol overheads from IP, TCP or UDP, and so forth.

Specifications

Specification Status Comment
WebRTC 1.0: Real-time Communication Between Browsers
The definition of 'RTCRtpEncodingParameters.maxBitrate' in that specification.
Candidate Recommendation Initial definition.

Browser compatibility

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
maxBitrateChrome Full support 67Edge Full support ≤79Firefox Full support 46IE No support NoOpera ? Safari ? WebView Android Full support 67Chrome Android Full support 67Firefox Android Full support 46Opera Android ? Safari iOS ? Samsung Internet Android Full support 9.0

Legend

Full support
Full support
No support
No support
Compatibility unknown
Compatibility unknown

See also