An ICE candidate describes the protocols and routing needed for WebRTC to be able to communicate with a remote device. When starting a WebRTC peer connection, typically a number of candidates are proposed by each end of the connection, until they mutually agree upon one which describes the connection they decide will be best. WebRTC then uses that candidate's details to initiate the connection.
RTCIceCandidateobject to represent a single ICE candidate, optionally configured based on a configuration object.
Note: For backwards compatibility, the constructor also accepts as input a string containing the value of the
candidateproperty instead of the configuration object.
A string containing the IP address of the candidate.
A string representing the transport address for the candidate that can be used for connectivity checks. The format of this address is a
candidate-attributeas defined in RFC 5245. This string is empty (
"") if the
RTCIceCandidateis an "end of candidates" indicator.
A string which indicates whether the candidate is an RTP or an RTCP candidate; its value is either
rtcp, and is derived from the
"component-id"field in the
Returns a string containing a unique identifier that is the same for any candidates of the same type, share the same base (the address from which the ICE agent sent the candidate), and come from the same STUN server. This is used to help optimize ICE performance while prioritizing and correlating candidates that appear on multiple
An integer value indicating the candidate's port number.
A long integer value indicating the candidate's priority.
A string indicating whether the candidate's protocol is
If the candidate is derived from another candidate,
relatedAddressis a string containing that host candidate's IP address. For host candidates, this value is
For a candidate that is derived from another, such as a relay or reflexive candidate, the
relatedPortis a number indicating the port number of the candidate from which this candidate is derived. For host candidates, the
A string specifying the candidate's media stream identification tag which uniquely identifies the media stream within the component with which the candidate is associated, or
nullif no such association exists.
tcpTyperepresents the type of TCP candidate. Otherwise,
A string indicating the type of candidate as one of the strings listed on
A string containing a randomly-generated username fragment ("ice-ufrag") which ICE uses for message integrity along with a randomly-generated password ("ice-pwd"). You can use this string to verify generations of ICE generation; each generation of the same ICE process will use the same
usernameFragment, even across ICE restarts.
For examples, see the article Signaling and video calling, which demonstrates the entire process.
|WebRTC 1.0: Real-Time Communication Between Browsers |
BCD tables only load in the browser