RTCRtpSender: getStats()-Methode

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.

Die Methode getStats() des RTCRtpSender fordert asynchron ein RTCStatsReport-Objekt an, das Statistiken über den ausgehenden Datenverkehr auf der RTCPeerConnection bereitstellt, die den Sender besitzt. Sie gibt ein Promise zurück, das erfüllt wird, wenn die Ergebnisse verfügbar sind.

Syntax

js
getStats()

Parameter

Keine.

Rückgabewert

Ein JavaScript Promise, das erfüllt wird, sobald die Statistiken verfügbar sind. Der Erfüllungshandler des Promises erhält als Parameter ein RTCStatsReport-Objekt, das die gesammelten Statistiken enthält.

Das zurückgegebene RTCStatsReport akkumuliert die Statistiken für alle Streams, die mit dem RTCRtpSender gesendet werden, sowie die Statistiken für alle Abhängigkeiten dieser Streams.

Diese können beispielsweise Statistiken mit Typen umfassen: outbound-rtp, candidate-pair, local-candidate, remote-candidate.

Beispiele

Dieses einfache Beispiel erhält die Statistiken für einen RTCRtpSender und aktualisiert das innerText-Element, um die aktuelle Round-Trip-Zeit für Anfragen an den Sender anzuzeigen.

js
sender.getStats().then((stats) => {
  document.getElementById("currentRTT").innerText = stats.roundTripTime;
});

Spezifikationen

Specification
WebRTC: Real-Time Communication in Browsers
# widl-RTCRtpSender-getStats-Promise-RTCStatsReport

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch