org.jouvieje.fmodex.structures
Class FMOD_DSP_DESCRIPTION

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

public class FMOD_DSP_DESCRIPTION

extends Pointer

Constructor Summary

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

Method Summary

static FMOD_DSP_DESCRIPTION	allocate() Allocate a new FMOD_DSP_DESCRIPTION.
static FMOD_DSP_DESCRIPTION	asFMOD_DSP_DESCRIPTION(Pointer pointer) Create a view of the Pointer object as a FMOD_DSP_DESCRIPTION object.
int	getChannels() [w] Number of channels.
FMOD_DSP_DIALOGCALLBACK	getConfig() [w] This is called when the user calls DSP::showConfigDialog.
int	getConfigHeight() [w] Height of config dialog graphic if there is one. 0 otherwise.
int	getConfigWidth() [w] Width of config dialog graphic if there is one. 0 otherwise.
FMOD_DSP_CREATECALLBACK	getCreate() [w] Create callback.
FMOD_DSP_GETPARAMCALLBACK	getGetParameter() [w] This is called when the user calls DSP::getParameter.
java.lang.String	getName() [w] Name of the unit to be displayed in the network.
int	getNumParameters() [w] Number of parameters used in this filter.
FMOD_DSP_PARAMETERDESC[]	getParamDesc() [w] Variable number of parameter structures.
FMOD_DSP_READCALLBACK	getRead() [w] Read callback.
FMOD_DSP_RELEASECALLBACK	getRelease() [w] Release callback.
FMOD_DSP_RESETCALLBACK	getReset() [w] Reset callback.
FMOD_DSP_SETPARAMCALLBACK	getSetParameter() [w] This is called when the user calls DSP::setParameter.
FMOD_DSP_SETPOSITIONCALLBACK	getSetPosition() [w] Set position callback.
Pointer	getUserData() [w] Optional.
int	getVersion() [w] Plugin writer's version number.
void	release()
void	setChannels(int channels) [w] Number of channels.
void	setConfig(FMOD_DSP_DIALOGCALLBACK config) [w] This is called when the user calls DSP::showConfigDialog.
void	setConfigHeight(int configHeight) [w] Height of config dialog graphic if there is one. 0 otherwise.
void	setConfigWidth(int configWidth) [w] Width of config dialog graphic if there is one. 0 otherwise.
void	setCreate(FMOD_DSP_CREATECALLBACK create) [w] Create callback.
void	setGetParameter(FMOD_DSP_GETPARAMCALLBACK getParameter) [w] This is called when the user calls DSP::getParameter.
void	setName(java.lang.String name) [w] Name of the unit to be displayed in the network.
void	setParamDesc(FMOD_DSP_PARAMETERDESC[] paramDesc) [w] Variable number of parameter structures.
void	setRead(FMOD_DSP_READCALLBACK read) [w] Read callback.
void	setRelease(FMOD_DSP_RELEASECALLBACK release) [w] Release callback.
void	setReset(FMOD_DSP_RESETCALLBACK reset) [w] Reset callback.
void	setSetParameter(FMOD_DSP_SETPARAMCALLBACK setParameter) [w] This is called when the user calls DSP::setParameter.
void	setSetPosition(FMOD_DSP_SETPOSITIONCALLBACK setPosition) [w] Set position callback.
void	setUserData(Pointer userData) [w] Optional.
void	setVersion(int version) [w] 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_DSP_DESCRIPTION

public FMOD_DSP_DESCRIPTION()

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

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

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

  FMOD_DSP_DESCRIPTION obj = FMOD_DSP_DESCRIPTION.allocate();

See Also:

allocate()

Method Detail

asFMOD_DSP_DESCRIPTION

public static FMOD_DSP_DESCRIPTION asFMOD_DSP_DESCRIPTION(Pointer pointer)

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

allocate

public static FMOD_DSP_DESCRIPTION allocate()

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

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

release

public void release()

getName

public java.lang.String getName()

[w] Name of the unit to be displayed in the network.

setName

public void setName(java.lang.String name)

[w] Name of the unit to be displayed in the network.

getVersion

public int getVersion()

[w] Plugin writer's version number.

setVersion

public void setVersion(int version)

[w] Plugin writer's version number.

getChannels

public int getChannels()

[w] Number of channels. Use 0 to process whatever number of channels is currently in the network. >0 would be mostly used if the unit is a unit that only generates sound.

