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

    Type Alias StompboxGate

    key value
    type entity
    key "stompboxGate"
    is

    A gate effect in the form of a stompbox.s

    type StompboxGate = {
        attackMs: PrimitiveField<number, "mut">;
        audioInput: NexusObject<Empty>;
        audioOutput: NexusObject<Empty>;
        displayName: PrimitiveField<string, "mut">;
        holdMs: PrimitiveField<number, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        isInverted: PrimitiveField<boolean, "mut">;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
        postGain: PrimitiveField<number, "mut">;
        releaseMs: PrimitiveField<number, "mut">;
        sideChainInput: NexusObject<Empty>;
        thresholdGain: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    attackMs audioInput audioOutput displayName holdMs isActive isInverted positionX positionY postGain releaseMs sideChainInput thresholdGain

    Properties

    attackMs: PrimitiveField<number, "mut">

    Sets the amount of time for the Gate to change from open to closed, can give the effect of the sound fading in.

    key value
    default 10
    range [1, 100]
    is api.TargetType.AutomatableParameter
    audioInput: NexusObject<Empty>

    Primary 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.

    holdMs: PrimitiveField<number, "mut">

    Allows definition of the amount of time the Gate will stay open after the signal falls below the given threshold.

    key value
    default 100
    range [0.009999999776482582, 2000]
    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
    isInverted: PrimitiveField<boolean, "mut">

    Selects the gate mode whether it is inverse or not. By default, the gate effect is off and can be triggered to turn on. If inverted, the gate is on (the signal off) by default and can be triggered to turn off.

    key value
    default false
    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
    postGain: PrimitiveField<number, "mut">

    Gain applied to the signal after the effect. Equivalent to a dB range of [-inf, 9.0].

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

    Sets the amount of time the Gate takes to go from closed to open. A fast release will abruptly cut of the sound once it has fallen below the given threshold, a slower release will smoothly change from closed to open much like a slow fade out.

    key value
    default 50
    range [10, 600]
    is api.TargetType.AutomatableParameter
    sideChainInput: NexusObject<Empty>

    Side Chain Input.

    key value
    is api.TargetType.AudioInput
    thresholdGain: PrimitiveField<number, "mut">

    Threshold of the gate, any signals with gain levels below the the threshold will be muted.

    key value
    default 0.6665999889373779
    range [0, 1]
    is api.TargetType.AutomatableParameter

    Settings

    Member Visibility

    On This Page

    Properties