Skip to main content

RTCIceCandidate

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

MDN Reference

Methods​

toJSON()​

toJSON(): RTCIceCandidateInit;

The RTCIceCandidate method toJSON() converts the RTCIceCandidate on which it's called into JSON.

MDN Reference

Returns​

RTCIceCandidateInit

Properties​

address​

readonly address: string | null;

The RTCIceCandidate interface's read-only address property is a string providing the IP address of the device which is the source of the candidate. The address is null by default if not otherwise specified.

MDN Reference

candidate​

readonly candidate: string;

The read-only property candidate on the RTCIceCandidate interface returns a string describing the candidate in detail. Most of the other properties of RTCIceCandidate are actually extracted from this string.

MDN Reference

component​

readonly component: RTCIceComponent | null;

The read-only component property on the RTCIceCandidate interface is a string which indicates whether the candidate is an RTP or an RTCP candidate.

MDN Reference

foundation​

readonly foundation: string | null;

The foundation read-only property of the RTCIceCandidate interface is a string that allows correlation of candidates from a common network path on multiple RTCIceTransport objects.

MDN Reference

port​

readonly port: number | null;

The RTCIceCandidate interface's read-only port property contains the port number on the device at the address given by RTCIceCandidate.address at which the candidate's peer can be reached.

MDN Reference

priority​

readonly priority: number | null;

The RTCIceCandidate interface's read-only priority property specifies the candidate's priority according to the remote peer; the higher this value is, the better the remote peer considers the candidate to be.

MDN Reference

protocol​

readonly protocol: RTCIceProtocol | null;

The RTCIceCandidate interface's read-only protocol property is a string which indicates whether the candidate uses UDP or TCP as its transport protocol.

MDN Reference

relatedAddress​

readonly relatedAddress: string | null;

The RTCIceCandidate interface's read-only relatedAddress property is a string indicating the related address of a relay or reflexive candidate.

MDN Reference

relatedPort​

readonly relatedPort: number | null;

The RTCIceCandidate interface's read-only relatedPort property indicates the port number of reflexive or relay candidates.

MDN Reference

sdpMid​

readonly sdpMid: string | null;

The read-only property sdpMid on the RTCIceCandidate interface returns a string specifying the media stream identification tag of the media component with which the candidate is associated. This ID uniquely identifies a given stream for the component with which the candidate is associated.

MDN Reference

sdpMLineIndex​

readonly sdpMLineIndex: number | null;

The read-only sdpMLineIndex property on the RTCIceCandidate interface is a zero-based index of the m-line describing the media associated with the candidate.

MDN Reference

tcpType​

readonly tcpType: RTCIceTcpCandidateType | null;

The RTCIceCandidate interface's read-only tcpType property is included on TCP candidates to provide additional details about the candidate type.

MDN Reference

type​

readonly type: RTCIceCandidateType | null;

The RTCIceCandidate interface's read-only type specifies the type of candidate the object represents.

MDN Reference

usernameFragment​

readonly usernameFragment: string | null;

The read-only usernameFragment property on the RTCIceCandidate interface is a string indicating the username fragment ("ufrag") that uniquely identifies a single ICE interaction session.

MDN Reference