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

    Type Alias StompboxCrusher

    key value
    type entity
    key "stompboxCrusher"
    is

    A bitcrusher in the form of a stompbox.

    type StompboxCrusher = {
        audioInput: NexusObject<Empty>;
        audioOutput: NexusObject<Empty>;
        bits: PrimitiveField<number, "mut">;
        displayName: PrimitiveField<string, "mut">;
        downsamplingFactor: PrimitiveField<number, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        mix: PrimitiveField<number, "mut">;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
        postGain: PrimitiveField<number, "mut">;
        preGain: 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
    bits: PrimitiveField<number, "mut">

    Bit depth of the signal. Lower bit depth results in more distortion.

    key value
    default 8
    range [1, 24]
    is api.TargetType.AutomatableParameter
    displayName: PrimitiveField<string, "mut">

    The user-assigned name of this device.

    downsamplingFactor: PrimitiveField<number, "mut">

    How much the signal is downsampled - higher values result in more noisy output.

    key value
    default 0
    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 how much of the processed signal is mixed with the original, unprocessed signal. 0 = 100% dry signal, 1 = 100% wet signal

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

    Allows control over the volume of the signal once it has been processed. Gain factors, equivalent to a dB range of [-inf, 9.0]. Default is unit gain.

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

    Allows for adjustment of the volume of the signal before it is processed. Equivalent to a dB range of [-inf, 27.0].

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