Rev | Line | |
---|
[5039] | 1 | .\" roar_simple_play.3: |
---|
| 2 | |
---|
| 3 | .TH "roar_vs_read" "3" "May 2011" "RoarAudio" "RoarAudio Programmer's Manual" |
---|
| 4 | |
---|
| 5 | .SH NAME |
---|
| 6 | roar_vs_read, roar_vs_write \- Read or write data from or to sound server |
---|
| 7 | |
---|
| 8 | .SH SYNOPSIS |
---|
| 9 | |
---|
| 10 | #include <roaraudio.h> |
---|
| 11 | |
---|
| 12 | ssize_t roar_vs_read (roar_vs_t * vss, void * buf, size_t len, int * error); |
---|
| 13 | |
---|
| 14 | ssize_t roar_vs_write(roar_vs_t * vss, const void * buf, size_t len, int * error); |
---|
| 15 | |
---|
| 16 | .SH "DESCRIPTION" |
---|
| 17 | roar_vs_read() reads data from the sound server into buffer \fBbuf\fR. |
---|
| 18 | |
---|
| 19 | roar_vs_write() writes data in buffer \fBbuf\fR to the sound server. |
---|
| 20 | |
---|
| 21 | .SH "PARAMETERS" |
---|
| 22 | .TP |
---|
| 23 | \fBvss\fR |
---|
| 24 | The VS object data is read from or written to. |
---|
| 25 | |
---|
| 26 | .TP |
---|
| 27 | \fBbuf\fR |
---|
| 28 | The buffer to read to or write from. |
---|
| 29 | |
---|
| 30 | .TP |
---|
| 31 | \fBlen\fR |
---|
| 32 | The length of the data to be read or written in byte. |
---|
| 33 | |
---|
| 34 | .TP |
---|
| 35 | \fBerror\fR |
---|
| 36 | This is a pointer to a integer used to store the error value in case of error. |
---|
| 37 | This can be NULL if not used but it is very recommended to use this error value to report |
---|
| 38 | good error messages to the user. |
---|
| 39 | |
---|
| 40 | .SH "RETURN VALUE" |
---|
| 41 | On success these calls return the amount of data read or written. |
---|
| 42 | This can be smaller than the requested size. On error, \-1 is returned. |
---|
| 43 | |
---|
| 44 | .SH "EXAMPLES" |
---|
| 45 | FIXME |
---|
| 46 | |
---|
| 47 | .SH "SEE ALSO" |
---|
| 48 | \fBroarvs\fR(7), |
---|
| 49 | \fBlibroar\fR(7), |
---|
| 50 | \fBRoarAudio\fR(7). |
---|
| 51 | |
---|
| 52 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.