Module org.refcodes.codec

Package org.refcodes.codec

Enum Class ModulationFormat

java.lang.Object

java.lang.Enum<ModulationFormat>

org.refcodes.codec.ModulationFormat

All Implemented Interfaces:

Serializable, Comparable<ModulationFormat>, Constable

public enum ModulationFormat
extends Enum<ModulationFormat>

Pulse-code modulation format: Defines the according pulse-code modulation format with the according silence threshold (root mean square).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BYTE
SHORT

Method Summary

Modifier and Type	Method	Description
int	getBytesPerSample()	Returns the bytes/sample for the according audio mode.
int	getSilenceThreshold()	Returns the root mean square silence threshold for the according audio mode.
static ModulationFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ModulationFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BYTE

public static final ModulationFormat BYTE

SHORT

public static final ModulationFormat SHORT

Method Details

values

public static ModulationFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ModulationFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getBytesPerSample

public int getBytesPerSample()

Returns the bytes/sample for the according audio mode.

Returns:

The according bytes/sample.

getSilenceThreshold

public int getSilenceThreshold()

Returns the root mean square silence threshold for the according audio mode.

Returns:

The according silence threshold.