Api Sandbox Audio Mixer
class

Mixer

public class Mixer

Takes a bunch of sound, changes its volumes, mixes it together, outputs it

Properties

Name Type Description
ChildCount Int32
Meter AudioMeter Allows monitoring of the output of the mixer
Id Guid Unique identifier for this object, for lookup, deserialization etc
Name String The display name for this mixer
Volume Single Scale the volume of our output by this amount
MaxVoices Int32 The maximum amount of voices to play at one time on this mixer
OverrideOcclusion Boolean If true then this mixer will use custom occlusion tags. If false we'll use what our parent uses.
OcclusionTags TagSet The tags which occlude our physics
Spacializing Single When 0 the sound will come out of all speakers, when 1 it will be fully spacialized
DistanceAttenuation Single Sounds get quieter as they go further away
Occlusion Single How much these sounds can get occluded
AirAbsorption Single How much the air absorbs energy from the sound
Solo Boolean Should this be the only mixer that is heard?
Mute Boolean Is this mixer muted?
IsMaster Boolean The default mixer gets all sounds that don't have a mixer specifically assigned
Master static Mixer
Default static Mixer
ProcessorCount Int32 The amount of processors

Methods

Mixer AddChild()
Void Destroy()
Mixer[] GetChildren()
IReadOnlySet<UInt32> GetOcclusionTags()

Get an array of occlusion tags our sounds want to hit. May return null if there are none defined!

Void StopAll(Single fade)

Stop all sound handles using this mixer

static Void ResetToDefault()
static Mixer FindMixerByName(String name)
static Mixer FindMixerByGuid(Guid guid)
Void AddProcessor(AudioProcessor ap)

Add a processor to the list

Void ClearProcessors()

Add a processor to the list

Void RemoveProcessor(AudioProcessor ap)

Add a processor to the list

AudioProcessor[] GetProcessors()

Get the current processor list

T GetProcessor()

Get the first processor of a specific type, or null if not found

JsonObject Serialize()
Void Deserialize(JsonObject js, TypeLibrary typeLibrary)
Assembly: Sandbox.Engine Namespace: Sandbox.Audio Full Name: Sandbox.Audio.Mixer