[5058] | 1 | .\" RoarAudio |
---|
| 2 | .TH "roarvs" "7" "June 2011" "RoarAudio" "System Manager's Manual: RoarAuido" |
---|
| 3 | |
---|
| 4 | .SH NAME |
---|
| 5 | libroar \- RoarAudio sound library |
---|
| 6 | |
---|
| 7 | roarvs \- RoarAudio very simple API |
---|
| 8 | |
---|
| 9 | .SH SYNOPSIS |
---|
| 10 | |
---|
| 11 | #include <roaraudio.h> |
---|
| 12 | |
---|
| 13 | roar_vs_t * vss; |
---|
| 14 | |
---|
| 15 | .SH "DESCRIPTION" |
---|
| 16 | The VS (for Very Simple) API is a high level abstraction layer used to allow use of RoarAudio |
---|
| 17 | from very simple programs. The API was designed to help people to easly upgrade existing artsc and pulse-simple |
---|
| 18 | code to RoarAudio. While the API is equivalently simple it is much more powerful than one one by |
---|
| 19 | aRtsc or PulseAudio. |
---|
| 20 | |
---|
| 21 | The VS API also has a mode to play back (and record) files easly. As this uses VIO/DSTR it can handle |
---|
| 22 | streams as well. |
---|
| 23 | |
---|
| 24 | .\".SH "EXAMPLES" |
---|
| 25 | |
---|
| 26 | .SH "TUTORIALS" |
---|
| 27 | Tutorials can be found in \fBroartut\fR(7). |
---|
| 28 | |
---|
| 29 | .SH "IMPORTANT FUNCTIONS" |
---|
| 30 | There are several important functions. This is a small list of the most important ones. |
---|
| 31 | |
---|
| 32 | .TP |
---|
[5106] | 33 | \fBError handling\fR |
---|
[5058] | 34 | \fBroar_vs_strerr\fR(3) |
---|
| 35 | |
---|
| 36 | .TP |
---|
| 37 | \fBOpening\fR |
---|
| 38 | \fBroar_vs_new\fR(3), \fBroar_vs_new_simple\fR(3), \fBroar_vs_new_playback\fR(3), |
---|
| 39 | \fBroar_vs_new_from_file\fR(3) |
---|
| 40 | |
---|
| 41 | .TP |
---|
| 42 | \fBClosing\fR |
---|
| 43 | \fBroar_vs_close\fR(3) |
---|
| 44 | |
---|
| 45 | .TP |
---|
| 46 | \fBReading and writing\fR |
---|
| 47 | \fBroar_vs_read\fR(3), \fBroar_vs_write\fR(3) |
---|
| 48 | |
---|
| 49 | .TP |
---|
| 50 | \fBNon-Blocking and Asyncron IO\fR |
---|
| 51 | \fBroar_vs_blocking\fR(3), |
---|
| 52 | \fBroar_vio_select\fR(3) |
---|
| 53 | |
---|
| 54 | .TP |
---|
| 55 | \fBVolume and Flags\fR |
---|
| 56 | \fBroar_vs_pause\fR(3), \fBroar_vs_mute\fR(3), |
---|
| 57 | \fBroar_vs_volume_mono\fR(3), \fBroar_vs_volume_stereo\fR(3), \fBroar_vs_volume_get\fR(3) |
---|
| 58 | |
---|
| 59 | .TP |
---|
| 60 | \fBMeta data\fR |
---|
| 61 | \fBroar_vs_meta\fR(3), \fBroar_vs_role\fR(3) |
---|
| 62 | |
---|
| 63 | .TP |
---|
| 64 | \fBFile mode\fR |
---|
| 65 | \fBroar_vs_file\fR(3), \fBroar_vs_file_simple\fR(3), |
---|
| 66 | \fBroar_vs_iterate\fR(3), \fBroar_vs_run\fR(3) |
---|
| 67 | |
---|
| 68 | .TP |
---|
| 69 | \fBBuffered mode\fR |
---|
| 70 | \fBroar_vs_buffer\fR(3), |
---|
| 71 | \fBroar_vs_iterate\fR(3), \fBroar_vs_run\fR(3) |
---|
| 72 | |
---|
| 73 | .SH "BUGS" |
---|
| 74 | A lot... |
---|
| 75 | |
---|
| 76 | .SH "SEE ALSO" |
---|
| 77 | \fBroar-config\fR(1), |
---|
| 78 | \fBroartypes\fR(1), |
---|
| 79 | \fBroartut\fR(7), |
---|
| 80 | \fBRoarAudio\fR(7). |
---|
| 81 | |
---|
| 82 | .\"ll |
---|