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

Documentation unclear for ToneEvent #1281

Open
strawstack opened this issue Sep 25, 2024 · 0 comments
Open

Documentation unclear for ToneEvent #1281

strawstack opened this issue Sep 25, 2024 · 0 comments

Comments

@strawstack
Copy link

Describe the bug
On the ToneEvent page in the docs, there is example code, but this code does not actually cause a sound to play when run. One has to look elsewhere to learn that Tone.getTransport().start() must be called. The line Tone.getTransport().start(); should be included on the doc page for ToneEvent.

To Reproduce
Visit https://tonejs.github.io/docs/15.0.4/classes/ToneEvent.html and copy paste then run the example code. Nothing will happen. The users must read a lot of other docs to learn why this code does not produce any sound.

Expected behavior
I would expect to be able to play a sound if I copy paste example code from a tutorial page into my local environment.

What I've tried
I tried a lot to get ToneEvent to work. Finally, I stumbled across the answer about how to get ToneEvent to work when looking at Scheduling in the other part of the tutorial: https://tonejs.github.io/#scheduling

Additional context
Link to relevant documentation: https://tonejs.github.io/docs/15.0.4/classes/ToneEvent.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant