org.xith3d.sound
Enum BufferFormat

java.lang.Object
  extended by java.lang.Enum<BufferFormat>
      extended by org.xith3d.sound.BufferFormat
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<BufferFormat>

public enum BufferFormat
extends java.lang.Enum<BufferFormat>

This is an abstraction for common sound formats.


Enum Constant Summary
MONO16
           
MONO8
           
STEREO16
           
STEREO8
           
 
Method Summary
 int getBits()
          The number of bits for this format.
static BufferFormat getFromValues(int bits, int channels)
          Selects the correct BufferFormat from int values.
 int getNumChannels()
          The number of channels for this format.
static BufferFormat valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static BufferFormat[] 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

MONO8

public static final BufferFormat MONO8

MONO16

public static final BufferFormat MONO16

STEREO8

public static final BufferFormat STEREO8

STEREO16

public static final BufferFormat STEREO16
Method Detail

values

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

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

valueOf

public static BufferFormat valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getBits

public final int getBits()
The number of bits for this format.

Returns:
the number of bits for this format.

getNumChannels

public final int getNumChannels()
The number of channels for this format.

Returns:
the number of channels for this format.

getFromValues

public static final BufferFormat getFromValues(int bits,
                                               int channels)
Selects the correct BufferFormat from int values.

Parameters:
bits -
channels -
Returns:
the selected format.