The read-only RTCIceTransport property gatheringState returns a DOMString from the enumerated type RTCIceGathererState that indicates what gathering state the ICE agent is currently in: "new", "gathering", or "complete".
Syntax
gatherState = RTCIceTransport.gatheringState;
Value
A string from the RTCIceGathererState enumerated type whose value indicates the current state of the ICE agent's candidate gathering process:
"new"- The
RTCIceTransportis 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
| Specification | Status | Comment |
|---|---|---|
| WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCIceTransport.gatheringState' in that specification. |
Candidate Recommendation | Initial definition. |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
gatheringState | Chrome No support No | Edge No support No | Firefox No support No | IE No support No | Opera No support No | Safari Full support 11 | WebView Android No support No | Chrome Android No support No | Firefox Android No support No | Opera Android No support No | Safari iOS Full support 11 | Samsung Internet Android No support No |
Legend
- Full support
- Full support
- No support
- No support