audiojs / web-audio-api

Node.js implementation of Web audio API
MIT License
817 stars 67 forks source link

Enhance README examples... #48

Open q2dg opened 8 years ago

q2dg commented 8 years ago

Specifically, please substitute "Create some audio nodes here to make some noise ..." comment by some real code. People who don't know/remember how to create audio nodes (or who don't want to spend time on it) won't hear anything if they directly try to execute these examples, and that's a pity for doing a fast glance of the capabilities of this module. Thanks!

sebpiq commented 8 years ago

There is examples ... but true, there could be more, and there could be a clearer link in the README.

However, the specific section you are referring to is about how to connect node-web-audio-api to the sound of your OS as there is no builtin way to do it. Therefore, there shouldn't be any sound example there because it would make the explanations harder to read.

q2dg commented 8 years ago

What about using node-speaker (https://github.com/TooTallNate/node-speaker)?

sebpiq commented 8 years ago

No ... it was a dependency of the library at the beginning, but I since changed my mind :

1) there is no reason to tie this with node-speaker as there is many other options for sound playback (as in examples : icecast, aplay ...)

2) node-speaker breaks quite often and can't compile on some OSes.

q2dg commented 8 years ago

I didn't refer to adding node-speaker as a dependency but adding it to the Readme examples in a way to have a fast, dirty but functional codes ready to prove. Now they are incomplete, so people must do the job of completing them to have something "working". If you don't like node-speaker, another option is redirecting the sound to a generic writablestream...but well, anyway, thanks a lot