Changeset 5082:ce8656ac6c64 in roaraudio


Ignore:
Timestamp:
06/20/11 17:34:04 (10 years ago)
Author:
phi
Branch:
default
Phase:
public
Message:

update manpage

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/man3/roar_vs_position.3

    r5058 r5082  
    22 
    33.SH NAME 
    4 roar_vs_position, roar_vs_latency \- Get stream position information 
     4roar_vs_position, roar_vs_latency, roar_vs_latency2 \- Get stream position information 
    55 
    66.SH SYNOPSIS 
     
    1212roar_mus_t roar_vs_latency(roar_vs_t * vss, int backend, int * error); 
    1313 
     14roar_mus_t roar_vs_latency2(roar_vs_t * vss, int backend, int wait, int * error); 
     15 
    1416.SH "DESCRIPTION" 
    1517\fBroar_vs_position()\fR returns the current server site position of the stream plus 
     
    2022 
    2123Use of roar_vs_latency() is not recommended as it requires the codec to use a true constant bit rate. 
     24 
     25\fBroar_vs_latency2()\fR is perfectly equivalent to roar_vs_latency() expect that it takes the additional 
     26parameter wait. The wait parameter may have the values ROAR_VS_WAIT, ROAR_VS_NOWAIT and ROAR_VS_ASYNC. 
     27If it is ROAR_VS_WAIT the function does the same as roar_vs_latency(). 
     28If the parameter is ROAR_VS_NOWAIT roar_vs_latency2() will return interpolated data based on old data collected 
     29by calls to roar_vs_latency(), roar_vs_latency2() or roar_vs_position(). 
     30ROAR_VS_ASYNC is used to trigger asyncron updates to this internal state. Asyncron operations need to be enabled 
     31before they can be used. See \fBroar_vs_ctl\fR(3). 
    2232 
    2333Calling these functions too often will result in bad performance and incorrect data 
     
    3646ROAR_VS_BACKEND_DEFAULT is used to ask for the default correction. This should be used in all common cases. 
    3747ROAR_VS_BACKEND_FIRST is used to ask for correction based on the first primary stream on the same mixer. 
     48 
     49.TP 
     50\fBwait\fR 
     51Tells the API if the call should wait or not. Must be ROAR_VS_WAIT, ROAR_VS_NOWAIT or ROAR_VS_ASYNC. 
    3852 
    3953.TP 
Note: See TracChangeset for help on using the changeset viewer.