Wwise Unreal Integration Documentation

This tutorial explains how to use Unreal Blueprints to play music from an integrated Wwise project. A Blueprint is suitable for music, which might play for the entire duration of the game across different levels.

To prepare for this tutorial:

In Wwise Authoring, create a Music Playlist Container.
Add a Music Segment that loops indefinitely. The following image shows the Container configuration:
Create an Event that plays the Music Segment. This tutorial uses an example called Play_Music.
Generate SoundBanks in either Wwise or Unreal.
In the Unreal Editor, drag the music Event from the Wwise Picker into the Level Editor. Just as in Adding Ambient Sound to a Level, the Event is added and a uasset is created.
Select the Event and in the Details panel, select the Auto Post option.

Posting an Event

In this part of the tutorial, you will add sounds to the ThirdPersonExampleMap level. The level already contains various Actors such as Lights, Meshes, and a character.

注記： If you have multiple scenes, you can create a Persistent level so the music survives when a different map is loaded.

This tutorial uses the Blueprint of the playable character, which is available by default in the ThirdPersonCharacter content. To play, or "post", a Wwise Event, you have to do three things:

Call the Unreal Event when you begin to play.
Connect it to the function that plays the Wwise Event.
Specify which Actor plays the Event.

The following procedure explains this process in detail.

To post an event:

In the Content Browser, go to ThirdPerson > Blueprints and double-click BP_ThirdPersonCharacter. The BP_ThirdPersonCharacter Blueprint opens. The Event Graph tab contains three disabled nodes.
Drag a pin from the BeginPlay node, search for the Post Event Audiokinetic function and click it.

The Post Event function requires a reference to an Actor to place the Wwise Event.
Drag a pin from the Actor Object Reference, search for the Get a reference to self Variable and click it.
In the Post Event function, select the Play_Music Ak Event.
Click Compile and then in the Level Editor, click Play. The music plays.

Using AkComponents

The Blueprint environment is ideal for controlling Actor behavior. However, to efficiently manage and position Actors in levels, you can expose some Blueprint controls in the Details panel and work primarily in the Level Editor instead. To do this, you can add an AkComponent to the Actor, which you can then use to offset the position of the sound from the Level Editor.

To use an AkComponent:

In the Blueprint Editor, on the Components tab, click Add, then search for the Ak Audiokinetic component and click it.
In the Event Graph, delete the Post Event function and the reference to Self.
Drag the Ak component into the Blueprint, then drag a pin from the component, search for Post Ak Event and click it.
Connect BeginPlay to the Post Ak Event.

You can now retrieve the Wwise Event selected in the AkComponent.
Drag a pin from the AkEvent Object Reference, find and select a Get Ak Audio Event and connect it to the Ak component.
Click Compile.
In the Components panel, select Ak, then in the Details panel, expand the Ak Event section. It is currently empty.
Drag the music Event from the Wwise Picker into the empty Ak Audio Event area.

You can now change the Event without opening the Blueprint, and you can offset the position of the sound relative to the Actor to which it is attached.

Controlling Music with States

In most cases, you want interactive music in your game to adapt to gameplay conditions and provide variety. This tutorial demonstrates a common implementation strategy, which is to use States to control music.

Before you start, you must create a new music system in Wwise that consists of two distinct types of music: in this case, selection of calm music and a selection of intense music.

Create a Music Switch Container that can switch between "Repeat Calm" and "Repeat Intense" Music Playlists based on a “Music” State, as shown in the following image.

In the example, there are three States: Calm, Intense, and None. With this setup, you can set States from the game to change the music during runtime. You can also choose which State to set when the game starts.

A common approach, which this tutorial uses, is to set States when the player enters a certain area, defined by a Trigger. You create a Trigger Box and use a Blueprint system to set the State when the player crosses the boundaries of the box.

Ensure that you complete the steps in Using AkComponents before you proceed.

To control music with States:

In the Blueprint Editor, drag a SetState Audiokinetic function from BeginPlay.
将 Initial State 设为 Music-Calm。

The initial state is now set up.
将 Box Trigger 拖到 Level 中。
增大 Box Trigger 的尺寸。
In the Details view, click the button with the three boxes (1), then New Subclass (2), type a Blueprint name (3), and then click Select (4), as shown in the following image.

The Blueprint is created, and contains an ActorBeginOverlap Event, which you can use to detect when something enters the Trigger Box.
从 ActorBeginOverlap 向外拖动连线，接着赋值给 ThirdPersonCharacter，然后将 Exec 连到 Set State 函数。

To ensure that you can use the Trigger Box for multiple states, you must create a Variable that is accessible outside the Blueprint.
Drag from the State Value and click Promote to variable.

There is now a variable under My Blueprint > Variables on the left.
Rename the variable to “MusicState” and click the eye icon.

The variable is now public (accessible outside the Blueprint).
Click Compile, and close the Blueprint.
Select the Trigger, then in the Details view select a State under Default > Music State.
In the level, walk into the new Trigger with the ThirdPersonCharacter and wait for the music to change.

You can now duplicate the trigger, reuse it somewhere else and set a different state without affecting the original trigger.