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.

File Attributes

Format

The file format: WAV, the industry standard Waveform Audio File Format for storing audio bitstreams; or WEM, the Wwise description file.

Default value: WAV

Ambisonic Channel Ordering

For ambisonic channel configurations, this setting can be used to switch between FuMa ordering and ACN ordering (AmbiX).

	Note
	For ambisonic order above 3, this setting is ignored and files are always AmbiX, because FuMa is not defined above 3rd order.

	Note
	By default, Wwise considers imported ambisonic files to be FuMa when the order is below or equal to 3, and AmbiX above. Therefore, when this setting is set to FuMa, ambisonic files of any order will be properly imported into Wwise.

Default value: FuMa

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 within 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.

	Warning
	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:

Stereo Downmix

Enable to downmix any input with more than two channels to a stereo file. It activates the following 7.1 configuration volume sliders to adjust the relative importance of the different input channels, whatever they may be, for the stereo downmix.

	Note
	For ambisonic channel configurations, the Stereo downmix does nothing.

Default value: true

Front

The gain applied to the front speakers.

Default value: 0.0

Range: -96.3 to 0

Units: dB

Center

The applied gain to the center speaker.

Default value: -3.0

Range: -96.3 to 0

Units: dB

Surround

The gain applied to the surround speakers.

Default value: -3.0

Range: -96.3 to 0

Units: dB

Back

The gain applied to the back speakers.

Default value: -3.0

Range: -96.3 to 0

Units: dB

LFE

The gain applied to the distinct channel for the low frequency effect.

Default value: -96.3

Range: -96.3 to 0

Units: dB

Recorder Input

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 Master 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

Import in Wwise

Prompts the Audio File Importer to make it convenient to import recorded files.

Authoring Tool Recording Status

The current state of the recording process among the following possibilities:

Shows the contents of the PCM (WAV or AMB) file in Peak mode over a detailed timeline for all its applicable channels.