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

    Type Alias Heisenberg

    key value
    type entity
    key "heisenberg"
    is api.TargetType.NoteTrackPlayer

    data structure for the Heisenberg FM synth

    Index

    Properties

    audioOutput: NexusObject<Empty>

    Single Output.

    key value
    is api.TargetType.AudioOutput
    displayName: PrimitiveField<string, "mut">

    The user-assigned name of this device.

    The "env 1" envelope of the Heisenberg. Can be assigned to individual operators inside the operator message.

    The "env 2" envelope of the Heisenberg. Can be assigned to individual operators inside the operator message.

    envelopeMain: NexusObject<AdsrEnvelope>

    The "main" envelope of the Heisenberg. Is always applied to the entire synth's gain, but can also be assigned to individual operators inside the operator message.

    The Heisenberg filter configuration.

    gain: PrimitiveField<number, "mut">

    Gain of the synthesizer. Equivalent to a dB range of [-inf, 0.0].

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

    Glide time controls the duration that a note's pitch "glides" to the next note once played. When in Mono or Legato mode, notes will glide if they overlap; in Polyphone mode, notes will glide if they don't overlap.

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

    Whether the device is active or not. When is_active=false, the heisenberg is silent.

    key value
    default true
    is api.TargetType.AutomatableParameter

    The first LFO of the Heisenberg. Can be assigned to the individual operators inside the operator message.

    The second LFO of the Heisenberg. Can be assigned to the individual operators inside the operator message.

    microTuning: PrimitiveField<NexusLocation, "mut">

    Micro tuning.

    key value
    default empty location
    required false
    targets api.TargetType.MicroTuning, meaning one of:
    entities.MicroTuningOctave
    notesInput: NexusObject<Empty>

    Notes Input.

    key value
    is api.TargetType.NotesInput

    Operator "A" of the Heisenberg.

    Operator "B" of the Heisenberg.

    Operator "C" of the Heisenberg.

    Operator "D" of the Heisenberg.

    operatorDetuneModeIndex: PrimitiveField<number, "mut">

    Selects the operator detune mode. This value affects which detune mode is shown in the DAW for each operator's detune gauge. It doesn't have an effect on the produced audio.

    • 0: invalid
    • 1: Semitone - show's semitone to detune an operator
    • 2: Ratio - show's the frequency ratio to detune an operator
    key value
    default 1
    range [1, 2]

    The Heisenberg pitch envelope. Can be assigned to the individual operators inside the operator message.

    playModeIndex: PrimitiveField<number, "mut">

    Selects the play mode of the synthesizer. The play mode determines how notes are played:

    • 0: invalid
    • 1: Mono
    • 2: Legato
    • 3: Polyphone

    Mono: At most once note is played at once with slight overlap during release. An incoming note cuts already playing notes.

    Legato: Same as mono, but attack is omitted when a new incoming note cut off an already playing note.

    Polyphone: Multiple notes/chords can be played simultaneously.

    key value
    default 3
    range [1, 3]
    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
    tuneSemitones: PrimitiveField<number, "mut">

    Global tuning of the synth, moves all notes played by a given amount of semitones.

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

    Setting this parameter to > 1 will create multiple voices per note.

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

    If there's multiple voices per note (i.e. if unisono_count > 1), increasing this parameter will detune all voices from each other more by up to 1 semitone. Increasing this parameter creates a "wider" sound. If unisono_count is 1, this parameter has no effect.

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

    Spreads the voices across the stereo field. 0 is centered, 1 moves some voices to the right, some to the left. -1 moves them in the opposite direction.

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

    Multiplier for the velocity of the notes, controlling their loudness. No unit.

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