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

    Type Alias Curve

    key value
    type entity
    key "curve"
    is

    The curve is a graphical equalizer that has 7 band eqs:

    • 1 low pass
    • 1 low shelf
    • 3 fully parametric peak filters
    • 1 high pass
    • 1 high shelf
    type Curve = {
        audioInput: NexusObject<Empty>;
        audioOutput: NexusObject<Empty>;
        displayName: PrimitiveField<string, "mut">;
        gainDb: PrimitiveField<number, "mut">;
        highPass: NexusObject<CurvePass>;
        highShelf: NexusObject<CurveShelf>;
        isActive: PrimitiveField<boolean, "mut">;
        lowPass: NexusObject<CurvePass>;
        lowShelf: NexusObject<CurveShelf>;
        peak1: NexusObject<CurvePeak>;
        peak2: NexusObject<CurvePeak>;
        peak3: NexusObject<CurvePeak>;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
        spectrumModeIndex: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    audioInput audioOutput displayName gainDb highPass highShelf isActive lowPass lowShelf peak1 peak2 peak3 positionX positionY spectrumModeIndex

    Properties

    audioInput: NexusObject<Empty>

    Audio 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.

    gainDb: PrimitiveField<number, "mut">

    Gain applied to the signal after equalization.

    key value
    default 0
    range [-24, 24]
    is api.TargetType.AutomatableParameter
    highPass: NexusObject<CurvePass>

    The high pass filter.

    highShelf: NexusObject<CurveShelf>

    The high shelf filter.

    isActive: PrimitiveField<boolean, "mut">

    Whether the equalizer is active or not. When is_active=false, audio signal bypasses the device

    key value
    default true
    is api.TargetType.AutomatableParameter
    lowPass: NexusObject<CurvePass>

    The low pass filter.

    lowShelf: NexusObject<CurveShelf>

    The low shelf filter.

    peak1: NexusObject<CurvePeak>

    The first peak filter.

    peak2: NexusObject<CurvePeak>

    The second peak filter.

    peak3: NexusObject<CurvePeak>

    The third peak filter.

    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
    spectrumModeIndex: PrimitiveField<number, "mut">

    Selects the spectrum mode of the equalizer. This only affects the visual representation in the DAW.

    • 0: invalid
    • 1: Off - no spectrum is displayed
    • 2: Pre - the spectrum is displayed before the equalizer is applied
    • 3: Post - the spectrum is displayed after the equalizer is applied
    key value
    default 1
    range [1, 3]

    Settings

    Member Visibility

    On This Page

    Properties