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
);
C# Syntax
RESULT Sound.getSubSoundParent(
out Sound parentsound
);
JavaScript Syntax
Sound.getSubSoundParent(
parentsound // writes value to parentsound.val
);
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
Version 1.10.03 Built on Feb 1, 2018