Firelight Technologies FMOD Studio API
Studio::CommandReplay::getCurrentCommand
Retrieves the progress through the command replay.
C++ Syntax
FMOD_RESULT Studio::CommandReplay::getCurrentCommand(
int *commandIndex,
float *currentTime
);
C Syntax
FMOD_RESULT FMOD_Studio_CommandReplay_GetCurrentCommand(
FMOD_STUDIO_COMMANDREPLAY *commandreplay,
int *commandIndex,
float *currentTime
);
C# Syntax
RESULT Studio.CommandReplay.getCurrentCommand(
out int commandIndex,
out float currentTime
);
JavaScript Syntax
CommandReplay.getCurrentCommand(
commandindex, // writes value to commandindex.val
currenttime // writes value to currenttime.val
);
Parameters
- commandIndex
- The address of the variable to hold the current command index. Specify 0 or NULL to ignore.
- currentTime
- The address of the variable to hold the current playback time. Specify 0 or NULL to ignore.
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 returns the current command index the playback is up to, and the current playback time.
See Also
Version 1.10.03 Built on Feb 1, 2018