mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-10-31 22:25:33 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

client API: Document buffer_attr.maxlength

Browse source 
Let's officially support that people use maxlength to put an upper
bound on playback latency.

Signed-off-by: David Henningsson <david.henningsson@canonical.com>
This commit is contained in:
David Henningsson 2013-03-25 09:20:16 +01:00 • committed by Tanu Kaskinen
parent 5f326b705d
commit feeec28de4
1 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/pulse/def.h
View file

@ -360,7 +360,13 @@ typedef struct pa_buffer_attr {
uint32_t maxlength;
/**< Maximum length of the buffer in bytes. Setting this to (uint32_t) -1
* will initialize this to the maximum value supported by server,
* which is recommended. */
* which is recommended.
*
* In strict low-latency playback scenarios you might want to set this to
* a lower value, likely together with the PA_STREAM_ADJUST_LATENCY flag.
* If you do so, you ensure that the latency doesn't grow beyond what is
* acceptable for the use case, at the cost of getting more underruns if
* the latency is lower than what the server can reliably handle. */
uint32_t tlength;
/**< Playback only: target length of the buffer. The server tries