Firelight Technologies FMOD Studio API

ChannelGroup::getMute

Retrieves the mute state.

C++ Syntax

FMOD_RESULT ChannelGroup::getMute(
  bool *mute
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_GetMute(
  FMOD_CHANNELGROUP *channelgroup,
  FMOD_BOOL *mute
);

C# Syntax

RESULT ChannelGroup.getMute(
  out bool mute
);

JavaScript Syntax

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

Parameters

mute

Address of a variable that receives the current 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.

See Also

• ChannelControl::setMute

Version 1.10.03 Built on Feb 1, 2018