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

    Type Alias HeisenbergPitchEnvelope

    key value
    type object

    The Heisenberg pitch envelope is a ADSR envelope that controls the pitch detune of the notes played. The enveloped can be toggled on or off on each operator using the use_pitch_envelope flag. If active, the pitch envelope detunes each incoming note's pitch by a certain factor.

    type HeisenbergPitchEnvelope = {
        attackRangeFactor: PrimitiveField<number, "mut">;
        attackSlopeFactor: PrimitiveField<number, "mut">;
        attackTimeNormalized: PrimitiveField<number, "mut">;
        decayRangeFactor: PrimitiveField<number, "mut">;
        decaySlopeFactor: PrimitiveField<number, "mut">;
        decayTimeNormalized: PrimitiveField<number, "mut">;
        isSynced: PrimitiveField<boolean, "mut">;
        loopDecayIndex: PrimitiveField<number, "mut">;
        releaseRangeFactor: PrimitiveField<number, "mut">;
        releaseSlopeFactor: PrimitiveField<number, "mut">;
        releaseTimeNormalized: PrimitiveField<number, "mut">;
        semitoneRange: PrimitiveField<number, "mut">;
        sustainRangeFactor: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    attackRangeFactor: PrimitiveField<number, "mut">

    The value of the attack phase of the envelope. The amount detuned is this factor multiplied by the semitone value below.

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

    Controls how much the attack phase is bent. 0 is linear, more or less means more or less sloping.

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

    The attack time of the pitch envelope, 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 milliseconds (1.0 .. 10_000.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.5
    range [0, 1]
    is api.TargetType.AutomatableParameter
    decayRangeFactor: PrimitiveField<number, "mut">

    The value of the decay phase of the envelope. The amount detuned is this factor multiplied by the semitone value below.

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

    Controls how much the decay phase is bent. 0 is linear, more or less means more or less sloping.

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

    The decay time of the pitch envelope, 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 milliseconds (1.0 .. 10_000.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.5
    range [0, 1]
    is api.TargetType.AutomatableParameter
    isSynced: PrimitiveField<boolean, "mut">

    Wether the pitch envelope is in time sync or not. This affects the meaning of the time values below.

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

    If enabled, the decay phase of the envelope will loop. Looping means playing the decay phase "back and forth".

    • 0: invalid
    • 1: Off
    • 2: Gate loops the decay phase until the note is released; then it loops until the end of the currently playing decay phase, then enters the release phase and stops.
    • 3: Infinity the decay phase will loop forever.
    key value
    default 1
    range [1, 3]
    is api.TargetType.AutomatableParameter
    releaseRangeFactor: PrimitiveField<number, "mut">

    The value the release phase ends at. The amount detuned is this factor multiplied by the semitone value below.

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

    Controls how much the release phase is bent. 0 is linear, more or less means more or less sloping.

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

    The release time of the pitch envelope, 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 milliseconds (1.0 .. 10_000.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.5
    range [0, 1]
    is api.TargetType.AutomatableParameter
    semitoneRange: PrimitiveField<number, "mut">

    The semitone value of the pitch envelope. This is the semitone value that is used to detune the notes played. The different envelope phases use this value to calculate the amount detuned.

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

    Sustain phase of the envelope. The amount detuned is this factor multiplied by the semitone value below.

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