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

    Type Alias Quantum

    key value
    type entity
    key "quantum"
    is

    The Quantum device, a multi-band compressor. It's essentially a band splitter, then a compressor for each band, then a merger.

    type Quantum = {
        audioInput: NexusObject<Empty>;
        audioOutput: NexusObject<Empty>;
        bands: ArrayField<NexusObject<QuantumBand>, 4>;
        displayName: PrimitiveField<string, "mut">;
        gainDb: PrimitiveField<number, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
        rmsWindowMs: PrimitiveField<number, "mut">;
        spectrumModeIndex: PrimitiveField<number, "mut">;
        splitFrequencyHz: ArrayField<PrimitiveField<number, "mut">, 3>;
    }
    Index

    Properties

    audioInput audioOutput bands displayName gainDb isActive positionX positionY rmsWindowMs spectrumModeIndex splitFrequencyHz

    Properties

    audioInput: NexusObject<Empty>

    Audio Input.

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

    Single Output.

    key value
    is api.TargetType.AudioOutput
    bands: ArrayField<NexusObject<QuantumBand>, 4>

    Compressor bands.

    displayName: PrimitiveField<string, "mut">

    The user-assigned name of this device.

    gainDb: PrimitiveField<number, "mut">

    Gain of the compressor.

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

    Allows adjustment of the duration of the window during which the signal peak is detected that triggers the compressors, in milliseconds. If this is 0, the compressor will trigger on the first peak sample.

    key value
    default 5
    range [0, 30]
    is api.TargetType.AutomatableParameter
    spectrumModeIndex: PrimitiveField<number, "mut">

    Selects the spectrum mode of the quantum. 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 compression is applied
    • 3: Post - the spectrum is displayed after the compression is applied
    key value
    default 2
    range [1, 3]
    splitFrequencyHz: ArrayField<PrimitiveField<number, "mut">, 3>

    The frequencies that split the different frequency bands for the band splitter. There are 4 frequency bands, thus 3 split points.

    These frequencies should be ordered in magnitude. If they aren't, then the different bands might overlap or not produce any sound at all.

    key value
    default 20
    range [20, 20000]

    Settings

    Member Visibility

    On This Page

    Properties