RTCPeerConnection: connectionState-Eigenschaft
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since Mai 2023.
Die schreibgeschützte connectionState-Eigenschaft der RTCPeerConnection-Schnittstelle gibt den aktuellen Zustand der Peer-Verbindung durch die Rückgabe eines der folgenden String-Werte an: new, connecting, connected, disconnected, failed oder closed.
Dieser Zustand repräsentiert im Wesentlichen den zusammengefassten Zustand aller ICE-Transporte (die vom Typ RTCIceTransport oder RTCDtlsTransport sind), die von der Verbindung verwendet werden.
Ändert sich der Wert dieser Eigenschaft, wird ein connectionstatechange-Ereignis an die RTCPeerConnection-Instanz gesendet.
Wert
Ein String, der den aktuellen Zustand der Verbindung darstellt. Dieser kann einen der folgenden Werte annehmen:
new-
Mindestens einer der ICE Transports der Verbindung (
RTCIceTransportoderRTCDtlsTransportObjekte) befindet sich im Zustandnew, und keiner von ihnen ist in einem der folgenden Zustände:connecting,checking,failed,disconnected, oder alle Transporte der Verbindung sind im Zustandclosed. connecting-
Einer oder mehrere der ICE Transports sind aktuell dabei, eine Verbindung herzustellen; das heißt, ihr
iceConnectionStateist entwedercheckingoderconnected, und keine Transporte befinden sich im Zustandfailed. connected-
Jeder ICE Transport, der von der Verbindung genutzt wird, ist entweder in Gebrauch (Zustand
connectedodercompleted) oder ist geschlossen (Zustandclosed); zusätzlich ist mindestens ein Transport entwederconnectedodercompleted. disconnected-
Mindestens einer der ICE Transports der Verbindung befindet sich im Zustand
disconnectedund keiner der anderen Transporte ist in den Zuständen:failed,connectingoderchecking. failed-
Einer oder mehrere der ICE Transports der Verbindung befinden sich im Zustand
failed. closed-
Die
RTCPeerConnectionist geschlossen.
Beispiel
const peerConnection = new RTCPeerConnection(configuration);
// …
const connectionState = peerConnection.connectionState;
Spezifikationen
| Specification |
|---|
| WebRTC: Real-Time Communication in Browsers> # dom-peerconnection-connection-state> |