From feeec28de481de41fc99f73ccc9bc64ff06235f8 Mon Sep 17 00:00:00 2001 From: David Henningsson Date: Mon, 25 Mar 2013 09:20:16 +0100 Subject: client API: Document buffer_attr.maxlength Let's officially support that people use maxlength to put an upper bound on playback latency. Signed-off-by: David Henningsson --- src/pulse/def.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/pulse/def.h b/src/pulse/def.h index 495302f8..a7f592b3 100644 --- a/src/pulse/def.h +++ b/src/pulse/def.h @@ -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 -- cgit v1.2.3