Share via


iceConnectionState property

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

The iceConnectionState property indicates whether the remote peer can accept trickled ICE candidates.

This property is read-only.

Syntax

JavaScript
state = object.iceConnectionState

 

Property values

Type: RTCIceConnectionState

Remarks

The RTCIceConnectionState enum (the type of the iceConnectionState property) has the following enumerations:

Member Description
"new" Waiting for remote candidates to be added. Any of the RTCIceTransports are new (with none checking, failed, or disconnected), or all are closed.
"checking" The RTCIceTransports are being checked and none of them have failed or been disconnected yet.
"connected" The connection is established. All RTCIceTransports are either connected, completed, or closed and at least one of them is in the "connected" state.
"completed" A connection has been found for all components. All RTCIceTransports are completed or closed and at least one of them is in the "completed" state.
"failed" A connection has not been made due to all components not being matched up. Any of the RTCIceTransports have failed.
"disconnected" Any of the RTCIceTransports have been disconnected.
"closed" The RTCPeerConnection is no longer handling requests.

 

See also

RTCPeerConnection