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

    Type Alias Space

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

    The Space is a wavetable synthesizer.

    It features 2 wavetables called "A" and "B", which can be independently adjusted and mixed together.

    type Space = {
        amplitudeEnvelope: NexusObject<AdsrEnvelope>;
        audioOutput: NexusObject<Empty>;
        displayName: PrimitiveField<string, "mut">;
        envelopeLfoAmountModulationDepth: PrimitiveField<number, "mut">;
        envelopeLfoRateModulationDepth: PrimitiveField<number, "mut">;
        envelopeMixModulationDepth: PrimitiveField<number, "mut">;
        envelopeTuneModulationDepth: PrimitiveField<number, "mut">;
        gain: PrimitiveField<number, "mut">;
        glideMs: PrimitiveField<number, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        keyboardMixModulationDepth: PrimitiveField<number, "mut">;
        lfo: NexusObject<SpaceLFO>;
        lfoGainModulationDepth: PrimitiveField<number, "mut">;
        lfoMixModulationDepth: PrimitiveField<number, "mut">;
        lfoPanningModulationDepth: PrimitiveField<number, "mut">;
        lfoStereoDetuneShiftModulationDepth: PrimitiveField<number, "mut">;
        microTuning: PrimitiveField<NexusLocation, "mut">;
        mixAB: PrimitiveField<number, "mut">;
        modulationEnvelope: NexusObject<AdsrEnvelope>;
        modulationEnvelopeHasRelease: PrimitiveField<boolean, "mut">;
        notePlayModeIndex: PrimitiveField<number, "mut">;
        notesInput: NexusObject<Empty>;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
        soundA: NexusObject<SpaceSound>;
        soundB: NexusObject<SpaceSound>;
        stereoDetuneShift: PrimitiveField<number, "mut">;
        tuneASemitones: PrimitiveField<number, "mut">;
        tuneBSemitones: PrimitiveField<number, "mut">;
        tuneSemitones: PrimitiveField<number, "mut">;
        velocityGainModulationDepth: PrimitiveField<number, "mut">;
        velocityMixModulationDepth: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    amplitudeEnvelope audioOutput displayName envelopeLfoAmountModulationDepth envelopeLfoRateModulationDepth envelopeMixModulationDepth envelopeTuneModulationDepth gain glideMs isActive keyboardMixModulationDepth lfo lfoGainModulationDepth lfoMixModulationDepth lfoPanningModulationDepth lfoStereoDetuneShiftModulationDepth microTuning mixAB modulationEnvelope modulationEnvelopeHasRelease notePlayModeIndex notesInput positionX positionY soundA soundB stereoDetuneShift tuneASemitones tuneBSemitones tuneSemitones velocityGainModulationDepth velocityMixModulationDepth

    Properties

    amplitudeEnvelope: NexusObject<AdsrEnvelope>

    The adsr envelope that modulates the gain of the synth.

    audioOutput: NexusObject<Empty>

    Single Output.

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

    The user-assigned name of this device.

    envelopeLfoAmountModulationDepth: PrimitiveField<number, "mut">

    The amount by which the modulation envelope modulates the LFO amount.

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

    The amount by which the modulation envelope modulates the LFO rate.

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

    The amount by which the modulation envelope modulates the mix_a_b parameter.

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

    The amount by which the modulation envelope modulates the tune_semitones parameter.

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

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

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

    Glide time between notes in milliseconds.

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

    Whether the device is active or not

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

    The amount by which the keyboard (i.e. note pitch) modulates the mix_a_b parameter.

    key value
    default 0
    range [-1, 1]
    is api.TargetType.AutomatableParameter
    lfo: NexusObject<SpaceLFO>

    Parameters for the space LFO.

    lfoGainModulationDepth: PrimitiveField<number, "mut">

    The amount by which the LFO modulates the gain parameter.

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

    The amount by which the LFO modulates the mix_a_b parameter.

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

    The amount by which the LFO modulates the panning of the signal.

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

    The amount by which the LFO modulates the stereo_detune_shift parameter.

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

    Micro tuning.

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

    Mixes the two wavetables A and B. -1 means only wavetable A is used, 1.0 means only wavetable B is used.

    key value
    default -1
    range [-1, 1]
    is api.TargetType.AutomatableParameter
    modulationEnvelope: NexusObject<AdsrEnvelope>

    The adsr envelope that can be used to modulate other parameters of the synth.

    modulationEnvelopeHasRelease: PrimitiveField<boolean, "mut">

    Whether the modulation envelope's release phase is used or not.

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

    Selects the play mode of the synth for notes.

    • 0: invalid
    • 1: Mono At most once note is played at once with slight overlap during release. An incoming note cuts already playing notes, starting from the attack phase.
    • 2: Legato At most once note is played at once. Incoming notes cut already playing notes, skipping the attack phase of notes, essentially acting as if the currently playing note's pitch was changed to the new note.
    • 3: Polyphone Multiple notes/chords can be played simultaneously.
    key value
    default 3
    range [1, 3]
    is api.TargetType.AutomatableParameter
    notesInput: NexusObject<Empty>

    Notes Input.

    key value
    is api.TargetType.NotesInput
    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
    soundA: NexusObject<SpaceSound>

    The parameters for the wavetable "A".

    soundB: NexusObject<SpaceSound>

    The parameters for the wavetable "B".

    stereoDetuneShift: PrimitiveField<number, "mut">

    Multi purpose parameter to widen the stereo image of the sound.

    In the negative range (-1..0) the widening happens by phase shifting the two channels (resulting in a wider perceived stereo sound without pitch shift), while in the positive range (0 ..1) the widening happens by detuning the voices, with the right channel being pitched down and the right channel being pitched up on a range between 0 and 12 semitones.

    If the value is at -1, both voices are equal (resulting in a mono sound).

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

    Tuning of wavetable "A".

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

    Tuning of wavetable "B".

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

    Global tuning of the synth, moves all notes played by a given amount of semitones. +/-12 semitones is equivalent to +/- 1 octave.

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

    The amount by which the velocity modulates the gain parameter.

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

    The amount by which the note velocity modulates the mix_a_b parameter.

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

    Settings

    Member Visibility

    On This Page

    Properties