Layer

Object Hierarchy:

Description:

[ CCode ( type_id = "ges_layer_get_type ()" ) ]
public class Layer : InitiallyUnowned, Extractable, MetaContainer

Layer-s are responsible for collecting and ordering Clip-s.

A layer within a timeline will have an associated priority, corresponding to their index within the timeline. A layer with the index/priority 0 will have the highest priority and the layer with the largest index will have the lowest priority (the order of priorities, in this sense, is the _reverse_ of the numerical ordering of the indices). move_layer should be used if you wish to change how layers are prioritised in a timeline.

Layers with higher priorities will have their content priorities over content from lower priority layers, similar to how layers are used in image editing. For example, if two separate layers both display video content, then the layer with the higher priority will have its images shown first. The other layer will only have its image shown if the higher priority layer has no content at the given playtime, or is transparent in some way. Audio content in separate layers will simply play in addition.

Namespace: GES

Package: gst-editing-services-1.0

Content:

Properties:

public bool auto_transition { get; set; }
Whether to automatically create a TransitionClip whenever two Source-s that both belong to a Clip in the layer overlap.
public uint priority { get; set; }
The priority of the layer in the Timeline.

Creation methods:

public Layer ()
Creates a new layer.

Methods:

public unowned Clip? add_asset (Asset asset, ClockTime start, ClockTime inpoint, ClockTime duration, TrackType track_types)
See add_asset_full, which also gives an error.
public unowned Clip add_asset_full (Asset asset, ClockTime start, ClockTime inpoint, ClockTime duration, TrackType track_types) throws Error
Extracts a new clip from an asset and adds it to the layer with the given properties.
public bool add_clip (Clip clip)
See add_clip_full, which also gives an error.
public bool add_clip_full (Clip clip) throws Error
Adds the given clip to the layer.
public bool get_active_for_track (Track track)
Gets whether the layer is active for the given track.
public bool get_auto_transition ()
Gets the auto_transition of the layer.
public List<Clip> get_clips ()
Get the Clip-s contained in this layer.
public List<Clip> get_clips_in_interval (ClockTime start, ClockTime end)
Gets the clips within the layer that appear between start and end.
public ClockTime 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).
public uint get_priority ()
Get the priority of the layer.
public unowned Timeline? get_timeline ()
Gets the timeline that the layer is a part of.
public bool is_empty ()
Convenience method to check if the layer is empty (doesn't contain any Clip), or not.
public virtual void object_added (Clip object)
public virtual void object_removed (Clip object)
public bool remove_clip (Clip clip)
Removes the given clip from the layer.
public bool set_active_for_tracks (bool active, List<Track>? tracks)
Activate or deactivate track elements in tracks (or in all tracks if tracks is null).
public void set_auto_transition (bool auto_transition)
Sets auto_transition for the layer.
public void set_priority (uint priority)
Sets the layer to the given priority.
public void set_timeline (Timeline timeline)

Signals:

public signal void active_changed (bool active, GenericArray<Track> tracks)
Will be emitted whenever the layer is activated or deactivated for some Track.
public signal void clip_added (Clip clip)
Will be emitted after the clip is added to the layer.
public signal void clip_removed (Clip clip)
Will be emitted after the clip is removed from the layer.

Fields:

public uint32 max_nle_priority
public uint32 min_nle_priority
public unowned Timeline timeline

Inherited Members:

All known members inherited from class GLib.Object

All known members inherited from interface GES.Extractable

set_asset

set_asset_full

All known members inherited from interface GES.MetaContainer