RTCStatsReport

RTCStatsReport.size

Gibt die Anzahl der Elemente im RTCStatsReport-Objekt zurück.

RTCStatsReport.entries()

Gibt ein neues Iterator-Objekt zurück, das ein zweigliedriges Array von [id, statistic-dictionary] für jedes Element im RTCStatsReport-Objekt in Einfügungsreihenfolge enthält.

RTCStatsReport.forEach()

Ruft callbackFn einmal für jedes im RTCStatsReport-Objekt vorhandene Schlüssel-Wert-Paar in Einfügungsreihenfolge auf. Wenn ein thisArg-Parameter an forEach übergeben wird, wird er als this-Wert für jeden Rückruf verwendet.

RTCStatsReport.get()

Gibt das Statistik-Wörterbuch zurück, das mit der übergebenen id verknüpft ist, oder undefined, wenn keine vorhanden ist.

RTCStatsReport.has()

Gibt einen booleschen Wert zurück, der angibt, ob das RTCStatsReport ein Statistik-Wörterbuch enthält, das mit der angegebenen id verknüpft ist.

RTCStatsReport.keys()

Gibt ein neues Iterator-Objekt zurück, das die Schlüssel (IDs) für jedes Element im RTCStatsReport-Objekt in Einfügungsreihenfolge enthält.

RTCStatsReport.values()

Gibt ein neues Iterator-Objekt zurück, das die Werte (Statistik-Objekte) für jedes Element im RTCStatsReport-Objekt in Einfügungsreihenfolge enthält.

RTCStatsReport[Symbol.iterator]()

Gibt ein neues Iterator-Objekt zurück, das ein zweigliedriges Array von [id, statistic-dictionary] für jedes Element im RTCStatsReport-Objekt in Einfügungsreihenfolge enthält.

Ein Promise, der sich in ein RTCStatsReport auflöst, wird von den Methoden RTCRtpReceiver.getStats(), RTCRtpSender.getStats() und RTCPeerConnection.getStats() zurückgegeben. Das Aufrufen von getStats() bei einem RTCPeerConnection ermöglicht es Ihnen, anzugeben, ob Sie ausgehende Statistiken, eingehende Statistiken oder Statistiken für die gesamte Verbindung erhalten möchten. Die Versionen getStats() von RTCRtpReceiver und RTCRtpSender geben jeweils nur eingehende bzw. ausgehende Statistiken zurück.

Der Statistikbericht ist ein schreibgeschütztes Map-ähnliches Objekt: ein geordnetes Wörterbuch, bei dem die Eigenschaften id-Strings sind, die das WebRTC-Objekt eindeutig identifizieren, das zur Erstellung eines bestimmten Satzes von Statistiken überprüft wurde, und der Wert ein Wörterbuchobjekt ist, das diese Statistiken enthält. Ein RTCStatsReport kann wie ein schreibgeschütztes Map durchlaufen und verwendet werden.

Der Bericht kann viele verschiedene Kategorien von Statistiken enthalten, einschließlich ein- und ausgehender Statistiken sowohl für die aktuellen als auch für die Remote-Enden der Peer-Verbindung, Informationen über Codecs, Zertifikate und verwendete Medien und so weiter. Jede Kategorie von Statistiken wird in einem anderen Typ von Statistik-Wörterbuchobjekt bereitgestellt, das anhand seiner type-Eigenschaft identifiziert werden kann.

Alle Wörterbuchtypen haben die folgenden Eigenschaften:

id

Ein String, der das Objekt eindeutig identifiziert, das überwacht wurde, um den Satz von Statistiken zu erstellen. Dieser Wert bleibt über Berichte hinweg für (mindestens) die Lebensdauer der Verbindung bestehen. Beachten Sie jedoch, dass sich die ID für einige Statistiken zwischen Browsern und für nachfolgende Verbindungen, selbst zum gleichen Peer, ändern kann.

timestamp

Ein hochauflösendes Zeitstempelobjekt (DOMHighResTimeStamp), das Zeit angibt, zu der die Probe entnommen wurde. Viele gemeldete Statistiken sind kumulative Werte; der Zeitstempel ermöglicht es, Raten und Durchschnitte zwischen beliebigen zwei Berichten mit jeder gewünschten Berichtsrate zu berechnen.

type

Ein String mit einem Wert, der den Typ der Statistiken angibt, die das Objekt enthält, wie candidate-pair, inbound-rtp, certificate und so weiter. Die Statistik-Typen und deren zugehörige Objekte sind unten aufgelistet.

Benutzer iterieren typischerweise ein RTCStatsReport, indem sie eine forEach()- oder for...of-Schleife verwenden und die interessierenden Statistiken mit der type-Eigenschaft auswählen. Sobald ein bestimmtes Statistikobjekt mit seinem type identifiziert wurde, kann die id-Eigenschaft anschließend mit get() verwendet werden, um denselben Statistikbericht zu einem anderen Zeitpunkt zu erhalten.

Der Zeitstempel kann verwendet werden, um Durchschnittswerte für Statistiken zu berechnen, die sich über die Lebensdauer einer Verbindung ansammeln.

Die Statistik-type-Werte und deren entsprechende Wörterbücher sind unten aufgeführt.

Dieses Beispiel zeigt, wie Sie videobezogene Statistiken für den lokalen RTCRtpReceiver, der für den Empfang von gestreamten Medien verantwortlich ist, protokollieren könnten.

Angenommen, Sie haben eine Variable myPeerConnection, die eine Instanz von RTCPeerConnection ist, dann verwendet der Code await, um auf den Statistikbericht zu warten, und iteriert ihn dann unter Verwendung von RTCStatsReport.forEach(). Er filtert dann die Wörterbücher für nur die Berichte, die den type von inbound-rtp und kind von video haben.

const stats = await myPeerConnection.getStats();

stats.forEach((report) => {
  if (report.type === "inbound-rtp" && report.kind === "video") {
    // Log the frame rate
    console.log(report.framesPerSecond);
  }
});

Dieses Beispiel zeigt, wie Sie die ausgehenden Statistiken von einem RTCRtpSender durchlaufen könnten.

Der Code folgt einem ähnlichen Muster wie das vorherige Beispiel, iteriert jedoch mit einer for...of-Schleife über die RTCStatsReport.values() und filtert den type von outbound-rtp. Es wird vorausgesetzt, dass Sie bereits ein RTCRtpSender-Objekt namens "sender" haben.

const stats = await sender.getStats();

for (const stat of stats.values()) {
  if (stat.type != "outbound-rtp") continue;
  Object.keys(stat).forEach((statName) => {
    console.log(`${statName}: ${report[statName]}`);
  });
}

• WebRTC API
• RTCPeerConnection
• RTCPeerConnection.getStats(), RTCRtpReceiver.getStats(), und RTCRtpSender.getStats()