Firelight Technologies FMOD Studio API

Studio::MixerStrip::setMute

Sets the pause state of the MixerStrip.

C++ Syntax

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

C Syntax

FMOD_RESULT FMOD_Studio_MixerStrip_SetMute(
  FMOD_STUDIO_MIXERSTRIP *mixerstrip,
  FMOD_BOOL mute
);

Parameters

mute

The desired pause state. true = pause, false = unpause.

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 mixer strip. If mute is true, it overrides the mute state of all objects controlled by this mixer strip. If mute is false, controlled objects obey their own pause state.

See Also

• Studio::MixerStrip::getMute

Version 1.03.06 Built on Apr 17, 2014