Studio::Bus::stopAllEvents

FMOD Studio API

Firelight Technologies FMOD Studio API

Studio::Bus::stopAllEvents

Stops all EventInstances routed into the bus.

C++ Syntax

FMOD_RESULT Studio::Bus::stopAllEvents(
  FMOD_STUDIO_STOP_MODE mode
);

C Syntax

FMOD_RESULT FMOD_Studio_Bus_StopAllEvents(
  FMOD_STUDIO_BUS *bus,
  FMOD_STUDIO_STOP_MODE mode
);

C# Syntax

RESULT Studio.Bus.stopAllEvents(
  STOP_MODE mode
);

JavaScript Syntax

Bus.stopAllEvents(
  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




Version 1.10.03 Built on Feb 1, 2018