RTCIceTransport: getLocalCandidates() method
The RTCIceTransport
method getLocalCandidates()
returns an array of RTCIceCandidate
objects, one for each of the candidates that have been gathered by the local device during the current ICE agent session.
The local candidates are placed in this list by the ICE agent prior to being delivered to the local client's code in an icecandidate
event so that the client can forward the candidates to the remote peer.
Syntax
Parameters
Return value
A JavaScript Array
containing one RTCIceCandidate
object for each candidate that has been identified so far during the ICE candidate gathering session.
You can't correlate these local candidates with matching remote candidates. To find the best match found so far, call RTCIceTransport.getSelectedCandidatePair()
.
Examples
This simple example gets the local candidate list from the RTCIceTransport
for the first RTCRtpSender
on the RTCPeerConnection
, then outputs to the console all of the candidates in the list.
const localCandidates = pc
.getSenders()[0]
.transport.transport.getLocalCandidates();
localCandidates.forEach((candidate, index) => {
console.log(`Candidate ${index}: ${candidate.candidate}`);
});
Specifications
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
getLocalCandidates |
75 |
79 |
No |
No |
62 |
No |
75 |
75 |
No |
54 |
No |
11.0 |