discord4j.voice

Enum VoiceConnection.State

java.lang.Object

java.lang.Enum<VoiceConnection.State>

discord4j.voice.VoiceConnection.State

All Implemented Interfaces:

Serializable, Comparable<VoiceConnection.State>

Enclosing interface:

VoiceConnection

public static enum VoiceConnection.State
extends Enum<VoiceConnection.State>

States of a voice connection.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECTED Voice connection is active and capable of handling audio.
CONNECTING Performing a handshake to establish a voice gateway session.
DISCONNECTED A voice connection that has disconnected.
RECONNECTING A voice connection that is scheduled for a reconnect attempt.
RESUMING A voice connection that is scheduled for a resume attempt.

Method Summary

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

CONNECTING

public static final VoiceConnection.State CONNECTING

Performing a handshake to establish a voice gateway session.

CONNECTED

public static final VoiceConnection.State CONNECTED

Voice connection is active and capable of handling audio.

RESUMING

public static final VoiceConnection.State RESUMING

A voice connection that is scheduled for a resume attempt.

RECONNECTING

public static final VoiceConnection.State RECONNECTING

A voice connection that is scheduled for a reconnect attempt.

DISCONNECTED

public static final VoiceConnection.State DISCONNECTED

A voice connection that has disconnected.

Method Detail

values

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

Returns:

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

valueOf

public static VoiceConnection.State 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