Firelight Technologies FMOD Studio API
FMOD_STUDIO_COMMANDREPLAY_FRAME_CALLBACK
Callback for when the command replay goes to the next frame.
C/C++ Syntax
FMOD_RESULT F_CALLBACK FMOD_STUDIO_COMMANDREPLAY_FRAME_CALLBACK(
FMOD_STUDIO_COMMANDREPLAY *replay,
int commandIndex,
float currentTime,
void *userdata
);
Parameters
replay
Pointer to the command replay object.
commandIndex
The current playback command index.
currentTime
The current playback time.
userdata
The userdata assigned into the given replay, or NULL if not set.
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_STUDIO_COMMANDREPLAY * to FMOD::Studio::CommandReplay * inside the callback and use as normal.
'userdata' is the userdata assigned to the system from Studio::CommandReplay::setUserData function.
The command replay file is batched into frames, where each frame will be executed only after the appropriate time as passed. Each time a frame is passed this callback will be invoked.
See Also
Version 1.10.03 Built on Feb 1, 2018