Studio::CommandReplay::getPlaybackState

FMOD Studio API

Firelight Technologies FMOD Studio API

Studio::CommandReplay::getPlaybackState

Retrieves the playback state.

C++ Syntax

FMOD_RESULT Studio::CommandReplay::getPlaybackState(
  FMOD_STUDIO_PLAYBACK_STATE *state
);

C Syntax

FMOD_RESULT FMOD_Studio_CommandReplay_GetPlaybackState(
  FMOD_STUDIO_COMMANDREPLAY *commandreplay,
  FMOD_STUDIO_PLAYBACK_STATE *state
);

C# Syntax

RESULT Studio.CommandReplay.getPlaybackState(
  out PLAYBACK_STATE state
);

JavaScript Syntax

CommandReplay.getPlaybackState(
  state                            // writes value to state.val
);

Parameters

state
The address of the variable to hold the playback state. 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.

See Also




Version 1.10.03 Built on Feb 1, 2018