GESTimelineElement

GES.TimelineElement

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──GES.TimelineElement
            ╰──GES.Container
            ╰──GES.TrackElement

GES.TimelineElement.prototype.add_child_property

function GES.TimelineElement.prototype.add_child_property(pspec: GObject.ParamSpec, child: GObject.Object): {
    // javascript wrapper for 'ges_timeline_element_add_child_property'
}

Register a property of a child of the element to allow it to be written with GES.TimelineElement.prototype.set_child_property and read with GES.TimelineElement.prototype.get_child_property. A change in the property will also appear in the deep-notify signal.

pspec should be unique from other children properties that have been registered on self.

GES.TimelineElement.prototype.copy

function GES.TimelineElement.prototype.copy(deep: Number): {
    // javascript wrapper for 'ges_timeline_element_copy'
}

Create a copy of self. All the properties of self are copied into a new element, with the exception of parent, timeline and name. Other data, such the list of a GES.Container's children, is not copied.

If deep is true, then the new element is prepared so that it can be used in GES.TimelineElement.prototype.paste or GES.Timeline.prototype.paste_element. In the case of copying a GES.Container, this ensures that the children of self will also be pasted. The new element should not be used for anything else and can only be used once in a pasting operation. In particular, the new element itself is not an actual 'deep' copy of self, but should be thought of as an intermediate object used for a single paste operation.

GES.TimelineElement.prototype.edit

function GES.TimelineElement.prototype.edit(layers: [ GES.Layer ], new_layer_priority: Number, mode: GES.EditMode, edge: GES.Edge, position: Number): {
    // javascript wrapper for 'ges_timeline_element_edit'
}

See GES.TimelineElement.prototype.edit_full, which also gives an error.

Note that the layers argument is currently ignored, so you should just pass null.

Since : 1.18

GES.TimelineElement.prototype.edit_full

function GES.TimelineElement.prototype.edit_full(new_layer_priority: Number, mode: GES.EditMode, edge: GES.Edge, position: Number): {
    // javascript wrapper for 'ges_timeline_element_edit_full'
}

Edits the element within its timeline by adjusting its start, duration or in-point, and potentially doing the same for other elements in the timeline. See GES.EditMode for details about each edit mode. An edit may fail if it would place one of these properties out of bounds, or if it would place the timeline in an unsupported configuration.

Note that if you act on a GES.TrackElement, this will edit its parent GES.Clip instead. Moreover, for any GES.TimelineElement, if you select GES.Edge.EDGE_NONE for GES.EditMode.EDIT_NORMAL or GES.EditMode.EDIT_RIPPLE, this will edit the toplevel instead, but still in such a way as to make the start of self reach the edit position.

Note that if the element's timeline has a snapping-distance set, then the edit position may be snapped to the edge of some element under the edited element.

new_layer_priority can be used to switch self, and other elements moved by the edit, to a new layer. New layers may be be created if the the corresponding layer priority/index does not yet exist for the timeline.

Since : 1.18

GES.TimelineElement.prototype.get_child_property

function GES.TimelineElement.prototype.get_child_property(property_name: String): {
    // javascript wrapper for 'ges_timeline_element_get_child_property'
}

Gets the property of a child of the element.

property_name can either be in the format "prop-name" or "TypeName::prop-name", where "prop-name" is the name of the property to get (as used in g_object_get (not introspectable)), and "TypeName" is the type name of the child (as returned by G_OBJECT_TYPE_NAME (not introspectable)). The latter format is useful when two children of different types share the same property name.

The first child found with the given "prop-name" property that was registered with GES.TimelineElement.prototype.add_child_property (and of the type "TypeName", if it was given) will have the corresponding property copied into value.

Note that ges_timeline_element_get_child_properties (not introspectable) may be more convenient for C programming.

GES.TimelineElement.prototype.get_child_property_by_pspec

function GES.TimelineElement.prototype.get_child_property_by_pspec(pspec: GObject.ParamSpec): {
    // javascript wrapper for 'ges_timeline_element_get_child_property_by_pspec'
}

Gets the property of a child of the element. Specifically, the property corresponding to the pspec used in GES.TimelineElement.prototype.add_child_property is copied into value.

GES.TimelineElement.prototype.get_duration

function GES.TimelineElement.prototype.get_duration(): {
    // javascript wrapper for 'ges_timeline_element_get_duration'
}

Gets the duration for the element.

GES.TimelineElement.prototype.get_inpoint

function GES.TimelineElement.prototype.get_inpoint(): {
    // javascript wrapper for 'ges_timeline_element_get_inpoint'
}

Gets the in-point for the element.

GES.TimelineElement.prototype.get_layer_priority

function GES.TimelineElement.prototype.get_layer_priority(): {
    // javascript wrapper for 'ges_timeline_element_get_layer_priority'
}

Gets the priority of the layer the element is in. A GES.Group may span several layers, so this would return the highest priority (numerically, the smallest) amongst them.

Since : 1.16

GES.TimelineElement.prototype.get_max_duration

function GES.TimelineElement.prototype.get_max_duration(): {
    // javascript wrapper for 'ges_timeline_element_get_max_duration'
}

Gets the max-duration for the element.

GES.TimelineElement.prototype.get_name

function GES.TimelineElement.prototype.get_name(): {
    // javascript wrapper for 'ges_timeline_element_get_name'
}

Gets the name for the element.

GES.TimelineElement.prototype.get_natural_framerate

function GES.TimelineElement.prototype.get_natural_framerate(): {
    // javascript wrapper for 'ges_timeline_element_get_natural_framerate'
}

Get the "natural" framerate of self. This is to say, for example for a GES.VideoUriSource the framerate of the source.

Note that a GES.AudioSource may also have a natural framerate if it derives from the same GES.SourceClip asset as a GES.VideoSource, and its value will be that of the video source. For example, if the uri of a GES.UriClip points to a file that contains both a video and audio stream, then the corresponding GES.AudioUriSource will share the natural framerate of the corresponding GES.VideoUriSource.

Since : 1.18

GES.TimelineElement.prototype.get_parent

function GES.TimelineElement.prototype.get_parent(): {
    // javascript wrapper for 'ges_timeline_element_get_parent'
}

Gets the parent for the element.

GES.TimelineElement.prototype.get_priority

function GES.TimelineElement.prototype.get_priority(): {
    // javascript wrapper for 'ges_timeline_element_get_priority'
}

Gets the priority for the element.

GES.TimelineElement.prototype.get_start

function GES.TimelineElement.prototype.get_start(): {
    // javascript wrapper for 'ges_timeline_element_get_start'
}

Gets the start for the element.

GES.TimelineElement.prototype.get_timeline

function GES.TimelineElement.prototype.get_timeline(): {
    // javascript wrapper for 'ges_timeline_element_get_timeline'
}

Gets the timeline for the element.

GES.TimelineElement.prototype.get_toplevel_parent

function GES.TimelineElement.prototype.get_toplevel_parent(): {
    // javascript wrapper for 'ges_timeline_element_get_toplevel_parent'
}

Gets the toplevel parent of the element.

GES.TimelineElement.prototype.get_track_types

function GES.TimelineElement.prototype.get_track_types(): {
    // javascript wrapper for 'ges_timeline_element_get_track_types'
}

Gets the track types that the element can interact with, i.e. the type of GES.Track it can exist in, or will create GES.TrackElement-s for.

Since : 1.6.0

GES.TimelineElement.prototype.list_children_properties

function GES.TimelineElement.prototype.list_children_properties(): {
    // javascript wrapper for 'ges_timeline_element_list_children_properties'
}

Get a list of children properties of the element, which is a list of all the specifications passed to GES.TimelineElement.prototype.add_child_property.

GES.TimelineElement.prototype.lookup_child

function GES.TimelineElement.prototype.lookup_child(prop_name: String): {
    // javascript wrapper for 'ges_timeline_element_lookup_child'
}

Looks up a child property of the element.

prop_name can either be in the format "prop-name" or "TypeName::prop-name", where "prop-name" is the name of the property to look up (as used in g_object_get (not introspectable)), and "TypeName" is the type name of the child (as returned by G_OBJECT_TYPE_NAME (not introspectable)). The latter format is useful when two children of different types share the same property name.

The first child found with the given "prop-name" property that was registered with GES.TimelineElement.prototype.add_child_property (and of the type "TypeName", if it was given) will be passed to child, and the registered specification of this property will be passed to pspec.

GES.TimelineElement.prototype.paste

function GES.TimelineElement.prototype.paste(paste_position: Number): {
    // javascript wrapper for 'ges_timeline_element_paste'
}

Paste an element inside the same timeline and layer as self. self **must** be the return of GES.TimelineElement.prototype.copy with deep=TRUE, and it should not be changed before pasting. self is not placed in the timeline, instead a new element is created, alike to the originally copied element. Note that the originally copied element must stay within the same timeline and layer, at both the point of copying and pasting.

Pasting may fail if it would place the timeline in an unsupported configuration.

After calling this function element should not be used. In particular, element can not be pasted again. Instead, you can copy the returned element and paste that copy (although, this is only possible if the paste was successful).

See also GES.Timeline.prototype.paste_element.

Since : 1.6.0

GES.TimelineElement.prototype.remove_child_property

function GES.TimelineElement.prototype.remove_child_property(pspec: GObject.ParamSpec): {
    // javascript wrapper for 'ges_timeline_element_remove_child_property'
}

Remove a child property from the element. pspec should be a specification that was passed to GES.TimelineElement.prototype.add_child_property. The corresponding property will no longer be registered as a child property for the element.

GES.TimelineElement.prototype.ripple

function GES.TimelineElement.prototype.ripple(start: Number): {
    // javascript wrapper for 'ges_timeline_element_ripple'
}

Edits the start time of an element within its timeline in ripple mode. See GES.TimelineElement.prototype.edit with GES.EditMode.EDIT_RIPPLE and GES.Edge.EDGE_NONE.

GES.TimelineElement.prototype.ripple_end

function GES.TimelineElement.prototype.ripple_end(end: Number): {
    // javascript wrapper for 'ges_timeline_element_ripple_end'
}

Edits the end time of an element within its timeline in ripple mode. See GES.TimelineElement.prototype.edit with GES.EditMode.EDIT_RIPPLE and GES.Edge.EDGE_END.

GES.TimelineElement.prototype.roll_end

function GES.TimelineElement.prototype.roll_end(end: Number): {
    // javascript wrapper for 'ges_timeline_element_roll_end'
}

Edits the end time of an element within its timeline in roll mode. See GES.TimelineElement.prototype.edit with GES.EditMode.EDIT_ROLL and GES.Edge.EDGE_END.

GES.TimelineElement.prototype.roll_start

function GES.TimelineElement.prototype.roll_start(start: Number): {
    // javascript wrapper for 'ges_timeline_element_roll_start'
}

Edits the start time of an element within its timeline in roll mode. See GES.TimelineElement.prototype.edit with GES.EditMode.EDIT_ROLL and GES.Edge.EDGE_START.

GES.TimelineElement.prototype.set_child_property

function GES.TimelineElement.prototype.set_child_property(property_name: String, value: GObject.Value): {
    // javascript wrapper for 'ges_timeline_element_set_child_property'
}

See GES.TimelineElement.prototype.set_child_property_full, which also gives an error.

Note that ges_timeline_element_set_child_properties (not introspectable) may be more convenient for C programming.

GES.TimelineElement.prototype.set_child_property_by_pspec

function GES.TimelineElement.prototype.set_child_property_by_pspec(pspec: GObject.ParamSpec, value: GObject.Value): {
    // javascript wrapper for 'ges_timeline_element_set_child_property_by_pspec'
}

