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

Notes

Any additional information about the object properties.

Controls the Mute and Solo states for the object and shows the implicit mute and solo states for the object.

Muting an object silences this object for the current monitoring session. Soloing an object silences all the other objects in the project except this one.

A bold M or S indicates that the Mute or Solo state has been explicitly set for the object. A non-bold M or S with faded color indicates that the object's Mute or Solo state was implicitly set from another object's state.

Muting an object implicitly mutes the descendant objects.

Soloing an object implicitly mutes the sibling objects and implicitly solos the descendant and ancestor objects.

	Tip
	Hold the Ctrl key while clicking a solo button to exclusively solo the object for which the solo button is associated.

	Note
	Mute and Solo are designed to be used for monitoring purposes only and are not persisted in the project or stored in the SoundBanks.

Sets the display of the Property 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.

	Shortcuts for selecting tabs
	Press Ctrl and the number corresponding to the number of the Property Editor tab you want. For example, Ctrl+4 would select the RTPC tab if that were the fourth visible tab.

Voice Volume

The attenuation (level or amplitude) applied on the current object before it is routed to a bus or sent to an Auxiliary Bus. Refer to Understanding the Voice Pipeline for more information about volumes.

Default value: 0
Range: -400 to 400
Units: dB

	Note
	The default slider range is from -96 to +12 dB. You can go over those limits by entering the value directly or by rolling the mouse while the focus is on the edit control.

Voice Pitch

The playback speed of an audio object, where:

	Tip
	1,200 cents is equivalent to one octave.

Default value: 0
Range: -2400 to 2400
Units: Cents

Voice Low-pass Filter

A recursive filter that attenuates high frequencies based on the value specified.

The units for this filter represent the percentage of low-pass filtering that has been applied, where 0 means no low-pass filtering (signal unaffected) and 100 means maximal attenuation.

(For more detail, see Wwise LPF and HPF Value Cutoff Frequencies .)

Default value: 0
Range: 0 to 100
Units: %

High-pass filter

A recursive filter that attenuates low frequencies based on the value specified.

The units for this filter represent the percentage of high-pass filtering that has been applied, where 0 means no high-pass filtering (signal unaffected) and 100 means maximal attenuation.

The high-pass filter has a link indicator and an RTPC indicator, see Working with the Property Editor for more information.

Default value: 0
Range: 0 to 100
Units: %

Volume (to Output Bus)

The attenuation or amplitude of the signal routed to the audio output bus.

	Note
	The default slider range is from -96 to +12. You can go over those limits by entering the value directly, or by rolling the mouse while the focus is on the edit control.

	Tip
	When using the User-Defined Auxiliary Sends in a wet/dry mix scenario, the Output Bus Volume would be associated with the dry level, as opposed to the auxiliary send volume, which would relate to the wet level. Use an RTPC on Output Bus Volume and Auxiliary Send Volumes to control the balance from the game.

Default value: 0
Range: -200 to 200
Units: dB

Low-pass Filter (to Output Bus)

A Low-Pass Filter for the signal routed to the audio output bus.

A recursive filter that attenuates high frequencies based on the value specified.

The units for this filter represent the percentage of Low-Pass Filtering that has been applied, where 0 means no Low-Pass Filtering (signal unaffected) and 100 means maximal attenuation.

Default value: 0
Range: 0 to 100
Units: %

High-pass Filter (to Output Bus)

A High-Pass Filter for the signal routed to the audio output bus.

A recursive filter that attenuates low frequencies based on the value specified.

The units for this filter represent the percentage of High-Pass Filtering that has been applied, where 0 means no High-Pass Filtering (signal unaffected) and 100 means maximal attenuation.

Default value: 0
Range: 0 to 100
Units: %

Override parent

Determines whether the game-defined auxiliary sends usage will be inherited from the parent or defined at the current level in the hierarchy. When this option is not selected, the game-defined auxiliary controls are unavailable.

	Note
	If the object is a top-level object, this option is unavailable.

Default value: false

Use game-defined auxiliary sends

Determines whether the object is using the game-defined auxiliary sends for the game object. A game-defined send is a combination of an Auxiliary Bus and a send volume.

Enable this option to have the object affected by the values coming from the game for the following functions:

If the game has initialized Spatial Audio and sent Rooms and Portals data to Wwise, this property determines if the object should send to the Auxiliary Bus defined by the current Room that the game object is inside.

Default value: false

Volume (Game-defined auxiliary sends)

Determines the attenuation on the game-defined auxiliary sends volumes set for the game object.

Use this volume to offset game-defined auxiliary send values.

	Note
	The default slider range is from -96 to +12. You can go over those limits by entering the value directly, or by rolling the mouse while the focus is on the edit control.

Default value: 0
Range: -200 to 200
Units: dB

Override Parent

Determines whether the User-Defined Auxiliary Sends usage will be inherited from the parent or defined at the current level in the hierarchy. When this option is not selected, the user-defined auxiliary controls are unavailable.

	Note
	If the object is a top-level object, then this option is unavailable.

Click the Configure Columns... shortcut (right-click) option from the column header band.

The Configure Columns Dialog opens. Specify which columns to display and their order.

ID column (User-Defined Auxiliary Sends)

Determines the ID of the User-Defined Auxiliary Sends. Up to 4 different sends can be added.

User Auxiliary Send

Determines the Auxiliary Bus this object is sending audio data to. Auxiliary sends can only target Auxiliary Busses.

To add an auxiliary send:

	Note
	Auxiliary Busses can be created anywhere in the Master-Mixer Hierarchy as children of an existing Bus or an existing Auxiliary Bus.

	Tip
	You can drag and drop an Auxiliary Bus object from the Project Explorer to the User-Defined Auxiliary Sends list to quickly add a send.

