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

    Type Alias Waveshaper

    key value
    type entity
    key "waveshaper"
    is api.TargetType.Waveshaper

    The waveshaper is a distortion effect that allows to remap the amplitude of the incoming signal according to a curve defined by a series of anchors.

    The mix factor can be modulated by an envelope that's triggered by the peak of the main incoming signal or a side-chain signal.

    The curve of the waveshaper is defined by a series of anchors that mark points on the plane spanned by (0, 0) and (1, 1). To draw the curve, sort all anchors by x-coordinate and then connect them with lines such that line between p1 and p2 are sloped with the slope parameter of anchor p2.

    There are two implicit anchors:

    • one at (0, 0) where the curve starts
    • one at (1, y) where the curve ends, sloped with "final_slope" field. where y is the "final_y" field.

    This is to make sure the curve always starts at (0, 0) and ends at (1, 1), and that the curve can be sloped even if no anchor is present.

    type Waveshaper = {
        attackMs: PrimitiveField<number, "mut">;
        audioInput: NexusObject<Empty>;
        audioOutput: NexusObject<Empty>;
        autoDrive: PrimitiveField<number, "mut">;
        displayName: PrimitiveField<string, "mut">;
        finalSlope: PrimitiveField<number, "mut">;
        finalY: PrimitiveField<number, "mut">;
        invertEnvelope: PrimitiveField<boolean, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        mix: PrimitiveField<number, "mut">;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
        preGain: PrimitiveField<number, "mut">;
        releaseMs: PrimitiveField<number, "mut">;
        sideChainInput: NexusObject<Empty>;
        thresholdGain: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    attackMs: PrimitiveField<number, "mut">

    The attack time of the envelope influencing the mix factor.

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

    Single Input

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

    Single Output

    key value
    is api.TargetType.AudioOutput
    autoDrive: PrimitiveField<number, "mut">

    The amount that the envelope influences the mix factor. 0 means no influence, 1 means full influence.

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

    The user-assigned name of this device.

    finalSlope: PrimitiveField<number, "mut">

    The slope of the implicit anchor at (1, final_y), see message documentation for more details.

    key value
    default 0
    range [-1, 1]
    finalY: PrimitiveField<number, "mut">

    The y-coordinate of the implicit anchor at (1, final_y), see message documentation for more details.

    key value
    default 1
    range [0, 1]
    invertEnvelope: PrimitiveField<boolean, "mut">

    Whether to invert the auto envelope. If invert_envelope=true, then the envelope is by default "on" (mix is reduced), and can be turned off when triggered.

    key value
    default false
    is api.TargetType.AutomatableParameter
    isActive: PrimitiveField<boolean, "mut">

    Whether the device 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
    preGain: PrimitiveField<number, "mut">

    Allow adjustment of the volume of the signal before it is processed 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">

    The release time of the envelope influencing the mix factor.

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

    Side Chain Input

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

    The gain threshold above which the envelope is triggered/released. Equivalent to a dB range of [-inf, 9.0].

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