IN THIS ARTICLE
Wwise Audio Engine Gem
The Wwise Audio Engine Gem provides support for using the Audiokinetic Wave Works Interactive Sound Engine (Wwise) in Open 3D Engine (O3DE) projects.
The Wwise Audio Engine Gem requires the Audio System Gem.
For more information, refer to Audio System Overview.
Enabling the Wwise Audio Engine Gem
To enable the Wwise Audio Engine Gem, do the following:
Use O3DE Project Manager or the command line to add the Wwise Audio Engine Gem to your project. Note that Wwise Audio Engine requires the Audio System Gem as a dependency.
Download the Wwise Launcher and use it to install the Wwise audio SDK version 2021.1.1.7601 or later. Make sure to select the SDK(C++) component during installation.Note:In general you can use more recent versions of Wwise than specified above, but some SDK updates will require code changes.
(Recommended) Set the CMake cache variable
LY_WWISE_INSTALL_PATHto the path where you installed Wwise. You can use
cmake-guito set this variable, or you can set it when you run the
cmakebuild configuration command. By using this cache variable, CMake project regeneration will automatically be triggered if the variable is updated in the future.
You can use the following CMake build configuration command to set
LY_WWISE_INSTALL_PATHfrom your project directory.
cmake configure -B build/<platform> -G "Visual Studio 16" -DLY_3RDPARTY_PATH=<o3de-packages> -DLY_WWISE_INSTALL_PATH=<wwise-installation>Note:Use
Visual Studio 16as the generator for Visual Studio 2019, and
Visual Studio 17for Visual Studio 2022. For a complete list of common generators for each supported platform, refer to Configuring projects.
Build your project using Project Manager, Visual Studio, or CMake.Important:Whenever updating the Wwise audio SDK to a newer version, if you have any existing O3DE projects that use the Wwise Audio Engine Gem, make sure to update
LY_WWISE_INSTALL_PATHwith the new path. Or, if you are relying on the
WWISEROOTenvironment variable that is set during Wwise installation, be sure to regenerate the Visual Studio project files using
cmakeif you want them to use the newer SDK.
When you build your project, CMake looks for your Wwise installation by checking for the existence of specific variables, in the following order:
LY_WWISE_INSTALL_PATHCMake cache variable.
WWISEROOTenvironment variable, which is set when installing Wwise.