Firelight Technologies FMOD Studio API
ChannelGroup::setUserData
Sets a user value that can be retrieved with ChannelControl::getUserData.
C++ Syntax
FMOD_RESULT ChannelGroup::setUserData(
void *userdata
);
C Syntax
FMOD_RESULT FMOD_ChannelGroup_SetUserData(
FMOD_CHANNELGROUP *channelgroup,
void *userdata
);
C# Syntax
RESULT ChannelGroup.setUserData(
IntPtr userdata
);
JavaScript Syntax
ChannelGroup.setUserData(
userdata
);
Parameters
- userdata
- Data that the user wishes stored within this object.
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
You can use this to store a pointer to any wrapper or internal class that is associated with this object. This is especially useful for callbacks where you need to get back access to your own objects.
See Also
Version 1.10.03 Built on Feb 1, 2018