RTCIceCandidate.RTCIceCandidate()

The RTCIceCandidate() constructor creates and returns a new RTCIceCandidate object, which can be configured to represent a single ICE candidate.

Syntax

candidate = new RTCIceCandidate([candidateInfo]);

Parameters

candidateInfo Optional
An optional RTCIceCandidateInit object providing information about the candidate; if this is provided, the candidate is initialized configured to represent the described candidate.

Note: If a string is provided as the candidateInfo parameter, it is expected to be the text of a candidate m-line. This provides backward compatibility with older versions of WebRTC.

Return value

A newly-created RTCIceCandidate object, optionally configured based on the specified object based on the RTCIceCandidateInit dictionary.

If candidateInfo is provided, the new RTCIceCandidate is initialized as follows:

Note: Parsing of the candidate string is performed using the candidate-attribute grammar from the WebRTC Specification.

Exceptions

TypeError
The specified RTCIceCandidateInit has values of null in both the sdpMid and sdpMLineIndex properties.

Specifications

Specification Status Comment
WebRTC 1.0: Real-time Communication Between Browsers
The definition of 'RTCIceCandidate()' in that specification.
Candidate Recommendation Initial definition.

Browser compatibility

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

See also

 

Document Tags and Contributors

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