RTCPeerConnection: iceGatheringState property

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.

The iceGatheringState read-only property of the RTCPeerConnection interface returns a string that describes the overall ICE gathering state for this connection. 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.

Note that iceGatheringState represents the overall gathering state of the connection, including every RTCIceTransport used by every RTCRtpSender and every RTCRtpReceiver on the entire connection. This contrasts with RTCIceTransport.gatheringState, which represents the gathering state for a single transport.

Value

The possible values are:

new

The peer connection was just created and hasn't done any networking yet.

gathering

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

Example

js
const pc = new RTCPeerConnection();
const state = pc.iceGatheringState;

Specifications

Specification
WebRTC: Real-Time Communication in Browsers
# dom-peerconnection-ice-gathering-state

Browser compatibility

BCD tables only load in the browser

See also