Changeset 5082:ce8656ac6c64 in roaraudio

Timestamp:

06/20/11 17:34:04 (13 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

update manpage

File:

• doc/man3/roar_vs_position.3 (modified) (4 diffs)

doc/man3/roar_vs_position.3

@@ -2 +2 @@
 
 .SH NAME
-roar_vs_position, roar_vs_latency \- Get stream position information
+roar_vs_position, roar_vs_latency, roar_vs_latency2 \- Get stream position information
 
 .SH SYNOPSIS
@@ -12 +12 @@
 roar_mus_t roar_vs_latency(roar_vs_t * vss, int backend, int * error);
 
+roar_mus_t roar_vs_latency2(roar_vs_t * vss, int backend, int wait, int * error);
+
 .SH "DESCRIPTION"
 \fBroar_vs_position()\fR returns the current server site position of the stream plus
@@ -20 +22 @@
 
 Use of roar_vs_latency() is not recommended as it requires the codec to use a true constant bit rate.
+
+\fBroar_vs_latency2()\fR is perfectly equivalent to roar_vs_latency() expect that it takes the additional
+parameter wait. The wait parameter may have the values ROAR_VS_WAIT, ROAR_VS_NOWAIT and ROAR_VS_ASYNC.
+If it is ROAR_VS_WAIT the function does the same as roar_vs_latency().
+If the parameter is ROAR_VS_NOWAIT roar_vs_latency2() will return interpolated data based on old data collected
+by calls to roar_vs_latency(), roar_vs_latency2() or roar_vs_position().
+ROAR_VS_ASYNC is used to trigger asyncron updates to this internal state. Asyncron operations need to be enabled
+before they can be used. See \fBroar_vs_ctl\fR(3).
 
 Calling these functions too often will result in bad performance and incorrect data
@@ -36 +46 @@
 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
+\fBwait\fR
+Tells the API if the call should wait or not. Must be ROAR_VS_WAIT, ROAR_VS_NOWAIT or ROAR_VS_ASYNC.
 
 .TP