diff options
| author | Arun Raghavan <git@arunraghavan.net> | 2015-07-06 11:16:27 +0530 |
|---|---|---|
| committer | Arun Raghavan <git@arunraghavan.net> | 2015-07-06 14:35:51 +0530 |
| commit | f0da038c340640d96e7db902ad1523f3498935ca (patch) | |
| tree | e3d7912753b96b015afe313a3fd988b655d63e49 /gst | |
| parent | 8e2c72f1257188f33ebf78629b24cbf224184a69 (diff) | |
pad: Clarify pad probe return type documentation
Diffstat (limited to 'gst')
| -rw-r--r-- | gst/gstpad.h | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/gst/gstpad.h b/gst/gstpad.h index 696d79d064..32e6b15bfc 100644 --- a/gst/gstpad.h +++ b/gst/gstpad.h @@ -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. */ |