: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(nick: str) -> ~gi.repository.Gst.Format

      Return the format registered with the given nick.







      :param nick: The nick of the format





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

      Get details about the given format.







      :param format: The format to get details of





   .. method:: get_name(format: ~gi.repository.Gst.Format) -> str | None

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







      :param format: a :obj:`~gi.repository.Gst.Format`





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

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










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

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







      :param nick: The nick of the new format


      :param description: The description of the new format





   .. method:: to_quark(format: ~gi.repository.Gst.Format) -> int

      Get the unique quark for the given format.







      :param format: a :obj:`~gi.repository.Gst.Format`















Fields
------

.. rst-class:: interim-class

.. class:: Format
   :no-index:
   

   .. attribute:: BUFFERS

      Buffers (few, if any, elements implement this as of
      May 2009)







   .. attribute:: BYTES

      Bytes







   .. attribute:: DEFAULT

      The default format of the pad/element. This can be
      samples for raw audio, frames/fields for raw video (some, but not all,
      elements support this; use ``GST_FORMAT_TIME`` if you don't have a good
      reason to query for samples/frames)







   .. attribute:: PERCENT

      Percentage of stream (few, if any, elements implement
      this as of May 2009)







   .. attribute:: TIME

      Time in nanoseconds







   .. attribute:: UNDEFINED

      Undefined format