[...] column (User-Defined Auxiliary Sends)

Allow to select an Auxiliary Bus from the Master-Mixer Hierarchy.

User-Defined Auxiliary Send Volume

Determine the attenuation of the signal sent to the Auxiliary Bus.

	Note
	The default slider range is from -96 to +12 dB. You can go over those limits by entering the value directly, or by rolling the mouse while the focus is on the edit control.

	Note
	This control is only active when an Auxiliary Bus is selected for a specific send entry.

Default value: 0
Range: -200 to 200
Units: dB

Override parent

Determines whether the early reflections auxiliary sends usage will be inherited from the parent or defined at the current level in the hierarchy. When this option is not selected, the early reflections auxiliary controls are unavailable.

	Note
	If the object is a top-level object, this option is unavailable.

Default value: false

Early Reflections Auxiliary Send

Enables reflection processing in Wwise Spatial Audio and determines the Auxiliary Bus this object is sending to for early reflections processing.

Early reflections processing simulates the acoustic phenomenon of sound bouncing off of virtual surfaces defined by geometry in the game. Since the first few reflections convey the most spatial information to the listener, it is advantageous to process the early reflections separately (from the late reverb) and with more detail using the Wwise Reflect plug-in.

To render early reflections, the Wwise Reflect plugin must be assigned to an effect slot on the Auxiliary Bus assigned to an early reflections send.

If no send is specified, then Wwise Spatial Audio will not compute early reflections paths for the sound.

	Note
	It is also possible to assign a reflections Auxiliary Bus per Game Object via the Spatial Audio API. In the case that a reflections bus is assigned both via the API and to the sound in the authoring tool, the bus used for the sound is taken from the authoring tool.

	Note
	For reflections to be computed, the Wwise Spatial Audio library must be initialized and the game must send level geometry to Wwise Spatial Audio.

To add an auxiliary send:

	Note
	Auxiliary Busses can be created anywhere in the Master-Mixer Hierarchy as children of an existing Bus or an existing Auxiliary Bus.

	Tip
	You can drag and drop an Auxiliary Bus object from the Project Explorer to the User-Defined Auxiliary Sends list to quickly add a send.

Early Reflections Auxiliary Send Volume

Determine the attenuation of the signal sent to the reflections Auxiliary Bus. This control also effects the volume of the reflections aux send specified by the API.

	Note
	The default slider range is from -96 to +12 dB. You can go over those limits by entering the value directly, or by rolling the mouse while the focus is on the edit control.

Default value: 0
Range: -200 to 200
Units: dB

Initial Delay

Initial Delay

Initial delay applied before playing. This delay will be added to parents and children Initial delay.

	Note
	This delay changes the behavior of a container in Trigger rate mode as the delay of its children will be applied additionally to the Trigger rate duration.

	Note
	The Source Editor’s Play Cursor start position is not respected when there is an Initial Delay. For more information, refer to the Source Editor documentation .

Note

Using the built-in parameters to control an RTPC can lead to problems if that RTPC is tied to Initial Delay or Priority. Built-in parameters are computed when a sound plays on a given game object, so they work great for most sound properties. Logical control of playback items like Initial Delay and Priority are not suited while using the built-in parameters to control an RTPC since their value is unknown at the moment the Play Action is posted.

Default value: 0
Range: 0 to 3600
Units: s

Scope

Default value: Global

Play Type

Random or Sequence

Default value: Random

Random type

Default value: Standard

Avoid repeating last x played

Determines how many other objects must be played before an object can be repeated.

The behavior of this option is affected by whether you are in Standard or Shuffle mode.

In Standard mode, the object played is selected completely randomly, but the last x objects played are excluded from the list.

In Shuffle mode, when the container is looped, the last x objects played will be excluded from the list.

If you have a non-looping Random Container that is set to shuffle and continuous, the “Avoid repeating last x played” option has no effect on the playback of your container.

Default value: 1
Range: 1 to 999

Sequence At End of Playlist

Defines the playback behavior of the sequence after it has played the last object in the playlist. There are two options to choose from:

Default value: Restart

Play Mode

Step or Continuous

Default value: Step

Always reset playlist

Determines whether playback continues or returns to the beginning of the playlist when a container is replayed after being stopped during playback.

If selected, the container returns to the beginning of the playlist. If unselected, the container will begin playback at the next object in the playlist.

Default value: true

Loop

Enables controls that define the number of times the container will be played.

Default value: true

Infinite

Specifies that the container will be repeated indefinitely.

Default value: Infinite

No. of loops

The number of times the container will be played.

Default value: 2
Range: 1 to 32767

Transitions

Enables controls that allow you to create and define a transition between the objects in the container.

Default value: false

Type

A list of transitions that can be applied between objects in the container.

	Note
	There are some limitations and restrictions when using Xfade, Sample accurate, and Trigger rate transitions. A couple of notable ones are:

Default value: Xfade (amp)

Duration

The length of the crossfades or delay between clips. If Trigger rate is selected as the transition type, the duration defines the amount of time that will pass before the next sound is triggered.

The Duration slider is unavailable when the Sample Accurate option is selected.

The maximum duration of a crossfade is equal to half the duration of the sound. In cases where the crossfade time is longer than half the duration of the sound, the crossfade duration is automatically adjusted to the maximum allowed. This automatic adjustment is performed by the sound engine at run time. Wwise does not limit or indicate that the crossfade time is too long for some of the sounds in the container.

Default value: 1
Range: 0 to 3600