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);

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

• System::createDSP
• System::createDSPByType
• Channel::getDSP
• ChannelGroup::getDSP
• Channel::addDSP
• ChannelGroup::addDSP
• Channel::removeDSP
• ChannelGroup::removeDSP

Version 1.03.06 Built on Apr 17, 2014