Wwise Plug-ins are identified by a Company ID and a Plug-in ID. These IDs are defined in the plugin.xml file.

• Company ID: It is used to uniquely identify a particular Company
  • attribute CompanyID on tags EffectPlugin, SourcePlugin, ConversionPlugin.
  • 12-bit unsigned integer in the range 0-4095.
  • with 0-63 being reserved for Audiokinetic.
  • with 64-255 can be used for internal plug-in development.
  • 256-4095 are assigned by Audiokinetic to plug-in programmers.
• Plug-in ID: It is used to uniquely identify a particular plug-in for the specified Company ID
  • attribute PluginID on tags EffectPlugin, SourcePlugin, ConversionPlugin.
  • 16-bit unsigned integer in the range 0-32767.
  • Set freely by the Plug-in programmer

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:

• 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

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.

Example

Here is an example, for a fictional effect plug-in with:

• Company ID: 72
• Plugin ID: 5

XML:

Plugin Factory: