org.jouvieje.fmoddesigner.structures
Class FMOD_EVENT_LOADINFO

java.lang.Object
  org.jouvieje.fmodex.utils.Pointer
      org.jouvieje.fmoddesigner.structures.FMOD_EVENT_LOADINFO

public class FMOD_EVENT_LOADINFO

extends Pointer

Constructor Summary

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

Method Summary

static FMOD_EVENT_LOADINFO	allocate() Allocate a new FMOD_EVENT_LOADINFO.
static FMOD_EVENT_LOADINFO	asFMOD_EVENT_LOADINFO(Pointer pointer) Create a view of the Pointer object as a FMOD_EVENT_LOADINFO object.
java.lang.String	getEncryptionKey() [in] Optional.
int	getLoadFromMemoryLength() [in] Optional.
boolean	getOverrideCategoryVals() [in] Optional.
int	getSize() [in] Size of this structure.
int	getSizeofInstancePoolSimple() [in] Optional.
float	getSoundDefEntryLimit() [in] Optional.
void	release()
void	setEncryptionKey(java.lang.String encryptionKey) [in] Optional.
void	setLoadFromMemoryLength(int loadFromMemoryLength) [in] Optional.
void	setOverrideCategoryVals(boolean overrideCategoryVals) [in] Optional.
void	setSize(int size) [in] Size of this structure.
void	setSizeofInstancePoolSimple(int sizeofInstancePoolSimple) [in] Optional.
void	setSoundDefEntryLimit(float soundDefEntryLimit) [in] Optional.

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_EVENT_LOADINFO

public FMOD_EVENT_LOADINFO()

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

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

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

  FMOD_EVENT_LOADINFO obj = FMOD_EVENT_LOADINFO.allocate();

See Also:

allocate()

Method Detail

asFMOD_EVENT_LOADINFO

public static FMOD_EVENT_LOADINFO asFMOD_EVENT_LOADINFO(Pointer pointer)

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

allocate

public static FMOD_EVENT_LOADINFO allocate()

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

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

release

public void release()

getSize

public int getSize()

[in] Size of this structure. This is used so the structure can be expanded in the future and still work on older versions of FMOD Ex.

setSize

public void setSize(int size)

[in] Size of this structure. This is used so the structure can be expanded in the future and still work on older versions of FMOD Ex.

getEncryptionKey

public java.lang.String getEncryptionKey()

[in] Optional. Specify 0 to ignore. Key, or 'password' to decrypt a bank. A sound designer may have encrypted the audio data to protect their sound data from 'rippers'.

setEncryptionKey

public void setEncryptionKey(java.lang.String encryptionKey)

[in] Optional. Specify 0 to ignore. Key, or 'password' to decrypt a bank. A sound designer may have encrypted the audio data to protect their sound data from 'rippers'.

getSoundDefEntryLimit

public float getSoundDefEntryLimit()

[in] Optional. Specify 0 to ignore. A value between 0 -> 1 that is multiplied with the number of sound definition entries in each sound definition in the project being loaded in order to programmatically reduce the number of sound definition entries used at runtime.

setSoundDefEntryLimit

public void setSoundDefEntryLimit(float soundDefEntryLimit)

[in] Optional. Specify 0 to ignore. A value between 0 -> 1 that is multiplied with the number of sound definition entries in each sound definition in the project being loaded in order to programmatically reduce the number of sound definition entries used at runtime.

getLoadFromMemoryLength

public int getLoadFromMemoryLength()

[in] Optional. Specify 0 to ignore. Length of memory buffer pointed to by name_or_data parameter passed to EventSystem::load. If this field is non-zero then the name_or_data parameter passed to EventSystem::load will be interpreted as a pointer to a memory buffer containing the .fev data to load. If this field is zero the name_or_data parameter is interpreted as the filename of the .fev file to load.

setLoadFromMemoryLength

public void setLoadFromMemoryLength(int loadFromMemoryLength)

[in] Optional. Specify 0 to ignore. Length of memory buffer pointed to by name_or_data parameter passed to EventSystem::load. If this field is non-zero then the name_or_data parameter passed to EventSystem::load will be interpreted as a pointer to a memory buffer containing the .fev data to load. If this field is zero the name_or_data parameter is interpreted as the filename of the .fev file to load.

getOverrideCategoryVals

public boolean getOverrideCategoryVals()

[in] Optional. If this member is set to true, newly-loaded categories will impart their properties (volume, pitch etc.) to existing categories of the same name.

setOverrideCategoryVals

public void setOverrideCategoryVals(boolean overrideCategoryVals)

[in] Optional. If this member is set to true, newly-loaded categories will impart their properties (volume, pitch etc.) to existing categories of the same name.

getSizeofInstancePoolSimple

public int getSizeofInstancePoolSimple()

[in] Optional. Specify 0 to ignore. If this value is non-zero, FMOD will create an instance pool for simple events with "sizeof_instancepool_simple" entries. Note: Event instance pools currently work for simple events only. Complex events will behave as normal and not be pooled.

setSizeofInstancePoolSimple

public void setSizeofInstancePoolSimple(int sizeofInstancePoolSimple)

[in] Optional. Specify 0 to ignore. If this value is non-zero, FMOD will create an instance pool for simple events with "sizeof_instancepool_simple" entries. Note: Event instance pools currently work for simple events only. Complex events will behave as normal and not be pooled.