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 erhalten werden, indem der RTCStatsReport, der durch RTCPeerConnection.getStats() zurückgegeben wird, durchiteriert wird, 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 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.

foundation Optional

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

port Optional

Die vom Kandidaten verwendete Netzwerkportnummer. 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 zur Datenübertragung auf dem Port verwendet wird. Entspricht RTCIceCandidate.protocol.

transportId

Ein String, der das Transportobjekt, das inspiziert wurde, um die RTCTransportStats zu erhalten, eindeutig identifiziert. Dieser ist dem Kandidaten zugeordnet, der diesen Statistiken entspricht.

usernameFragment Optional

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

Gemeinsame Instanz-Eigenschaften

Die folgenden Eigenschaften sind allen WebRTC-Statistikobjekten gemeinsam.

id

Ein String, der das Objekt, das überwacht wird, um diese Statistik zu erzeugen, eindeutig identifiziert.

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 von Statistiken angibt, den 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 durchläuft diesen dann mit RTCStatsReport.forEach(). Es werden dann nur die Wörterbücher gefiltert, die den Typ local-candidate aufweisen, und das Ergebnis wird geloggt.

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