diff options
author | Aylur <[email protected]> | 2024-09-11 13:30:43 +0000 |
---|---|---|
committer | Aylur <[email protected]> | 2024-09-11 13:30:51 +0000 |
commit | 137345755c1c02d4766f1788198096013df9080c (patch) | |
tree | 19fdc58f9ba48edd2e2f5121da9ac169ad1651cf /docs/libraries/mpris.md | |
parent | 56dd3eb43d218d6099d760f6c0c4956db84c46f2 (diff) |
docs: document libraries
Diffstat (limited to 'docs/libraries/mpris.md')
-rw-r--r-- | docs/libraries/mpris.md | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/docs/libraries/mpris.md b/docs/libraries/mpris.md index 57a4da6..d277b24 100644 --- a/docs/libraries/mpris.md +++ b/docs/libraries/mpris.md @@ -1 +1,89 @@ # Mpris + +Library and CLI tool for interacting and monitoring media players +exposing an mpris interface through dbus. + +An alternative for [playerctl](https://github.com/altdesktop/playerctl) that better integrates +with astal. + +## Installation + +1. install dependencies + +:::code-group + +```sh [<i class="devicon-archlinux-plain"></i> Arch] +sudo pacman -Syu meson vala json-glib gobject-introspection +``` + +```sh [<i class="devicon-fedora-plain"></i> Fedora] +sudo dnf install meson gcc valac json-glib-devel gobject-introspection-devel +``` + +```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu] +sudo apt install meson valac 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 +``` + +:::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: + +```sh +meson setup --prefix /usr build +``` + +::: + +## Usage + +You can browse the [Mpris reference](https://aylur.github.io/libastal/mpris). + +### CLI + +```sh +astal-mpris --help +``` + +### Library + +:::code-group + +```js [<i class="devicon-javascript-plain"></i> JavaScript] +import Mpris from "gi://AstalMpris"; + +const spotify = Mpris.Player.new("spotify") + +if (spotify.available) + console.log(spotify.title) +``` + +```py [<i class="devicon-python-plain"></i> Python] +# Not yet documented +``` + +```lua [<i class="devicon-lua-plain"></i> Lua] +-- Not yet documented +``` + +```vala [<i class="devicon-vala-plain"></i> Vala] +// Not yet documented +``` + +::: |