Firelight Technologies FMOD Studio API
FMOD_OUTPUT_GETHANDLE_CALLBACK
Called when the user calls System::getOutputHandle.
C/C++ Syntax
FMOD_RESULT F_CALLBACK FMOD_OUTPUT_GETHANDLE_CALLBACK(
FMOD_OUTPUT_STATE *output_state,
void **handle
);
Parameters
output_state
Pointer to the plugin state. The user can use this variable to access runtime plugin specific variables and plugin writer user data.
handle
Address of a variable to receieve the current plugin's output 'handle'. This is only if the plugin writer wants to allow the user access to the main handle behind the plugin (for example the file handle in a file writer plugin). The pointer type must be published to the user somehow, as is done in fmod.h.
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
Remember to return FMOD_OK at the bottom of the function, or an appropriate error code from FMOD_RESULT.
See Also
Version 1.10.03 Built on Feb 1, 2018