Studio::System::loadCommandReplay

FMOD Studio API

Firelight Technologies FMOD Studio API

Studio::System::loadCommandReplay

Playback Studio commands that have previously been recorded to file.

C++ Syntax

FMOD_RESULT Studio::System::loadCommandReplay(
  const char *filename,
  FMOD_STUDIO_COMMANDREPLAY_FLAGS flags
);

C Syntax

FMOD_RESULT FMOD_Studio_System_LoadCommandReplay(
  FMOD_STUDIO_SYSTEM *system,
  const char *filename,
  FMOD_STUDIO_COMMANDREPLAY_FLAGS flags
);

C# Syntax

RESULT Studio.System.loadCommandReplay(
  string path,
  COMMANDREPLAY_FLAGS flags,
  out CommandReplay replay
);

JavaScript Syntax

System.loadCommandReplay(
  filename,                        
  flags,                           
  playback                         // writes value to playback.val
);

Parameters

filename
The filename to load the command replay file from.
flags
Flags that control the command replay.

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.

See Also




Version 1.10.03 Built on Feb 1, 2018