Version
This Property Editor contains the properties and behavior options for the selected Switch Container. Object properties determine the characteristics of the objects when they are played in-game. Object behaviors determine which objects are played back at any given point in the game.
A Switch Container plays back objects and/or containers according to a Switch or State that corresponds to particular changes in the environment of the game either at a global or local level. For example, a Switch Container for a character's footsteps might contain Switches for grass, concrete, wood, and any other surface that a character can walk on in-game. Each of these Switches are triggered by the game engine and would have specific sounds or containers associated with them.
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 |
||||||
[name] |
The name of the object. |
||||||
Displays the object's color. Clicking the icon opens the color selector. Select a color to apply it to the object.
|
|||||||
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.
|
|||||||
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 editor become unavailable. Default value: true |
||||||
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 |
Any additional information about the object properties. |
||||||
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.
|
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
|
|||
Voice Pitch |
The playback speed of an audio structure, where:
Default value: 0 |
|||
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 |
|||
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 |
Make-up Gain | ||||
---|---|---|---|---|
Interface Element |
Description |
|||
Make-up Gain |
Volume gain in decibels (dB) applied to the voice, after all other volume adjustments. The make-up gain is additive across the Actor-Mixer Hierarchy. 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. For more information about the Make-up Gain, refer to Using Loudness Normalization or Make-up gain to Adjust Volume .
Default value: 0 |
Output Bus | |||||||
---|---|---|---|---|---|---|---|
Interface Element |
Description |
||||||
Volume (to Output Bus) |
The attenuation or amplitude of the signal routed to the audio output bus.
Default value: 0 |
||||||
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 |
||||||
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 |
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.
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.
Default value: 0 |
|||
|
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.
|
||||||
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:
|
||||||
[...] 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.
Default value: 0 |
||||||
|
Early Reflections Auxiliary Sends | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Interface Element |
Description |
||||||||||||
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.
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.
To add an auxiliary 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.
Default value: 0 |
Switch Container Specific | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Interface Element |
Description |
|||||||||
Initial Delay | ||||||||||
Initial Delay |
Initial delay applied before playing. This delay will be added to parents and children Initial delay.
Default value: 0 |
|||||||||
Play Mode |
Default value: Step |
|||||||||
Switch Group |
The Switch or State Group assigned to the current container. The Group list contains all the Switch or State Groups that currently exist for the current project. The contents of the Group list depends on whether Switch or State is selected. |
|||||||||
Default Switch/State |
The Switch/State that will be played when the game cannot identify a specific Switch or State. |
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise