.TH "roar_vs_position" "3" "June 2011" "RoarAudio" "RoarAudio Programmer's Manual" .SH NAME roar_vs_position, roar_vs_latency \- Get stream position information .SH SYNOPSIS #include ssize_t roar_vs_position(roar_vs_t * vss, int backend, int * error); roar_mus_t roar_vs_latency(roar_vs_t * vss, int backend, int * error); .SH "DESCRIPTION" \fBroar_vs_position()\fR returns the current server site position of the stream plus the current offset for the selected backend. \fBroar_vs_latency()\fR returns the latency between the client site stream position and the server site position plus the latency by the backend. Use of roar_vs_latency() is not recommended as it requires the codec to use a true constant bit rate. Calling these functions too often will result in bad performance and incorrect data (pool interval smaller than server response time). Polling up to 20 times per second shoudn't be a problem. .SH "PARAMETERS" .TP \fBvss\fR The VS object to be used. .TP \fBbackend\fR The backend used for correction. This can be a stream ID of the stream to use as backend or one of the special values defined by the constants ROAR_VS_BACKEND_*. ROAR_VS_BACKEND_NONE is used to ask for no correction. ROAR_VS_BACKEND_DEFAULT is used to ask for the default correction. This should be used in all common cases. ROAR_VS_BACKEND_FIRST is used to ask for correction based on the first primary stream on the same mixer. .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" roar_vs_position() returns the stream position on success and \-1 on error. Stream position is the current position of the stream in units of samples (not frames!). roar_vs_latency() returns the stream latency on success and zero on error. However zero is a valid value. In case of error \fBerror\fR is set to the error. In case of no error but zero latency \fBerror\fR is cleared (set to ROAR_ERROR_NONE). Latency is retruned in mu-seconds (1/10^-6s). .SH "EXAMPLES" FIXME .SH "SEE ALSO" \fBroarvs\fR(7), \fBlibroar\fR(7), \fBRoarAudio\fR(7). .\" ll