diff options
| author | Jan Schmidt <jan@centricular.com> | 2021-02-06 03:58:54 +1100 |
|---|---|---|
| committer | Jan Schmidt <jan@centricular.com> | 2021-02-10 13:43:28 +1100 |
| commit | da3886acacd0c7b6fe8664bec599b1d34732df6b (patch) | |
| tree | 6fb49465b59509fd57a1e973cca14cf576f05df4 /gst | |
| parent | 170f694198509f23a2ad77e28d069b2d1fb2ece6 (diff) | |
pad: Improve the documentation for GstPadProbeReturn.
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>
Diffstat (limited to 'gst')
| -rw-r--r-- | gst/gstpad.h | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/gst/gstpad.h b/gst/gstpad.h index 8cc896dec7..c89be30508 100644 --- a/gst/gstpad.h +++ b/gst/gstpad.h @@ -548,9 +548,12 @@ typedef enum * 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 * 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 - * 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 * 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 |