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

Plugin settings docs #36

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions book/pages/MOD_SETTINGS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Plugin settings

Provided you installed [ModSettings](https://github.com/jackhumbert/mod_settings) you can customize plugin settings, as follow:

| settings | possible values | default |
|-------------|------------------------------------|---------|
| buffer size | `auto` / `64` / `128` / `256` / `512` / `1024` | `auto` |

## Buffer size

`buffer size` refers to the amount of audio data that is processed *at one time*. It can directly affect the performance and responsiveness of your audio application.

- smaller buffer sizes reduce latency but require more processing power.
- larger buffer sizes increase stability at the cost of higher latency.

> `auto` is used when no specific buffer size is set and uses default behavior of your machine.
1 change: 1 addition & 0 deletions book/pages/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ It's built with emphasis on getting you going fast, providing sensible defaults
- [Spatialization](./SPATIALIZATION.md)
- [Internal docs](./DOCS.md)
- [Integration](./INTEGRATION.md)
- [Plugin settings](./MOD_SETTINGS.md)