com.github.theholywaffle.teamspeak3.api

Enum Codec

java.lang.Object

java.lang.Enum<Codec>

com.github.theholywaffle.teamspeak3.api.Codec

All Implemented Interfaces:

Serializable, Comparable<Codec>

public enum Codec
extends Enum<Codec>

Voice codecs currently used by TeamSpeak3.

A channel's codec may be edited by using TS3Api.editChannel(int, Map). All voice data may also be encrypted.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CELT_MONO The CELT Mono codec.
OPUS_MUSIC The Opus codec optimised for music transmission.
OPUS_VOICE The Opus codec optimised for voice transmission.
SPEEX_NARROWBAND The Speex narrowband codec with a sampling rate of 8kHz.
SPEEX_ULTRAWIDEBAND The Speex ultra-wideband codec with a sampling rate of 32kHz.
SPEEX_WIDEBAND The Speex wideband codec with a sampling rate of 16kHz.
UNKNOWN An unknown codec.

Method Summary

Methods

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

SPEEX_NARROWBAND

public static final Codec SPEEX_NARROWBAND

The Speex narrowband codec with a sampling rate of 8kHz.

All Speex codecs are basically obsolete as Opus is better in every aspect and has a comparable required bandwidth.

• Bandwidth per client with codec quality 0: 2.49 KiB/s
• Bandwidth per client with codec quality 10: 5.22 KiB/s

SPEEX_WIDEBAND

public static final Codec SPEEX_WIDEBAND

The Speex wideband codec with a sampling rate of 16kHz.

All Speex codecs are basically obsolete as Opus is better in every aspect and has a comparable required bandwidth.

• Bandwidth per client with codec quality 0: 2.69 KiB/s
• Bandwidth per client with codec quality 10: 7.37 KiB/s

SPEEX_ULTRAWIDEBAND

public static final Codec SPEEX_ULTRAWIDEBAND

The Speex ultra-wideband codec with a sampling rate of 32kHz.

All Speex codecs are basically obsolete as Opus is better in every aspect and has a comparable required bandwidth.

• Bandwidth per client with codec quality 0: 2.73 KiB/s
• Bandwidth per client with codec quality 10: 7.57 KiB/s

CELT_MONO

public static final Codec CELT_MONO

The CELT Mono codec. It is optimised for music but still generates very good results in voice transmission.

Note that this codec requires the most bandwidth of all currently available codecs.

• Bandwidth per client with codec quality 0: 6.10 KiB/s
• Bandwidth per client with codec quality 10: 13.92 KiB/s

OPUS_VOICE

public static final Codec OPUS_VOICE

The Opus codec optimised for voice transmission.

This is the default codec used by TeamSpeak and usually achieves the best results for voice transmission.

• Bandwidth per client with codec quality 0: 2.73 KiB/s
• Bandwidth per client with codec quality 10: 7.71 KiB/s

OPUS_MUSIC

public static final Codec OPUS_MUSIC

The Opus codec optimised for music transmission.

Please note that if used only to transmit speech, this codec can sound worse than Opus Voice despite a higher bandwidth.

• Bandwidth per client with codec quality 0: 3.08 KiB/s
• Bandwidth per client with codec quality 10: 11.87 KiB/s

UNKNOWN

public static final Codec UNKNOWN

An unknown codec.

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

Method Detail

values

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

Returns:

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

valueOf

public static Codec 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()