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

    Module entities

    Contains the field types of all possible entities in the nexus document.

    To create an entity marked with Entity key: "foo" use the create method of the transaction builder as follows:

    const foo = t.create("foo", {})
    

    Device Entities

    Audio Device Entities are entities representing devices that are placed on the desktop.

    They're the main building blocks of the audio processing graph. Some of the types below are actual entities, some are just fields of entities.

    All devices have positionX and positionY fields that can be used to position the device on the desktop, and a displayName field that can be used to name the device. They can be connected using entities.DesktopAudioCable and entities.DesktopNoteCable.

    The DAW will manage placement of these devices so they don't overlap whenever the user moves them.

    AudioDevice
    AudioMerger
    AudioSplitter
    AutoFilter
    BandSplitter
    Bassline
    Beatbox8
    Beatbox8Pattern
    Beatbox9
    Beatbox9Pattern
    Centroid
    CentroidChannel
    Crossfader
    Curve
    Exciter
    Gakki
    GraphicalEQ
    Gravity
    Heisenberg
    Helmholtz
    Kobolt
    Machiniste
    MachinistePattern
    MatrixArpeggiator
    Minimixer
    MinimixerChannel
    NoteSplitter
    Panorama
    Pulsar
    Pulverisateur
    Quantum
    Quasar
    Rasselbock
    RasselbockPattern
    RingModulator
    Space
    StereoEnhancer
    StompboxChorus
    StompboxCompressor
    StompboxCrusher
    StompboxDelay
    StompboxFlanger
    StompboxGate
    StompboxParametricEqualizer
    StompboxPhaser
    StompboxPitchDelay
    StompboxReverb
    StompboxSlope
    StompboxStereoDetune
    StompboxTube
    TinyGain
    Tonematrix
    TonematrixPattern
    Waveshaper
    WaveshaperAnchor

    Device Fields

    AudioMergerCoordinates
    AudioSplitterCoordinates
    BasslinePattern
    BasslineStep
    Beatbox8Bassdrum
    Beatbox8ClapMaracas
    Beatbox8ClosedHihat
    Beatbox8Cowbell
    Beatbox8Cymbal
    Beatbox8OpenHihat
    Beatbox8PatternStep
    Beatbox8RimClaves
    Beatbox8Snaredrum
    Beatbox8TomCongaHigh
    Beatbox8TomCongaLow
    Beatbox8TomCongaMid
    Beatbox9Bassdrum
    Beatbox9Clap
    Beatbox9Crash
    Beatbox9Hihat
    Beatbox9PatternStep
    Beatbox9Ride
    Beatbox9Rim
    Beatbox9Snaredrum
    Beatbox9Tom
    CentroidAux
    CrossfaderChannel
    CurvePass
    CurvePeak
    CurveShelf
    GraphicalEQFilter
    HeisenbergFilter
    HeisenbergLFO
    HeisenbergOperator
    HeisenbergPitchEnvelope
    HelmholtzFilter
    KoboltChannel
    MachinisteChannel
    MachinisteChannelPattern
    MachinisteStep
    MatrixArpeggiatorPattern
    MatrixArpeggiatorPatternStep
    NoteSplitterChannel
    PulverisateurAmplitudeEnvelope
    PulverisateurAudio
    PulverisateurChannel
    PulverisateurFilter
    PulverisateurFilterEnvelope
    PulverisateurLfo
    PulverisateurNoise
    PulverisateurOscillator
    PulverisateurOscillatorA
    PulverisateurOscillatorB
    PulverisateurOscillatorC
    QuantumBand
    RasselbockChannel
    RasselbockGate
    RasselbockReverse
    RasselbockRowPattern
    RasselbockScratch
    RasselbockShuffle
    RasselbockSpeed
    RasselbockStep
    RasselbockStop
    RasselbockStutter
    SpaceLFO
    SpaceSound
    TonematrixStep

    Mixer Entities

    Mixer related entities are entities with which the main audiotool mixer is configured. An audiotool project must contain an entities.MixerMaster entity in order to produce sound. To connect an audio device to the mixer, create a entities.MixerChannel entity and connect a device to it through the field entities.MixerChannel.audioInput using a entities.DesktopAudioCable.

    MixerAux
    MixerAuxRoute
    MixerChannel
    MixerDelayAux
    MixerGroup
    MixerMaster
    MixerReverbAux
    MixerSideChainCable
    MixerStripGrouping

    Mixer Fields

    MixerCompressor
    MixerEq
    MixerStripDisplayParameters
    MixerStripFaderParameters
    MixerTrimFilter

    Timeline Entities

    These are entities that are built to build the timeline - be it note tracks, audio tracks, automation tracks, or pattern tracks.

    AudioRegion
    AudioTrack
    AutomationCollection
    AutomationEvent
    AutomationRegion
    AutomationTrack
    Note
    NoteCollection
    NoteRegion
    NoteTrack
    PatternRegion
    PatternTrack
    TempoAutomationTrack

    Timeline Fields

    Region

    Utility Entities

    Utility types and helper entities used throughout the system.

    Config
    DesktopAudioCable
    DesktopNoteCable
    Groove
    MicroTuningOctave
    Sample
    SpitfireLabsVst3Plugin

    Utility Fields

    AdsrEnvelope
    Empty