1 '\" t
   2 .\"
   3 .\" This file and its contents are supplied under the terms of the
   4 .\" Common Development and Distribution License ("CDDL"), version 1.0.
   5 .\" You may only use this file in accordance with the terms of version
   6 .\" 1.0 of the CDDL.
   7 .\"
   8 .\" A full copy of the text of the CDDL should have accompanied this
   9 .\" source.  A copy of the CDDL is also available via the Internet at
  10 .\" http://www.illumos.org/license/CDDL.
  11 .\"
  12 .\"
  13 .\" Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
  14 .\" Copyright 2020 Peter Tribble.
  15 .\"
  16 .TH AUDIOCTL 1 "Feb 8, 2020"
  17 .SH NAME
  18 audioctl - audio device control command line interface
  19 .SH SYNOPSIS
  20 .nf
  21 \fBaudioctl\fR \fBlist-devices\fR
  22 .fi
  23 
  24 .LP
  25 .nf
  26 \fBaudioctl\fR \fBshow-device\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR]
  27 .fi
  28 
  29 .LP
  30 .nf
  31 \fBaudioctl\fR \fBshow-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] [\fIcontrol\fR ...]
  32 .fi
  33 
  34 .LP
  35 .nf
  36 \fBaudioctl\fR \fBset-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] \fIcontrol\fR \fIvalue\fR
  37 .fi
  38 
  39 .LP
  40 .nf
  41 \fBaudioctl\fR \fBsave-controls\fR [\fB-d\fR \fIdevice\fR] [\fB-f\fR] \fIfile\fR
  42 .fi
  43 
  44 .LP
  45 .nf
  46 \fBaudioctl\fR \fBload-controls\fR [\fB-d\fR \fIdevice\fR] \fIfile\fR
  47 .fi
  48 
  49 .LP
  50 .nf
  51 \fBaudioctl\fR \fBhelp\fR
  52 .fi
  53 
  54 .SH DESCRIPTION
  55 The \fBaudioctl\fP command is used to control various settings and features
  56 of audio devices, including mixer settings such as playback volume and
  57 record gain.
  58 .SH SUBCOMMANDS
  59 The \fBaudioctl\fR command supports the following subcommands.
  60 .sp
  61 .ne 2
  62 .na
  63 \fBlist-devices\fR
  64 .ad
  65 .sp .6
  66 .RS 4n
  67 List all the audio devices on the system.
  68 .RE
  69 
  70 .sp
  71 .ne 2
  72 .na
  73 \fBshow-device\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR]
  74 .ad
  75 .sp .6
  76 .RS 4n
  77 Display an informational overview of \fIdevice\fR (or the default device if
  78 not specified).  If the \fB-v\fR option is specified, then more detail
  79 will be displayed.
  80 .RE
  81 
  82 .sp
  83 .ne 2
  84 .na
  85 \fBshow-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] [\fBcontrol\fR ... ]
  86 .ad
  87 .sp .6
  88 .RS 4n
  89 Display the control settings for one or more \fIcontrols\fR of a
  90 \fIdevice\fR (or the default device if not specified).  If no \fIcontrol\fR is
  91 specified, then the settings for all controls will be displayed. If
  92 the \fB-v\fR option is specified, then more detail will be displayed.
  93 .RE
  94 
  95 .sp
  96 .ne 2
  97 .na
  98 \fBset-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] \fIcontrol\fR \fIvalue\fR
  99 .ad
 100 .sp .6
 101 .RS 4n
 102 Set the control settings for a \fIcontrol\fR of a \fIdevice\fR (or the
 103 default device if not specified) to \fIvalue\fR.  If the \fB-v\fR
 104 option is specified, then more verbose output be displayed.
 105 .RE
 106 
 107 .sp
 108 .ne 2
 109 .na
 110 \fBsave-controls\fR [\fB-f\fR] [\fB-d\fR \fIdevice\fR] \fIfile\fR
 111 .ad
 112 .sp .6
 113 .RS 4n
 114 Save all control settings of the \fIdevice\fR (or the default device if not
 115 specified) to the named \fIfile\fR.  This subcommand will not replace
 116 or modify an existing file unless \fB-f\fR (force) is specified.
 117 .RE
 118 
 119 .sp
 120 .ne 2
 121 .na
 122 \fBload-controls\fR [\fB-d\fR \fIdevice\fR] \fIfile\fR
 123 .ad
 124 .sp .6
 125 .RS 4n
 126 Load previously saved control settings from a \fIfile\fR
 127 into a \fIdevice\fR (or all audio devices if not
 128 specified).
 129 .RE
 130 
 131 .sp
 132 .ne 2
 133 .na
 134 \fBhelp\fR
 135 .ad
 136 .sp .6
 137 .RS 4n
 138 Display the usage message.
 139 .RE
 140 
 141 .SH ENVIRONMENT VARIABLES
 142 .ne 2
 143 .na
 144 \fB\fBAUDIODEV\fR\fR
 145 .ad
 146 .RS 12n
 147 The full path name of the default audio device to use if one
 148 is not specified on the command line.  If this variable is not set,
 149 \fB/dev/audio\fR is used.
 150 .RE
 151 
 152 .SH ATTRIBUTES
 153 The \fBaudioctl\fR command and its subcommands are Committed.  The
 154 names of controls, their values, and device names are Uncommitted.
 155 The display output is intended for human consumption, and is Not An
 156 Interface.  The format of the state files used by the
 157 \fBsave-controls\fR and \fBload-controls\fR subcommands is Committed
 158 Private.
 159 .SH SEE ALSO
 160 \fBaudioplay\fR(1), \fBaudiorecord\fR(1), \fBdsp\fR(7I),
 161 \fBmixer\fR(7I)