DSP::getNumOutputs

FMOD Studio API

Firelight Technologies FMOD Studio API

DSP::getNumOutputs

Retrieves the number of outputs connected to the DSP unit.

C++ Syntax

FMOD_RESULT DSP::getNumOutputs(
  int *numoutputs
);

C Syntax

FMOD_RESULT FMOD_DSP_GetNumOutputs(
  FMOD_DSP *dsp,
  int *numoutputs
);

C# Syntax

RESULT DSP.getNumOutputs(
  out int numoutputs
);

JavaScript Syntax

DSP.getNumOutputs(
  numoutputs                       // writes value to numoutputs.val
);

Parameters

numoutputs
Address of a variable that receives the number of outputs connected to this unit.

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

Outputs are units that this unit feeds data to. When there are multiple outputs, the data is split and sent to each unit individually.

Performance warning! Because this function needs to flush the dsp queue before it can determine how many units are available, this function may block significantly while the background mixer thread operates.

See Also




Version 1.10.03 Built on Feb 1, 2018