DasRTCIceCandidateStats-Wörterbuch derWebRTC API wird verwendet, um Statistiken zu einemRTCIceCandidate zu berichten.

Die Statistiken können durch Iteration desRTCStatsReport abgerufen werden, das vonRTCPeerConnection.getStats() zurückgegeben wird, bis Sie einen Bericht mit demtype vonlocal-candidate finden.

Instanzeigenschaften

addressOptional

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 alsip bezeichnet und akzeptierte nur IP-Adressen.EntsprichtRTCIceCandidate.address.

candidateType

Ein String, der einem der Werte inRTCIceCandidate.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.

foundationOptionalExperimentell

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

portOptional

Die Netzwerkportnummer, die vom Kandidaten verwendet wird.EntsprichtRTCIceCandidate.port.

priorityOptional

Die Priorität des Kandidaten.EntsprichtRTCIceCandidate.priority.

protocolOptional

Ein String, der das Protokoll angibt (tcp oderudp), das zum Übertragen von Daten auf demport verwendet wird.EntsprichtRTCIceCandidate.protocol.

relayProtocol

Ein String, der das Protokoll angibt, das von einem lokalenICE-Kandidaten verwendet wird, um mit demTURN-Server zu kommunizieren.

transportId

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

urlOptional

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

usernameFragmentOptionalExperimentell

Ein String, der das ICE-Username-Fragment ("ice-ufrag") enthält.EntsprichtRTCIceCandidate.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

EinDOMHighResTimeStamp-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 VariablemyPeerConnection, die eine Instanz vonRTCPeerConnection ist. Der folgende Code verwendetawait, um auf den Statistikbericht zu warten und iteriert dann über diesen mithilfe vonRTCStatsReport.forEach().Er filtert dann die Wörterbücher für genau diejenigen Berichte heraus, die den Typlocal-candidate haben, und protokolliert das Ergebnis.

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

Spezifikationen

Browser-Kompatibilität