GESFormatter

GESFormatter

GObject
    ╰──GInitiallyUnowned
        ╰──GESFormatter
            ╰──GESBaseXmlFormatter
            ╰──GESCommandLineFormatter
            ╰──GESPitiviFormatter

Implemented interfaces: GESExtractable

Base class for timeline data serialization and deserialization.

Members

parent (GInitiallyUnowned) –
No description available

Class structure

GESFormatterClass

Fields
parent_class (GInitiallyUnownedClass) –
No description available
can_load_uri (GESFormatterCanLoadURIMethod) –
No description available
load_from_uri (GESFormatterLoadFromURIMethod) –
No description available
save_to_uri (GESFormatterSaveToURIMethod) –
No description available

GES.FormatterClass

Attributes
FormatterClass.parent_class (GObject.InitiallyUnownedClass) –
No description available
FormatterClass.can_load_uri (GES.FormatterCanLoadURIMethod) –
No description available
FormatterClass.load_from_uri (GES.FormatterLoadFromURIMethod) –
No description available
FormatterClass.save_to_uri (GES.FormatterSaveToURIMethod) –
No description available

GES.FormatterClass

GES.FormatterClass

Attributes
FormatterClass.parent_class (GObject.InitiallyUnownedClass) –
No description available
FormatterClass.can_load_uri (GES.FormatterCanLoadURIMethod) –
No description available
FormatterClass.load_from_uri (GES.FormatterLoadFromURIMethod) –
No description available
FormatterClass.save_to_uri (GES.FormatterSaveToURIMethod) –
No description available

GESFormatter

GObject
    ╰──GInitiallyUnowned
        ╰──GESFormatter
            ╰──GESBaseXmlFormatter
            ╰──GESCommandLineFormatter
            ╰──GESPitiviFormatter

Implemented interfaces: GESExtractable

Base class for timeline data serialization and deserialization.

Members

parent (GInitiallyUnowned) –
No description available

GESFormatter

GObject
    ╰──GInitiallyUnowned
        ╰──GESFormatter
            ╰──GESBaseXmlFormatter
            ╰──GESCommandLineFormatter
            ╰──GESPitiviFormatter

Implemented interfaces: GESExtractable

Base class for timeline data serialization and deserialization.

GESFormatter

GObject
    ╰──GInitiallyUnowned
        ╰──GESFormatter
            ╰──GESBaseXmlFormatter
            ╰──GESCommandLineFormatter
            ╰──GESPitiviFormatter

Implemented interfaces: GESExtractable

Base class for timeline data serialization and deserialization.

Members

parent (GInitiallyUnowned) –
No description available

Methods

ges_formatter_load_from_uri

gboolean
ges_formatter_load_from_uri (GESFormatter * formatter,
                             GESTimeline * timeline,
                             const gchar * uri)

Load data from the given URI into timeline.

Parameters:

formatter

a GESFormatter

timeline

a GESTimeline

uri

a gchar * pointing to a URI

Returns

TRUE if the timeline data was successfully loaded from the URI, else FALSE.

GES.Formatter.load_from_uri

@raises(GLib.GError)
def GES.Formatter.load_from_uri (self, timeline, uri):
    #python wrapper for 'ges_formatter_load_from_uri'

Load data from the given URI into timeline.

Parameters:

formatter ( GES.Formatter ) –

a GES.Formatter

timeline ( GES.Timeline ) –

a GES.Timeline

uri ( str ) –

a int * pointing to a URI

Returns ( bool ) –

TRUE if the timeline data was successfully loaded from the URI, else FALSE.

GES.Formatter.LoadFromUri

bool
GES.Formatter.LoadFromUri (GES.Timeline,
                           string)

Load data from the given URI into timeline.

Parameters:

timeline

a GES.Timeline

uri

a char * pointing to a URI

Returns

TRUE if the timeline data was successfully loaded from the URI, else FALSE.

GES.prototype.load_from_uri

function GES.prototype.load_from_uri(timeline: GES.Timeline, uri: String): {
    // javascript wrapper for 'ges_formatter_load_from_uri'
}

Load data from the given URI into timeline.

Parameters:

formatter ( GES.Formatter ) –

a GES.Formatter

timeline ( GES.Timeline ) –

a GES.Timeline

uri ( String ) –

a String * pointing to a URI

Returns ( Number ) –

TRUE if the timeline data was successfully loaded from the URI, else FALSE.

ges_formatter_save_to_uri

gboolean
ges_formatter_save_to_uri (GESFormatter * formatter,
                           GESTimeline * timeline,
                           const gchar * uri,
                           gboolean overwrite)

Save data from timeline to the given URI.

Parameters:

formatter

a GESFormatter

timeline

a GESTimeline

