The state property in an RTCIceCandidatePairStats object indicates the state of the check list of which the candidate pair is a member.
Syntax
state = rtcIceCandidatePairStats.state;
Value
A DOMString whose value is one of those found in the RTCStatsIceCandidatePairState enumerated type.
ICE check lists
During ICE negotiation, the ICE layer builds up a check list, which is a list of potential pairings of ICE candidates. Each pair has a state, whose value is represented by RTCStatsIceCandidatePairState.
[[File:../../../../../../media.prod.mdn.mozit.cloud/attachments/2019/04/04/16570/f259ebc8c2fdf433de1b870968603418/ice-check-list-states.svg|A diagram showing how ICE candidate pairs change state as the check list is analyed]]
When a candidate pair is added to the check list, it begins in the frozen state. As soon as there are no checks ongoing which block the pair from being analyzed, it is unfrozen and moves into the waiting state. This may happen immediately upon being added to the check list.
Each time a candidate pair is done being checked, the next-highest priority candidate pair remaining on the check list moves from the waiting state to the in-progress state, and its check begins. If the check fails for any reason, the pair moves into its final state, failed. If the check succeeds, the pair ends up in the succeeded state.
The ICE check list state for any given pair of ICE candidates can be found in the corresponding the state property.
Specifications
| Specification | Status | Comment |
|---|---|---|
| Identifiers for WebRTC's Statistics APIThe definition of 'RTCIceCandidatePairStats.state' in that specification. | Candidate Recommendation | Initial specification. |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
state
|
Chrome
No support No |
Edge
No support No |
Firefox
Full support 29 |
IE
No support No |
Opera
? |
Safari
? |
WebView Android
No support No |
Chrome Android
No support No |
Firefox Android
Full support 29 |
Opera Android
? |
Safari iOS
? |
Samsung Internet Android
No support No |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
RTCIceCandidatePairStats.state by Mozilla Contributors is licensed under CC-BY-SA 2.5.
