Firelight Technologies FMOD Studio API

Studio::EventInstance::getPaused

Retrieves the pause state of the event instance.

C++ Syntax

FMOD_RESULT Studio::EventInstance::getPaused(
  bool *paused
);

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_GetPaused(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  FMOD_BOOL *paused
);

C# Syntax

RESULT Studio.EventInstance.getPaused(
  out bool paused
);

JavaScript Syntax

EventInstance.getPaused(
  paused                           // writes value to paused.val
);

Parameters

paused

Address of a variable to receive the pause state.

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

• Studio::EventInstance::setPaused

Version 1.10.03 Built on Feb 1, 2018