Wwise Unity Integration Documentation
The Integration provides Wwise-specific components you can use directly on Unity Scene GameObjects. These components should cover most sound design scenarios. While the components are custom C# scripts, no coding is required to edit their public properties.
To add Wwise components to Unity GameObjects:
- Go to the Unity Inspector window (Ctrl+3) loaded with the GameObject selected in the scene.
- Click Add Component to prompt the Component list.
- Select Wwise to open its sublist and choose the desired Wwise Components.
Tip: Type "ak" in the component search field to more quickly access a list containing all the Wwise components.
You can add components to your game by dragging Wwise objects from the Wwise Picker to either the Inspector or onto game objects listed in the Hierarchy of your loaded scene.
The WwiseGlobal object is a GameObject that contains the Initializing and Terminating scripts for the Wwise Sound Engine. In the Editor workflow, it is added to every scene, so that it can be properly previewed in the Editor. In the game, only one instance is created, in the first scene, and it is persisted throughout the game. There are a few customizable options in the initializer script.
If you want to disable this behavior, use Edit > Project Settings > Wwise Editor and disable Create WwiseGlobal GameObject. It then becomes your responsability to add the initializer script on an object that will persist throughout the game.
In order for positioning to work, the Ak Audio Listener script needs to be attached to the main camera in every scene. By default the listener is added automatically to the main camera. If you want to disable this behavior, go to Edit > Project Settings > Wwise Editor and disable Automatically add Listener to Main Camera.
This integration also provides a few classes that can be used, with minimal code, for most remaining usage scenarios:
This type represents an auxiliary send in the Master-Mixer Hierarchy.
This type can be used to load/unload SoundBanks.
This type represents the values of the flags used when posting an Event with a callback.
This type can be used to post Events to the sound engine.
This type can be used to set game parameter values to the sound engine.
This type can be used to set Wwise States.
This type can be used to set Switch values on gameobjects.
This type can be used to post triggers to the sound engine.
This type represents an Acoustic Texture.
- See also
A native WAAPI client with a C# API allows you to connect to WAAPI from within Unity. It currently is available for Windows and macOS. The Wwise Authoring API sends messages via JSON objects. In Unity, the client was implemented using strings. You may use your preferred method to construct valid JSON strings to then give to the WAAPI client.
- See also
- WAAPI Utilities
There are four ways to add sounds to your game:
- Using the Wwise Picker. This is the simplest way to add a sound to an object. Drag an Event from the Wwise Picker window to an object in the Unity Viewer or the Inspector. This automatically creates an AkAmbient component on the target Game Object.
- Using the Add Component menu. Add an AkAmbient or an AkEvent component to any Unity Game Object.
Using Wwise Types. Call
AK.Wwise.Event.Post()at any time from a C# script.
Using scripts. Call
AkSoundEngine.PostEvent()at any time from a C# script.
For Unity's Timeline feature, there are custom Wwise tracks for triggering Wwise events and setting Wwise RTPC values.
- See also
The Unity integration includes a simple WAAPI client that can be used to interface with the Wwise Authoring tool.
- See also
Most Wwise SDK functions are available in Unity through the
AkSoundEngine class. Think of it as the replacement of C++ namespaces
AK::MusicEngine, and so on. See API Changes and Limitations for changes made in the API binding compared to the original SDK. For more complex situations, you'll need to call Wwise functions from code. In the API, the
GameObjectID in all functions is replaced by the Unity flavor of the GameObject. At runtime, an AkGameObj component is automatically added to this GameObject, unless you have already manually added it before.
The native Wwise API allows you to use strings or IDs to trigger events and other named objects in the Wwise project. You can still do this in the C# world by converting the file
Wwise_IDs.cs. Click Assets > Wwise > Convert Wwise SoundBank IDs. You need to have Python installed to make this work.
MIDI can be sent to Wwise by filling the
AkMIDIPost members of
AkMIDIPostArray class and calling any of the following methods:
The following is a basic script that sends MIDI messages to the sound engine:
The Unity integration exposes the offline rendering feature within the Wwise SDK and simplifies how audio samples can be retrieved.
Caution: Care must be taken to ensure that only the asynchronous
AkSoundEngine.StartDeviceCapture sets up a specific output audio device for capture so that the number of available samples can be determined by calling
AkSoundEngine.UpdateCaptureSampleCount and the audio samples can be retrieved by calling
The following example illustrates how to use the Unity integration to perform offline audio rendering in conjunction with Unity's screen capture functionality. With this functionality implemented, one can easily perform a multiplexing post-processing step to combine the captured audio samples and video frames into a movie.
The audio input source plug-in can be used via C# scripting. See Audio Input Source Plug-in from the Wwise SDK documentation.
The following is a basic script that sends a test tone to the audio input source plug-in:
By default, the
AkGameObj component is attached to a specific Unity
gameObject and uses its transform (with an optional offset) for full positioning. This is usually adequate for many games, such as first-person shooters. However, games with custom camera angles, such as many third-person games, may find it difficult to accommodate the two aspects of positioning (distance attenuation and spatialization) by simply attaching the audio listener to one game object, such as the main camera in Unity. Other games may want players to experience other custom positioning.
To this end, the
AkGameObj component class provides overridable positioning to Unity users. Through the three virtual methods
GetUpward(), users can derive a subclass from
AkGameObj and use that subclass component to customize any number of Unity
Here is a simple example of how to use a custom component to override the default
AkAudioListener behavior. With a third-person project integrated with Wwise, remove the existing
AkAudioListener and its associated
AkGameObj. Then attach the following script to the MainCamera object, attach
AkAudioListener, and finally specify the target Unity
gameObject (such as the player avatar) that the audio listener's position will follow. After this, the distance attenuation of all the emitters will rely on the selected target Unity
gameObject's position as the listener position (an on-screen distance listener), while the orientation of all the emitters is still based on the main camera orientation as the listener orientation (an off-screen orientation listener).