Skip to content

Mpris

Library and CLI tool for interacting and monitoring media players exposing an mpris interface through dbus.

An alternative for playerctl that better integrates with astal.

Usage

You can browse the Mpris reference.

CLI

sh
astal-mpris --help

Library

js
import Mpris from "gi://AstalMpris"

const spotify = Mpris.Player.new("spotify")

if (spotify.available) print(spotify.title)
py
from gi.repository import AstalMpris as Mpris

spotify = Mpris.Player.new("spotify")

if spotify.get_available():
    print(spotify.get_title())
lua
local Mpris = require("lgi").require("AstalMpris")

local spotify = Mpris.Player.new("spotify")

if spotify.available then
    print(spotify.title)
end
vala
// Not yet documented

Installation

WARNING

In order for network cover art urls to be cached (spotify for example) make sure gvfs is enabled.

nix
services.gvfs.enable = true;
  1. install dependencies

    sh
    sudo pacman -Syu meson vala valadoc gvfs json-glib gobject-introspection
    sh
    sudo dnf install meson vala valadoc gvfs json-glib-devel gobject-introspection-devel
    sh
    sudo apt install meson valac valadoc gvfs libjson-glib-dev gobject-introspection
  2. clone repo

    sh
    git clone https://github.com/aylur/astal.git
    cd astal/lib/mpris
  3. install

    sh
    meson setup build
    meson install -C build

Released under the LGPL v2.1 License