Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "schema"

Contents:



Ordered by Machine, Vibraphone, Bass, HiHat machine, HiHat:

  • sub-States
  • sub-Events

Index

Type aliases

BassEvent

BassEvent: BassCapoEvent

Any event pertaining to the bass.

BassString

BassString: 1 | 2 | 3 | 4

A single string on the bass.

We chose to start at one since musicians count starting from one. String 1 is highest pitched string, and string 4 is the lowest pitched string.

Channel

Channel: DrumType | "vibraphone" | "bass"

A channel that can be muted. Used as keys in the MachineState.mute object.

Example

// specifies that the bassdrum and vibraphone are muted
const state: MachineState = {
  mute: {
    bassdrum: true,
    vibraphone: true,
  },
  ...
};

DropEvent

The dropping of a single marble with no timing information.

DrumType

DrumType: "bassdrum" | "hihat" | "snare"

All possible drums that can be played. Used for specifying which drum to play in a DrumDropEvent.

Event

An untimed event that changes the state of one channel or manually drops a marble.

Events only change one thing. Multiple simultaneous changes must be represented by multiple events with the same tick.

HihatEvent

HihatEvent: HihatClosedEvent

Any event pertaining to the hihat, not the hihat machine.

HihatMachineEvent

HihatMachineEvent: HihatMachineSettingEvent

Any event pertaining to the hihat machine.

MachineEvent

MachineEvent: ChannelMuteEvent

All possible events relating to the machine itself.

PerformanceDropEvent

PerformanceDropEvent: DropEvent & CorePerformanceDropEvent

TickedDropEvent

TickedDropEvent: CoreDropEvent & DropEvent

The dropping of a single marble with an associated tick.

TimedEvent

TimedEvent: CoreTimedEvent & Event

An event occurring in time (non-tempo dependent).

VibraphoneChannel

VibraphoneChannel: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11

Every channel that can be played on the vibraphone.

We decided to start at one since the BassString type also starts at one. We also decided to only represent playable channels and not actual channels (two per note).

VibraphoneEvent

Any event pertaining to the vibraphone.

Generated using TypeDoc