Version
menu

Wwise Unity Integration Documentation
Wwise Browser

The Wwise Browser window shows the available objects (such as Events and Switches) from your Wwise project, using the same structure. The project displayed in the Wwise Browser view is based on the Generated SoundBanks and your Wwwise Project. Normally, this project is specified when the Wwise plug-in was installed in Unity.

Wwise Browser Columns

The Wwise Browser is separated into two columns, which are described in the following sections.

The Name column recreates the hierarchy of the project as it exists in the SoundBanks and displays the name of the Wwise Items. It prioritises the name found in the Generated SoundBanks over the name in Wwise if the names are different.

Status Column

The Status Column compares the Wwise Project to the Generated SoundBanks and provides information about the differences between the two. For this column to work properly, the Wwise Browser must be connected to WAAPI.

  • New in Wwise: The Wwise Project has the information but the SoundBanks do not. Generating the SoundBanks creates the item in the SoundBanks and changes this column to SoundBank Up to Date.
  • Deleted in Wwise: The SoundBanks have the item information but Wwise does not. Generating the SoundBanks removes the item from the Wwise Browser or, if a UAsset of the item exists, changes the column to Not in Wwise or SoundBank.
  • Renamed in Wwise: The Wwise Project and the SoundBanks have the same item but with different names. Generating the SoundBanks renames the item inside the SoundBanks to match the name in Wwise.
  • SoundBank needs Update: The item in Wwise and the SoundBanks do not have the same ID.
  • Moved in Wwise: The item exists in both Wwise and the SoundBank, but in a different location in each. Generating the SoundBanks moves the item to the same location it is in Wwise and changes this column to SoundBank Up to Date. Items with this label are shown where they are according to the SoundBanks in the Wwise Browser.
  • SoundBank Up to Date: The name and ID of the item are the same in the Wwise Project and in the SoundBanks.

Adding Audio to your Scenes with the Browser

To add any object from the Wwise Browser to your scene, drag the object onto an existing Game Object or into the Inspector window. Refer to each component's documentation for further details about the components:

  • Dragging and dropping an Event creates an AkAmbient.
  • Dragging and dropping a SoundBank creates an AkBank.
  • Dragging and dropping a Switch Value creates an AkSwitch.
  • Dragging and dropping a State Value creates an AkState.
  • Dragging and dropping an Aux Bus creates an AkEnvironment.

Search and Navigation

To find a specific item, type the name in the filter box near the top of the Wwise Browser. The items in the list are filtered to match the text.

You can filter Wwise objects to reduce the number of objects displayed in the Browser. There are two categories of filtering: SoundBank Status and Types. The SoundBank Status filters on the “Status” column and Types filters on the Wwise item type. When you select a filter, all Wwise objects that do not satisfy the condition are filtered out of the Wwise Browser.

You can expand and close items by clicking on the + and - buttons or by double-clicking the item's name. You can also select and expand items by using the keyboard's arrow keys.

You might need to expand some items if the one you're looking for has a closed parent.

Generating SoundBanks

Click Generate SoundBanks to generate all SoundBanks for all platforms and languages. The generated SoundBanks will appear under the Wwise Browser's SoundBanks folder, the same as if they were generated from within Wwise. Additionally, the Unity status bar will display one of the following messages:

  • WwiseUnity: SoundBanks generation successful, if there were no errors or warnings;
  • WwiseUnity: SoundBanks generation has warning(s) , if there were warnings ;
  • WwiseUnity: SoundBanks generation error, if there were errors. Click on the message to move focus to the Console tab, which displays information from the SoundBank generation process.

Finding References in Scenes

You can use the Wwise Browser to find all GameObjects that contain references to a specified Wwise object.

To find references to a Wwise object in a scene:

Do one of the following: Right-click the object and select the option to find references. Select the object and press Shift+R

A custom search appears in the Hierarchy window, which lists GameObjects that contain a reference to the Wwise object.

WAAPI Features

When connected to the Wwise Authoring, modifications to the Wwise project are immediately reflected in the Browser window. If you copy, rename, delete, or move an object in the Wwise Project Explorer, the contents of the Browser window will be updated. There are also many additional features available when right clicking items in the Browser window:

Synchronized Selection

The Autosync selection option under the Wwise Integration in the Project Settings lets you decide whether you want your selection to be synchronized across Unity and Wwise authoring. This can help ease the transition between programs as the last selected item will be the same.

Event Playback

To audition an event, right-click it in the Wwise Browser and click Play/Stop.

If multiple events are playing, you can right-click any item in the Browser and select Stop All.

Open Containing Folder

The Open Containing Folder option in the shortcut menu opens the folder that contains the Wwise object's Work Unit in the file explorer.

Refreshing the Project

In Wwise Authoring mode, clicking the Refresh button will clear the browser window refetch the project contents using WAAPI.

Connection Status

Connection status and any error messages resulting from unsuccessful WAAPI request will be displayed in the upper-right corner of the Wwise Browser Window.

For more information on setting up WAAPI for your project, refer to the WAAPI Utilities page. If WAAPI is enabled but the Unity project is not able to successfully open the websocket connnection, a specific error message will be displayed in the Wwise Browser window.

Connection error messages:

  • Connection refused
    • Caused by the project not being open.
    • Caused by the wrong port/IP address being specified in the Unity or Wwise WAAPI settings.
    • Caused by WAAPI being disabled in the Wwise Authoring User preferences
  • The wrong project is open in Wwise
    • Make sure you have opened the correct project
  • No project is open in Wwise yet
    • Make sure you have opened the project

Other error messages:

  • Cannot execute call because Wwise has an exclusive lock
    • Caused by a modal or settings window being open in Wwise Authoring.

After each failed connection, the Unity integration will attempt to reconnect after 2^N seconds, where N is the amount of failed connection attempts. This wait time will never exceed 32 seconds.


Cette page a-t-elle été utile ?

Besoin d'aide ?

Des questions ? Des problèmes ? Besoin de plus d'informations ? Contactez-nous, nous pouvons vous aider !

Visitez notre page d'Aide

Décrivez-nous de votre projet. Nous sommes là pour vous aider.

Enregistrez votre projet et nous vous aiderons à démarrer sans aucune obligation !

Partir du bon pied avec Wwise