RTCIceTransport.getLocalCandidates()

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

localCandidates = RTCIceTransport.getLocalCandidates();

Parameters

None.

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().

Example

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.

var localCandidates = pc.getSenders()[0].transport.transport.getLocalCandidates();

localCandidates.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.getLocalCandidates()' in that specification.
Candidate Recommendation Initial definition.

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support No No No No No No
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support No No ? No No No No

 

Document Tags and Contributors

Contributors to this page: Sheppy
Last updated by: Sheppy,