GES-0.10 Python API Documentation

Class: GES.CustomTimelineSource

Subclass of: GES.TimelineSource

Debugging custom timeline source

Abstract Class: GES.Formatter

Known subclasses: GES.KeyfileFormatter

Base class for timeline data serialization and deserialization.

Methods

boolcan_load_uri(uri)(static method)

boolcan_save_uri(uri)(static method)

voidclear_data()

boolload(timeline)

boolload_from_uri(timeline, uri)

boolsave(timeline)

boolsave_to_uri(timeline, uri)

voidset_data(data, length)

Class: GES.KeyfileFormatter

Subclass of: GES.Formatter

Serializes a #GESTimeline to a file using #GKeyFile

Class: GES.SimpleTimelineLayer

Subclass of: GES.TimelineLayer

Properties

bool"valid"read-only

FALSE when the arrangement of objects in the layer would cause errors or unexpected output during playback. Do not set the containing pipeline state to PLAYING when this property is FALSE.

Signals

void"object-moved"(self, simple_timeline_layer, object, old, new)

Will be emitted when an object is moved with #ges_simple_timeline_layer_move_object.

Methods

booladd_object(object, position)

intindex(object)

boolis_valid()

boolmove_object(object, newposition)

GES.TimelineObjectnth(position)

Class: GES.Timeline

Implements: Gst.ChildProxy

Subclass of: Gst.Bin

Signals

void"layer-removed"(self, timeline, layer)

Will be emitted after the layer was removed from the timeline.

void"track-removed"(self, timeline, track)

Will be emitted after the track was removed from the timeline.

void"layer-added"(self, timeline, layer)

Will be emitted after the layer was added to the timeline.

void"track-added"(self, timeline, track)

Will be emitted after the track was added to the timeline.

Methods

booladd_layer(layer)

booladd_track(track)

GLib.Listget_layers()

GES.Trackget_track_for_pad(pad)

GLib.Listget_tracks()

boolload_from_uri(uri)

boolremove_layer(layer)

boolremove_track(track)

boolsave_to_uri(uri)

voidlayer_added(layer)

voidlayer_removed(layer)

voidtrack_added(track)

voidtrack_removed(track)

Class: GES.TimelineFileSource

Subclass of: GES.TimelineSource

Properties

GES.TrackType"supported-formats"construct-only

Whether the sound will be played or not.

bool"mute"construct-only

Whether the sound will be played or not.

bool"is-image"construct-only

Whether this filesource represents a still image or not. This must be set before create_track_objects is called.

string"uri"construct-only

The location of the file/resource to use.

int"max-duration"construct-only

The maximum duration (in nanoseconds) of the file. If not set before adding the object to a layer, it will be discovered asynchronously. Connect to 'notify::max-duration' to be notified of it.

Methods

intget_max_duration()

GES.TrackTypeget_supported_formats()

stringget_uri()

boolis_image()

boolis_muted()

voidset_is_image(is_image)

voidset_max_duration(maxduration)

voidset_mute(mute)

voidset_supported_formats(supportedformats)

Class: GES.TimelineLayer

Known subclasses: GES.SimpleTimelineLayer

Properties

int"priority"read/write

The priority of the layer in the #GESTimeline. 0 is the highest priority. Conceptually, a #GESTimeline is a stack of GESTimelineLayers, and the priority of the layer represents its position in the stack. Two layers should not have the same priority within a given GESTimeline.

Signals

void"object-added"(self, timeline_layer, object)

Will be emitted after the object was added to the layer.

void"object-removed"(self, timeline_layer, object)

Will be emitted after the object was removed from the layer.

Methods

booladd_object(object)

intget_priority()

boolremove_object(object)

voidset_priority(priority)

voidset_timeline(timeline)

GLib.Listget_objects()

voidobject_added(object)

voidobject_removed(object)

Abstract Class: GES.TimelineObject

Known subclasses: GES.TimelineOperation, GES.TimelineSource

The #GESTimelineObject base class.

Properties

int"in-point"read/write

The in-point at which this #GESTimelineObject will start outputting data from its contents (in nanoseconds). be the one located 5 seconds in the controlled resource.

GES.TimelineLayer"layer"read-only

int"height"read-only

The span of layer priorities which this object occupies.

