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

    All Entities

    This document contains a list of all entities in the document. The second column of each table contains the entity "type name" that can be used to construct the entity.

    For example, the entity "bassline" can be constructed like this:

    t.create("bassline", {})
    

    Devices that generate sound based on a timeline track.

    Link Key Description
    Space "space" The space synth
    Heisenberg "heisenberg" The heisenberg synth
    Pulverisateur "pulverisateur" The pulv synth
    Gakki "gakki" A soundfont player.
    AudioDevice "audioDevice" The device to which an audio track can be connected to.

    These are devices that can be controlled via patterns on the desktop. The patterns can be scheduled using a pattern track. Some devices also support note input.

    Link Key Description
    Bassline "bassline" A tb303-like bassline device.
    BasslinePattern "basslinePattern" A pattern for the bassline. Must point to the bassline.
    Beatbox8 "beatbox8" A tr808-like drum machine.
    Beatbox8Pattern "beatbox8Pattern" A pattern for the beatbox8. Must point to a beatbox8.
    Beatbox9 "beatbox9" A tr909-like drum machine.
    Beatbox9Pattern "beatbox9Pattern" A pattern for the tr909. Must point to a beatbox9.
    Tonematrix "tonematrix" The tonematrix device, a grid-based sequencer.
    TonematrixPattern "tonematrixPattern" A pattern for the tonematrix. Must point to a tonematrix.
    Rasselbock "rasselbock" The rasselbock, an effect device whose effect can be triggered on a sequencer grid.
    RasselbockPattern "rasselbockPattern" Must point to a rasselbock.
    MatrixArpeggiator "matrixArpeggiator" An arpeggiator that can be configured with a pattern
    MatrixArpeggiatorPattern "matrixArpeggiatorPattern" A pattern for the matrix arpeggiator. Must point to a matrix arpeggiator.
    Link Key Description
    StompboxChorus "stompboxChorus" A stompbox Chorus
    StompboxCompressor "stompboxCompressor" A stompbox Compressor
    StompboxCrusher "stompboxCrusher" A stompbox Crusher
    StompboxDelay "stompboxDelay" A stompbox Delay
    StompboxFlanger "stompboxFlanger" A stompbox Flanger
    StompboxGate "stompboxGate" A stompbox Gate
    StompboxParametricEqualizer "stompboxParametricEqualizer" A stompbox ParametricEqualizer
    StompboxPhaser "stompboxPhaser" A stompbox Phaser
    StompboxPitchDelay "stompboxPitchDelay" A stompbox PitchDelay
    StompboxReverb "stompboxReverb" A stompbox Reverb
    StompboxSlope "stompboxSlope" A stompbox Slope
    StompboxStereoDetune "stompboxStereoDetune" A stompbox StereoDetune
    StompboxTube "stompboxTube" A stompbox Tube
    AutoFilter "autoFilter" A filter triggered based on signal gain
    Curve "curve" An EQ.
    TinyGain "tinyGain" A simple gain knob.
    Helmholtz "helmholtz" A resonator device.
    Quantum "quantum" A multiband compressor.
    Quasar "quasar" An advanced reverb effect.
    Waveshaper "waveshaper" A frame-by-frame amplitude remapping effect, resulting in distortion.
    WaveshaperAnchor "waveshaperAnchor" An anchor for the waveshaper. Must point to the waveshaper.
    Exciter "exciter" Enriches the signal by adding harmonic content.
    Panorama "panorama" Manipulation of the stereo signal.
    Pulsar "pulsar" An advanced delay effect.
    StereoEnhancer "stereoEnhancer" Widen or narrow the stereo field.
    RingModulator "ringModulator" Multiplies two audio signals together
    GraphicalEQ "graphicalEQ" A graphical equalizer with 2 notch filters
    Gravity "gravity" A compressor.

    These are devices that can be used to route audio and mix them slightly before they enter the main mixer.

    Link Key Description
    DesktopAudioCable "desktopAudioCable" An audio carrying cable on the desktop.
    DesktopNoteCable "desktopNoteCable" A note carrying cable on the desktop.
    BandSplitter "bandSplitter" Split the incoming signals into multiple cables by frequency bands.
    AudioMerger "audioMerger" Merge audio from multiple cables into one.
    AudioSplitter "audioSplitter" Split audio into multiple cables.
    NoteSplitter "noteSplitter" Split notes into multiple cables to connect them to multiple synths.
    Centroid "centroid" A mixer.
    CentroidChannel "centroidChannel" A channel of the centroid. Must point to the centroid.
    Minimixer "minimixer" A small mixer.
    Crossfader "crossfader" An even smaller mixer.
    Kobolt "kobolt" Another smaller mixer.

    Entities used to build the main audiotool mixer.

    Link Key Description
    MixerMaster "mixerMaster" The master strip. Must exist for a project to make sound.
    MixerChannel "mixerChannel" A regular mixer channel with sockets on the stagebox.
    MixerGroup "mixerGroup" A mixer group strip grouping other channel/group strips.
    MixerStripGrouping "mixerStripGrouping" An entity that can be used to group channel- and group strips
    MixerAux "mixerAux" A generic aux strip with inserts
    MixerAuxRoute "mixerAuxRoute" A connection from a channel/group strip to an aux strip.
    MixerDelayAux "mixerDelayAux" An aux strip with a baked-in delay effect
    MixerReverbAux "mixerReverbAux" An aux strip with baked-in reverb effect
    MixerSideChainCable "mixerSideChainCable" A cable that can be used to connect mixer signals to side chains inputs.
    Machiniste "machiniste" A sample based step sequencer, useful e.g. for drums.
    MachinistePattern "machinistePattern" A pattern for the machiniste. Must point to a machiniste.
    Link Key Description
    AudioTrack "audioTrack" An audio track. Must point to an AudioDevice.
    AudioRegion "audioRegion" An audio region. Must point to an audio track, a sample, and an automation collection controlling the playback of the sample.
    Link Key Description
    AutomationTrack "automationTrack" A parameter automation track. Must point to an automatable parameter of a device.
    AutomationCollection "automationCollection" A collection of automation events.
    AutomationEvent "automationEvent" An automation event. Must point to an automation collection or a tempo automation track.
    AutomationRegion "automationRegion" An automation region. Must point to an automation track and an automation collection.
    Link Key Description
    NoteTrack "noteTrack" A note track. Must point to a device on the desktop supporting notes.
    NoteRegion "noteRegion" A note region. Must point to a note track and a note collection.
    NoteCollection "noteCollection" A collection of notes.
    Note "note" A note. Must point to a note collection.
    Link Key Description
    PatternTrack "patternTrack" A pattern track. Must point to a device supporting patterns.
    PatternRegion "patternRegion" A pattern region.
    Link Key Description
    TempoAutomationTrack "tempoAutomationTrack" A tempo automation track. Can exist at most once per project. Pointed to by automation events.

    These entities don't fit into a category.

    Link Key Description
    Config "config" A config object configuring global parameters like bpm and signature. Can exist at most once.
    Groove "groove" An entity that can be pointed to by a variety of devices. Makes their notes feel more "groovy".
    MicroTuningOctave "microTuningOctave" An entity that can be pointed to by a variety of devices. Allows detuning every note on the scale with precision.
    Sample "sample" A sample. Contains an id of a sample that's resolved from the backend. Used by audio regions and the machiniste.