Firelight Technologies FMOD Studio API
DSP::getNumInputs
Retrieves the number of inputs connected to the DSP unit.
C++ Syntax
FMOD_RESULT DSP::getNumInputs(
int *numinputs
);
C Syntax
FMOD_RESULT FMOD_DSP_GetNumInputs(
FMOD_DSP *dsp,
int *numinputs
);
C# Syntax
RESULT DSP.getNumInputs(
out int numinputs
);
JavaScript Syntax
DSP.getNumInputs(
numinputs // writes value to numinputs.val
);
Parameters
- numinputs
- Address of a variable that receives the number of inputs 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
Inputs are units that feed data to this unit. When there are multiple inputs, they are mixed together.
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