Wwise Plug-ins are identified by a Company ID and a Plug-in ID. These IDs are defined in the plugin.xml file.
CompanyID
on tags EffectPlugin
, SourcePlugin
, ConversionPlugin
.PluginID
on tags EffectPlugin
, SourcePlugin
, ConversionPlugin
.
|
Note: The combination of the Company ID and Plug-in ID must be unique. |
Within Wwise and the sound engine, the Company ID and Plug-in ID are combined with a 4-bit Plug-in Type value to form a 32-bit unique identifier. The plug-in type values are defined in the AkPluginType
enum (IAkEffect.h) as follows:
|
Note: The 4-bit type does not "help" the IDs to be different: The Plug-in Manager (in Wwise) makes sure that there is no duplicate Company ID and Plug-in ID combination, regardless of the Plug-in type. |
The packed 32-bit class ID is put together like this: Plug-in ID + Company ID + Plug-in Type == Packed 32-bit Class ID
. So, in a case where the Plug-in ID is 1, the Company ID is 0, and the Plug-in Type is 1, then the Packed 32-bit Class ID is 0x00010001.
|
Note: The Company ID used for all Audiokinetic plug-ins (Conversion, Source, and Effect plug-ins) is 0, as defined by AKCOMPANYID_AUDIOKINETIC in AkTypes.h. |
Here is an example, for a fictional effect plug-in with:
XML:
<?xml version="1.0" encoding="utf-8"?> <!-- Copyright (C) 2006 Audiokinetic Inc. --> <PluginModule> <EffectPlugin Name="FictionalDelay" CompanyID="72" PluginID="5"> ...
Plugin Factory:
... AK_IMPLEMENT_PLUGIN_FACTORY(FictionalDelayFX, AkPluginTypeEffect, 72, 5) ...
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise