| context |
@@ -392,36 +402,36 @@
- | sampleRate |
+ eventLogger |
- number
+ function
|
- : The sample rate of the AudioContext.
+ | : The function that is called to emit events.
|
- | eventLogger |
+ logging |
- function
+ boolean
|
- : The function that is called to emit events.
+ | : Whether console logging is ON or OFF.
|
- | logging |
+ isFirstInstance |
boolean
|
- : Whether console logging is ON or OFF.
+ | : Whether this is the first instance of the Midi Player or
|
@@ -463,6 +473,30 @@
+
+ | playerId |
+
+ string
+
+ |
+ : ID of this instance of Midi Player.
+ |
+
+
+
+
+
+ | sampleRate |
+
+ number
+
+ |
+ : The sample rate of the AudioContext.
+ |
+
+
+
+
| source |
@@ -500,24 +534,25 @@
- | waveBuffer |
+ volume |
- any
+ number
|
- : The buffer with the MIDI data converted to WAV.
+ | : Playback volume.
|
- | isFirstInstance |
+ waveBuffer |
- boolean
+ any
|
- : Whether this is the first instance of the Midi Player or not.
+ | : The buffer with the MIDI data converted to WAV.
+not.
|
@@ -1101,6 +1136,150 @@ Examples
+
+
+
+
+
+
+
+
+
+
+
+ Gets the current volume of the playback.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns
+ number
+ :
+ The current volume.
+
+
+
+
+
+
+
+
+ Examples
+
+
+ const volume = midiPlayer.getVolume();
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets the current volume of the playback.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ | parameter |
+ type |
+ description |
+
+
+
+ input |
+
+ object
+
+ |
+ |
+
+
+
+
+ | input.volume |
+
+ number
+
+ |
+ The new value for the volume (also known as gain). Typically, a whole number between 0 and 100 but can actually be negative, greater, or even a decimal number.
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Examples
+
+
+ midiPlayer.setVolume({ volume: 80 });
+
+
+
+
+
+
+
+
+
+
diff --git a/example/javascript/package.json b/example/javascript/package.json
index aa99ef5..6a84f2d 100644
--- a/example/javascript/package.json
+++ b/example/javascript/package.json
@@ -4,7 +4,7 @@
"scripts": {
"start": "serve -l 8081 --symlinks",
"lint": "prettier --write **/*.js",
- "link:make": "ln -s ../../../index.js ./src/web-midi-player.js",
+ "link:make": "npm run link:delete && ln -s ../../../index.js ./src/web-midi-player.js",
"link:delete": "rm ./src/web-midi-player.js"
},
"devDependencies": {
diff --git a/example/javascript/src/player-handler.js b/example/javascript/src/player-handler.js
index 4eb2809..81dc9fb 100644
--- a/example/javascript/src/player-handler.js
+++ b/example/javascript/src/player-handler.js
@@ -6,11 +6,7 @@ const MIDI_ERROR = 'MIDI_ERROR';
let midiPlayer = null;
-const eventLogger = payload => {
- console[event === MIDI_ERROR ? 'error' : 'log'](payload);
-};
-
-midiPlayer = new MidiPlayer({ eventLogger, patchUrl: 'patches/' });
+midiPlayer = new MidiPlayer({ logging: true, patchUrl: 'patches/' });
const songElements = document.getElementsByClassName('Player__Song');
diff --git a/example/react/index.html b/example/react/index.html
index 397871a..82fe2a2 100644
--- a/example/react/index.html
+++ b/example/react/index.html
@@ -5,5 +5,5 @@
-
+ | |