logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class CreateAudioMixerEffectLoopOutput

    Editor-only result of an effect-loop creation attempt.
    The creator NEVER throws to the UI: failures (including internal-API/reflection errors) are reported here with Success = false and a populated ErrorMessage so the window can surface them clearly instead of failing silently.

    Inheritance
    object
    CreateAudioMixerEffectLoopOutput
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Serenity.SoundMixer.Infrastructure.AudioMixerEffectLoop.Editor.dto
    Assembly: Serenity.UnitySoundMixer.Infrastructure.Editor.dll
    Syntax
    public class CreateAudioMixerEffectLoopOutput

    Fields

    CreatedEffectOrder

    The final effect chain in created order, e.g. [ "Receive", "Echo", "Lowpass", "Attenuation" ]. Empty on failure.

    Declaration
    public readonly IReadOnlyList<string> CreatedEffectOrder
    Field Value
    Type Description
    IReadOnlyList<string>

    ErrorMessage

    Human-readable failure reason when Success is false; null otherwise.

    Declaration
    public readonly string ErrorMessage
    Field Value
    Type Description
    string

    ResolvedLoopName

    The name the group was actually created with. May differ from the requested name when a duplicate existed and the creator resolved it (e.g. "EchoLoop" -> "EchoLoop_1").

    Declaration
    public readonly string ResolvedLoopName
    Field Value
    Type Description
    string

    Success

    True when the loop group and its full effect chain were created and persisted.

    Declaration
    public readonly bool Success
    Field Value
    Type Description
    bool

    Warnings

    Non-fatal warnings worth surfacing (e.g. effect-name list came from the fallback).

    Declaration
    public readonly IReadOnlyList<string> Warnings
    Field Value
    Type Description
    IReadOnlyList<string>

    Methods

    Fail(string)

    Builds a failed result carrying a clear, user-facing message.

    Declaration
    public static CreateAudioMixerEffectLoopOutput Fail(string errorMessage)
    Parameters
    Type Name Description
    string errorMessage
    Returns
    Type Description
    CreateAudioMixerEffectLoopOutput

    Ok(string, IReadOnlyList<string>, IReadOnlyList<string>)

    Builds a successful result.

    Declaration
    public static CreateAudioMixerEffectLoopOutput Ok(string resolvedLoopName, IReadOnlyList<string> createdEffectOrder, IReadOnlyList<string> warnings)
    Parameters
    Type Name Description
    string resolvedLoopName
    IReadOnlyList<string> createdEffectOrder
    IReadOnlyList<string> warnings
    Returns
    Type Description
    CreateAudioMixerEffectLoopOutput
    In this article
    © 2026 Serenity. All Rights Reserved