Firelight Technologies FMOD Studio API

DSP::getOutput

Retrieves a pointer to a DSP unit which is acting as an output to this unit.

C++ Syntax

FMOD_RESULT DSP::getOutput(
  int index,
  FMOD::DSP **output,
  FMOD::DSPConnection **outputconnection
);

C Syntax

FMOD_RESULT FMOD_DSP_GetOutput(
  FMOD_DSP *dsp,
  int index,
  FMOD_DSP **output,
  FMOD_DSPCONNECTION **outputconnection
);

C# Syntax

RESULT DSP.getOutput(
  int index,
  out DSP output,
  out DSPConnection outputconnection
);

JavaScript Syntax

DSP.getOutput(
  index,                           
  output,                          // writes value to output.val
  outputconnection                 // writes value to outputconnection.val
);

Parameters

index

Index of the output unit to retrieve.

output

Address of a variable that receieves the pointer to the desired output unit.

outputconnection

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

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

An output is a unit which this unit will feed data too once it has processed its data.
Find out the number of output units to this unit by calling DSP::getNumOutputs.

Performance warning! Because this function needs to flush the dsp queue before it can determine if the specified numerical output is available or not, this function may block significantly while the background mixer thread operates.

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

See Also

• DSP::getNumOutputs
• DSP::addInput
• DSP::getInput
• DSPConnection::getMix
• DSPConnection::setMix

Version 1.10.03 Built on Feb 1, 2018