RTCIceTransport: getLocalCandidates()-Methode

Die getLocalCandidates()-Methode der RTCIceTransport-Schnittstelle gibt ein Array von RTCIceCandidate-Objekten zurück, eines für jeden der Kandidaten, die vom lokalen Gerät während der aktuellen ICE-Agentensitzung gesammelt wurden.

Die lokalen Kandidaten werden von dem ICE-Agenten in diese Liste eingefügt, bevor sie im Rahmen eines icecandidate-Ereignisses an den Code des lokalen Clients übergeben werden, sodass der Client die Kandidaten an den entfernten Peer weiterleiten kann.

Syntax

js
getLocalCandidates()

Parameter

Keine.

Rückgabewert

Ein JavaScript-Array, das ein RTCIceCandidate-Objekt für jeden Kandidaten enthält, der bisher während der ICE-Kandidatensammlungssitzung identifiziert wurde.

Sie können diese lokalen Kandidaten nicht mit passenden entfernten Kandidaten korrelieren. Um das beste bisher gefundene Match zu finden, rufen Sie RTCIceTransport.getSelectedCandidatePair() auf.

Beispiele

Dieses einfache Beispiel holt die Liste der lokalen Kandidaten von der RTCIceTransport für den ersten RTCRtpSender auf der RTCPeerConnection und gibt dann alle Kandidaten in der Liste in der Konsole aus.

js
const localCandidates = pc
  .getSenders()[0]
  .transport.iceTransport.getLocalCandidates();

localCandidates.forEach((candidate, index) => {
  console.log(`Candidate ${index}: ${candidate.candidate}`);
});

Spezifikationen

Specification
WebRTC: Real-Time Communication in Browsers
# dom-rtcicetransport-getlocalcandidates

Browser-Kompatibilität

BCD tables only load in the browser