Firelight Technologies FMOD Studio API

Studio::Bus::getMute

Retrieves the mute state of the bus.

C++ Syntax

FMOD_RESULT Studio::Bus::getMute(
  bool *mute
);

C Syntax

FMOD_RESULT FMOD_Studio_Bus_GetMute(
  FMOD_STUDIO_BUS *bus,
  FMOD_BOOL *mute
);

C# Syntax

RESULT Studio.Bus.getMute(
  out bool mute
);

JavaScript Syntax

Bus.getMute(
  mute                             // writes value to mute.val
);

Parameters

mute

Address of a variable to receive the mute 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::setMute

Version 1.10.03 Built on Feb 1, 2018