Firelight Technologies FMOD Studio API

Sound::getSubSoundParent

Retrieves a handle to the parent Sound object that contains our subsound.

C++ Syntax

FMOD_RESULT Sound::getSubSoundParent(
  FMOD::Sound **parentsound
);

C Syntax

FMOD_RESULT FMOD_Sound_GetSubSoundParent(
  FMOD_SOUND *sound,
  FMOD_SOUND **parentsound
);

Parameters

parentsound

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 not a subsound, the parentsound will be returned as NULL.

See Also

• Sound::getNumSubSounds
• Sound::getSubSound

Version 1.03.06 Built on Apr 17, 2014