RTCIceCandidate

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

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;
    sdpMLineIndex: null | number;
    sdpMid: null | string;
    tcpType: null | RTCIceTcpCandidateType;
    type: null | RTCIceCandidateType;
    usernameFragment: null | string;
    toJSON(): RTCIceCandidateInit;
}

Index

Properties

<internal>.RTCIceCandidate.address <internal>.RTCIceCandidate.candidate <internal>.RTCIceCandidate.component <internal>.RTCIceCandidate.foundation <internal>.RTCIceCandidate.port <internal>.RTCIceCandidate.priority <internal>.RTCIceCandidate.protocol <internal>.RTCIceCandidate.relatedAddress <internal>.RTCIceCandidate.relatedPort <internal>.RTCIceCandidate.sdpMLineIndex <internal>.RTCIceCandidate.sdpMid <internal>.RTCIceCandidate.tcpType <internal>.RTCIceCandidate.type <internal>.RTCIceCandidate.usernameFragment

Methods

<internal>.RTCIceCandidate.toJSON

Properties

`Readonly`address

address: null | string

`Readonly`candidate

candidate: string

`Readonly`component

component: null | RTCIceComponent

`Readonly`foundation

foundation: null | string

`Readonly`port

port: null | number

`Readonly`priority

priority: null | number

`Readonly`protocol

protocol: null | RTCIceProtocol

`Readonly`relatedAddress

relatedAddress: null | string

`Readonly`relatedPort

relatedPort: null | number

`Readonly`sdpMLineIndex

sdpMLineIndex: null | number

`Readonly`sdpMid

sdpMid: null | string

`Readonly`tcpType

tcpType: null | RTCIceTcpCandidateType

`Readonly`type

type: null | RTCIceCandidateType

`Readonly`usernameFragment

usernameFragment: null | string

Methods

toJSON

toJSON(): RTCIceCandidateInit

Returns RTCIceCandidateInit