RTCIceCandidate
WebRTC
WebRTC
The RTCIceCandidate interface—part of the WebRTC API—represents a candidate Interactive Connectivity Establishment (ICE) configuration which may be used to establish an RTCPeerConnection.
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.
For details on how the ICE process works, see Lifetime of a WebRTC session. The article WebRTC connectivity provides additional useful details.
Constructor
- RTCIceCandidate()
-
: Creates an
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 candidate property instead of the configuration object.
Instance properties
- address
- : A string containing the IP address of the candidate.
- 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 5245. This string is empty ("") if theRTCIceCandidateis an "end of candidates" indicator. - component
- : A string which indicates whether the candidate is an RTP or an RTCP candidate; its value is either
rtporrtcp, and is derived from the"component-id"field in thecandidatea-line string. - foundation
- : 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 RTCIceTransport objects.
- port
- : An integer value indicating the candidate's port number.
- priority
- : A long integer value indicating the candidate's priority.
- protocol
- : A string indicating whether the candidate's protocol is
"tcp"or"udp". - relatedAddress
- : If the candidate is derived from another candidate,
relatedAddressis a string containing that host candidate's IP address. For host candidates, this value isnull. - relatedPort
- : 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, therelatedPortproperty isnull. - sdpMid
- : 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. - sdpMLineIndex
- : If not
null,sdpMLineIndexindicates the zero-based index number of the media description (as defined in RFC 4566) in the SDP with which the candidate is associated. - tcpType
- : If
protocolis"tcp",tcpTyperepresents the type of TCP candidate. Otherwise,tcpTypeisnull. - type
- : A string indicating the type of candidate as one of the strings listed on
RTCIceCandidate.type. - usernameFragment
- : 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.
Instance methods
- toJSON()
- : Returns a JSON-serializable plain object representing the
RTCIceCandidateobject. Automatically called by JSON.stringify().
Examples
For examples, see the article Signaling and video calling, which demonstrates the entire process.