RTCPeerConnection: iceConnectionState-Eigenschaft

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.

Die schreibgeschützte Eigenschaft iceConnectionState der RTCPeerConnection Schnittstelle gibt einen String zurück, der den Zustand des mit der RTCPeerConnection verbundenen ICE-Agents beschreibt: new, checking, connected, completed, failed, disconnected und closed.

Sie beschreibt den aktuellen Zustand des ICE-Agents und seine Verbindung zum ICE-Server; das heißt, zum STUN- oder TURN-Server.

Sie können erkennen, wann sich dieser Wert geändert hat, indem Sie das iceconnectionstatechange-Ereignis beobachten.

Wert

Der aktuelle Zustand des ICE-Agents und seiner Verbindung. Der Wert ist einer der folgenden Strings:

new

Der ICE-Agent sammelt Adressen oder wartet darauf, über Aufrufe an RTCPeerConnection.addIceCandidate() mit entfernten Kandidaten versorgt zu werden (oder beides).

checking

Der ICE-Agent hat einen oder mehrere entfernte Kandidaten erhalten und überprüft Paare aus lokalen und entfernten Kandidaten auf gegenseitige Verträglichkeit, um ein kompatibles Paar zu finden, hat jedoch noch kein Paar gefunden, das die Peer-Verbindung ermöglichen würde. Es ist möglich, dass das Sammeln von Kandidaten ebenfalls noch im Gange ist.

connected

Ein verwendbares Paar aus lokalen und entfernten Kandidaten wurde für alle Komponenten der Verbindung gefunden und die Verbindung wurde hergestellt. Es ist möglich, dass das Sammeln noch im Gange ist, und es ist auch möglich, dass der ICE-Agent weiterhin Kandidaten gegeneinander überprüft, um eine bessere Verbindung zu finden.

completed

Der ICE-Agent hat das Sammeln der Kandidaten abgeschlossen, hat alle Paare gegeneinander überprüft und eine Verbindung für alle Komponenten gefunden.

failed

Der ICE-Agent hat alle Kandidatenpaare gegeneinander geprüft und es nicht geschafft, kompatible Paare für alle Komponenten der Verbindung zu finden. Es ist jedoch möglich, dass der ICE-Agent für einige Komponenten kompatible Verbindungen gefunden hat.

disconnected

Prüfungen zur Sicherstellung, dass Komponenten noch verbunden sind, sind bei mindestens einer Komponente der RTCPeerConnection fehlgeschlagen. Dies ist ein weniger strenger Test als failed und kann auf weniger zuverlässigen Netzwerken oder während vorübergehender Verbindungen sporadisch auftreten und ebenso spontan wieder gelöst werden. Wenn das Problem behoben ist, kann die Verbindung in den connected-Zustand zurückkehren.

closed

Der ICE-Agent für diese RTCPeerConnection wurde heruntergefahren und bearbeitet keine Anfragen mehr.

Beispiele

js
const pc = new RTCPeerConnection();
const state = pc.iceConnectionState;

Spezifikationen

Specification
WebRTC: Real-Time Communication in Browsers
# dom-peerconnection-ice-connection-state

Browser-Kompatibilität

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
iceConnectionState

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support

Siehe auch