Wwise Help

Inclusion

Determines whether the element is included or excluded. When selected, the element is included. When unselected, the element is not included. By default, this applies across all platforms. Use the Link indicator (to the left of the check box) to determine or to set platform-specific customizations.

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

Default value: true

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.

Effect

The type of effect.

Shared by (Used by)

A list of objects that currently subscribe to the selected ShareSet.

This field is called “Used by” when editing a custom instance of the Effect.

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
	The searches do not include elements in collapsed nodes of the List View, Query Editor, MIDI Keymap Editor, and Reference View.

Returns the Effect property settings to their default values.

This option is only available when editing a custom instance of the Effect.

Notes

Additional information about the Effect.

Mode

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

Default value: Peak

Scope

Default value: Global

Dynamics

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 where the monitored level goes below the current output value.

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

Output Game Parameter

When set, the output value will be sent to this Game Parameter based on the playing instance's Scope, be it 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.

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

Apply Downstream Volume

When enabled, the meter will display volume gains applied at a higher level. For example, if the volume of the Master Audio Bus is increased by 10 and that 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, unless this option is enabled the meter will normally not show it.

Default value: false

(VU Meters)

A pair of meters that display the input level of the audio signal, and output value of the Game Parameter.

To enable the VU meters, you must click the Start Capture button in the Wwise toolbar.

The VU meters only work when the Effect has been applied to a bus in the Master-Mixer Hierarchy. In the case of a ShareSet, the bus must be selected in the 'Shared by' list of the Effect Editor.