RTCPeerConnection.iceGatheringState

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.

Syntax

 var state = RTCPeerConnection.iceGatheringState;

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

var pc = new RTCPeerConnection();
var state = pc.iceGatheringState;

Specifications

Specification
WebRTC 1.0: Real-Time Communication Between Browsers (WebRTC 1.0)
# dom-peerconnection-ice-gathering-state

Browser compatibility

BCD tables only load in the browser

See also