| Taylor Holberton | eea4389 | 2016-10-02 11:35:35 -0400 | [diff] [blame] | 1 | .TH TINYPLAY 1 "October 2, 2016" "tinyplay" "TinyALSA" |
| 2 | |
| 3 | .SH NAME |
| 4 | tinyplay \- sends audio to an audio device |
| 5 | |
| 6 | .SH SYNOPSIS |
| 7 | .B tinyplay\fR \fIfile\fR [ \fIoptions\fR ] |
| 8 | |
| 9 | .SH Description |
| 10 | |
| 11 | \fBtinyplay\fR can send audio to an audio device from a wav file or standard input (as raw samples). |
| 12 | Options can be used to specify various hardware parameters to open the PCM with. |
| 13 | |
| 14 | .SH OPTIONS |
| 15 | |
| 16 | .TP |
| Taylor Holberton | 84a74a7 | 2016-11-19 10:12:44 -0800 | [diff] [blame] | 17 | \fB\-D, --card\fR \fIcard\fR |
| Taylor Holberton | eea4389 | 2016-10-02 11:35:35 -0400 | [diff] [blame] | 18 | Card number of the PCM. |
| Taylor Holberton | 84abf1e | 2016-10-02 12:11:49 -0400 | [diff] [blame] | 19 | The default is 0. |
| Taylor Holberton | eea4389 | 2016-10-02 11:35:35 -0400 | [diff] [blame] | 20 | |
| 21 | .TP |
| Taylor Holberton | 84a74a7 | 2016-11-19 10:12:44 -0800 | [diff] [blame] | 22 | \fB\-d, --device\fR \fIdevice\fR |
| Taylor Holberton | eea4389 | 2016-10-02 11:35:35 -0400 | [diff] [blame] | 23 | Device number of the PCM. |
| Taylor Holberton | 84abf1e | 2016-10-02 12:11:49 -0400 | [diff] [blame] | 24 | The default is 0. |
| Taylor Holberton | eea4389 | 2016-10-02 11:35:35 -0400 | [diff] [blame] | 25 | |
| 26 | .TP |
| Taylor Holberton | 84a74a7 | 2016-11-19 10:12:44 -0800 | [diff] [blame] | 27 | \fB\-c, --channels\fR \fIchannels\fR |
| Taylor Holberton | eea4389 | 2016-10-02 11:35:35 -0400 | [diff] [blame] | 28 | Number of channels the PCM will have. |
| 29 | This option is only valid for raw file types. |
| 30 | The default is 2 for raw file types. |
| 31 | |
| 32 | .TP |
| Taylor Holberton | 84a74a7 | 2016-11-19 10:12:44 -0800 | [diff] [blame] | 33 | \fB\-r, --rate\fR \fIrate\fR |
| Taylor Holberton | eea4389 | 2016-10-02 11:35:35 -0400 | [diff] [blame] | 34 | Number of frames per second of the PCM. |
| 35 | This option is only valid for raw file types. |
| 36 | The default is 48000 for raw file types. |
| 37 | |
| 38 | .TP |
| Taylor Holberton | 84a74a7 | 2016-11-19 10:12:44 -0800 | [diff] [blame] | 39 | \fB\-i, --file-type\fR \fIfile-type\fR |
| Taylor Holberton | eea4389 | 2016-10-02 11:35:35 -0400 | [diff] [blame] | 40 | The file type used for playback. |
| 41 | Available types are \fIraw\fR and \fIwav\fR. |
| 42 | Specifying \fIraw\fR means that \fIchannels\fR, \fIrate\fR and \fIbits\fR may have to be specified as well. |
| Taylor Holberton | 84a74a7 | 2016-11-19 10:12:44 -0800 | [diff] [blame] | 43 | By default, the file type is determined by the file name. |
| 44 | Specifying the file type with this option will take precedent over the one determined by the file name. |
| Taylor Holberton | eea4389 | 2016-10-02 11:35:35 -0400 | [diff] [blame] | 45 | |
| 46 | .TP |
| Taylor Holberton | 84a74a7 | 2016-11-19 10:12:44 -0800 | [diff] [blame] | 47 | \fB\-b, --bits\fR \fIbits\fR |
| Taylor Holberton | eea4389 | 2016-10-02 11:35:35 -0400 | [diff] [blame] | 48 | Number of bits per sample the PCM will have. |
| 49 | This option is only valid for raw file types. |
| 50 | The default is 16 for raw file types. |
| 51 | |
| 52 | .TP |
| Taylor Holberton | 84a74a7 | 2016-11-19 10:12:44 -0800 | [diff] [blame] | 53 | \fB\-p, --period-size\fR \fIperiod_size\fR |
| Taylor Holberton | eea4389 | 2016-10-02 11:35:35 -0400 | [diff] [blame] | 54 | Number of frames in a period. |
| 55 | The default is 1024. |
| 56 | |
| 57 | .TP |
| Taylor Holberton | 84a74a7 | 2016-11-19 10:12:44 -0800 | [diff] [blame] | 58 | \fB\-n, --period-count\fR \fIperiods\fR |
| Taylor Holberton | eea4389 | 2016-10-02 11:35:35 -0400 | [diff] [blame] | 59 | Number of periods the PCM will have. |
| 60 | The default is 4. |
| 61 | |
| 62 | .SH SIGNALS |
| 63 | |
| 64 | When playing audio, SIGINT will stop the playback and close the file. |
| 65 | |
| 66 | .SH EXAMPLES |
| 67 | |
| 68 | .TP |
| 69 | \fBtinyplay output.wav\fR |
| 70 | Plays a file called output.wav. |
| 71 | |
| 72 | .TP |
| 73 | \fBtinyplay output.wav -D 1 |
| 74 | Plays a file called output.wav on card 1. |
| 75 | |
| 76 | .TP |
| 77 | \fBtinyplay output.raw -i raw --channels 2 --rate 44100 --bits 32 |
| 78 | Plays a raw audio file called output.raw; using 2 channels, 44100 frames per second and 32 bits per sample. |
| 79 | |
| 80 | .SH BUGS |
| 81 | |
| 82 | Please report bugs to https://github.com/tinyalsa/tinyalsa/issues. |
| 83 | |
| 84 | .SH SEE ALSO |
| 85 | |
| 86 | .BR tinycap(1), |
| 87 | .BR tinymix(1), |
| 88 | .BR tinypcminfo(1) |
| 89 | |
| 90 | .SH AUTHORS |
| 91 | Simon Wilson |
| 92 | .P |
| 93 | For a complete list of authors, visit the project page at https://github.com/tinyalsa/tinyalsa. |
| 94 | |