org.jouvieje.fmoddesigner.structures
Class FMOD_MUSIC_SAMPLE_INFO

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

public class FMOD_MUSIC_SAMPLE_INFO

extends Pointer

Constructor Summary

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

Method Summary

static FMOD_MUSIC_SAMPLE_INFO	allocate() Allocate a new FMOD_MUSIC_SAMPLE_INFO.
static FMOD_MUSIC_SAMPLE_INFO	asFMOD_MUSIC_SAMPLE_INFO(Pointer pointer) Create a view of the Pointer object as a FMOD_MUSIC_SAMPLE_INFO object.
java.lang.String	getFileName() The filename of the sample.
int	getIndex() The index of the sample within the parent segment.
int	getSegmentId() The ID of the parent segment.
void	release()
void	setFileName(java.lang.String fileName) The filename of the sample.
void	setIndex(int index) The index of the sample within the parent segment.
void	setSegmentId(int segmentId) The ID of the parent segment.

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_MUSIC_SAMPLE_INFO

public FMOD_MUSIC_SAMPLE_INFO()

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

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

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

  FMOD_MUSIC_SAMPLE_INFO obj = FMOD_MUSIC_SAMPLE_INFO.allocate();

See Also:

allocate()

Method Detail

asFMOD_MUSIC_SAMPLE_INFO

public static FMOD_MUSIC_SAMPLE_INFO asFMOD_MUSIC_SAMPLE_INFO(Pointer pointer)

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

allocate

public static FMOD_MUSIC_SAMPLE_INFO allocate()

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

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

release

public void release()

getSegmentId

public int getSegmentId()

The ID of the parent segment.

setSegmentId

public void setSegmentId(int segmentId)

The ID of the parent segment.

getIndex

public int getIndex()

The index of the sample within the parent segment.

setIndex

public void setIndex(int index)

The index of the sample within the parent segment.

getFileName

public java.lang.String getFileName()

The filename of the sample.
Note: If the sample was built by a version of FMOD Designer before 4.29.09, this field will be 0.

setFileName

public void setFileName(java.lang.String fileName)

The filename of the sample.
Note: If the sample was built by a version of FMOD Designer before 4.29.09, this field will be 0.