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 .\"
15 .TH AUDIOCTL 1 "Mar 18, 2011"
16 .SH NAME
17 audioctl - audio device control command line interface
18 .SH SYNOPSIS
19 .LP
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\fB] [\fIcontrol\fR ...]
32 .fi
33
34 .LP
35 .nf
36 \fBaudioctl\fR \fBset-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fB] \fIcontrol\fR \fIvalue\fR
37 .fi
38
39 .LP
40 .nf
41 \fBaudioctl\fR \fBsave-controls\fR [\fB-d\fR \fIdevice\fB] [\fB-f\fR] \fIfile\fR
42 .fi
43
44 .LP
45 .nf
46 \fBaudioctl\fR \fBload-controls\fR [\fB-d\fR \fIdevice\fB] \fIfile\fR
47 .fi
48
49 .SH DESCRIPTION
50 The \fBaudioctl\fP command is used to control various settings and features
51 of audio devices, including mixer settings such as playback volume and
52 record gain.
53 .LP
54
55 .SH SUBCOMMANDS
56 The \fBaudioctl\fR command supports the following subcommands.
57 .sp
58 .ne 2
59 .na
60 \fBlist-devices\fR
61 .ad
62 .sp .6
63 .RS 4n
64 List all the audio devices on the system.
65 .RE
66
67 .sp
68 .ne 2
69 .na
70 \fBshow-device\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] [\fBcontrol\fR ... ]
71 .ad
72 .sp .6
73 .RS 4n
74 Display an informational overview of \fIdevice\fR (or the default device if
121 .sp .6
122 .RS 4n
123 Load previously saved control settings from a \fIfile\fR
124 into a \fIdevice\fR (or all audio devices if not
125 specified).
126 .RE
127
128 .SH ENVIRONMENT VARIABLES
129 .ne 2
130 .na
131 \fB\fBAUDIODEV\fR\fR
132 .ad
133 .RS 12n
134 The full path name of the default audio device to use if one
135 is not specified on the command line. If this variable is not set,
136 \fB/dev/audio\fR is used.
137 .RE
138
139
140 .SH ATTRIBUTES
141 .LP
142 See \fBattributes\fR(5) for descriptions of the following attributes:
143 .sp
144
145 .sp
146 .TS
147 box;
148 c | c
149 l | l .
150 ATTRIBUTE TYPE ATTRIBUTE VALUE
151 _
152 Interface Stability See below.
153 .TE
154 .LP
155 The \fBaudioctl\fR command and its subcommands are Committed. The
156 names of controls, their values, and device names are Uncommitted.
157 The display output is intended for human consumption, and is Not An
158 Interface. The format of the state files used by the
159 \fBsave-controls\fR and \fBload-controls\fR subcommands is Committed
160 Private.
161 .LP
162
163 .SH SEE ALSO
164 \fBaudioplay\fR(1), \fBaudiorecord\fR(1), \fBdsp\fR(7I),
165 \fBmixer\fR(7I), \fBattributes\fR(5)
|
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 .\"
15 .TH AUDIOCTL 1 "Mar 18, 2011"
16 .SH NAME
17 audioctl - audio device control command line interface
18 .SH SYNOPSIS
19 .nf
20 \fBaudioctl\fR \fBlist-devices\fR
21 .fi
22
23 .LP
24 .nf
25 \fBaudioctl\fR \fBshow-device\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR]
26 .fi
27
28 .LP
29 .nf
30 \fBaudioctl\fR \fBshow-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fB] [\fIcontrol\fR ...]
31 .fi
32
33 .LP
34 .nf
35 \fBaudioctl\fR \fBset-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fB] \fIcontrol\fR \fIvalue\fR
36 .fi
37
38 .LP
39 .nf
40 \fBaudioctl\fR \fBsave-controls\fR [\fB-d\fR \fIdevice\fB] [\fB-f\fR] \fIfile\fR
41 .fi
42
43 .LP
44 .nf
45 \fBaudioctl\fR \fBload-controls\fR [\fB-d\fR \fIdevice\fB] \fIfile\fR
46 .fi
47
48 .SH DESCRIPTION
49 The \fBaudioctl\fP command is used to control various settings and features
50 of audio devices, including mixer settings such as playback volume and
51 record gain.
52 .SH SUBCOMMANDS
53 The \fBaudioctl\fR command supports the following subcommands.
54 .sp
55 .ne 2
56 .na
57 \fBlist-devices\fR
58 .ad
59 .sp .6
60 .RS 4n
61 List all the audio devices on the system.
62 .RE
63
64 .sp
65 .ne 2
66 .na
67 \fBshow-device\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] [\fBcontrol\fR ... ]
68 .ad
69 .sp .6
70 .RS 4n
71 Display an informational overview of \fIdevice\fR (or the default device if
118 .sp .6
119 .RS 4n
120 Load previously saved control settings from a \fIfile\fR
121 into a \fIdevice\fR (or all audio devices if not
122 specified).
123 .RE
124
125 .SH ENVIRONMENT VARIABLES
126 .ne 2
127 .na
128 \fB\fBAUDIODEV\fR\fR
129 .ad
130 .RS 12n
131 The full path name of the default audio device to use if one
132 is not specified on the command line. If this variable is not set,
133 \fB/dev/audio\fR is used.
134 .RE
135
136
137 .SH ATTRIBUTES
138 See \fBattributes\fR(5) for descriptions of the following attributes:
139 .sp
140
141 .sp
142 .TS
143 box;
144 c | c
145 l | l .
146 ATTRIBUTE TYPE ATTRIBUTE VALUE
147 _
148 Interface Stability See below.
149 .TE
150 .LP
151 The \fBaudioctl\fR command and its subcommands are Committed. The
152 names of controls, their values, and device names are Uncommitted.
153 The display output is intended for human consumption, and is Not An
154 Interface. The format of the state files used by the
155 \fBsave-controls\fR and \fBload-controls\fR subcommands is Committed
156 Private.
157 .SH SEE ALSO
158 \fBaudioplay\fR(1), \fBaudiorecord\fR(1), \fBdsp\fR(7I),
159 \fBmixer\fR(7I), \fBattributes\fR(5)
|