Firelight Technologies FMOD Studio API

DSP::disconnectFrom

Disconnect the DSP unit from the specified input.

C++ Syntax

FMOD_RESULT DSP::disconnectFrom(
  FMOD::DSP *target,
  FMOD::DSPConnection *connection
);

C Syntax

FMOD_RESULT FMOD_DSP_DisconnectFrom(
  FMOD_DSP *dsp,
  FMOD_DSP *target,
  FMOD_DSPCONNECTION *connection
);

C# Syntax

RESULT DSP.disconnectFrom(
  DSP target,
  DSPConnection connection
);

JavaScript Syntax

DSP.disconnectFrom(
  target,                          
  connection                       
);

Parameters

target

The input unit that this unit is to be disconnected from. Specify 0 or NULL to disconnect the unit from all outputs and inputs.

connection

If there is more than one connection between 2 dsp units, this can be used to define which of the connections should be disconnected.

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

Note that when you disconnect a unit, it is up to you to reconnect the network so that data flow can continue.

Important note: If you have a handle to the connection pointer that binds these 2 DSP units, then it will become invalid. The connection is then sent back to a freelist to be re-used again by a later addInput command.

See Also

• DSP::addInput
• DSP::disconnectAll

Version 1.10.03 Built on Feb 1, 2018