:right-sidebar: True

PadProbeInfo
===================================================================

.. currentmodule:: gi.repository.Gst





.. class:: PadProbeInfo(*args, **kwargs)
   :no-contents-entry:






Info passed in the :obj:`~gi.repository.Gst.PadProbeCallback`\.




Methods
-------

.. rst-class:: interim-class

.. class:: PadProbeInfo
   :no-index:


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

      










   .. method:: get_buffer_list() -> ~gi.repository.Gst.BufferList | None

      










   .. method:: get_event() -> ~gi.repository.Gst.Event | None

      










   .. method:: get_flow_return() -> ~gi.repository.Gst.FlowReturn

      



      .. versionadded:: 1.28








   .. method:: get_id() -> int

      



      .. versionadded:: 1.28








   .. method:: get_offset() -> int

      



      .. versionadded:: 1.28








   .. method:: get_query() -> ~gi.repository.Gst.Query | None

      










   .. method:: get_size() -> int

      



      .. versionadded:: 1.28








   .. method:: get_type() -> ~gi.repository.Gst.PadProbeType

      



      .. versionadded:: 1.28








   .. method:: set_buffer(buffer: ~gi.repository.Gst.Buffer | None = None) -> None

      Updates ``info`` with ``buffer`` or :const:`None`.



      .. versionadded:: 1.28





      :param buffer: a :obj:`~gi.repository.Gst.Buffer`




   .. method:: set_buffer_list(list: ~gi.repository.Gst.BufferList | None = None) -> None

      Updates ``info`` with ``list`` or :const:`None`.



      .. versionadded:: 1.28





      :param list: a :obj:`~gi.repository.Gst.BufferList`




   .. method:: set_event(event: ~gi.repository.Gst.Event | None = None) -> None

      Updates ``info`` with ``event`` or :const:`None`.



      .. versionadded:: 1.28





      :param event: a :obj:`~gi.repository.Gst.Event`




   .. method:: set_flow_return(flow_ret: ~gi.repository.Gst.FlowReturn) -> None

      Updates ``info`` with ``flow_ret``\.



      .. versionadded:: 1.28





      :param flow_ret: A :obj:`~gi.repository.Gst.FlowReturn`














Fields
------

.. rst-class:: interim-class

.. class:: PadProbeInfo
   :no-index:
   

   .. attribute:: data

      Type specific data, check the ``type`` field to know the
      datatype.  This field can be :const:`None`.






   .. attribute:: id

      The id of the probe






   .. attribute:: offset

      Offset of pull probe, this field is valid when ``type`` contains
      ``GST_PAD_PROBE_TYPE_PULL``






   .. attribute:: size

      Size of pull probe, this field is valid when ``type`` contains
      ``GST_PAD_PROBE_TYPE_PULL``






   .. attribute:: type

      The current probe type