Firelight Technologies FMOD Studio API

DSP::disconnectAll

Helper function to disconnect either all inputs or all outputs of a dsp unit.

C++ Syntax

FMOD_RESULT DSP::disconnectAll(
  bool inputs,
  bool outputs
);

C Syntax

FMOD_RESULT FMOD_DSP_DisconnectAll(
  FMOD_DSP *dsp,
  FMOD_BOOL inputs,
  FMOD_BOOL outputs
);

Parameters

inputs

true = disconnect all inputs to this DSP unit. false = leave input connections alone.

outputs

true = disconnect all outputs to this DSP unit. false = leave output connections alone.

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 function is optimized to be faster than disconnecting inputs and outputs manually one by one.

Important note: If you have a handle to DSPConnection pointers that bind any of the inputs or outputs to this DSP unit, then they will become invalid. The connections are sent back to a freelist to be re-used again by a later addInput command.

See Also

• DSP::disconnectFrom

Version 1.03.06 Built on Apr 17, 2014