◆ SendPluginCustomGameData()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::SendPluginCustomGameData	(	AkUniqueID	in_busID,
		AkGameObjectID	in_busObjectID,
		AkPluginType	in_eType,
		AkUInt32	in_uCompanyID,
		AkUInt32	in_uPluginID,
		const void *	in_pData,
		AkUInt32	in_uSizeInBytes
	)

Sends custom game data to a plug-in that resides on a bus (insert Effect or mixer plug-in). Data will be copied and stored into a separate list. Previous entry is deleted when a new one is sent. Sets the data pointer to NULL to clear item from the list.

Note: The plug-in type and ID is passed and matched with plugins set on the desired bus. This means that you cannot send different data to various instances of the plug-in on a same bus.

Returns: AK_Success if data was sent successfully.

Parameters

in_busID	Bus ID
in_busObjectID	Bus Object ID. Pass AK_INVALID_GAME_OBJECT to send custom data with global scope. Game object scope supersedes global scope, as with RTPCs.
in_eType	Plug-in type (for example, source or effect)
in_uCompanyID	Company identifier (as declared in the plug-in description XML file)
in_uPluginID	Plug-in identifier (as declared in the plug-in description XML file)
in_pData	The data blob
in_uSizeInBytes	Size of data

Wwise SDK 2022.1.7

SendPluginCustomGameData

Other Documentation

◆ SendPluginCustomGameData()

Was this page helpful?

Need Support?

Tell us about your project. We're here to help.