Firelight Technologies FMOD Studio API

SoundGroup::setMuteFadeSpeed

Specify a time in seconds for FMOD_SOUNDGROUP_BEHAVIOR_MUTE behavior to fade with. By default there is no fade.

When more sounds are playing in a SoundGroup than are specified with SoundGroup::setMaxAudible, the least important sound (ie lowest priority / lowest audible volume due to 3D position, volume etc) will fade to silence if FMOD_SOUNDGROUP_BEHAVIOR_MUTE is used, and any previous sounds that were silent because of this rule will fade in if they are more important.

C++ Syntax

FMOD_RESULT SoundGroup::setMuteFadeSpeed(
  float speed
);

C Syntax

FMOD_RESULT FMOD_SoundGroup_SetMuteFadeSpeed(
  FMOD_SOUNDGROUP *soundgroup,
  float speed
);

C# Syntax

RESULT SoundGroup.setMuteFadeSpeed(
  float speed
);

JavaScript Syntax

SoundGroup.setMuteFadeSpeed(
  speed                            
);

Parameters

speed

Fade time in seconds (1.0 = 1 second). Default = 0.0. (no fade).

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

If a mode besides FMOD_SOUNDGROUP_BEHAVIOR_MUTE is used, the fade speed is ignored.

See Also

• SoundGroup::getMuteFadeSpeed
• SoundGroup::setMaxAudibleBehavior
• SoundGroup::getMaxAudibleBehavior
• SoundGroup::setMaxAudible
• SoundGroup::getMaxAudible
• System::createSoundGroup
• System::getMasterSoundGroup

Version 1.10.03 Built on Feb 1, 2018