:right-sidebar: True

ReferenceTimestampMeta
===================================================================

.. currentmodule:: gi.repository.Gst


.. versionadded:: 1.14




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






:obj:`~gi.repository.Gst.ReferenceTimestampMeta` can be used to attach alternative timestamps and
possibly durations to a :obj:`~gi.repository.Gst.Buffer`\. These are generally not according to
the pipeline clock and could be e.g. the NTP timestamp when the media was
captured.

The reference is stored as a :obj:`~gi.repository.Gst.Caps` in ``reference``\. Examples of valid
references would be

- ``timestamp/x-drivername-stream``\: for timestamps that are locally
   generated by some driver named ``drivername`` when generating the stream,
   e.g. based on a frame counter
- ``timestamp/x-ntp, host=pool.ntp.org, port=123``\: for timestamps based on a
   specific NTP server. Note that the host/port parameters might not always
   be given.
- ``timestamp/x-ptp, version=IEEE1588-2008, domain=1``\: for timestamps based
   on a given PTP clock.
- ``timestamp/x-unix``\: for timestamps based on the UNIX epoch according to
   the local clock.


Since 1.24 it can be serialized using :func:`~gi.repository.Gst.Meta.serialize` and
:func:`~gi.repository.Gst.Meta.deserialize`.




Methods
-------

.. rst-class:: interim-class

.. class:: ReferenceTimestampMeta
   :no-index:


   .. classmethod:: get_info() -> ~gi.repository.Gst.MetaInfo

      Gets the global :obj:`~gi.repository.Gst.MetaInfo` describing the :obj:`~gi.repository.Gst.ReferenceTimestampMeta` meta.


      .. versionadded:: 1.14


















Fields
------

.. rst-class:: interim-class

.. class:: ReferenceTimestampMeta
   :no-index:
   

   .. attribute:: duration

      Duration, or :const:`~gi.repository.Gst.CLOCK_TIME_NONE`






   .. attribute:: parent

      The parent :obj:`~gi.repository.Gst.Meta` structure






   .. attribute:: reference

      Identifier for the timestamp reference.






   .. attribute:: timestamp

      Timestamp