Firelight Technologies FMOD Studio API
FMOD_DSP_RESET_CALLBACK
This callback function is called by DSP::reset to allow the effect to reset its internal state.
C/C++ Syntax
FMOD_RESULT F_CALLBACK FMOD_DSP_RESET_CALLBACK(
FMOD_DSP_STATE *dsp_state
);
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 handle to the user created DSP handle is stored within the FMOD_DSP_STATE structure.
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
This callback is called on all plugins inside an event whenever the event is started (for example by Studio::EventInstance::start).
It is also useful if (for example) an effect is still holding audio data for a sound that has stopped, and is being relocated to a new sound. Resetting the unit would clear any buffers and get it ready for new sound data.
Note that this callback should not change any public parameters that are exposed via FMOD_DSP_DESCRIPTION.paramdesc, but should instead reset the internal state to match the public parameter values.
Functions that the user would have to call for this callback to be called:
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