OSDN Git Service

alsa-lib: Reword doxygen doc for snd_pcm_delay()
authorLennart Poettering <mznyfn@0pointer.de>
Sun, 31 Aug 2008 01:42:20 +0000 (03:42 +0200)
committerJaroslav Kysela <perex@perex.cz>
Sun, 31 Aug 2008 13:46:22 +0000 (15:46 +0200)
commitbd7b73a621a74de863f6d6f79af4131144e4f9fe
treecd9fcf2b2d0d2cc958fbde2a35c5012eaa38aeaf
parent73d20069e072e2b62bbc3ea12e46ae19d8b6cac9
alsa-lib: Reword doxygen doc for snd_pcm_delay()

snd_pcm_delay() is for synchronization purposes, it returns the overall latency
of the stream, not just the latency induced by the hardware playback buffer.
The documentation is a bit misleading about this fact, and some people already
misunderstood it. So let's reword this to make the explanation clearer and
explicit.

This is a result of the discussions of the thread this mail belongs to:

http://mailman.alsa-project.org/pipermail/alsa-devel/2008-June/008456.html

From: Lennart Poettering <mznyfn@0pointer.de>
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
src/pcm/pcm.c