Table of Contents

Query Editor

The Query Editor is where you create and run queries. A query is basically a request to display a subset of information in your project. You can create very specific queries when looking for particular objects, or more general queries to find all sound objects in a particular platform, for example.

All project elements that match your query criteria are displayed in the Results list. When you select an entry in the Results list, it automatically gets loaded into the Transport Control and is ready for playback. You can right-click a selection of entries in the Results list to access a series of commands, such as Edit, Show in Multi Editor, Show in Schematic View, and Convert. You can double-click an entry in the Results list at any time to display it in the Property Editor. You can also drag project elements from the Results list to the Project Explorer. For example, you can drag one or more sound objects from the Results list into an Actor-Mixer or container within the Project Explorer.

It is possible to edit the properties of the objects in the list. You can choose which property or column to show by:

  • Right-clicking the list header and selecting Configure Columns; or
  • Clicking the View Settings button in the titlebar of the view.

[Tip] Tip

When multiple items are selected, modifying a property (slider, combo, or check box) will affect the whole selection and set the object's value to all other selected objects. However, when holding the Alt key and dragging a slider, the selected objects' values will be offset instead of being set to an absolute value.

[Tip] Tip

When the results of your search are displayed, you can select an entry to automatically load it into the Transport Control for immediate playback.

[Note] Note

When different types of objects appear in the list, it shows all the columns possible for those objects.


From the results list, you can click an object to display it in an already open view or double-click an object to open it into its corresponding view. You can also select one or more entries in the results list and then right-click to display the shortcut menu commands. Many of these, including Show in Multi Editor, Show in Schematic View, and Convert..., are common to a variety of objects. There are, however, a few specific to the search and query views:

[Tip] Tip

See Using Shortcut Menus for a description of common Wwise shortcut menu commands.

  • Refresh All Sizes: Refreshes all Preview Sizes in the results list.
  • Refresh Size: Refreshes only the Preview Sizes of the selected objects.
  • Remove From View: Removes the selected objects from the current search's results list.

Interface Element

Description

Click the View Settings icon in the upper right corner of the view.

The Object Property Settings dialog box opens. Select the individual properties for every possible Wwise object type that you wish to display.

Name

The name of the query.

Opens the selector menu, where you can create a new query or select an existing one.

Clears all criteria and search results from the Query Editor.

Notes

Any additional information used to describe the query.

Object type

The type of object or other project element for which you are searching, for example, sound, Bus, SoundBank, and so on.

Start From

The location in the project hierarchy where your query will begin.

Opens the Project Explorer - Browser dialog box where you can navigate to the location where you want your query to begin.

Resets the Start From Here location.

Platform

The platform or platforms that you want to include in your search.

Searches through the project for the objects and other project elements that meet your search criteria.

Criteria

Browser

A list of criteria on which you can base your query, such as Name or Output Bus.

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.

Criteria

A list of criteria you have selected for your query.

Operator

The logical operator used when your query contains multiple criteria. The following operators are available:

And for items that match all criteria.

Or for items that match at least one criteria.

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 and category of the criterion on which you are basing your search.

Condition

The specific details of the criterion on which you are basing your search.

For some criteria, you can use a wildcard operator, which is the asterisk (*) in Wwise, to replace part of a word when you are trying to find different project elements that contain, start with, or end with certain letters or numbers.

Results

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

The Object Property Settings dialog box opens. Select the individual properties for every possible Wwise object type that you wish to display as a column.

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.

Common Columns: If the following properties are selected in the Object Property Settings, they are always present as columns in the results area. Other columns display according to which types of objects are listed in the Results area.

Name

The name of the object or project element that matches your search criteria.

Path

The location in the project hierarchy of the object or project element.

Notes

Defines the notes or comments specified for the object or project element.

Type

The type of object or project element included in your results. For example: sound, bus, SoundBank, Query, Effect, and so on.

Default value: All Objects

Controls the Mute and Solo states for the object and shows the implicit mute and solo states for the object.

Muting an object silences this object for the current monitoring session. Soloing an object silences all the other objects in the project except this one.

A bold M or S indicates that the Mute or Solo state has been explicitly set for the object. A non-bold M or S with faded color indicates that the object's Mute or Solo state was implicitly set from another object's state.

Muting an object implicitly mutes the descendant objects.

Soloing an object implicitly mutes the sibling objects and implicitly solos the descendant and ancestor objects.

[Tip] Tip

Hold the Ctrl key while clicking a solo button to exclusively solo the object for which the solo button is associated.

[Note] Note

Mute and Solo are designed to be used for monitoring purposes only and are not persisted in the project or stored in the SoundBanks.

Platform

The platform on which the object or project element is located.

Size Previews: All the Size Preview values are calculated when opening the view. They will, however, auto-refresh when there are fundamental changes, such as changing the platform.

[Note] Note

Any fields marked as "-" are either incalculable or inapplicable to the object in question.

Total Size

The sum of the element's Media Size and Structure Size, which approximates the total size that they will take up in a SoundBank.

Media Size

An approximation of the total size that a Wwise object's media files, including converted source files, Events, and Effects, will take up within a SoundBank.

[Note] Note

For Effects requiring a license, their size value is not included unless the appropriate license is entered.

The parent object will only display the size of the normally smaller audio buffer files if its media files are set to stream with Zero latency. No size displays for the parent object if its media files stream without Zero latency.

[Caution] Caution

There are many situations where the media size of an object has changed but the view is not updated. To ensure that all sizes are up to date, use the Refresh All Sizes shortcut menu option. To update one or several specific items, select them and use the Refresh Size shortcut menu option.

Object Size

An approximation of the size Wwise objects, excluding the size of sound files on disk, will take up within a SoundBank.

[Note] Note

Actions do not have any size. And objects that are only in the Init bank, such as Game Syncs, are not included.

Structure Size

An approximation of the size an object (Object Size) and its structural descendants will take up within a SoundBank.

Other Columns: Apart from the columns listed above, many object-type-specific properties can be added as columns. These will display according to your results.

Copies query results to the Windows clipboard so you can paste them into another application.