This documentation is for a prerelease version of O3DE. Click here to switch to the latest release, or select a version from the dropdown.

Version:

Icon of a magnifying glass.
  Edit on GitHub

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:

  1. 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.

  2. 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.

  3. (Recommended) Set the CMake cache variable LY_WWISE_INSTALL_PATH to the path where you installed Wwise. You can use cmake-gui to set this variable, or you can set it when you run the cmake build 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_PATH from 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 16 as the generator for Visual Studio 2019, and Visual Studio 17 for Visual Studio 2022. For a complete list of common generators for each supported platform, refer to Configuring projects.

  4. 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_PATH with the new path. Or, if you are relying on the WWISEROOT environment variable that is set during Wwise installation, be sure to regenerate the Visual Studio project files using cmake if 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:

  1. The LY_WWISE_INSTALL_PATH CMake cache variable.

  2. The WWISEROOT environment variable, which is set when installing Wwise.