Firelight Technologies FMOD Studio API

SoundGroup::setUserData

Sets a user value that the SoundGroup object will store internally. Can be retrieved with SoundGroup::getUserData.

C++ Syntax

FMOD_RESULT SoundGroup::setUserData(
  void *userdata
);

C Syntax

FMOD_RESULT FMOD_SoundGroup_SetUserData(
  FMOD_SOUNDGROUP *soundgroup,
  void *userdata
);

C# Syntax

RESULT SoundGroup.setUserData(
  IntPtr userdata
);

JavaScript Syntax

SoundGroup.setUserData(
  userdata                         
);

Parameters

userdata

Address of user data that the user wishes stored within the sound group 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

This function is primarily used in case the user wishes to 'attach' data to an FMOD object.
It can be useful if an FMOD callback passes an object of this type as a parameter, and the user does not know which object it is (if many of these types of objects exist). Using SoundGroup::getUserData would help in the identification of the object.

See Also

• SoundGroup::getUserData
• System::createSoundGroup
• System::getMasterSoundGroup

Version 1.10.03 Built on Feb 1, 2018