Firelight Technologies FMOD Studio API
Studio::CommandReplay::start
Starts the command replay running.
C++ Syntax
FMOD_RESULT Studio::CommandReplay::start();
C Syntax
FMOD_RESULT FMOD_Studio_CommandReplay_Start(FMOD_STUDIO_COMMANDREPLAY *commandreplay);
C# Syntax
RESULT Studio.CommandReplay.start();
JavaScript Syntax
CommandReplay.start();
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
This function starts the replay running. The state of the replay can be called from Studio::CommandReplay::getPlaybackState.
If the replay is already running then it will restart from the beginning.
Once the replay finishes it will automatically stop.
See Also
- Studio::System::loadCommandReplay
- Studio::CommandReplay::stop
- Studio::CommandReplay::getPlaybackState
Version 1.10.03 Built on Feb 1, 2018