[1318] | 1 | .\" RoarAudio |
---|
| 2 | .TH "roarvio" "7" "March 2009" "RoarAudio" "System Manager's Manual: RoarAuido" |
---|
| 3 | |
---|
| 4 | .SH NAME |
---|
| 5 | libroar \- RoarAudio sound library |
---|
| 6 | |
---|
| 7 | roarvio \- RoarAudio virtual IO layer |
---|
| 8 | |
---|
| 9 | .SH SYNOPSIS |
---|
| 10 | |
---|
| 11 | #include <roaraudio.h> |
---|
| 12 | |
---|
| 13 | struct roar_vio_calls; |
---|
| 14 | |
---|
| 15 | .SH "DESCRIPTION" |
---|
| 16 | The RoarAudio VIO interface is RoarAudio's IO abstraction layer. It provides basic |
---|
| 17 | IO functions such as read and write independing on the underlaying IO. For Example |
---|
| 18 | can you open a plain or a gziped file via the VIO layer. After a successful open |
---|
| 19 | both objects behave the same, libroar takes care about the compression in the gzip |
---|
| 20 | case. |
---|
| 21 | |
---|
| 22 | .\".SH "EXAMPLES" |
---|
| 23 | |
---|
| 24 | .SH "TUTORIALS" |
---|
| 25 | Tutorials can be found in \fBroartutvio\fR(7). |
---|
| 26 | |
---|
| 27 | .SH "IMPORTANT FUNCTIONS" |
---|
| 28 | There are several important functions. This is a small list of the most important ones. |
---|
| 29 | |
---|
| 30 | .TP |
---|
| 31 | \fBOpening\fR |
---|
[3108] | 32 | \fBroar_vio_open_file\fR(3), \fBroar_vio_open_fh\fR(3), \fBroar_vio_open_stdio\fR(3), |
---|
| 33 | \fBroar_vio_open_dstr\fR(3), \fBroar_vio_open_proto\fR(3). |
---|
| 34 | |
---|
[4608] | 35 | While there are a lot functions important for opening files the most important |
---|
| 36 | one is \fBroar_vio_open_dstr\fR(3). It opens a stream based on URLs that can point |
---|
[3108] | 37 | to local files or files on remotge machines. It also can handle compression and encryption. |
---|
[1318] | 38 | |
---|
| 39 | .TP |
---|
| 40 | \fBClosing\fR |
---|
[4608] | 41 | \fBroar_vio_close\fR(3), \fBroar_vio_shutdown\fR(3) |
---|
[1318] | 42 | |
---|
| 43 | .TP |
---|
| 44 | \fBReading and writing\fR |
---|
| 45 | \fBroar_vio_read\fR(3), \fBroar_vio_write\fR(3) |
---|
| 46 | |
---|
| 47 | .TP |
---|
| 48 | \fBSeeking and positioning\fR |
---|
| 49 | \fBroar_vio_lseek\fR(3) |
---|
| 50 | |
---|
| 51 | .TP |
---|
| 52 | \fBNon-Blocking and Asyncron IO\fR |
---|
[4608] | 53 | \fBroar_vio_nonblock\fR(3), \fBroar_vio_sync\fR(3), |
---|
| 54 | \fBroar_vio_select\fR(3) |
---|
| 55 | |
---|
| 56 | .TP |
---|
| 57 | \fBNetworking and Sockets\fR |
---|
| 58 | \fBroar_vio_accept\fR(3) |
---|
| 59 | |
---|
| 60 | .TP |
---|
| 61 | \fBString handling\fR |
---|
| 62 | \fBroar_vio_printf\fR(3) |
---|
[1318] | 63 | |
---|
| 64 | .SH "BUGS" |
---|
| 65 | A lot... |
---|
| 66 | |
---|
| 67 | .SH "SEE ALSO" |
---|
| 68 | \fBroar-config\fR(1), |
---|
| 69 | \fBroartypes\fR(1), |
---|
| 70 | \fBroartutvio\fR(7), |
---|
| 71 | \fBRoarAudio\fR(7). |
---|
| 72 | |
---|
| 73 | .\"ll |
---|