RTCDataChannelStats

Das RTCDataChannelStats-Wörterbuch der WebRTC API stellt Statistiken zu einem RTCDataChannel-Objekt auf der Verbindung bereit.

Der Bericht kann abgerufen werden, indem der RTCStatsReport iteriert wird, der von RTCPeerConnection.getStats() zurückgegeben wird, bis Sie einen Eintrag mit dem type data-channel finden.

Die Statistiken der Datenkanäle können mit einem bestimmten Kanal korreliert werden, indem die dataChannelIdentifier-Eigenschaft mit einer übereinstimmenden RTCDataChannel.id verglichen wird.

Instanzeigenschaften

bytesSent Optional

Ein positiver Ganzzahlenwert, der die Gesamtanzahl der Nutzdatenbytes angibt, die über das zugehörige RTCDataChannel gesendet wurden.

bytesReceived Optional

Ein positiver Ganzzahlenwert, der die Gesamtanzahl der Nutzdatenbytes angibt, die über das zugehörige RTCDataChannel empfangen wurden.

dataChannelIdentifier Optional

Ein positiver Ganzzahlenwert, der die id des zugehörigen RTCDataChannel enthält.

label Optional

Eine Zeichenkette, die das label des zugehörigen RTCDataChannel enthält.

messagesReceived Optional

Ein positiver Ganzzahlenwert, der die Gesamtanzahl der message events angibt, die für empfangene Nachrichten im zugehörigen RTCDataChannel ausgelöst wurden.

messagesSent Optional

Ein positiver Ganzzahlenwert, der die Gesamtanzahl der message events angibt, die für gesendete Nachrichten auf dem Kanal ausgelöst wurden.

protocol Optional

Eine Zeichenkette, die das protocol des zugehörigen RTCDataChannel enthält.

state

Der readyState des zugehörigen RTCDataChannel.

Allgemeine Instanzeigenschaften

Die folgenden Eigenschaften sind allen WebRTC-Statistikobjekten gemeinsam (siehe RTCStatsReport für mehr Informationen).

id

Ein String, der das Objekt eindeutig identifiziert, das überwacht wird, um diesen Satz von Statistiken zu erstellen.

timestamp

Ein DOMHighResTimeStamp-Objekt, das die Zeit angibt, zu der die Probe für dieses Statistikobjekt entnommen wurde.

type

Ein String mit dem Wert "data-channel", der den Typ der Statistiken angibt, die das Objekt enthält.

Beispiele

Angenommen, myPeerConnection ist eine Instanz von RTCPeerConnection, nutzt der folgende Code await, um auf den Statistikbericht zu warten und iteriert dann darüber mit RTCStatsReport.forEach(). Er filtert dann die Wörterbücher nur für diejenigen Berichte, die den Typ data-channel haben, und protokolliert das Ergebnis.

js
const stats = await myPeerConnection.getStats();

stats.forEach((report) => {
  if (report.type === "data-channel") {
    // Log the channel information
    console.log(report);
  }
});

Spezifikationen

Specification
Identifiers for WebRTC's Statistics API
# dom-rtcstatstype-data-channel

Browser-Kompatibilität

BCD tables only load in the browser