Studio::CommandReplay::setPaused

FMOD Studio API

Firelight Technologies FMOD Studio API

Studio::CommandReplay::setPaused

Sets the replay paused or unpaused.

C++ Syntax

FMOD_RESULT Studio::CommandReplay::setPaused(
  bool paused
);

C Syntax

FMOD_RESULT FMOD_Studio_CommandReplay_SetPaused(
  FMOD_STUDIO_COMMANDREPLAY *commandreplay,
  FMOD_BOOL paused
);

C# Syntax

RESULT Studio.CommandReplay.setPaused(
  bool paused
);

JavaScript Syntax

CommandReplay.setPaused(
  paused                           
);

Parameters

paused
The desired pause state. true = pause, false = unpause.

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

When paused the replay will no longer contiune to issue replay commands.

See Also




Version 1.10.03 Built on Feb 1, 2018