RTCIceTransport | @foxy.io/sdk

Provides access to information about the ICE transport layer over which the data is being sent and received.

Hierarchy

EventTarget
- RTCIceTransport

Index

Properties

Methods

Properties

Readonly component

component: RTCIceComponent

Readonly gatheringState

gatheringState: RTCIceGathererState

ongatheringstatechange

ongatheringstatechange: null | ((this: RTCIceTransport, ev: Event) => any)

onselectedcandidatepairchange

onselectedcandidatepairchange: null | ((this: RTCIceTransport, ev: Event) => any)

onstatechange

onstatechange: null | ((this: RTCIceTransport, ev: Event) => any)

Readonly role

role: RTCIceRole

Readonly state

state: RTCIceTransportState

Methods

addEventListener

addEventListener<K>(type: K, listener: ((this: RTCIceTransport, ev: RTCIceTransportEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:12142
Type Parameters
- K extends "statechange" | "gatheringstatechange" | "selectedcandidatepairchange"
Parameters
- type: K
- listener: ((this: RTCIceTransport, ev: RTCIceTransportEventMap[K]) => any)
  - - (this: RTCIceTransport, ev: RTCIceTransportEventMap[K]): any
    - Parameters
      - this: RTCIceTransport
      - ev: RTCIceTransportEventMap[K]
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:12143
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5428
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

Parameters
- event: Event
Returns boolean

getLocalCandidates

getLocalCandidates(): RTCIceCandidate[]

- Defined in node_modules/typescript/lib/lib.dom.d.ts:12137
Returns RTCIceCandidate[]

getLocalParameters

getLocalParameters(): null | RTCIceParameters

- Defined in node_modules/typescript/lib/lib.dom.d.ts:12138
Returns null | RTCIceParameters

getRemoteCandidates

getRemoteCandidates(): RTCIceCandidate[]

- Defined in node_modules/typescript/lib/lib.dom.d.ts:12139
Returns RTCIceCandidate[]

getRemoteParameters

getRemoteParameters(): null | RTCIceParameters

- Defined in node_modules/typescript/lib/lib.dom.d.ts:12140
Returns null | RTCIceParameters

getSelectedCandidatePair

getSelectedCandidatePair(): null | RTCIceCandidatePair

- Defined in node_modules/typescript/lib/lib.dom.d.ts:12141
Returns null | RTCIceCandidatePair

removeEventListener

removeEventListener<K>(type: K, listener: ((this: RTCIceTransport, ev: RTCIceTransportEventMap[K]) => any), options?: boolean | EventListenerOptions): void
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:12144
Type Parameters
- K extends "statechange" | "gatheringstatechange" | "selectedcandidatepairchange"
Parameters
- type: K
- listener: ((this: RTCIceTransport, ev: RTCIceTransportEventMap[K]) => any)
  - - (this: RTCIceTransport, ev: RTCIceTransportEventMap[K]): any
    - Parameters
      - this: RTCIceTransport
      - ev: RTCIceTransportEventMap[K]
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:12145
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

Hierarchy

Index

Properties

Methods

Properties

Readonly component

Readonly gatheringState

ongatheringstatechange

onselectedcandidatepairchange

onstatechange

Readonly role

Readonly state

Methods

addEventListener

Type Parameters

K extends "statechange" | "gatheringstatechange" | "selectedcandidatepairchange"

Parameters

type: K

listener: ((this: RTCIceTransport, ev: RTCIceTransportEventMap[K]) => any)

Parameters

this: RTCIceTransport

ev: RTCIceTransportEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

dispatchEvent

Parameters

event: Event

Returns boolean

getLocalCandidates

Returns RTCIceCandidate[]

getLocalParameters

Returns null | RTCIceParameters

getRemoteCandidates

Returns RTCIceCandidate[]

getRemoteParameters

Returns null | RTCIceParameters

getSelectedCandidatePair

Returns null | RTCIceCandidatePair

removeEventListener

Type Parameters

K extends "statechange" | "gatheringstatechange" | "selectedcandidatepairchange"

Parameters

type: K

listener: ((this: RTCIceTransport, ev: RTCIceTransportEventMap[K]) => any)

Parameters

this: RTCIceTransport

ev: RTCIceTransportEventMap[K]

Returns any

Optional options: boolean | EventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | EventListenerOptions

Returns void