appsink

Appsink is a sink plugin that supports many different methods for making the application get a handle on the GStreamer data in a pipeline. Unlike most GStreamer elements, Appsink provides external API functions.

For the documentation of the API, please see the

libgstapp section in the GStreamer Plugins Base Libraries documentation.

Hierarchy

GObject
    ╰──GInitiallyUnowned
        ╰──GstObject
            ╰──GstElement
                ╰──GstBaseSink
                    ╰──appsink

Implemented interfaces

GstURIHandler

Factory details

Authors: – David Schleef , Wim Taymans

Classification:Generic/Sink

Rank – none

Plugin – app

Package – GStreamer Base Plug-ins

Pad Templates

sink

ANY

Presencealways

Directionsink

Object type – GstPad


Signals

eos

eos_callback (GstElement* param_0,
              gpointer udata)
def eos_callback (param_0, udata):
    #python callback for the 'eos' signal
function eos_callback(param_0: GstElement* param_0, udata: gpointer udata): {
    // javascript callback for the 'eos' signal
}

Parameters:

param_0
No description available
udata
No description available

Flags: Run Last


new-preroll

GstFlowReturn*
new_preroll_callback (GstElement* param_0,
                      gpointer udata)
def new_preroll_callback (param_0, udata):
    #python callback for the 'new-preroll' signal
function new_preroll_callback(param_0: GstElement* param_0, udata: gpointer udata): {
    // javascript callback for the 'new-preroll' signal
}

Parameters:

param_0
No description available
udata
No description available
Returns (GstFlowReturn*)
No description available

Flags: Run Last


new-sample

GstFlowReturn*
new_sample_callback (GstElement* param_0,
                     gpointer udata)
def new_sample_callback (param_0, udata):
    #python callback for the 'new-sample' signal
function new_sample_callback(param_0: GstElement* param_0, udata: gpointer udata): {
    // javascript callback for the 'new-sample' signal
}

Parameters:

param_0
No description available
udata
No description available
Returns (GstFlowReturn*)
No description available

Flags: Run Last


new-serialized-event

gboolean
new_serialized_event_callback (GstElement* param_0,
                               gpointer udata)
def new_serialized_event_callback (param_0, udata):
    #python callback for the 'new-serialized-event' signal
function new_serialized_event_callback(param_0: GstElement* param_0, udata: gpointer udata): {
    // javascript callback for the 'new-serialized-event' signal
}

Parameters:

param_0
No description available
udata
No description available
Returns (gboolean)
No description available

Flags: Run Last


propose-allocation

gboolean
propose_allocation_callback (GstElement* param_0,
                             GstQuery* arg0,
                             gpointer udata)
def propose_allocation_callback (param_0, arg0, udata):
    #python callback for the 'propose-allocation' signal
function propose_allocation_callback(param_0: GstElement* param_0, arg0: GstQuery* arg0, udata: gpointer udata): {
    // javascript callback for the 'propose-allocation' signal
}

Parameters:

param_0
No description available
arg0
No description available
udata
No description available
Returns (gboolean)
No description available

Flags: Run Last


Action Signals

pull-preroll

g_signal_emit_by_name (param_0, "pull-preroll", &ret);
ret = param_0.emit ("pull-preroll")
let ret = param_0.emit ("pull-preroll");

Parameters:

param_0 (GstElement*)
No description available
Returns (GstSample*)
No description available

Flags: Run Last / Action


pull-sample

g_signal_emit_by_name (param_0, "pull-sample", &ret);
ret = param_0.emit ("pull-sample")
let ret = param_0.emit ("pull-sample");

Parameters:

param_0 (GstElement*)
No description available
Returns (GstSample*)
No description available

Flags: Run Last / Action


try-pull-object

g_signal_emit_by_name (param_0, "try-pull-object", arg0, &ret);
ret = param_0.emit ("try-pull-object", arg0)
let ret = param_0.emit ("try-pull-object", arg0);

Parameters:

param_0 (GstElement*)
No description available
arg0 (guint64)
No description available
Returns (GstMiniObject*)
No description available

Flags: Run Last / Action


try-pull-preroll

g_signal_emit_by_name (param_0, "try-pull-preroll", arg0, &ret);
ret = param_0.emit ("try-pull-preroll", arg0)
let ret = param_0.emit ("try-pull-preroll", arg0);

Parameters:

param_0 (GstElement*)
No description available
arg0 (guint64)
No description available
Returns (GstSample*)
No description available

Flags: Run Last / Action


try-pull-sample

g_signal_emit_by_name (param_0, "try-pull-sample", arg0, &ret);
ret = param_0.emit ("try-pull-sample", arg0)
let ret = param_0.emit ("try-pull-sample", arg0);

Parameters:

param_0 (GstElement*)
No description available
arg0 (guint64)
No description available
Returns (GstSample*)
No description available

Flags: Run Last / Action


Properties

buffer-list

“buffer-list” gboolean

Use buffer lists

Flags : Read / Write

Default value : false


caps

“caps” GstCaps*

The allowed caps for the sink pad

Flags : Read / Write


drop

“drop” gboolean

Drop old buffers when the buffer queue is filled

Flags : Read / Write

Default value : false


emit-signals

“emit-signals” gboolean

Emit new-preroll and new-sample signals

Flags : Read / Write

Default value : false


eos

“eos” gboolean

Check if the sink is EOS or not started

Flags : Read

Default value : true


max-buffers

“max-buffers” guint

The maximum number of buffers to queue internally (0 = unlimited)

Flags : Read / Write

Default value : 0


max-bytes

“max-bytes” guint64

The maximum amount of bytes to queue internally (0 = unlimited)

Flags : Read / Write

Default value : 0


max-time

“max-time” guint64

The maximum total duration to queue internally (in ns, 0 = unlimited)

Flags : Read / Write

Default value : 0


wait-on-eos

“wait-on-eos” gboolean

Wait for all buffers to be processed after receiving an EOS

Flags : Read / Write

Default value : true


The results of the search are