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.

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.

Usage notes

This constructor does not do complete validation of the specified candidateInfo object or string.

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

BCD tables only load in the browser

See also