The SoundBank Manager displays the 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 related to the selected SoundBank is automatically displayed in the SoundBank Editor.
The SoundBank Manager displays two lists of SoundBanks:
User-Defined SoundBanks: This list, in the upper pane, contains all SoundBanks created by editing the project. These SoundBanks are created and fully defined by the user, either by manually creating the SoundBanks individually, or importing a definition file. Refer to Creating User-Defined SoundBanks Manually for more details.
Auto-Defined SoundBanks: This list, in the lower pane, contains all objects for which Wwise can automatically create a SoundBank. For each object, the list details whether a SoundBank was automatically created. If a SoundBank is not created, additional columns provide the information required to determine why. Refer to Automatically Defining SoundBanks for more details.
![[Note]](/images/2022.1.17_8543/?source=Help&id=note.png) | Note |
|---|---|
Both SoundBank lists add and remove rows dynamically as the project is edited. However, the information presented in each row:
|
|
Interface Element |
Description | |||
|---|---|---|---|---|
|
Show Hierarchy |
Changes the way items are displayed in the SoundBank lists. If selected, items are displayed hierarchically, with Work Units, Folders, and other objects. If unselected, items are displayed in a simple list. | |||
  |
Display options affecting the content of the Auto-Defined SoundBanks list:
If any options in the list are deselected, the display options button is displayed in orange.
| |||
|
[Platform] |
Displays the current active platform for which SoundBank information is shown. To change the active platform, refer to Switching to a Different Platform. | |||
|
[Language] |
Displays the current active language for which SoundBank information is shown. To change the active language, refer to Switching to a Different Language Version. | |||
 | Opens the New SoundBank dialog. There you can create and name a new SoundBank in a specific Work Unit. | |||
 |
Displays the SoundBank Generation Log, which contains information about issues or potential issues that were found during the generation process. The button displays the number of severe SoundBank Generation Log entries. | |||
 |
Opens the Generating SoundBanks dialog and generates the selected SoundBanks and corresponding files for the selected platforms and languages, all according to the settings specified. If no changes were made since the last time the SoundBanks were generated, then the SoundBanks are not regenerated. | |||
 |
Opens 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. If no changes were made since the last time the SoundBanks were generated, then the SoundBanks are not regenerated. | |||
  |
SoundBank Settings:
| |||
|
User-Defined SoundBanks | ||||
|
User-Defined SoundBanks |
The first column of the list of user-defined SoundBanks. The column contains the name of user-defined SoundBanks. Refer to Working with User-Defined SoundBanks for more information. When displaying SoundBanks with Show Hierarchy enabled, 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 appears in red if there are any issues with the SoundBank. Such issues could be either of the following:
Only SoundBanks with their check box selected are generated. If Enable Auto-Defined SoundBanks is selected in the Project Settings, you will not have the option to select individual SoundBanks. This is because Wwise automatically defines SoundBanks for Events not included in any user-defined SoundBank. Generating all SoundBanks at the same time ensures this can be accurately assessed. Refer to Automatically Defining SoundBanks for more information on this SoundBank management strategy. | |||
|
ID |
The ID used to identify the SoundBank when calling SDK functions. Note, the ID is obtained using the SDK function AK::SoundEngine::GetIDFromString. Generated metadata files also contain the SoundBank's ID. See SoundBanks Tab for details. | |||
|
On Disk |
Displays whether a SoundBank file exists for the row entry. If a file exists then the column contains the SoundBank file (.bnk) icon. Otherwise the column is empty. The information in this column is updated after each SoundBank generation. If source control is enabled and configured for generated files, then the icon indicates the source control status of the file. | |||
|
Data Size |
The amount of in-game memory that the SoundBank would use for the currently selected platform. If your SoundBank contains Sound Voices, the Data Size column are also updated according to the currently selected language. The Data Size value is 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. If your SoundBank contains Sound Voices, the Decoded Size column will also be updated according to the currently selected language. Units: Bytes | |||
|
Max Size |
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: Bytes | |||
|
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 is 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 is displayed 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. | |||
  |
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.
| |||
 |
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. | |||
|
Auto-Defined SoundBanks | ||||
|
Auto-Defined SoundBanks |
The first column of the Auto-Defined SoundBanks list. The column contains the name of the objects for which Wwise may auto-define a SoundBank. This column contains:
When displaying SoundBanks with Show Hierarchy enabled, this column displays the object for which the SoundBank was automatically defined and its hierarchy, as seen in the Project Explorer view. | |||
|
ID |
The ID used to identify the SoundBank when calling SDK functions. Note, the ID is obtained using the SDK function AK::SoundEngine::GetIDFromString Generated metadata files also contain the SoundBank's ID. See SoundBanks Tab for more details. | |||
|
On Disk |
Displays whether a SoundBank file exists for the row entry. If a file exists then the column contains the SoundBank file (.bnk) icon. Otherwise the column is empty. The information in this column is updated after each SoundBank generation. If source control is enabled and configured for generated files, then the icon indicates the source control status of the file. | |||
|
Inc |
Displays whether the object's Inclusion property is set, if applicable. An object that has the Inclusion property must have the property set to have an automatically defined SoundBank.
| |||
|
In User-Defined |
Displays which user-defined SoundBanks contain the object, if applicable. This might determine if the object has an automatically defined SoundBank, depending on the project configuration. Refer to Working with User-Defined SoundBanks for more information.
| |||
|
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 is displayed 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. | |||
|
|
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.
| |||
|
|
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. | |||
|
Platforms | ||||
|
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 are available in the list. For more information about getting licenses for all platforms, refer to the Troubleshooting section of the Audiokinetic Launcher documentation. | |||
|
|
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.
| |||
|
|
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. | |||
|
Languages | ||||
|
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.
| |||
|
|
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. | |||
Related Topics
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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