Firelight Technologies FMOD Studio API

SoundGroup::getMuteFadeSpeed

Retrieves the current time in seconds for FMOD_SOUNDGROUP_BEHAVIOR_MUTE behavior to fade with.

C++ Syntax

FMOD_RESULT SoundGroup::getMuteFadeSpeed(
  float *speed
);

C Syntax

FMOD_RESULT FMOD_SoundGroup_GetMuteFadeSpeed(
  FMOD_SOUNDGROUP *soundgroup,
  float *speed
);

C# Syntax

RESULT SoundGroup.getMuteFadeSpeed(
  out float speed
);

JavaScript Syntax

SoundGroup.getMuteFadeSpeed(
  speed                            // writes value to speed.val
);

Parameters

speed

Address of a variable to receive the 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::setMuteFadeSpeed
• SoundGroup::setMaxAudibleBehavior
• SoundGroup::getMaxAudibleBehavior
• SoundGroup::setMaxAudible
• SoundGroup::getMaxAudible
• System::createSoundGroup
• System::getMasterSoundGroup

Version 1.10.03 Built on Feb 1, 2018