Module `Musician.Instruments`

Instrument definitions

Tables

Musician.INSTRUMENTS	Instruments table.
Musician.INSTRUMENTS_AVAILABLE	Ordered list of internal instrument IDs available to the end user

Musician.INSTRUMENTS

Instruments table. The key is the internal instrument ID (string) and each value is a table having the following attribues:

color (table) Color {r, g, b} from Musician.COLORS (optional)
name (string) Same as the instrument id (automatically generated) (optional)
midi (int) General MIDI instrument ID (0-127). For percussions, midi is its MIDI ID + 128 (optional)
decay (number) Decay duration in seconds (optional)
isPlucked (boolean) True for plucked instruments such as guitar, piano etc. Used for visualization only. (optional)
path (string) Path to the instrument melodic samples directory. (optional)
regions (table) Tables of path, lokey and hikey (inclusive) in replacement of path allowing picking melodic samples from multiple directories according to the MIDI key range defined by lokey and hikey. (optional)
isPercussion (boolean) Act as a percussion instrument using the single sample file (without extension) from path or picked from pathList using keyMod or roundRobin methods (optional)
pathList (table) List of file paths to be chosen using keyMod or roundRobin (without extension) (optional)
keyMod (int) Plays nth sample file from pathList modulo the MIDI key number (optional)
roundRobin (boolean) Plays sample file from pathList using round robin (optional)
source (string) Credits to author, software, library etc used to create the instrument. Displayed in the "About" window. (optional)

Musician.INSTRUMENTS_AVAILABLE

Ordered list of internal instrument IDs available to the end user