/ fm / liveswitch / IceConnectionState

Enumeration: IceConnectionState

fm.liveswitch.IceConnectionState

The state of an ICE gatherer.

Table of contents

Enumeration members

• Checking
• Closed
• Completed
• Connected
• Disconnected
• Failed
• New

Enumeration members

Checking

• Checking: = 2

Indicates that the ICE agent(s) has(ve) been given one or more remote candidates and is(are) checking pairs of local and remote candidates against one another to try to find a compatible match, but has(ve) not yet found a pair which will allow the peer connection to be made. It's possible that gathering of candidates is also still underway.

Defined in: Generated/TypeScript/fm.liveswitch/IceConnectionState.ts:20

---

Closed

• Closed: = 7

The ICE agent(s) for this RTCPeerConnection has shut down and is no longer handling requests

Defined in: Generated/TypeScript/fm.liveswitch/IceConnectionState.ts:50

---

Completed

• Completed: = 4

Indicates that the ICE agent has finished gathering candidates, has checked all pairs against one another, and has found a connection for all components.

Defined in: Generated/TypeScript/fm.liveswitch/IceConnectionState.ts:32

---

Connected

• Connected: = 3

Indicates that a usable pairing of local and remote candidates has been found for all components of the connection, and the connection has been established. It's possible that gathering is still underway, and it's also possible that the ICE agent is still checking candidates against one another looking for a better connection to use.

Defined in: Generated/TypeScript/fm.liveswitch/IceConnectionState.ts:26

---

Disconnected

• Disconnected: = 6

Indicates that checks to ensure that components are still connected failed for at least one component of the RTCPeerConnection. This is a less stringent test than "failed" and may trigger intermittently and resolve just as spontaneously on less reliable networks, or during temporary disconnections. When the problem resolves, the connection may return to the "Connected" state.

Defined in: Generated/TypeScript/fm.liveswitch/IceConnectionState.ts:44

---

Failed

• Failed: = 5

Indicates that the ICE candidate has checked all candidates pairs against one another and has failed to find compatible matches for all components of the connection. It is, however, possible that the ICE agent did find compatible connections for some components.

Defined in: Generated/TypeScript/fm.liveswitch/IceConnectionState.ts:38

---

New

• New: = 1

Indicates that the ICE agent(s) is(are) gathering addresses or is(are) waiting to be given remote candidates (or both)..

Defined in: Generated/TypeScript/fm.liveswitch/IceConnectionState.ts:14