uri

a gchar * pointing to a URI

overwrite

TRUE to overwrite file if it exists

Returns

TRUE if the timeline data was successfully saved to the URI else FALSE.

GES.Formatter.save_to_uri

@raises(GLib.GError)
def GES.Formatter.save_to_uri (self, timeline, uri, overwrite):
    #python wrapper for 'ges_formatter_save_to_uri'

Save data from timeline to the given URI.

Parameters:

formatter ( GES.Formatter ) –

a GES.Formatter

timeline ( GES.Timeline ) –

a GES.Timeline

uri ( str ) –

a int * pointing to a URI

overwrite ( bool ) –

True to overwrite file if it exists

Returns ( bool ) –

TRUE if the timeline data was successfully saved to the URI else FALSE.

GES.Formatter.SaveToUri

bool
GES.Formatter.SaveToUri (GES.Timeline,
                         string,
                         bool)

Save data from timeline to the given URI.

Parameters:

timeline

a GES.Timeline

uri

a char * pointing to a URI

overwrite

true to overwrite file if it exists

Returns

TRUE if the timeline data was successfully saved to the URI else FALSE.

GES.prototype.save_to_uri

function GES.prototype.save_to_uri(timeline: GES.Timeline, uri: String, overwrite: Number): {
    // javascript wrapper for 'ges_formatter_save_to_uri'
}

Save data from timeline to the given URI.

Parameters:

formatter ( GES.Formatter ) –

a GES.Formatter

timeline ( GES.Timeline ) –

a GES.Timeline

uri ( String ) –

a String * pointing to a URI

overwrite ( Number ) –

true to overwrite file if it exists

Returns ( Number ) –

TRUE if the timeline data was successfully saved to the URI else FALSE.

Virtual Methods

can_load_uri

gboolean
can_load_uri (GESFormatter * dummy_instance,
              const gchar * uri)

Whether the URI can be loaded

Parameters:

dummy_instance
No description available
uri
No description available
Returns
No description available

can_load_uri

def can_load_uri (dummy_instance, uri):
    #python implementation of the 'can_load_uri' virtual method

Whether the URI can be loaded

Parameters:

dummy_instance ( GES.Formatter ) –
No description available
uri ( str ) –
No description available
Returns ( bool ) –
No description available

CanLoadUri

bool
CanLoadUri (string)

Whether the URI can be loaded

Parameters:

uri
No description available
Returns
No description available

can_load_uri

function can_load_uri(dummy_instance: GES.Formatter, uri: String): {
    // javascript implementation of the 'can_load_uri' virtual method
}

Whether the URI can be loaded

Parameters:

dummy_instance ( GES.Formatter ) –
No description available
uri ( String ) –
No description available
Returns ( Number ) –
No description available

load_from_uri

gboolean
load_from_uri (GESFormatter * formatter,
               GESTimeline * timeline,
               const gchar * uri)

class method to deserialize data from a URI

Parameters:

formatter
No description available
timeline
No description available
uri
No description available
Returns
No description available

load_from_uri

def load_from_uri (formatter, timeline, uri):
    #python implementation of the 'load_from_uri' virtual method

class method to deserialize data from a URI

Parameters:

formatter ( GES.Formatter ) –
No description available
timeline ( GES.Timeline ) –
No description available
uri ( str ) –
No description available
Returns ( bool ) –
No description available

LoadFromUri

bool
LoadFromUri (GES.Timeline,
             string)

class method to deserialize data from a URI

Parameters:

timeline
No description available
uri
No description available
Returns
No description available

load_from_uri

function load_from_uri(formatter: GES.Formatter, timeline: GES.Timeline, uri: String): {
    // javascript implementation of the 'load_from_uri' virtual method
}

class method to deserialize data from a URI

Parameters:

formatter ( GES.Formatter ) –
No description available
timeline ( GES.Timeline ) –
No description available
uri ( String ) –
No description available
Returns ( Number ) –
No description available

save_to_uri

gboolean
save_to_uri (GESFormatter * formatter,
             GESTimeline * timeline,
             const gchar * uri,
             gboolean overwrite)

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
Returns
No description available

save_to_uri

def save_to_uri (formatter, timeline, uri, overwrite):
    #python implementation of the 'save_to_uri' virtual method

class method to serialize data to a URI

Parameters:

formatter ( GES.Formatter ) –
No description available
timeline ( GES.Timeline ) –
No description available
uri ( str ) –
No description available
overwrite ( bool ) –
No description available
Returns ( bool ) –
No description available

SaveToUri

bool
SaveToUri (GES.Timeline,
           string,
           bool)

class method to serialize data to a URI

Parameters:

timeline
No description available
uri
No description available
overwrite
No description available
Returns
No description available

