Firelight Technologies FMOD Studio API

DSP::reset

Calls the DSP unit's reset function, which will clear internal buffers and reset the unit back to an initial state.

C++ Syntax

FMOD_RESULT DSP::reset();

C Syntax

FMOD_RESULT FMOD_DSP_Reset(FMOD_DSP *dsp);

C# Syntax

RESULT DSP.reset();

JavaScript Syntax

DSP.reset();

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

Calling this function is useful if the DSP unit relies on a history to process itself (ie an echo filter).

If you disconnected the unit and reconnected it to a different part of the network with a different sound, you would want to call this to reset the units state (ie clear and reset the echo filter) so that you dont get left over artifacts from the place it used to be connected.

Version 1.10.03 Built on Feb 1, 2018