The stumpwm-sndioctl Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The stumpwm-sndioctl Reference Manual

This is the stumpwm-sndioctl Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 12:39:07 2021 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

stumpwm-sndioctl

stumpwm-sndioctl adds some features to StumpWM so you can control the volume using OpenBSD's sndioctl, and have it show you pretty messages as you make changes.

Add something like this to your StumpWM config:

(ql:quickload :stumpwm-sndioctl)
(define-key *top-map* (kbd "XF86AudioMute") "toggle-mute")
(define-key *top-map* (kbd "XF86AudioLowerVolume") "volume-down")
(define-key *top-map* (kbd "XF86AudioRaiseVolume") "volume-up")

The code is documented in Lisp style (i.e. self documenting), see stumpwm-sndioctl.lisp for all the knobs you can turn.

License

Copyright 2021, Dr Ashton Fagg ashton@fagg.id.au

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 stumpwm-sndioctl

Author

Dr Ashton Fagg <ashton@fagg.id.au>

License

ISC

Description

Interface to OpenBSD’s sndioctl for StumpWM.

Version

0.0.1

Dependency

stumpwm

Source

stumpwm-sndioctl.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 stumpwm-sndioctl.asd

Location

stumpwm-sndioctl.asd

Systems

stumpwm-sndioctl (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 stumpwm-sndioctl/package.lisp

Parent

stumpwm-sndioctl (system)

Location

package.lisp

Packages

stumpwm-sndioctl


Previous: , Up: Lisp files   [Contents][Index]

3.1.3 stumpwm-sndioctl/stumpwm-sndioctl.lisp

Dependency

package.lisp (file)

Parent

stumpwm-sndioctl (system)

Location

stumpwm-sndioctl.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 stumpwm-sndioctl

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *step*

The amount by which the volume will be changed on up/down command.

Package

stumpwm-sndioctl

Source

stumpwm-sndioctl.lisp (file)

Special Variable: *terse*

If t, this will supress messages that get shown on changes to volume.

Package

stumpwm-sndioctl

Source

stumpwm-sndioctl.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: set-mute ()

Force sets mute to ON

Package

stumpwm-sndioctl

Source

stumpwm-sndioctl.lisp (file)

Function: toggle-mute ()

Toggles mute

Package

stumpwm-sndioctl

Source

stumpwm-sndioctl.lisp (file)

Function: unset-mute ()

Force sets mute to OFF

Package

stumpwm-sndioctl

Source

stumpwm-sndioctl.lisp (file)

Function: volume-down ()

Volume goes down

Package

stumpwm-sndioctl

Source

stumpwm-sndioctl.lisp (file)

Function: volume-up ()

Volume goes up

Package

stumpwm-sndioctl

Source

stumpwm-sndioctl.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Functions

Function: call-sndioctl ARGS CAPTIVE

Calls sndioctl with the required arguments.

Package

stumpwm-sndioctl

Source

stumpwm-sndioctl.lisp (file)

Function: get-mute-state-string ()

Returns a nicely formatted string containing the current mute state.

Package

stumpwm-sndioctl

Source

stumpwm-sndioctl.lisp (file)

Function: get-volume-level-string ()

Returns a nicely formatted string containing the current volume level.

Package

stumpwm-sndioctl

Source

stumpwm-sndioctl.lisp (file)

Function: make-step-cmd DIRECTION

Helpful wrapper for generating command strings for incrementing/decrementing volume.

Package

stumpwm-sndioctl

Source

stumpwm-sndioctl.lisp (file)

Function: sndioctl-status-message ()

Returns a string indicating currrent sndioctl state.

Package

stumpwm-sndioctl

Source

stumpwm-sndioctl.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   S  
Index Entry  Section

F
File, Lisp, stumpwm-sndioctl.asd: The stumpwm-sndioctl․asd file
File, Lisp, stumpwm-sndioctl/package.lisp: The stumpwm-sndioctl/package․lisp file
File, Lisp, stumpwm-sndioctl/stumpwm-sndioctl.lisp: The stumpwm-sndioctl/stumpwm-sndioctl․lisp file

L
Lisp File, stumpwm-sndioctl.asd: The stumpwm-sndioctl․asd file
Lisp File, stumpwm-sndioctl/package.lisp: The stumpwm-sndioctl/package․lisp file
Lisp File, stumpwm-sndioctl/stumpwm-sndioctl.lisp: The stumpwm-sndioctl/stumpwm-sndioctl․lisp file

S
stumpwm-sndioctl.asd: The stumpwm-sndioctl․asd file
stumpwm-sndioctl/package.lisp: The stumpwm-sndioctl/package․lisp file
stumpwm-sndioctl/stumpwm-sndioctl.lisp: The stumpwm-sndioctl/stumpwm-sndioctl․lisp file

Jump to:   F   L   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   C   F   G   M   S   T   U   V  
Index Entry  Section

C
call-sndioctl: Internal functions

F
Function, call-sndioctl: Internal functions
Function, get-mute-state-string: Internal functions
Function, get-volume-level-string: Internal functions
Function, make-step-cmd: Internal functions
Function, set-mute: Exported functions
Function, sndioctl-status-message: Internal functions
Function, toggle-mute: Exported functions
Function, unset-mute: Exported functions
Function, volume-down: Exported functions
Function, volume-up: Exported functions

G
get-mute-state-string: Internal functions
get-volume-level-string: Internal functions

M
make-step-cmd: Internal functions

S
set-mute: Exported functions
sndioctl-status-message: Internal functions

T
toggle-mute: Exported functions

U
unset-mute: Exported functions

V
volume-down: Exported functions
volume-up: Exported functions

Jump to:   C   F   G   M   S   T   U   V  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*step*: Exported special variables
*terse*: Exported special variables

S
Special Variable, *step*: Exported special variables
Special Variable, *terse*: Exported special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, stumpwm-sndioctl: The stumpwm-sndioctl package

S
stumpwm-sndioctl: The stumpwm-sndioctl system
stumpwm-sndioctl: The stumpwm-sndioctl package
System, stumpwm-sndioctl: The stumpwm-sndioctl system

Jump to:   P   S