Firelight Technologies FMOD Studio API

DSP::setBypass

Enables or disables the read callback of a DSP unit so that it does or doesn't process the data coming into it.
A DSP unit that is disabled still processes its inputs, it will just be 'dry'.

C++ Syntax

FMOD_RESULT DSP::setBypass(
  bool bypass
);

C Syntax

FMOD_RESULT FMOD_DSP_SetBypass(
  FMOD_DSP *dsp,
  FMOD_BOOL bypass
);

C# Syntax

RESULT DSP.setBypass(
  bool bypass
);

JavaScript Syntax

DSP.setBypass(
  bypass                           
);

Parameters

bypass

Boolean to cause the read callback of the DSP unit to be bypassed or not. 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.
To disable the unit and all of its inputs, use DSP::setActive instead.

See Also

• DSP::getBypass
• DSP::setActive

Version 1.10.03 Built on Feb 1, 2018