Version

menu_open

SoundBank Editor - Edit Tab

The Edit tab of the SoundBank Editor displays every single project element that will be included in your SoundBank. This list is a breakdown of each element within the object hierarchies that were added to the Add tab. This breakdown allows you to fine-tune the contents of your SoundBank by excluding specific events, object structures, or media files.

More detailed information is displayed for the media files in the SoundBank, including sample rate, audio format, and file size. By having this additional information, you can easily tweak the Conversion Settings of each individual file to respect the constraints or limitations of a particular platform. To change the Conversion Settings of a media file, simply right-click the entry in the list and select Conversion Settings.

If you want to exclude a particular element from the SoundBank, simply clear the element's corresponding check box. You can sort the project elements alphabetically or in ascending/descending order by clicking any one of the column's title bars. You can also use the search or filters to help you find particular elements quickly.

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.

Name

The name of the SoundBank.

Notes

Any additional information about the SoundBank.

 

Search

Filters the project elements that appear in the list.

Type a name or part of a name in this text box to display only those elements that contain corresponding letters in their name.

Clears the contents of the Search field.

When the Search field is cleared, the entire list of project elements included in the SoundBank is displayed again.

(Language Filter)

Filters the list by language.

The language filter allows you to review the contents of each language's SoundBank.

(Object Filter)

Filters the list by object type.

You can filter the list using any of the following object types:

Events - To display only the Events that were added to the SoundBank.

Structures - To display only object structures that were added to the SoundBank.

Media - To display only the media files that were added to the SoundBank.

 

Include

Determines whether an individual event, object, or media file is included in the SoundBank.

To exclude a project element from the SoundBank, deselect its corresponding check box.

If you exclude a parent object, all corresponding child objects will be automatically excluded as well.

Object

A list of every object structure, event, and media file that is currently in the SoundBank.

Click the column title bar to sort the information alphabetically in either ascending or descending order.

Sample Rate

The sample rate of the audio file that will be included in the SoundBank.

The sample rate basically defines the number of times per second a digital audio signal is sampled, defined in Hertz (Hz). The sample rate range varies for each platform to a maximum of 48,000 Hz.

The sample rate information will appear in blue if the media file has not yet been converted for the current platform or in red if the original media file is missing from the project.

Format

The format of the audio file that will be included in the SoundBank, for example, PCM, Vorbis, or ADPCM. Refer to About Audio Formats for information on selecting the audio file format for your platform.

The format information will appear in blue if the media file has not yet been converted for the current platform or in red if the original media file is missing from the project.

Memory Size

The amount of a platform's memory that will be taken up by the converted media files when this SoundBank is loaded into memory.

Unit: Bytes

If a media file is streamed, the memory size will be zero.

Decoded Size

The amount of in-game memory that a SoundBank with decoded Opus or Vorbis media would use for the currently selected platform. If the SoundBank has no Opus or Vorbis 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

Prefetch Size

The amount of a platform's memory that will be taken up by the prefetch data associated with the streamed media file when this SoundBank is loaded into memory.

Prefetch data is loaded into memory to ensure that the streamed media file plays back without a delay.

Unit: Bytes

File Size

The total size of the converted media file.

This number may not represent the amount of data that will be included in the generated SoundBank, depending on whether the media file is streamed and its prefetch status.

Unit: Bytes

ID

The media file's unique 9-digit identification number.

 

Includes all events, objects, and media files in the SoundBank.


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