Line | |
---|
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 |
---|
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 | |
---|
35 | However there is a lot function that are important for opening files the most important |
---|
36 | function is \fBroar_vio_open_dstr\fR(3). It opens a stream based on URLs that can point |
---|
37 | to local files or files on remotge machines. It also can handle compression and encryption. |
---|
38 | |
---|
39 | .TP |
---|
40 | \fBClosing\fR |
---|
41 | \fBroar_vio_close\fR(3) |
---|
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 |
---|
53 | \fBroar_vio_nonblock\fR(3), \fBroar_vio_sync\fR(3) |
---|
54 | |
---|
55 | .SH "BUGS" |
---|
56 | A lot... |
---|
57 | |
---|
58 | .SH "SEE ALSO" |
---|
59 | \fBroar-config\fR(1), |
---|
60 | \fBroartypes\fR(1), |
---|
61 | \fBroartutvio\fR(7), |
---|
62 | \fBRoarAudio\fR(7). |
---|
63 | |
---|
64 | .\"ll |
---|
Note: See
TracBrowser
for help on using the repository browser.