Wwise Version

Welcome to Wwise 2021.1.5

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.

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 separate parts to provide you with comprehensive and easy-to-find information about Wwise.

  • Part I, “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.

  • Part II, “Setting Up Your Projects” - Includes conceptual and procedural information on how to set up a project, either alone or within a Workgroup 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.

  • Part III, “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.

  • Part IV, “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.

  • Part V, “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.

  • Part VI, “Finishing Your Projects” - Includes information on how to create the final mix, troubleshoot and simulate different aspects of your project, and generate the SoundBanks and file packages for your game.

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

  • Part VIII, “Wwise Reference” - Provides complete information about all the options and views in Wwise, and is accessible through the contextual help.

  • Part IX, “Wwise Plug-ins” - Provides descriptions of each option for the various plug-ins that ship with Wwise.

  • Part X, “Wwise Tools” - Provides information about the various tools that ship with Wwise, including the Multi-Channel Creator.

  • Part XI, “Appendix” - Provides supplementary reference information on Wwise downmix behavior, regular expression use, default keyboard shortcuts, and an overview of the Wwise documentation set.

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

Accessing Wwise Context-Sensitive Help

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

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

  • Press F1.

Wwise Help opens displaying information about the view or dialog box you are currently in.

Setting Wwise Documentation Preferences

Refer to Setting the Documentation Preferences for details on setting the documentation source (online or offline) and the documentation language.

Visual Identifiers

The following icons are used throughout this document to help you identify certain types of information:

[Note] Note

Notes are used to provide important additional information.

[Tip] Tip

Tips are useful bits of information, workarounds, and shortcuts that you may find helpful in a particular situation.

[Caution] Caution

Cautions are used when you can lose or damage information, such as deleting data or not being able to easily undo an action. Cautions always appear before you are about to do such a task.

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 may want to read the Wwise Fundamentals document to gain a better understanding of the key concepts and workflow of Wwise. After reviewing the Wwise Fundamentals document, you can then start reading the individual chapters in each part of the Help. These chapters provide conceptual and procedural information, examples, and tips and best practices for using Wwise.

Using Other Wwise Documents and Support

Wwise Help is only one component in our comprehensive set of materials and resources that are available to you. Consult Appendix D, Additional Resources for information about these other guides and resources.