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

    Type Alias Beatbox9

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

    Data structure for the beatbox 9 drum-machine

    type Beatbox9 = {
        accentAmount: PrimitiveField<number, "mut">;
        audioOutput: NexusObject<Empty>;
        bassdrum: NexusObject<Beatbox9Bassdrum>;
        clap: NexusObject<Beatbox9Clap>;
        crash: NexusObject<Beatbox9Crash>;
        displayName: PrimitiveField<string, "mut">;
        gain: PrimitiveField<number, "mut">;
        hihat: NexusObject<Beatbox9Hihat>;
        isActive: PrimitiveField<boolean, "mut">;
        notesInput: NexusObject<Empty>;
        patternIndex: PrimitiveField<number, "mut">;
        patternSlots: ArrayField<NexusObject<Empty>, 28>;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
        ride: NexusObject<Beatbox9Ride>;
        rim: NexusObject<Beatbox9Rim>;
        snaredrum: NexusObject<Beatbox9Snaredrum>;
        tomHigh: NexusObject<Beatbox9Tom>;
        tomLow: NexusObject<Beatbox9Tom>;
        tomMid: NexusObject<Beatbox9Tom>;
    }
    Index

    Properties

    accentAmount audioOutput bassdrum clap crash displayName gain hihat isActive notesInput patternIndex patternSlots positionX positionY ride rim snaredrum tomHigh tomLow tomMid

    Properties

    accentAmount: PrimitiveField<number, "mut">

    The loudness of unaccented notes. 0 is quieter, 1 is louder. No unit.

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

    Single Output

    key value
    is api.TargetType.AudioOutput
    bassdrum: NexusObject<Beatbox9Bassdrum>

    Bassdrum instrument

    clap: NexusObject<Beatbox9Clap>

    Handclap

    crash: NexusObject<Beatbox9Crash>

    Crash

    displayName: PrimitiveField<string, "mut">

    The user-assigned name of this device.

    gain: PrimitiveField<number, "mut">

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

    key value
    default 0.7079457640647888
    range [0, 1]
    is api.TargetType.AutomatableParameter
    hihat: NexusObject<Beatbox9Hihat>

    hihat instrument

    isActive: PrimitiveField<boolean, "mut">

    Whether the device is active or not. When is_active=false, no audio is produced.

    key value
    default true
    is api.TargetType.AutomatableParameter
    notesInput: NexusObject<Empty>

    Notes Input.

    key value
    is api.TargetType.NotesInput
    patternIndex: PrimitiveField<number, "mut">

    The index of the currently selected pattern

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

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

    key value
    element is api.TargetType.Beatbox9PatternSlot
    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
    ride: NexusObject<Beatbox9Ride>

    Ride

    rim: NexusObject<Beatbox9Rim>

    Rimshot

    snaredrum: NexusObject<Beatbox9Snaredrum>

    Snaredrum instrument

    tomHigh: NexusObject<Beatbox9Tom>

    High tom.

    tomLow: NexusObject<Beatbox9Tom>

    Low tom.

    tomMid: NexusObject<Beatbox9Tom>

    Mid tom.

    Settings

    Member Visibility

    On This Page

    Properties