View source

class IceCandidate

package js.html.rtc

@:native("RTCIceCandidate")

Available on js

The RTCIceCandidate interface—part of the WebRTC API—represents a candidate Internet Connectivity Establishment (ICE) configuration which may be used to establish an RTCPeerConnection.

Documentation RTCIceCandidate by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See also:

Constructor

new(candidateInitDict:IceCandidateInit)

Throws:

null

DOMError

Variables

candidate:String

A DOMString representing the transport address for the candidate that can be used for connectivity checks. The format of this address is a candidate-attribute as defined in {{RFC(5245)}}. This string is empty ("") if the RTCIceCandidate is an "end of candidates" indicator.

sdpMLineIndex:Int

If not null, sdpMLineIndex indicates the zero-based index number of the media description (as defined in RFC 4566) in the SDP with which the candidate is associated.

sdpMid:String

A DOMString specifying the candidate's media stream identification tag which uniquely identifies the media stream within the component with which the candidate is associated, or null if no such association exists.

Methods

toJSON():Dynamic