jzz-input-uke
v0.1.6
Published
SVG MIDI Ukulele
Downloads
19
Readme
JZZ-input-Uke
SVG MIDI Ukulele
Install
npm install jzz-input-uke --save
or yarn add jzz-input-uke
or get the full development version and minified scripts from GitHub
Usage
Plain HTML
<script src="JZZ.js"></script>
<script src="JZZ.input.Uke.js"></script>
//...CDN (jsdelivr)
<script src="https://cdn.jsdelivr.net/npm/jzz"></script>
<script src="https://cdn.jsdelivr.net/npm/jzz-input-uke"></script>
//...CDN (unpkg)
<script src="https://unpkg.com/jzz"></script>
<script src="https://unpkg.com/jzz-input-uke"></script>
//...CommonJS
var JZZ = require('jzz');
require('jzz-input-uke')(JZZ);
//...TypeScript / ES6
import { JZZ } from 'jzz';
import { Uke } from 'jzz-input-uke';
Uke(JZZ);
//...Example HTML
<!DOCTYPE html>
<html lang=en>
<head>
<script src="https://cdn.jsdelivr.net/npm/jzz"></script>
<script src="https://cdn.jsdelivr.net/npm/jzz-synth-tiny"></script>
<script src="https://cdn.jsdelivr.net/npm/jzz-input-uke"></script>
</head>
<body>
<div id="uke_div"></div>
<script>
JZZ.synth.Tiny.register('Web Audio');
var out = JZZ().openMidiOut();
var uke = JZZ.input.Uke({ at: "uke_div" });
uke.viewbox(-3.1, -.15, 3.2, 1.35);
uke.transform(1, 3, -3, 1, 0, 0)
uke.connect(out);
</script>
</body>
</html>API
Construction
var uke = JZZ.input.Uke(args);
// or
JZZ.input.Uke.register('My Cool Ukulele', args);
var uke = JZZ().openMidiIn('My Cool Ukulele');args is an object with th optional keys:
at: DOM element to insert SVG, or its ID as string; default: the bottom of the page;frets: number of frets; default:18;strings: tuning; default:gCEA;channels: MIDI channels for each string; default:[0, 1, 2, 3];active: iffalse, ignore the user interaction; default:true
Connection
var midi_in = JZZ().openMidiIn();
var midi_out = JZZ().openMidiOut();
midi_in.connect(uke);
uke.connect(midi_out);