Module webrtc.java

Package dev.onvoid.webrtc

Enum RTCSignalingState

java.lang.Object

java.lang.Enum<RTCSignalingState>

dev.onvoid.webrtc.RTCSignalingState

All Implemented Interfaces:

Serializable, Comparable<RTCSignalingState>

public enum RTCSignalingState
extends Enum<RTCSignalingState>

Describes the state of the signaling process on the local end of the RTCPeerConnection.

Author:

Alex Andres

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSED	The RTCPeerConnection has been closed.
HAVE_LOCAL_OFFER	A local description, of type "offer", has been successfully applied.
HAVE_LOCAL_PR_ANSWER	A remote description of type "offer" has been successfully applied and a local description of type "pranswer" has been successfully applied.
HAVE_REMOTE_OFFER	A remote description, of type "offer", has been successfully applied.
HAVE_REMOTE_PR_ANSWER	A local description of type "offer" has been successfully applied and a remote description of type "pranswer" has been successfully applied.
STABLE	There is no offer/answer exchange in progress.

Method Summary

Modifier and Type	Method	Description
static RTCSignalingState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RTCSignalingState[]	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

STABLE

public static final RTCSignalingState STABLE

There is no offer/answer exchange in progress. This is also the initial state, in which case the local and remote descriptions are empty.

HAVE_LOCAL_OFFER

public static final RTCSignalingState HAVE_LOCAL_OFFER

A local description, of type "offer", has been successfully applied.

HAVE_LOCAL_PR_ANSWER

public static final RTCSignalingState HAVE_LOCAL_PR_ANSWER

A remote description of type "offer" has been successfully applied and a local description of type "pranswer" has been successfully applied.

HAVE_REMOTE_OFFER

public static final RTCSignalingState HAVE_REMOTE_OFFER

A remote description, of type "offer", has been successfully applied.

HAVE_REMOTE_PR_ANSWER

public static final RTCSignalingState HAVE_REMOTE_PR_ANSWER

A local description of type "offer" has been successfully applied and a remote description of type "pranswer" has been successfully applied.

CLOSED

public static final RTCSignalingState CLOSED

The RTCPeerConnection has been closed.

Method Detail

values

public static RTCSignalingState[] 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 (RTCSignalingState c : RTCSignalingState.values())
    System.out.println(c);

Returns:

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

valueOf

public static RTCSignalingState 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