README.md

🧑‍🎤 react-riffs

React Hooks + MIDI 🎹 = 🎶 Riffs 🎶

Contents

• useMidiInputs
• useClock
• useControl
• useNote
• useNotes
• usePitchbend

Usage

React Riffs exposes several hooks for use with the WebMIDI API. It wraps the excellent WebMidi.js, so refer to their documentation for event reference, etc.

useMidiInputs

In order to make use of Riffs, you first need to invoke the useMidiInputs hook. This will bootstrap WebMidi and return an array of connected Inputs:

let [myInput] = useMidiInputs();

console.log(myInput);
//=> Input {_userHandlers: {...}, _midiInput: MIDIInput, ...}

useMidiInputs takes an optional debug flag, which will add listeners to log the following events to the console: noteon, pitchbend, start, stop

let [myInput] = useMidiInputs({ debug: true });

Once you have your input, you can start reading from your input device. Just remember to pass your input object each time you invoke an event hook.

Each of the following takes an optional channel as the last parameter. If no channel is specified, it will default to 'all'.

useClock

Returns the current timestamp from the input device along with a boolean representing whether or not the clock is currently running

let [timestamp, isRunning] = useClock(myInput);

console.log(timestamp);
//=> 1234.1234567890123

console.log(isRunning);
//=> false

useControl

Returns the integer value of a controlchange event: 0-127 This hook accepts as an optional second parameter, a string indicating the control to listen for. If this is not supplied, it will default to modulationwheelcoarse. A list of valid control types will be printed to the console if useMidiInputs is initialized with the debug flag.

let mod = useControl(myInput);

console.log(mod);
//=> 64

useNote

NOTE: You probably want useNotes

Returns the most recent noteon/noteoff event, along with a Boolean flag for whether the note is being played

let [noteEvent, isOn] = useNote(myInput);

console.log(noteEvent);
//=> {target: Input, data: Uint8Array(3), type: "noteon", ...}

console.log(isOn);
//=> true

useNotes

Returns an array of noteon events for all of the notes currently being played

let pressedKeys = useNotes(myInput);

console.log(pressedKeys);
//=> [{target: Input, data: Uint8Array(3), type: "noteon" ...}]

usePitchbend

Returns a float between -1.0 and 1.0 for the current pitchbend value. No bend is 0.0

let bend = usePitchbend(myInput);

console.log(bend);
//=> 0