Base class for timeline data serialization and deserialization.
Class structure
GES Formatter class. Override the vmethods to implement the formatter functionnality.
GES.FormatterClass
GES Formatter class. Override the vmethods to implement the formatter functionnality.
GES.FormatterClass
GES Formatter class. Override the vmethods to implement the formatter functionnality.
GES.Formatter
Base class for timeline data serialization and deserialization.
GES.Formatter
Base class for timeline data serialization and deserialization.
Methods
gboolean
ges_formatter_load_from_uri (GESFormatter * formatter,
GESTimeline * timeline,
const gchar * uri,
GError ** error)
Load data from the given URI into timeline.
Parameters:
uri
–
a gchar * pointing to a URI
error
–
A GError that will be set in case of error
Returns
–
TRUE if the timeline data was successfully loaded from the URI,
else FALSE.
deprecated : 1.18: Use @ges_timeline_load_from_uri
GES.Formatter.prototype.load_from_uri
function GES.Formatter.prototype.load_from_uri(timeline: GES.Timeline, uri: String): {
}
Load data from the given URI into timeline.
TRUE if the timeline data was successfully loaded from the URI,
else FALSE.
deprecated : 1.18: Use @ges_timeline_load_from_uri
GES.Formatter.load_from_uri
@raises(GLib.GError)
def GES.Formatter.load_from_uri (self, timeline, uri):
Load data from the given URI into timeline.
Parameters:
a int * pointing to a URI
TRUE if the timeline data was successfully loaded from the URI,
else FALSE.
deprecated : 1.18: Use @ges_timeline_load_from_uri
gboolean
ges_formatter_save_to_uri (GESFormatter * formatter,
GESTimeline * timeline,
const gchar * uri,
gboolean overwrite,
GError ** error)
Save data from timeline to the given URI.
Parameters:
uri
–
a gchar * pointing to a URI
overwrite
–
TRUE to overwrite file if it exists
error
–
A GError that will be set in case of error
Returns
–
TRUE if the timeline data was successfully saved to the URI
else FALSE.
deprecated : 1.18: Use @ges_timeline_save_to_uri
GES.Formatter.prototype.save_to_uri
function GES.Formatter.prototype.save_to_uri(timeline: GES.Timeline, uri: String, overwrite: Number): {
}
Save data from timeline to the given URI.
Parameters:
true to overwrite file if it exists
TRUE if the timeline data was successfully saved to the URI
else FALSE.
deprecated : 1.18: Use @ges_timeline_save_to_uri
GES.Formatter.save_to_uri
@raises(GLib.GError)
def GES.Formatter.save_to_uri (self, timeline, uri, overwrite):
Save data from timeline to the given URI.
Parameters:
a int * pointing to a URI
True to overwrite file if it exists
TRUE if the timeline data was successfully saved to the URI
else FALSE.
deprecated : 1.18: Use @ges_timeline_save_to_uri
Class Methods
ges_formatter_class_register_metas (GESFormatterClass * klass,
const gchar * name,
const gchar * description,
const gchar * extensions,
const gchar * caps,
gdouble version,
GstRank rank)
Parameters:
klass
–
The class to register metas on
name
–
The name of the formatter
description
–
The formatter description
extensions
–
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
–
The caps the formatter handled, they should match what
gstreamer typefind mechanism will report for the files the formatter
handles.
version
–
The version of the formatter
rank
–
The rank of the formatter
GES.FormatterClass.prototype.register_metas
function GES.FormatterClass.prototype.register_metas(klass: GES.FormatterClass, name: String, description: String, extensions: String, caps: String, version: Number, rank: Gst.Rank): {
}
Parameters:
The class to register metas on
The name of the formatter
The formatter description
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
The caps the formatter handled, they should match what
gstreamer typefind mechanism will report for the files the formatter
handles.
The version of the formatter
The rank of the formatter
Functions
gboolean
ges_formatter_can_load_uri (const gchar * uri,
GError ** error)
Checks if there is a GESFormatter available which can load a GESTimeline
from the given URI.
Parameters:
uri
–
a gchar * pointing to the URI
error
–
A GError that will be set in case of error
Returns
–
TRUE if there is a GESFormatter that can support the given uri
or FALSE if not.
GES.Formatter.prototype.can_load_uri
function GES.Formatter.prototype.can_load_uri(uri: String): {
}
Checks if there is a GES.Formatter available which can load a GES.Timeline
from the given URI.
Parameters:
a String * pointing to the URI
TRUE if there is a GES.Formatter that can support the given uri
or FALSE if not.
GES.Formatter.can_load_uri
@raises(GLib.GError)
def GES.Formatter.can_load_uri (uri):
Checks if there is a GES.Formatter available which can load a GES.Timeline
from the given URI.
Parameters:
a int * pointing to the URI
TRUE if there is a GES.Formatter that can support the given uri
or FALSE if not.
gboolean
ges_formatter_can_save_uri (const gchar * uri,
GError ** error)
Returns TRUE if there is a GESFormatter available which can save a
GESTimeline to the given URI.
Parameters:
uri
–
a gchar * pointing to a URI
error
–
A GError that will be set in case of error
Returns
–
TRUE if the given uri is supported, else FALSE.
GES.Formatter.prototype.can_save_uri
function GES.Formatter.prototype.can_save_uri(uri: String): {
}
Returns TRUE if there is a GES.Formatter available which can save a
GES.Timeline to the given URI.
TRUE if the given uri is supported, else FALSE.
GES.Formatter.can_save_uri
@raises(GLib.GError)
def GES.Formatter.can_save_uri (uri):
Returns TRUE if there is a GES.Formatter available which can save a
GES.Timeline to the given URI.
Parameters:
a int * pointing to a URI
TRUE if the given uri is supported, else FALSE.
GESAsset *
ges_formatter_get_default ()
Get the default GESAsset to use as formatter. It will return
the asset for the GESFormatter that has the highest rank
Returns
(
[transfer: none])
–
The GESAsset for the formatter with highest rank
GES.Formatter.prototype.get_default
function GES.Formatter.prototype.get_default(): {
}
Get the default GES.Asset to use as formatter. It will return
the asset for the GES.Formatter that has the highest rank
The GES.Asset for the formatter with highest rank
GES.Formatter.get_default
def GES.Formatter.get_default ():
Get the default GES.Asset to use as formatter. It will return
the asset for the GES.Formatter that has the highest rank
The GES.Asset for the formatter with highest rank
Virtual Methods
gboolean
can_load_uri (GESFormatter * dummy_instance,
const gchar * uri,
GError ** error)
Whether the URI can be loaded
Parameters:
dummy_instance
–
No description available
uri
–
No description available
error
–
No description available
Returns
–
No description available
vfunc_can_load_uri
function vfunc_can_load_uri(dummy_instance: GES.Formatter, uri: String): {
}
Whether the URI can be loaded
do_can_load_uri
def do_can_load_uri (dummy_instance, uri):
Whether the URI can be loaded
gboolean
load_from_uri (GESFormatter * formatter,
GESTimeline * timeline,
const gchar * uri,
GError ** error)
class method to deserialize data from a URI
Parameters:
formatter
–
No description available
timeline
–
No description available
uri
–
No description available
error
–
No description available
Returns
–
No description available
vfunc_load_from_uri
function vfunc_load_from_uri(formatter: GES.Formatter, timeline: GES.Timeline, uri: String): {
}
class method to deserialize data from a URI
do_load_from_uri
def do_load_from_uri (formatter, timeline, uri):
class method to deserialize data from a URI
gboolean
save_to_uri (GESFormatter * formatter,
GESTimeline * timeline,
const gchar * uri,
gboolean overwrite,
GError ** error)
class method to serialize data to a URI
Parameters:
formatter
–
No description available
timeline
–
No description available
uri
–
No description available
overwrite
–
No description available
error
–
No description available
Returns
–
No description available
vfunc_save_to_uri
function vfunc_save_to_uri(formatter: GES.Formatter, timeline: GES.Timeline, uri: String, overwrite: Number): {
}
class method to serialize data to a URI
do_save_to_uri
def do_save_to_uri (formatter, timeline, uri, overwrite):
class method to serialize data to a URI
Functions
GESAsset *
ges_find_formatter_for_uri (const gchar * uri)
Get the best formatter for uri. It tries to find a formatter
compatible with uri extension, if none is found, it returns the default
formatter asset.
Parameters:
uri
–
No description available
Returns
(
[transfer: none])
–
The GESAsset for the best formatter to save to uri
Since : 1.18
GES.prototype.find_formatter_for_uri
function GES.prototype.find_formatter_for_uri(uri: String): {
}
Get the best formatter for uri. It tries to find a formatter
compatible with uri extension, if none is found, it returns the default
formatter asset.
The GES.Asset for the best formatter to save to uri
Since : 1.18
GES.find_formatter_for_uri
def GES.find_formatter_for_uri (uri):
Get the best formatter for uri. It tries to find a formatter
compatible with uri extension, if none is found, it returns the default
formatter asset.
The GES.Asset for the best formatter to save to uri
Since : 1.18
Constants
#define GES_TYPE_FORMATTER ges_formatter_get_type()
Callbacks
gboolean
(*GESFormatterCanLoadURIMethod) (GESFormatter * dummy_instance,
const gchar * uri,
GError ** error)
Parameters:
dummy_instance
–
No description available
uri
–
No description available
error
–
No description available
Returns
–
No description available
GES.FormatterCanLoadURIMethod
function GES.FormatterCanLoadURIMethod(dummy_instance: GES.Formatter, uri: String): {
}
GES.FormatterCanLoadURIMethod
def GES.FormatterCanLoadURIMethod (dummy_instance, uri):
gboolean
(*GESFormatterLoadFromURIMethod) (GESFormatter * formatter,
GESTimeline * timeline,
const gchar * uri,
GError ** error)
Virtual method for loading a timeline from a given URI.
Every GESFormatter subclass needs to implement this method.
Parameters:
uri
–
the URI to load from
error
–
An error to be set in case something wrong happens or NULL
Returns
–
TRUE if the timeline was properly loaded from the given uri,
else FALSE.
GES.FormatterLoadFromURIMethod
function GES.FormatterLoadFromURIMethod(formatter: GES.Formatter, timeline: GES.Timeline, uri: String): {
}
Virtual method for loading a timeline from a given URI.
Every GES.Formatter subclass needs to implement this method.
TRUE if the timeline was properly loaded from the given uri,
else FALSE.
GES.FormatterLoadFromURIMethod
def GES.FormatterLoadFromURIMethod (formatter, timeline, uri):
Virtual method for loading a timeline from a given URI.
Every GES.Formatter subclass needs to implement this method.
TRUE if the timeline was properly loaded from the given uri,
else FALSE.
gboolean
(*GESFormatterSaveToURIMethod) (GESFormatter * formatter,
GESTimeline * timeline,
const gchar * uri,
gboolean overwrite,
GError ** error)
Virtual method for saving a timeline to a uri.
Every GESFormatter subclass needs to implement this method.
Parameters:
overwrite
–
Whether the file should be overwritten in case it exists
error
–
An error to be set in case something wrong happens or NULL
Returns
–
TRUE if the timeline was properly stored to the given uri,
else FALSE.
GES.FormatterSaveToURIMethod
function GES.FormatterSaveToURIMethod(formatter: GES.Formatter, timeline: GES.Timeline, uri: String, overwrite: Number): {
}
Virtual method for saving a timeline to a uri.
Every GES.Formatter subclass needs to implement this method.
Parameters:
Whether the file should be overwritten in case it exists
TRUE if the timeline was properly stored to the given uri,
else FALSE.
GES.FormatterSaveToURIMethod
def GES.FormatterSaveToURIMethod (formatter, timeline, uri, overwrite):
Virtual method for saving a timeline to a uri.
Every GES.Formatter subclass needs to implement this method.
Parameters:
Whether the file should be overwritten in case it exists
TRUE if the timeline was properly stored to the given uri,
else FALSE.
The results of the search are