1 '\" te
2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
5 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH AUDIORECORD 1 "May 13, 2017"
7 .SH NAME
8 audiorecord \- record an audio file
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBaudiorecord\fR [\fB-af\fR] [\fB-v\fR \fIvol\fR] [\fB-c\fR \fIchannels\fR] [\fI-s\fR \fIrate\fR]
13 [\fB-e\fR \fIencoding\fR] [\fB-t\fR \fItime\fR] [\fB-i\fR \fIinfo\fR] [\fB-d\fR \fIdev\fR]
14 [\fB-T\fR \fBau\fR | \fBaif\fR[\fBf\fR] | \fBwav\fR] [\fIfile\fR[.\fBau\fR|.\fBaif\fR[\fBf\fR]]|.\fBwav\fR]
15 .fi
16
17 .SH DESCRIPTION
18 .LP
19 The \fBaudiorecord\fR utility copies audio data from the audio device to a
20 named audio file, or to the standard output if no filename is present. If no
21 output file is specified and standard output is a tty, the program exits with
22 an error message.
23 .sp
24 .LP
25 By default, monaural audio data is recorded at 8 kHz and encoded in \fB-law\fR
26 format. If the audio device supports additional configurations, the \fB-c\fR,
27 \fB-s\fR, and \fB-e\fR options may be used to specify the data format. The
28 output file is prefixed by an audio file header that identifies the format of
29 the data encoded in the file.
30 .sp
31 .LP
32 Recording begins immediately and continues until a \fBSIGINT\fR signal (for
33 example, Control-c) is received. If the \fB-t\fR option is specified,
34 \fBaudiorecord\fR stops when the specified quantity of data has been recorded.
35 .sp
36 .LP
37 If the audio device is unavailable, that is, if another process currently has
38 read access, \fBaudiorecord\fR prints an error message and exits immediately.
39 .SH OPTIONS
40 .LP
41 The following options are supported:
42 .sp
43 .ne 2
44 .na
45 \fB\fB-\e?\fR\fR
46 .ad
47 .RS 24n
48 \fIHelp\fR: Prints a command line usage message.
49 .RE
50
51 .sp
52 .ne 2
53 .na
54 \fB\fB-a\fR\fR
55 .ad
56 .RS 24n
57 \fIAppend\fR: Appends the data on the end of the named audio file. The audio
58 device must support the audio data format of the existing file.
59 .RE
60
61 .sp
62 .ne 2
63 .na
64 \fB\fB-c\fR \fIchannels\fR\fR
65 .ad
148 file suffix, the type is set as specified in this option. If this option is not
149 specified, the file suffix determines the type.
150 .RE
151
152 .sp
153 .ne 2
154 .na
155 \fB\fB-v\fR \fIvol\fR\fR
156 .ad
157 .RS 24n
158 \fIVolume\fR: The recording gain is set to the specified value before recording
159 begins, and is reset to its previous level when \fBaudiorecord\fR exits. The
160 \fIvol\fR argument is an integer value between 0 and 100, inclusive. If this
161 argument is not specified, the input volume remains at the level most recently
162 set by any process.
163 .RE
164
165 .SH OPERANDS
166 .ne 2
167 .na
168 \fB\fIfile\fR[\fB\&.au\fR|\fB\&.aif\fR[\fBf\fR]]|\fB\&.wav\fR\fR
169 .ad
170 .sp .6
171 .RS 4n
172 \fIFile Specification\fR: The named audio file is rewritten, or appended. If no
173 filename is present, and standard output is not a tty, or if the special
174 filename "\fB\(mi\fR" is specified, output is directed to the standard
175 output.
176 .sp
177 If the \fB-T\fR option is not specified, the file suffix determines the type of
178 file. If the suffix is not recognized, the default is \fB\&.au\fR. If the
179 \fB-T\fR option \fBis\fR specified, that file type is used regardless of the
180 file suffix.
181 .RE
182
183 .SH USAGE
184 .LP
185 See \fBlargefile\fR(5) for the description of the behavior of \fBaudiorecord\fR
186 when encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
187 .SH ENVIRONMENT VARIABLES
188 .ne 2
189 .na
190 \fB\fBAUDIODEV\fR\fR
191 .ad
192 .RS 12n
193 The full path name of the audio device to record from, if no \fB-d\fR argument
194 is supplied. If the \fBAUDIODEV\fR variable is not set, \fB/dev/audio\fR is
195 used.
196 .RE
197
198 .SH ATTRIBUTES
199 .LP
200 See \fBattributes\fR(5) for descriptions of the following attributes:
201 .sp
202
203 .sp
204 .TS
205 box;
206 c | c
207 l | l .
208 ATTRIBUTE TYPE ATTRIBUTE VALUE
209 _
210 Architecture SPARC, x86
211 _
212 Interface Stability Committed
213 .TE
214
215 .SH SEE ALSO
216 .LP
217 \fBaudioconvert\fR(1), \fBaudioplay\fR(1),
218 \fBattributes\fR(5), \fBlargefile\fR(5), \fBaudio\fR(7I)
|
1 '\" te
2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
3 .\" Copyright 2020 Peter Tribble.
4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
5 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
6 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 .TH AUDIORECORD 1 "Feb 8, 2020"
8 .SH NAME
9 audiorecord \- record an audio file
10 .SH SYNOPSIS
11 .nf
12 \fBaudiorecord\fR [\fB-af\fR] [\fB-v\fR \fIvol\fR] [\fB-c\fR \fIchannels\fR] [\fB-s\fR \fIrate\fR]
13 [\fB-e\fR \fIencoding\fR] [\fB-t\fR \fItime\fR] [\fB-i\fR \fIinfo\fR] [\fB-d\fR \fIdev\fR]
14 [\fB-T\fR \fBau\fR|\fBaif\fR[\fBf\fR]|\fBwav\fR] [\fIfile\fR[.\fBau\fR|.\fBaif\fR[\fBf\fR]|.\fBwav\fR]]
15 .fi
16
17 .SH DESCRIPTION
18 The \fBaudiorecord\fR utility copies audio data from the audio device to a
19 named audio file, or to the standard output if no filename is present. If no
20 output file is specified and standard output is a tty, the program exits with
21 an error message.
22 .sp
23 .LP
24 By default, monaural audio data is recorded at 8 kHz and encoded in \fBu-law\fR
25 format. If the audio device supports additional configurations, the \fB-c\fR,
26 \fB-s\fR, and \fB-e\fR options may be used to specify the data format. The
27 output file is prefixed by an audio file header that identifies the format of
28 the data encoded in the file.
29 .sp
30 .LP
31 Recording begins immediately and continues until a \fBSIGINT\fR signal (for
32 example, Control-c) is received. If the \fB-t\fR option is specified,
33 \fBaudiorecord\fR stops when the specified quantity of data has been recorded.
34 .sp
35 .LP
36 If the audio device is unavailable, that is, if another process currently has
37 read access, \fBaudiorecord\fR prints an error message and exits immediately.
38 .SH OPTIONS
39 The following options are supported:
40 .sp
41 .ne 2
42 .na
43 \fB\fB-?\fR\fR
44 .ad
45 .RS 24n
46 \fIHelp\fR: Prints a command line usage message.
47 .RE
48
49 .sp
50 .ne 2
51 .na
52 \fB\fB-a\fR\fR
53 .ad
54 .RS 24n
55 \fIAppend\fR: Appends the data on the end of the named audio file. The audio
56 device must support the audio data format of the existing file.
57 .RE
58
59 .sp
60 .ne 2
61 .na
62 \fB\fB-c\fR \fIchannels\fR\fR
63 .ad
146 file suffix, the type is set as specified in this option. If this option is not
147 specified, the file suffix determines the type.
148 .RE
149
150 .sp
151 .ne 2
152 .na
153 \fB\fB-v\fR \fIvol\fR\fR
154 .ad
155 .RS 24n
156 \fIVolume\fR: The recording gain is set to the specified value before recording
157 begins, and is reset to its previous level when \fBaudiorecord\fR exits. The
158 \fIvol\fR argument is an integer value between 0 and 100, inclusive. If this
159 argument is not specified, the input volume remains at the level most recently
160 set by any process.
161 .RE
162
163 .SH OPERANDS
164 .ne 2
165 .na
166 \fIfile\fR[\fB\&.au\fR|\fB\&.aif\fR[\fBf\fR]|\fB\&.wav\fR]
167 .ad
168 .sp .6
169 .RS 4n
170 \fIFile Specification\fR: The named audio file is rewritten, or appended. If no
171 filename is present, and standard output is not a tty, or if the special
172 filename "\fB\(mi\fR" is specified, output is directed to the standard
173 output.
174 .sp
175 If the \fB-T\fR option is not specified, the file suffix determines the type of
176 file. If the suffix is not recognized, the default is \fB\&.au\fR. If the
177 \fB-T\fR option \fBis\fR specified, that file type is used regardless of the
178 file suffix.
179 .RE
180
181 .SH USAGE
182 See \fBlargefile\fR(5) for the description of the behavior of \fBaudiorecord\fR
183 when encountering files greater than or equal to 2 Gbyte (2^31 bytes).
184 .SH ENVIRONMENT VARIABLES
185 .ne 2
186 .na
187 \fB\fBAUDIODEV\fR\fR
188 .ad
189 .RS 12n
190 The full path name of the audio device to record from, if no \fB-d\fR argument
191 is supplied. If the \fBAUDIODEV\fR variable is not set, \fB/dev/audio\fR is
192 used.
193 .RE
194
195 .SH SEE ALSO
196 \fBaudioconvert\fR(1), \fBaudioplay\fR(1),
197 \fBlargefile\fR(5), \fBaudio\fR(7I)
|