GES.EffectClass

Fields

Name	Type	Access	Description
parent_class	GES.BaseEffectClass	r	parent class
rate_properties	[object]	r

Methods

register_rate_property (element_name, property_name)

Details

class GES.EffectClass

register_rate_property(element_name, property_name)

Parameters:

• element_name (str) – The Gst.ElementFactory name of the element that changes the rate

• property_name (str) – The name of the property that changes the rate

Returns:

True if the rate property was successfully registered. When this method returns False, a warning is emitted with more information.

Return type:

bool

Register an element that can change the rate at which media is playing. The property type must be float or double, and must be a factor of the rate, i.e. a value of 2.0 must mean that the media plays twice as fast. Several properties may be registered for a single element type, provided they all contribute to the rate as independent factors. For example, this is true for the “GstPitch::rate” and “GstPitch::tempo” properties. These are already registered by default in GES, along with #videorate:rate for #videorate and #scaletempo:rate for #scaletempo.

If such a rate property becomes a child property of a GES.Effect upon its creation (the element is part of its GES.Effect :bin-description), it will be automatically registered as a time property (see GES.BaseEffect.register_time_property()) and will have its time translation functions set (see GES.BaseEffect.set_time_translation_funcs()) to use the overall rate of the rate properties. Note that if an effect contains a rate property as well as a non-rate time property, you should ensure to set the time translation functions to some other methods using GES.BaseEffect.set_time_translation_funcs().

Note, you can obtain a reference to the GES.EffectClass using

``

GES_EFFECT_CLASS (g_type_class_ref (GES_TYPE_EFFECT));

``