XMonad.Actions.Volume

A minimal interface to the "amixer" command-line utility.

Usage

You can use this module with the following in your ~/.xmonad/xmonad.hs:

 import XMonad.Actions.Volume

then add appropriate keybinds to adjust the volume; for example:

 , ((modMask x, xK_F8 ), lowerVolume 3 >> return ())
 , ((modMask x, xK_F9 ), raiseVolume 3 >> return ())
 , ((modMask x, xK_F10), toggleMute    >> return ())

For detailed instructions on editing your key bindings, see XMonad.Doc.Extending.

Common functions

toggleMute :: MonadIO m => m Bool

Toggle mutedness on the default channels. Returns True when this attempts to mute the speakers and False when this attempts to unmute the speakers.

raiseVolume :: MonadIO m => Double -> m Double

Raise the volume on the default channels the given number of percentage points. Returns the volume it attempts to set.

lowerVolume :: MonadIO m => Double -> m Double

Lower the volume on the default channels the given number of percentage points. Returns the volume it attempts to set.

Low-level interface

getVolume :: MonadIO m => m Double

Get the geometric mean of the volumes on the default channels.

getMute :: MonadIO m => m Bool

Get the mutedness of the default channels. Returns True if any of the channels are muted, and False otherwise.

getVolumeMute :: MonadIO m => m (Double, Bool)

Get both the volume and the mutedness of the default channels.

setVolume :: MonadIO m => Double -> m ()

Attempt to set the default channels to a volume given in percentage of maximum.

setMute :: MonadIO m => Bool -> m ()

Attempt to set the muting on the default channels.

setVolumeMute :: MonadIO m => Double -> Bool -> m ()

Attempt to set both the volume in percent and the muting on the default channels.

modifyVolume :: MonadIO m => (Double -> Double) -> m Double

Apply a function to the volume of the default channels, and return the modified value.

modifyMute :: MonadIO m => (Bool -> Bool) -> m Bool

Apply a function to the muting on the default channels, and return the modified value.

modifyVolumeMute :: MonadIO m => (Double -> Bool -> (Double, Bool)) -> m (Double, Bool)

Apply a function to both the volume and the muting of the default channels, and return the modified values.

Variants that take a list of channels

defaultChannels :: [String]

Channels are what amixer calls "simple controls". The most common ones are "Master", "Wave", and "PCM", so these are included in defaultChannels. It is guaranteed to be safe to pass channel names that don't exist on the default sound device to the *Channels family of functions.

toggleMuteChannels :: MonadIO m => [String] -> m Bool

raiseVolumeChannels :: MonadIO m => [String] -> Double -> m Double

lowerVolumeChannels :: MonadIO m => [String] -> Double -> m Double

getVolumeChannels :: MonadIO m => [String] -> m Double

getMuteChannels :: MonadIO m => [String] -> m Bool

getVolumeMuteChannels :: MonadIO m => [String] -> m (Double, Bool)

setVolumeChannels :: MonadIO m => [String] -> Double -> m ()

setMuteChannels :: MonadIO m => [String] -> Bool -> m ()

setVolumeMuteChannels :: MonadIO m => [String] -> Double -> Bool -> m ()

modifyVolumeChannels :: MonadIO m => [String] -> (Double -> Double) -> m Double

modifyMuteChannels :: MonadIO m => [String] -> (Bool -> Bool) -> m Bool

modifyVolumeMuteChannels :: MonadIO m => [String] -> (Double -> Bool -> (Double, Bool)) -> m (Double, Bool)

defaultOSDOpts :: Bool -> String

Default options for displaying the volume.

osdCat :: MonadIO m => Double -> (Bool -> String) -> m ()

Helper function to output current volume via osd_cat. (Needs the osd_cat executable). The second parameter is passed True when the speakers are muted and should return the options to pass to osd_cat.