Version
menu_open

SoundBank Manager

The SoundBank Manager displays the list of SoundBanks that have been created for your project. It also displays information about each SoundBank, including its current size, the amount of free space left, and the type or contents of the SoundBank. Before generating your SoundBanks, you can define custom user settings and specify for which platforms and languages the SoundBanks will be generated.

When you double-click a SoundBank in the SoundBank Manager, information relating to the selected SoundBank is automatically displayed in the SoundBank Editor.

Interface Element

Description

Opens a search field where standard alphanumeric entries filter out unmatching elements from the view. Learn more in Using Tables.

Click the Close icon to the left of the search icon to close the search field and remove the filter.

[Note] Note

The searches do not include elements in collapsed nodes of the List View, Query Editor, MIDI Keymap Editor, and Reference View.

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.

Changes the way SoundBanks are displayed in the SoundBank Manager. You can choose either of the following options:

  • Tree list: Displays SoundBanks hierarchically, with Work Units and Folders.

  • Flat list: Displays SoundBanks in a simple list.

Opens the New SoundBank dialog box where you can name the new SoundBank that you want to create and specify which Work Unit to place it in.

Opens the SoundBank User Settings dialog box where you create custom user settings by overriding those defined at the project level.

The project SoundBank settings are defined in the Project Settings dialog box.

Prompts the Generating SoundBanks dialog and generates the selected SoundBanks and corresponding files for the selected platforms and languages, all according to the settings specified. SoundBanks that are up to date—no changes since the last time they were generated—are not regenerated.

Prompts the Generating SoundBanks dialog and generates all SoundBanks and corresponding files for all platforms and languages, whether or not they are selected, all according to the settings specified. SoundBanks that are up to date - no changes since the last time they were generated—are not regenerated.

Displays the SoundBank Generation Log, which contains information about issues or potential issues that were found during the generation process.

 

SoundBanks

The name of the SoundBank.

When displaying SoundBanks in the Tree list mode, this column displays the hierarchy of Work Units, Folders, and SoundBanks. When selecting the check box for a Work Unit or Folder, all children are also selected. When deselecting it, all children are also deselected.

The name will appear in red if there are any issues with the SoundBank. Such issues could be either of the following:

  • The current value of the Data Size exceeds the maximum memory allowed in Max Size.

  • The SoundBank does not include sources for all the specified language versions of its Sound Voices.

    [Note] Note

    If Use reference language as stand-in is selected in the Language Manager, then the missing language voices will be output in the reference language; however, the SoundBank name will still be red.

Only the SoundBanks whose check boxes are selected will be generated.

Data Size

The amount of in-game memory that the SoundBank would use for the currently selected platform.

[Note] Note

If your SoundBank contains Sound Voices, the Data Size column will also be updated according to the currently selected language.

The Data Size value will be red if it exceeds the maximum. The displayed size is the value as of the last generation of the SoundBank; it does not update until the SoundBank is successfully regenerated.

Units: Bytes

Decoded Size

The amount of in-game memory that a SoundBank with decoded Vorbis or Opus media would use for the currently selected platform. If the SoundBank has no Vorbis or Opus media files, then this value will be same as the Data Size.

[Note] Note

If your SoundBank contains Sound Voices, then - like the Data Size column - the Decoded Size column will also be updated according to the currently selected language.

Units: Bytes

Maximum

The maximum amount of in-game memory that you want to allocate for a particular SoundBank.

This value can be unlinked so that the maximum size can be different for each platform.

You can successfully generate a SoundBank even though it exceeds the maximum memory that you allocated.

A value of 0 means there is no limit on the size of this SoundBank. In this case the control displays “Infinite” instead of “0”.

Default value: 0
Range: 0 to 2147483647
Units: B

Free Space

The amount of space remaining in the SoundBank. Free space is calculated by subtracting the Data Size from the Max Size. If the Data Size exceeds the Max Size, the Free Space value will be displayed in red.

Units: Bytes

Type

Displays the type of objects that are included in the corresponding SoundBank, for example, SFX, Voice, and Music. If the SoundBank contains all four types of objects, the word “All” is displayed in this column.

The text in this column will appear in red if the SoundBank contains Voice content with any other type. This simply warns you that data will be unnecessarily duplicated for each language generated.

Date Updated

The date and time the SoundBank was last updated.

Selects all SoundBanks in the list.

Clears the check boxes for all SoundBanks in the list.

 

Platforms

A list of platforms that are available and active in the current project.

SoundBanks will be generated for the platforms whose check boxes are selected.

Only platforms licensed for the current project will be available in the list. For more information about getting licenses for all platforms, refer to the Troubleshooting section of the Wwise Installation and Migration guide.

Opens a search field where standard alphanumeric entries filter out unmatching elements from the view. Learn more in Using Tables.

Click the Close icon to the left of the search icon to close the search field and remove the filter.

[Note] Note

The searches do not include elements in collapsed nodes of the List View, Query Editor, MIDI Keymap Editor, and Reference View.

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.

Selects all platforms in the list.

Clears the check boxes for all platforms in the list.

 

Languages

A list of languages used in the current project.

SoundBanks will be generated for the languages whose check boxes are selected.

Opens a search field where standard alphanumeric entries filter out unmatching elements from the view. Learn more in Using Tables.

Click the Close icon to the left of the search icon to close the search field and remove the filter.

[Note] Note

The searches do not include elements in collapsed nodes of the List View, Query Editor, MIDI Keymap Editor, and Reference View.

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.

Selects all languages in the list.

Clears the check boxes for all languages in the list.


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