save_to_uri

function save_to_uri(formatter: GES.Formatter, timeline: GES.Timeline, uri: String, overwrite: Number): {
    // javascript implementation of the 'save_to_uri' virtual method
}

class method to serialize data to a URI

Parameters:

formatter ( GES.Formatter ) –
No description available
timeline ( GES.Timeline ) –
No description available
uri ( String ) –
No description available
overwrite ( Number ) –
No description available
Returns ( Number ) –
No description available

Properties

ParentClass

GObject.InitiallyUnownedClass ParentClass { get; set;  }

Flags : Read / Write

CanLoadUri

GES.FormatterCanLoadURIMethod CanLoadUri { get; set;  }

Flags : Read / Write

LoadFromUri

GES.FormatterLoadFromURIMethod LoadFromUri { get; set;  }

Flags : Read / Write

SaveToUri

GES.FormatterSaveToURIMethod SaveToUri { get; set;  }

Flags : Read / Write

Class Methods

ges_formatter_class_register_metas

ges_formatter_class_register_metas (GESFormatterClass * klass,
                                    const gchar * name,
                                    const gchar * description,
                                    const gchar * extension,
                                    const gchar * mimetype,
                                    gdouble version,
                                    GstRank rank)

Parameters:

klass
No description available
name
No description available
description
No description available
extension
No description available
mimetype
No description available
version
No description available
rank
No description available

GES.Formatter.RegisterMetas

GES.Formatter.RegisterMetas (string,
                             string,
                             string,
                             string,
                             double,
                             Gst.Rank)

Parameters:

name
No description available
description
No description available
extension
No description available
mimetype
No description available
version
No description available
rank
No description available

GES.prototype.register_metas

function GES.prototype.register_metas(klass: GES.FormatterClass, name: String, description: String, extension: String, mimetype: String, version: Number, rank: Gst.Rank): {
    // javascript wrapper for 'ges_formatter_class_register_metas'
}

Parameters:

klass ( GES.FormatterClass ) –
No description available
name ( String ) –
No description available
description ( String ) –
No description available
extension ( String ) –
No description available
mimetype ( String ) –
No description available
version ( Number ) –
No description available
rank ( Gst.Rank ) –
No description available

Functions

ges_formatter_can_load_uri

gboolean
ges_formatter_can_load_uri (const gchar * uri)

Checks if there is a GESFormatter available which can load a GESTimeline from the given URI.

Parameters:

uri

a gchar * pointing to the URI

Returns

TRUE if there is a GESFormatter 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):
    #python wrapper for 'ges_formatter_can_load_uri'

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

Parameters:

uri ( str ) –

a int * pointing to the URI

Returns ( bool ) –

TRUE if there is a GES.Formatter that can support the given uri or FALSE if not.

GES.Formatter.CanLoadUri

bool
GES.Formatter.CanLoadUri (string)

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

Parameters:

uri

a char * pointing to the URI

Returns

TRUE if there is a GES.Formatter that can support the given uri or FALSE if not.

GES.prototype.can_load_uri

function GES.prototype.can_load_uri(uri: String): {
    // javascript wrapper for 'ges_formatter_can_load_uri'
}

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

Parameters:

uri ( String ) –

a String * pointing to the URI

Returns ( Number ) –

TRUE if there is a GES.Formatter that can support the given uri or FALSE if not.

ges_formatter_can_save_uri

gboolean
ges_formatter_can_save_uri (const gchar * uri)

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

Returns

TRUE if the given uri is supported, else FALSE.

GES.Formatter.can_save_uri

@raises(GLib.GError)
def GES.Formatter.can_save_uri (uri):
    #python wrapper for 'ges_formatter_can_save_uri'

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

Parameters:

uri ( str ) –

a int * pointing to a URI

Returns ( bool ) –

TRUE if the given uri is supported, else FALSE.

GES.Formatter.CanSaveUri

bool
GES.Formatter.CanSaveUri (string)

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

Parameters:

uri

a char * pointing to a URI

Returns

TRUE if the given uri is supported, else FALSE.

GES.prototype.can_save_uri

function GES.prototype.can_save_uri(uri: String): {
    // javascript wrapper for 'ges_formatter_can_save_uri'
}

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

Parameters:

uri ( String ) –

a String * pointing to a URI

Returns ( Number ) –

TRUE if the given uri is supported, else FALSE.

ges_formatter_get_default

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.get_default

def GES.Formatter.get_default ():
    #python wrapper for '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

Returns ( GES.Asset ) –

The GES.Asset for the formatter with highest rank

GES.Formatter.GetDefault

GES.Asset
GES.Formatter.GetDefault ()

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

Returns

The GES.Asset for the formatter with highest rank

