doc: Clarify that gst_buffer_pool_acquire_buffer() blocks by default

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2955>

diff --git a/subprojects/gstreamer/gst/gstbufferpool.c b/subprojects/gstreamer/gst/gstbufferpool.c
index 96192cf..c98f7e1 100644 (file)
--- a/subprojects/gstreamer/gst/gstbufferpool.c
+++ b/subprojects/gstreamer/gst/gstbufferpool.c
@@ -1262,7 +1262,9 @@ default_reset_buffer (GstBufferPool * pool, GstBuffer * buffer)
  * @params: (transfer none) (allow-none): parameters.
  *
  * Acquires a buffer from @pool. @buffer should point to a memory location that
- * can hold a pointer to the new buffer.
+ * can hold a pointer to the new buffer. When the pool is empty, this function
+ * will by default block until a buffer is released into the pool again or when
+ * the pool is set to flushing or deactivated.
  *
  * @params can contain optional parameters to influence the allocation.
  *