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
);

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.