def: Document that pa_buffer_attr.maxlength is in bytes.

Fixes https://bugs.freedesktop.org/show_bug.cgi?id=42919
This commit is contained in:
Peter Meerwald 2011-12-11 16:07:39 +01:00 committed by Colin Guthrie
parent d735857942
commit 564997e487

View file

@ -339,7 +339,7 @@ typedef enum pa_stream_flags {
/** Playback and record buffer metrics */
typedef struct pa_buffer_attr {
uint32_t maxlength;
/**< Maximum length of the buffer. Setting this to (uint32_t) -1
/**< 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. */