iceGatheringState property

RTCIceGatheringState get iceGatheringState

The iceGatheringState read-only property of the RTCPeerConnection interface returns a string that describes the overall ICE gathering state for this connection. 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 RTCPeerConnection.icegatheringstatechange_event.

Note that iceGatheringState represents the overall gathering state of the connection, including every RTCIceTransport used by every RTCRtpSender and every RTCRtpReceiver on the entire connection. This contrasts with RTCIceTransport.gatheringState, which represents the gathering state for a single transport.

Implementation

external RTCIceGatheringState get iceGatheringState;