RTCIceCandidateStats

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.

* 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 Iterieren des RTCStatsReport, das von RTCPeerConnection.getStats() zurückgegeben wird, abgerufen werden, bis Sie einen Bericht mit dem type von local-candidate finden.

Instanz-Eigenschaften

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 zuvor ip genannt und akzeptierte nur IP-Adressen.

candidateType

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

deleted Optional

Ein Boolean-Wert, der angibt, ob der Kandidat freigegeben oder gelöscht wurde; der Standardwert ist false. Für lokale Kandidaten ist der Wert true, wenn der Kandidat gelöscht oder freigegeben wurde. Für Host-Kandidaten bedeutet true, dass alle Netzwerkressourcen (normalerweise ein Netzwerksocket), die mit dem Kandidaten verbunden sind, bereits freigegeben wurden. Für TURN-Kandidaten ist die TURN-Zuweisung für gelöschte Kandidaten nicht mehr aktiv. Diese Eigenschaft ist für entfernte Kandidaten nicht vorhanden.

port Optional

Die von dem Kandidaten verwendete Netzwerkportnummer.

priority Optional

Die Priorität des Kandidaten, entsprechend RTCIceCandidate.priority.

protocol Optional

Ein String, der das verwendete Protokoll (tcp oder udp) angibt, um Daten auf dem port zu übertragen.

relayProtocol Optional

Ein String, der das Protokoll identifiziert, das vom Endpunkt zur Kommunikation mit dem TURN-Server verwendet wird; gültige Werte sind tcp, udp und tls. Nur für lokale Kandidaten vorhanden.

transportId

Ein String, der das Transportobjekt eindeutig identifiziert, das geprüft wurde, um die RTCTransportStats zu erhalten, die mit dem Kandidaten verbunden sind, der diese Statistiken betrifft.

url Optional

Für lokale Kandidaten ist die url-Eigenschaft die URL des ICE-Servers, von dem der Kandidat empfangen wurde. Diese URL entspricht der, die im RTCPeerConnectionIceEvent-Objekt enthalten ist, das das icecandidate-Ereignis darstellt, das den Kandidaten an den lokalen Peer geliefert hat.

Gemeinsame Instanz-Eigenschaften

Die folgenden Eigenschaften sind allen WebRTC-Statistikobjekten gemeinsam.

id

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

timestamp

Ein DOMHighResTimeStamp-Objekt, das die Zeit angibt, zu der 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

TBD

Spezifikationen

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

Browser-Kompatibilität