RTCIceCandidateStats

Baseline Widely available *

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

* Some parts of this feature may have varying levels of support.

Das RTCIceCandidateStats-Wörterbuch der WebRTC API wird verwendet, um Statistiken zu einem RTCIceCandidate zu berichten.

Die Statistiken können durch Iteration des RTCStatsReport abgerufen werden, das von RTCPeerConnection.getStats() zurückgegeben wird, bis Sie einen Bericht mit dem type von local-candidate finden.

Instanzeigenschaften

address Optional

Ein String, der die Adresse des Kandidaten enthält. Dieser Wert kann eine IPv4-Adresse, eine IPv6-Adresse oder ein vollständig qualifizierter Domainname sein. Diese Eigenschaft wurde vorher als ip bezeichnet und akzeptierte nur IP-Adressen. Entspricht RTCIceCandidate.address.

candidateType

Ein String, der einem der Werte in RTCIceCandidate.type entspricht und angibt, für welche Art von Kandidat das Objekt Statistiken bereitstellt.

deleted

Ein boolescher Wert, der angibt, ob der Kandidat gelöscht oder freigegeben wurde.

foundation Optional

Ein String, der den Kandidaten eindeutig über mehrere Transporte hinweg identifiziert. Entspricht RTCIceCandidate.foundation.

port Optional

Die Netzwerkportnummer, die vom Kandidaten verwendet wird. Entspricht RTCIceCandidate.port.

priority Optional

Die Priorität des Kandidaten. Entspricht RTCIceCandidate.priority.

protocol Optional

Ein String, der das Protokoll angibt (tcp oder udp), das zum Übertragen von Daten auf dem port verwendet wird. Entspricht RTCIceCandidate.protocol.

relayProtocol

Ein String, der das Protokoll angibt, das von einem lokalen ICE-Kandidaten verwendet wird, um mit dem TURN-Server zu kommunizieren.

transportId

Ein String, der das Transportobjekt eindeutig identifiziert, das untersucht wurde, um die RTCTransportStats zu erhalten, die dem Kandidaten entsprechen, der diesen Statistiken entspricht.

url Optional

Ein String, der die URL des ICE-Servers angibt, von dem der beschriebene Kandidat abgerufen wurde. Diese Eigenschaft ist nur für lokale Kandidaten verfügbar.

usernameFragment Optional

Ein String, der das ICE-Username-Fragment ("ice-ufrag") enthält. Entspricht RTCIceCandidate.usernameFragment.

Gemeinsame Instanzeigenschaften

Die folgenden Eigenschaften sind allen WebRTC-Statistikobjekten gemeinsam.

id

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

timestamp

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

type

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

Beispiele

Angenommen, Sie haben eine Variable myPeerConnection, die eine Instanz von RTCPeerConnection ist. Der folgende Code verwendet await, um auf den Statistikbericht zu warten und iteriert dann über diesen mithilfe von RTCStatsReport.forEach(). Er filtert dann die Wörterbücher für genau diejenigen Berichte heraus, die den Typ local-candidate haben, und protokolliert das Ergebnis.

js
const stats = await myPeerConnection.getStats();

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

Spezifikationen

Specification
Identifiers for WebRTC's Statistics API
# dom-rtcstatstype-local-candidate

Browser-Kompatibilität