Blame docs/libs/html/GstAggregatorPad.html

Packit a6ee4b
Packit a6ee4b
<html>
Packit a6ee4b
<head>
Packit a6ee4b
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit a6ee4b
<title>GstAggregatorPad: GStreamer 1.0 Library Reference Manual</title>
Packit a6ee4b
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit a6ee4b
<link rel="home" href="index.html" title="GStreamer 1.0 Library Reference Manual">
Packit a6ee4b
<link rel="up" href="gstreamer-base.html" title="GStreamer Base and Utility Classes">
Packit a6ee4b
<link rel="prev" href="GstAggregator.html" title="GstAggregator">
Packit a6ee4b
<link rel="next" href="GstBaseParse.html" title="GstBaseParse">
Packit a6ee4b
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
Packit a6ee4b
<link rel="stylesheet" href="style.css" type="text/css">
Packit a6ee4b
</head>
Packit a6ee4b
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Top  | 
Packit a6ee4b
                  Description  | 
Packit a6ee4b
                  Object Hierarchy  | 
Packit a6ee4b
                  Properties  | 
Packit a6ee4b
                  Signals
Packit a6ee4b
Packit a6ee4b
Home
Packit a6ee4b
Up
Packit a6ee4b
Prev
Packit a6ee4b
Next
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

GstAggregatorPad

Packit a6ee4b

GstAggregatorPad — GstPad subclass for pads managed by GstAggregator

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Functions

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
GstBuffer *
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
gst_aggregator_pad_pop_buffer ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
GstBuffer *
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
gst_aggregator_pad_peek_buffer ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
gboolean
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
gst_aggregator_pad_drop_buffer ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
gboolean
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
gst_aggregator_pad_is_eos ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
gboolean
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
gst_aggregator_pad_has_buffer ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Properties

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
gboolean
Packit a6ee4b
emit-signals
Packit a6ee4b
Read / Write
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Signals

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
void
Packit a6ee4b
buffer-consumed
Packit a6ee4b
Run First
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Types and Values

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
struct
Packit a6ee4b
GstAggregatorPad
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
struct
Packit a6ee4b
GstAggregatorPadClass
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Object Hierarchy

Packit a6ee4b
    GObject
Packit a6ee4b
    ╰── GInitiallyUnowned
Packit a6ee4b
        ╰── GstObject
Packit a6ee4b
            ╰── GstPad
Packit a6ee4b
                ╰── GstAggregatorPad
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Includes

Packit a6ee4b
#include <gst/base/base.h>
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Description

Packit a6ee4b

Pads managed by a GstAggregor subclass.

Packit a6ee4b

This class used to live in gst-plugins-bad and was moved to core.

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Functions

Packit a6ee4b
Packit a6ee4b

gst_aggregator_pad_pop_buffer ()

Packit a6ee4b
GstBuffer *
Packit a6ee4b
gst_aggregator_pad_pop_buffer (GstAggregatorPad *pad);
Packit a6ee4b

Steal the ref to the buffer currently queued in pad

Packit a6ee4b
.

Packit a6ee4b
Packit a6ee4b

Parameters

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

pad

Packit a6ee4b

the pad to get buffer from

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Returns

Packit a6ee4b

The buffer in pad

Packit a6ee4b
or NULL if no buffer was
Packit a6ee4b
queued. You should unref the buffer after usage. 

Packit a6ee4b

[transfer full]

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

gst_aggregator_pad_peek_buffer ()

Packit a6ee4b
GstBuffer *
Packit a6ee4b
gst_aggregator_pad_peek_buffer (GstAggregatorPad *pad);
Packit a6ee4b
Packit a6ee4b

Parameters

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

pad

Packit a6ee4b

the pad to get buffer from

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Returns

Packit a6ee4b

A reference to the buffer in pad

Packit a6ee4b
or
Packit a6ee4b
NULL if no buffer was queued. You should unref the buffer after
Packit a6ee4b
usage. 

Packit a6ee4b

[transfer full]

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

gst_aggregator_pad_drop_buffer ()

