Firelight Technologies FMOD Studio API

DSP::getBypass

Retrieves the bypass state of the DSP unit.

C++ Syntax

FMOD_RESULT DSP::getBypass(
  bool *bypass
);

C Syntax

FMOD_RESULT FMOD_DSP_GetBypass(
  FMOD_DSP *dsp,
  FMOD_BOOL *bypass
);

C# Syntax

RESULT DSP.getBypass(
  out bool bypass
);

JavaScript Syntax

DSP.getBypass(
  bypass                           // writes value to bypass.val
);

Parameters

bypass

Address of a variable that receieves the bypass state for a DSP unit. true = unit is not processing audio data, false = unit is processing audio data. Default = false.

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

If a unit is bypassed, it will still process its inputs, unlike DSP::setActive (when set to false) which causes inputs to stop processing as well.

See Also

• DSP::setBypass
• DSP::setActive

Version 1.10.03 Built on Feb 1, 2018