Firelight Technologies FMOD Studio API
FMOD_DSP_SYSTEM_MIX_CALLBACK
This callback is called once, for each mix for this type of DSP. It is not associated with any DSP instance. The function can be used as a global pre/mid/post mix function for this type of DSP to do things like update a global state for the plugin type.
C/C++ Syntax
FMOD_RESULT F_CALLBACK FMOD_DSP_SYSTEM_MIX_CALLBACK(
FMOD_DSP_STATE *dsp_state,
int stage
);
Parameters
dsp_state
Pointer to the plugin state. The user can use this variable to access runtime plugin specific variables and plugin writer user data. Do not cast this to FMOD_DSP! The instance pointer in the state for this callback will be 0 / null. Only 'systemobject' and 'callbacks' are valid for use.
stage
0 = premix, or before the mixer has executed. 1 = postmix, or after the after the mix has been executed. 2 = midmix, after clocks calculation before the main mix has occurred.
Return Values
If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.
Remarks
The callback is not associated with any DSP instance, so the instance member of FMOD_DSP_STATE will be 0 / NULL. The callback is triggered automatically by the mixer and is not triggered by any API function. Remember to return FMOD_OK at the bottom of the function, or an appropriate error code from FMOD_RESULT.
See Also
Version 1.10.03 Built on Feb 1, 2018