Interface 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

interface RTCIceCandidate {
    address: string | null;
    candidate: string;
    component: RTCIceComponent | null;
    foundation: string | null;
    port: number | null;
    priority: number | null;
    protocol: RTCIceProtocol | null;
    relatedAddress: string | null;
    relatedPort: number | null;
    sdpMid: string | null;
    sdpMLineIndex: number | null;
    tcpType: RTCIceTcpCandidateType | null;
    type: RTCIceCandidateType | null;
    usernameFragment: string | null;
    toJSON(): RTCIceCandidateInit;
}
Index

Properties

address candidate component foundation port priority protocol relatedAddress relatedPort sdpMid sdpMLineIndex tcpType type usernameFragment

Methods

toJSON

Properties

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.

MDN Reference

candidate: string

The read-only property candidate on the RTCIceCandidate interface returns a string describing the candidate in detail.

MDN Reference

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: 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: 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: 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: 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: 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: number | null

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

MDN Reference

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.

MDN Reference

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: 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: RTCIceCandidateType | null

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

MDN Reference

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

Methods

Settings

Member Visibility

On This Page

Properties
Methods