Module webrtc.java

Package dev.onvoid.webrtc

Enum RTCIceGatheringState

java.lang.Object

java.lang.Enum<RTCIceGatheringState>

dev.onvoid.webrtc.RTCIceGatheringState

All Implemented Interfaces:

Serializable, Comparable<RTCIceGatheringState>

public enum RTCIceGatheringState
extends Enum<RTCIceGatheringState>

Describes the ICE gathering state for the RTCPeerConnection.

Author:

Alex Andres

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPLETE	At least one RTCIceTransport exists, and all RTCIceTransports are in the "COMPLETE" gathering state.
GATHERING	Any of the RTCIceTransports are in the "GATHERING" state.
NEW	Any of the RTCIceTransports are in the "NEW" gathering state and none of the transports are in the "GATHERING" state, or there are no transports.

Method Summary

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

Any of the RTCIceTransports are in the "NEW" gathering state and none of the transports are in the "GATHERING" state, or there are no transports.

GATHERING

public static final RTCIceGatheringState GATHERING

Any of the RTCIceTransports are in the "GATHERING" state.

COMPLETE

public static final RTCIceGatheringState COMPLETE

At least one RTCIceTransport exists, and all RTCIceTransports are in the "COMPLETE" gathering state.

Method Detail

values

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

Returns:

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

valueOf

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