RTCDataChannelStats

Das RTCDataChannelStats-Wörterbuch der WebRTC API liefert Statistiken, die mit einem RTCDataChannel-Objekt auf der Verbindung in Zusammenhang stehen.

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

Die Datenkanalstatistiken können einem bestimmten Kanal zugeordnet werden, indem die dataChannelIdentifier-Eigenschaft mit einer passenden RTCDataChannel.id verglichen wird.

Instanz-Eigenschaften

bytesSent Optional

Ein positiver Ganzzahlwert, der die Gesamtanzahl der Nutzlast-Bytes angibt, die über den zugehörigen RTCDataChannel gesendet wurden.

bytesReceived Optional

Ein positiver Ganzzahlwert, der die Gesamtanzahl der Nutzlast-Bytes angibt, die über den zugehörigen RTCDataChannel empfangen wurden.

dataChannelIdentifier Optional

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

label Optional

Ein String, der das label des zugehörigen RTCDataChannel enthält.

messagesReceived Optional

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

messagesSent Optional

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

protocol Optional

Ein String, der das protocol des zugehörigen RTCDataChannel enthält.

state

Der readyState des zugehörigen RTCDataChannel.

Gemeinsame Instanz-Eigenschaften

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

id

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

timestamp

Ein DOMHighResTimeStamp-Objekt, das den Zeitpunkt angibt, zu dem die Probe für dieses Statistikobjekt entnommen wurde.

type

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

Beispiele

Gegeben sei eine Variable myPeerConnection, die eine Instanz von RTCPeerConnection ist. Der nachfolgende Code verwendet await, um auf den Statistikbericht zu warten, und durchläuft ihn dann mit RTCStatsReport.forEach(). Er filtert die Wörterbücher heraus, die nur Berichte vom 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