Version

    Other Documentation

menu_open
Wwise SDK 2022.1.8

◆ RegisterPlugin()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::RegisterPlugin ( AkPluginType  in_eType,
AkUInt32  in_ulCompanyID,
AkUInt32  in_ulPluginID,
AkCreatePluginCallback  in_pCreateFunc,
AkCreateParamCallback  in_pCreateParamFunc,
AkGetDeviceListCallback  in_pGetDeviceList = NULL 
)

Registers a plug-in with the sound engine and sets the callback functions to create the plug-in and its parameter node.

Note: This function is deprecated. Registration is now automatic if you link plug-ins statically. If plug-ins are dynamic libraries (such as DLLs or SOs), use RegisterPluginDLL.
See also
Returns
  • AK_Success if successful
  • AK_InvalidParameter if invalid parameters were provided
  • AK_InsufficientMemory if there isn't enough memory to register the plug-in
Remarks
Codecs and plug-ins must be registered before loading banks that use them.
Loading a bank referencing an unregistered plug-in or codec will result in a load bank success, but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects, posting the event will fail.
Parameters
in_eType Plug-in type (for example, source or effect)
in_ulCompanyID Company identifier (as declared in the plug-in description XML file)
in_ulPluginID Plug-in identifier (as declared in the plug-in description XML file)
in_pCreateFunc Pointer to the plug-in's creation function
in_pCreateParamFunc Pointer to the plug-in's parameter node creation function
in_pGetDeviceList Optional pointer to the plug-in's device enumeration function. Specify for a sink plug-in to support AK::SoundEngine::GetDeviceList.

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