@audiotool/nexus - v0.0.12
    Preparing search index...

    Type Alias StompboxDelay

    key value
    type entity
    key "stompboxDelay"
    is

    A simple delay effect in the form of a stompbox.

    The effective delay time is step_count*step_length.

    type StompboxDelay = {
        audioInput: NexusObject<Empty>;
        audioOutput: NexusObject<Empty>;
        displayName: PrimitiveField<string, "mut">;
        feedbackFactor: PrimitiveField<number, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        mix: PrimitiveField<number, "mut">;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
        stepCount: PrimitiveField<number, "mut">;
        stepLengthIndex: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    audioInput: NexusObject<Empty>

    Single Input.

    key value
    is api.TargetType.AudioInput
    audioOutput: NexusObject<Empty>

    Single Output.

    key value
    is api.TargetType.AudioOutput
    displayName: PrimitiveField<string, "mut">

    The user-assigned name of this device.

    feedbackFactor: PrimitiveField<number, "mut">

    How much of the original signal is fed back into the delay line.

    key value
    default 0.4000000059604645
    range [0, 1]
    is api.TargetType.AutomatableParameter
    isActive: PrimitiveField<boolean, "mut">

    Whether the stompbox is active or not. When is_active=false, audio signal bypasses the device

    key value
    default true
    is api.TargetType.AutomatableParameter
    mix: PrimitiveField<number, "mut">

    Controls the mix between the incoming and the effect signal. 0 ("dry") means 0% effect applied, 1 ("wet") means 100% effect applied; values between mixes the two linearly.

    key value
    default 0.20000000298023224
    range [0, 1]
    is api.TargetType.AutomatableParameter
    positionX: PrimitiveField<number, "mut">

    X position on the desktop in the DAW.

    key value
    default 0
    range full
    positionY: PrimitiveField<number, "mut">

    Y position on the desktop in the DAW.

    key value
    default 0
    range full
    stepCount: PrimitiveField<number, "mut">

    Count of delay steps.

    key value
    default 3
    range [1, 7]
    is api.TargetType.AutomatableParameter
    stepLengthIndex: PrimitiveField<number, "mut">

    Selects the length of each delay step as bar time.

    • 0: invalid
    • 1: 1/16 bars
    • 2: 1/8T bars
    • 3: 1/8 bars
    key value
    default 1
    range [1, 3]
    is api.TargetType.AutomatableParameter