Wire Plumber

Wrapper library over wireplumber to better integrate with Astal.

Usage

You can browse the Wireplumber reference.

CLI

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

wpctl --help

Library

The AstalWp library is initialized asynchronously; therefore, all lists (e.g. audio.speakers) are initially empty, and the properties have default values. This is usually not an issue. When you bind to these values, your widget will receive updates as soon as the library has loaded the data. However, this means that you won't get the correct data when accessing the library's properties at the top level. To accommodate this, it emits the ready signal once, as soon as the initial data has been loaded.

JavaScript

import Wp from "gi://AstalWp"

const wp = Wp.get_default()
const default_speaker = wp.audio.default_speaker;

wp.connect("ready", () => {
    print(default_speaker.volume)
}

Python

from gi.repository import AstalWp as Wp

audio = Wp.get_default().get_audio()

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

Lua

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

local audio = Wp.get_default().audio

print(audio.default_speaker.volume)

Vala

// Not yet documented

Installation

1. install dependencies

   Arch

   sudo pacman -Syu meson vala valadoc wireplumber gobject-introspection

   Fedora

   sudo dnf install meson vala valadoc wireplumber-devel gobject-introspection-devel

   Ubuntu

   # 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