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

    Type Alias StompboxSlope

    key value
    type entity
    key "stompboxSlope"
    is

    The slope filter is a multi-mode filter without envelope, with lowpass, highpass, notch, and bandpass modes. The notch & bandpass filters are implemented as a low and high pass filter in parallel or series, respectively.

    type StompboxSlope = {
        audioInput: NexusObject<Empty>;
        audioOutput: NexusObject<Empty>;
        bandWidthHz: PrimitiveField<number, "mut">;
        displayName: PrimitiveField<string, "mut">;
        filterModeIndex: PrimitiveField<number, "mut">;
        frequencyHz: PrimitiveField<number, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        mix: PrimitiveField<number, "mut">;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
        resonanceFactor: 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
    bandWidthHz: PrimitiveField<number, "mut">

    The spacing in hertz between the low and high pass filters. Only has an effect for notch and bandpass modes. This effectively controls the bandwidth of the bandpass/notch filter.

    key value
    default 0
    range [-500, 500]
    is api.TargetType.AutomatableParameter
    displayName: PrimitiveField<string, "mut">

    The user-assigned name of this device.

    filterModeIndex: PrimitiveField<number, "mut">

    Selects the filter mode of the slope.

    • 0: invalid
    • 1: Lowpass a single lowpass filter
    • 2: Highpass a single highpass filter
    • 3: Notch a low and high pass filter in parallel
    • 4: Bandpass a low and high pass filter in series
    key value
    default 1
    range [1, 4]
    is api.TargetType.AutomatableParameter
    frequencyHz: PrimitiveField<number, "mut">

    The cut-off frequency of the filter.

    key value
    default 300
    range [18, 10000]
    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 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
    resonanceFactor: PrimitiveField<number, "mut">

    The resonance of the filter. 0 means no resonance, 1 means maximum resonance. No unit.

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