Experimental
This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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.
| Constant | Description |
|---|---|
"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 | Status | Comment |
|---|---|---|
| WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCPeerConnection.iceGatheringState' in that specification. |
Candidate Recommendation | Initial specification. |
Browser compatibility
BCD tables only load in the browser