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

    Type Alias StompboxCompressor

    key value
    type entity
    key "stompboxCompressor"
    is

    A simple compressor in the form of a stompbox.

    type StompboxCompressor = {
        attackMs: PrimitiveField<number, "mut">;
        audioInput: NexusObject<Empty>;
        audioOutput: NexusObject<Empty>;
        detectionModeIndex: PrimitiveField<number, "mut">;
        displayName: PrimitiveField<string, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        makeupGainDb: PrimitiveField<number, "mut">;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
        ratio: PrimitiveField<number, "mut">;
        releaseMs: PrimitiveField<number, "mut">;
        sideChainInput: NexusObject<Empty>;
        thresholdDb: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    attackMs audioInput audioOutput detectionModeIndex displayName isActive makeupGainDb positionX positionY ratio releaseMs sideChainInput thresholdDb

    Properties

    attackMs: PrimitiveField<number, "mut">

    Attack speed of the compressor.

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

    Primary Input.

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

    Single Output.

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

    Selects the compressor detection mode.

    • 0: invalid
    • 1: moving average
    • 2: peak
    key value
    default 1
    range [1, 2]
    is api.TargetType.AutomatableParameter
    displayName: PrimitiveField<string, "mut">

    The user-assigned name of this device.

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

    Makeup gain applied to the signal after compression.

    key value
    default 0
    range [-12, 12]
    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
    ratio: PrimitiveField<number, "mut">

    Ratio of the compressor.

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

    Release speed of the compressor.

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

    Side Chain Input.

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

    Threshold above which compression kicks in.

    key value
    default -15
    range [-24, 0]
    is api.TargetType.AutomatableParameter

    Settings

    Member Visibility

    On This Page

    Properties