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

    Type Alias StompboxTube

    key value
    type entity
    key "stompboxTube"
    is

    The tube effect is a distortion effect that simulates the sound of a tube amp in the form of a stompbox.

    type StompboxTube = {
        audioInput: NexusObject<Empty>;
        audioOutput: NexusObject<Empty>;
        displayName: PrimitiveField<string, "mut">;
        drive: PrimitiveField<number, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
        postGain: PrimitiveField<number, "mut">;
        tone: 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.

    drive: PrimitiveField<number, "mut">

    Allows adjustment of the how much distortion is applied to the original signal.

    key value
    default 12
    range [0.10000000149011612, 12]
    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
    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">

    This device's output gain. Equivalent to a dB range of [-inf, 6.0].

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

    Acts as a hi-pass filter for the overtone spectrum.

    key value
    default 0
    range [-10, 10]
    is api.TargetType.AutomatableParameter