org.jouvieje.fmodex.structures
Class FMOD_CODEC_DESCRIPTION

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

public class FMOD_CODEC_DESCRIPTION

extends Pointer

Constructor Summary

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

Method Summary

static FMOD_CODEC_DESCRIPTION	allocate() Allocate a new FMOD_CODEC_DESCRIPTION.
static FMOD_CODEC_DESCRIPTION	asFMOD_CODEC_DESCRIPTION(Pointer pointer) Create a view of the Pointer object as a FMOD_CODEC_DESCRIPTION object.
FMOD_CODEC_CLOSECALLBACK	getClose() [in] Close callback for the codec for when FMOD tries to close a sound using this codec.
int	getDefaultAsStream() [in] Tells FMOD to open the file as a stream when calling System::createSound, and not a static sample.
FMOD_CODEC_GETLENGTHCALLBACK	getGetLength() [in] Callback to return the length of the song in whatever format required when Sound::getLength is called.
FMOD_CODEC_GETPOSITIONCALLBACK	getGetPosition() [in] Tell callback for the codec for when FMOD tries to get the current position within the with Channel::getPosition.
FMOD_CODEC_GETWAVEFORMAT	getGetWaveFormat() [in] Callback to tell FMOD about the waveformat of a particular subsound.
java.lang.String	getName() [in] Name of the codec.
FMOD_CODEC_OPENCALLBACK	getOpen() [in] Open callback for the codec for when FMOD tries to open a sound using this codec.
FMOD_CODEC_READCALLBACK	getRead() [in] Read callback for the codec for when FMOD tries to read some data from the file to the destination format (specified in the open callback).
FMOD_CODEC_SETPOSITIONCALLBACK	getSetPosition() [in] Seek callback for the codec for when FMOD tries to seek within the file with Channel::setPosition.
FMOD_CODEC_SOUNDCREATECALLBACK	getSoundCreate() [in] Sound creation callback for the codec when FMOD finishes creating the sound.
int	getTimeUnits() [in] When setposition codec is called, only these time formats will be passed to the codec.
int	getVersion() [in] Plugin writer's version number.
void	release()
void	setClose(FMOD_CODEC_CLOSECALLBACK close) [in] Close callback for the codec for when FMOD tries to close a sound using this codec.
void	setDefaultAsStream(int defaultAsStream) [in] Tells FMOD to open the file as a stream when calling System::createSound, and not a static sample.
void	setGetLength(FMOD_CODEC_GETLENGTHCALLBACK getLength) [in] Callback to return the length of the song in whatever format required when Sound::getLength is called.
void	setGetPosition(FMOD_CODEC_GETPOSITIONCALLBACK getPosition) [in] Tell callback for the codec for when FMOD tries to get the current position within the with Channel::getPosition.
void	setGetWaveFormat(FMOD_CODEC_GETWAVEFORMAT getWaveFormat) [in] Callback to tell FMOD about the waveformat of a particular subsound.
void	setName(java.lang.String name) [in] Name of the codec.
void	setOpen(FMOD_CODEC_OPENCALLBACK open) [in] Open callback for the codec for when FMOD tries to open a sound using this codec.
void	setRead(FMOD_CODEC_READCALLBACK read) [in] Read callback for the codec for when FMOD tries to read some data from the file to the destination format (specified in the open callback).
void	setSetPosition(FMOD_CODEC_SETPOSITIONCALLBACK setPosition) [in] Seek callback for the codec for when FMOD tries to seek within the file with Channel::setPosition.
void	setSoundCreate(FMOD_CODEC_SOUNDCREATECALLBACK soundCreate) [in] Sound creation callback for the codec when FMOD finishes creating the sound.
void	setTimeUnits(int timeUnits) [in] When setposition codec is called, only these time formats will be passed to the codec.
void	setVersion(int version) [in] Plugin writer's version number.

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_DESCRIPTION

public FMOD_CODEC_DESCRIPTION()

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

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

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

  FMOD_CODEC_DESCRIPTION obj = FMOD_CODEC_DESCRIPTION.allocate();

See Also:

allocate()

Method Detail

asFMOD_CODEC_DESCRIPTION

public static FMOD_CODEC_DESCRIPTION asFMOD_CODEC_DESCRIPTION(Pointer pointer)

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

allocate

public static FMOD_CODEC_DESCRIPTION allocate()

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

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

release

public void release()

getName

public java.lang.String getName()

[in] Name of the codec.

setName

public void setName(java.lang.String name)

[in] Name of the codec.

getVersion

public int getVersion()

[in] Plugin writer's version number.

setVersion

public void setVersion(int version)

[in] Plugin writer's version number.

getDefaultAsStream

public int getDefaultAsStream()

