RTCRtpReceiver.getStats()

The RTCRtpReceiver method getStats() asynchronously requests an RTCStatsReport object which provides statistics about incoming traffic on the owning RTCPeerConnection, returning a Promise whose fulfillment handler will be called once the results are available.

Syntax

var promise = RTCRtpReceiver.getStats();

Return value

A JavaScript Promise which is fulfilled once the statistics are available. The promise's fulfillment handler receives as a parameter a RTCStatsReport object containing the collected statistics.

The returned statistics include those from all streams which are coming in through the RTCRtpReceiver, as well as any of their dependencies.

Example

This simple example obtains the statistics for an RTCRtpReceiver and updates an element's innerText to display the number of packets lost.

receiver.getStats().then(function(stats) {
  document.getElementById("lostpackets").innerText =
          stats.packetsLost;
});

Specifications

Specification Status Comment
WebRTC 1.0: Real-time Communication Between Browsers
The definition of 'RTCRtpReceiver.getStats()' in that specification.
Candidate Recommendation Initial specification.

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support58 ?55 No45 ?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support5558 Yes5545 ?7.0

See also

Document Tags and Contributors

Contributors to this page: Sheppy, fscholz, jpmedley
Last updated by: Sheppy,