Firelight Technologies FMOD Studio API

Studio::Bus::getPaused

Retrieves the pause state of the bus.

C++ Syntax

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

C Syntax

FMOD_RESULT FMOD_Studio_Bus_GetPaused(
  FMOD_STUDIO_BUS *bus,
  FMOD_BOOL *paused
);

C# Syntax

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

JavaScript Syntax

Bus.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::Bus::setPaused

Version 1.10.03 Built on Feb 1, 2018