Go to file

Milan Zamazal cc8fa0336e Document CLASS cl-defgeneric arguments This is needed to make checkdoc happy. The wording is not very good because checkdoc insists on using one of the predefined words before `pw-accessor’.		2022-07-12 21:27:19 +02:00
.gitignore	Initial commit	2022-06-04 21:51:45 +02:00
LICENSE	Initial commit	2022-06-04 21:51:45 +02:00
pipewire-zero-pkg.el	Use Version instead of Package-Version in package headers	2022-07-04 19:04:42 +02:00
pipewire.el	Rename pw-ui.el to pipewire.el	2022-07-12 21:15:58 +02:00
pw-access.el	Document CLASS cl-defgeneric arguments	2022-07-12 21:27:19 +02:00
pw-lib.el	Silence checkdoc messages about docstrings of internal objects	2022-07-06 10:20:27 +02:00
README.org	README a bit updated	2022-06-28 21:04:48 +02:00
screenshot.jpg	Screenshot updated	2022-06-18 10:33:00 +02:00

README.org

pipewire-0

Usage
Notes
- Why is it named pipewire-0?
Contact

pipewire-0 is an Emacs interface to PipeWire. It provides a library to access some PipeWire functionality and a simple user interface to handle audio devices. It allows displaying PipeWire devices and clients, changing volumes and muting and unmuting of PipeWire sinks and sources and setting default sinks and sources.

pipewire-0 currently relies on the output of the PipeWire command line tools. It works for me but it may not work in other environments. Feel free to use it, fix it, fork it. Contact me if you want to discuss anything.

Usage

Installation

pipewire-0 currently requires presence of PipeWire command line tools, namely pw-cli and pw-metadata.

To install pipewire-0, put the *.el files to a site-lisp directory and add the following line to your Emacs configuration:

(require ’pw-ui)

Or if you use straight.el, you can install pipewire-0 as follows:

(straight-use-package
'(pipewire-0 :type git
           :repo "https://git.zamazal.org/pdm/pipewire-0"
           :local-repo "pipewire-0"))

User interface

M-x pipewire enters a buffer with PipeWire objects:

Use C-h m to display basic help.

Most of the interactive functions can be used anywhere:

pipewire-increase-volume
pipewire-decrase-volume
pipewire-set-volume
pipewire-toggle-muted
pipewire-toggle-microphone
pipewire-set-default

They can be bound to multimedia keys:

(global-set-key (kbd "<XF86AudioMute>") 'pipewire-toggle-muted)
(global-set-key (kbd "<XF86AudioLowerVolume>") 'pipewire-decrease-volume)
(global-set-key (kbd "<XF86AudioRaiseVolume>") 'pipewire-increase-volume)

Configuration

M-x customize-group RET pipewire RET

Library

pipewire-0 consists of the following source files:

pw-lib.el: PipeWire library to be used in Elisp programs.
pw-access.el: PipeWire communication interface, not supposed to be used outside pw-lib.
pw-ui.el: User commands and interface.

Look into pw-lib.el to see what public pw-lib-* functions are available there. For example, the following snippet can be used to display current volume level of the default audio sink:

(let ((object (pw-lib-default-audio-sink)))
(format "%s%s"
       (pw-lib-volume object t)
       (if (pw-lib-muted-p object) "(M)" "")))

Notes

PipeWire is currently accessed using pw-cli command line utility. pw-cli output is apparently undocumented and changes between versions so this is not a reliable way to communicate with PipeWire. But I don’t know about anything better currently. Nevertheless, it’s easy to replace pw-cli with something else in pw-access.el.

Why is it named pipewire-0?

I wrote pipewire-0 because I couldn’t find any Emacs interface to PipeWire. I would name it simply pipewire or pipewire-el but I expect that someone will write a full-fledged PipeWire interface sooner or later. I’d like to avoid confusion and reserve the plain name for the future interface, while having the basic above zero, pipewire-0, support for now.

Contact

pipewire-0 is available at git.zamazal.org. You can file issues there.

If you don’t want to discuss things publicly or to bother registering at yet another web site, you can reach me at pdm@zamazal.org.

README.org Unescape Escape