Skip to content
New issue

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

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

Already on GitHub? # to your account

Unify documentation under a few common concepts #6

Open
udoprog opened this issue Oct 10, 2022 · 0 comments
Open

Unify documentation under a few common concepts #6

udoprog opened this issue Oct 10, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@udoprog
Copy link
Owner

udoprog commented Oct 10, 2022

This library uses the following concepts:

  • Buffer refers to an object holding an audio buffer.
  • A sample is a single value from with in a buffer from a single channel.
  • Channel refers to a single channel inside of an audio buffer.
  • A frame refers to the group of channel at a given offset inside of an audio buffer.

The primary abstraction are buffers that contain 0 or more channels. Each buffer can also be viewed as a sequence of frames, where each frame contains the corresponding sample from every channel in that buffer.

@udoprog udoprog added the documentation Improvements or additions to documentation label Oct 10, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant