Firelight Technologies FMOD Studio API

SoundGroup::getSound

Retrieves a pointer to a sound from within a sound group.

C++ Syntax

FMOD_RESULT SoundGroup::getSound(
  int index,
  FMOD::Sound **sound
);

C Syntax

FMOD_RESULT FMOD_SoundGroup_GetSound(
  FMOD_SOUNDGROUP *soundgroup,
  int index,
  FMOD_SOUND **sound
);

C# Syntax

RESULT SoundGroup.getSound(
  int index,
  out Sound sound
);

JavaScript Syntax

SoundGroup.getSound(
  index,                           
  sound                            // writes value to sound.val
);

Parameters

index

Index of the sound that is to be retrieved.

sound

Address of a variable to receieve a pointer to a Sound object.

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

Use SoundGroup::getNumSounds in conjunction with this function to enumerate all sounds in a sound group.

See Also

• System::createSoundGroup
• System::createSound
• SoundGroup::getNumSounds
• System::getMasterSoundGroup

Version 1.10.03 Built on Feb 1, 2018