Skip to content
MIDI library for Node.js and web-browsers
JavaScript HTML
Branch: master
Clone or download

Latest commit

Latest commit 1a5b09c May 18, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
javascript JZZ.version May 18, 2020
minified JZZ.version May 18, 2020
test Increased mocha timeout May 3, 2020
.eslintrc.js
.gitattributes Added .gitattributes Dec 13, 2016
.gitignore Update .gitignore to include dev artifact files Jul 10, 2019
.npmignore Version update Nov 8, 2018
.travis.yml Updated .travis.yml Apr 26, 2020
Gruntfile.js Added unpkg link May 17, 2020
README.md JZZ.version May 18, 2020
bower.json Update for Node v.12.*.* May 3, 2019
index.d.ts TypeScript definitions - done Oct 8, 2019
package.json JZZ.version May 18, 2020
test-watcher.js Released v0.4.4 Mar 3, 2018
test-web-midi.html
test-web-midi.js Added Web MIDI tests Apr 2, 2018
test.html AMD and CommonJS Jan 17, 2018
test.js AMD and CommonJS Jan 17, 2018

README.md

JZZ: MIDI library for Node.js and web-browsers

nodejs firefox chrome opera safari msie edge windows macos linux raspberry pi ios android
npm npm jsDelivr Build Status Coverage

JZZ.js allows sending, receiving and playing MIDI messages in Node.js and all major browsers in Linux, MacOS and Windows. Some features are available on iOS and Android devices.

JZZ.js enables Web MIDI API in Node.js and those browsers that don't support it, and provides additional functionality to make developer's life easier.

For the best user experience, it's highly RECOMMENDED (though not required) to install the latest version of Jazz-Plugin and browser extensions from Chrome Web Store or Mozilla Add-ons or Apple App Store.

Features

  • MIDI In/Out
  • User-defined MIDI nodes
  • MIDI files
  • MPE
  • SMPTE
  • Additional modules

Install

npm install jzz --save
or bower install jzz
or yarn add jzz
or get the full development version and minified scripts from Github

Note: in the (unlikely) case you get into trouble installing the midi-test module, that requires special system configuration, you can safely remove it from the devDependencies by running npm remove midi-test --save-dev.

Usage

Plain HTML
<script src="JZZ.js"></script>
//...
CDN (jsdelivr)
<script src="https://cdn.jsdelivr.net/npm/jzz"></script>       // the latest version, or
<script src="https://cdn.jsdelivr.net/npm/jzz@1.0.6"></script> // any particular version
//...
CDN (unpkg)
<script src="https://unpkg.com/jzz"></script>       // the latest version, or
<script src="https://unpkg.com/jzz@1.0.6"></script> // any particular version
//...
CommonJS (Browserify and Node.js command line applications)
var JZZ = require('jzz');
//...
AMD
require(['JZZ'], function(JZZ) {
  //...
});
TypeScript
import * as JZZ from 'jzz';
//...

Web MIDI API

(Node.js example)
var navigator = require('jzz');
navigator.requestMIDIAccess().then(onSuccess, onFail);
// ...
navigator.close(); // This will close MIDI inputs,
                   // otherwise Node.js will wait for MIDI input forever.
// In browsers the funcion is neither defined nor required.

JZZ API

MIDI Output/Input
JZZ().or('Cannot start MIDI engine!')
     .openMidiOut().or('Cannot open MIDI Out port!')
     .wait(500).send([0x90,60,127]) // note on
     .wait(500).send([0x80,60,0]);  // note off
JZZ().openMidiIn().or('Cannot open MIDI In port!')
     .and(function() { console.log('MIDI-In: ', this.name()); })
     .connect(function(msg) { console.log(msg.toString()); })
     .wait(10000).close();
Connecting MIDI nodes
var input = JZZ().openMidiIn();
var output = JZZ().openMidiOut();
var delay = JZZ.Widget({ _receive: function(msg) { this.wait(500).emit(msg); }});
input.connect(delay);
delay.connect(output);
Helpers and shortcuts
// All calls below will do the same job:
port.send([0x90, 61, 127]).wait(500).send([0x80, 61, 0]);   // arrays
port.send(0x90, 61, 127).wait(500).send(0x80, 61, 0);       // comma-separated
port.send(0x90, 'C#5', 127).wait(500).send(0x80, 'Db5', 0); // note names
port.noteOn(0, 'C#5', 127).wait(500).noteOff(0, 'B##4');    // helper functions
port.note(0, 'C#5', 127, 500);                              // another shortcut
port.ch(0).noteOn('C#5').wait(500).noteOff('C#5');          // using channels
port.ch(0).note('C#5', 127, 500);                           // using channels
Asynchronous calls
// in the environments that support async/await:
async function playNote() {
  var midi = await JZZ();
  var port = await midi.openMidiOut();
  await port.noteOn(0, 'C5', 127);
  await port.wait(500);
  await port.noteOff(0, 'C5');
  await port.close();
  console.log('done!');
}
// or:
async function playAnotherNote() {
  var port = await JZZ().openMidiOut();
  await port.noteOn(0, 'C5', 127).wait(500).noteOff(0, 'C5').close();
  console.log('done!');
}

Additional modules

Check the Getting Started page and the API reference for more information.
Your questions and comments are welcome here.

We would really appreciate your support!

You can’t perform that action at this time.