clarify that buffers remain alive until the remove_buffer callback returns

In order for stream buffers to be captured and then processed by other
threads, pipewire needs to guarantee that the buffer will remain alive
until the application is notified of its removal.  In this case pipewire
uses the "remove_buffer" callback to notify the application that a buffer
is about to be removed, so pipewire must guarantee that it is alive up
to that point.
This commit is contained in:
Jonathan Marler 2023-03-06 09:02:57 -07:00 committed by Wim Taymans
parent 90b11e3c49
commit 44f4845df3

View file

@ -122,7 +122,7 @@ extern "C" {
* metadata of the buffer.
*
* The buffer is owned by the stream and stays alive until the
* remove_buffer event is emitted or the stream is destroyed.
* remove_buffer callback has returned or the stream is destroyed.
*
* When the buffer has been processed, call \ref pw_stream_queue_buffer()
* to let PipeWire reuse the buffer.