:right-sidebar: True

ControlBinding
===================================================================

.. currentmodule:: gi.repository.Gst





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


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





A base class for value mapping objects that attaches control sources to :obj:`~gi.repository.GObject.Object`
properties. Such an object is taking one or more :obj:`~gi.repository.Gst.ControlSource` instances,
combines them and maps the resulting value to the type and value range of the
bound property.




Methods
-------

.. rst-class:: interim-class

.. class:: ControlBinding
   :no-index:


   .. method:: do_get_g_value_array(self, timestamp: int, interval: int, values: list[~gi.repository.GObject.Value]) -> bool

      






      :param timestamp: 

      :param interval: 

      :param values: 




   .. method:: do_get_value(self, timestamp: int) -> ~gi.repository.GObject.Value | None

      






      :param timestamp: 




   .. method:: do_sync_values(self, object: ~gi.repository.Gst.Object, timestamp: int, last_sync: int) -> bool

      






      :param object: 

      :param timestamp: 

      :param last_sync: 




   .. method:: get_g_value_array(timestamp: int, interval: int, values: list[~gi.repository.GObject.Value]) -> bool

      Gets a number of :obj:`~gi.repository.GObject.Value` for the given controlled property starting at the
      requested time. The array ``values`` need to hold enough space for ``n_values`` of
      :obj:`~gi.repository.GObject.Value`\.

      This function is useful if one wants to e.g. draw a graph of the control
      curve or apply a control curve sample by sample.






      :param timestamp: the time that should be processed

      :param interval: the time spacing between subsequent values

      :param values: array to put control-values in




   .. method:: get_value(timestamp: int) -> ~gi.repository.GObject.Value | None

      Gets the value for the given controlled property at the requested time.






      :param timestamp: the time the control-change should be read from




   .. method:: is_disabled() -> bool

      Checks if the control binding is disabled.









   .. method:: set_disabled(disabled: bool) -> None

      This function is used to disable a control binding for some time, i.e.
      :func:`~gi.repository.Gst.Object.sync_values` will do nothing.






      :param disabled: boolean that specifies whether to disable the controller
         or not.




   .. method:: sync_values(object: ~gi.repository.Gst.Object, timestamp: int, last_sync: int) -> bool

      Sets the property of the ``object``\, according to the :obj:`~gi.repository.Gst.ControlSource` that
      handles it and for the given timestamp.

      If this function fails, it is most likely the application developers fault.
      Most probably the control sources are not setup correctly.






      :param object: the object that has controlled properties

      :param timestamp: the time that should be processed

      :param last_sync: the last time this was called








Properties
----------

.. rst-class:: interim-class

.. class:: ControlBinding
   :no-index:
   

   .. attribute:: props.name
      :type: str

      






   .. attribute:: props.object
      :type: ~gi.repository.Gst.Object

      












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

.. rst-class:: interim-class

.. class:: ControlBinding
   :no-index:
   

   .. method:: do_get_g_value_array(timestamp: int, interval: int, values: list[~gi.repository.GObject.Value]) -> bool

      Gets a number of :obj:`~gi.repository.GObject.Value` for the given controlled property starting at the
      requested time. The array ``values`` need to hold enough space for ``n_values`` of
      :obj:`~gi.repository.GObject.Value`\.

      This function is useful if one wants to e.g. draw a graph of the control
      curve or apply a control curve sample by sample.






      :param timestamp: the time that should be processed

      :param interval: the time spacing between subsequent values

      :param values: array to put control-values in




   .. method:: do_get_value(timestamp: int) -> ~gi.repository.GObject.Value | None

      Gets the value for the given controlled property at the requested time.






      :param timestamp: the time the control-change should be read from




   .. method:: do_sync_values(object: ~gi.repository.Gst.Object, timestamp: int, last_sync: int) -> bool

      Sets the property of the ``object``\, according to the :obj:`~gi.repository.Gst.ControlSource` that
      handles it and for the given timestamp.

      If this function fails, it is most likely the application developers fault.
      Most probably the control sources are not setup correctly.






      :param object: the object that has controlled properties

      :param timestamp: the time that should be processed

      :param last_sync: the last time this was called








Fields
------

.. rst-class:: interim-class

.. class:: ControlBinding
   :no-index:
   

   .. attribute:: disabled

      






   .. attribute:: name

      Name of the property of this binding






   .. attribute:: object

      






   .. attribute:: parent

      The parent structure






   .. attribute:: pspec

      :obj:`~gi.repository.GObject.ParamSpec` for this property