Line | |
---|
1 | .TH "roar_vs_sync" "3" "May 2011" "RoarAudio" "RoarAudio Programmer's Manual" |
---|
2 | |
---|
3 | .SH NAME |
---|
4 | roar_vs_sync \- Sync VS object with server |
---|
5 | |
---|
6 | .SH SYNOPSIS |
---|
7 | |
---|
8 | #include <roaraudio.h> |
---|
9 | |
---|
10 | int roar_vs_sync (roar_vs_t * vss, int wait, int * error); |
---|
11 | |
---|
12 | .SH "DESCRIPTION" |
---|
13 | This function syncs the local data buffers with the server by flushing them. |
---|
14 | The parameter \fBwait\fR is used to tell the function if it should also wait for the flushed |
---|
15 | data to be played (sometimes called drain by other sound systems). This mode is not recommended |
---|
16 | expect at end of stream as it will result in buffer underruns. |
---|
17 | |
---|
18 | This function does only flush IO buffers not the ring buffers in buffered mode. |
---|
19 | Use \fBroar_vs_iterate\fR(3) or \fBroar_vs_run\fR(3) to do this. |
---|
20 | |
---|
21 | .SH "PARAMETERS" |
---|
22 | .TP |
---|
23 | \fBvss\fR |
---|
24 | The VS object to be synced. |
---|
25 | |
---|
26 | .TP |
---|
27 | \fBwait\fR |
---|
28 | Specifies if the calls should block untill all data has been played. Must be ROAR_VS_WAIT or ROAR_VS_NOWAIT. |
---|
29 | |
---|
30 | .TP |
---|
31 | \fBerror\fR |
---|
32 | This is a pointer to a integer used to store the error value in case of error. |
---|
33 | This can be NULL if not used but it is very recommended to use this error value to report |
---|
34 | good error messages to the user. |
---|
35 | |
---|
36 | .SH "RETURN VALUE" |
---|
37 | On success these calls return 0. On error, \-1 is returned. |
---|
38 | |
---|
39 | .SH "NOTES" |
---|
40 | This function uses the WAIT protocol command if \fBwait\fR is set to ROAR_VS_WAIT. |
---|
41 | This is not supported by all servers. |
---|
42 | |
---|
43 | .SH "EXAMPLES" |
---|
44 | FIXME |
---|
45 | |
---|
46 | .SH "SEE ALSO" |
---|
47 | \fBroarvs\fR(7), |
---|
48 | \fBlibroar\fR(7), |
---|
49 | \fBRoarAudio\fR(7). |
---|
50 | |
---|
51 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.