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.

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.

Channel Count

The number of channels to write in the ADM output file. This count is fixed for the entire duration of the file. When the object count exceeds the number of available channels, objects will be mixed into the main mix.

Default value: 64

Range: 2 to 128

Main Mix Channel Config

The channel configuration of the main mix (bed). When objects cannot be written as dynamic objects due to exceeding the number of available channels, or the use of options that are not compatible with ADM objects, they will be mixed into the main mix.

Default value: 7.1

Enable Passthrough Mix

When enabled, create a stereo passthrough mix object in the ADM output file. This mix follows the same rules as the audio output device-level passthrough.

Default value: false

Preserve Extra Beds

When enabled, 2d objects are preserved as separate beds when possible instead of being sent to the main mix.

Default value: false

Apply Downstream Volume

When enabled, the gains applied at a higher level will apply to the output file. For example, if the volume of the Main Audio Bus is increased by 10 and that of a child Audio Bus is decreased by 15, then the child and all its children will inherit the sum total gain of -5. Although the gain is always audible, unless this option is enabled the audio file output by the recorder will not include it.

Default value: false

Hold

When enabled, the recorder will remain active even when there is no input. This can be used together with RTPC control to ensure a recording does not reset during periods of silence. The property must be disabled for the recorder to terminate.

Default value: false

Authoring Tool Output Path

Path

The name of the full or relative path (to your Documents folder) and the filename of the recording file. Use the selector button to the right to search for a file or location. Adding “%s” to the filename will include the current date and time in the filename when the Effect is invoked.

Status

The full path to the specified filename. If there are no issues, it has black font. If there are errors, they are listed in square brackets and - except for blank filepaths - in red font. These include the following:

	Note
	If there are any listed issues, the Authoring Tool Recoding Status becomes Cannot Record.

Game Output Path

Path

The filename relative to the location of the SoundBanks.

Caution: Mac paths must use a forward slash. While Windows will interpret both slashes and backslashes as folder separators, on Mac, a backslash will be interpreted as part of the filename.

Status

If there are no issues, it displays in black font the full path to the specified filename using the $(Game base path) relative variable. This variable corresponds to the location of the SoundBanks. For example, at runtime, if the SoundBanks are located at \Game\Audio\Soundbanks\Linux and the Path is set to Recording.wav, then $(Game base path)\Recording.wav represents \Game\Audio\Soundbanks\Linux\Recording.wav. If there are errors, they are listed within square brackets and—except for blank filepaths—in red font. These include the following: