Firelight Technologies FMOD Studio API
Studio::Bus::setPaused
Sets the pause state of the bus.
C++ Syntax
FMOD_RESULT Studio::Bus::setPaused(
bool paused
);
C Syntax
FMOD_RESULT FMOD_Studio_Bus_SetPaused(
FMOD_STUDIO_BUS *bus,
FMOD_BOOL paused
);
C# Syntax
RESULT Studio.Bus.setPaused(
bool paused
);
JavaScript Syntax
Bus.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 all audio routed into the bus. If paused is true, it overrides the pause state of all objects routed into this bus. If paused is false, objects routed into this bus obey their own pause state.
See Also
Version 1.10.03 Built on Feb 1, 2018