:right-sidebar: True

AggregatorPad
===================================================================

.. currentmodule:: gi.repository.GstBase


.. versionadded:: 1.14




.. class:: AggregatorPad(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.Gst.Pad`, :class:`~gi.repository.Gst.Object`, :class:`~gi.repository.GObject.InitiallyUnowned`, :class:`~gi.repository.GObject.Object`





:Constructors:

::

    AggregatorPad(**properties)





Methods
-------

.. rst-class:: interim-class

.. class:: AggregatorPad
   :no-index:


   .. method:: drop_buffer() -> bool

      Drop the buffer currently queued in ``pad``.










   .. method:: has_buffer() -> bool

      This checks if a pad has a buffer available that will be returned by
      a call to :func:`~gi.repository.GstBase.AggregatorPad.peek_buffer` or
      :func:`~gi.repository.GstBase.AggregatorPad.pop_buffer`.



      .. versionadded:: 1.14.1








   .. method:: is_eos() -> bool

      









   .. method:: is_inactive() -> bool

      It is only valid to call this method from ``GstAggregatorClass``::aggregate()



      .. versionadded:: 1.20








   .. method:: peek_buffer() -> ~gi.repository.Gst.Buffer | None

      









   .. method:: pop_buffer() -> ~gi.repository.Gst.Buffer | None

      Steal the ref to the buffer currently queued in ``pad``.














Properties
----------

.. rst-class:: interim-class

.. class:: AggregatorPad
   :no-index:
   

   .. attribute:: props.emit_signals
      :type: bool

      Enables the emission of signals such as :obj:`~gi.repository.GstBase.AggregatorPad`::buffer-consumed



      .. versionadded:: 1.16









Signals
-------

.. rst-class:: interim-class

.. class:: AggregatorPad.signals
   :no-index:
   

   .. method:: buffer_consumed(object: ~gi.repository.Gst.Buffer) -> None

      






      :param object: 








Virtual Methods
---------------

.. rst-class:: interim-class

.. class:: AggregatorPad
   :no-index:
   

   .. method:: do_flush(aggregator: ~gi.repository.GstBase.Aggregator) -> ~gi.repository.Gst.FlowReturn

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







      :param aggregator: 




   .. method:: do_skip_buffer(aggregator: ~gi.repository.GstBase.Aggregator, buffer: ~gi.repository.Gst.Buffer) -> bool

      Optional
      Called before input buffers are queued in the pad, return :const:`True`
      if the buffer should be skipped.







      :param aggregator: 

      :param buffer: 








Fields
------

.. rst-class:: interim-class

.. class:: AggregatorPad
   :no-index:
   

   .. attribute:: parent

      






   .. attribute:: priv

      






   .. attribute:: segment

      Last segment received.