add demos and more code examples to README

This commit is contained in:
Michael Deal 2013-01-22 16:23:40 -08:00
parent edbb8113b8
commit 53c40f3cf3

View file

@ -1,3 +1,46 @@
CODE EXAMPLES (from the repo)
* ./demo-Basic.html is the most basic implementation as seen here:
<pre>
MIDI.loadPlugin({
soundfontUrl: "./soundfont/", // path to soundfont directory
instruments: [ "acoustic_grand_piano", "synth_drum" ], // multiple instruments
callback: function() {
MIDI.programChange(0, 0); // change channel 0 to instrument 0 (acoustic_grand_piano)
MIDI.programChange(1, 118); // change channel 1 to instrument 118 (synth_drum)
for (var n = 0; n < 100; n ++) {
var delay = n / 4; // play one note every quarter second
var note = MIDI.pianoKeyOffset + n; // the MIDI note
var velocity = 127; // how hard the note hits
// play the note
MIDI.noteOn(0, note, velocity, delay);
// play the some note 3-steps up
MIDI.noteOn(1, note + 3, velocity, delay);
}
}
});
</pre>
* ./demo-MIDIPlayer.html shows how to parse MIDI files, and interact with the data stream.
* ./demo-WhitneyMusicBox.html is a audio/visual experiment by Jim Bumgardner
-------------
DEMOS
* <a href="http://qiao.github.com/euphony/">Euphony 3D Piano</a>
* <a href="http://labs.uxmonk.com/simon-says/">Simon Says</a>
* <a href="http://labs.uxmonk.com/brite-lite/">Brite Lite</a>
* <a href="http://mudcu.be/piano/">Color Piano</a>
-------------
SOUNDFONT GENERATORS (*not* required to get started!)
* Ruby
* Shell
-------------
* <a href="./js/MIDI.loadPlugin.js">MIDI.loadPlugin.js</a>: Decides which framework is best to use, and sends request.
<pre>
// interface to download soundfont, then execute callback;
@ -21,7 +64,7 @@ MIDI.keyToNote = object; // A0 => 21
MIDI.noteToKey = object; // 21 => A0
</pre>
* <a href="./js/MIDI.Player.js">MIDI.Player.js</a>: Streams the MIDI to the browser.
<pre>
<pre>
MIDI.Player.currentTime = integer; // time we are at now within the song.
MIDI.Player.endTime = integer; // time when song ends.
MIDI.Player.playing = boolean; // are we playing? yes or no.