astal/docs/libraries/wireplumber.md

Wire Plumber

Wrapper library over wireplumber to better integrate with Astal.

Installation

1. install dependencies

:::code-group

sudo pacman -Syu meson vala wireplumber gobject-introspection

sudo dnf install meson gcc valac wireplumber-devel gobject-introspection-devel

# Not yet documented

:::

2. clone repo

git clone https://github.com/aylur/astal.git
cd astal/lib/wireplumber

3. install

meson setup build
meson install -C build

:::tip Most distros recommend manual installs in /usr/local, which is what meson defaults to. If you want to install to /usr instead which most package managers do, set the prefix option:

meson setup --prefix /usr build

:::

Usage

You can browse the Wireplumber reference.

CLI

There is no CLI for this library, use the one provided by wireplumber.

wpctl --help

Library

:::code-group

import Wp from "gi://AstalWp"

const audio = Wp.get_default().audio

print(audio.default_speaker.volume)

from gi.repository import AstalWp as Wp

audio = Wp.get_default().get_audio()

print(audio.get_default_speaker().get_volume())

local Wp = require("lgi").require("AstalWp")

local audio = Wp.get_default().audio

print(audio.default_speaker.volume)

// Not yet documented

:::