GESLayer

GES.Layer

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──GES.Layer

GES.Layer.prototype.new

function GES.Layer.prototype.new(): {
    // javascript wrapper for 'ges_layer_new'
}

Creates a new layer.

GES.Layer.prototype.add_asset

function GES.Layer.prototype.add_asset(asset: GES.Asset, start: Number, inpoint: Number, duration: Number, track_types: GES.TrackType): {
    // javascript wrapper for 'ges_layer_add_asset'
}

See GES.Layer.prototype.add_asset_full, which also gives an error.

GES.Layer.prototype.add_asset_full

function GES.Layer.prototype.add_asset_full(asset: GES.Asset, start: Number, inpoint: Number, duration: Number, track_types: GES.TrackType): {
    // javascript wrapper for 'ges_layer_add_asset_full'
}

Extracts a new clip from an asset and adds it to the layer with the given properties.

Since : 1.18

GES.Layer.prototype.add_clip

function GES.Layer.prototype.add_clip(clip: GES.Clip): {
    // javascript wrapper for 'ges_layer_add_clip'
}

See GES.Layer.prototype.add_clip_full, which also gives an error.

GES.Layer.prototype.add_clip_full

function GES.Layer.prototype.add_clip_full(clip: GES.Clip): {
    // javascript wrapper for 'ges_layer_add_clip_full'
}

Adds the given clip to the layer. If the method succeeds, the layer will take ownership of the clip.

This method will fail and return false if clip already resides in some layer. It can also fail if the additional clip breaks some compositional rules (see GES.TimelineElement).

Since : 1.18

GES.Layer.prototype.get_active_for_track

function GES.Layer.prototype.get_active_for_track(track: GES.Track): {
    // javascript wrapper for 'ges_layer_get_active_for_track'
}

Gets whether the layer is active for the given track. See GES.Layer.prototype.set_active_for_tracks.

Since : 1.18

GES.Layer.prototype.get_auto_transition

function GES.Layer.prototype.get_auto_transition(): {
    // javascript wrapper for 'ges_layer_get_auto_transition'
}

Gets the auto-transition of the layer.

GES.Layer.prototype.get_clips

function GES.Layer.prototype.get_clips(): {
    // javascript wrapper for 'ges_layer_get_clips'
}

Get the GES.Clip-s contained in this layer.

GES.Layer.prototype.get_clips_in_interval

function GES.Layer.prototype.get_clips_in_interval(start: Number, end: Number): {
    // javascript wrapper for 'ges_layer_get_clips_in_interval'
}

Gets the clips within the layer that appear between start and end.

GES.Layer.prototype.get_duration

function GES.Layer.prototype.get_duration(): {
    // javascript wrapper for 'ges_layer_get_duration'
}

Retrieves the duration of the layer, which is the difference between the start of the layer (always time 0) and the end (which will be the end time of the final clip).

GES.Layer.prototype.get_priority

function GES.Layer.prototype.get_priority(): {
    // javascript wrapper for 'ges_layer_get_priority'
}

Get the priority of the layer. When inside a timeline, this is its index in the timeline. See GES.Timeline.prototype.move_layer.

GES.Layer.prototype.get_timeline

function GES.Layer.prototype.get_timeline(): {
    // javascript wrapper for 'ges_layer_get_timeline'
}

Gets the timeline that the layer is a part of.

GES.Layer.prototype.is_empty

function GES.Layer.prototype.is_empty(): {
    // javascript wrapper for 'ges_layer_is_empty'
}

Convenience method to check if the layer is empty (doesn't contain any GES.Clip), or not.

GES.Layer.prototype.remove_clip

function GES.Layer.prototype.remove_clip(clip: GES.Clip): {
    // javascript wrapper for 'ges_layer_remove_clip'
}

Removes the given clip from the layer.

GES.Layer.prototype.set_active_for_tracks

function GES.Layer.prototype.set_active_for_tracks(active: Number, tracks: [ GES.Track ]): {
    // javascript wrapper for 'ges_layer_set_active_for_tracks'
}

Activate or deactivate track elements in tracks (or in all tracks if tracks is null).

When a layer is deactivated for a track, all the GES.TrackElement-s in the track that belong to a GES.Clip in the layer will no longer be active in the track, regardless of their individual active value.

Note that by default a layer will be active for all of its timeline's tracks.

Since : 1.18

GES.Layer.prototype.set_auto_transition

function GES.Layer.prototype.set_auto_transition(auto_transition: Number): {
    // javascript wrapper for 'ges_layer_set_auto_transition'
}

Sets auto-transition for the layer. Use GES.Timeline.prototype.set_auto_transition if you want all layers within a GES.Timeline to have auto-transition set to true. Use this method if you want different values for different layers (and make sure to keep auto-transition as false for the corresponding timeline).

GES.Layer.prototype.set_priority

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

Sets the layer to the given priority. See priority.

deprecated : 1.16.0: use #ges_timeline_move_layer instead. This deprecation means that you will not need to handle layer priorities at all yourself, GES will make sure there is never 'gaps' between layer priorities.

GES.Layer.prototype.set_timeline

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

active-changed

function active_changed_callback(self: GES.Layer, active: Number, tracks: [ GES.Track ], user_data: Object): {
    // javascript callback for the 'active-changed' signal
}

Will be emitted whenever the layer is activated or deactivated for some GES.Track. See GES.Layer.prototype.set_active_for_tracks.

Flags: Run First

Since : 1.18

clip-added

function clip_added_callback(self: GES.Layer, clip: GES.Clip, user_data: Object): {
    // javascript callback for the 'clip-added' signal
}

Will be emitted after the clip is added to the layer.

Flags: Run First

clip-removed

function clip_removed_callback(self: GES.Layer, clip: GES.Clip, user_data: Object): {
    // javascript callback for the 'clip-removed' signal
}

Will be emitted after the clip is removed from the layer.

Flags: Run First

auto-transition

“auto-transition” Number

Whether to automatically create a GES.TransitionClip whenever two GES.Source-s that both belong to a GES.Clip in the layer overlap. See GES.Timeline for what counts as an overlap.

When a layer is added to a GES.Timeline, if this property is left as false, but the timeline's auto-transition is true, it will be set to true as well.

Flags : Read / Write

priority

“priority” Number

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

Note that the timeline needs to be committed (with GES.Timeline.prototype.commit) for the change to be taken into account.

Flags : Read / Write

deprecated : 1.16.0: use #ges_timeline_move_layer instead. This deprecation means that you will not need to handle layer priorities at all yourself, GES will make sure there is never 'gaps' between layer priorities.

vfunc_object_added

function vfunc_object_added(layer: GES.Layer, object: GES.Clip): {
    // javascript implementation of the 'object_added' virtual method
}

vfunc_object_removed

function vfunc_object_removed(layer: GES.Layer, object: GES.Clip): {
    // javascript implementation of the 'object_removed' virtual method
}