Firelight Technologies FMOD Studio API

DSP::addInput

Adds the specified DSP unit as an input of the DSP object.

C++ Syntax

FMOD_RESULT DSP::addInput(
  FMOD::DSP *input,
  FMOD::DSPConnection **connection,
  FMOD_DSPCONNECTION_TYPE type
);

C Syntax

FMOD_RESULT FMOD_DSP_AddInput(
  FMOD_DSP *dsp,
  FMOD_DSP *input,
  FMOD_DSPCONNECTION **connection,
  FMOD_DSPCONNECTION_TYPE type
);

C# Syntax

RESULT DSP.addInput(
  DSP target,
  out DSPConnection connection,
  DSPCONNECTION_TYPE type
);

JavaScript Syntax

DSP.addInput(
  input,                           
  connection,                      // writes value to connection.val
  type                             
);

Parameters

input

The DSP unit to add as an input of the current unit.

connection

The connection between the 2 units. Optional. Specify 0 or NULL to ignore.

type

The type of connection between the 2 units. See FMOD_DSPCONNECTION_TYPE.

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 you want to add a unit as an output of another unit, then add 'this' unit as an input of that unit instead.

Inputs are automatically mixed together, then the mixed data is sent to the unit's output(s).
To find the number of inputs or outputs a unit has use DSP::getNumInputs or DSP::getNumOutputs.

Note: The connection pointer retrieved here will become invalid if you disconnect the 2 dsp units that use it.

See Also

• DSP::getNumInputs
• DSP::getInput
• DSP::getNumOutputs
• DSP::disconnectFrom
• FMOD_DSPCONNECTION_TYPE

Version 1.10.03 Built on Feb 1, 2018