---
title: "RTCIceTransport | JavaScript maps SDK"
description: "Documentation for MapTiler SDK"
---

> For AI agents: a documentation index is available at [/llms.txt](https://docs.maptiler.com/llms.txt). Markdown versions of all pages are available by appending .md to any URL.

# 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](https://developer.mozilla.org/docs/Web/API/RTCIceTransport)

interface RTCIceTransport {  
    [gatheringState](#gatheringstate): [RTCIceGathererState](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.RTCIceGathererState/);  
    [ongatheringstatechange](#ongatheringstatechange): ((this: RTCIceTransport, ev: Event) \=> any) | null;  
    [onselectedcandidatepairchange](#onselectedcandidatepairchange):  
        | ((this: RTCIceTransport, ev: Event) \=> any)  
        | null;  
    [onstatechange](#onstatechange): ((this: RTCIceTransport, ev: Event) \=> any) | null;  
    [state](#state): [RTCIceTransportState](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.RTCIceTransportState/);  
    [addEventListener](#addeventlistener-1)<[K](#addeventlistenerk) extends keyof [RTCIceTransportEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.RTCIceTransportEventMap/)\>(  
        type: [K](#addeventlistenerk),  
        listener: (this: RTCIceTransport, ev: [RTCIceTransportEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.RTCIceTransportEventMap/)\[[K](#addeventlistenerk)\]) \=> any,  
        options?: boolean | AddEventListenerOptions,  
    ): void;  
    [addEventListener](#addeventlistener-2)(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | AddEventListenerOptions,  
    ): void;  
    [dispatchEvent](#dispatchevent-1)(event: Event): boolean;  
    [getSelectedCandidatePair](#getselectedcandidatepair-1)(): [RTCIceCandidatePair](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.RTCIceCandidatePair/) | null;  
    [removeEventListener](#removeeventlistener-1)<[K](#removeeventlistenerk) extends keyof [RTCIceTransportEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.RTCIceTransportEventMap/)\>(  
        type: [K](#removeeventlistenerk),  
        listener: (this: RTCIceTransport, ev: [RTCIceTransportEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.RTCIceTransportEventMap/)\[[K](#removeeventlistenerk)\]) \=> any,  
        options?: boolean | EventListenerOptions,  
    ): void;  
    [removeEventListener](#removeeventlistener-2)(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | EventListenerOptions,  
    ): void;  
}

#### Hierarchy

-   EventTarget
    -   RTCIceTransport

##### Index

### Properties[](#properties)

[gatheringState](#gatheringstate) [ongatheringstatechange](#ongatheringstatechange) [onselectedcandidatepairchange](#onselectedcandidatepairchange) [onstatechange](#onstatechange) [state](#state)

### Methods[](#methods)

[addEventListener](#addeventlistener) [dispatchEvent](#dispatchevent) [getSelectedCandidatePair](#getselectedcandidatepair) [removeEventListener](#removeeventlistener)

## Properties[](#properties-1)

### `Readonly`gatheringState[](#gatheringstate)

gatheringState: [RTCIceGathererState](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.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](https://developer.mozilla.org/docs/Web/API/RTCIceTransport/gatheringState)

### ongatheringstatechange[](#ongatheringstatechange)

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

[MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceTransport/gatheringstatechange_event)

### onselectedcandidatepairchange[](#onselectedcandidatepairchange)

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

[MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceTransport/selectedcandidatepairchange_event)

### onstatechange[](#onstatechange)

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

[MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceTransport/statechange_event)

### `Readonly`state[](#state)

state: [RTCIceTransportState](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.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](https://developer.mozilla.org/docs/Web/API/RTCIceTransport/state)

## Methods[](#methods-1)

### addEventListener[](#addeventlistener)

-   addEventListener<[K](#addeventlistenerk) extends keyof [RTCIceTransportEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.RTCIceTransportEventMap/)\>(  
        type: [K](#addeventlistenerk),  
        listener: (this: RTCIceTransport, ev: [RTCIceTransportEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.RTCIceTransportEventMap/)\[[K](#addeventlistenerk)\]) \=> any,  
        options?: boolean | AddEventListenerOptions,  
    ): void[](#addeventlistener-1)
    
    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](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
    
    #### Type Parameters
    
    -   K extends keyof [RTCIceTransportEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.RTCIceTransportEventMap/)
    
    #### Parameters
    
    -   type: [K](#addeventlistenerk)
    -   listener: (this: RTCIceTransport, ev: [RTCIceTransportEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.RTCIceTransportEventMap/)\[[K](#addeventlistenerk)\]) \=> any
    -   `Optional`options: boolean | AddEventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.addEventListener
    
-   addEventListener(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | AddEventListenerOptions,  
    ): void[](#addeventlistener-2)
    
    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](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
    
    #### Parameters
    
    -   type: string
    -   listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/)
    -   `Optional`options: boolean | AddEventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.addEventListener
    

### dispatchEvent[](#dispatchevent)

-   dispatchEvent(event: Event): boolean[](#dispatchevent-1)
    
    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](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
    
    #### Parameters
    
    -   event: Event
    
    #### Returns boolean
    
    Inherited from EventTarget.dispatchEvent
    

### getSelectedCandidatePair[](#getselectedcandidatepair)

-   getSelectedCandidatePair(): [RTCIceCandidatePair](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.RTCIceCandidatePair/) | null[](#getselectedcandidatepair-1)
    
    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](https://developer.mozilla.org/docs/Web/API/RTCIceTransport/getSelectedCandidatePair)
    
    #### Returns [RTCIceCandidatePair](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.RTCIceCandidatePair/) | null
    

### removeEventListener[](#removeeventlistener)

-   removeEventListener<[K](#removeeventlistenerk) extends keyof [RTCIceTransportEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.RTCIceTransportEventMap/)\>(  
        type: [K](#removeeventlistenerk),  
        listener: (this: RTCIceTransport, ev: [RTCIceTransportEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.RTCIceTransportEventMap/)\[[K](#removeeventlistenerk)\]) \=> any,  
        options?: boolean | EventListenerOptions,  
    ): void[](#removeeventlistener-1)
    
    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](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
    
    #### Type Parameters
    
    -   K extends keyof [RTCIceTransportEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.RTCIceTransportEventMap/)
    
    #### Parameters
    
    -   type: [K](#removeeventlistenerk)
    -   listener: (this: RTCIceTransport, ev: [RTCIceTransportEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.RTCIceTransportEventMap/)\[[K](#removeeventlistenerk)\]) \=> any
    -   `Optional`options: boolean | EventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.removeEventListener
    
-   removeEventListener(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | EventListenerOptions,  
    ): void[](#removeeventlistener-2)
    
    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](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
    
    #### Parameters
    
    -   type: string
    -   listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/)
    -   `Optional`options: boolean | EventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.removeEventListener