Firelight Technologies FMOD Studio API
FMOD_DSP_STATE
DSP plugin structure that is passed into each callback.
C/C++ Syntax
typedef struct {
void *instance;
void *plugindata;
FMOD_CHANNELMASK channelmask;
FMOD_SPEAKERMODE source_speakermode;
float *sidechaindata;
int sidechainchannels;
FMOD_DSP_STATE_FUNCTIONS *functions;
int systemobject;
} FMOD_DSP_STATE;
JavaScript Syntax
struct FMOD_DSP_STATE
{
plugindata,
channelmask,
source_speakermode,
sidechainchannels,
systemobject,
};
Members
instance
[r] Internal instance pointer, should not be used or written to.
plugindata
[w] Plugin writer created data the output author wants to attach to this object.
channelmask
[r] Specifies which speakers the DSP effect is active on
source_speakermode
[r] Specifies which speaker mode the signal originated for information purposes, ie in case panning needs to be done differently.
sidechaindata
[r] The mixed result of all incoming sidechains is stored at this pointer address.
sidechainchannels
[r] The number of channels of pcm data stored within the sidechain buffer.
functions
[r] Struct containing functions to give plugin developers the ability to query system state, access system level functionality and helpers.
systemobject
[r] FMOD::System object index, relating to the System object that created this DSP.
Remarks
Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.
Members marked with [w] mean the variable can be written to. The user can set the value.
'systemobject' is an integer that relates to the System object that created the DSP or registered the DSP plugin. If only 1 System object is created then it should be 0. A second object would be 1 and so on.
FMOD_DSP_STATE_FUNCTIONS::getsamplerate/getblocksize/getspeakermode could return different results so it could be relevant to plugin developers to monitor which object is being used.
JavaScript only :
Not all fields are currently supported or may not work as expected at this time. To initialize an new instance in javascript use "FMOD.DSP_STATE()", no 'new' keyword is required.
See Also
Version 1.10.03 Built on Feb 1, 2018