aboutsummaryrefslogtreecommitdiff
path: root/utils/tinyplay.1
blob: 56bac12efd660aee5eb4d6b8c005aaf08dc7e62e (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
93
94
.TH TINYPLAY 1 "October 2, 2016" "tinyplay" "TinyALSA"

.SH NAME
tinyplay \- sends audio to an audio device

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

.SH Description

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

.SH OPTIONS

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

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

.TP
\fB\-c, --channels\fR \fIchannels\fR
Number of channels the PCM will have.
This option is only valid for raw file types.
The default is 2 for raw file types.

.TP
\fB\-r, --rate\fR \fIrate\fR
Number of frames per second of the PCM.
This option is only valid for raw file types.
The default is 48000 for raw file types.

.TP
\fB\-i, --file-type\fR \fIfile-type\fR
The file type used for playback.
Available types are \fIraw\fR and \fIwav\fR.
Specifying \fIraw\fR means that \fIchannels\fR, \fIrate\fR and \fIbits\fR may have to be specified as well.
By default, the file type is determined by the file name.
Specifying the file type with this option will take precedent over the one determined by the file name.

.TP
\fB\-b, --bits\fR \fIbits\fR
Number of bits per sample the PCM will have.
This option is only valid for raw file types.
The default is 16 for raw file types.

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

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

.SH SIGNALS

When playing audio, SIGINT will stop the playback and close the file.

.SH EXAMPLES

.TP
\fBtinyplay output.wav\fR
Plays a file called output.wav.

.TP
\fBtinyplay output.wav -D 1
Plays a file called output.wav on card 1.

.TP
\fBtinyplay output.raw -i raw --channels 2 --rate 44100 --bits 32
Plays a raw audio file called output.raw; using 2 channels, 44100 frames per second and 32 bits per sample.

.SH BUGS

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

.SH SEE ALSO

.BR tinycap(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.