The read-only property RTCPeerConnection.iceGatheringState returns a string that describes the connection's ICE gathering state. This lets you detect, for example, when collection of ICE candidates has finished.
You can detect when the value of this property changes by watching for an event of type icegatheringstatechange.
The possible values are:
newThe peer connection was just created and hasn't done any networking yet.
gatheringThe ICE agent is in the process of gathering candidates for the connection.
complete The ICE agent has finished gathering candidates. If something happens that requires collecting new candidates, such as a new interface being added or the addition of a new ICE server, the state will revert to gathering to gather those candidates.
js
const pc = new RTCPeerConnection(); const state = pc.iceGatheringState;
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
iceGatheringState |
25 | 15 | 22 | No | 15 | 11 | 4.4 | 25 | 24 | 14 | 11 | 1.5 |
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/iceGatheringState