mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-04-16 21:14:44 +00:00
Code Issues 1 Projects Releases Wiki Activity

pad: Clarify pad probe return type documentation

Browse source
This commit is contained in:
Arun Raghavan 2015-07-06 11:16:27 +05:30
parent 8e2c72f125
commit f0da038c34
1 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
gst/gstpad.h
View file

@ -500,14 +500,18 @@ typedef enum
/**
* GstPadProbeReturn:
* @GST_PAD_PROBE_OK: normal probe return value
* @GST_PAD_PROBE_OK: normal probe return value. This leaves the probe in
* place, and defers decisions about dropping or passing data to other
* probes, if any. If there are no other probes, the default behaviour
* for the probe type applies (block for blocking probes, and pass for
* non-blocking probes).
* @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 passed upstream. In both cases, this result code
* means that #GST_FLOW_OK or %TRUE is returned to the caller.
* @GST_PAD_PROBE_REMOVE: remove probe
* @GST_PAD_PROBE_PASS: pass the data item in the block probe and block on
* the next item
* the data item is not sent downstream. For pull mode, it means that
* the data item is not passed upstream. In both cases, no more probes
* are called and #GST_FLOW_OK or %TRUE is returned to the caller.
* @GST_PAD_PROBE_REMOVE: remove this probe.
* @GST_PAD_PROBE_PASS: pass the data item in the block probe and block on the
* next item.
*
* Different return values for the #GstPadProbeCallback.
*/