Firelight Technologies FMOD Studio API

Studio::EventInstance::setPaused

Sets the pause state of the event instance.

C++ Syntax

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

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_SetPaused(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  FMOD_BOOL paused
);

C# Syntax

RESULT Studio.EventInstance.setPaused(
  bool paused
);

JavaScript Syntax

EventInstance.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

This function allows pausing/unpausing of an event instance.

See Also

• Studio::EventInstance::getPaused

Version 1.10.03 Built on Feb 1, 2018