Firelight Technologies FMOD Studio API

DSP::getActive

Retrieves the active state of a DSP unit.

C++ Syntax

FMOD_RESULT DSP::getActive(
  bool *active
);

C Syntax

FMOD_RESULT FMOD_DSP_GetActive(
  FMOD_DSP *dsp,
  FMOD_BOOL *active
);

C# Syntax

RESULT DSP.getActive(
  out bool active
);

JavaScript Syntax

DSP.getActive(
  active                           // writes value to active.val
);

Parameters

active

Address of a variable that receives the active state of the unit. 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.

See Also

• DSP::setActive
• DSP::setBypass

Version 1.10.03 Built on Feb 1, 2018