:right-sidebar: True

Format
===================================================================

.. currentmodule:: gi.repository.Gst





.. class:: Format
   :no-contents-entry:






Standard predefined formats




Methods
-------

.. rst-class:: interim-class

.. class:: Format
   :no-index:


   .. method:: get_by_nick() -> ~gi.repository.Gst.Format

      Return the format registered with the given nick.









   .. method:: get_details() -> ~gi.repository.Gst.FormatDefinition | None

      Get details about the given format.









   .. method:: get_name() -> str | None

      Get a printable name for the given format. Do not modify or free.









   .. method:: iterate_definitions() -> ~gi.repository.Gst.Iterator

      Iterate all the registered formats. The format definition is read
      only.









   .. method:: register(description: str) -> ~gi.repository.Gst.Format

      Create a new GstFormat based on the nick or return an
      already registered format with that nick.






      :param description: The description of the new format




   .. method:: to_quark() -> int

      Get the unique quark for the given format.



















Fields
------

.. rst-class:: interim-class

.. class:: Format
   :no-index:
   

   .. attribute:: BUFFERS

      The type of the None singleton.







   .. attribute:: BYTES

      The type of the None singleton.







   .. attribute:: DEFAULT

      The type of the None singleton.







   .. attribute:: PERCENT

      The type of the None singleton.







   .. attribute:: TIME

      The type of the None singleton.







   .. attribute:: UNDEFINED

      The type of the None singleton.