Firelight Technologies FMOD Studio API

Studio::Bus::setMute

Sets the mute state of the bus.

C++ Syntax

FMOD_RESULT Studio::Bus::setMute(
  bool mute
);

C Syntax

FMOD_RESULT FMOD_Studio_Bus_SetMute(
  FMOD_STUDIO_BUS *bus,
  FMOD_BOOL mute
);

C# Syntax

RESULT Studio.Bus.setMute(
  bool mute
);

JavaScript Syntax

Bus.setMute(
  mute                             
);

Parameters

mute

The desired mute state. true = mute, false = unmute.

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 muting/unmuting of all audio routed into the bus. If mute is true, it overrides the mute state of all objects routed into this bus. If mute is false, objects routed into this bus obey their own mute state.

See Also

• Studio::Bus::getMute

Version 1.10.03 Built on Feb 1, 2018