RTCPeerConnection.connectionState

A propriedade connectionState do tipo somente leitura da interface RTCPeerConnection indica o estado atual da conexão em par, devolvendo um valor em string específicado por um enum RTCPeerConnection.

Quando o valor da propriedade muda, o evento connectionstatechange é enviado para a intância RTCPeerConnection.

Syntax

var connectionState = RTCPeerConnection.connectionState;

Value

O estado atual da conexão, como um valor do enum RTCPeerConnectionState.

RTCPeerConnectionState enum

The RTCPeerConnectionState enum defines string constants which describe states in which the RTCPeerConnection may be. These values are returned by the connectionState property. This state essentially represents the aggregate state of all ICE transports (which are of type RTCIceTransport or RTCDtlsTransport (en-US)) being used by the connection.

Constant Description
"new" At least one of the connection's ICE transports (RTCIceTransports or RTCDtlsTransport (en-US)s) are in the "new" state, and none of them are in one of the following states: "connecting", "checking", "failed", or "disconnected", or all of the connection's transports are in the "closed" state.
"connecting" One or more of the ICE transports are currently in the process of establishing a connection; that is, their RTCIceConnectionState is either "checking" or "connected", and no transports are in the "failed" state. <<< Make this a link once I know where that will be documented
"connected" Every ICE transport used by the connection is either in use (state "connected" or "completed") or is closed (state "closed"); in addition, at least one transport is either "connected" or "completed".
"disconnected" At least one of the ICE transports for the connection is in the "disconnected" state and none of the other transports are in the state "failed", "connecting", or "checking".
"failed" One or more of the ICE transports on the connection is in the "failed" state.
"closed" The RTCPeerConnection is closed.This value was in the RTCSignalingState enum (and therefore found by reading the value of the signalingState (en-US)) property until the May 13, 2016 draft of the specification.

Example

var pc = new RTCPeerConnection(configuration);

/* ... */

var connectionState = pc.connectionState;

Specifications

Specification Status Comment
WebRTC 1.0: Real-time Communication Between Browsers
The definition of 'RTCPeerConnection.connectionState' in that specification.		 Candidata a Recomendação Initial specification.

Compatibilidade com navegadores

BCD tables only load in the browser

See also