org.jouvieje.fmodex.structures
Class FMOD_CODEC_WAVEFORMAT

java.lang.Object
  org.jouvieje.fmodex.utils.Pointer
      org.jouvieje.fmodex.structures.FMOD_CODEC_WAVEFORMAT

public class FMOD_CODEC_WAVEFORMAT

extends Pointer

Constructor Summary

FMOD_CODEC_WAVEFORMAT()
Create an object that holds a null FMOD_CODEC_WAVEFORMAT.

Method Summary

static FMOD_CODEC_WAVEFORMAT	allocate() Allocate a new FMOD_CODEC_WAVEFORMAT.
static FMOD_CODEC_WAVEFORMAT	asFMOD_CODEC_WAVEFORMAT(Pointer pointer) Create a view of the Pointer object as a FMOD_CODEC_WAVEFORMAT object.
int	getBlockAlign() [in] Blockalign in decompressed, PCM samples of the optimal decode chunk size for this format.
int	getChannelMask() [in] Microsoft speaker channel mask, as defined for WAVEFORMATEXTENSIBLE and is found in ksmedia.h.
int	getChannels() [in] Number of channels used by codec, ie mono = 1, stereo = 2.
FMOD_SOUND_FORMAT	getFormat() [in] Format for (decompressed) codec output, ie FMOD_SOUND_FORMAT_PCM8, FMOD_SOUND_FORMAT_PCM16.
int	getFrequency() [in] Default frequency in hz of the codec, ie 44100.
int	getLengthBytes() [in] Length in bytes of the source data.
int	getLengthPCM() [in] Length in decompressed, PCM samples of the file, ie length in seconds * frequency.
int	getLoopEnd() [in] Loopend in decompressed, PCM samples of file.
int	getLoopStart() [in] Loopstart in decompressed, PCM samples of file.
int	getMode() [in] Mode to determine whether the sound should by default load as looping, non looping, 2d or 3d.
java.nio.CharBuffer	getName() [in] Name of sound.
void	release()
void	setBlockAlign(int blockAlign) [in] Blockalign in decompressed, PCM samples of the optimal decode chunk size for this format.
void	setChannelMask(int channelMask) [in] Microsoft speaker channel mask, as defined for WAVEFORMATEXTENSIBLE and is found in ksmedia.h.
void	setChannels(int channels) [in] Number of channels used by codec, ie mono = 1, stereo = 2.
void	setFormat(FMOD_SOUND_FORMAT format) [in] Format for (decompressed) codec output, ie FMOD_SOUND_FORMAT_PCM8, FMOD_SOUND_FORMAT_PCM16.
void	setFrequency(int frequency) [in] Default frequency in hz of the codec, ie 44100.
void	setLengthBytes(int lengthBytes) [in] Length in bytes of the source data.
void	setLengthPCM(int lengthPCM) [in] Length in decompressed, PCM samples of the file, ie length in seconds * frequency.
void	setLoopEnd(int loopEnd) [in] Loopend in decompressed, PCM samples of file.
void	setLoopStart(int loopStart) [in] Loopstart in decompressed, PCM samples of file.
void	setMode(int mode) [in] Mode to determine whether the sound should by default load as looping, non looping, 2d or 3d.
void	setName(java.lang.String name) [in] Name of sound.

Methods inherited from class org.jouvieje.fmodex.utils.Pointer

asByteBuffer, asDouble, asFloat, asInt, asLong, asPointer, asString, asString, equals, isNull, shareMemory

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FMOD_CODEC_WAVEFORMAT

public FMOD_CODEC_WAVEFORMAT()

Create an object that holds a null FMOD_CODEC_WAVEFORMAT.
The call isNull() on the object created will returns true.

  FMOD_CODEC_WAVEFORMAT obj = new FMOD_CODEC_WAVEFORMAT();
  (obj == null) <=> false
  obj.isNull() <=> true
 

To creates a new FMOD_CODEC_WAVEFORMAT, use the static "constructor" :

  FMOD_CODEC_WAVEFORMAT obj = FMOD_CODEC_WAVEFORMAT.allocate();

