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

    Type Alias Bassline

    key value
    type entity
    key "bassline"
    is api.TargetType.PatternTrackPlayer, api.TargetType.NoteTrackPlayer

    The bassline is inspired by a very famous bass synthesizer.

    type Bassline = {
        accent: PrimitiveField<number, "mut">;
        audioInput: NexusObject<Empty>;
        audioOutput: NexusObject<Empty>;
        cutoffFrequencyHz: PrimitiveField<number, "mut">;
        displayName: PrimitiveField<string, "mut">;
        filterDecay: PrimitiveField<number, "mut">;
        filterEnvelopeModulationDepth: PrimitiveField<number, "mut">;
        filterResonance: PrimitiveField<number, "mut">;
        gain: PrimitiveField<number, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        microTuning: PrimitiveField<NexusLocation, "mut">;
        patternIndex: PrimitiveField<number, "mut">;
        patternSlots: ArrayField<NexusObject<Empty>, 28>;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
        tuneSemitones: PrimitiveField<number, "mut">;
        waveformIndex: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    accent: PrimitiveField<number, "mut">

    The accent factor affects the signal's volume and filter behavior of notes that are marked with "accent", relative to the non-accented ones.

    key value
    default 1
    range [0, 1]
    is api.TargetType.AutomatableParameter
    audioInput: NexusObject<Empty>

    The filter can be used with external input.

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

    Device output.

    key value
    is api.TargetType.AudioOutput
    cutoffFrequencyHz: PrimitiveField<number, "mut">

    Cutoff frequency for the low-pass filter.

    key value
    default 220
    range [220, 12000]
    is api.TargetType.AutomatableParameter
    displayName: PrimitiveField<string, "mut">

    The user-assigned name of this device.

    filterDecay: PrimitiveField<number, "mut">

    The duration of the decay stage of the filter envelope. No unit; 0 is shorter, 1 is longer.

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

    Controls the impact of the filter envelope on the filter cutoff frequency.

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

    Filter resonance. No unit.

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

    This device's output gain. Equivalent to a dB range of [-inf, 0.0].

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

    Whether the bassline is active or not. When is_active=false no audio is produced by the bassline nor is the input audio audible.

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

    Reference to the microtuning.

    key value
    default empty location
    required false
    targets api.TargetType.MicroTuning, meaning one of:
    entities.MicroTuningOctave
    patternIndex: PrimitiveField<number, "mut">

    The index of the currently selected pattern. Controls which pattern the bassline currently plays back, unless a pattern track is connected to it.

    key value
    default 0
    range [0, 27]
    patternSlots: ArrayField<NexusObject<Empty>, 28>

    Empty fields which BasslinePatterns can point to. At most one pattern can point to a given element in this list.

    key value
    element is api.TargetType.BasslinePatternSlot
    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">

    This parameter detunes every note (whether incoming or from the step sequencer) by a specified number of semitones. +/-12 semitones is equivalent to +/- 1 octave.

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

    Selects the waveform used by the Synth:

    • 0: invalid
    • 1: sawtooth
    • 2: square
    key value
    default 1
    range [1, 2]
    is api.TargetType.AutomatableParameter