LUASTATUS-PLUGIN-ALSA(7)

🌸 NAME 🌸

okay bestie, welcome to luastatus-plugin-alsa(7) — it's from the Miscellaneous Information Manual, and it's literally the ALSA plugin for luastatus 💅

✨ OVERVIEW ✨

bestie, this plugin monitors the volume and mute state of an ALSA channel. that's the whole vibe. no cap.

💅 OPTIONS 💅

The following options are supported:

• card — string. Card name, defaults to "default" ✨
• channel — string. Channel name, defaults to "Master" 🎀
• in_db — boolean. Whether or not to report normalized volume (in dBs) 🌸
• capture — boolean. Whether or not this is a capture stream, as opposed to a playback one. Defaults to false 💖
• timeout — number. If specified and not negative, this plugin will call cb with nil argument whenever the channel does not change its state in timeout seconds since the previous call to cb ⭐
• make_self_pipe — boolean. If true, the wake_up() (see the Functions section) function will be available. Defaults to false 🦋

okay so the timeout move only applies when it's specified and not negative — that's the exact condition, bestie, no extra lore 🙈

🫶 cb argument 🫶

On timeout, nil (if the timeout option has been specified).

Otherwise, the argument is a table with the following entries:

• mute — boolean. Whether or not the playback switch is turned off.

(Only provided if the channel has the playback switch capability.) 💀

• vol — table with the following entries:
  • cur, min, max — numbers. Current, minimal and maximal volume levels, correspondingly.

(Only provided if the channel has the volume control capability.) 🔥

🦋 FUNCTIONS 🦋

The following functions are provided:

• wake_up() — Forces a call to cb.

Only available if the make_self_pipe option was set to true; otherwise, it throws an error 😭

🌈 COPYRIGHT 🌈

LGPLv3 👑

---

okay that's the whole page, bestie 💖 the original footer just repeats luastatu...ugin-alsa(7) — no extra source/version or date line is listed there, so this is your cute sign-off instead: luastatus-plugin-alsa(7) 🦋✨🎀