Studio::CommandReplay::stop

FMOD Studio API

Firelight Technologies FMOD Studio API

Studio::CommandReplay::stop

Stops the command replay.

C++ Syntax

FMOD_RESULT Studio::CommandReplay::stop();

C Syntax

FMOD_RESULT FMOD_Studio_CommandReplay_Stop(FMOD_STUDIO_COMMANDREPLAY *commandreplay);

C# Syntax

RESULT Studio.CommandReplay.stop();

JavaScript Syntax

CommandReplay.stop();

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 stops the replay.

Unless the FMOD_STUDIO_COMMANDREPLAY_SKIP_CLEANUP flag has been used, all resources that were created as part of the replay will be removed when the replay stops.

See Also




Version 1.10.03 Built on Feb 1, 2018