yvesgurcan/web-midi-player

Add section about audio controls in README

Opened this issue · 0 comments

Explampify with code how to use pause, resume, and stop in the "Getting started" section of the README and also in the documentation thanks to JSDoc.

/**
* Pauses playback of MIDI input.
* @param {undefined}
* @return {boolean} Whether playback was successfully paused or not.
* @example
* midiPlayer.pause();
*/
pause() {

/**
* Resumes playback of MIDI input.
* @param {undefined}
* @return {boolean} Whether playback was successfully ressumed or not.
* @example
* midiPlayer.resume();
*/
resume() {

* Stops playback of MIDI input.
* @param {undefined}
* @return {boolean} Whether playback was successfully stopped or not.
* @example
* midiPlayer.stop();
*/
stop() {