Callbacks

	BaseEffectTimeTranslationFunc (effect, time, time_property_values, *user_data)
	CreateTrackElementFunc (clip, type)
	CreateTrackElementsFunc (clip, type)
	ExtractableCheckId (type, id)
	FillTrackElementFunc (clip, track_element, nleobj)
	FormatterCanLoadURIMethod (dummy_instance, uri)
	FormatterLoadFromURIMethod (formatter, timeline, uri)
	FormatterSaveToURIMethod (formatter, timeline, uri, overwrite)
	MetaForeachFunc (container, key, value, *user_data)

Details

GES.BaseEffectTimeTranslationFunc(effect, time, time_property_values, *user_data)

Parameters:

• effect (GES.BaseEffect) – The GES.BaseEffect that is doing the time translation

• time (int) – The #GstClockTime to translation

• time_property_values ({str: GObject.Value}) – A table of child property name/value pairs

• user_data (object or None) – Data passed to GES.BaseEffect.set_time_translation_funcs()

Returns:

The translated time.

Return type:

int

A function for querying how an effect would translate a time if it had the given child property values set. The keys for time_properties will be the same string that was passed to GES.BaseEffect.register_time_property(), the values will be GObject.Value values of the corresponding child properties. You should always use the values given in time_properties before using the currently set values.

New in version 1.18.

GES.CreateTrackElementFunc(clip, type)

Parameters:

• clip (GES.Clip) – A GES.Clip

• type (GES.TrackType) – A GES.TrackType to create a GES.TrackElement for

Returns:

The GES.TrackElement created by clip, or None if clip can not provide a track element for the given type or an error occurred.

Return type:

GES.TrackElement or None

A method for creating the core GES.TrackElement of a clip, to be added to a GES.Track of the given track type.

If a clip may produce several track elements per track type, GES.CreateTrackElementsFunc is more appropriate.

GES.CreateTrackElementsFunc(clip, type)

Parameters:

• clip (GES.Clip) – A GES.Clip

• type (GES.TrackType) – A GES.TrackType to create GES.TrackElement-s for

Returns:

A list of the GES.TrackElement-s created by clip for the given type, or None if no track elements are created or an error occurred.

Return type:

[GES.TrackElement]

A method for creating the core GES.TrackElement-s of a clip, to be added to GES.Track-s of the given track type.

GES.ExtractableCheckId(type, id)

Parameters:

• type (GObject.GType) – The GES.Extractable type to check id for

• id (str) – The ID to check

Return type:

str

Method for checking that an ID is valid for the given GES.Extractable type. If the given ID is considered valid, it can be adjusted into some standard and returned to prevent the creation of separate GES.Asset-s, with different GES.Asset :id, that would otherwise act the same.

Returns (transfer full) (nullable): The actual GES.Asset :id to set on any corresponding assets, based on id, or None if id is not valid.

GES.FillTrackElementFunc(clip, track_element, nleobj)

Parameters:

• clip (GES.Clip) – The GES.Clip controlling the track elements

• track_element (GES.TrackElement) – The GES.TrackElement

• nleobj (Gst.Element) – The nleobject that needs to be filled

Returns:

True if the implementer successfully filled the nleobj.

Return type:

bool

A function that will be called when the nleobject of a corresponding track element needs to be filled.

The implementer of this function shall add the proper Gst.Element to nleobj using Gst.Bin.add().

Deprecated since version 1.18: This method type is no longer used.

GES.FormatterCanLoadURIMethod(dummy_instance, uri)

Parameters:

• dummy_instance (GES.Formatter) –

• uri (str) –

Return type:

bool

GES.FormatterLoadFromURIMethod(formatter, timeline, uri)

Parameters:

• formatter (GES.Formatter) – a GES.Formatter

• timeline (GES.Timeline) – a GES.Timeline

• uri (str) – a str * pointing to a URI

Returns:

True if the timeline data was successfully loaded from the URI, else False.

Return type:

bool

Virtual method for loading a timeline from a given URI.

Every GES.Formatter subclass needs to implement this method.

GES.FormatterSaveToURIMethod(formatter, timeline, uri, overwrite)

Parameters:

• formatter (GES.Formatter) – a GES.Formatter

• timeline (GES.Timeline) – a GES.Timeline

• uri (str) – a str * pointing to a URI

• overwrite (bool) – True to overwrite file if it exists

Returns:

True if the timeline data was successfully saved to the URI else False.

Return type:

bool

Virtual method for saving a timeline to a uri.

Every GES.Formatter subclass needs to implement this method.

GES.MetaForeachFunc(container, key, value, *user_data)

Parameters:

• container (GES.MetaContainer) – A GES.MetaContainer

• key (str) – The key for one of container's fields

• value (GObject.Value) – The set value under key

• user_data (object or None) – User data

A method to be called on all of a meta container’s fields.