Table of Contents

Attenuation Editor

The Attenuation Editor allows you to define the distance-based attenuation properties for a particular object. By creating a series of curves to define the relationship between specific Wwise properties, such as volume and Low-Pass Filter, and the distance between the emitting source and the listener, you can simulate sophisticated distance-based attenuation for the sounds, music, and motion in your game. You can further refine your attenuation using sound cones, which simulate attenuation based on the orientation of the emitter in relation to the listener.

You can create detailed and complex attenuation curves by defining the shape of each curve segment. A curve segment is any part of the curve between two control points. You can choose from a variety of curve shapes, including linear, constant, logarithmic, exponential, and s-curve.

These attenuation settings can also be saved as ShareSets, which means you can share these settings across several objects in your project.

[Note] Note

The attenuation values are always added to the existing property values of the associated objects. So if you have a hierarchy of sounds or music with a cumulative volume level of -20 dB and then attenuate the volume by -64 dB, the volume of the object will be -84 dB.

[Note] Note

The graph view will also display the distance between Game Objects and Listeners. Note that only Game Objects and Listeners added to the Watches Tab of the Game Object Explorer will be displayed.

A few of the attenuation properties can be controlled using RTPCs. For a description of the RTPC properties, switch to the RTPC Tab and click the Help icon. For more information on how to apply RTPCs, refer to Chapter 19, Working with RTPCs.

Interface Element

Description

Name

The name of the Attenuation ShareSet.

Shared by

A list of objects that currently subscribe to the selected ShareSet.

Opens a search field where standard alphanumeric entries filter out unmatching elements from the view. Learn more in Using Tables.

Click the Close icon to the left of the search icon to close the search field and remove the filter.

[Note] Note

The searches do not include elements in collapsed nodes of the List View, Query Editor, MIDI Keymap Editor, and Reference View.

Reset Attenuation

Returns the attenuation settings to their default values.

This option is only available when editing a custom attenuation instance.

Notes

Additional information about the ShareSet or the attenuation settings that have been applied.

Attenuation Settings

Graph view

A graphical representation of the relationship between specific Wwise properties, such as volume and Low-Pass Filter, and distance. The combination of all of these curves simulates the distance-based attenuation for the sounds, music, and motion objects within your game.

The X axis is represented in distance units. The minimum value is 0 and the maximum value is determined by the current max distance value. The values along the Y axis will depend on which property curves are selected in the Curves list.

The two default control points in the Graph view represent the values for Radius center and Max distance.

The radius center cannot be deleted or moved along the X axis because it is defined by the game object (3D game-defined) or listener's position (3D Automation) in game. You can add additional points to modify the shape of the attenuation curve.

You can preview the attenuation curves by dragging the Distance cursor during playback.

The graph view can display several curves simultaneously.

Zooms in towards the center of the graph view.

Resets the graph view to the default zoom factor ratio of 1:1.

Zooms out from the center of the graph view.

Game Object Explorer...

Clicking this button opens the Game Object Explorer view.

Show Game Objects

Enables the display of game object values in the graph view. The game objects shown will be those that are added to the watch list in the Game Object Explorer.

[Note] Note

In addition to watches on game objects, it is necessary to have a watch on at least one listener. Also, the Listener Data option must be enabled in the Profiler Settings to be able to see the game object values in the graph view.

Coordinates

X

The coordinate along the X axis of the selected control point. The x value represents distance.

If more than one control point is selected, the field displays a value of 0, so that you can increase or decrease the value of all selected control points relative to their current values. For example, if you select two control points and type -5 in the X text box, both control points will move to the left by 5 units.

Y

The coordinate along the Y axis of the selected control point. The values along the Y axis may be different depending on which curve is selected in the Curves list.

If more than one control point is selected, the field displays a value of 0, so that you can increase or decrease the value of all selected control points relative to their current values. For example, if you select two control points and type -5 in the Y text box, both control points will move down by 5 units.

Curves

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.

(Pin/Unpin)

Determines whether the attenuation curve is displayed in the graph view.

When the Pin icon is selected, the attenuation curve will be displayed in the graph view whether the curve is selected or not.

