Firelight Technologies FMOD Studio API

DSP::disconnectFrom

Disconnect the DSP unit from the specified target.

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
);

Parameters

target
The unit that this unit is to be removed 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




Version 1.03.06 Built on Apr 17, 2014