:right-sidebar: True

PadTemplate
===================================================================

.. currentmodule:: gi.repository.Gst





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


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





:Constructors:

::

    PadTemplate(**properties)
    new(name_template:str, direction:Gst.PadDirection, presence:Gst.PadPresence, caps:Gst.Caps) -> Gst.PadTemplate or None
    new_from_static_pad_template_with_gtype(pad_template:Gst.StaticPadTemplate, pad_type:GType) -> Gst.PadTemplate or None
    new_with_gtype(name_template:str, direction:Gst.PadDirection, presence:Gst.PadPresence, caps:Gst.Caps, pad_type:GType) -> Gst.PadTemplate or None



Constructors
------------

.. rst-class:: interim-class

.. class:: PadTemplate
   :no-index:


   .. classmethod:: new(name_template: str, direction: ~gi.repository.Gst.PadDirection, presence: ~gi.repository.Gst.PadPresence, caps: ~gi.repository.Gst.Caps) -> ~gi.repository.Gst.PadTemplate | None

      Creates a new pad template with a name according to the given template
      and with the given arguments.







      :param name_template: the name template.


      :param direction: the :obj:`~gi.repository.Gst.PadDirection` of the template.


      :param presence: the :obj:`~gi.repository.Gst.PadPresence` of the pad.


      :param caps: a :obj:`~gi.repository.Gst.Caps` set for the template.





   .. classmethod:: new_from_static_pad_template_with_gtype(pad_template: ~gi.repository.Gst.StaticPadTemplate, pad_type: type) -> ~gi.repository.Gst.PadTemplate | None

      Converts a :obj:`~gi.repository.Gst.StaticPadTemplate` into a :obj:`~gi.repository.Gst.PadTemplate` with a type.



      .. versionadded:: 1.14





      :param pad_template: the static pad template


      :param pad_type: The :obj:`~gi.repository.GObject.Type` of the pad to create





   .. classmethod:: new_with_gtype(name_template: str, direction: ~gi.repository.Gst.PadDirection, presence: ~gi.repository.Gst.PadPresence, caps: ~gi.repository.Gst.Caps, pad_type: type) -> ~gi.repository.Gst.PadTemplate | None

      Creates a new pad template with a name according to the given template
      and with the given arguments.



      .. versionadded:: 1.14





      :param name_template: the name template.


      :param direction: the :obj:`~gi.repository.Gst.PadDirection` of the template.


      :param presence: the :obj:`~gi.repository.Gst.PadPresence` of the pad.


      :param caps: a :obj:`~gi.repository.Gst.Caps` set for the template.


      :param pad_type: The :obj:`~gi.repository.GObject.Type` of the pad to create









Methods
-------

.. rst-class:: interim-class

.. class:: PadTemplate
   :no-index:


   .. method:: get_caps() -> ~gi.repository.Gst.Caps

      Gets the capabilities of the pad template.










   .. method:: get_documentation_caps() -> ~gi.repository.Gst.Caps

      See :func:`~gi.repository.Gst.PadTemplate.set_documentation_caps`.



      .. versionadded:: 1.18








   .. method:: pad_created(pad: ~gi.repository.Gst.Pad) -> None

      Emit the pad-created signal for this template when created by this pad.







      :param pad: the :obj:`~gi.repository.Gst.Pad` that created it





   .. method:: set_documentation_caps(caps: ~gi.repository.Gst.Caps) -> None

      Certain elements will dynamically construct the caps of their
      pad templates. In order not to let environment-specific information
      into the documentation, element authors should use this method to
      expose "stable" caps to the reader.



      .. versionadded:: 1.18





      :param caps: the documented capabilities









Properties
----------

.. rst-class:: interim-class

.. class:: PadTemplate
   :no-index:
   

   .. attribute:: props.caps
      :type: ~gi.repository.Gst.Caps

      The capabilities of the pad described by the pad template.







   .. attribute:: props.direction
      :type: ~gi.repository.Gst.PadDirection

      The direction of the pad described by the pad template.







   .. attribute:: props.gtype
      :type: type

      The type of the pad described by the pad template.



      .. versionadded:: 1.14





   .. attribute:: props.name_template
      :type: str

      The name template of the pad template.







   .. attribute:: props.presence
      :type: ~gi.repository.Gst.PadPresence

      When the pad described by the pad template will become available.











Signals
-------

.. rst-class:: interim-class

.. class:: PadTemplate.signals
   :no-index:
   

   .. method:: pad_created(pad: ~gi.repository.Gst.Pad) -> None

      This signal is fired when an element creates a pad from this template.







      :param pad: the pad that was created.









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

.. rst-class:: interim-class

.. class:: PadTemplate
   :no-index:
   

   .. method:: do_pad_created(pad: ~gi.repository.Gst.Pad) -> None

      Emit the pad-created signal for this template when created by this pad.







      :param pad: the :obj:`~gi.repository.Gst.Pad` that created it









Fields
------

.. rst-class:: interim-class

.. class:: PadTemplate
   :no-index:
   

   .. attribute:: caps

      






   .. attribute:: direction

      






   .. attribute:: name_template

      






   .. attribute:: object

      






   .. attribute:: presence