setChannels

public void setChannels(int channels)

[w] Number of channels. Use 0 to process whatever number of channels is currently in the network. >0 would be mostly used if the unit is a unit that only generates sound.

getCreate

public FMOD_DSP_CREATECALLBACK getCreate()

[w] Create callback. This is called when DSP unit is created. Can be null.

setCreate

public void setCreate(FMOD_DSP_CREATECALLBACK create)

[w] Create callback. This is called when DSP unit is created. Can be null.

getRelease

public FMOD_DSP_RELEASECALLBACK getRelease()

[w] Release callback. This is called just before the unit is freed so the user can do any cleanup needed for the unit. Can be null.

setRelease

public void setRelease(FMOD_DSP_RELEASECALLBACK release)

[w] Release callback. This is called just before the unit is freed so the user can do any cleanup needed for the unit. Can be null.

getReset

public FMOD_DSP_RESETCALLBACK getReset()

[w] Reset callback. This is called by the user to reset any history buffers that may need resetting for a filter, when it is to be used or re-used for the first time to its initial clean state. Use to avoid clicks or artifacts.

setReset

public void setReset(FMOD_DSP_RESETCALLBACK reset)

[w] Reset callback. This is called by the user to reset any history buffers that may need resetting for a filter, when it is to be used or re-used for the first time to its initial clean state. Use to avoid clicks or artifacts.

getRead

public FMOD_DSP_READCALLBACK getRead()

[w] Read callback. Processing is done here. Can be null.

setRead

public void setRead(FMOD_DSP_READCALLBACK read)

[w] Read callback. Processing is done here. Can be null.

getSetPosition

public FMOD_DSP_SETPOSITIONCALLBACK getSetPosition()

[w] Set position callback. This is called if the unit wants to update its position info but not process data, or reset a cursor position internally if it is reading data from a certain source. Can be null.

setSetPosition

public void setSetPosition(FMOD_DSP_SETPOSITIONCALLBACK setPosition)

[w] Set position callback. This is called if the unit wants to update its position info but not process data, or reset a cursor position internally if it is reading data from a certain source. Can be null.

getNumParameters

public int getNumParameters()

[w] Number of parameters used in this filter. The user finds this with DSP::getNumParameters

getParamDesc

public FMOD_DSP_PARAMETERDESC[] getParamDesc()

[w] Variable number of parameter structures.

setParamDesc

public void setParamDesc(FMOD_DSP_PARAMETERDESC[] paramDesc)

[w] Variable number of parameter structures.

getSetParameter

public FMOD_DSP_SETPARAMCALLBACK getSetParameter()

[w] This is called when the user calls DSP::setParameter. Can be null.

setSetParameter

public void setSetParameter(FMOD_DSP_SETPARAMCALLBACK setParameter)

[w] This is called when the user calls DSP::setParameter. Can be null.

getGetParameter

public FMOD_DSP_GETPARAMCALLBACK getGetParameter()

[w] This is called when the user calls DSP::getParameter. Can be null.

setGetParameter

public void setGetParameter(FMOD_DSP_GETPARAMCALLBACK getParameter)

[w] This is called when the user calls DSP::getParameter. Can be null.

getConfig

public FMOD_DSP_DIALOGCALLBACK getConfig()

[w] This is called when the user calls DSP::showConfigDialog. Can be used to display a dialog to configure the filter. Can be null.

setConfig

public void setConfig(FMOD_DSP_DIALOGCALLBACK config)

[w] This is called when the user calls DSP::showConfigDialog. Can be used to display a dialog to configure the filter. Can be null.

getConfigWidth

public int getConfigWidth()

[w] Width of config dialog graphic if there is one. 0 otherwise.

setConfigWidth

public void setConfigWidth(int configWidth)

[w] Width of config dialog graphic if there is one. 0 otherwise.

getConfigHeight

public int getConfigHeight()

[w] Height of config dialog graphic if there is one. 0 otherwise.

setConfigHeight

public void setConfigHeight(int configHeight)

[w] Height of config dialog graphic if there is one. 0 otherwise.

getUserData

public Pointer getUserData()

[w] Optional. Specify 0 to ignore. This is user data to be attached to the DSP unit during creation. Access via DSP::getUserData.

setUserData

public void setUserData(Pointer userData)

[w] Optional. Specify 0 to ignore. This is user data to be attached to the DSP unit during creation. Access via DSP::getUserData.