See Also:

allocate()

Method Detail

asFMOD_CODEC_WAVEFORMAT

public static FMOD_CODEC_WAVEFORMAT asFMOD_CODEC_WAVEFORMAT(Pointer pointer)

Create a view of the Pointer object as a FMOD_CODEC_WAVEFORMAT object.
This view is valid only if the memory holded by the Pointer holds a FMOD_CODEC_WAVEFORMAT object.

allocate

public static FMOD_CODEC_WAVEFORMAT allocate()

Allocate a new FMOD_CODEC_WAVEFORMAT.
The call isNull() on the object created will return false.

  FMOD_CODEC_WAVEFORMAT obj = FMOD_CODEC_WAVEFORMAT.allocate();
  (obj == null) <=> obj.isNull() <=> false
 

release

public void release()

getName

public java.nio.CharBuffer getName()

[in] Name of sound.

setName

public void setName(java.lang.String name)

[in] Name of sound.

getFormat

public FMOD_SOUND_FORMAT getFormat()

[in] Format for (decompressed) codec output, ie FMOD_SOUND_FORMAT_PCM8, FMOD_SOUND_FORMAT_PCM16.

setFormat

public void setFormat(FMOD_SOUND_FORMAT format)

[in] Format for (decompressed) codec output, ie FMOD_SOUND_FORMAT_PCM8, FMOD_SOUND_FORMAT_PCM16.

getChannels

public int getChannels()

[in] Number of channels used by codec, ie mono = 1, stereo = 2.

setChannels

public void setChannels(int channels)

[in] Number of channels used by codec, ie mono = 1, stereo = 2.

getFrequency

public int getFrequency()

[in] Default frequency in hz of the codec, ie 44100.

setFrequency

public void setFrequency(int frequency)

[in] Default frequency in hz of the codec, ie 44100.

getLengthBytes

public int getLengthBytes()

[in] Length in bytes of the source data.

setLengthBytes

public void setLengthBytes(int lengthBytes)

[in] Length in bytes of the source data.

getLengthPCM

public int getLengthPCM()

[in] Length in decompressed, PCM samples of the file, ie length in seconds * frequency. Used for Sound::getLength and for memory allocation of static decompressed sample data.

setLengthPCM

public void setLengthPCM(int lengthPCM)

[in] Length in decompressed, PCM samples of the file, ie length in seconds * frequency. Used for Sound::getLength and for memory allocation of static decompressed sample data.

getBlockAlign

public int getBlockAlign()

[in] Blockalign in decompressed, PCM samples of the optimal decode chunk size for this format. The codec read callback will be called in multiples of this value.

setBlockAlign

public void setBlockAlign(int blockAlign)

[in] Blockalign in decompressed, PCM samples of the optimal decode chunk size for this format. The codec read callback will be called in multiples of this value.

getLoopStart

public int getLoopStart()

[in] Loopstart in decompressed, PCM samples of file.

setLoopStart

public void setLoopStart(int loopStart)

[in] Loopstart in decompressed, PCM samples of file.

getLoopEnd

public int getLoopEnd()

[in] Loopend in decompressed, PCM samples of file.

setLoopEnd

public void setLoopEnd(int loopEnd)

[in] Loopend in decompressed, PCM samples of file.

getMode

public int getMode()

[in] Mode to determine whether the sound should by default load as looping, non looping, 2d or 3d.

setMode

public void setMode(int mode)

[in] Mode to determine whether the sound should by default load as looping, non looping, 2d or 3d.

getChannelMask

public int getChannelMask()

[in] Microsoft speaker channel mask, as defined for WAVEFORMATEXTENSIBLE and is found in ksmedia.h. Leave at 0 to play in natural speaker order.

setChannelMask

public void setChannelMask(int channelMask)

[in] Microsoft speaker channel mask, as defined for WAVEFORMATEXTENSIBLE and is found in ksmedia.h. Leave at 0 to play in natural speaker order.