RTCIceCandidate

open class RTCIceCandidate(init: RTCLocalIceCandidateInit = definedExternally)(source)

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

Constructors

Link copied to clipboard
constructor(init: RTCLocalIceCandidateInit = definedExternally)

Properties

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
val port: Short?

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Functions

Link copied to clipboard

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