Wwise Help

SoundBank Settings

Enable Auto-Defined SoundBanks

Configures whether Wwise automatically defines a SoundBank for individual objects. When set, Wwise might automatically define SoundBanks for some objects. See Auto-defined SoundBanks for details.

	Note
	SoundBanks automatically defined by Wwise for Events only include the Event and referenced Structures, and explicitly exclude media. Using such a SoundBank requires extra code within the game code. Refer to Understanding how SoundBanks are loaded in a game for more details.

Copy Loose/Streamed Media

Configures whether Wwise automatically copies media to the output folder during SoundBank generation. When enabled, Wwise:

	Note
	This option replaces CopyStreamedFiles.exe. Previously, the copying of media files was done via a post-build step using CopyStreamedFiles.exe. The application has been removed.

Create Sub-Folders for Generated Files

Configures whether sub-folders are created in output folders. When enabled, Wwise creates sub-folders for:

Files are placed in sub-folders using the ID of the associated item. The first two decimal digits of the ID are determined as follows:

Refer to SoundBank output folder layout for more details.

	Note
	Consider enabling this option if your project's output folder will be under source control. Some source control systems impose a fixed limit on the number of files per folder. This option evenly distributes the files amongst sub-folders.

Remove Unused Generated Files

If selected, unused generated files are removed from the output folder during SoundBank generation. Files removed include:

If selected, empty folders are also removed. Folders removed include:

	Note
	Consider selecting this option if your project's output folder will be under source control. Removed files will also be removed from source control.

Use Source Control for Generated Files

	Caution
	If this option is disabled, the status of generated files is not updated even if the files are under source control.

If selected, source control status is updated with changes (add, delete, or edit) to generated files during SoundBank generation. Files updated include:

	Note
	This option is valid only if Source control is configured. Refer to General Tab for more details.

Use SoundBank Names for Filenames

Determines whether SoundBank names or IDs are used to:

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, 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

Allow SoundBanks to Exceed Maximum Size

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

Metadata Files

Generate All Banks 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 the following files (XML and/or JSON):

Generate Per Bank Metadata Files

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.

This option also creates the following files (XML and/or JSON):

Files Types

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.

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.

Include in Metadata

Object GUID

Adds globally unique identifiers to referenced objects.

Object Path

Adds object paths to referenced objects.

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. Only Play and Post Event Actions can have a non-zero value.

Default value: true

Estimated duration

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: true

Root Output Path

The folder where global, platform agnostic generated files are saved. These file include:

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

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.

SoundBank Paths

Right-click the table header to open the Configure Columns dialog where you can specify which columns to display and their order. See Using tables.

Platform

The name of the platform associated with a specific path or location.

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 which allows you to specify a new folder where the SoundBanks for each platform will be saved.

Pre-Generation Step

Right-click the table header to open the Configure Columns dialog where you can specify which columns to display and their order. See Using tables.

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 which allows you to specify a new folder where the SoundBanks for each platform will be saved.

Post-Generation Step

Right-click the table header to open the Configure Columns dialog where you can specify which columns to display and their order. See Using tables.

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 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.

Closes the Project Settings dialog without saving the settings.