summaryrefslogtreecommitdiff
path: root/docs/libraries/mpris.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libraries/mpris.md')
-rw-r--r--docs/libraries/mpris.md100
1 files changed, 0 insertions, 100 deletions
diff --git a/docs/libraries/mpris.md b/docs/libraries/mpris.md
deleted file mode 100644
index dfe7956..0000000
--- a/docs/libraries/mpris.md
+++ /dev/null
@@ -1,100 +0,0 @@
-# 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)
- print(spotify.title)
-```
-
-```py [<i class="devicon-python-plain"></i> Python]
-from gi.repository import AstalMpris as Mpris
-
-spotify = Mpris.Player.new("spotify")
-
-if spotify.get_available():
- print(spotify.get_title())
-```
-
-```lua [<i class="devicon-lua-plain"></i> Lua]
-local Mpris = require("lgi").require("AstalMpris")
-
-local spotify = Mpris.Player.new("spotify")
-
-if spotify.available then
- print(spotify.title)
-end
-```
-
-```vala [<i class="devicon-vala-plain"></i> Vala]
-// Not yet documented
-```
-
-:::