DSP::release

FMOD Studio API

Firelight Technologies FMOD Studio API

DSP::release

Frees a DSP object.

C++ Syntax

FMOD_RESULT DSP::release();

C Syntax

FMOD_RESULT FMOD_DSP_Release(FMOD_DSP *dsp);

C# Syntax

RESULT DSP.release();

JavaScript Syntax

DSP.release();

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 will free the DSP object.

NOTE: If DSP is not removed from the Channel, ChannelGroup or System object with Channel::removeDSP or ChannelGroup::removeDSP, after being added with Channel::addDSP or ChannelGroup::addDSP, it will not release and will instead return FMOD_ERR_DSP_INUSE.

See Also




Version 1.10.03 Built on Feb 1, 2018