The stumpwm-sndioctl Reference Manual

This is the stumpwm-sndioctl Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:59:10 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 stumpwm-sndioctl

Interface to OpenBSD’s sndioctl for StumpWM.

Author

Dr Ashton Fagg <>

License

ISC

Version

0.0.1

Dependency

stumpwm (system).

Source

stumpwm-sndioctl.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 stumpwm-sndioctl/stumpwm-sndioctl.asd

Source

stumpwm-sndioctl.asd.

Parent Component

stumpwm-sndioctl (system).

ASDF Systems

stumpwm-sndioctl.


3.1.2 stumpwm-sndioctl/package.lisp

Source

stumpwm-sndioctl.asd.

Parent Component

stumpwm-sndioctl (system).

Packages

stumpwm-sndioctl.


3.1.3 stumpwm-sndioctl/stumpwm-sndioctl.lisp

Dependency

package.lisp (file).

Source

stumpwm-sndioctl.asd.

Parent Component

stumpwm-sndioctl (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 stumpwm-sndioctl

Source

package.lisp.

Use List
  • common-lisp.
  • stumpwm.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


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.

Special Variable: *terse*

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

Package

stumpwm-sndioctl.

Source

stumpwm-sndioctl.lisp.


5.1.2 Ordinary functions

Function: set-mute ()

Force sets mute to ON

Package

stumpwm-sndioctl.

Source

stumpwm-sndioctl.lisp.

Function: toggle-mute ()

Toggles mute

Package

stumpwm-sndioctl.

Source

stumpwm-sndioctl.lisp.

Function: unset-mute ()

Force sets mute to OFF

Package

stumpwm-sndioctl.

Source

stumpwm-sndioctl.lisp.

Function: volume-down ()

Volume goes down

Package

stumpwm-sndioctl.

Source

stumpwm-sndioctl.lisp.

Function: volume-up ()

Volume goes up

Package

stumpwm-sndioctl.

Source

stumpwm-sndioctl.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: call-sndioctl (args captive)

Calls sndioctl with the required arguments.

Package

stumpwm-sndioctl.

Source

stumpwm-sndioctl.lisp.

Function: get-mute-state-string ()

Returns a nicely formatted string containing the current mute state.

Package

stumpwm-sndioctl.

Source

stumpwm-sndioctl.lisp.

Function: get-volume-level-string ()

Returns a nicely formatted string containing the current volume level.

Package

stumpwm-sndioctl.

Source

stumpwm-sndioctl.lisp.

Function: make-step-cmd (direction)

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

Package

stumpwm-sndioctl.

Source

stumpwm-sndioctl.lisp.

Function: sndioctl-status-message ()

Returns a string indicating currrent sndioctl state.

Package

stumpwm-sndioctl.

Source

stumpwm-sndioctl.lisp.


Appendix A Indexes


A.1 Concepts