source: roaraudio/doc/man3/roar_vs_sync.3 @ 5041:236c1b3b1a30

.TH "roar_vs_sync" "3" "May 2011" "RoarAudio" "RoarAudio Programmer's Manual"

.SH NAME
roar_vs_sync \- Sync VS object with server

.SH SYNOPSIS

#include <roaraudio.h>

int     roar_vs_sync (roar_vs_t * vss, int wait, int * error);

.SH "DESCRIPTION"
This function syncs the local data buffers with the server by flushing them.
The parameter \fBwait\fR is used to tell the function if it should also wait for the flushed
data to be played (sometimes called drain by other sound systems). This mode is not recommended
expect at end of stream as it will result in buffer underruns.

This function does only flush IO buffers not the ring buffers in buffered mode.
Use \fBroar_vs_iterate\fR(3) or \fBroar_vs_run\fR(3) to do this.

.SH "PARAMETERS"
.TP
\fBvss\fR
The VS object to be synced.

.TP
\fBwait\fR
Specifies if the calls should block untill all data has been played. Must be ROAR_VS_WAIT or ROAR_VS_NOWAIT.

.TP
\fBerror\fR
This is a pointer to a integer used to store the error value in case of error.
This can be NULL if not used but it is very recommended to use this error value to report
good error messages to the user.

.SH "RETURN VALUE"
On success these calls return 0.  On error, \-1 is returned.

.SH "NOTES"
This function uses the WAIT protocol command if \fBwait\fR is set to ROAR_VS_WAIT.
This is not supported by all servers.

.SH "EXAMPLES"
FIXME

.SH "SEE ALSO"
\fBroarvs\fR(7),
\fBlibroar\fR(7),
\fBRoarAudio\fR(7).

.\" ll