com.github.theholywaffle.teamspeak3.api

Enum CodecEncryptionMode

java.lang.Object

java.lang.Enum<CodecEncryptionMode>

com.github.theholywaffle.teamspeak3.api.CodecEncryptionMode

All Implemented Interfaces:

Serializable, Comparable<CodecEncryptionMode>

public enum CodecEncryptionMode
extends Enum<CodecEncryptionMode>

Describes how the virtual server manages audio encryption.

Can be edited with TS3Api.editServer(Map).

Enum Constant Summary

Enum Constants

Enum Constant and Description
CODEC_CRYPT_DISABLED Audio encryption is globally disabled on this virtual server.
CODEC_CRYPT_ENABLED Audio encryption is globally enabled on this virtual server.
CODEC_CRYPT_INDIVIDUAL Each channel manages audio encryption on its own.
UNKNOWN An unknown codec encryption mode.

Method Summary

Methods

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

CODEC_CRYPT_INDIVIDUAL

public static final CodecEncryptionMode CODEC_CRYPT_INDIVIDUAL

Each channel manages audio encryption on its own.

See Also:

TS3Api.editChannel(int, Map)

CODEC_CRYPT_DISABLED

public static final CodecEncryptionMode CODEC_CRYPT_DISABLED

Audio encryption is globally disabled on this virtual server.

CODEC_CRYPT_ENABLED

public static final CodecEncryptionMode CODEC_CRYPT_ENABLED

Audio encryption is globally enabled on this virtual server.

UNKNOWN

public static final CodecEncryptionMode UNKNOWN

An unknown codec encryption mode.

If you ever encounter an unknown mode, please tell us! We may have to update the API.

Method Detail

values

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

Returns:

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

valueOf

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

getIndex

public int getIndex()