Sets the property of a child of the element. Specifically, the property corresponding to the pspec used in GES.TimelineElement.prototype.add_child_property is set to value.

GES.TimelineElement.prototype.set_child_property_full

function GES.TimelineElement.prototype.set_child_property_full(property_name: String, value: GObject.Value): {
    // javascript wrapper for 'ges_timeline_element_set_child_property_full'
}

Sets the property of a child of the element.

property_name can either be in the format "prop-name" or "TypeName::prop-name", where "prop-name" is the name of the property to set (as used in g_object_set (not introspectable)), and "TypeName" is the type name of the child (as returned by G_OBJECT_TYPE_NAME (not introspectable)). The latter format is useful when two children of different types share the same property name.

The first child found with the given "prop-name" property that was registered with GES.TimelineElement.prototype.add_child_property (and of the type "TypeName", if it was given) will have the corresponding property set to value. Other children that may have also matched the property name (and type name) are left unchanged!

Since : 1.18

GES.TimelineElement.prototype.set_duration

function GES.TimelineElement.prototype.set_duration(duration: Number): {
    // javascript wrapper for 'ges_timeline_element_set_duration'
}

Sets duration for the element.

Whilst the element is part of a GES.Timeline, this is the same as editing the element with GES.TimelineElement.prototype.edit under GES.EditMode.EDIT_TRIM with GES.Edge.EDGE_END. In particular, the duration of the element may be snapped to a different timeline time difference from the one given. In addition, setting may fail if it would place the timeline in an unsupported configuration, or the element does not have enough internal content to last the desired duration.

GES.TimelineElement.prototype.set_inpoint

function GES.TimelineElement.prototype.set_inpoint(inpoint: Number): {
    // javascript wrapper for 'ges_timeline_element_set_inpoint'
}

Sets in-point for the element. If the new in-point is above the current max-duration of the element, this method will fail.

GES.TimelineElement.prototype.set_max_duration

function GES.TimelineElement.prototype.set_max_duration(maxduration: Number): {
    // javascript wrapper for 'ges_timeline_element_set_max_duration'
}

Sets max-duration for the element. If the new maximum duration is below the current in-point of the element, this method will fail.

GES.TimelineElement.prototype.set_name

function GES.TimelineElement.prototype.set_name(name: String): {
    // javascript wrapper for 'ges_timeline_element_set_name'
}

Sets the name for the element. If null is given for name, then the library will instead generate a new name based on the type name of the element, such as the name "uriclip3" for a GES.UriClip, and will set that name instead.

If self already has a timeline, you should not call this function with name set to null.

You should ensure that, within each GES.Timeline, every element has a unique name. If you call this function with name as null, then the library should ensure that the set generated name is unique from previously generated names. However, if you choose a name that interferes with the naming conventions of the library, the library will attempt to ensure that the generated names will not conflict with the chosen name, which may lead to a different name being set instead, but the uniqueness between generated and user-chosen names is not guaranteed.

GES.TimelineElement.prototype.set_parent

function GES.TimelineElement.prototype.set_parent(parent: GES.TimelineElement): {
    // javascript wrapper for 'ges_timeline_element_set_parent'
}

Sets the parent for the element.

This is used internally and you should normally not call this. A GES.Container will set the parent of its children in GES.Container.prototype.add and GES.Container.prototype.remove.

Note, if parent is not null, self must not already have a parent set. Therefore, if you wish to switch parents, you will need to call this function twice: first to set the parent to null, and then to the new parent.

If parent is not null, you must ensure it already has a (non-floating) reference to self before calling this.

GES.TimelineElement.prototype.set_priority

function GES.TimelineElement.prototype.set_priority(priority: Number): {
    // javascript wrapper for 'ges_timeline_element_set_priority'
}

Sets the priority of the element within the containing layer.

deprecated : 1.10: All priority management is done by GES itself now. To set #GESEffect priorities #ges_clip_set_top_effect_index should be used.

GES.TimelineElement.prototype.set_start

