doc: Clarify that gst_buffer_pool_acquire_buffer() blocks by default

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2955>
This commit is contained in:
Xavier Claessens 2022-08-30 10:48:18 -04:00 committed by GStreamer Marge Bot
parent 64010bb1f8
commit a9ae28d10b

View file

@ -1262,7 +1262,9 @@ default_reset_buffer (GstBufferPool * pool, GstBuffer * buffer)
* @params: (transfer none) (allow-none): parameters. * @params: (transfer none) (allow-none): parameters.
* *
* Acquires a buffer from @pool. @buffer should point to a memory location that * 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. * @params can contain optional parameters to influence the allocation.
* *