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 #4

Open
devongovett opened this issue Aug 7, 2012 · 7 comments
Open

Documentation #4

devongovett opened this issue Aug 7, 2012 · 7 comments

Comments

@devongovett
Copy link
Member

What do you think of doing an annotated version of the source using docco? Obviously pitch.js isn't particularly hard to use, but I think a docco version of the source (if annotated well) could be interesting to people and help them understand the source, and maybe we'd get more outside contributors because of that. Anyway, just a thought.

jussi-kalliokoski added a commit that referenced this issue Aug 8, 2012
@jussi-kalliokoski
Copy link
Member

Yes, it's worth thinking about. For now, I uploaded at least some docs generated by the build scripts I have in sink.js :D

@jussi-kalliokoski
Copy link
Member

Oops, it's missing the important methods. Oh well, will fix later.

@coleww
Copy link

coleww commented May 3, 2014

This is way old, but I just found this library and I'm not clear on how to use it. Some docs of the available methods would be very helpful, or especially a simple code example that gets the audio context, hooks up the mic, and displays pitch.

I'm trying to make an app that converts guitar notes into brainfuck code and then runs it

@crackofdusk
Copy link
Member

@coleww You can check out the example here: https://github.com/audiocogs/pitch.js-demo

@clu3
Copy link

clu3 commented May 5, 2014

@crackofdusk i've setup the site but i only see some wheels and some access-mic permission flash setting, what am i supposed to do with this demo? Thanks

@crackofdusk
Copy link
Member

@clu3 Authorize mic access, then try singing a note. The pitch detector will use mic input as its input.

@clu3
Copy link

clu3 commented May 5, 2014

Thanks @crackofdusk I got it running.
I'm playing with pitch.js. I'm trying to compare the pitch between a user's recording and a given sample mp3 file, just to see if the English learner speaks English in the right tone. Hopefully pitch.js can really give me the data so I can draw 2 graphs that users can actually see and compare for themselves

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

5 participants