aboutsummaryrefslogtreecommitdiffstats
path: root/src/pcm_buffer.h
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/pcm_buffer.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/pcm_buffer.h b/src/pcm_buffer.h
index fe223c742..b132d4fd2 100644
--- a/src/pcm_buffer.h
+++ b/src/pcm_buffer.h
@@ -63,6 +63,10 @@ pcm_buffer_deinit(struct pcm_buffer *buffer)
/**
* Get the buffer, and guarantee a minimum size. This buffer becomes
* invalid with the next pcm_buffer_get() call.
+ *
+ * This function will never return NULL, even if size is zero, because
+ * the PCM library uses the NULL return value to signal "error". An
+ * empty destination buffer is not always an error.
*/
G_GNUC_MALLOC
void *