Class UnitySoundMixerEffectLoopDefinition

Unity ScriptableObject implementation of a registered AudioMixer effect-loop definition.
Created by the "Tools > Serenity > Audio > Create Audio Mixer Effect Loop" tool alongside the actual mixer group, this asset is the persistent, reusable record of a loop (e.g. EchoLoop) that runtime use cases / EventDispatcher signals resolve by Id.

Inheritance
object
UnitySoundMixerEffectLoopDefinition
Implements
Namespace: Serenity.SoundMixer.Installation.Settings
Assembly: Serenity.UnitySoundMixer.Installation.dll
Syntax
public class UnitySoundMixerEffectLoopDefinition : ScriptableObject, ISoundMixerEffectLoopDefinition, IFoundationSettings
Remarks

Runtime-only type (no UnityEditor dependency). The loop is the RECEIVE side of a Send/Receive routing pair; to use it, a source group adds a Send targeting this loop's Receive. Each source's Send level is the exposed parameter driven at runtime; the loop's own output level is a static mixer setting (a fixed return trim) and is not exposed or controlled at runtime.

Constructors

UnitySoundMixerEffectLoopDefinition()

Declaration
public UnitySoundMixerEffectLoopDefinition()

Fields

AudioMixer

Declaration
public AudioMixer AudioMixer
Field Value
Type Description
AudioMixer

The AudioMixer asset that owns the loop group.

AudioMixerName

Declaration
public string AudioMixerName
Field Value
Type Description
string

Name of the owning AudioMixer asset, retained for diagnostics/runtime matching.

DefaultWet

Declaration
public float DefaultWet
Field Value
Type Description
float

Default wet (Send/effect) amount, normalized 0..1. The dry amount is the complement (1 - wet).

Description

Declaration
public string Description
Field Value
Type Description
string

Optional human description of the loop.

DisplayName

Declaration
public string DisplayName
Field Value
Type Description
string

Human-readable name shown in tooling.

EffectNames

Declaration
public List<string> EffectNames
Field Value
Type Description
List<string>

Ordered internal effect names created inside the loop (for editor/debug visibility).

Guid

Declaration
public string Guid
Field Value
Type Description
string

Global unique identifier for this definition instance.

Id

Declaration
public string Id
Field Value
Type Description
string

Unique identifier (key) used by use cases and events to resolve this loop.

LoopGroupName

Declaration
public string LoopGroupName
Field Value
Type Description
string

Name of the generated loop mixer group (e.g. "EchoLoop").

ReceiveEffectName

Declaration
public string ReceiveEffectName
Field Value
Type Description
string

Internal name of the Receive effect at the head of the loop chain.

Sources

Declaration
public List<UnitySoundMixerEffectLoopSource> Sources
Field Value
Type Description
List<UnitySoundMixerEffectLoopSource>

Source-group routes: bind each source group (e.g. "Music") to the exposed AudioMixer parameter names used to apply this loop from that source (its Attenuation and its Send into the loop). This is what lets actions reference only an effect-loop id and a source group name.

Implements