Version
menu_open
Wwise SDK 2024.1.0
Glossary

Term Definition
Query

A text string that conforms to the Wwise Authoring Query Language.

When a query is executed, it always returns a sequence of Wwise objects.

For more information about the syntax of a query, refer to Wwise Authoring Query Language (WAQL) Reference.

Query Source Defines where the query will look for the initial sequence of objects.
Query Transform Defines a transformation function that takes as input the result of the preceding portion of the query and generates another sequence.
Sequence An enumerable list of Wwise objects.
Input Sequence A sequence generated by the left-hand side source or transform.
Wwise Object

An object instance from the Wwise project.

Most of the Wwise objects can be found in the Project Explorer, such as Sounds, Buses, Blend Containers, Virtual Folders, Work Units, etc. Some objects are not shown in the Project Explorer, but can be found in specialized views, such as Audio Sources, Music Clips, Music Cues, etc.

Each object has:

  • name
  • type
  • id
  • children
  • Properties
  • References

For a complete list of all Wwise objects types, refer to Wwise Objects Reference.

Wwise Object Type

The type of a Wwise object.

For a complete list of all Wwise objects types, refer to Wwise Objects Reference.

Accessor A named field on a Wwise object used to retrieve a value from the object.
Built-in Accessor

A special accessor that can be found natively on most Wwise objects.

For example:

  • name
  • id
  • type
  • path

Note: Built-in accessors are case-insensitive.

Property

A named field on a Wwise object that stores a value.

Each Wwise object defines its own list of properties. For a complete list of all properties, refer to Wwise Objects Reference and select a specific object.

For example: Volume, Pitch, and Lowpass.

For more information on how to define your own properties for a plug-in or by using Custom Properties, refer to Properties XML Description.

Property Accessor

An accessor that returns the value of a property.

Property accessors can be used in three ways:

  • PROPERTY_NAME: returns the value as defined in the user interface, taking into consideration the override settings, if any.
  • @PROPERTY_NAME: returns the value of the property as defined directly in the WWU file, not taking the override settings into consideration.
  • @@PROPERTY_NAME: same as PROPERTY_NAME, but can be used if the PROPERTY_NAME conflicts with a built-in accessor name.

Note: Property accessors are case-insensitive.

Reference

A named field on a Wwise object that stores a reference to another object in the project. Some references can also define an object locally (known as Custom).

Each Wwise object defines its own list of references. For a complete list of all references, refer to Wwise Objects Reference and select a specific object.

For example: Volume, Pitch, and Lowpass.

Reference Accessor

An accessor that returns a Wwise object.

Reference accessors can be used in three ways:

  • REFERENCE_NAME: returns the value as defined in the user interface, taking into consideration the override settings, if any.
  • @REFERENCE_NAME: returns the value of the property as defined directly in the WWU file, not taking the override settings into consideration.
  • @@REFERENCE_NAME: same as REFERENCE_NAME, but can be used if the REFERENCE_NAME conflicts with a built-in accessor name.

Note: It is possible to join multiple reference accessors.

Note: Reference accessors are case-insensitive.

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