Firelight Technologies FMOD Studio API

SoundGroup::getMaxAudibleBehavior

Retrieves the current max audible behavior method.

C++ Syntax

FMOD_RESULT SoundGroup::getMaxAudibleBehavior(
  FMOD_SOUNDGROUP_BEHAVIOR *behavior
);

C Syntax

FMOD_RESULT FMOD_SoundGroup_GetMaxAudibleBehavior(
  FMOD_SOUNDGROUP *soundgroup,
  FMOD_SOUNDGROUP_BEHAVIOR *behavior
);

C# Syntax

RESULT SoundGroup.getMaxAudibleBehavior(
  out SOUNDGROUP_BEHAVIOR behavior
);

JavaScript Syntax

SoundGroup.getMaxAudibleBehavior(
  behavior                         // writes value to behavior.val
);

Parameters

behavior

Address of a variable to receive the current sound group max playbacks behavior. 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::setMaxAudibleBehavior
• SoundGroup::setMaxAudible
• SoundGroup::getMaxAudible
• SoundGroup::setMuteFadeSpeed
• SoundGroup::getMuteFadeSpeed
• System::createSoundGroup
• System::getMasterSoundGroup

Version 1.10.03 Built on Feb 1, 2018