Firelight Technologies FMOD Studio API

Sound::getSubSound

Retrieves a handle to a Sound object that is contained within the parent sound.

C++ Syntax

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

C Syntax

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

C# Syntax

RESULT Sound.getSubSound(
  int index,
  out Sound subsound
);

JavaScript Syntax

Sound.getSubSound(
  index,                           
  subsound                         // writes value to subsound.val
);

Parameters

index

Index of the subsound to retrieve within this sound.

subsound

Address of a variable that receives the sound object specified.

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 the sound is a stream and FMOD_NONBLOCKING was not used, then this call will perform a blocking seek/flush to the specified subsound.

If FMOD_NONBLOCKING was used to open this sound and the sound is a stream, FMOD will do a non blocking seek/flush and set the state of the subsound to FMOD_OPENSTATE_SEEKING.
The sound won't be ready to be used in this case until the state of the sound becomes FMOD_OPENSTATE_READY (or FMOD_OPENSTATE_ERROR).

See Also

• Sound::getNumSubSounds
• Sound::getSubSoundParent
• System::createSound
• FMOD_MODE
• FMOD_OPENSTATE

Version 1.10.03 Built on Feb 1, 2018