Firelight Technologies FMOD Studio API

SoundGroup::getMaxAudible

Retrieves the number of concurrent playbacks of sounds in a sound group to the specified value.
If the sounds in the sound group are playing this many times, any attepts to play more of the sounds in the sound group will fail with FMOD_ERR_MAXAUDIBLE.

C++ Syntax

FMOD_RESULT SoundGroup::getMaxAudible(
  int *maxaudible
);

C Syntax

FMOD_RESULT FMOD_SoundGroup_GetMaxAudible(
  FMOD_SOUNDGROUP *soundgroup,
  int *maxaudible
);

C# Syntax

RESULT SoundGroup.getMaxAudible(
  out int maxaudible
);

JavaScript Syntax

SoundGroup.getMaxAudible(
  maxaudible                       // writes value to maxaudible.val
);

Parameters

maxaudible

Address of a variable to receive the number of playbacks to be audible at once. -1 = unlimited. 0 means no sounds in this group will succeed. Default = -1.

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

SoundGroup::getNumPlaying can be used to determine how many instances of the sounds in the sound group are playing.

See Also

• SoundGroup::setMaxAudible
• SoundGroup::getNumPlaying
• System::createSoundGroup
• System::getMasterSoundGroup

Version 1.10.03 Built on Feb 1, 2018