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.
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.
These might include, for example, statistics with types: outbound-rtp
, candidate-pair
, local-candidate
, remote-candidate
.
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((stats) => {
document.getElementById("currentRTT").innerText = stats.roundTripTime;
});