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

    Type Alias StompboxPhaser

    key value
    type entity
    key "stompboxPhaser"
    is

    data structure for the stompbox phaser

    type StompboxPhaser = {
        audioInput: NexusObject<Empty>;
        audioOutput: NexusObject<Empty>;
        displayName: PrimitiveField<string, "mut">;
        feedbackFactor: PrimitiveField<number, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        lfoFrequencyHz: PrimitiveField<number, "mut">;
        maxFrequencyHz: PrimitiveField<number, "mut">;
        minFrequencyHz: PrimitiveField<number, "mut">;
        mix: PrimitiveField<number, "mut">;
        positionX: PrimitiveField<number, "mut">;
        positionY: 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.

    feedbackFactor: PrimitiveField<number, "mut">

    Defines how much of the processed signal is feed back into the effect.

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

    Allows adjustment of the speed of the phasing effect.

    key value
    default 0.6000000238418579
    range [0.03999999910593033, 5]
    is api.TargetType.AutomatableParameter
    maxFrequencyHz: PrimitiveField<number, "mut">

    Allow for a frequency range to be set for the effect. Only frequencies between the min and max will be affected.

    key value
    default 3000
    range [300, 8000]
    is api.TargetType.AutomatableParameter
    minFrequencyHz: PrimitiveField<number, "mut">

    Allow for a frequency range to be set for the effect. Only frequencies between the min and max will be affected.

    key value
    default 240
    range [30, 300]
    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.

    Note: 100% here means maximum audible effect, unlike some physical phasers.

    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