mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-02 09:01:50 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve README

Browse source
This commit is contained in:
Wim Taymans 2020-06-11 21:18:32 +02:00
parent cdda6ca329
commit 85b6d97b21
1 changed files with 28 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

46
README.md
View file

@ -20,7 +20,7 @@ distribution package system. This ensures PipeWire is integrated
into the rest of your system for the best experience. into the rest of your system for the best experience.
If you want to build and install PipeWire yourself, refer to If you want to build and install PipeWire yourself, refer to
INSTALL.md for instructions. [install](INSTALL.md) for instructions.
## Usage ## Usage
@ -38,15 +38,15 @@ or with the provided scripts shown below.
PipeWire can use environment variables to control the behaviour of PipeWire can use environment variables to control the behaviour of
applications: applications:
* PIPEWIRE_DEBUG=<level> to increase the debug level * `PIPEWIRE_DEBUG=<level>` to increase the debug level
* PIPEWIRE_LOG=<filename> to redirect log to filename * `PIPEWIRE_LOG=<filename>` to redirect log to filename
* PIPEWIRE_LATENCY=<num/denom> to configure latency * `PIPEWIRE_LATENCY=<num/denom>` to configure latency
* PIPEWIRE_NODE=<id> to request link to specified node * `PIPEWIRE_NODE=<id>` to request link to specified node
### Using tools ### Using tools
pw-cat can be used to play and record audio and midi. Use pw-cat -h to get `pw-cat` can be used to play and record audio and midi. Use `pw-cat -h` to get
some more help. There are some aliases like pw-play and pw-record to make some more help. There are some aliases like `pw-play` and `pw-record` to make
things easier: things easier:
``` ```
@ -60,13 +60,13 @@ JACK side-by-side or have PipeWire take over the functionality of JACK
completely. completely.
In dual mode, JACK apps will by default use the JACK server. To direct a JACK In dual mode, JACK apps will by default use the JACK server. To direct a JACK
app to PipeWire, you can use the pw-jack script like this: app to PipeWire, you can use the `pw-jack` script like this:
``` ```
$ pw-jack <appname> $ pw-jack <appname>
``` ```
If you replaced JACK with PipeWire completely, pw-jack does not have any If you replaced JACK with PipeWire completely, `pw-jack` does not have any
effect and can be ommited. effect and can be ommited.
### Running PulseAudio applications ### Running PulseAudio applications
@ -76,7 +76,7 @@ PulseAudio side-by-side or have PipeWire take over the functionality of
PulseAudio completely. We don't recommend to completely replace PulseAudio PulseAudio completely. We don't recommend to completely replace PulseAudio
at this point. at this point.
Use the pw-pulse script to launch a PulseAudio application on PipeWire, like: Use the `pw-pulse` script to launch a PulseAudio application on PipeWire, like:
``` ```
$ pw-pulse <appname> $ pw-pulse <appname>
@ -90,13 +90,13 @@ If the PipeWire alsa module is installed, it can be seen with
$ aplay -L $ aplay -L
``` ```
Alsa application can then use the pipewire: device to use PipeWire Alsa application can then use the `pipewire:` device to use PipeWire
as the audio system. as the audio system.
### Running GStreamer applications ### Running GStreamer applications
PipeWire includes 2 GStreamer elements called pipewiresrc and PipeWire includes 2 GStreamer elements called `pipewiresrc` and
pipewiresink. They can be used in pipelines like this: `pipewiresink`. They can be used in pipelines like this:
``` ```
$ gst-launch-1.0 pipewiresrc ! videoconvert ! autovideosink $ gst-launch-1.0 pipewiresrc ! videoconvert ! autovideosink
@ -120,20 +120,30 @@ automatically use the PipeWire video source when possible.
### Inspecting the PipeWire state ### Inspecting the PipeWire state
There is currently no native graphical tool to inspect the PipeWire graph There is currently no native graphical tool to inspect the PipeWire graph
but we recommend to use one of the excellent JACK tools, such as Carla, but we recommend to use one of the excellent JACK tools, such as `Carla`,
catia, qjackctl,... You will not be able to see all features like the video `catia`, `qjackctl`,... You will not be able to see all features like the video
ports but it is a good start. ports but it is a good start.
pw-mon dumps and monitors the state of the PipeWire daemon. `pw-mon` dumps and monitors the state of the PipeWire daemon.
pw-dot can dump a graph of the pipeline, checkout out the help for `pw-dot` can dump a graph of the pipeline, checkout out the help for
how to do this. how to do this.
There is a more complicated tools to inspect the state of the server There is a more complicated tools to inspect the state of the server
with pw-cli. This tools can be used interactively or it can execute with `pw-cli`. This tools can be used interactively or it can execute
single commands like this to get the server information: single commands like this to get the server information:
``` ```
$ pw-cli info 0 $ pw-cli info 0
``` ```
## Contributing
PipeWire is Free Software and is developed in the open. It is licensed under
the MIT license.
Contributors are encouraged to submit merge requests or file bugs on gitlab,
Join us on IRC at #pipewire on Freenode.
We adhere to the Contributor Covenant for our [code of conduct](CODE_OF_CONDUCT.md).