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.

Welcome to Wwise 2023.1.8

Built to address the specific needs of the game development pipeline, Wwise is a unique solution for designers, composers, and programmers. By allowing you to develop game audio, music, and motion concurrently with game visuals, Wwise facilitates the design and authoring of sophisticated audio and motion during every phase of game development.

For a list of changes in this version of Wwise, refer to the Release Notes found in the SDK documentation.

About Wwise Help

Wwise Help is a context-sensitive help system that contains both reference topics describing each view, field, and option in Wwise, and task-based information. The documentation is divided into the following main sections to provide you with comprehensive and easy-to-find information about Wwise.

  • Getting started - Includes an introduction to many of the concepts in Wwise, information to get you up and running with Wwise quickly, and some helpful information on organizing your workspace and working efficiently with Wwise.

  • Setting up your projects - Includes conceptual and procedural information on how to set up a project, either alone or in a team environment, how to define or adjust platforms for your project, how to deal with the assets in your project, and how to build and get the most out of the Wwise hierarchy of assets.

  • Interacting with the game - Includes conceptual and procedural information on how to use events, dynamic sequences, and Wwise game syncs to drive the sounds in your game.

  • Using sounds and motion to enhance gameplay - Includes conceptual and procedural information on how to enhance the rich and immersive game environments using a variety of properties and behaviors, effects, motion, positioning settings, and playback priority.

  • Creating interactive music - Includes an overview and introduction to the Interactive Music concepts in Wwise, along with extensive procedural information on how to create interactive music for your game.

  • Finishing your projects - Includes information on how to create the final mix, troubleshoot and simulate different aspects of your project, generate the SoundBanks and file packages for your game, and Wwise downmix behavior.

  • Working with Wwise - Describes the functionality of specific Wwise views to help you get up and running quickly with the software.

  • Reference topics - Provides complete information about all the options and views in Wwise, and is accessible from within Wwise in the form of context-sensitive reference pages.

  • Wwise plug-ins - Provides descriptions of each option for the various plug-ins that ship with Wwise.

  • Wwise tools - Provides information about the various tools that ship with Wwise, including the Multi-Channel Creator.

  • Additional resources - Provides an overview of the Wwise documentation set and various learning materials.

  • Glossary - Provides an alphabetical list of Wwise and audio-related terms with corresponding definitions.

Accessing Wwise context-sensitive reference topics

When you are looking for information about a specific option or view in Wwise, open the corresponding reference topic from that view by doing either of the following:

  • Click the Help button in the upper-right corner of any view or dialog.

  • Press F1.

A reference topic opens, displaying information about the view or dialog you are currently in.

Accessing the Contextual Help view

In addition to the context-senstitive reference topics mentioned previously, the Contextual Help view provides information within Wwise itself about selected properties as well as error messages from the Capture Log. Refer to Contextual Help for more information.

Setting Wwise documentation preferences

Refer to Setting the documentation preferences for details on setting the source of the context-sensitive reference topics (online or offline) and the language of the documentation (reference topics, Contextual Help view, and the Wwise SDK documentation).

Keyboard and mouse conventions

The following table shows the terms used throughout this document relating to the mouse and keyboard. Wwise takes advantage of the left, center, and right mouse buttons. Unless otherwise stated, use the left mouse button.

This term

Means this with a mouse

Click

Quickly press and release the left mouse button. Always use the left mouse button unless otherwise stated.

Right-click

Quickly press and release the right mouse button.

Double-click

Click the left mouse button twice rapidly.

Shift+click, Ctrl+click, Alt+click

Hold down the Shift, Ctrl, or Alt key as you click a mouse button.

Drag

Hold down the left mouse button while you move the mouse. This is equivalent to drag and drop.

Alt+key, Ctrl+key, Shift+key

Hold down the first key while you press the second key. For example, “Press Ctrl+Z” means to hold down the Ctrl key while you press the Z key.

Before you begin

Before working with Wwise, you might want to read Wwise Fundamentals to gain a better understanding of the key concepts and workflow of Wwise. Then you can start reading the individual sections in Wwise Help. These sections provide conceptual and procedural information, examples, and tips and best practices for using Wwise.


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