Firelight Technologies FMOD Studio API

SoundGroup::setMaxAudibleBehavior

This function changes the way the sound playback behaves when too many sounds are playing in a soundgroup. Muting, failing and stealing behaviors can be specified.

C++ Syntax

FMOD_RESULT SoundGroup::setMaxAudibleBehavior(
  FMOD_SOUNDGROUP_BEHAVIOR behavior
);

C Syntax

FMOD_RESULT FMOD_SoundGroup_SetMaxAudibleBehavior(
  FMOD_SOUNDGROUP *soundgroup,
  FMOD_SOUNDGROUP_BEHAVIOR behavior
);

C# Syntax

RESULT SoundGroup.setMaxAudibleBehavior(
  SOUNDGROUP_BEHAVIOR behavior
);

JavaScript Syntax

SoundGroup.setMaxAudibleBehavior(
  behavior                         
);

Parameters

behavior

Specify a behavior determined with a FMOD_SOUNDGROUP_BEHAVIOR flag. Default is FMOD_SOUNDGROUP_BEHAVIOR_FAIL.

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

• FMOD_SOUNDGROUP_BEHAVIOR
• SoundGroup::getMaxAudibleBehavior
• SoundGroup::setMaxAudible
• SoundGroup::getMaxAudible
• SoundGroup::setMuteFadeSpeed
• SoundGroup::getMuteFadeSpeed
• System::createSoundGroup
• System::getMasterSoundGroup

Version 1.10.03 Built on Feb 1, 2018