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

    Type Alias SpaceLFO

    key value
    type object

    The Space's LFO parameters.

    type SpaceLFO = {
        doesRetrigger: PrimitiveField<boolean, "mut">;
        isSynced: PrimitiveField<boolean, "mut">;
        phaseOffset: PrimitiveField<number, "mut">;
        rateNormalized: PrimitiveField<number, "mut">;
        waveformIndex: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    doesRetrigger: PrimitiveField<boolean, "mut">

    If this is true, the LFO retriggers for every incoming note. Otherwise it starts at project time 0.

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

    Whether rate_normalized is synced to the project tempo or not.

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

    The LFO's phase offset.

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

    The rate of the LFO, expressed as a normalized value. The meaning of the value depends on the is_synced flag:

    • if is_synced is false, the value maps linearly to Hz (0.01 .. 500.0).
    • if is_synced is true, then the value is quantized to one of 30 bar time durations. The bar time durations are: 1/256, 1/192, 1/128, 1/96, 1/64, 1/48, 1/32, 1/24, 1/16, 1/12, 1/8, 1/6, 3/16, 1/4, 5/16, 1/3, 3/8, 7/16, 1/2, 9/16, 7/12, 5/8, 2/3, 3/4, 5/6, 7/8, 1/1, 2/1, 3/1, 4/1.
    key value
    default 0.25
    range [0, 1]
    is api.TargetType.AutomatableParameter
    waveformIndex: PrimitiveField<number, "mut">

    Selects the waveform of the lfo.

    • 0: invalid
    • 1: Sine
    • 2: Triangle
    • 3: Sawtooth Up
    • 4: Square
    • 5: Random
    key value
    default 1
    range [1, 5]
    is api.TargetType.AutomatableParameter