iceGatheringState

Summary

Returns the gathering state of the ICE agent.

Property of apis/webrtc/RTCPeerConnectionapis/webrtc/RTCPeerConnection

Syntax

Note: This property is read-only.

var result = element.iceGatheringState;

Return Value

Returns an object of type RTCGatheringStateRTCGatheringState

The RTCGatherState enum has the following values:

• new - The object was just created, and no networking has occurred yet.
• gathering - The ICE engine is in the process of gathering candidates for this RTCPeerConnection.
• complete - The ICE engine has completed gathering.

Notes

Events such as adding a new interface or new TURN server could cause the state to go back to gathering.