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

    Type Alias QuantumBand

    key value
    type object

    data structure for the Quantum compressor band

    type QuantumBand = {
        attackMs: PrimitiveField<number, "mut">;
        isCompressorActive: PrimitiveField<boolean, "mut">;
        isMuted: PrimitiveField<boolean, "mut">;
        isSoloed: PrimitiveField<boolean, "mut">;
        kneeDb: PrimitiveField<number, "mut">;
        makeupGainDb: PrimitiveField<number, "mut">;
        ratio: PrimitiveField<number, "mut">;
        releaseMs: PrimitiveField<number, "mut">;
        thresholdDb: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    attackMs: PrimitiveField<number, "mut">

    Attack time of the compressor band.

    key value
    default 5
    range [0, 1000]
    is api.TargetType.AutomatableParameter
    isCompressorActive: PrimitiveField<boolean, "mut">

    Whether the compressor is active for this band. If is_compressor_active is false, the compressor is disabled, but the frequency band is still added to the final signal.

    key value
    default true
    is api.TargetType.AutomatableParameter
    isMuted: PrimitiveField<boolean, "mut">

    Whether the compressor band is muted or not. If is_muted is true, the entire frequency band is muted.

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

    Whether the compressor band is soloed or not. If is_soloed is true, only bands with is_soloed true are audible.

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

    The width of the knee in decibels. A wider knee is a more rounded compression curve.

    key value
    default 3
    range [0, 24]
    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 band.

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

    Release time of the compressor band.

    key value
    default 50
    range [0, 1000]
    is api.TargetType.AutomatableParameter
    thresholdDb: PrimitiveField<number, "mut">

    Threshold at which the compressor band starts compressing, expressed in dB.

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