RTCRtpSender.getStats()
The RTCRtpSender
method getStats()
asynchronously requests an RTCStatsReport
object which provides
statistics about outgoing traffic on the RTCPeerConnection
which owns the
sender, returning a Promise
which is fulfilled when the results are
available.
Syntax
var promise = RTCRtpSender.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 RTCStatsReport
accumulates the statistics for all of the
streams being sent using the RTCRtpSender
, as well as the statistics for
any dependencies those streams have.
Example
This simple example obtains the statistics for an RTCRtpSender
and updates
an element's innerText
to display the current round
trip time for requests on the sender.
sender.getStats().then(function(stats) {
document.getElementById("currentRTT").innerText =
stats.roundTripTime;
});
Specifications
Specification |
---|
WebRTC 1.0: Real-Time Communication Between Browsers # widl-RTCRtpSender-getStats-Promise-RTCStatsReport |
Browser compatibility
BCD tables only load in the browser