Firelight Technologies FMOD Studio API

Studio::CommandReplay::getCommandAtTime

Finds a command that corresponds to the given playback time.

C++ Syntax

FMOD_RESULT Studio::CommandReplay::getCommandAtTime(
  float time,
  int *commandIndex
);

C Syntax

FMOD_RESULT FMOD_Studio_CommandReplay_GetCommandAtTime(
  FMOD_STUDIO_COMMANDREPLAY *commandreplay,
  float time,
  int *commandIndex
);

C# Syntax

RESULT Studio.CommandReplay.getCommandAtTime(
  float time,
  out int commandIndex
);

JavaScript Syntax

CommandReplay.getCommandAtTime(
  time,                            
  commandindex                     // writes value to commandindex.val
);

Parameters

time

The time used to find a command index.

commandIndex

Address of the variable to receive the command index.

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

The time passed in must be less than or equal to the total playback time of the replay. It will return an index for the first command which has an equal or greater time.

See Also

• Studio::CommandReplay::getCommandCount
• Studio::CommandReplay::getCommandString
• Studio::CommandReplay::getCommandInfo

Version 1.10.03 Built on Feb 1, 2018