Firelight Technologies FMOD Studio API
Studio::CommandReplay::setFrameCallback
Sets a callback that is issued when the replay reaches a new frame.
C++ Syntax
FMOD_RESULT Studio::CommandReplay::setFrameCallback(
FMOD_STUDIO_COMMANDREPLAY_FRAME_CALLBACK callback
);
C Syntax
FMOD_RESULT FMOD_Studio_CommandReplay_SetFrameCallback(
FMOD_STUDIO_COMMANDREPLAY *commandreplay,
FMOD_STUDIO_COMMANDREPLAY_FRAME_CALLBACK callback
);
C# Syntax
RESULT Studio.CommandReplay.setFrameCallback(
COMMANDREPLAY_FRAME_CALLBACK callback
);
JavaScript Syntax
CommandReplay.setFrameCallback(
callback
);
Parameters
- callback
- The callback to use.
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
The frame callback is called whenever a new frame of the replay is reached. Each frame command will advance the time of the replay.
See Also
Version 1.10.03 Built on Feb 1, 2018