Version

menu_open

Property Editor: Sound

This Property Editor contains the properties and behavior options for the selected sound object (an SFX or a Voice). Object properties, such as pitch and volume, determine how the audio sounds in-game. Object behaviors, such as looping and streaming, determine how sounds are played at any given point in the game.

The General Settings tab of the Property Editor is divided into three separate areas. The first area includes all the absolute properties, such as output routing. The middle area includes all the relative properties, such as volume and pitch. The last area, on the right, includes all the behaviors.

For a complete description of absolute and relative properties, refer to About Properties in the Project Hierarchy.

For a description of the properties on the Conversion, Effects, Positioning, RTPC, States, and Advanced Settings tabs, refer to Common Property Tabs: Actor-Mixer Objects.

Refer to Understanding the Voice Pipeline to learn about how voices are being processed, how they are being routed and where the different volumes and Effects are being applied.

General

Interface Element

Description

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] Tip

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

[Note] 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] 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.

[Tip] 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.

Relative Properties

Interface Element

Description

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

  • Pitch 0 = Normal speed.
  • Pitch 1,200 = 2 x speed.
  • Pitch 2,400 = 4 x speed.
  • Pitch -1,200 = 0.5 speed
  • Pitch -2,400 = 0.25 speed
[Tip] 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: %

Output Bus

Interface Element

Description

Volume (to Output Bus)

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

[Note] 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] 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: %

Game-defined Auxiliary Sends

Interface Element

Description

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

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

[Note] Game-defined auxiliary sends properties in the All Properties tab

There are game-defined auxiliary sends properties for LPF and HPF, which can only be adjusted in the All Properties Tab.

User-Defined Auxiliary Sends

Interface Element

Description

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

  1. Click the selector […] button.
  2. Select an Auxiliary Bus from the Master-Mixer Hierarchy.
  3. Click OK.
  4. Set the send volume for this newly added send.
[Note] Note

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

[Tip] 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] 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] 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

[Note] User-defined auxiliary sends properties in the All Properties tab

There are user-defined auxiliary sends properties for LPF and HPF, which can only be adjusted in the All Properties Tab.

Sound Object Specific

Initial Delay

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

[Note] 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] 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] 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

Behaviors

Loop

Enables controls that define the number of times the sound or defined loop region in the file will be played.

Some compressed audio file formats, such as ADPCM, require that loop markers lie on predetermined sample boundaries. To accommodate these requirements, you may have to convert your files again when using the Loop option

Default value: false

Infinite

Specifies that the sound or defined loop region in the file will be repeated indefinitely.

Default value: true

No. of loops

The number of times the sound or defined loop region in the file will be played.

Default value: 1
Range: -1 to 32767

 

Stream

Enables controls that allow you to stream the 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. Refer to Managing SoundBanks for more details.

[Note] Note

Within the Project Settings’ or the SoundBanks Settings’ SoundBanks tab, the Generate Metadata Files option should always be enabled. Additionally, you must enable the Generate XML Metadata option. With these set, Wwise generates the SoundbanksInfo.xml file whenever you successfully generate SoundBanks.

Default value: false

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

Default value: false

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.

Default value: false

Prefetch length (ms)

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

Default value: 100
Range: 0 to 10000
Units: ms


Cette page a-t-elle été utile ?

Besoin d'aide ?

Des questions ? Des problèmes ? Besoin de plus d'informations ? Contactez-nous, nous pouvons vous aider !

Visitez notre page d'Aide

Décrivez-nous de votre projet. Nous sommes là pour vous aider.

Enregistrez votre projet et nous vous aiderons à démarrer sans aucune obligation !

Partir du bon pied avec Wwise