RTCRtpReceiver: 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 RTCRtpReceiver fordert asynchron ein RTCStatsReport-Objekt an, das Statistiken über eingehenden Datenverkehr auf dem zugehörigen RTCPeerConnection bereitstellt. Dabei wird ein Promise zurückgegeben, dessen Erfüllungshandler aufgerufen wird, sobald 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 Promise erhält als Parameter ein RTCStatsReport-Objekt, das die gesammelten Statistiken enthält.

Die zurückgegebenen Statistiken umfassen jene von allen Streams, die über den RTCRtpReceiver eingehen, sowie deren Abhängigkeiten.

Diese könnten zum Beispiel Statistiken mit Typen beinhalten: inbound-rtp, candidate-pair, local-candidate, remote-candidate.

Beispiele

Dieses einfache Beispiel ruft die Statistiken für einen RTCRtpReceiver ab und aktualisiert die innerText eines Elements, um die Anzahl der verlorenen Pakete anzuzeigen.

js
receiver.getStats().then((stats) => {
  document.getElementById("lost-packets").innerText = stats.packetsLost;
});

Spezifikationen

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

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch