Version
menu_open
Wwise SDK 2024.1.4

◆ 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 are passed and matched with plugins set on the desired bus. This means that you cannot send different data to various instances of a plug-in on the same bus.
Returns
AK_Success if data was sent successfully.
Parameters
in_busIDBus ID
in_busObjectIDBus Object ID. Pass AK_INVALID_GAME_OBJECT to send custom data with global scope. Game object scope supersedes global scope, as with RTPCs.
in_eTypePlug-in type (for example, source or effect)
in_uCompanyIDCompany identifier (as declared in the plug-in description XML file)
in_uPluginIDPlug-in identifier (as declared in the plug-in description XML file)
in_pDataThe data blob
in_uSizeInBytesSize of data

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

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

Register your project and we'll help you get started with no strings attached!

Get started with Wwise