Firelight Technologies FMOD Studio API
DSPConnection::getInput
Retrieves the DSP unit that is the input of this connection.
C++ Syntax
FMOD_RESULT DSPConnection::getInput(
FMOD::DSP **input
);
C Syntax
FMOD_RESULT FMOD_DSPConnection_GetInput(
FMOD_DSPCONNECTION *dspconnection,
FMOD_DSP **input
);
C# Syntax
RESULT DSPConnection.getInput(
out DSP input
);
JavaScript Syntax
DSPConnection.getInput(
input // writes value to input.val
);
Parameters
- input
- Address of a pointer that receives the pointer to the DSP unit that is the input of this connection.
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
A DSPConnection joins 2 DSP units together (think of it as the line between 2 circles).
Each DSPConnection has 1 input and 1 output.
Note! If a DSP::addInput just occurred, the connection might not be ready because the DSP system is still queued to connect in the background. If so the function will return FMOD_ERR_NOTREADY and the input will be null. Poll until it is ready.
See Also
Version 1.10.03 Built on Feb 1, 2018