Firelight Technologies FMOD Studio API

System::createSoundGroup

Creates a sound group, which can store handles to multiple Sound pointers.

C++ Syntax

FMOD_RESULT System::createSoundGroup(
  const char *name,
  FMOD::SoundGroup **soundgroup
);

C Syntax

FMOD_RESULT FMOD_System_CreateSoundGroup(
  FMOD_SYSTEM *system,
  const char *name,
  FMOD_SOUNDGROUP **soundgroup
);

C# Syntax

RESULT System.createSoundGroup(
  string name,
  out SoundGroup soundgroup
);

JavaScript Syntax

System.createSoundGroup(
  name,                            
  soundgroup                       // writes value to soundgroup.val
);

Parameters

name

Name of sound group.

soundgroup

Address of a variable to receive a pointer to a 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

Once a SoundGroup is created, Sound::setSoundGroup is used to put a sound in a SoundGroup.

See Also

• SoundGroup::release
• Sound::setSoundGroup

Version 1.10.03 Built on Feb 1, 2018