Version

menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.

Metadata Tab


[Note]Note

The Metadata tab for busses is exactly the same as the Metadata tab for Actor-Mixer and Interactive Music objects except that the Override parent check box does not apply.

The Metadata tab allows you to associate an unlimited number of Metadata plug-ins with an object. When you associate a Metadata plug-in with an object, you must choose the Metadata plug-in type, and whether the Metadata plug-in is a ShareSet or a custom instance. Clicking the Edit […] button opens the Metadata Editor, allowing you to edit the properties of the Metadata plug-in.

The Metadata tab is divided into two panels. The left panel is where you add or remove Metadata plug-ins, assign their name and mode, or open them in the Metadata Editor. The right panel, like a miniature version of the Multi Editor, allows you to edit properties across multiple selected plug-ins.

General

Interface Element

Description

[name]

The name of the object.

Displays the object's color. Clicking the icon opens the color selector.

Select a color to apply it to the object. When you choose a color for an object, a palette icon appears on the selected square, as well as a yellow triangle in the lower-right corner, as shown.

To inherit the parent object's color, select the square at the far left of the color selector.

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.

Inclusion

Determines whether the element is included in the SoundBanks when they are generated. When selected, the element is included. When unselected, the element is not included.

To optimize your sound design for each platform, you might want to exclude certain elements on certain platforms. By default, this check box applies across all platforms. Use the Link indicator to the left of the check box to unlink the element. Then you can customize the state of the check box per platform.

When this option is unselected, the property and behavior options in the editor become unavailable.

Default value: true

Indicates the number of elements in your project that contain direct references to the object. The icon is displayed in orange when references to the object exist, and in gray when no references exist.

Selecting the button opens the Reference View with the object's name in the References to: field.

Notes

Any additional information about the object properties.

Sets the display of the Property Editor's selected tabs. By default, there is one panel that displays a single selected tab. You can, however, click a splitter button to display two panels, divided horizontally or vertically. The selected option is highlighted with a background color.

You cannot open the same tab in both panels. If you try to open the same tab in both panels, the first panel automatically opens a different tab.

[Tip]Tip

  • Press Ctrl and the number that corresponds to the number of the Property Editor tab you want to view. For example, Ctrl+4 opens the RTPC tab if it is the fourth visible tab.

Metadata

Interface Element

Description

Override parent

Determines whether the Metadata plug-ins are inherited from the parent or defined at the current level in the hierarchy. When this option is not selected, the Metadata options are not available.

If the object is a bus or a top-level object, the Override parent option is not available.

Default value: false

Link Indicator

Use the Link indicator (to the left of the Metadata heading) to determine or to set platform-specific customizations.

The entire list of Metadata plug-ins is linked or unlinked, not individual items in the list.

Metadata

Right-click the table header to open the Configure Columns dialog where you can specify which columns to display and their order. See Using tables.

Type

The type of Metadata plug-in.

Name

The name of the Metadata instance. The Metadata instance can be a ShareSet or a custom instance of a ShareSet. All Metadata instances for the selected Metadata type will appear in the corresponding list.

Mode

Determines whether the Metadata instance is shared. The mode can be either:

  • Define custom: To create a custom Metadata plug-in instance whose properties will not be shared between objects.

  • Use ShareSets: To use a ShareSet of a Metadata plug-in, which means that Metadata properties can be shared between objects.

Edit

Opens the Metadata Editor where you can edit the properties of the selected Metadata instance in real time.
The Add button allows you to add Metadata plug-ins to the list. The list of Metadata plug-ins and corresponding instances that can be selected are presented in a list.
The Delete button removes the selected Metadata plug-in(s) from the list.

(Name Field)

An editable text field which displays the name of the selected Metadata plug-in(s). If more than one plug-in is selected, this field is blank.

The References button displays the number of references in the project to the currently selected Metadata plug-in.

Click the button to open the Reference View loaded with all the project objects/elements that directly reference the selected Metadata plug-in.

[Note]Note

The button is dimmed and displays "0" when selecting multiple Metadata plug-ins.

The display maximum is 999.In the uncommon circumstance of 1,000 or more references, the number will not increase but all the objects/elements will show up in the Reference view.

Right-click the table header to open the Configure Columns dialog where you can specify which columns to display and their order. See Using tables.

Name

The names of the properties of the currently selected Metadata plug-in(s).

[Note]Note

ShareSets have the Color and Inclusion properties, while custom instances do not.

Value

The values of the properties of the currently selected Metadata plug-in(s). Modifications made in this panel are applied to all plug-ins selected in the left panel that have the modified property.

When more than one selected plug-in has the same property but with different values, a dash appears in the Value column (as shown in the following figure). In this case, you can still edit the property and your changes will be applied, as usual, to all selected plug-ins that have the modified property.

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.


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