Integrating Plug-ins
Introduction
Plug-ins are used in Wwise to offer various types of sources and effects to the Wwise user and game developer. Source plug-ins are used to generate sound, while effect plug-ins are used to modify sound.
For a complete list of available plug-ins, refer to Source and Effect Plug-ins.
Integrating Plug-ins
A Wwise audio plug-in consists of two files:
- A DLL (How to Create a Wwise Plug-in DLL)
- An XML file (Wwise Plug-in XML Description Files)
On startup, Wwise searches for these plug-in files in the "plugins" folder in the main Wwise installation folder. Wwise matches the DLL file with the XML file based on the file name. This means that each plug-in DLL must have its companion XML file with the same base name. For example, if your plug-in DLL is named "MyPlugin.dll", then the XML file should be named "MyPlugin.xml".
To install a plug-in:
- 32-bit application: Copy the DLL and XML files to the "Authoring/Win32/Release/bin/plugins" folder in the main Wwise folder.
- 64-bit application: Copy the DLL and XML files to the "Authoring/x64/Release/bin/plugins" folder in the main Wwise folder.
|
Caution: The default installation folder for Wwise is "<ProgramFiles>\Audiokinetic\Wwise <VERSION> <BUILD>", but Wwise users may install elsewhere. If you create an installer for your plug-in, it should not assume that Wwise is installed in the default location. |
For an example of how to install plug-ins, refer to Plug-in Example.
Troubleshooting
If you run into any problems, refer to the Wwise Source and Effect Plug-in Troubleshooting Guide.
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