From 0d41bcfcbf9c523612e37127dc857b30bc0a565f Mon Sep 17 00:00:00 2001 From: Arun Raghavan Date: Fri, 30 Dec 2011 23:49:59 +0530 Subject: [PATCH] doc: Clarify pa_stream_get_latency() return value Clarifies that the latency is returned via an inout parameter and the return value is an error code or 0 on success. --- src/pulse/stream.h | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/pulse/stream.h b/src/pulse/stream.h index 0422cc9..6e6d34a 100644 --- a/src/pulse/stream.h +++ b/src/pulse/stream.h @@ -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 -- 2.7.4