Integrating Plug-ins in the Authoring Tool
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.
Installation
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.
Installation on Windows
To install a plug-in:
- 32-bit application: Copy the DLL and XML files to the
Authoring\Win32\Release\bin\pluginsfolder in the main Wwise folder. - 64-bit application: Copy the DLL and XML files to the
Authoring\x64\Release\bin\pluginsfolder 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.
Installation on macOS
On macOS, the Wwise authoring tool runs only in 64 bits. Therefore, you must deploy 64-bit DLLs when installing plug-ins.
- Right-click on your Wwise.app and select Show Package Content.
- Copy the DLL and XML files to the
/Contents/SharedSupport/Wwise2017/support/wwise/drive_c/Program Files/Audiokinetic/Wwise/Authoring/x64/Release/bin/pluginsfolder.
Furthermore, because the Mac version of Wwise runs through Codeweavers CrossOver, XML and DLL files must be indexed. Codeweavers CrossOver keeps a Windows file hierarchy list. If the XML and DLL files are not included in this list, they'll never be discovered by the application.
To add new files to the Codeweavers CrossOver list, follow these instructions:
- Open a Terminal.
- Go to the Wwise.app you want to update. For example,
cd /Applications/Audiokinetic/WWISE_VERSION/Wwise.app/Contents/SharedSupport/Wwise2017. - Launch the command to update the file entitled files (this command is on a single line):
CX_ROOT=/Applications/Audiokinetic/WWISE_VERSION/Wwise.app/Contents/SharedSupport/Wwise2017 WINEPREFIX=/Applications/Audiokinetic/WWISEVERSION/Wwise.app/Contents/SharedSupport/Wwise2017/support/wwise ./bin/wineprefixcreate --snapshot.
Of course, if you are writing a plug-in for public distribution, these steps should be part of your installer to be transparent to the end-user.
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