Package net.dv8tion.jda.api.audio

Enum SpeakingMode

java.lang.Object

java.lang.Enum<SpeakingMode>

net.dv8tion.jda.api.audio.SpeakingMode

All Implemented Interfaces:

Serializable, Comparable<SpeakingMode>

public enum SpeakingMode
extends Enum<SpeakingMode>

Flags representing the speaking modes used by discord users.

Enum Constant Summary

Enum Constants

Enum Constant	Description
PRIORITY
SOUNDSHARE
VOICE

Method Summary

Modifier and Type	Method	Description
static EnumSet<SpeakingMode>	getModes(int mask)	Parses the active modes represented by the provided bitmask
int	getRaw()	The raw bitmask for this mode
static int	getRaw(Collection<SpeakingMode> modes)	Converts the given speaking modes into raw its bitmask.
static int	getRaw(SpeakingMode... modes)	Converts the given speaking modes into raw its bitmask.
static SpeakingMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SpeakingMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VOICE

public static final SpeakingMode VOICE

SOUNDSHARE

public static final SpeakingMode SOUNDSHARE

PRIORITY

public static final SpeakingMode PRIORITY

Method Detail

values

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

Returns:

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

valueOf

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

getRaw

public int getRaw()

The raw bitmask for this mode

Returns:

bitmask

getModes

@Nonnull
public static EnumSet<SpeakingMode> getModes(int mask)

Parses the active modes represented by the provided bitmask

Parameters:

mask - The bitmask containing the active speaking modes

Returns:

EnumSet containing the speaking modes

getRaw

public static int getRaw(@Nullable
                         SpeakingMode... modes)

Converts the given speaking modes into raw its bitmask. This is only useful for sending speaking updates.

Parameters:

modes - The modes

Returns:

The bitmask for the provided speaking modes

getRaw

public static int getRaw(@Nullable
                         Collection<SpeakingMode> modes)

Converts the given speaking modes into raw its bitmask. This is only useful for sending speaking updates.

Parameters:

modes - The modes

Returns:

The bitmask for the provided speaking modes