state 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.]
Returns the current state of the RTCIceGatherer.
This property is read/write.
Syntax
| JavaScript |
|---|
object.state = state state = object.state |
Property values
Type: RTCIceGathererState
Use one of the following:
| Value | Condition |
|---|---|
| new | The object was just created, and no gathering has occurred yet. Since RTCIceGatherer objects gather upon construction, this state will only exist momentarily. |
| gathering | The RTCIceGatherer is in the process of gathering candidates (which includes adding new candidates and removing invalidated candidates). |
| complete | The RTCIceGatherer has completed gathering. Events such as adding, updating or removing an interface, or adding, changing or removing a TURN server will cause the state to go back to gathering before re-entering "complete" once all candidate changes are finalized. |
| closed | The RTCIceGatherer has been closed intentionally (by callling |
Standards information
See also
RTCIceGatherer
RTCIceGathererStateChangedEvent