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

    Type Alias MixerCompressor

    key value
    type object

    Compressor for channel and group strips. This is not an entity but a submessage used by other strips.

    type MixerCompressor = {
        attackMs: PrimitiveField<number, "mut">;
        detectionModeIndex: PrimitiveField<number, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        makeupGainDb: PrimitiveField<number, "mut">;
        ratio: PrimitiveField<number, "mut">;
        releaseMs: PrimitiveField<number, "mut">;
        sideChainInput: NexusObject<Empty>;
        thresholdDb: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    attackMs detectionModeIndex isActive makeupGainDb ratio releaseMs sideChainInput thresholdDb

    Properties

    attackMs: PrimitiveField<number, "mut">

    Attack speed of the compressor.

    key value
    default 15
    range [0.0010000000474974513, 200]
    is api.TargetType.AutomatableParameter
    detectionModeIndex: PrimitiveField<number, "mut">

    Selects the compressor detection mode.

    • 0: invalid
    • 1: Rms
    • 2: Peak
    key value
    default 1
    range [1, 2]
    is api.TargetType.AutomatableParameter
    isActive: PrimitiveField<boolean, "mut">

    Whether the compressor is active or not. If is_active=false, the compressor is bypassed.

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

    Makeup gain applied to the signal after compression.

    key value
    default 0
    range [-24, 24]
    is api.TargetType.AutomatableParameter
    ratio: PrimitiveField<number, "mut">

    Ratio of the compressor.

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

    Release speed of the compressor.

    key value
    default 100
    range [0.0010000000474974513, 2000]
    is api.TargetType.AutomatableParameter
    sideChainInput: NexusObject<Empty>

    Side chain input for this compressor.

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

    Threshold decibels of the compressor.

    key value
    default -10
    range [-48, 0]
    is api.TargetType.AutomatableParameter

    Settings

    Member Visibility

    On This Page

    Properties