Table of Contents

SoundBanks Tab

In the SoundBanks tab of the Project Settings dialog box, you can define the settings for your SoundBanks. For example, you can specify whether to generate content and header files with your SoundBanks, whether SoundBank names can be used, and the location where your SoundBanks will be saved. Within this tab, you can also specify pre-defined or custom steps that will be performed before and/or after the SoundBanks are generated.

These settings will be applied to all SoundBanks that are generated for this project. Although these settings are defined at the project level, each user can create custom SoundBank settings by overriding the project settings in the SoundBank User Settings dialog box.

Interface Element

Description

SoundBank Settings

Allow SoundBanks to exceed maximum size

Determines whether SoundBanks that exceed the maximum size will be generated or not.

Use SoundBank names

Determines whether SoundBank names or IDs are used to:

Name the generated SoundBank files (for example “Init.bnk” or “1355168291.bnk”)

Identify the target when one SoundBank refers to media in another SoundBank.

Depending on the Low-Level I/O implementation used in your game, this option may affect how AK::SoundBank::LoadBank() can be called. For more information, please refer to Using SoundBank Names in the Wwise SDK documentation (under Sound Engine Integration Walkthrough > Integrate Wwise Elements into Your Game > Integrating Banks > Integration Details - Banks > General Information).

Default value: true

Generate header file

Creates a header file that maps names to IDs. The header file maps Events, States, Switches, and Game Parameters.

The header file is saved in the header file path under the name “Wwise_IDs.h”.

If your programmers prefer to work with IDs in the code, you must generate the header file.

Default value: false

Generate Bank Content TXT Files

Creates files that list the contents of each SoundBank. The content files include information on Events, busses, States, and Switches, as well as a complete list of streamed and in memory media files.

The associated list specifies the text file type for SoundBank content files.

  • ANSI

  • Unicode

    [Tip] Tip

    If you have file paths or object names or notes that contain non-ANSI characters, you should use the Unicode format.

Generate Metadata File

Creates a single file for each specified type (XML and/or JSON), SoundbanksInfo.xml/SoundbanksInfo.json, which lists information for all generated SoundBanks. This file includes information on the SoundBank name, path, language, included Events and files (AMB, WAV, and WEM), as well as the specific details specified for the Metadata Options. This option also creates a PluginInfo file (XML and/or JSON), containing information on all the plug-ins used in the project.

[Note] You may get an "Invalid info file" SoundBank generation error

Wwise's default behavior for streamed files requires the SoundbanksInfo.xml for the post SoundBank generation step. You will get an error if the file cannot be found. Consequently, the Generate Metadata Files option should always be enabled. Additionally, you must enable the Generate XML Metadata option.

Generate Per Bank Metadata File

Creates files for each specified type (XML and/or JSON) and each individually generated SoundBank, listing their information. These files include information on the SoundBank name, path, language, included Events and files (AMB, WAV, and WEM), as well as the specific details specified for the Metadata Options.

Generate XML Metadata

If either of the Generate Metadata File options are enabled, then this specifies the creation of an XML version. This option is disabled if neither of the Generate Metadata File options are enabled.

As explained for the Generate Metadata File option, Wwise requires the SoundbanksInfo.xml file for streamed files. So, be sure to enable this option.

Generate JSON Metadata

If either of the Generate Metadata File options are enabled, then this specifies the creation of a JSON version. This option is disabled if neither of the Generate Metadata File options are enabled.

Metadata Options

Include GUID

Adds the Events' and SoundBanks' globally unique identifiers.

Max attenuation

Determines whether maximum attenuation information—see the Max distance property in the Attenuation Editor —is included in the metadata files for each Event. For non-Play Actions, expect this value to always be 0.

Default value: false

Attempts to determine the expected duration of each Event in a SoundBank. For each event, a DurationType, MinDuration, and MaxDurations attribute will be included

Attempts to determine the expected duration of each Event in a SoundBank. For each event, a DurationType, MinDuration, and MaxDurations attribute will be included in the soundbanksinfo.xml file. The DurationType may be one of: “OneShot”, “Infinite”, “Mixed” or “Unknown”. “OneShot” indicates a non-looping sound; “Infinite”, a looping sound; “Mixed”, a sound which may or may not loop infinitely (possibly based on random chance or a Switch), and “Unknown” indicates that Wwise was not able to determine the duration. The MinDuration and MaxDuration attributes attempt to place a lower and upper bound on the duration of an event. Note that these bounds are only an estimate and may or may not be accurate depending on runtime conditions.

Default value: false

 

Header file path:

The path or location where the SoundBank header file will be saved.

The path or location may be different depending on whether you are using the project location or a custom location for the current user.

Opens Windows Explorer or Mac Finder to allow you to change the default location where the SoundBank header file will be saved.

SoundBank Paths

Click the Configure Columns... shortcut (right-click) option from the column header band.

The Configure Columns Dialog opens. Specify which columns to display and their order.

Platform

The name of the platform associated with a specific path or location, such as Windows, Xbox One, Mac, iOS, Switch, and PlayStation 4.

SoundBank Folder

The path or specific folder where the SoundBanks will be saved.

The path or location may be different depending on whether you are using the project location or a custom location for the current user.

(Browse)

Opens the Browse For Folder dialog box which allows you to specify a new folder where the SoundBanks for each platform will be saved.

Pre-Generation Step

Click the Configure Columns... shortcut (right-click) option from the column header band.

The Configure Columns Dialog opens. Specify which columns to display and their order.

Platform

The name of the platform on which the custom step will be performed, such as Windows, Mac, iOS, and PlayStation 4.

The Global opening step is a non-platform specific step that is performed before any of the other steps.

Description

Specific information that describes the command line.

Click the description and then Press F2 to edit the description directly in the table.

Command Line

A form of command line shell that allows you to write commands that will perform custom jobs post SoundBank generation. The default command line copies the streamed files to the location where the SoundBanks are saved.

Click the command and then press F2 to edit the command line directly in the table. If you have multiple lines in your command, you will have to open the Post-Generation Step Editor to edit the additional command lines.

(Browse)

Opens the Browse For Folder dialog box which allows you to specify a new folder where the SoundBanks for each platform will be saved.

Post-Generation Step

Click the Configure Columns... shortcut (right-click) option from the column header band.

The Configure Columns Dialog opens. Specify which columns to display and their order.

Platform

The name of the platform on which the custom step will be performed, such as Windows, Mac, iOS, and PlayStation 4.

The Global opening step is a non-platform specific step that is performed before any of the other steps.

Description

Specific information that describes the command line.

Click the description and then Press F2 to edit the description directly in the table.

Command Line

A form of command line shell that allows you to write commands that will perform custom jobs post SoundBank generation. The default command line copies the streamed files to the location where the SoundBanks are saved.

Click the command and then press F2 to edit the command line directly in the table. If you have multiple lines in your command, you will have to open the Post-Generation Step Editor to edit the additional command lines.

(Browse)

Opens the Browse For Folder dialog box which allows you to specify a new folder where the SoundBanks for each platform will be saved.

 

Saves the project settings and closes the dialog box.

Closes the Project Settings dialog box without saving the settings.