GES.Formatter¶

Subclasses:: GES.BaseXmlFormatter, GES.CommandLineFormatter, GES.PitiviFormatter

Methods¶

Inherited:: GObject.Object (37), GES.Extractable (3)
Structs:: GES.FormatterClass (1), GObject.ObjectClass (5)

class	`can_load_uri` (uri)
class	`can_save_uri` (uri)
class	`get_default` ()
class	`register_metas` (name, description, extensions, caps, version, rank)
	`load_from_uri` (timeline, uri)
	`save_to_uri` (timeline, uri, overwrite)

Virtual Methods¶

Inherited:: GObject.Object (7), GES.Extractable (3)

	`do_can_load_uri` (uri)
	`do_load_from_uri` (timeline, uri)
	`do_save_to_uri` (timeline, uri, overwrite)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
parent	`GObject.InitiallyUnowned`	r
project	`GES.Project`	r
timeline	`GES.Timeline`	r

Class Details¶

class GES.Formatter(**kwargs)¶

Bases:: GObject.InitiallyUnowned, GES.Extractable
Abstract:: Yes
Structure:: GES.FormatterClass

Base class for timeline data serialization and deserialization.

classmethod can_load_uri(uri)[source]¶

Parameters:: uri (str) – a str * pointing to the URI
Raises:: GLib.Error
Returns:: True if there is a GES.Formatter that can support the given uri or False if not.
Return type:: bool

Checks if there is a GES.Formatter available which can load a GES.Timeline from the given URI.

classmethod can_save_uri(uri)[source]¶

Parameters:: uri (str) – a str * pointing to a URI
Raises:: GLib.Error
Returns:: True if the given uri is supported, else False.
Return type:: bool

Returns True if there is a GES.Formatter available which can save a GES.Timeline to the given URI.

classmethod get_default()[source]¶

Returns:: The GES.Asset for the formatter with highest rank
Return type:: GES.Asset

Get the default GES.Asset to use as formatter. It will return the asset for the GES.Formatter that has the highest rank

classmethod register_metas(name, description, extensions, caps, version, rank)¶

Parameters:

name (str) – The name of the formatter
description (str) – The formatter description
extensions (str) – A list of coma separated file extensions handled by the formatter. The order of the extensions should match the list of the structures inside caps
caps (str) – The caps the formatter handled, they should match what gstreamer typefind mechanism will report for the files the formatter handles.
version (float) – The version of the formatter
rank (Gst.Rank) – The rank of the formatter

load_from_uri(timeline, uri)[source]¶

Parameters:

timeline (GES.Timeline) – a GES.Timeline
uri (str) – a str * pointing to a URI

Raises:

GLib.Error

Returns:

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

Return type:

bool

Load data from the given URI into timeline.

Deprecated since version 1.18: Use ges_timeline_load_from_uri

save_to_uri(timeline, uri, overwrite)[source]¶

Parameters:

timeline (GES.Timeline) – a GES.Timeline
uri (str) – a str * pointing to a URI
overwrite (bool) – True to overwrite file if it exists

Raises:

GLib.Error

Returns:

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

Return type:

bool

Save data from timeline to the given URI.

Deprecated since version 1.18: Use ges_timeline_save_to_uri

do_can_load_uri(uri) virtual¶

Parameters:: uri (str) –
Return type:: bool

Whether the URI can be loaded

do_load_from_uri(timeline, uri) virtual¶

Parameters:

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

Load data from the given URI into timeline.

Deprecated since version 1.18: Use ges_timeline_load_from_uri

do_save_to_uri(timeline, uri, overwrite) virtual¶

Parameters:

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

Save data from timeline to the given URI.

Deprecated since version 1.18: Use ges_timeline_save_to_uri