This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for the proper prefixes to use in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the spec changes.
The read-only property RTCPeerConnection.iceGatheringState
returns an enum of type RTCIceGatheringState
that describes the ICE gathering state for the connection.
Syntax
var state = peerConnection.iceGatheringState;
Value
The possible values are those of an enum of type RTCIceGatheringState
:
"new"
: the object was just created, and no networking has occurred yet."gathering"
: the ICE engine is in the process of gathering candidates for thisRTCPeerConnection
."complete"
: the ICE engine has completed gathering. Events such as adding a new interface or a new TURN server will cause the state to go back to gathering.
Example
var pc = new RTCPeerConnection(); var state = pc.iceGatheringState;
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browser The definition of 'RTCPeerConnection.iceGatheringState' in that specification. |
Working Draft | Initial specification. |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | (Yes) [1] | (Yes) [1] | Not supported | (Yes) | ? |
Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Basic support | ? | ? | ? | Not supported | ? | ? |
[1] Though this property is not prefixed, the interface it belongs to is.