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

Feat: add more docs? #11

Open
quenbyako opened this issue Dec 28, 2020 · 1 comment
Open

Feat: add more docs? #11

quenbyako opened this issue Dec 28, 2020 · 1 comment

Comments

@quenbyako
Copy link
Contributor

Well, you know, docs are great! Personally i didn't understood, what's differences between generator and channel, why some effects are hardcoded, etc. I can contribute, but i don't understand most of mechanics in this package

@bspaans
Copy link
Owner

bspaans commented Dec 30, 2020

Yeah, the project is a bit light on docs. I think what could be useful is to have a short tutorial with code samples to talk a bit more on how to achieve certain things, because I'm not sure godoc is the right place for it (although the godocs certainly could use some love as well)

To answer your question: generators are the basic sound generating building block; usually you want your generator to play certain notes at certain time intervals etc. so in this case you can put your generator in a channel, which has e.g. NoteOn and NoteOff methods to control when the generator outputs samples. The Sequencer implementation takes multiple of these channels (described as ChannelDefs) and is then able to do automations, play MIDI, etc. Hope that helped a bit.

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

2 participants