Packit a6ee4b
gboolean
Packit a6ee4b
gst_aggregator_pad_drop_buffer (GstAggregatorPad *pad);
Packit a6ee4b

Drop the buffer currently queued in pad

Packit a6ee4b
.

Packit a6ee4b
Packit a6ee4b

Parameters

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

pad

Packit a6ee4b

the pad where to drop any pending buffer

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Returns

Packit a6ee4b

TRUE if there was a buffer queued in pad

Packit a6ee4b
, or FALSE if not.

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

gst_aggregator_pad_is_eos ()

Packit a6ee4b
gboolean
Packit a6ee4b
gst_aggregator_pad_is_eos (GstAggregatorPad *pad);
Packit a6ee4b
Packit a6ee4b

Parameters

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

pad

Packit a6ee4b

an aggregator pad

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Returns

Packit a6ee4b

TRUE if the pad is EOS, otherwise FALSE.

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

gst_aggregator_pad_has_buffer ()

Packit a6ee4b
gboolean
Packit a6ee4b
gst_aggregator_pad_has_buffer (GstAggregatorPad *pad);
Packit a6ee4b

This checks if a pad has a buffer available that will be returned by

Packit a6ee4b
a call to gst_aggregator_pad_peek_buffer() or
Packit a6ee4b
gst_aggregator_pad_pop_buffer().

Packit a6ee4b
Packit a6ee4b

Parameters

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

pad

Packit a6ee4b

the pad to check the buffer on

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Returns

Packit a6ee4b

TRUE if the pad has a buffer available as the next thing.

Packit a6ee4b
Packit a6ee4b

Since: 1.14.1

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Types and Values

Packit a6ee4b
Packit a6ee4b

struct GstAggregatorPad

Packit a6ee4b
struct GstAggregatorPad {
Packit a6ee4b
  /* Protected by the OBJECT_LOCK */
Packit a6ee4b
  GstSegment segment;
Packit a6ee4b
};
Packit a6ee4b
Packit a6ee4b

The implementation the GstPad to use with GstAggregator

Packit a6ee4b
Packit a6ee4b

Members

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

GstSegment segment;

Packit a6ee4b

last segment received.

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Since: 1.14

Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

struct GstAggregatorPadClass

Packit a6ee4b
struct GstAggregatorPadClass {
Packit a6ee4b
  GstPadClass   parent_class;
Packit a6ee4b
Packit a6ee4b
  GstFlowReturn (*flush)       (GstAggregatorPad * aggpad, GstAggregator * aggregator);
Packit a6ee4b
  gboolean      (*skip_buffer) (GstAggregatorPad * aggpad, GstAggregator * aggregator, GstBuffer * buffer);
Packit a6ee4b
};
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Members

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

flush ()

Packit a6ee4b

Optional

Packit a6ee4b
Called when the pad has received a flush stop, this is the place
Packit a6ee4b
to flush any information specific to the pad, it allows for individual
Packit a6ee4b
pads to be flushed while others might not be.

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

skip_buffer ()

Packit a6ee4b

Optional

Packit a6ee4b
Called before input buffers are queued in the pad, return TRUE
Packit a6ee4b
if the buffer should be skipped.

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Since: 1.14

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Property Details

Packit a6ee4b
Packit a6ee4b

The “emit-signals” property

Packit a6ee4b
  “emit-signals”             gboolean
Packit a6ee4b

Enables the emission of signals such as “buffer-consumed”

Packit a6ee4b

Flags: Read / Write

Packit a6ee4b

Default value: FALSE

Packit a6ee4b

Since: 1.16

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Signal Details

Packit a6ee4b
Packit a6ee4b

The “buffer-consumed” signal

Packit a6ee4b
void
Packit a6ee4b
user_function (GstAggregatorPad *gstaggregatorpad,
Packit a6ee4b
               GstBuffer        *arg1,
Packit a6ee4b
               gpointer          user_data)
Packit a6ee4b

Flags: Run First

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

See Also

Packit a6ee4b

gstcollectpads for historical reasons.

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Generated by GTK-Doc V1.28
Packit a6ee4b
</body>
Packit a6ee4b
</html>