logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class SoundMixerClearEffectLoopInput

    Data Transfer Object describing a request to clear (deactivate) a previously applied SoundMixer effect loop from a source group/channel, optionally restoring the captured previous mixer values.

    Inheritance
    object
    SoundMixerClearEffectLoopInput
    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 SoundMixerClearEffectLoopInput

    Constructors

    SoundMixerClearEffectLoopInput(string, string, float, bool)

    Initializes a new instance of the SoundMixerClearEffectLoopInput class.

    Declaration
    public SoundMixerClearEffectLoopInput(string effectLoopId, string sourceGroupName, 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 the loop was applied from.

    float fadeDuration

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

    bool restorePreviousState

    Whether to restore captured previous values (default true).

    Fields

    EffectLoopId

    Declaration
    public string EffectLoopId
    Field Value
    Type Description
    string

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

    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, the previously captured mixer values are restored.

    SourceGroupName

    Declaration
    public string SourceGroupName
    Field Value
    Type Description
    string

    Logical source group/channel the loop was applied from (matches the apply request).

    In this article
    © 2026 Serenity. All Rights Reserved