RTCIceTransport.gatheringState

The read-only RTCIceTransport property gatheringState returns a DOMString that indicates the current gathering state of the ICE agent: "new", "gathering", or "complete".

Syntax

gatherState = RTCIceTransport.gatheringState;

Value

A DOMString that indicates the current state of the ICE agent's candidate gathering process:

"new"

The RTCIceTransport is newly created and has not yet started to gather ICE candidates.

"gathering"

The transport is in the process of gathering candidates.

"complete"

The transport has finished gathering ICE candidates and has sent the end-of-candidates indicator to the remote device. The transport won't gather any further candidates unless an ICE restart occurs, at which point the gathering process starts over from scratch.

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
gatheringState
75
79
No
No
62
11
75
75
No
54
11
11.0

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/RTCIceTransport/gatheringState