logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class SoundMixerApplyEffectLoopInput

    Data Transfer Object describing a request to apply a registered SoundMixer effect loop to a source group/channel at runtime.
    Callers express only INTENT: which effect loop, applied to which source group. The service resolves the Unity exposed-parameter names (source Attenuation, source Send, loop output Attenuation) from the effect-loop definition's configured routes — no AudioMixer parameter names appear here.

    Inheritance
    object
    SoundMixerApplyEffectLoopInput
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Serenity.SoundMixer.Application.DTO
    Assembly: Serenity.SoundMixer.Application.dll
    Syntax
    public class SoundMixerApplyEffectLoopInput
    Remarks

    Wet/Dry are OPTIONAL normalized (0..1) overrides; when null, the service uses the definition's default wet/dry. They are normalized values the service converts to dB and applies to the resolved routing parameters — there are no independent "wet"/"dry" mixer parameters.

    Constructors

    SoundMixerApplyEffectLoopInput(string, string, float?, float?, float, bool)

    Initializes a new instance of the SoundMixerApplyEffectLoopInput class.

    Declaration
    public SoundMixerApplyEffectLoopInput(string effectLoopId, string sourceGroupName, float? wet = null, float? dry = null, float fadeDuration = 0, bool restorePreviousState = true)
    Parameters
    Type Name Description
    string effectLoopId

    Id of the registered effect loop definition.

    string sourceGroupName

    Logical source group/channel applying the loop.

    float? wet

    Optional normalized wet override (clamped to 0..1); null uses the definition default.

    float? dry

    Optional normalized dry override (clamped to 0..1); null uses the definition default.

    float fadeDuration

    Fade duration in seconds (clamped to >= 0).

    bool restorePreviousState

    Whether to capture previous values for later restore (default true).

    Fields

    Dry

    Declaration
    public float? Dry
    Field Value
    Type Description
    float?

    Optional normalized dry override in 0..1. When null, the definition's default dry is used.

    EffectLoopId

    Declaration
    public string EffectLoopId
    Field Value
    Type Description
    string

    Id/key of the registered effect loop definition to apply.

    FadeDuration

    Declaration
    public float FadeDuration
    Field Value
    Type Description
    float

    Requested fade duration in seconds (>= 0). See service notes for current support level.

    RestorePreviousState

    Declaration
    public bool RestorePreviousState
    Field Value
    Type Description
    bool

    When true, previous mixer values are captured so they can be restored on clear.

    SourceGroupName

    Declaration
    public string SourceGroupName
    Field Value
    Type Description
    string

    Logical source group/channel to apply the loop from (e.g. "Music", "SFX", "Voice").

    Wet

    Declaration
    public float? Wet
    Field Value
    Type Description
    float?

    Optional normalized wet override in 0..1. When null, the definition's default wet is used.

    In this article
    © 2026 Serenity. All Rights Reserved