The WebRTC API's
RTCIceCandidateInit dictionary, which contains the information needed to fundamentally describe an
RTCIceCandidateInit is used when using
new RTCIceCandidate() to create a new ICE candidate object. It's also used as the return value from the
RTCIceCandidate.toJSON() method, and can be passed directly into
RTCPeerConnection.addIceCandidate() to add a candidate to the peer connection.
- The ICE
candidate-attribute. If the candidate is an indicator that there are no further candidates (rather than representing a new candidate), this is the empty string (
""). The default is the empty string.
- The identification tag of the media stream with which the candidate is associated, or
nullif there is no associated media stream. The default is
- The zero-based index of the m-line within the SDP of the media description with which the candidate is associated, or
nullif no such associated exists. The default is
DOMStringcontaining a string which uniquely identifies the remote peer. This string is generated by WebRTC at the beginning of the session, and at least 24 bits worth of the string contain random data. The string may be up to 256 characters long. This property has no default value and is not present unless set explicitly.
|WebRTC 1.0: Real-time Communication Between Browsers
The definition of 'RTCIceCandidateInit' in that specification.
|Candidate Recommendation||Initial definition.|