Firelight Technologies FMOD Studio API

Studio::System::startCommandCapture

Start recording all Studio commands to a file with the given path.

C++ Syntax

FMOD_RESULT Studio::System::startCommandCapture(
  const char *filename,
  FMOD_STUDIO_COMMANDCAPTURE_FLAGS flags
);

C Syntax

FMOD_RESULT FMOD_Studio_System_StartCommandCapture(
  FMOD_STUDIO_SYSTEM *system,
  const char *filename,
  FMOD_STUDIO_COMMANDCAPTURE_FLAGS flags
);

C# Syntax

RESULT Studio.System.startCommandCapture(
  string path,
  COMMANDCAPTURE_FLAGS flags
);

JavaScript Syntax

System.startCommandCapture(
  filename,                        
  flags                            
);

Parameters

filename

The filename where the write the command replay file.

flags

Flags that control command capturing.

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

Commands can be captured and then replayed for debug purposes.

Unless the FMOD_STUDIO_COMMANDCAPTURE_SKIP_INITIAL_STATE flag is specified, the command capture will first record the set of all banks and event instances that currently exist.

See Also

• FMOD_STUDIO_COMMANDCAPTURE_FLAGS
• Studio::System::stopCommandCapture
• Studio::System::loadCommandReplay

Version 1.10.03 Built on Feb 1, 2018