Skip to content

Commit

Permalink
Add docs for nperiods
Browse files Browse the repository at this point in the history
  • Loading branch information
vrslev committed Jan 31, 2024
1 parent eafc4b3 commit 40d2466
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ server = jack_server.Server(
device="BuiltInSpeakerDevice",
rate=48000,
period=1024,
# nperiods=2 # Work only with `alsa` driver
)
server.start()

Expand Down Expand Up @@ -93,6 +94,12 @@ Sampling rate.

Buffer size.

#### `nperiods: int`

Number of periods. 2 is right for motherboard, PCI, PCI-X, etc.; 3 for USB ([source](https://wiki.archlinux.org/title/JACK_Audio_Connection_Kit)).

Can be helpful when tailoring performance on jittery systems.

#### `params: dict[str, jack_server.Parameter]`

Driver parameters mapped by name.
Expand Down

0 comments on commit 40d2466

Please sign in to comment.