mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-11-03 09:01:50 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Clarify pa_stream_get_latency() return value

Browse source 
Clarifies that the latency is returned via an inout parameter and the
return value is an error code or 0 on success.
This commit is contained in:
Arun Raghavan 2011-12-30 23:49:59 +05:30
parent 07e47bc018
commit 0d41bcfcbf
1 changed files with 8 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

14
src/pulse/stream.h
View file

@ -691,16 +691,18 @@ pa_operation* pa_stream_set_name(pa_stream *s, const char *name, pa_stream_succe
* see pa_stream_get_timing_info(). */
int pa_stream_get_time(pa_stream *s, pa_usec_t *r_usec);
/** Return the total stream latency. This function is based on
/** Determine the total stream latency. This function is based on
* pa_stream_get_time().
*
* In case the stream is a monitoring stream the result can be
* negative, i.e. the captured samples are not yet played. In this
* case \a *negative is set to 1.
* The latency is stored in \a *r_usec. In case the stream is a
* monitoring stream the result can be negative, i.e. the captured
* samples are not yet played. In this case \a *negative is set to 1.
*
* If no timing information has been received yet, this call will
* return PA_ERR_NODATA. For more details see
* pa_stream_get_timing_info() and pa_stream_get_time(). */
* return PA_ERR_NODATA. On success, it will return 0.
*
* For more details see pa_stream_get_timing_info() and
* pa_stream_get_time(). */
int pa_stream_get_latency(pa_stream *s, pa_usec_t *r_usec, int *negative);
/** Return the latest raw timing data structure. The returned pointer