Module webrtc.java

Package dev.onvoid.webrtc

Enum RTCPeerConnectionState

java.lang.Object

java.lang.Enum<RTCPeerConnectionState>

dev.onvoid.webrtc.RTCPeerConnectionState

All Implemented Interfaces:

Serializable, Comparable<RTCPeerConnectionState>

public enum RTCPeerConnectionState
extends Enum<RTCPeerConnectionState>

Indicates the current state of the RTCPeerConnection.

Author:

Alex Andres

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSED	The RTCPeerConnection is closed.
CONNECTED	None of the previous states apply and all RTCIceTransports and RTCDtlsTransports are in the "CONNECTED", "COMPLETED" or "CLOSED" state.
CONNECTING	None of the previous states apply and all RTCIceTransports or RTCDtlsTransports are in the "NEW", "CONNECTING" or "CHECKING" state.
DISCONNECTED	None of the previous states apply and any RTCIceTransports or RTCDtlsTransports are in the "DISCONNECTED" state.
FAILED	The previous state doesn't apply and any RTCIceTransports or RTCDtlsTransports are in the "FAILED" state.
NEW	None of the previous states apply and all RTCIceTransports and RTCDtlsTransports are in the "NEW" or "CLOSED" state, or there are no transports.

Method Summary

Modifier and Type	Method	Description
static RTCPeerConnectionState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RTCPeerConnectionState[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEW

public static final RTCPeerConnectionState NEW

None of the previous states apply and all RTCIceTransports and RTCDtlsTransports are in the "NEW" or "CLOSED" state, or there are no transports.

CONNECTING

public static final RTCPeerConnectionState CONNECTING

None of the previous states apply and all RTCIceTransports or RTCDtlsTransports are in the "NEW", "CONNECTING" or "CHECKING" state.

CONNECTED

public static final RTCPeerConnectionState CONNECTED

None of the previous states apply and all RTCIceTransports and RTCDtlsTransports are in the "CONNECTED", "COMPLETED" or "CLOSED" state.

DISCONNECTED

public static final RTCPeerConnectionState DISCONNECTED

None of the previous states apply and any RTCIceTransports or RTCDtlsTransports are in the "DISCONNECTED" state.

FAILED

public static final RTCPeerConnectionState FAILED

The previous state doesn't apply and any RTCIceTransports or RTCDtlsTransports are in the "FAILED" state.

CLOSED

public static final RTCPeerConnectionState CLOSED

The RTCPeerConnection is closed.

Method Detail

values

public static RTCPeerConnectionState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RTCPeerConnectionState c : RTCPeerConnectionState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RTCPeerConnectionState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null