xref: /illumos-gate/usr/src/man/man1/audioctl.1 (revision 6a79a30125dbfeba7eb8ef0a9cd3a8206f644043)
t

This file and its contents are supplied under the terms of the
Common Development and Distribution License ("CDDL"), version 1.0.
You may only use this file in accordance with the terms of version
1.0 of the CDDL.

A full copy of the text of the CDDL should have accompanied this
source. A copy of the CDDL is also available via the Internet at
http://www.illumos.org/license/CDDL.


Copyright 2011 Nexenta Systems, Inc. All rights reserved.
Copyright 2020 Peter Tribble.

AUDIOCTL 1 "Feb 8, 2020"
NAME
audioctl - audio device control command line interface
SYNOPSIS
audioctl list-devices

audioctl show-device [-v] [-d device]

audioctl show-control [-v] [-d device] [control ...]

audioctl set-control [-v] [-d device] control value

audioctl save-controls [-d device] [-f] file

audioctl load-controls [-d device] file

audioctl help
DESCRIPTION
The audioctl command is used to control various settings and features of audio devices, including mixer settings such as playback volume and record gain.
SUBCOMMANDS
The audioctl command supports the following subcommands. list-devices

List all the audio devices on the system.

show-device [-v] [-d device]

Display an informational overview of device (or the default device if not specified). If the -v option is specified, then more detail will be displayed.

show-control [-v] [-d device] [control ... ]

Display the control settings for one or more controls of a device (or the default device if not specified). If no control is specified, then the settings for all controls will be displayed. If the -v option is specified, then more detail will be displayed.

set-control [-v] [-d device] control value

Set the control settings for a control of a device (or the default device if not specified) to value. If the -v option is specified, then more verbose output be displayed.

save-controls [-f] [-d device] file

Save all control settings of the device (or the default device if not specified) to the named file. This subcommand will not replace or modify an existing file unless -f (force) is specified.

load-controls [-d device] file

Load previously saved control settings from a file into a device (or all audio devices if not specified).

help

Display the usage message.

ENVIRONMENT VARIABLES
AUDIODEV

The full path name of the default audio device to use if one is not specified on the command line. If this variable is not set, /dev/audio is used.

ATTRIBUTES
The audioctl command and its subcommands are Committed. The names of controls, their values, and device names are Uncommitted. The display output is intended for human consumption, and is Not An Interface. The format of the state files used by the save-controls and load-controls subcommands is Committed Private.
SEE ALSO
audioplay(1), audiorecord(1), dsp(7I), mixer(7I)