org.jouvieje.fmoddesigner.structures
Class FMOD_EVENT_INFO

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

public class FMOD_EVENT_INFO

extends Pointer

Constructor Summary

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

Method Summary

static FMOD_EVENT_INFO	allocate() Allocate a new FMOD_EVENT_INFO.
static FMOD_EVENT_INFO	asFMOD_EVENT_INFO(Pointer pointer) Create a view of the Pointer object as a FMOD_EVENT_INFO object.
float	getAudibility() [out] current audibility of event.
int	getChannelsPlaying() [out] Number of channels currently playing in this event instance.
FMOD_GUID	getGuid() [out] Pointer to a structure that will be filled with the event's GUID.
Event[]	getInstances() [in/out] Pointer to an array that will be filled with the current reference-counted event handles of all instances of this event.
int	getInstancesActive() [out] Number of event instances currently in use.
int	getLengthMs() [out] Length in milliseconds of this event.
int	getMaxWaveBanks() [in/out] Out, number of wavebanks refered to by this event.
int	getMemoryUsed() This member has been deprecated.
int	getNumInstances() [in/out] On entry, maximum number of entries in instances array.
int	getPositionMs() [out] Time passed in playback of this event instance in milliseconds.
int	getProjectId() [out] The runtime 'EventProject' wide unique identifier for this event.
int	getSystemId() [out] The runtime 'EventSystem' wide unique identifier for this event.
FMOD_EVENT_WAVEBANKINFO[]	getWavebankInfo() [in] Pointer to array FMOD_EVENT_WAVEBANKINFO structures (max size defined by maxwavebanks).
void	release()
void	setInstances(Event[] instances) [in/out] Pointer to an array that will be filled with the current reference-counted event handles of all instances of this event.
void	setMemoryUsed(int memoryUsed) This member has been deprecated.
void	setWavebankInfo(FMOD_EVENT_WAVEBANKINFO[] wavebankInfo) [in] Pointer to array FMOD_EVENT_WAVEBANKINFO structures (max size defined by maxwavebanks).

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_INFO

public FMOD_EVENT_INFO()

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

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

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

  FMOD_EVENT_INFO obj = FMOD_EVENT_INFO.allocate();

See Also:

allocate()

Method Detail

asFMOD_EVENT_INFO

public static FMOD_EVENT_INFO asFMOD_EVENT_INFO(Pointer pointer)

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

allocate

public static FMOD_EVENT_INFO allocate()

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

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

release

public void release()

getMemoryUsed

public int getMemoryUsed()

This member has been deprecated.

setMemoryUsed

public void setMemoryUsed(int memoryUsed)

This member has been deprecated.

getPositionMs

public int getPositionMs()

[out] Time passed in playback of this event instance in milliseconds.

getLengthMs

public int getLengthMs()

[out] Length in milliseconds of this event. Note: lengthms will be -1 if the length of the event can't be determined i.e. if it has looping sounds.

getChannelsPlaying

public int getChannelsPlaying()

[out] Number of channels currently playing in this event instance.

getInstancesActive

public int getInstancesActive()

[out] Number of event instances currently in use.

getMaxWaveBanks

public int getMaxWaveBanks()

[in/out] Out, number of wavebanks refered to by this event. In. Maximum size of array of wavebankinfo structures supplied by user. Optional.

getWavebankInfo

public FMOD_EVENT_WAVEBANKINFO[] getWavebankInfo()

[in] Pointer to array FMOD_EVENT_WAVEBANKINFO structures (max size defined by maxwavebanks). FMOD will fill these in with detailed information on each wave bank. Optional.

setWavebankInfo

public void setWavebankInfo(FMOD_EVENT_WAVEBANKINFO[] wavebankInfo)

[in] Pointer to array FMOD_EVENT_WAVEBANKINFO structures (max size defined by maxwavebanks). FMOD will fill these in with detailed information on each wave bank. Optional.

getProjectId

public int getProjectId()

[out] The runtime 'EventProject' wide unique identifier for this event.

getSystemId

public int getSystemId()

[out] The runtime 'EventSystem' wide unique identifier for this event. This is calculated when single or multiple projects are loaded.

getAudibility

public float getAudibility()

[out] current audibility of event.

getNumInstances

public int getNumInstances()

[in/out] On entry, maximum number of entries in instances array. On exit, actual number of entries in instances array, or if instances is null, then it is just the number of instances of this event. Optional.

getInstances

public Event[] getInstances()

[in/out] Pointer to an array that will be filled with the current reference-counted event handles of all instances of this event. Optional. Specify 0 if not needed. Must be used in conjunction with numinstances. Note: Due to reference counting, the event instance handles returned here may be different between subsequent calls to this function. If you use these event handles, make sure your code is prepared for them to be invalid!

setInstances

public void setInstances(Event[] instances)

[in/out] Pointer to an array that will be filled with the current reference-counted event handles of all instances of this event. Optional. Specify 0 if not needed. Must be used in conjunction with numinstances. Note: Due to reference counting, the event instance handles returned here may be different between subsequent calls to this function. If you use these event handles, make sure your code is prepared for them to be invalid!

getGuid

public FMOD_GUID getGuid()

[out] Pointer to a structure that will be filled with the event's GUID. Optional. Specify 0 if not needed.