/ fm / liveswitch / CandidatePairState

Enumeration: CandidatePairState

fm.liveswitch.CandidatePairState

The state of a candidate pair.

Table of contents

Enumeration members

• Closed
• ConnectivityLost
• Failed
• InProgress
• New
• Succeeded
• Waiting

Enumeration members

Closed

• Closed: = 6

Indicates that connectivity checks have been stopped intentionally due to transport closure.

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairState.ts:48

---

ConnectivityLost

• ConnectivityLost: = 7

Indicates that connectivity checks have succeeded in the past, but are currently not responding.

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairState.ts:55

---

Failed

• Failed: = 5

Indicates that all connectivity checks have timed out or produced a failure response.

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairState.ts:41

---

InProgress

• InProgress: = 3

Indicates that connectivity checks are in progress.

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairState.ts:28

---

New

• New: = 1

Indicates that the candidate pair has been formed, but connectivity checks have not yet started.

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairState.ts:15

---

Succeeded

• Succeeded: = 4

Indicates that a connectivity check was successful.

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairState.ts:34

---

Waiting

• Waiting: = 2

Indicates that the connectivity check is ready for connectivity checks, but checks have not yet started.

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairState.ts:22