Firelight Technologies FMOD Studio API

FMOD_DSP_RESET_CALLBACK

This callback function is called by DSP::reset to allow the effect to reset itself to a default state.
This is useful if an effect is for example still holding audio data for a sound that has stopped, and the unit wants to be relocated to a new sound. Resetting the unit would clear any buffers, put the effect back to its initial state, and get it ready for new sound data.

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

Functions that the user would have to call for this callback to be called.

• DSP::reset

Remember to return FMOD_OK at the bottom of the function, or an appropriate error code from FMOD_RESULT.

See Also

• FMOD_DSP_STATE
• FMOD_DSP_DESCRIPTION
• DSP::reset

Version 1.03.06 Built on Apr 17, 2014