Firelight Technologies FMOD Studio API
DSP::getInput
Retrieves a pointer to a DSP unit which is acting as an input to this unit.
C++ Syntax
FMOD_RESULT DSP::getInput(
int index,
FMOD::DSP **input,
FMOD::DSPConnection **inputconnection
);
C Syntax
FMOD_RESULT FMOD_DSP_GetInput(
FMOD_DSP *dsp,
int index,
FMOD_DSP **input,
FMOD_DSPCONNECTION **inputconnection
);
C# Syntax
RESULT DSP.getInput(
int index,
out DSP input,
out DSPConnection inputconnection
);
JavaScript Syntax
DSP.getInput(
index,
input, // writes value to input.val
inputconnection // writes value to inputconnection.val
);
Parameters
- index
- Index of the input unit to retrieve.
- input
- Address of a variable that receieves the pointer to the desired input unit.
- inputconnection
- 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 input is a unit which feeds audio data to this unit.
If there are more than 1 input to this unit, the inputs will be mixed, and the current unit processes the mixed result.
Find out the number of input units to this unit by calling DSP::getNumInputs.
Performance warning! Because this function needs to flush the dsp queue before it can determine if the specified numerical input 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
Version 1.10.03 Built on Feb 1, 2018