RTCIceCandidateStats

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

Die Statistiken können abgerufen werden, indem über den RTCStatsReport iteriert wird, der von RTCPeerConnection.getStats() zurückgegeben wird, bis Sie einen Bericht mit dem type 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ändiger Domänenname sein. Diese Eigenschaft wurde früher ip genannt und akzeptierte nur IP-Adressen.

candidateType

Ein String, der einen der Werte in RTCIceCandidate.type entspricht und angibt, für welche Art von Kandidaten das Objekt Statistiken liefert.

deleted Optional

Ein Boolescher Wert, der angibt, ob der Kandidat freigegeben oder gelöscht wurde; der Standardwert ist false. Bei lokalen Kandidaten ist der Wert true, wenn der Kandidat gelöscht oder freigegeben wurde. Bei Host-Kandidaten bedeutet true, dass alle mit dem Kandidaten verbundenen Netzwerkressourcen (in der Regel ein Netzwerk-Socket) bereits freigegeben wurden. Bei 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 vom Kandidaten verwendete Netzwerkportnummer.

priority Optional

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

protocol Optional

Ein String, der das Protokoll (tcp oder udp) angibt, das zur Datenübertragung auf dem port verwendet wird.

relayProtocol Optional

Ein String, der das Protokoll identifiziert, das von der Endstelle 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 untersucht wurde, um die zugehörigen RTCTransportStats des Kandidaten zu erhalten.

url Optional

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

Gemeinsame Instanz-Eigenschaften

Die folgenden Eigenschaften sind allen WebRTC-Statistikobjekten gemeinsam.

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 genommen 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

BCD tables only load in the browser