Wwise Plug-in IDs
Wwise Plug-ins are identified by a Company ID and a Plug-in ID. These IDs are defined in the plugin_xml.xml file.
- The Company ID (attribute
CompanyIDon tagsEffectPlugin,SourcePlugin,ConversionPlugin, and so on in the XML file) is a 12-bit unsigned integer, with 0 being reserved for Audiokinetic. - The Plug-in ID (attribute
PluginIDon tagsEffectPlugin,SourcePlugin,ConversionPlugin, and so on in the XML file) is a 16-bit unsigned integer in the range 0-65535. It is used to uniquely identify a particular plug-in for the specified Company ID. The combination of the Company ID and Plug-in ID must be unique on a given machine.
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.
|
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.
The plug-in type values are defined in the AkPluginType enum (IAkEffect.h) as follows:
- AkPluginTypeNone = 0, used internally by Audiokinetic
- AkPluginTypeCodec = 1, conversion plug-ins
- AkPluginTypeSource = 2, source plug-ins
- AkPluginTypeEffect = 3, effect plug-ins
- Audiokinetic Company IDs and Plug-in IDs
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.
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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