function GES.TimelineElement.prototype.set_start(start: Number): {
    // javascript wrapper for 'ges_timeline_element_set_start'
}

Sets start for the element. If the element has a parent, this will also move its siblings with the same shift.

Whilst the element is part of a GES.Timeline, this is the same as editing the element with GES.TimelineElement.prototype.edit under GES.EditMode.EDIT_NORMAL with GES.Edge.EDGE_NONE. In particular, the start of the element may be snapped to a different timeline time from the one given. In addition, setting may fail if it would place the timeline in an unsupported configuration.

GES.TimelineElement.prototype.set_timeline

function GES.TimelineElement.prototype.set_timeline(timeline: GES.Timeline): {
    // javascript wrapper for 'ges_timeline_element_set_timeline'
}

Sets the timeline of the element.

This is used internally and you should normally not call this. A GES.Clip will have its timeline set through its GES.Layer. A GES.Track will similarly take care of setting the timeline of its GES.TrackElement-s. A GES.Group will adopt the same timeline as its children.

If timeline is null, this will stop its current timeline from tracking it, otherwise timeline will start tracking self. Note, in the latter case, self must not already have a timeline set. Therefore, if you wish to switch timelines, you will need to call this function twice: first to set the timeline to null, and then to the new timeline.

GES.TimelineElement.prototype.trim

function GES.TimelineElement.prototype.trim(start: Number): {
    // javascript wrapper for 'ges_timeline_element_trim'
}

Edits the start time of an element within its timeline in trim mode. See GES.TimelineElement.prototype.edit with GES.EditMode.EDIT_TRIM and GES.Edge.EDGE_START.

child-property-added

function child_property_added_callback(self: GES.TimelineElement, prop_object: GObject.Object, prop: GObject.ParamSpec, user_data: Object): {
    // javascript callback for the 'child-property-added' signal
}

Emitted when the element has a new child property registered. See GES.TimelineElement.prototype.add_child_property.

Note that some GES elements will be automatically created with pre-registered children properties. You can use GES.TimelineElement.prototype.list_children_properties to list these.

Flags: Run First

Since : 1.18

child-property-removed

function child_property_removed_callback(self: GES.TimelineElement, prop_object: GObject.Object, prop: GObject.ParamSpec, user_data: Object): {
    // javascript callback for the 'child-property-removed' signal
}

Emitted when the element has a child property unregistered. See GES.TimelineElement.prototype.remove_child_property.

Flags: Run First

Since : 1.18

deep-notify

function deep_notify_callback(self: GES.TimelineElement, prop_object: GObject.Object, prop: GObject.ParamSpec, user_data: Object): {
    // javascript callback for the 'deep-notify' signal
}

Emitted when a child of the element has one of its registered properties set. See GES.TimelineElement.prototype.add_child_property. Note that unlike notify, a child property name can not be used as a signal detail.

Flags: Run First / No Hooks

duration

“duration” Number

The duration that the element is in effect for in the timeline (a time difference in nanoseconds using the time coordinates of the timeline). For example, for a source element, this would determine for how long it should output its internal content for. For an operation element, this would determine for how long its effect should be applied to any source content.

Flags : Read / Write

in-point

“in-point” Number

The initial offset to use internally when outputting content (in nanoseconds, but in the time coordinates of the internal content).

For example, for a GES.VideoUriSource that references some media file, the "internal content" is the media file data, and the in-point would correspond to some timestamp in the media file. When playing the timeline, and when the element is first reached at timeline-time start, it will begin outputting the data from the timestamp in-point onwards, until it reaches the end of its duration in the timeline.

For elements that have no internal content, this should be kept as 0.

Flags : Read / Write

max-duration

“max-duration” Number

The full duration of internal content that is available (a time difference in nanoseconds using the time coordinates of the internal content).

This will act as a cap on the in-point of the element (which is in the same time coordinates), and will sometimes be used to limit the duration of the element in the timeline.

For example, for a GES.VideoUriSource that references some media file, this would be the length of the media file.

