diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/default.nix | 7 | ||||
| -rw-r--r-- | docs/guide/libraries/cava.md | 91 | ||||
| -rw-r--r-- | docs/guide/typescript/widget.md | 8 | ||||
| -rw-r--r-- | docs/vitepress.config.ts | 1 |
4 files changed, 103 insertions, 4 deletions
diff --git a/docs/default.nix b/docs/default.nix index 0d79ce1..1370fc6 100644 --- a/docs/default.nix +++ b/docs/default.nix @@ -154,6 +154,13 @@ in version = ../lib/bluetooth/version; }} ${genLib { + flakepkg = "cava"; + gir = "Cava"; + description = "Audio visualization library using cava"; + version = ../lib/cava/version; + authors = "kotontrion"; + }} + ${genLib { flakepkg = "hyprland"; gir = "Hyprland"; description = "IPC client for Hyprland"; diff --git a/docs/guide/libraries/cava.md b/docs/guide/libraries/cava.md new file mode 100644 index 0000000..e695e16 --- /dev/null +++ b/docs/guide/libraries/cava.md @@ -0,0 +1,91 @@ +# Cava + +Audio visualizer using [cava](https://github.com/karlstav/cava). + +## Installation + +1. install dependencies + +Note that it requires [libcava](https://github.com/LukashonakV/cava), a fork of cava, which provides cava as a shared library. + +:::code-group + +```sh [<i class="devicon-archlinux-plain"></i> Arch] +sudo pacman -Syu meson vala gobject-introspection +paru -S libcava +``` + +```sh [<i class="devicon-fedora-plain"></i> Fedora] +# Not yet documented +``` + +```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu] +# Not yet documented +``` + +::: + +2. clone repo + +```sh +git clone https://github.com/aylur/astal.git +cd astal/lib/cava +``` + +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 [Cava reference](https://aylur.github.io/libastal/cava). + +### CLI + +There is no CLI for this library, use the one provided by cava. + +```sh +cava +``` + +### Library + +:::code-group + +```js [<i class="devicon-javascript-plain"></i> JavaScript] +import Cava from "gi://AstalCava" + +const cava = Cava.get_default() + +cava.connect("notify::values", () => { + print(cava.get_values()) +}) +``` + +```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 +``` + +::: diff --git a/docs/guide/typescript/widget.md b/docs/guide/typescript/widget.md index 3bdf394..7ed69e3 100644 --- a/docs/guide/typescript/widget.md +++ b/docs/guide/typescript/widget.md @@ -197,18 +197,18 @@ These widgets are available by default in JSX. - button: [Astal.Button](https://aylur.github.io/libastal/astal3/class.Button.html) - centerbox: [Astal.CenterBox](https://aylur.github.io/libastal/astal3/class.CenterBox.html) - circularprogress: [Astal.CircularProgress](https://aylur.github.io/libastal/astal3/class.CircularProgress.html) -- drawingarea: [Gtk.DrawingArea](https://docs.gtk.org/gtk3/astal3/class.DrawingArea.html) -- entry: [Gtk.Entry](https://docs.gtk.org/gtk3/astal3/class.Entry.html) +- drawingarea: [Gtk.DrawingArea](https://docs.gtk.org/gtk3/class.DrawingArea.html) +- entry: [Gtk.Entry](https://docs.gtk.org/gtk3/class.Entry.html) - eventbox: [Astal.EventBox](https://aylur.github.io/libastal/astal3/class.EventBox.html) - icon: [Astal.Icon](https://aylur.github.io/libastal/astal3/class.Icon.html) - label: [Astal.Label](https://aylur.github.io/libastal/astal3/class.Label.html) - levelbar: [Astal.LevelBar](https://aylur.github.io/libastal/astal3/class.LevelBar.html) - overlay: [Astal.Overlay](https://aylur.github.io/libastal/astal3/class.Overlay.html) -- revealer: [Gtk.Revealer](https://docs.gtk.org/gtk3/astal3/class.Revealer.html) +- revealer: [Gtk.Revealer](https://docs.gtk.org/gtk3/class.Revealer.html) - scrollable: [Astal.Scrollable](https://aylur.github.io/libastal/astal3/class.Scrollable.html) - slider: [Astal.Slider](https://aylur.github.io/libastal/astal3/class.Slider.html) - stack: [Astal.Stack](https://aylur.github.io/libastal/astal3/class.Stack.html) -- switch: [Gtk.Switch](https://docs.gtk.org/gtk3/astal3/class.Switch.html) +- switch: [Gtk.Switch](https://docs.gtk.org/gtk3/class.Switch.html) - window: [Astal.Window](https://aylur.github.io/libastal/astal3/class.Window.html) ## Gtk4 diff --git a/docs/vitepress.config.ts b/docs/vitepress.config.ts index 2df3eea..f542a68 100644 --- a/docs/vitepress.config.ts +++ b/docs/vitepress.config.ts @@ -104,6 +104,7 @@ export default defineConfig({ { text: "Auth", link: "/guide/libraries/auth" }, { text: "Battery", link: "/guide/libraries/battery" }, { text: "Bluetooth", link: "/guide/libraries/bluetooth" }, + { text: "Cava", link: "/guide/libraries/cava" }, { text: "Hyprland", link: "/guide/libraries/hyprland" }, { text: "Mpris", link: "/guide/libraries/mpris" }, { text: "Network", link: "/guide/libraries/network" }, |