int"priority"read/write

The layer priority of the timeline object.

int"start"read/write

The position of the object in the #GESTimelineLayer (in nanoseconds).

int"duration"read/write

The duration (in nanoseconds) which will be used in the container #GESTrack starting from 'in-point'.

Methods

booladd_track_object(trobj)

GES.TrackObjectcreate_track_object(track)

boolcreate_track_objects(track)

boolfill_track_object(trackobj, gnlobj)

GES.TrackObjectfind_track_object(track, type)

GES.TimelineLayerget_layer()

GLib.Listget_track_objects()

boolrelease_track_object(trackobject)

voidset_duration(duration)

voidset_inpoint(inpoint)

voidset_layer(layer)

voidset_priority(priority)

voidset_start(start)

Abstract Class: GES.TimelineOperation

Known subclasses: GES.TimelineOverlay, GES.TimelineTransition

Subclass of: GES.TimelineObject

The GESTimelineOperation subclass. Subclasses can access these fields.

Abstract Class: GES.TimelineOverlay

Known subclasses: GES.TimelineTextOverlay

Subclass of: GES.TimelineOperation

Class: GES.TimelinePipeline

Implements: Gst.ChildProxy

Subclass of: Gst.Pipeline

Methods

booladd_timeline(timeline)

Gst.Bufferget_thumbnail_buffer(caps)

Gst.Bufferget_thumbnail_rgb24(width, height)

boolsave_thumbnail(width, height, format, location)

boolset_mode(mode)

boolset_render_settings(output_uri, profile)

Class: GES.TimelineSource

Known subclasses: GES.CustomTimelineSource, GES.TimelineTestSource, GES.TimelineTitleSource, GES.TimelineFileSource

Subclass of: GES.TimelineObject

Class: GES.TimelineStandardTransition

Subclass of: GES.TimelineTransition

Properties

GES.VideoStandardTransitionType"vtype"construct-only

a #GESVideoStandardTransitionType representing the wipe to use

Class: GES.TimelineTestSource

Subclass of: GES.TimelineSource

Properties

float"volume"construct-only

The volume for the audio track objects.

GES.VideoTestPattern"vpattern"construct-only

Video pattern to display in video track objects.

float"freq"construct-only

The frequency to generate for audio track objects.

bool"mute"construct-only

Whether the sound will be played or not.

Methods

floatget_frequency()

floatget_volume()

GES.VideoTestPatternget_vpattern()

boolis_muted()

voidset_frequency(freq)

voidset_mute(mute)

voidset_volume(volume)

voidset_vpattern(vpattern)

Class: GES.TimelineTextOverlay

Subclass of: GES.TimelineOverlay

Properties

string"text"construct-only

The text to diplay

string"font-desc"construct-only

Pango font description string

GES.TextHAlign"halignment"construct-only

Horizontal alignment of the text

GES.TextVAlign"valignment"construct-only

Vertical alignent of the text

Methods

stringget_font_desc()

GES.TextHAlignget_halignment()

stringget_text()

GES.TextVAlignget_valignment()

voidset_font_desc(font_desc)

voidset_halign(halign)

voidset_text(text)

voidset_valign(valign)

Class: GES.TimelineTitleSource

Subclass of: GES.TimelineSource

Render stand-alone titles in GESTimelineLayer.

Properties

string"text"construct-only

The text to diplay

string"font-desc"construct-only

Pango font description string

GES.TextVAlign"valignment"construct-only

Vertical alignent of the text

GES.TextHAlign"halignment"construct-only

Horizontal alignment of the text

bool"mute"construct-only

Whether the sound will be played or not.

Methods

stringget_font_desc()

GES.TextHAlignget_halignment()

stringget_text()

GES.TextVAlignget_valignment()

boolis_muted()

voidset_font_desc(font_desc)

voidset_halignment(halign)

voidset_mute(mute)

voidset_text(text)

voidset_valignment(valign)

Abstract Class: GES.TimelineTransition

Known subclasses: GES.TimelineStandardTransition

Subclass of: GES.TimelineOperation

Class: GES.Track

Implements: Gst.ChildProxy

Subclass of: Gst.Bin

Properties

GES.TrackType"track-type"construct-only

