Interface RTCIceTransport
gatheringState: RTCIceGathererState;
ongatheringstatechange: ((this: RTCIceTransport, ev: Event) => any) | null;
onselectedcandidatepairchange:
| ((this: RTCIceTransport, ev: Event) => any)
| null;
onstatechange: ((this: RTCIceTransport, ev: Event) => any) | null;
state: RTCIceTransportState;
addEventListener<K extends keyof RTCIceTransportEventMap>(
type: K,
listener: (this: RTCIceTransport, ev: RTCIceTransportEventMap[K]) => any,
options?: boolean | AddEventListenerOptions,
): void;
addEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | AddEventListenerOptions,
): void;
dispatchEvent(event: Event): boolean;
getSelectedCandidatePair(): RTCIceCandidatePair | null;
removeEventListener<K extends keyof RTCIceTransportEventMap>(
type: K,
listener: (this: RTCIceTransport, ev: RTCIceTransportEventMap[K]) => any,
options?: boolean | EventListenerOptions,
): void;
removeEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | EventListenerOptions,
): void;
}
Hierarchy
- EventTarget
- RTCIceTransport
Properties
ReadonlygatheringState
The gatheringState read-only property of the RTCIceTransport interface returns a string that indicates the current gathering state of the ICE agent for this transport: 'new', 'gathering', or 'complete'.
ongatheringstatechange
onselectedcandidatepairchange
onstatechange
Readonlystate
The state read-only property of the RTCIceTransport interface returns the current state of the ICE transport, so you can determine the state of ICE gathering in which the ICE agent currently is operating.
Methods
addEventListener
- addEventListener<K extends keyof RTCIceTransportEventMap>(
type: K,
listener: (this: RTCIceTransport, ev: RTCIceTransportEventMap[K]) => any,
options?: boolean | AddEventListenerOptions,
): voidThe
addEventListener()method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.Type Parameters
- K extends keyof RTCIceTransportEventMap
Parameters
- type: K
- listener: (this: RTCIceTransport, ev: RTCIceTransportEventMap[K]) => any
Optionaloptions: boolean | AddEventListenerOptions
Returns void
- addEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | AddEventListenerOptions,
): voidThe
addEventListener()method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.Parameters
- type: string
- listener: EventListenerOrEventListenerObject
Optionaloptions: boolean | AddEventListenerOptions
Returns void
dispatchEvent
The
dispatchEvent()method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.Parameters
- event: Event
Returns boolean
getSelectedCandidatePair
The
getSelectedCandidatePair()method of the RTCIceTransport interface returns an RTCIceCandidatePair object containing the current best-choice pair of ICE candidates describing the configuration of the endpoints of the transport.Returns RTCIceCandidatePair | null
removeEventListener
- removeEventListener<K extends keyof RTCIceTransportEventMap>(
type: K,
listener: (this: RTCIceTransport, ev: RTCIceTransportEventMap[K]) => any,
options?: boolean | EventListenerOptions,
): voidThe
removeEventListener()method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.Type Parameters
- K extends keyof RTCIceTransportEventMap
Parameters
- type: K
- listener: (this: RTCIceTransport, ev: RTCIceTransportEventMap[K]) => any
Optionaloptions: boolean | EventListenerOptions
Returns void
- removeEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | EventListenerOptions,
): voidThe
removeEventListener()method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.Parameters
- type: string
- listener: EventListenerOrEventListenerObject
Optionaloptions: boolean | EventListenerOptions
Returns void
The
RTCIceTransportinterface provides access to information about the ICE transport layer over which the data is being sent and received.MDN Reference