pulseaudio-ctl(1)

🌸 NAME 🌸

Okay bestie, meet pulseaudio-ctl — it's the manual page for controlling pulseaudio's basic functions like the master volume level and mute status from a mapped key. Literally your little volume remote with main character energy. 💅✨

🫶 SYNOPSIS 🫶

pulseaudio-ctl [option1] [option2]

🌈 DESCRIPTION 🌈

Recommended usage of pulseaudio-ctl is to map a call to the script (see below) to a single keypress — yes, one keypress — so you can change mute status or quickly adjust master volume levels without breaking the vibe. Many keyboards have keys that are literally specific to these particular actions, and many if not all DE or WMs offer the ability to natively map a script call to a keypress or combo of key presses. For example, xfce4 allows for this under Settings > Keyboard > Application Shortcuts. Obsessed. 🎀

💖 CONFIG 💖

Persistent options are stored in $HOME/.config/pulseaudio-ctl/config, which is sufficiently commented for users to understand. Go inspect this file and uncomment those that suit your needs. Periodt, it's all right there. 🦋

✨ OPTIONS ✨

ngl, here's the full menu — every flag, every token, no skips:

• up — Adjust master volume up by 5 % (default) or up by another value defined as the 2nd token. ⬆️
• down — Adjust master volume down by 5 % (default) or down by another value defined as the 2nd token. ⬇️
• mute — Set the mute status of the master volume to the value defined in the 2nd token. Toggle by default. 🔇
• mute-input — Set the mute status of the input device (microphone for example) to the value defined in the 2nd token. Toggle by default. 🎙️
• set — Set the master volume level to the number specified as the 2nd token. 🎚️
• atmost — Like the 'set' option only takes effect if the current volume is higher than the 2nd token. 🤏
• current — Print the current volume level to STDOUT. 📢
• full-status — Print the current volume level, the sink mute state and the source mute state to STDOUT. 📊

🍓 EXAMPLES 🍓

Increase vol level by 5 %:

/usr/bin/pulseaudio-ctl up

Increase vol level by 25 %:

/usr/bin/pulseaudio-ctl up 25

Toogle mute current output — yes, the iconique “Toogle” stays, iykyk 😭:

/usr/bin/pulseaudio-ctl mute

Unmute current output:

/usr/bin/pulseaudio-ctl mute no

Set current vol level to 85 %:

/usr/bin/pulseaudio-ctl set 85

🧚 CONTRIBUTE 🧚

Should you wish to contribute to this code, please fork and send a pull request. Source is freely available on github: https://github.com/graysky2/pulseaudio-ctl. Slay. 🫶

💀 BUGS 💀

None known. That's the whole mood, fr fr. 💀✨

👑 AUTHOR 👑

graysky (graysky AT archlinux DOT us)

---

mwah 💋 — this iconic page is pulseaudio-ctl(1), dated 25 March 2017. That's the footer vibe, bestie; now go map those keys. 🎀