Type of stream the track outputs. This is used when creating the #GESTrack to specify in generic terms what type of content will be outputted. It also serves as a 'fast' way to check what type of data will be outputted from the #GESTrack without having to actually check the #GESTrack's caps property.

Gst.Caps"caps"construct-only

Caps used to filter/choose the output stream. This is generally set to a generic set of caps like 'video/x-raw-rgb;video/x-raw-yuv' for raw video.

Methods

booladd_object(object)

Gst.Capsget_caps()

GES.Timelineget_timeline()

boolremove_object(object)

voidset_caps(caps)

voidset_timeline(timeline)

Class: GES.TrackAudioTestSource

Subclass of: GES.TrackSource

Methods

floatget_freq()

floatget_volume()

voidset_freq(freq)

voidset_volume(volume)

Class: GES.TrackAudioTransition

Subclass of: GES.TrackTransition

Class: GES.TrackFileSource

Subclass of: GES.TrackSource

Properties

string"uri"construct-only

The location of the file/resource to use.

Class: GES.TrackImageSource

Subclass of: GES.TrackSource

Properties

string"uri"construct-only

The location of the file/resource to use.

Abstract Class: GES.TrackObject

Known subclasses: GES.TrackOperation, GES.TrackSource

The GESTrackObject base class.

Properties

bool"active"read/write

Whether the object should be taken into account in the #GESTrack output. If #FALSE, then its contents will not be used in the resulting track.

int"duration"read/write

The duration (in nanoseconds) which will be used in the container #GESTrack starting from 'in-point'.

int"priority"read/write

The priority of the object within the containing #GESTrack. If two objects intersect over the same region of time, the @priority property is used to decide which one takes precedence. The highest priority (that supercedes everything) is 0, and then lowering priorities go in increasing numerical value (with #G_MAXUINT64 being the lowest priority).

int"start"read/write

The position of the object in the container #GESTrack (in nanoseconds).

int"in-point"read/write

The in-point at which this #GESTrackObject will start outputting data from its contents (in nanoseconds). be the one located 5 seconds in the controlled resource.

Methods

Gst.Elementget_element()

Gst.Elementget_gnlobject()

GES.TimelineObjectget_timeline_object()

GES.Trackget_track()

boolis_locked()

boolset_active(active)

voidset_duration(duration)

voidset_inpoint(inpoint)

voidset_locked(locked)

voidset_priority(priority)

voidset_start(start)

voidset_timeline_object(tlobject)

boolset_track(track)

voidactive_changed(active)

voidchanged()

voidduration_changed(duration)

voidgnl_priority_changed(priority)

voidmedia_start_changed(media_start)

voidstart_changed(start)

Abstract Class: GES.TrackOperation

Known subclasses: GES.TrackTextOverlay, GES.TrackTransition

Subclass of: GES.TrackObject

Base class for overlays, transitions, and effects

Class: GES.TrackSource

Known subclasses: GES.TrackVideoTestSource, GES.TrackTitleSource, GES.TrackImageSource, GES.TrackAudioTestSource, GES.TrackFileSource

Subclass of: GES.TrackObject

Base class for single-media sources

Class: GES.TrackTextOverlay

Subclass of: GES.TrackOperation

Methods

stringget_font_desc()

GES.TextHAlignget_halignment()

stringget_text()

GES.TextVAlignget_valignment()

voidset_font_desc(font_desc)

voidset_halignment(halign)

voidset_text(text)

voidset_valignment(valign)

Class: GES.TrackTitleSource

Subclass of: GES.TrackSource

Methods

stringget_font_desc()

GES.TextHAlignget_halignment()

stringget_text()

GES.TextVAlignget_valignment()

voidset_font_desc(font_desc)

voidset_halignment(halign)

voidset_text(text)

voidset_valignment(valign)

Abstract Class: GES.TrackTransition

Known subclasses: GES.TrackAudioTransition, GES.TrackVideoTransition

Subclass of: GES.TrackOperation

Base class for media transitions.

Class: GES.TrackVideoTestSource

Subclass of: GES.TrackSource

Methods

GES.VideoTestPatternget_pattern()

voidset_pattern(pattern)

Class: GES.TrackVideoTransition

Subclass of: GES.TrackTransition

Methods

GES.VideoStandardTransitionTypeget_transition_type()

boolset_transition_type(type)