Firelight Technologies FMOD Studio API
DSP::setActive
Enables or disables a unit for being processed.
C++ Syntax
FMOD_RESULT DSP::setActive(
bool active
);
C Syntax
FMOD_RESULT FMOD_DSP_SetActive(
FMOD_DSP *dsp,
FMOD_BOOL active
);
C# Syntax
RESULT DSP.setActive(
bool active
);
JavaScript Syntax
DSP.setActive(
active
);
Parameters
- active
- true = unit is activated, false = unit is deactivated.
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 does not connect or disconnect a unit in any way, it just disables it so that it is not processed.
If a unit is disabled, and has inputs, they will also cease to be processed.
To disable a unit but allow the inputs of the unit to continue being processed, use DSP::setBypass instead.
See Also
Version 1.10.03 Built on Feb 1, 2018