RTCIceTransport

Overview

The RTCIceTransport interface provides access to information about the ICE transport layer over which the data is being sent and received.

Location

 

component

 

property component: String read;

 

String component { get; }

 

var component: String { get{} }

 

String component { __get; }

 

ReadOnly Property component() As String

gatheringState

 

property gatheringState: String read;

 

String gatheringState { get; }

 

var gatheringState: String { get{} }

 

String gatheringState { __get; }

 

ReadOnly Property gatheringState() As String

getLocalCandidates

Returns an array of RTCIceCandidate objects, each describing one of the ICE candidates that have been gathered so far for the local device. These are the same candidates which have already been sent to the remote peer by sending an icecandidate event to the RTCPeerConnection for transmission.

 

method getLocalCandidates: array of RTCIceCandidate

 

RTCIceCandidate[] getLocalCandidates()

 

func getLocalCandidates() -> RTCIceCandidate...

 

RTCIceCandidate[] getLocalCandidates()

 

Function getLocalCandidates() As RTCIceCandidate()

getLocalParameters

Returns a RTCIceParameters object describing the ICE parameters established by a call to the RTCPeerConnection.setLocalDescription() method. Returns null if parameters have not yet been received.

 

method getLocalParameters: dynamic

 

dynamic getLocalParameters()

 

func getLocalParameters() -> dynamic

 

dynamic getLocalParameters()

 

Function getLocalParameters() As dynamic

getRemoteCandidates

Returns an array of RTCIceCandidate objects, one for each of the remote device's ICE candidates that have been received by the local end of the RTCPeerConnection and delivered to ICE by calling addIceCandidate().

 

method getRemoteCandidates: array of RTCIceCandidate

 

RTCIceCandidate[] getRemoteCandidates()

 

func getRemoteCandidates() -> RTCIceCandidate...

 

RTCIceCandidate[] getRemoteCandidates()

 

Function getRemoteCandidates() As RTCIceCandidate()

getRemoteParameters

Returns a RTCIceParameters object containing the ICE parameters for the remote device, as set by a call to RTCPeerConnection.setRemoteDescription(). If setRemoteDescription() hasn't been called yet, the return value is null.

 

method getRemoteParameters: dynamic

 

dynamic getRemoteParameters()

 

func getRemoteParameters() -> dynamic

 

dynamic getRemoteParameters()

 

Function getRemoteParameters() As dynamic

getSelectedCandidatePair

Returns a RTCIceCandidatePair object that identifies the two candidates—one for each end of the connection—that have been selected so far. It's possible that a better pair will be found and selected later; if you need to keep up with this, watch for the selectedcandidatepairchange event. If no candidate pair has been selected yet, the return value is null.

 

method getSelectedCandidatePair: dynamic

 

dynamic getSelectedCandidatePair()

 

func getSelectedCandidatePair() -> dynamic

 

dynamic getSelectedCandidatePair()

 

Function getSelectedCandidatePair() As dynamic

role

 

property role: String read;

 

String role { get; }

 

var role: String { get{} }

 

String role { __get; }

 

ReadOnly Property role() As String

state

 

property state: String read;

 

String state { get; }

 

var state: String { get{} }

 

String state { __get; }

 

ReadOnly Property state() As String

 

component

 

property component: String read;

 

String component { get; }

 

var component: String { get{} }

 

String component { __get; }

 

ReadOnly Property component() As String

gatheringState

 

property gatheringState: String read;

 

String gatheringState { get; }

 

var gatheringState: String { get{} }

 

String gatheringState { __get; }

 

ReadOnly Property gatheringState() As String

role

 

property role: String read;

 

String role { get; }

 

var role: String { get{} }

 

String role { __get; }

 

ReadOnly Property role() As String

state

 

property state: String read;

 

String state { get; }

 

var state: String { get{} }

 

String state { __get; }

 

ReadOnly Property state() As String

 

getLocalCandidates

Returns an array of RTCIceCandidate objects, each describing one of the ICE candidates that have been gathered so far for the local device. These are the same candidates which have already been sent to the remote peer by sending an icecandidate event to the RTCPeerConnection for transmission.

 

method getLocalCandidates: array of RTCIceCandidate

 

RTCIceCandidate[] getLocalCandidates()

 

func getLocalCandidates() -> RTCIceCandidate...

 

RTCIceCandidate[] getLocalCandidates()

 

Function getLocalCandidates() As RTCIceCandidate()

getLocalParameters

Returns a RTCIceParameters object describing the ICE parameters established by a call to the RTCPeerConnection.setLocalDescription() method. Returns null if parameters have not yet been received.

 

method getLocalParameters: dynamic

 

dynamic getLocalParameters()

 

func getLocalParameters() -> dynamic

 

dynamic getLocalParameters()

 

Function getLocalParameters() As dynamic

getRemoteCandidates

Returns an array of RTCIceCandidate objects, one for each of the remote device's ICE candidates that have been received by the local end of the RTCPeerConnection and delivered to ICE by calling addIceCandidate().

 

method getRemoteCandidates: array of RTCIceCandidate

 

RTCIceCandidate[] getRemoteCandidates()

 

func getRemoteCandidates() -> RTCIceCandidate...

 

RTCIceCandidate[] getRemoteCandidates()

 

Function getRemoteCandidates() As RTCIceCandidate()

getRemoteParameters

Returns a RTCIceParameters object containing the ICE parameters for the remote device, as set by a call to RTCPeerConnection.setRemoteDescription(). If setRemoteDescription() hasn't been called yet, the return value is null.

 

method getRemoteParameters: dynamic

 

dynamic getRemoteParameters()

 

func getRemoteParameters() -> dynamic

 

dynamic getRemoteParameters()

 

Function getRemoteParameters() As dynamic

getSelectedCandidatePair

Returns a RTCIceCandidatePair object that identifies the two candidates—one for each end of the connection—that have been selected so far. It's possible that a better pair will be found and selected later; if you need to keep up with this, watch for the selectedcandidatepairchange event. If no candidate pair has been selected yet, the return value is null.

 

method getSelectedCandidatePair: dynamic

 

dynamic getSelectedCandidatePair()

 

func getSelectedCandidatePair() -> dynamic

 

dynamic getSelectedCandidatePair()

 

Function getSelectedCandidatePair() As dynamic