Version

menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise Unreal Integration Documentation
Preparing for the Tutorials

These tutorials require the default installations of Wwise and Unreal 5. Although there are no tutorial-specific supplementary materials available, the Integration Demo Wwise sample project contains a variety of sounds and music that you can use for most of the examples. The Integration Demo is included with the Wwise SDK, which you can add to your installation through the Audiokinetic Launcher. For details, see Integration Demo Sample.

Prerequisites

Before you begin the tutorials, review the following prerequisites and ensure that all necessary setup is complete:

  • In Unreal, create a project with the Third Person game template, with a C++ Project Default. The Wwise Unreal Integration does not support Blueprint-only projects because the Wwise Integration plug-in is fully written in C++ and must be compiled. If you accidentally created a Blueprint-only project or are using an existing Blueprint-only project, you can convert it to a C++ project by adding a C++ class to it. For more information on Unreal projects, see Creating a New Project and Third Person Template.
  • Install the Wwise Unreal plug-in as described in Installation and Building the plug-in.
  • Enable Auto-Defined SoundBanks in your Wwise project. See Automatically Defining SoundBanks for more information.

Required Unreal Knowledge

Before you begin to integrate audio in Unreal, we strongly recommend that you have a working knowledge of Unreal 5 game development. Review the following sections in the Unreal documentation in particular:

  • Level Editor: The Level Editor is the initial layout that appears when you open Unreal. You use it to manage your assets: place sounds in the level, create new sounds, and so on. It is also the view from which you open other views, such as the Blueprint Editor.
  • Actors and Geometry, Components, and Blueprints Visual Scripting Overview: In Unreal, every object in your level is an Actor. There are different types of Actor, and Actors can have components that define what they do. For example, an Actor can have a Mesh that you can use as a Trigger to define areas in which a certain ambience plays. You can use Blueprints to design systems, and add them to Actors as well. Within these systems, you can reference your Actor’s components so that, for example, an ambience starts to play when something enters your Trigger area.
Tip:
When you generate SoundBanks, a notification appears and plays a sound. Depending on the level of your own sound integration, the sound might be quite loud, but you can disable it. To do so, go to Edit > Editor Preferences. Under Level Editor, click Miscellaneous and clear Enable Editor Sounds.

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise