RTCIceCandidatePairStats: availableOutgoingBitrate property

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

The availableOutgoingBitrate property of the RTCIceCandidatePairStats dictionary indicates the available outbound capacity of the network connection represented by the candidate pair. The higher the value, the more bandwidth you can assume is available for outgoing data.

You can get the incoming available bitrate from availableIncomingBitrate.

Value

A number which approximates the amount of available bandwidth for outgoing data on the network connection described by the RTCIceCandidatePair. The value is reported in bits per second and is computed over a 1-second interval.

The returned value is undefined in each of the following situations:

  • The underlying implementation doesn't support computing a sender-side estimate of the outgoing bit rate.
  • The RTCIceCandidatePair described by this object has never been used.
  • The candidate pair was once in use, but no longer is.

The value returned is calculated by adding up the available bit rate for every RTP stream using the connection described by this candidate pair. The returned value doesn't take into account overhead introduced by underlying protocols, including IP, UDP, or TCP.

Note: The returned value is computed using a method similar—but not identical—to the Transport Independent Application Specific Maximum (TIAS) described in RFC 3890, section 6.2.

Specifications

Specification
Identifiers for WebRTC's Statistics API
# dom-rtcicecandidatepairstats-availableoutgoingbitrate

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
availableOutgoingBitrate in 'candidate-pair' stats
Chrome – Full support
Chrome 58 (Release date: 2017-04-19)
footnote Full support
Edge – Full support
Edge 79 (Release date: 2020-01-15)
footnote Full support
Firefox – No support
Firefox
footnote No support
Opera – Full support
Opera 45 (Release date: 2017-05-10)
footnote Full support
Safari – No support
Safari 11 – 16.1 (Release date: 2017-09-19)
footnote Removed in 16.2 and later
Chrome Android – Full support
Chrome Android 58 (Release date: 2017-04-25)
footnote Full support
Firefox for Android – No support
Firefox for Android
footnote No support
Opera Android – Full support
Opera Android 43 (Release date: 2017-09-27)
footnote Full support
Safari on iOS – No support
Safari on iOS 11 – 16.1 (Release date: 2017-09-19)
footnote Removed in 16.2 and later
Samsung Internet – Full support
Samsung Internet 7 (Release date: 2018-03-16)
footnote Full support
WebView Android – Full support
WebView Android 58 (Release date: 2017-04-25)
footnote Full support
WebView on iOS – No support
WebView on iOS 11 – 16.1 (Release date: 2017-09-19)
footnote Removed in 16.2 and later

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support