Chartbreaker
    Preparing search index...

    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: null | string;
        candidate: string;
        component: null | RTCIceComponent;
        foundation: null | string;
        port: null | number;
        priority: null | number;
        protocol: null | RTCIceProtocol;
        relatedAddress: null | string;
        relatedPort: null | number;
        sdpMid: null | string;
        sdpMLineIndex: null | number;
        tcpType: null | RTCIceTcpCandidateType;
        type: null | RTCIceCandidateType;
        usernameFragment: null | string;
        toJSON(): RTCIceCandidateInit;
    }
    Index

    Properties

    address: null | string

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

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

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

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

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

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

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

    MDN Reference

    relatedPort: null | number

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

    MDN Reference

    sdpMid: null | string

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

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

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

    MDN Reference

    type: null | RTCIceCandidateType

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

    MDN Reference

    usernameFragment: null | string

    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