Version

menu_open

Property Editor: Music Switch Container

This Property Editor contains the properties and behavior options for the selected Music Switch Container. Music object properties determine how the music sounds when it is played in your game. Music object behaviors determine which pieces of music are played back 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 Low-Pass Filter. The last area, on the right, includes all the behaviors, including Switch type, tempo, and time signature.

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

For a description of the properties in the Conversion, Effects, Positioning, RTPC, States, Transitions, Stingers, and Advanced Settings tabs, refer to Common Property Tabs: Interactive Music Objects.

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. When you choose a color for an object, a palette icon appears on the selected square, as well as a yellow triangle in the lower-right corner, as shown.

To inherit the parent object's color, select the square at the far left of the color selector.

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.

Inclusion

Determines whether the element is included in the SoundBanks when they are generated. When selected, the element is included. When unselected, the element is not included.

To optimize your sound design for each platform, you might want to exclude certain elements on certain platforms. By default, this check box applies across all platforms. Use the Link indicator to the left of the check box to unlink the element. Then you can customize the state of the check box per platform.

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 that displays a single selected tab. You can, however, click a splitter button to display two panels, divided horizontally or vertically. The selected option is highlighted with a background color.

You cannot open the same tab in both panels. If you try to open the same tab in both panels, the first panel automatically opens a different tab.

[Tip]Tip

  • Press Ctrl and the number that corresponds to the number of the Property Editor tab you want to view. For example, Ctrl+4 opens the RTPC tab if it is 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 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: %

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

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 .

[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

Playback Speed

Interface Element

Description

Playback Speed

Adjusts the speed at which the music object’s contents are played:

  • A value of 1 results in a normal playback

  • A value less than 1 results in a slower playback

  • A value greater than 1 results in a faster playback

The Playback Speed affects different media types differently:

  • WAV: The contents are played at a higher/lower pitch.

  • MIDI: The contents are played at a faster/slower tempo.

[Note]Note

This value is multiplied by the Playback Speed of the object’s ancestors to determine the effective playback speed of the object.

[Note]Note

During an Interactive Music playback instance, the effective playback speed of the active Segment is applied to all playing Segments of the same playback instance. This is particularly important during the transition between two segments when a crossfade is applied. The fading-in (newly active) Segment’s playback speed is applied to the fading-out (previously active) Segment.

Default value: 1

Range: 0.25 to 4

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 aux sends

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

If enabled, the object is affected by the values coming from the game for the following functions:

Additionally, if the game has initialized Spatial Audio and sent Rooms and Portals data to Wwise, this option determines if the object sends to the Auxiliary Busses defined for Rooms and Portals based on the game object’s position.

Refer to Understanding Sends for further details this option.

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.

Right-click the table header to open the Configure Columns dialog where you can specify which columns to display and their order. See Using tables.

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.

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.

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

To render early reflections, the 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]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]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:

  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.

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

Time Settings

Interface Element

Description

Override parent

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

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

Default value: false

Tempo

The speed or pace of the music object. This setting should match the tempo of the original music source.

The tempo and time signature settings define the timeline ruler in the Music Editor, so you can easily position sync points at the next beat, bar, or grid.

Default value: 120

Range: 1 to 400

Units: BPM

Time Signature

The number and length of beats to the bar. This setting should match the time signature of the original music source.

Default value: 4

Range: 1 to 64

Grid

Frequency

Specifies an arbitrary method by which the Music Segment can be virtually partitioned. By adding another level of granularity to the Music Segment, you have a great deal of flexibility to determine sync points for music transitions, state changes, and stingers.

The Frequency and Offset settings define the behavior of the Next Grid option for state changes, transitions, and stingers.

Default value: 4 Bars

Offset

Creates an offset to the frequency value. You can select a standard offset value from the list or create a custom offset in milliseconds.

Default value: No

Offset Ms

The offset in milliseconds. Applicable if specifying a Custom offset.

Default value: 0

Range: 0 to 99999

Music Switch Container Specific

Interface Element

Description

Switch Type

Switch

Plays music objects within the container according to switches.

State

Plays music objects within the container according to states.

Displays the selected state or Switch Group in the Game Syncs tab of the Project Explorer.

Play Options

Continue to play on Switch change

Determines whether a music object that is in more than one Switch will continue to play when a new Switch is triggered.

If this option is selected and the music object is in both Switches, it will continue playing as if no Switch change had occurred. If a change in Switch occurs and this option is unselected, the music object will stop playing at the next sync point and will start again from the beginning.

Default value: true


Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise