RTCPeerConnection.iceGatheringState

The read-only property RTCPeerConnection.iceGatheringState returns an enum of type RTCIceGatheringState that describes 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 those of an enum of type RTCIceGatheringState.

RTCIceGatheringState enum

The RTCIceGatheringState enum defines string constants which reflect the current status of ICE gathering, as returned using the RTCPeerConnection.iceGatheringState property. You can detect when this value changes by watching for an event of type icegatheringstatechange.

Example

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

Specifications

Browser compatibilityUpdate compatibility data on GitHub

See also

• icegatheringstatechange
• WebRTC