Firelight Technologies FMOD Studio API
FMOD_SOUND_NONBLOCK_CALLBACK
Callback to be called when a sound has finished loading, or a non blocking seek is occuring.
C/C++ Syntax
FMOD_RESULT F_CALLBACK FMOD_SOUND_NONBLOCK_CALLBACK(
FMOD_SOUND *sound,
FMOD_RESULT result
);
Parameters
sound
Pointer to the sound. C++ users see remarks.
result
Error code. FMOD_OK if sound was created successfully, or an error code otherwise.
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
C++ Users. Cast FMOD_SOUND *
to FMOD::Sound *
inside the callback and use as normal.
Return code currently ignored.
Note that for non blocking streams a seek could occur when restarting the sound after the first playthrough. This will result in a callback being triggered again.
Since this callback can occur from the async thread, there are restrictions about what functions can be called during the callback. All Sound functions are safe to call, except for Sound::setSoundGroup and Sound::release. It is also safe to call System::getUserData. The rest of the Low Level API and the Studio API is not allowed. Calling a non-allowed function will return FMOD_ERR_INVALID_THREAD.
See Also
Version 1.10.03 Built on Feb 1, 2018