Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add section about audio controls in README #97

Open
yvesgurcan opened this issue Jan 20, 2020 · 0 comments
Open

Add section about audio controls in README #97

yvesgurcan opened this issue Jan 20, 2020 · 0 comments
Labels
📖 documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@yvesgurcan
Copy link
Owner

yvesgurcan commented Jan 20, 2020

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() {

@yvesgurcan yvesgurcan added 📖 documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant