Menu

AudioMix

The whole mix, authored on one node: what each bus does to the sound, the named mixes it can slide between, the rules that duck one bus while another is loud, and the taps that feed one bus through another's chain.

On this page

Add it
Fields

Guides

Audio

Add it

+ Add node → Audio Mix creates a node with it already on. Already have a node for it? Add component → AudioMixComponent.

Fields

Field Script name Kind Default What it does

Effects effects section — Effects on each bus, in the order the sound passes through them.

Field Script name Kind Default What it does

Master master section — Effects on the master output, after everything else.

Field Script name Kind Default What it does

Slots slots list empty The effects, first to last.

Field	Script name	Kind	Default	What it does
Effect	`effect`	one of LowPass, HighPass, BandPass, Delay, Distortion, Gain, Compressor, Reverb, Panner	none	Which effect this slot applies, such as a filter, a delay, or a reverb.
Enabled	`enabled`	checkbox	none	Whether this effect is switched on.

Music music section — Effects on music.

Field Script name Kind Default What it does

Slots slots list empty The effects, first to last.

Field	Script name	Kind	Default	What it does
Effect	`effect`	one of LowPass, HighPass, BandPass, Delay, Distortion, Gain, Compressor, Reverb, Panner	none	Which effect this slot applies, such as a filter, a delay, or a reverb.
Enabled	`enabled`	checkbox	none	Whether this effect is switched on.

Sfx sfx section — Effects on everything that is not music.

Field Script name Kind Default What it does

Slots slots list empty The effects, first to last.

Field	Script name	Kind	Default	What it does
Effect	`effect`	one of LowPass, HighPass, BandPass, Delay, Distortion, Gain, Compressor, Reverb, Panner	none	Which effect this slot applies, such as a filter, a delay, or a reverb.
Enabled	`enabled`	checkbox	none	Whether this effect is switched on.

Snapshots snapshots list empty Named mixes, such as paused, underwater, or boss.

Field Script name Kind Default What it does

Name name text none What the game calls it, such as "underwater", "paused", or "boss".

Master master section none The master bus.

Field	Script name	Kind	Default	What it does
Volume	`volume`	number, 0 to 1, step 0.01	none	The bus gain, from 0 to 1.
Effects	`effects`	list	none	Which of this bus's effects are on in this mix, one switch per slot of its chain, in order. A slot with no switch keeps what it had.

Music music section none The music bus.

Field	Script name	Kind	Default	What it does
Volume	`volume`	number, 0 to 1, step 0.01	none	The bus gain, from 0 to 1.
Effects	`effects`	list	none	Which of this bus's effects are on in this mix, one switch per slot of its chain, in order. A slot with no switch keeps what it had.

Sfx sfx section none Everything that is not music.

Field	Script name	Kind	Default	What it does
Volume	`volume`	number, 0 to 1, step 0.01	none	The bus gain, from 0 to 1.
Effects	`effects`	list	none	Which of this bus's effects are on in this mix, one switch per slot of its chain, in order. A slot with no switch keeps what it had.

Send Amounts send_amounts list none How much each of the mix's Sends carries in this mix, by row, from 0 to 1 as the row's own Amount. Leave a row out to keep the amount the Sends give it.

Ducking ducks list empty Rules that hold one bus down while another is loud.

Field	Script name	Kind	Default	What it does
Trigger	`trigger`	one of Master, Music, Sfx	none	The bus being listened to.
Target	`target`	one of Master, Music, Sfx	none	The bus being held down.
Threshold	`threshold_db`	number, -96 to 0, step 0.1	none	How loud the trigger has to get, in decibels relative to full scale.
Amount	`amount_db`	number, 0 to 96, step 0.1	none	How many decibels come off the target while the trigger is over.
Attack	`attack`	number, 0 to 5, step 0.001	none	How long the duck takes to come on, in seconds.
Release	`release`	number, 0 to 10, step 0.001	none	How long it takes to let go, in seconds.

Sends sends list empty Feeds some of one bus into another, after its own volume.

Field	Script name	Kind	Default	What it does
From	`from`	one of Master, Music, Sfx	none	The bus being tapped, after its own fader.
To	`to`	one of Master, Music, Sfx	none	The bus it feeds.
Amount	`amount`	number, 0 to 1, step 0.01	none	Fraction sent.