Wwise Help

Name

The name of the Effect instance.

Effect instances are a group of effect property settings. They can be one of two types: custom instances or ShareSets. Custom instances can be used by only one object, whereas ShareSets can be shared across several objects.

(Object Color)

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.

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

(Show references)

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

Additional information about the Effect.

Metering

Indicates the name of the object currently being metered.

Allows you to browse for other objects to meter.

	Note
	The metering interface elements only appear in the Effect Editor for Effects that include VU meters.

Sets the display of the Effect Editor's selected tabs. By default, there is one panel displaying only one selected tab. You can, however, click a splitter button to split the panel into two, either side by side or one on top of the other, for two different tabs. The currently selected option is highlighted with a background color.

	Note
	You cannot display the same tab in both panels. If you select the tab that is currently displayed in the other panel, then the other panel will automatically display another tab.

Mode

The metering mode. This plug-in can be set to track either peak values or RMS.

Default value: RMS

Scope

Default value: Global

Infinite Hold

When enabled, the output value is held indefinitely at the highest level monitored after the option was enabled. In other words, the output value can increase but never decrease.

While this option is enabled, the Hold property value has no effect.

Default value: false

Apply Downstream Volume

When enabled, the meter will display volume gains applied at a higher level. For example, if the volume of the Main Audio Bus is increased by 10 and the volume of a child Audio Bus is decreased by 15, then all its children will inherit the sum total gain of -5. Although the gain is always audible, the meter only reflects it when this option is enabled.

Default value: false

Per-Band Properties and Dynamics

Output Game Parameter

When set, the output value is sent to this Game Parameter based on the playing instance's Scope, either a specific Game Object or globally.

	Tip
	Make sure that the range of the selected Game Parameter contains the output value range. For more information on setting the Game Parameter range, refer to Property Editor: Game Parameter.

Attack

The time it takes for the output value to rise by 10 decibels, when the monitored level is above the current output value.

Default value: 800

Range: 20 to 20000

Units: s

High-Frequency Roll-off

The roll-off of the frequency range to be metered. Higher values result in sharper roll-offs around the range being metered.

Default value: 24 dB/Oct

Units: dB/octave

High-Frequency Cut

The upper end of the frequency range to be metered. A low-pass filter at this frequency point is performed for the metering process.

Default value: 16000

Range: 20 to 20000

Units: Hz

High-Frequency Roll-off

The roll-off of the frequency range to be metered. Higher values result in sharper roll-offs around the range being metered.

Default value: Disabled

Units: dB/octave

Attack

The time it takes for the output value to rise by 10 decibels, when the monitored level is above the current output value.

Default value: 0.0

Range: 0 to 10

Units: s

Hold

The time it takes for the output value to start falling from the moment the monitored level goes below the current output value.

This property has no effect while Infinite Hold is enabled.

Default value: 0

Range: 0 to 10

Units: s

Release

The time it takes for the output value to fall by 10 decibels, when the monitored level is below the current output value.

Default value: 0.1

Range: 0 to 10

Units: s

Min

The minimum output value.

Default value: -48

Range: -96.3 to 0

Max

The maximum output value.

Default value: 0

Range: -96.3 to 12