RTCIceCandidate

The RTCIceCandidate interface of the the WebRTC API represents a candidate Internet Connectivity Establishment (ICE) server for establishing an RTCPeerConnection.

Constructors

RTCIceCandidate()

Creates an RTCIceCandidate object.

Properties

RTCIceCandidate.candidate Read only

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 represents a "end of candidates" indicator.

RTCIceCandidate.foundation Read only

Returns a unique identifier that allows ICE to correlate candidates that appear on multiple RTCIceTransport objects.

RTCIceCandidate.ip Read only

Returns the IP address of the candidate.

RTCIceCandidate.port Read only

Returns the port of the candidate.

RTCIceCandidate.priority Read only

Returns the assigned priority of the candidate.

RTCIceCandidate.protocol Read only

Returns the protocol used by the candidate, either udp or tcp.

RTCIceCandidate.relatedAddress Read only

For a candidate that is derived from another, such as a relay or reflexive candidate, the relatedAddress is the IP address of the candidate that it is derived from. For host candidates, the relatedAddress is null.

RTCIceCandidate.relatedPort Read only

For a candidate that is derived from another, such as a relay or reflexive candidate, the relatedPort is the port of the candidate that it is derived from. For host candidates, the relatedPort is null.

RTCIceCandidate.sdpMid Read only

If not null, this contains the identifier of the "media stream identification" (as defined in RFC 5888) for the media component this candidate is associated with.

RTCIceCandidate.sdpMLineIndex Read only

If not null, this indicates the index (starting at zero) of the media description (as defined in RFC 4566) in the SDP this candidate is associated with.

RTCIceCandidate.tcpType Read only

If protocol is tcp, tcpType represents the type of TCP candidate. Otherwise, tcpType is null.

RTCIceCandidate.type Read only

One of host, srflx, prflx, or relay.

Specifications

Browser compatibility