pulseaudio-ctl

Section: (1)
Updated: 25 March 2017
Page Index

NAME

pulseaudio-ctl - Control pulseaudio's basic functions such as the master volume level and mute status from a mapped key.

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 for easy access to change mute status or quickly adjust master volume levels. Many keyboards have keys 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.

CONFIG

Persistent options are stored in $HOME/.config/pulseaudio-ctl/config which is sufficiently commented for users to understand.: Inspect this file and uncomment those that suit your needs.

OPTIONS

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

        /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

BUGS

None known

AUTHOR

graysky (graysky AT archlinux DOT us)