pad: Document the order in which pad probes are called

https://bugzilla.gnome.org/show_bug.cgi?id=757197
This commit is contained in:
Sebastian Dröge 2015-10-28 13:04:25 +02:00
parent 2dfa548f36
commit 1493f4a334

View file

@ -1324,6 +1324,13 @@ cleanup_hook (GstPad * pad, GHook * hook)
* Be notified of different states of pads. The provided callback is called for
* every state that matches @mask.
*
* Probes are called in groups: First GST_PAD_PROBE_TYPE_BLOCK probes are
* called, then others, then finally GST_PAD_PROBE_TYPE_IDLE. The only
* exception here are GST_PAD_PROBE_TYPE_IDLE probes that are called
* immediately if the pad is already idle while calling gst_pad_add_probe().
* In each of the groups, probes are called in the order in which they were
* added.
*
* Returns: an id or 0 if no probe is pending. The id can be used to remove the
* probe with gst_pad_remove_probe(). When using GST_PAD_PROBE_TYPE_IDLE it can
* happen that the probe can be run immediately and if the probe returns