mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-29 11:40:38 +00:00
139 lines
1.9 KiB
Text
139 lines
1.9 KiB
Text
<!-- ##### SECTION Title ##### -->
|
|
GstProbe
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Receive callbacks of data passing
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
PadProbes are used to be signalled with a callback when certain GstData
|
|
passes through pads.
|
|
</para>
|
|
<para>
|
|
Probes are usually used in combination with a probe dispatcher that will
|
|
enumerate all registered probes to signal them.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### STRUCT GstProbe ##### -->
|
|
<para>
|
|
The probe structure
|
|
</para>
|
|
|
|
@single_shot:
|
|
@callback:
|
|
@user_data:
|
|
|
|
<!-- ##### USER_FUNCTION GstProbeCallback ##### -->
|
|
<para>
|
|
The function that will be called when a probe is activated.
|
|
</para>
|
|
|
|
@probe: The probe that signalled the callback
|
|
@data: The GstData that triggered the probe
|
|
@user_data: user data
|
|
@Returns: TRUE if the GstData should be removed from the stream.
|
|
|
|
|
|
<!-- ##### FUNCTION gst_probe_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@single_shot:
|
|
@callback:
|
|
@user_data:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_probe_destroy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@probe:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_probe_perform ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@probe:
|
|
@data:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### STRUCT GstProbeDispatcher ##### -->
|
|
<para>
|
|
The structure of the probe dispatcher
|
|
</para>
|
|
|
|
@active:
|
|
@probes:
|
|
|
|
<!-- ##### FUNCTION gst_probe_dispatcher_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_probe_dispatcher_destroy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@disp:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_probe_dispatcher_init ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@disp:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_probe_dispatcher_set_active ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@disp:
|
|
@active:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_probe_dispatcher_add_probe ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@disp:
|
|
@probe:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_probe_dispatcher_remove_probe ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@disp:
|
|
@probe:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_probe_dispatcher_dispatch ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@disp:
|
|
@data:
|
|
@Returns:
|
|
|
|
|