The read-only RTCIceTransport
property gatheringState
returns a
DOMString
from the enumerated type RTCIceGathererState
that indicates what gathering state the ICE agent is currently in: "new"
,
"gathering"
, or "complete"
.
Syntax
gatherState = RTCIceTransport.gatheringState;
Value
A string from the RTCIceGathererState
enumerated type whose value
indicates the current state of the ICE agent's candidate gathering process:
"new"
- The
RTCIceTransport
is newly created and has not yet started to gather ICE candidates. "gathering"
- The transport is in the process of gathering candidates.
"complete"
- The transport has finished gathering ICE candidates and has sent the end-of-candidates indicator to the remote device. The transport won't gather any further candidates unless an ICE restart occurs, at which point the gathering process starts over from scratch.
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCIceTransport.gatheringState' in that specification. |
Candidate Recommendation | Initial definition. |
Browser compatibility
BCD tables only load in the browser