Version
arrow_right Table of Contents

Other Documentation

Wwise SDK 2021.1.9

◆ RegisterPluginDLL()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::RegisterPluginDLL ( const AkOSChar in_DllName,
const AkOSChar in_DllPath = NULL 
)

Loads a plug-in dynamic library and registers it with the sound engine.
With dynamic linking, all plugins are automatically registered. The plug-in DLL must be in the OS-specific library path or in the same location as the executable. If not, set AkInitSettings.szPluginDLLPath.

Returns
  • Ak_Success if successful.
  • AK_FileNotFound if the DLL is not found in the OS path or if it has extraneous dependencies not found.
  • AK_InsufficientMemory if the system ran out of resources while loading the dynamic library
  • AK_NotCompatible if the file was found but is not binary-compatible with the system's expected executable format
  • AK_InvalidFile if the symbol g_pAKPluginList is not exported by the dynamic library
  • AK_Fail if an unexpected system error was encountered
Parameters
in_DllName Name of the DLL to load, without "lib" prefix or extension.
in_DllPath Optional path to the DLL. Will override szPLuginDLLPath that was set in AkInitSettings.