W3cubDocs

/Web APIs

RTCRtpReceiver: getStats() method

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

js

getStats()

Parameters

None.

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.

These might include, for example, statistics with types: inbound-rtp, candidate-pair, local-candidate, remote-candidate.

Examples

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

js

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

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
getStats 67 13 55 No 54 12.1 67 67 55 48 12.2 7.0

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpReceiver/getStats