Firelight Technologies FMOD Studio API

Studio::CommandReplay::getCommandInfo

Retrieves information about the command at the given index.

C++ Syntax

FMOD_RESULT Studio::CommandReplay::getCommandInfo(
  int commandIndex,
  FMOD_STUDIO_COMMAND_INFO *info
);

C Syntax

FMOD_RESULT FMOD_Studio_CommandReplay_GetCommandInfo(
  FMOD_STUDIO_COMMANDREPLAY *commandreplay,
  int commandIndex,
  FMOD_STUDIO_COMMAND_INFO *info
);

C# Syntax

RESULT Studio.CommandReplay.getCommandInfo(
  int commandIndex,
  out COMMAND_INFO info
);

JavaScript Syntax

CommandReplay.getCommandInfo(
  commandindex,                    
  info                             // writes value to info.val
);

Parameters

commandIndex

The index of the command.

info

Address of the variable to receive command info structure.

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

• Studio::CommandReplay::getCommandCount
• Studio::CommandReplay::getCommandString
• Studio::CommandReplay::getCommandAtTime
• FMOD_STUDIO_COMMAND_INFO

Version 1.10.03 Built on Feb 1, 2018