:right-sidebar: True

NetClientClock
===================================================================

.. currentmodule:: gi.repository.GstNet





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


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


Subclasses: :class:`~gi.repository.GstNet.NtpClock`




:obj:`~gi.repository.GstNet.NetClientClock` implements a custom :obj:`~gi.repository.Gst.Clock` that synchronizes its time
to a remote time provider such as :obj:`~gi.repository.GstNet.NetTimeProvider`\. ``GstNtpClock``
implements a :obj:`~gi.repository.Gst.Clock` that synchronizes its time to a remote NTPv4 server.

A new clock is created with :func:`~gi.repository.GstNet.NetClientClock.new` or
:func:`~gi.repository.GstNet.NtpClock.new`, which takes the address and port of the remote time
provider along with a name and an initial time.

This clock will poll the time provider and will update its calibration
parameters based on the local and remote observations.

The "round-trip" property limits the maximum round trip packets can take.

Various parameters of the clock can be configured with the parent :obj:`~gi.repository.Gst.Clock`
"timeout", "window-size" and "window-threshold" object properties.

A :obj:`~gi.repository.GstNet.NetClientClock` and ``GstNtpClock`` is typically set on a :obj:`~gi.repository.Gst.Pipeline` with
:func:`~gi.repository.Gst.Pipeline.use_clock`.

If you set a :obj:`~gi.repository.Gst.Bus` on the clock via the "bus" object property, it will
send ``GST_MESSAGE_ELEMENT`` messages with an attached :obj:`~gi.repository.Gst.Structure` containing
statistics about clock accuracy and network traffic.


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

.. rst-class:: interim-class

.. class:: NetClientClock
   :no-index:


   .. classmethod:: new(name: str | None, remote_address: str, remote_port: int, base_time: int) -> ~gi.repository.Gst.Clock

      Create a new :obj:`~gi.repository.GstNet.NetClientClock` that will report the time
      provided by the :obj:`~gi.repository.GstNet.NetTimeProvider` on ``remote_address`` and
      ``remote_port``\.






      :param name: a name for the clock

      :param remote_address: the address or hostname of the remote clock provider

      :param remote_port: the port of the remote clock provider

      :param base_time: initial time of the clock










Properties
----------

.. rst-class:: interim-class

.. class:: NetClientClock
   :no-index:
   

   .. attribute:: props.address
      :type: str

      The type of the None singleton.







   .. attribute:: props.base_time
      :type: int

      The type of the None singleton.







   .. attribute:: props.bus
      :type: ~gi.repository.Gst.Bus

      The type of the None singleton.







   .. attribute:: props.internal_clock
      :type: ~gi.repository.Gst.Clock

      The type of the None singleton.







   .. attribute:: props.minimum_update_interval
      :type: int

      The type of the None singleton.







   .. attribute:: props.port
      :type: int

      The type of the None singleton.







   .. attribute:: props.qos_dscp
      :type: int

      The type of the None singleton.







   .. attribute:: props.round_trip_limit
      :type: int

      The type of the None singleton.















Fields
------

.. rst-class:: interim-class

.. class:: NetClientClock
   :no-index:
   

   .. attribute:: clock

      






   .. attribute:: priv