Studio::CommandReplay::seekToCommand

FMOD Studio API

Firelight Technologies FMOD Studio API

Studio::CommandReplay::seekToCommand

Seek to a given command index in the command replay.

C++ Syntax

FMOD_RESULT Studio::CommandReplay::seekToCommand(
  int commandIndex
);

C Syntax

FMOD_RESULT FMOD_Studio_CommandReplay_SeekToCommand(
  FMOD_STUDIO_COMMANDREPLAY *commandreplay,
  int commandIndex
);

C# Syntax

RESULT Studio.CommandReplay.seekToCommand(
  int commandIndex
);

JavaScript Syntax

CommandReplay.seekToCommand(
  commandindex                     
);

Parameters

commandIndex
The command index to seek to.

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 sets the seek command to seek to. The replay will start from the given seek position.

See Also




Version 1.10.03 Built on Feb 1, 2018