Firelight Technologies FMOD Studio API

System::getMasterSoundGroup

Retrieves the default sound group, where all sounds are placed when they are created.

C++ Syntax

FMOD_RESULT System::getMasterSoundGroup(
  FMOD::SoundGroup **soundgroup
);

C Syntax

FMOD_RESULT FMOD_System_GetMasterSoundGroup(
  FMOD_SYSTEM *system,
  FMOD_SOUNDGROUP **soundgroup
);

C# Syntax

RESULT System.getMasterSoundGroup(
  out SoundGroup soundgroup
);

JavaScript Syntax

System.getMasterSoundGroup(
  soundgroup                       // writes value to soundgroup.val
);

Parameters

soundgroup

Address of a pointer to a SoundGroup object to receive the master sound group.

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 user based soundgroup is deleted/released, the sounds will be put back into this sound group.

See Also

• SoundGroup::release
• SoundGroup::getSystemObject
• SoundGroup::setMaxAudible
• SoundGroup::getMaxAudible
• SoundGroup::getName
• SoundGroup::getNumSounds
• SoundGroup::getSound
• SoundGroup::getNumPlaying
• SoundGroup::setUserData
• SoundGroup::getUserData

Version 1.10.03 Built on Feb 1, 2018