[in] Tells FMOD to open the file as a stream when calling System::createSound, and not a static sample. Should normally be 0 (FALSE), because generally the user wants to decode the file into memory when using System::createSound. Mainly used for formats that decode for a very long time, or could use large amounts of memory when decoded. Usually sequenced formats such as mod/s3m/xm/it/midi fall into this category. It is mainly to stop users that don't know what they're doing from getting FMOD_ERR_MEMORY returned from createSound when they should have in fact called System::createStream or used FMOD_CREATESTREAM in System::createSound.

setDefaultAsStream

public void setDefaultAsStream(int defaultAsStream)

[in] Tells FMOD to open the file as a stream when calling System::createSound, and not a static sample. Should normally be 0 (FALSE), because generally the user wants to decode the file into memory when using System::createSound. Mainly used for formats that decode for a very long time, or could use large amounts of memory when decoded. Usually sequenced formats such as mod/s3m/xm/it/midi fall into this category. It is mainly to stop users that don't know what they're doing from getting FMOD_ERR_MEMORY returned from createSound when they should have in fact called System::createStream or used FMOD_CREATESTREAM in System::createSound.

getTimeUnits

public int getTimeUnits()

[in] When setposition codec is called, only these time formats will be passed to the codec. Use bitwise OR to accumulate different types.

setTimeUnits

public void setTimeUnits(int timeUnits)

[in] When setposition codec is called, only these time formats will be passed to the codec. Use bitwise OR to accumulate different types.

getOpen

public FMOD_CODEC_OPENCALLBACK getOpen()

[in] Open callback for the codec for when FMOD tries to open a sound using this codec.

setOpen

public void setOpen(FMOD_CODEC_OPENCALLBACK open)

[in] Open callback for the codec for when FMOD tries to open a sound using this codec.

getClose

public FMOD_CODEC_CLOSECALLBACK getClose()

[in] Close callback for the codec for when FMOD tries to close a sound using this codec.

setClose

public void setClose(FMOD_CODEC_CLOSECALLBACK close)

[in] Close callback for the codec for when FMOD tries to close a sound using this codec.

getRead

public FMOD_CODEC_READCALLBACK getRead()

[in] Read callback for the codec for when FMOD tries to read some data from the file to the destination format (specified in the open callback).

setRead

public void setRead(FMOD_CODEC_READCALLBACK read)

[in] Read callback for the codec for when FMOD tries to read some data from the file to the destination format (specified in the open callback).

getGetLength

public FMOD_CODEC_GETLENGTHCALLBACK getGetLength()

[in] Callback to return the length of the song in whatever format required when Sound::getLength is called.

setGetLength

public void setGetLength(FMOD_CODEC_GETLENGTHCALLBACK getLength)

[in] Callback to return the length of the song in whatever format required when Sound::getLength is called.

getSetPosition

public FMOD_CODEC_SETPOSITIONCALLBACK getSetPosition()

[in] Seek callback for the codec for when FMOD tries to seek within the file with Channel::setPosition.

setSetPosition

public void setSetPosition(FMOD_CODEC_SETPOSITIONCALLBACK setPosition)

[in] Seek callback for the codec for when FMOD tries to seek within the file with Channel::setPosition.

getGetPosition

public FMOD_CODEC_GETPOSITIONCALLBACK getGetPosition()

[in] Tell callback for the codec for when FMOD tries to get the current position within the with Channel::getPosition.

setGetPosition

public void setGetPosition(FMOD_CODEC_GETPOSITIONCALLBACK getPosition)

[in] Tell callback for the codec for when FMOD tries to get the current position within the with Channel::getPosition.

getSoundCreate

public FMOD_CODEC_SOUNDCREATECALLBACK getSoundCreate()

[in] Sound creation callback for the codec when FMOD finishes creating the sound. (So the codec can set more parameters for the related created sound, ie loop points/mode or 3D attributes etc).

setSoundCreate

public void setSoundCreate(FMOD_CODEC_SOUNDCREATECALLBACK soundCreate)

[in] Sound creation callback for the codec when FMOD finishes creating the sound. (So the codec can set more parameters for the related created sound, ie loop points/mode or 3D attributes etc).

getGetWaveFormat

public FMOD_CODEC_GETWAVEFORMAT getGetWaveFormat()

[in] Callback to tell FMOD about the waveformat of a particular subsound. This is to save memory, rather than saving 1000 FMOD_CODEC_WAVEFORMAT structures in the codec, the codec might have a more optimal way of storing this information.

setGetWaveFormat

public void setGetWaveFormat(FMOD_CODEC_GETWAVEFORMAT getWaveFormat)

[in] Callback to tell FMOD about the waveformat of a particular subsound. This is to save memory, rather than saving 1000 FMOD_CODEC_WAVEFORMAT structures in the codec, the codec might have a more optimal way of storing this information.