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.

LFO Section

LFO Depth

Amount of amplitude modulation applied to the input signal, in percentage. At 0%, the input signal passes through unchanged. At 100%, the signal is modulated to its full range.

Default value: 100

Range: 0 to 100

Units: %

LFO Frequency

Frequency of the modulating signal.

Default value: 1

Range: 0.02 to 20000

Units: Hz

LFO Waveform

Shape of the modulating signal.

	Note
	Although this parameter can be changed at run-time via RTPC, the signal is not guaranteed to be continuous.

Values: Sine, Square, Triangle, Upward sawtooth, Downward sawtooth.

Default value: Sine

LFO Smoothing

Amount of smoothing applied to the modulating signal. It is low-pass filtered by a certain value, mapped from 0 to 100%. At 0%, the signal comes out intact. With higher values, edges and discontinuities are smoothed.

	Note
	This setting has no effect on the sine waveform.

Default value: 0

Range: 0 to 100

Units: %

PWM (Pulse Width Modulation)

Applies to the square waveform only. Modulates the width of the pulse during one cycle. At 50%, the signal is at its full amplitude for half of the cycle, and is 0 for the other half. Near 100%, the signal is at its full amplitude for almost all the cycle, while it drops to 0 for a very short amount of time.

Default value: 50

Range: 0 to 100

Units: %

Initial Phase Section

Offset

Offsets phase of the modulating signal of all channels by a specific value.

	Note
	Although this parameter can be changed at run-time using RTPCs, it has no effect when it is set after the instance of this effect has started playing.

Default value: 0

Range: -180 to 180

Units: °

LFO Spread Mode

Defines how initial phase spread (see parameter “Spread”) is applied across channels. For example, with spread mode set to “Front-Rear”, all front channels start playing with a phase equal to 0, and all rear channels start playing with a phase equal to “Spread”. If present (and processed), the LFE channel is always synchronized with the Front Left channel.

Values:

	Note
	Although this parameter can be changed at run-time via RTPC, it has no effect when it is set after the instance of this effect has started playing.

Default value: Left-Right

LFO Phase Spread

Amount of divergence in initial phase spread across channels. The way in which this value affects each channel depends on the spread mode.

	Note
	Although this parameter can be changed at run-time using RTPCs, it has no effect when it is set after the instance of this effect has started playing.

Default value: 0

Range: 0 to 180

Units: °

Output section

Output Gain

Gain to apply to modulated signal.

Default value: 0

Range: -24 to 24

Units: dB

Process Center

Indicates whether the center channel (if present) is modulated or passed through. The center channel is only present in 3.x and 5.x configurations.

Default value: true

Process LFE

Indicates whether the LFE channel (if present) is modulated or passed through. The LFE channel is only present in X.1 configurations.

Default value: true