For elements that have no internal content, or whose content is indefinite, this should be kept as Gst.CLOCK_TIME_NONE.

Flags : Read / Write / Construct

name

“name” String

The name of the element. This should be unique within its timeline.

Flags : Read / Write / Construct

parent

“parent” GES.TimelineElement

The parent container of the element.

Flags : Read / Write

priority

“priority” Number

The priority of the element.

Flags : Read / Write

deprecated : 1.10: Priority management is now done by GES itself.

serialize

“serialize” Number

Whether the element should be serialized.

Flags : Read / Write

start

“start” Number

The starting position of the element in the timeline (in nanoseconds and in the time coordinates of the timeline). For example, for a source element, this would determine the time at which it should start outputting its internal content. For an operation element, this would determine the time at which it should start applying its effect to any source content.

Flags : Read / Write

timeline

“timeline” GES.Timeline

The timeline that the element lies within.

Flags : Read / Write

vfunc_deep_copy

function vfunc_deep_copy(self: GES.TimelineElement, copy: GES.TimelineElement): {
    // javascript implementation of the 'deep_copy' virtual method
}

Prepare copy for pasting as a copy of self. At least by copying the children properties of self into copy.

vfunc_get_layer_priority

function vfunc_get_layer_priority(self: GES.TimelineElement): {
    // javascript implementation of the 'get_layer_priority' virtual method
}

Get the priority of the layer that this element is part of.

Since : 1.16

vfunc_get_natural_framerate

function vfunc_get_natural_framerate(self: GES.TimelineElement): {
    // javascript implementation of the 'get_natural_framerate' virtual method
}

Since : 1.18

vfunc_get_track_types

function vfunc_get_track_types(self: GES.TimelineElement): {
    // javascript implementation of the 'get_track_types' virtual method
}

Return a the track types for the element.

vfunc_lookup_child

function vfunc_lookup_child(self: GES.TimelineElement, prop_name: String): {
    // javascript implementation of the 'lookup_child' virtual method
}

Find child, and its registered child property pspec, corresponding to the child property specified by prop_name. The default implementation will search for the first child that matches. If you overwrite this, you will likely still want to call the default vmethod, which has access to the registered parameter specifications.

vfunc_ripple

function vfunc_ripple(self: GES.TimelineElement, start: Number): {
    // javascript implementation of the 'ripple' virtual method
}

Set this method to overwrite a redirect to GES.TimelineElement.prototype.edit in GES.TimelineElement.prototype.ripple.

vfunc_ripple_end

function vfunc_ripple_end(self: GES.TimelineElement, end: Number): {
    // javascript implementation of the 'ripple_end' virtual method
}

Set this method to overwrite a redirect to GES.TimelineElement.prototype.edit in GES.TimelineElement.prototype.ripple_end.

vfunc_roll_end

function vfunc_roll_end(self: GES.TimelineElement, end: Number): {
    // javascript implementation of the 'roll_end' virtual method
}

Set this method to overwrite a redirect to GES.TimelineElement.prototype.edit in GES.TimelineElement.prototype.roll_end.

vfunc_roll_start

function vfunc_roll_start(self: GES.TimelineElement, start: Number): {
    // javascript implementation of the 'roll_start' virtual method
}

vfunc_set_child_property

function vfunc_set_child_property(self: GES.TimelineElement, child: GObject.Object, pspec: GObject.ParamSpec, value: GObject.Value): {
    // javascript implementation of the 'set_child_property' virtual method
}

Method for setting the child property given by pspec on child to value. Default implementation will use GObject.Object.prototype.set_property.

Since : 1.16

vfunc_set_child_property_full

function vfunc_set_child_property_full(self: GES.TimelineElement, child: GObject.Object, pspec: GObject.ParamSpec, value: GObject.Value): {
    // javascript implementation of the 'set_child_property_full' virtual method
}

Similar to set_child_property, except setting can fail, with the error being optionally set. Default implementation will call set_child_property and return true.

Since : 1.18