GstPadProbeReturn

Different return values for the #GstPadProbeCallback.

Values

ValueMeaning
DROP0

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, no more probes are called and #GST_FLOW_OK or %TRUE is returned to the caller.

OK1

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).

REMOVE2

remove this probe.

PASS3

pass the data item in the block probe and block on the next item.

HANDLED4

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 or event yourself). For queries it will also return %TRUE to the caller. The probe can also modify the #GstFlowReturn value by using the #GST_PAD_PROBE_INFO_FLOW_RETURN() accessor. Note that the resulting query must contain valid entries. Since: 1.6

Meta