Wwise Help

Name

The name of the object.

PF

Determines whether the object is included or excluded from the current platform. When selected, the object is included in the current platform. When unselected, the object is not included.

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

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.

Voice Volume

The attenuation (level or amplitude) applied on the audio object before it is being 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: -200 to 200
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 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.

Default value: 0
Range: 0 to 100
Units: Percent
(For more detail, see Wwise LPF Value Cutoff Frequencies.)

On the Wii platform, Wwise uses the Wii DSP low-pass filter.

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

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

High-pass filter is not available on the Wii, Vita Hardware, and 3DS.

Override parent

Determines whether the routing will be inherited from the parent or defined at the current level in the hierarchy. When this option is not selected, the output controls are unavailable.

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

Bus

The audio bus in the Master-Mixer hierarchy through which the object is routed.

This option is unavailable when the object is inheriting the output properties from the parent.

The audio bus can be unlinked to create a different routing path on a specific platform.

For more information, see To unlink the output routing for the current platform:.

Opens the Project Explorer - Browser where you can select the audio bus through which the object will be routed.

Volume (to Output Bus)

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

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

	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.

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

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

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.

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

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

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.

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

	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.

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.

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

ID column (User-defined Auxiliary Sends)

Determines the ID of the user-defined auxiliary sends. Up to 4 different sends can be added.

Auxiliary Bus column (User-defined auxiliary sends)

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

	Note
	Auxiliary Busses can be created anywhere in the Master-Mixer hierarchy as childre 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.

Volume column (User-defined auxiliary sends)

Determine the attenuation of the signal sent to the auxiliary bus.

Default value: 0
Range: -200 to 200
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.

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

Behaviors

Stream

Enables controls that allow you to stream the music audio played in game directly from game media.

Streamed media is not included into soundbanks. It is the Wwise Stream Manager's, and ultimately, the Low-Level I/O submodule's responsibility to open and read them from disk at run-time. Refer to the Wwise SDK documentation for more details on Wwise I/O.

Streamed files are described in the file SoundBanksInfo.xml, which is created for each platform when soundbanks are generated. You may use the CopyStreamedFiles or File Packager tools as a post-soundbank generation step in order to deploy them conveniently. Refer to Chapter 34, Managing SoundBanks for more details.

Audio playback is always streamed while authoring in Wwise regardless of whether this option is selected or not. The Stream settings, therefore, only apply when generating SoundBanks, and playing back from a remote platform or game.

RSX™ (PlayStation®3 only)

Enables controls that allow you to stream the audio played in game directly from RSX™ local memory.

This control overrides the Stream option (above), because audio played from RSX local memory is always streamed.

Streamed media is not included into soundbanks. It is the Wwise Stream Manager's, and ultimately, the Low-Level I/O submodule's responsibility to open and read them at run-time. In order to play them from RSX, you should set up an I/O system with a streaming device capable of transferring data from RSX local memory. Refer to the Wwise SDK documentation for more details on Wwise I/O and the RSX device.

RSX files, like streamed files, are described in the file SoundBanksInfo.xml, which is created for each platform when soundbanks are generated. The difference is that RSX files are annotated with a special attribute: RSX="true".

The default RSX device implementation requires that you group streamed files into file packages, using the File Packager tool. It is recommended that you use the File Packager tool as a post-soundbank generation step. Refer to Chapter 34, Managing SoundBanks and Chapter 35, Managing File Packages for more details on file packaging.

Look-ahead time (ms)

The amount of time reserved by the sound engine to seek the streaming data. This time defines the latency of the track. If the look ahead time is 100 milliseconds, the music will be heard only 100 milliseconds after pressing play.

Default value: 100
Range: 10,000
Units: Milliseconds

If the look-ahead time is too small, audio tracks may become unsynchronized during playback.

Zero latency

Creates a small audio buffer consisting of the beginning portion of the audio file that covers the latency time required to fetch the rest of the file. This enables the entire streamed sound to be played back without delays.

Latency and prefetch settings are set per track. If you have more than one music source per track then the beginning portion of each source will need to be loaded into memory.

Prefetch length (ms)

The beginning portion of the music, in milliseconds, that will be loaded into memory in order for the streamed music to be played back with zero latency.

Since the initial sync point for a piece of music may not be at the beginning of the clip, the prefetch data loaded into memory may not be useful. In this case, the look-ahead time is used.

Non-cachable

Disables caching of this file, when caching is enabled in the streaming manager. This is useful to prevent long loops, or files that are played infrequently, from using up space in the streaming cache that could be better utilized by other sounds.

Track Type

Defines the playback behavior of the current track and its sub-tracks. The Track Type can be any one of the following:

Normal - Plays the current track each time the parent segment is played. Sub-tracks can't be added when in Normal mode.

Random Step - Plays one of the sub-tracks in a random order each time the parent segment is played.

Sequence Step - Plays one of the sub-tracks in sequential order each time the parent segment is played.

Switch-plays the sub-tracks associated to the active switch/state.

Switch Type

Group

The switch/state group associated to the track. This field is active only if the Track Type is set to Switch.

Default Switch/State

The switch/state that will be played when the game cannot identify a specific switch/state. This field is active only if the Track Type is set to Switch.