Firelight Technologies FMOD Studio API

Channel::setMute

Sets the mute state effectively silencing it or returning it to its normal volume.

C++ Syntax

FMOD_RESULT Channel::setMute(
  bool mute
);

C Syntax

FMOD_RESULT FMOD_Channel_SetMute(
  FMOD_CHANNEL *channel,
  FMOD_BOOL mute
);

Parameters

mute

Mute state, true = mute (silent), false = normal volume.

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

Each channel and channel group has its own mute state, muting a channel group will mute all child channels but will not affect their individual setting. Calling ChannelControl::getMute will always return the value you set.

See Also

• ChannelControl::getMute

Version 1.03.06 Built on Apr 17, 2014