org.jouvieje.fmodex.structures
Class FMOD_ASYNCREADINFO

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

public class FMOD_ASYNCREADINFO

extends Pointer

Constructor Summary

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

Method Summary

static FMOD_ASYNCREADINFO	allocate() Allocate a new FMOD_ASYNCREADINFO.
static FMOD_ASYNCREADINFO	asFMOD_ASYNCREADINFO(Pointer pointer) Create a view of the Pointer object as a FMOD_ASYNCREADINFO object.
Pointer	getBuffer() [w] Buffer to read file data into.
int	getBytesRead() [w] Fill this in before setting result code to tell FMOD how many bytes were read.
Pointer	getHandle() [r] The file handle that was filled out in the open callback.
int	getOffset() [r] Seek position, make sure you read from this file offset.
int	getPriority() [r] 0 = low importance. 100 = extremely important (ie 'must read now or stuttering may occur')
FMOD_RESULT	getResult() [r/w] Result code, FMOD_OK tells the system it is ready to consume the data.
int	getSizeBytes() [r] how many bytes requested for read.
Pointer	getUserData() [r] User data pointer.
void	release()
void	setBuffer(Pointer buffer) [w] Buffer to read file data into.
void	setBytesRead(int bytesRead) [w] Fill this in before setting result code to tell FMOD how many bytes were read.
void	setResult(FMOD_RESULT result) [r/w] Result code, FMOD_OK tells the system it is ready to consume the data.

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_ASYNCREADINFO

public FMOD_ASYNCREADINFO()

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

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

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

  FMOD_ASYNCREADINFO obj = FMOD_ASYNCREADINFO.allocate();

See Also:

allocate()

Method Detail

asFMOD_ASYNCREADINFO

public static FMOD_ASYNCREADINFO asFMOD_ASYNCREADINFO(Pointer pointer)

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

allocate

public static FMOD_ASYNCREADINFO allocate()

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

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

release

public void release()

getHandle

public Pointer getHandle()

[r] The file handle that was filled out in the open callback.

getOffset

public int getOffset()

[r] Seek position, make sure you read from this file offset.

getSizeBytes

public int getSizeBytes()

[r] how many bytes requested for read.

getPriority

public int getPriority()

[r] 0 = low importance. 100 = extremely important (ie 'must read now or stuttering may occur')

getBuffer

public Pointer getBuffer()

[w] Buffer to read file data into.

setBuffer

public void setBuffer(Pointer buffer)

[w] Buffer to read file data into.

getBytesRead

public int getBytesRead()

[w] Fill this in before setting result code to tell FMOD how many bytes were read.

setBytesRead

public void setBytesRead(int bytesRead)

[w] Fill this in before setting result code to tell FMOD how many bytes were read.

getResult

public FMOD_RESULT getResult()

[r/w] Result code, FMOD_OK tells the system it is ready to consume the data. Set this last! Default value = FMOD_ERR_NOTREADY.

setResult

public void setResult(FMOD_RESULT result)

[r/w] Result code, FMOD_OK tells the system it is ready to consume the data. Set this last! Default value = FMOD_ERR_NOTREADY.

getUserData

public Pointer getUserData()

[r] User data pointer.