(Color block)

Displays the color of the attenuation curve in the graph view. Each property curve is assigned a different color.

(Link/Unlink)

Displays whether the curve is applied across all platforms.

Properties

The Wwise property upon which distance attenuation is applied. You can create attenuation curves for the following Wwise properties:

  • Output Bus Volume - Offsets the main volume controlling the signal routed to the bus. Corresponds to the dry portion in a wet/dry scenario.

  • Auxiliary send volumes - Offsets the game-defined and user-defined auxiliary send volumes. Corresponds to the wet portion in a wet/dry scenario.

  • Low-pass filter - The recursive filter that attenuates high frequencies based on a specified value.

  • High-pass filter - The recursive filter that attenuates low frequencies based on a specified value.

  • Spread - The amount or percentage of audio that is spread to neighboring speakers allowing for sounds to change over distance from a point source at low values to a completely diffused propagation at high values. For multi-channel sounds, each channel is spread separately.

  • Focus - The percentage value used to condense the virtual emitters generated by the spread value. For a focus of 0%, the virtual emitters remain unchanged, but at higher values each virtual points are moved closer around the source channel origin.

These properties are displayed along the Y axis in the graph view.

Curve

Specifies which attenuation curve will be used for each property. You can chose one of the following options:

  • None - No attenuation curve is created for the corresponding property. When “None” is selected, the corresponding property is NOT attenuated and remains at its full strength.

  • Use Output Bus Volume - The Output Bus Volume attenuation curve is used for the corresponding property. This option is only available for the Wet Volume.

  • Custom - A custom attenuation curve is created for the corresponding property.

Keep in mind that each new curve you create will require additional processing power.

 

Max distance

The distance from the emitting source where the sound/motion reaches its lowest level. The attenuation of the object remains constant beyond the max distance.

Sound and motion propagation is omni-directional, so the max distance value creates a spherical boundary around the emitting source.

The max distance is represented in the Graph view by the last control point.

Default Value: 100
Default Slider Range: 1 to 200
Input Range: 1 to 10,000,000,000
Units: Wwise distance units

Wwise distance units will match the distance units that you are using in game, for example, centimeters, meters, and so on.

 

Cone Attenuation

Creates a sound cone where attenuation is controlled using a series of cones with varying angles. The direction of the cone-shaped boundaries are ultimately controlled by the orientation of the game object.

The cone attenuation value is added to the distance-based attenuation values.

Default value: No

Inner angle

The angle that defines an area where no attenuation occurs.

The inner angle defines the top boundary in the mini cone display. It is redrawn in real time as the value is modified.

The area between the inner and outer angle is called the transition area. The volume attenuation within this area is linearly interpolated between zero attenuation and the max attenuation value.

Default value: 90
Range: 0 to 360
Units: °

Outer angle

The angle that defines the area where Volume, Low-Pass Filter, Spread, and Focus Attenuation remain at their maximum levels.

The outer angle defines the bottom boundary in the mini cone display. It is redrawn in real time as the value is modified.

The area between the inner and outer angle is called the transition area. The volume attenuation within this area is linearly interpolated between zero attenuation and the max attenuation value.

Default value: 245
Range: 0 to 360
Units: °

Max attenuation

The amount by which the volume is attenuated when the emitting source falls outside the transition area.

Max attenuation has a link indicator and an RTPC indicator, see Working with the Property Editor for more information.

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

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.

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

(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: %

Attenuation Preview

A graphical representation of the maximum radius attenuation of a sound, where the source of the sound is located directly in the middle of the circle.

This tool is not a panner so moving the red circle won't position your sound in the surround field. This tool can only be used to preview your attenuation settings.

The Attenuation Preview has the following two functions:

  • Displays the different areas of the cone attenuation. The different areas of the sound cone are updated in real time as the inner and outer angle values are modified.

  • Allows you to preview the attenuation of a sound by modifying the position of the listener during playback. The position of the listener is defined by its angle (black line) and distance (red circle) from the sound source. You can modify the distance and angle controls by clicking/dragging directly in the Attenuation Preview display.

The Attenuation Preview only works for objects that use a listener position.