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

    Type Alias GraphicalEQ

    key value
    type entity
    key "graphicalEQ"
    is

    The GraphicalEQ is an equalizer with two parametric peak filters.

    Each filter has a special parameter "panning" that results in the filter gain of the left channel to be the mirror of the right.

    type GraphicalEQ = {
        audioInput: NexusObject<Empty>;
        audioOutput: NexusObject<Empty>;
        displayName: PrimitiveField<string, "mut">;
        filter1: NexusObject<GraphicalEQFilter>;
        filter2: NexusObject<GraphicalEQFilter>;
        gainDb: PrimitiveField<number, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        mix: PrimitiveField<number, "mut">;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    audioInput: NexusObject<Empty>

    Audio input.

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

    Audio output.

    key value
    is api.TargetType.AudioOutput
    displayName: PrimitiveField<string, "mut">

    The user-assigned name of this device.

    The first peak filter. In the DAW UI, parameters are shown to the left.

    The second peak filter. In the DAW UI, parameters are shown to the right.

    gainDb: PrimitiveField<number, "mut">

    Gain applied to the signal after equalization.

    key value
    default 0
    range [-18, 18]
    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