PadProbeReturn

class PadProbeReturn

Different return values for the PadProbeCallback.

Fields

class PadProbeReturn

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, no other probes are called for this item and OK or True is returned to the caller.

HANDLED

Data has been handled in the probe and will not be forwarded further. For events and buffers this is the same behaviour as 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 FlowReturn value by using the ``GST_PAD_PROBE_INFO_FLOW_RETURN``() accessor. Note that the resulting query must contain valid entries. Since: 1.6

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

PASS

Pass the data item in the block probe and block on the next item. Note, that if there are multiple pad probes installed and any probe returns PASS, the data will be passed.

REMOVE

Remove this probe, passing the data. For blocking probes this will cause data flow to unblock, unless there are also other blocking probes installed.