Class: Gst::ControlBinding

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Overview

The class structure of Gst::ControlBinding.

Instance Method Summary collapse

Methods inherited from Object

#add_control_binding, check_uniqueness, #control_bindings_disabled=, #control_rate, #control_rate=, default_deep_notify, #default_error, #get_control_binding, #has_active_control_bindings, #has_ancestor, #has_as_ancestor, #has_as_parent, #parent, #parent=, #path_string, #ref, ref_sink, #remove_control_binding, replace, #set_control_binding_disabled, #suggest_next_sync, #unparent, #unref

Instance Method Details

#disabled=(disabled) ⇒ nil

This function is used to disable a control binding for some time, i.e. gst_object_sync_values() will do nothing. or not.

Parameters:

  • disabled (Boolean) —

    boolean that specifies whether to disable the controller

Returns:

  • (nil)

#get_g_value_array(timestamp, interval, n_values, values) ⇒ Boolean

Gets a number of #GValues for the given controlled property starting at the requested time. The array values need to hold enough space for n_values of #GValue.

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.

Parameters:

  • timestamp (Gst::ClockTime) —

    the time that should be processed

  • interval (Gst::ClockTime) —

    the time spacing between subsequent values

  • n_values (Integer) —

    the number of values

  • values (Array<GObject::Value>) —

    array to put control-values in

Returns:

  • (Boolean) —

    true if the given array could be filled, false otherwise

#get_value(timestamp) ⇒ GObject::Value

Gets the value for the given controlled property at the requested time. or nil if the property isn't controlled.

Parameters:

  • timestamp (Gst::ClockTime) —

    the time the control-change should be read from

Returns:

  • (GObject::Value) —

    the GValue of the property at the given time,

#get_value_array(timestamp, interval, n_values, values) ⇒ Boolean

Gets a number of values for the given controlled property starting at the requested time. The array values needs to hold enough space for n_values of the same type as the objects property's type.

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.

The values are unboxed and ready to be used. The similar function gst_control_binding_get_g_value_array() returns the array as #GValues and is more suitable for bindings.

Parameters:

  • timestamp (Gst::ClockTime) —

    the time that should be processed

  • interval (Gst::ClockTime) —

    the time spacing between subsequent values

  • n_values (Integer) —

    the number of values

  • values (Array<GObject>) —

    array to put control-values in

Returns:

  • (Boolean) —

    true if the given array could be filled, false otherwise

#is_disabled ⇒ Boolean

Checks if the control binding is disabled.

Returns:

  • (Boolean) —

    true if the binding is inactive

#name ⇒ String

Returns name.

Returns:

  • (String) —

    name

#name=(name) ⇒ String

Parameters:

  • name (String)

Returns:

  • (String) —

    name

  • (String) —

    name

#object ⇒ Gst::Object

Returns object.

Returns:

#object=(object) ⇒ Gst::Object

Parameters:

Returns:

#sync_values(object, timestamp, last_sync) ⇒ Boolean

Sets the property of the object, according to the Gst::ControlSources 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. property, false otherwise

Parameters:

  • object (Gst::Object) —

    the object that has controlled properties

  • timestamp (Gst::ClockTime) —

    the time that should be processed

  • last_sync (Gst::ClockTime) —

    the last time this was called

Returns:

  • (Boolean) —

    true if the controller value could be applied to the object