RTCIceTransport: getRemoteCandidates()-Methode

Die getRemoteCandidates()-Methode des RTCIceTransport-Interfaces gibt ein Array zurück, das ein RTCIceCandidate für jeden Kandidaten enthält, der während der aktuellen ICE-Erfassungssitzung bisher vom entfernten Peers empfangen wurde.

Jedes Mal, wenn Ihr Signalisierungscode RTCPeerConnection.addIceCandidate() aufruft, um einen empfangenen Kandidaten zur ICE-Sitzung hinzuzufügen, platziert der ICE-Agent ihn in der Liste, die von dieser Funktion zurückgegeben wird.

Syntax

js
getRemoteCandidates()

Parameter

Keine.

Rückgabewert

Ein Array, das ein RTCIceCandidate-Objekt für jeden bisher vom entfernten Peers empfangenen Kandidaten während der aktuellen ICE-Kandidatenerfassungssitzung enthält.

Es ist wichtig zu beachten, dass es keinen Weg gibt, diese entfernten Kandidaten mit kompatiblen lokalen Kandidaten zu korrelieren. Um das bisher beste gefundene Paar zu ermitteln, rufen Sie RTCIceTransport.getSelectedCandidatePair() auf.

Beispiel

Dieses einfache Beispiel ruft die Liste der entfernten Kandidaten vom RTCIceTransport für den ersten RTCRtpSender auf der RTCPeerConnection ab und gibt dann alle Kandidaten in der Liste auf der Konsole aus.

js
const remoteCandidates = pc
  .getSenders()[0]
  .transport.transport.getRemoteCandidates();

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

Spezifikationen

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

Browser-Kompatibilität

BCD tables only load in the browser