com.jogamp.openal.sound3d
Class Buffer

java.lang.Object
  extended by com.jogamp.openal.sound3d.Buffer

public class Buffer
extends Object

The Sound3D Buffer is a container for audio data used in the Sound3D environment.

Author:
Athomas Goldberg

Field Summary
static int FORMAT_MONO16
           
static int FORMAT_MONO8
           
static int FORMAT_STEREO16
           
static int FORMAT_STEREO8
           
 
Method Summary
 void configure(ByteBuffer data, int format, int freq)
          Configure the Sound3D buffer
 void delete()
          Delete this buffer, and free its resources.
 int getBitDepth()
          Get the bit-depth of the data, (8 or 16)
 ByteBuffer getData()
          Gets the raw data contained in this buffer.
 int getFrequency()
          Gets the audio frequency of the data contained in this buffer.
 int getNumChannels()
          Get the number of channels of the data (1-Mono, 2-Stereo)
 int getSize()
          Gets the size (in bytes) of the raw data containe in this buffer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FORMAT_MONO8

public static final int FORMAT_MONO8
See Also:
Constant Field Values

FORMAT_MONO16

public static final int FORMAT_MONO16
See Also:
Constant Field Values

FORMAT_STEREO8

public static final int FORMAT_STEREO8
See Also:
Constant Field Values

FORMAT_STEREO16

public static final int FORMAT_STEREO16
See Also:
Constant Field Values
Method Detail

configure

public void configure(ByteBuffer data,
                      int format,
                      int freq)
Configure the Sound3D buffer

Parameters:
data - the raw audio data
format - the format of the data: FORMAT_MONO8, FORMAT_MONO16, FORMAT_STEREO8 and FORMAT_STEREO16
freq - the frequency of the data

delete

public void delete()
Delete this buffer, and free its resources.


getBitDepth

public int getBitDepth()
Get the bit-depth of the data, (8 or 16)

Returns:
the bit-depth of the data

getNumChannels

public int getNumChannels()
Get the number of channels of the data (1-Mono, 2-Stereo)

Returns:
the number of audio channels.

getData

public ByteBuffer getData()
Gets the raw data contained in this buffer.

Returns:
the raw buffer data.

getFrequency

public int getFrequency()
Gets the audio frequency of the data contained in this buffer.

Returns:
the frequency of the data

getSize

public int getSize()
Gets the size (in bytes) of the raw data containe in this buffer.

Returns:
the size of the data.