GES.prototype.get_default

function GES.prototype.get_default(): {
    // javascript wrapper for '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

Returns ( GES.Asset ) –

The GES.Asset for the formatter with highest rank

Constants

GES_TYPE_FORMATTER

#define GES_TYPE_FORMATTER ges_formatter_get_type()

Callbacks

GESFormatterLoadFromURIMethod

gboolean
(*GESFormatterLoadFromURIMethod) (GESFormatter * formatter,
                                  GESTimeline * timeline,
                                  const gchar * uri)

Virtual method for loading a timeline from a given URI.

Every GESFormatter subclass needs to implement this method.

Parameters:

formatter

a GESFormatter

timeline

a GESTimeline

uri

the URI to load from

Returns

TRUE if the timeline was properly loaded from the given uri, else FALSE.

GES.FormatterLoadFromURIMethod

bool
(*GES.FormatterLoadFromURIMethod) (GES.Formatter,
                                   GES.Timeline,
                                   str)

Virtual method for loading a timeline from a given URI.

Every GES.Formatter subclass needs to implement this method.

Parameters:

formatter ( GES.Formatter ) –

a GES.Formatter

timeline ( GES.Timeline ) –

a GES.Timeline

uri ( str ) –

the URI to load from

Returns ( bool ) –

TRUE if the timeline was properly loaded from the given uri, else FALSE.

GES.FormatterLoadFromURIMethod

bool
(*GES.FormatterLoadFromURIMethod) (GES.Formatter,
                                   GES.Timeline,
                                   string)

Virtual method for loading a timeline from a given URI.

Every GES.Formatter subclass needs to implement this method.

Parameters:

formatter

a GES.Formatter

timeline

a GES.Timeline

uri

the URI to load from

Returns

TRUE if the timeline was properly loaded from the given uri, else FALSE.

GES.FormatterLoadFromURIMethod

Number
(*GES.FormatterLoadFromURIMethod) (GES.Formatter,
                                   GES.Timeline,
                                   String)

Virtual method for loading a timeline from a given URI.

Every GES.Formatter subclass needs to implement this method.

Parameters:

formatter ( GES.Formatter ) –

a GES.Formatter

timeline ( GES.Timeline ) –

a GES.Timeline

uri ( String ) –

the URI to load from

Returns ( Number ) –

TRUE if the timeline was properly loaded from the given uri, else FALSE.

GESFormatterSaveToURIMethod

gboolean
(*GESFormatterSaveToURIMethod) (GESFormatter * formatter,
                                GESTimeline * timeline,
                                const gchar * uri,
                                gboolean overwrite)

Virtual method for saving a timeline to a uri.

Every GESFormatter subclass needs to implement this method.

Parameters:

formatter

a GESFormatter

timeline

a GESTimeline

uri

the URI to save to

overwrite

Whether the file should be overwritten in case it exists

Returns

TRUE if the timeline was properly stored to the given uri, else FALSE.

GES.FormatterSaveToURIMethod

bool
(*GES.FormatterSaveToURIMethod) (GES.Formatter,
                                 GES.Timeline,
                                 str,
                                 bool)

Virtual method for saving a timeline to a uri.

Every GES.Formatter subclass needs to implement this method.

Parameters:

formatter ( GES.Formatter ) –

a GES.Formatter

timeline ( GES.Timeline ) –

a GES.Timeline

uri ( str ) –

the URI to save to

overwrite ( bool ) –

Whether the file should be overwritten in case it exists

Returns ( bool ) –

TRUE if the timeline was properly stored to the given uri, else FALSE.

GES.FormatterSaveToURIMethod

bool
(*GES.FormatterSaveToURIMethod) (GES.Formatter,
                                 GES.Timeline,
                                 string,
                                 bool)

Virtual method for saving a timeline to a uri.

Every GES.Formatter subclass needs to implement this method.

Parameters:

formatter

a GES.Formatter

timeline

a GES.Timeline

uri

the URI to save to

overwrite

Whether the file should be overwritten in case it exists

Returns

TRUE if the timeline was properly stored to the given uri, else FALSE.

GES.FormatterSaveToURIMethod

Number
(*GES.FormatterSaveToURIMethod) (GES.Formatter,
                                 GES.Timeline,
                                 String,
                                 Number)

Virtual method for saving a timeline to a uri.

Every GES.Formatter subclass needs to implement this method.

Parameters:

formatter ( GES.Formatter ) –

a GES.Formatter

timeline ( GES.Timeline ) –

a GES.Timeline

uri ( String ) –

the URI to save to

overwrite ( Number ) –

Whether the file should be overwritten in case it exists

Returns ( Number ) –

TRUE if the timeline was properly stored to the given uri, else FALSE.

The results of the search are