aboutsummaryrefslogtreecommitdiff
path: root/utils/tinycap.1
blob: d18dd123f24a03b8ee0554595c8c8ceca3441172 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
.TH TINYCAP 1 "October 2, 2016" "tinycap" "TinyALSA"

.SH NAME
tinycap \- captures audio from an audio device

.SH SYNOPSIS
.B tinycap\fR [ \fIfile\fR ] [ \fIoptions\fR ]

.SH Description

\fBtinycap\fR can record audio from an audio device to a wav file or standard output (as raw samples).
Options can be used to specify various hardware parameters to open the PCM with.

.SH OPTIONS

.TP
\fB\-D\fR \fIcard\fR
Card number of the PCM.
The default is 0.

.TP
\fB\-d\fR \fIdevice\fR
Device number of the PCM.
The default is 0.

.TP
\fB\-M\fR
Use memory-mapped I/O method.
If this option is not specified, then read and write I/O method will be used.

.TP
\fB\-c\fR \fIchannels\fR
Number of channels the PCM will have.
The default is 2.

.TP
\fB\-r\fR \fIrate\fR
Number of frames per second of the PCM.
The default is 48000.

.TP
\fB\-b\fR \fIbits\fR
Number of bits per sample the PCM will have.
The default is 32.

.TP
\fB\-p\fR \fIperiod_size\fR
Number of frames in a period.
The default is 1024.

.TP
\fB\-n\fR \fIperiods\fR
Number of periods the PCM will have.
The default is 4.

.TP
\fB\-t\fR \fIseconds\fR
Number of seconds to record audio.

.SH SIGNALS

When capturing audio, SIGINT will stop the recording and close the file.

.SH EXAMPLES

.TP
\fBtinycap output.wav\fR
Records a file called output.wav until an interrupt signal is caught.

.TP
\fBtinycap output.wav -D 1 -t 2
Records a file called output.wav from card 1 for two seconds or until an interrupt signal is caught.

.TP
\fBtinycap -- -t 3
Records to standard output for three seconds or until an interrupt signal is caught.

.SH BUGS

Please report bugs to https://github.com/tinyalsa/tinyalsa/issues.

.SH SEE ALSO

.BR tinyplay(1),
.BR tinymix(1),
.BR tinypcminfo(1)

.SH AUTHORS
Simon Wilson
.P
For a complete list of authors, visit the project page at https://github.com/tinyalsa/tinyalsa.