com.github.theholywaffle.teamspeak3.api.Codec Maven / Gradle / Ivy
Show all versions of teamspeak3-api Show documentation
package com.github.theholywaffle.teamspeak3.api;
/*
* #%L
* TeamSpeak 3 Java API
* %%
* Copyright (C) 2014 Bert De Geyter
* %%
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
* #L%
*/
import com.github.theholywaffle.teamspeak3.TS3Api;
import java.util.Map;
/**
* Voice codecs currently used by TeamSpeak3.
*
* A channel's codec may be edited by using {@link TS3Api#editChannel(int, Map)}.
* All voice data may also be encrypted.
*
*/
public enum Codec {
/**
* 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_NARROWBAND(0),
/**
* 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_WIDEBAND(1),
/**
* 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
*
*/
SPEEX_ULTRAWIDEBAND(2),
/**
* 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
*
*/
CELT_MONO(3),
/**
* 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_VOICE(4),
/**
* 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
*
*/
OPUS_MUSIC(5),
/**
* An unknown codec.
*
* If you ever encounter an unknown codec, please tell us!
* We may have to update the API.
*
*/
UNKNOWN(-1);
private final int i;
Codec(int i) {
this.i = i;
}
public int getIndex() {
return i;
}
}