# web-midi-api

> Web MIDI API for Node.js

Latest version **2.4.0** (published 2025-09-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install web-midi-api
pnpm add web-midi-api
yarn add web-midi-api
bun add web-midi-api
```

## Health

**Score 35/100 (D)** — status: stable.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 2.4.0 |
| Published | 2025-09-06 |
| First published | 2014-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 595 |
| Maintainers | jazz-soft |
| Keywords | midi, webmidi, web-midi, web-midi-api |

## Links

- npm: https://www.npmjs.com/package/web-midi-api
- Repository: https://github.com/jazz-soft/JZZ
- Homepage: https://jazz-soft.net
- Issues: https://github.com/jazz-soft/JZZ/issues
- npm.io page: https://npm.io/package/web-midi-api

## Dependencies (1)

- [jzz](https://npm.io/package/jzz.md) ^1.9.5

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 2.4.0 (latest) — 2025-09-06
- 2.3.9 — 2025-04-08
- 2.3.8 — 2025-03-11
- 2.3.7 — 2025-02-20
- 2.3.6 — 2025-02-15
- 2.3.5 — 2025-01-03
- 2.3.4 — 2024-11-30
- 2.3.3 — 2024-09-02
- 2.3.2 — 2024-06-16
- 2.3.1 — 2024-05-16
- 2.3.0 — 2024-03-17
- 2.2.9 — 2024-02-26
- 2.2.8 — 2024-01-14
- 2.2.7 — 2023-12-01
- 2.2.6 — 2023-09-22
- … 36 more at https://npm.io/package/web-midi-api/versions

## README

# Web MIDI API for Node.js

![nodejs](https://jazz-soft.github.io/img/nodejs.jpg)
![windows](https://jazz-soft.github.io/img/windows.jpg)
![macos](https://jazz-soft.github.io/img/macos.jpg)
![linux](https://jazz-soft.github.io/img/linux.jpg)
![raspberry pi](https://jazz-soft.github.io/img/rpi.jpg)  
[![npm](https://img.shields.io/npm/v/web-midi-api.svg)](https://www.npmjs.com/package/web-midi-api)
[![npm](https://img.shields.io/npm/dt/web-midi-api.svg)](https://www.npmjs.com/package/web-midi-api)
[![build](https://github.com/jazz-soft/JZZ/actions/workflows/build.yml/badge.svg)](https://github.com/jazz-soft/JZZ/actions)
[![Coverage](https://coveralls.io/repos/github/jazz-soft/JZZ/badge.svg?branch=master)](https://coveralls.io/github/jazz-soft/JZZ?branch=master)

This package is deprecated and kept here for the old projects compatibility.
It redirects to [**jzz**](https://www.npmjs.com/package/jzz):

```js
// index.js:
module.exports = require('jzz');
```

If you are starting a new project, please consider using
[**jzz**](https://www.npmjs.com/package/jzz) directly.

## Other versions
- [**cwilso/WebMIDIAPIShim**](https://github.com/cwilso/WebMIDIAPIShim) by [**Chris Wilson**](https://github.com/cwilso)
- [**abudaan/WebMIDIAPIShim**](https://github.com/abudaan/WebMIDIAPIShim) by [**Daniel van der Meer**](https://github.com/abudaan)


## Usage

`npm install web-midi-api`
```js
var navigator = require('web-midi-api');
// consider using var navigator = require('jzz');

var midi;
var inputs;
var outputs;

function onMIDIFailure(msg) {
  console.log('Failed to get MIDI access - ' + msg);
  process.exit(1);
}

function onMIDISuccess(midiAccess) {
  midi = midiAccess;
  inputs = midi.inputs;
  outputs = midi.outputs;
  setTimeout(testOutputs, 500);
}

function testOutputs() {
  console.log('Testing MIDI-Out ports...');
  outputs.forEach(function(port) {
    console.log('id:', port.id, 'manufacturer:', port.manufacturer, 'name:', port.name, 'version:', port.version);
    port.open();
    port.send([0x90, 60, 0x7f]);
  });
  setTimeout(stopOutputs, 1000);
}

function stopOutputs() {
  outputs.forEach(function(port) {
    port.send([0x80, 60, 0]);
  });
  testInputs();
}

function onMidiIn(ev) {
  var arr = [];
  for(var i = 0; i < ev.data.length; i++) {
    arr.push((ev.data[i] < 16 ? '0' : '') + ev.data[i].toString(16));
  }
  console.log('MIDI:', arr.join(' '));
}

function testInputs() {
  console.log('Testing MIDI-In ports...');
  inputs.forEach(function(port) {
    console.log('id:', port.id, 'manufacturer:', port.manufacturer, 'name:', port.name, 'version:', port.version);
    port.onmidimessage = onMidiIn;
  });
  setTimeout(stopInputs, 5000);
}

function stopInputs() {
  console.log('Thank you!');
  navigator.close(); // This will close MIDI inputs, otherwise Node.js will wait for MIDI input forever.
  process.exit(0);
}

navigator.requestMIDIAccess().then(onMIDISuccess, onMIDIFailure);
```

---
_Source: https://npm.io/package/web-midi-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._