Join us online - 19th of November
Save your spot

Interface RTCIceTransport

The RTCIceTransport interface provides access to information about the ICE transport layer over which the data is being sent and received. This is particularly useful if you need to access state information about the connection.

MDN Reference

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
Index
gatheringState ongatheringstatechange onselectedcandidatepairchange onstatechange state
addEventListener dispatchEvent getSelectedCandidatePair removeEventListener
gatheringState: RTCIceGathererState

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".

MDN Reference

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

MDN Reference

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

MDN Reference

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

MDN Reference

state: RTCIceTransportState

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.

MDN Reference

  • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

    MDN Reference

    Type Parameters

    Parameters

    Returns void

  • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

    MDN Reference

    Parameters

    Returns void

  • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

  • 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.

    MDN Reference

    Returns RTCIceCandidatePair | null

  • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

    MDN Reference

    Type Parameters

    Parameters

    Returns void

  • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

    MDN Reference

    Parameters

    Returns void

Was this helpful?