From a22602f436c08a6b1d1651f2e07d8026dc5833b9 Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Thu, 18 Feb 2021 16:18:15 +0100 Subject: [PATCH] README: update some documentation --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 6d8bf70dd..a80dbfc69 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,17 @@ $ pw-jack If you replaced JACK with PipeWire completely, `pw-jack` does not have any effect and can be omitted. +JACK applications will automatically use the buffer-size choosen by the +server. You can force a maximum buffer size (latency) by setting the +`PIPEWIRE_LATENCY` environment variable like so: + +``` +PIPEWIRE_LATENCY=128/48000 jack_simple_client +``` +Requests the `jack_simple_client` to run with a buffer of 128 or +less samples. + + ### Running PulseAudio applications PipeWire can run a PulseAudio compatible replacement server. You can't @@ -97,6 +108,10 @@ Server Name: PulseAudio (on PipeWire 0.3.x) ... ``` +You can use pavucontrol to change profiles and ports, change volumes +or redirect streams, just like with PulseAudio. + + ### Running ALSA applications If the PipeWire alsa module is installed, it can be seen with @@ -145,6 +160,14 @@ ports but it is a good start. `pw-dot` can dump a graph of the pipeline, check out the help for how to do this. +`pw-top` monitors the real-time status of the graph. This is handy to +find out what clients are running and how much DSP resources they +use. + +`pw-dump` dumps the state of the PipeWire daemon in JSON format. This +can be used to find out the properties and parameters of the objects +in the PipeWire daemon. + There is a more complicated tool to inspect the state of the server with `pw-cli`. This tools can be used interactively or it can execute single commands like this to get the server information: