Firelight Technologies FMOD Studio API

Sound::setSubSound

Assigns a sound as a 'subsound' of another sound. A sound can contain other sounds. The sound object that is issuing the command will be the 'parent' sound.

C++ Syntax

FMOD_RESULT Sound::setSubSound(
  int index,
  FMOD::Sound *subsound
);

C Syntax

FMOD_RESULT FMOD_Sound_SetSubSound(
  FMOD_SOUND *sound,
  int index,
  FMOD_SOUND *subsound
);

Parameters

index

Index within the sound to set the new sound to as a 'subsound'.

subsound

Sound object to set as a subsound within this sound.

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

• Sound::getNumSubSounds
• Sound::getSubSound

Version 1.03.06 Built on Apr 17, 2014