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%
 */

public enum Codec {

	CODEC_SPEEX_NARROWBAND(0),
	CODEC_SPEEX_WIDEBAND(1),
	CODEC_SPEEX_ULTRAWIDEBAND(2),
	CODEC_CELT_MONO(3),
	UNKNOWN(-1);

	private final int i;

	Codec(int i) {
		this.i = i;
	}

	public int getIndex() {
		return i;
	}

}

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.HashMap;

/**
 * A list of codecs currently used by TeamSpeak.
 * <p>
 * A channel's codec may be edited by using {@link TS3Api#editChannel(int, HashMap)}.
 * All voice data may also be encrypted.
 * </p>
 */
public enum Codec {

	/**
	 * The Speex narrowband codec with a sampling rate of 8kHz.
	 * <p>
	 * All Speex codecs are basically obsolete as Opus is better
	 * in every aspect and has a comparable required bandwidth.
	 * </p><ul>
	 * <li>Bandwidth per client with codec quality 0: 2.49 KiB/s</li>
	 * <li>Bandwidth per client with codec quality 10: 5.22 KiB/s</li>
	 * </ul>
	 */
	SPEEX_NARROWBAND(0),

	/**
	 * The Speex wideband codec with a sampling rate of 16kHz.
	 * <p>
	 * All Speex codecs are basically obsolete as Opus is better
	 * in every aspect and has a comparable required bandwidth.
	 * </p><ul>
	 * <li>Bandwidth per client with codec quality 0: 2.69 KiB/s</li>
	 * <li>Bandwidth per client with codec quality 10: 7.37 KiB/s</li>
	 * </ul>
	 */
	SPEEX_WIDEBAND(1),

	/**
	 * The Speex ultra-wideband codec with a sampling rate of 32kHz.
	 * <p>
	 * All Speex codecs are basically obsolete as Opus is better
	 * in every aspect and has a comparable required bandwidth.
	 * </p><ul>
	 * <li>Bandwidth per client with codec quality 0: 2.73 KiB/s</li>
	 * <li>Bandwidth per client with codec quality 10: 7.57 KiB/s</li>
	 * </ul>
	 */
	SPEEX_ULTRAWIDEBAND(2),

	/**
	 * The CELT Mono codec. It is optimised for music but still generates very good
	 * results in voice transmission.
	 * <p>
	 * Note that this codec requires the most bandwidth of all currently available codecs.
	 * </p><ul>
	 * <li>Bandwidth per client with codec quality 0: 6.10 KiB/s</li>
	 * <li>Bandwidth per client with codec quality 10: 13.92 KiB/s</li>
	 * </ul>
	 */
	CELT_MONO(3),

	/**
	 * The Opus codec optimised for voice transmission.
	 * <p>
	 * This is the default codec used by TeamSpeak and usually achieves the
	 * best results for voice transmission.
	 * </p><ul>
	 * <li>Bandwidth per client with codec quality 0: 2.73 KiB/s</li>
	 * <li>Bandwidth per client with codec quality 10: 7.71 KiB/s</li>
	 * </ul>
	 */
	OPUS_VOICE(4),

	/**
	 * The Opus codec optimised for music transmission.
	 * <p>
	 * Please note that if used only to transmit speech, this codec can
	 * sound worse than Opus Voice despite a higher bandwidth.
	 * </p><ul>
	 * <li>Bandwidth per client with codec quality 0: 3.08 KiB/s</li>
	 * <li>Bandwidth per client with codec quality 10: 11.87 KiB/s</li>
	 * </ul>
	 */
	OPUS_MUSIC(5),

	/**
	 * An unknown codec.
	 * <p>
	 * If you ever encounter an unknown codec, please tell us!
	 * We may have to update the API.
	 * </p>
	 */
	UNKNOWN(-1);

	private final int i;

	Codec(int i) {
		this.i = i;
	}

	public int getIndex() {
		return i;
	}
}

Rename existing codecs and add missing Opus codecs. Added javadocs.