mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-24 09:10:36 +00:00
Code Issues 1 Projects Releases Wiki Activity

pad: Improve the documentation for GstPadProbeReturn.

Browse source 
Explain that GST_PAD_PROBE_PASS will pass data even if there is
another pad probe that says to block, and that GST_PAD_PROBE_REMOVE
passes data and potentially unblocks the pad.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/749>
This commit is contained in:
Jan Schmidt 2021-02-06 03:58:54 +11:00
parent 170f694198
commit da3886acac
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
gst/gstpad.h
View file

@ -548,9 +548,12 @@ typedef enum
* the data item is not passed upstream. In both cases, no other probes * the data item is not passed upstream. In both cases, no other probes
* are called for this item and %GST_FLOW_OK or %TRUE is returned to the * are called for this item and %GST_FLOW_OK or %TRUE is returned to the
* caller. * caller.
* @GST_PAD_PROBE_REMOVE: remove this probe. * @GST_PAD_PROBE_REMOVE: remove this probe, passing the data. For blocking probes
* this will cause data flow to unblock, unless there are also other
* blocking probes installed.
* @GST_PAD_PROBE_PASS: pass the data item in the block probe and block on the * @GST_PAD_PROBE_PASS: pass the data item in the block probe and block on the
* next item. * next item. Note, that if there are multiple pad probes installed and
* any probe returns PASS, the data will be passed.
* @GST_PAD_PROBE_HANDLED: Data has been handled in the probe and will not be * @GST_PAD_PROBE_HANDLED: Data has been handled in the probe and will not be
* forwarded further. For events and buffers this is the same behaviour as * forwarded further. For events and buffers this is the same behaviour as
* %GST_PAD_PROBE_DROP (except that in this case you need to unref the buffer * %GST_PAD_PROBE_DROP (except that in this case you need to unref the buffer