Firelight Technologies FMOD Studio API

Studio::EventInstance::stop

Stops playback of the event instance.

C++ Syntax

FMOD_RESULT Studio::EventInstance::stop(
  FMOD_STUDIO_STOP_MODE mode
);

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_Stop(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  FMOD_STUDIO_STOP_MODE mode
);

C# Syntax

RESULT Studio.EventInstance.stop(
  STOP_MODE mode
);

JavaScript Syntax

EventInstance.stop(
  mode                             
);

Parameters

mode

The desired stop mode. See FMOD_STUDIO_STOP_MODE.

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

• FMOD_STUDIO_STOP_MODE
• Studio::EventInstance::start

Version 1.10.03 Built on Feb 1, 2018