Firelight Technologies FMOD Studio API
SoundGroup::getUserData
Retrieves the user value that that was set by calling the SoundGroup::setUserData function.
C++ Syntax
FMOD_RESULT SoundGroup::getUserData(
void **userdata
);
C Syntax
FMOD_RESULT FMOD_SoundGroup_GetUserData(
FMOD_SOUNDGROUP *soundgroup,
void **userdata
);
C# Syntax
RESULT SoundGroup.getUserData(
out IntPtr userdata
);
JavaScript Syntax
SoundGroup.getUserData(
userdata // writes value to userdata.val
);
Parameters
- userdata
- Address of a pointer that receives the data specified with the SoundGroup::setUserData function.
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
Version 1.10.03 Built on Feb 1, 2018