Wwise plugin Game Engine Integration

Resonance Audio Game Engine Integration

This guide shows you how to integrate the Resonance Audio plugins for Wwise into your projects.

If you are new to the Resonance Audio plugins for Wwise, see Getting Started with the Resonance Audio Plugin for Wwise.

About the Resonance Audio Wwise integration

The Resonance Audio Wwise integration incldues plugins for spatial audio on the following platforms.

Desktop

  • MacOS
  • Windows
  • Linux

Mobile

  • Android
  • iOS

The Resonance Audio plugins follow the standard Wwise plugin integration process.

Room effects game engine integration

The Resonance Audio Room Effects plugin uses the plugin custom game data structure in the Wwise SDK to set room properties in the environment.

Note: If room properties are not configured, the room effects bus outputs silence.

If you are using the Resonance Audio Room Effects Plugin, make sure to set room properties using the AK::SoundEngine::SendPluginCustomGameData method in your project’s game engine integration. Resonance Audio provides reference scripts for you to check how this function can be used in Unity.

For more information, see Room effects in Unity in this guide.

Unity integration

Software requirements

You’ll need Unity 5.6 or later to use the Resonance Audio plugin package.

Load the Resonance Audio plugins

Use the provided dynamic libraries to set up the Wwise integration with Resonance Audio plugins. Using the dynamic libraries lets you avoid having to recompile any code during installation.

  1. Download and install the Wwise Unity plugin. Follow the Wwise Unity Integration guide.

  2. Set up your Unity project and link it to your Wwise project.

  3. Close the Unity Editor.

  4. Copy the Resonance Audio plugin dynamic libraries for each platform into the corresponding DSP folders in the Wwise integration.
  5. You can now access the plugins within Unity. See the following instructions for including the room effects in Unity using the provided scripts.

Caution: Make sure to copy the GeneratedSoundbanks folder from your Wwise project into the StreamingAssets folder in your Unity project so that Wwise Unity integration works as expected on deployed platforms.

Room effects in Unity

The Resonance Audio plugin package includes an example wrapper implementation of room detection and multiple room management scripts for the Unity integration. You can find the corresponding scripts in the UnityIntegration folder.

The UnityIntegration folder also includes the WwiseResonanceAudioRoom wrapper script. This script encapsulates an audio room component that you can attach to any game object in your Unity scene.

The WwiseResonanceAudioRoom component is based on the ResonanceAudioRoom component in the Resonance Audio SDK for Unity package.

To use the included audio room component:

  1. Add the ResonanceAudio folder into the Assets folder of your Unity project.

  2. Attach the WwiseResonanceAudioRoom component to a GameObject in your scene.

  3. Adjust the WwiseResonanceAudioRoom properties as needed. Make sure that the audio listener and the audio sources are inside the room boundaries in order for room effects to work.

  4. In the Unity Inspector window, make sure that your Room Effects Bus Name field matches the name of the Audio Bus in your Wwise project where you attached the Resonance Audio Room Effects plugin. Typically, this is the Room Effects Bus. Update the Name field if it does not match.

    This step is required only once per scene. Additional WwiseResonanceAudioRoom components added to the scene are updated automatically with the corresponding plugin name.

See “Room Effects in Unity” in the Unity Developer Guide for more details on working with audio rooms in your Unity scenes.

Unreal integration

Software requirements

To use the Resonance Audio plugin package, you’ll need:

  • Unreal Engine version 4.16 or later
  • Wwise 2017.1.0 build 6302 or later

Load the Resonance Audio plugins

Use the provided static libraries to recompile the Wwise integration code with the Resonance Audio plugins. The Wwise integration for Unreal does not currently support using dynamic libraries to load plugins.

  1. Download and install the Wwise Unreal plugin. Follow the Wwise Unreal Integration guide.

  2. Add the Resonance Audio plugin static runtime libraries to your project:

    • In AkAudioDevice.cpp add #include <AK/Plugin/ResonanceAudioFXFactory.h>
    • In AkAudio.Build.cs add AddWwiseLib(Target, "ResonanceAudioFX");

  3. Rebuild the integration code to complete plugin registration.