mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-13 10:55:34 +00:00
Code Issues 1 Projects Releases Wiki Activity

pad: fix docs for GstPadProbeReturn

Browse source 
There is no 'block' value, but we have 'drop'. Also fix the markup; it
is '%' to link to constants (and enum values).
This commit is contained in:
Stefan Sauer 2017-02-15 20:37:40 +01:00
parent d709e9fa0c
commit ed7d1b668b
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
gst/gstpad.h
View file

@ -532,19 +532,19 @@ typedef enum
* @GST_PAD_PROBE_OK: normal probe return value. This leaves the probe in * @GST_PAD_PROBE_OK: normal probe return value. This leaves the probe in
* place, and defers decisions about dropping or passing data to other * place, and defers decisions about dropping or passing data to other
* probes, if any. If there are no other probes, the default behaviour * probes, if any. If there are no other probes, the default behaviour
* for the probe type applies (block for blocking probes, and pass for * for the probe type applies (%GST_PAD_PROBE_DROP for blocking probes,
* non-blocking probes). * and %GST_PAD_PROBE_PASS for non-blocking probes).
* @GST_PAD_PROBE_DROP: drop data in data probes. For push mode this means that * @GST_PAD_PROBE_DROP: drop data in data probes. For push mode this means that
* the data item is not sent downstream. For pull mode, it means that * the data item is not sent downstream. For pull mode, it means that
* 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.
* @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.
* @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
* or event yourself). For queries it will also return %TRUE to the caller. * or event yourself). For queries it will also return %TRUE to the caller.
* The probe can also modify the #GstFlowReturn value by using the * The probe can also modify the #GstFlowReturn value by using the
* #GST_PAD_PROBE_INFO_FLOW_RETURN() accessor. * #GST_PAD_PROBE_INFO_FLOW_RETURN() accessor.