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

    Type Alias Beatbox8Pattern

    key value
    type entity
    key "beatbox8Pattern"
    is

    A pattern of the beatbox8. A beatbox8 pattern is a sequence of "steps", each step can have at most step can contain zero, one or multiple active instruments. Further, each step can be "accented", resulting in all instruments being played louder on that step.

    The step duration depends on the step_scale_index field.

    type Beatbox8Pattern = {
        groove: PrimitiveField<NexusLocation, "mut">;
        length: PrimitiveField<number, "mut">;
        slot: PrimitiveField<NexusLocation, "immut">;
        steps: ArrayField<NexusObject<Beatbox8PatternStep>, 64>;
        stepScaleIndex: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    Every pattern can have a groove applied individually

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

    Number of steps before the pattern repeats.

    key value
    default 16
    range [1, 64]

    The beatbox8 this pattern belongs to, also includes the index of the pattern.

    key value
    default no default, required
    required true
    targets api.TargetType.Beatbox8PatternSlot, meaning one of:
    entities.Beatbox8.patternSlots
    immutable true

    Steps inside the current pattern.

    stepScaleIndex: PrimitiveField<number, "mut">

    The duration of each step in ticks.

    • 0: invalid
    • 1: 6 steps per 1/4th note = 1/24th semibreve (640 ticks) per step
    • 2: 3 steps per 1/4th note = 1/12th semibreve (1280 ticks) per step
    • 3: 4 steps per 1/4th note = 1/16th semibreve (960 ticks) per step
    • 4: 8 steps per 1/4th note = 1/32nd semibreve (480 ticks) per step
    key value
    default 3
    range [1, 4]