Skip to content

Commit a85a611

Browse files
committed
update notes
1 parent 5064359 commit a85a611

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

‎README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Code examples (from the repo)
1+
## Code examples - from the repo
22

33
* [Basic](./examples/Basic.html) - the most basic implementation.
44
* [MIDIPlayer](./examples/MIDIPlayer.html) - how to parse MIDI files, and interact with the data stream.
@@ -29,7 +29,7 @@ To dive in quickly Benjamin Gleitzman has created a package of [pre-rendered sou
2929

3030
## API
3131

32-
### [MIDI.loadPlugin.js](./js/midi/LoadPlugin.js): Decides which framework is best to use, and sends request.
32+
### [MIDI.loadPlugin.js](./js/midi/LoadPlugin.js) - Decides which framework is best to use
3333

3434
```javascript
3535
// interface to download soundfont, then execute callback;
@@ -42,7 +42,7 @@ MIDI.loadPlugin({
4242
});
4343
```
4444

45-
### [MIDI.Plugin.js](./js/midi/plugin.js): Ties together the following frameworks:
45+
### [MIDI.Plugin.js](./js/midi/plugin.js) - Controls MIDI output
4646

4747
```javascript
4848
MIDI.noteOn(channel, note, velocity, delay);
@@ -53,7 +53,7 @@ MIDI.keyToNote = object; // A0 => 21
5353
MIDI.noteToKey = object; // 21 => A0
5454
```
5555

56-
### [MIDI.Player.js](./js/midi/player.js): Streams the MIDI to the browser.
56+
### [MIDI.Player.js](./js/midi/player.js) - Plays MIDI stream
5757

5858
```javascript
5959
MIDI.Player.currentTime = integer; // time we are at now within the song.
@@ -66,7 +66,7 @@ MIDI.Player.pause(); // pause the MIDI track.
6666
MIDI.Player.stop(); // stops all audio being played, and resets currentTime to 0.
6767
```
6868

69-
### Callback whenever a note is played.
69+
### Listener for when notes are played
7070

7171
```javascript
7272
MIDI.Player.removeListener(); // removes current listener.
@@ -81,7 +81,7 @@ MIDI.Player.addListener(function(data) { // set it to your own function!
8181
});
8282
```
8383

84-
### Smooth animation, interpolates between onMidiEvent calls
84+
### Smooth animation interpolating between onMidiEvent calls
8585

8686
```javascript
8787
MIDI.Player.clearAnimation(); // clears current animation.
@@ -93,7 +93,7 @@ MIDI.Player.setAnimation(function(data) {
9393
});
9494
```
9595

96-
### Effects available for WebAudioContext (via Tuna.js)
96+
### Effects available for WebAudioContext via Tuna.js
9797

9898
```javascript
9999
MIDI.setEffects([
@@ -207,4 +207,4 @@ MIDI.setEffects([
207207
* [<audio>](http://dev.w3.org/html5/spec/Overview.html): HTML5 specs
208208
* Flash package: [SoundManager2](http://www.schillmania.com/projects/soundmanager2/) by [Scott Schiller](http://schillmania.com)
209209
* [jasmid](https://github.com/gasman/jasmid): Reads MIDI file byte-code, and translats into a Javascript array.
210-
* [base642binary.js](http://blog.danguer.com/2011/10/24/base64-binary-decoding-in-javascript/): Cleans up XML base64-requests for Web Audio API.
210+
* [base642binary.js](http://blog.danguer.com/2011/10/24/base64-binary-decoding-in-javascript/): Cleans up XML base64-requests for Web Audio API.

0 commit comments

Comments
 (0)