The RTCIceTransport
method getRemoteCandidates()
returns an array which contains one RTCIceCandidate
for each of the candidates that have been received from the remote peer so far during the current ICE gathering session.
Each time your signaling code calls RTCPeerConnection.addIceCandidate()
to add a received candidate to the ICE session, the ICE agent places it in the list returned by this function.
Syntax
remoteCandidates = RTCIceTransport.getRemoteCandidates();
Parameters
None.
Return value
An array containing one RTCIceCandidate
object for each candidate that has been received so far from the remote peer during the current ICE candidate gathering session.
It's important to keep in mind that there's no way to correlate these remote candidates with compatible local candidates. To find the best match found so far, call RTCIceTransport.getSelectedCandidatePair()
.
Example
This simple example gets the remote candidate list from the RTCIceTransport
for the first RTCRtpSender
on the RTCPeerConnection
, then outputs to the console all of the candidates in the list.
var remoteCandidates = pc.getSenders()[0].transport.transport.getRemoteCandidates(); remoteCandidates.forEach(function(candidate, index)) { console.log("Candidate " + index + ": " + candidate.candidate); });
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCIceCandidate.getRemoteCandidates()' in that specification. |
Candidate Recommendation | Initial definition. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
getRemoteCandidates | Chrome No support No | Edge No support 15 — 79 | Firefox No support No | IE No support No | Opera No support No | Safari No support No | WebView Android No support No | Chrome Android No support No | Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android No support No |
Legend
- No support
- No support