GESLayer

Responsible for the ordering of the various contained Clip(s). A timeline layer has a "priority" property, which is used to manage the priorities of individual Clips. Two layers should not have the same priority within a given timeline.

GESLayer

GObject
    ╰──GInitiallyUnowned
        ╰──GESLayer

Members

parent (GInitiallyUnowned) –
No description available
timeline (GESTimeline *) –

the GESTimeline where this layer is being used.

min_nle_priority (guint32) –
No description available
max_nle_priority (guint32) –
No description available
priv (GESLayerPrivate*) –
No description available
_ges_reserved (gpointer *) –
No description available

Class structure

GESLayerClass

Subclasses can override the get_objects if they can provide a more efficient way of providing the list of contained GESClip(s).


GES.LayerClass

Subclasses can override the get_objects if they can provide a more efficient way of providing the list of contained GES.Clip(s).


GES.LayerClass

Subclasses can override the get_objects if they can provide a more efficient way of providing the list of contained GES.Clip(s).


GESLayer

GObject
    ╰──GInitiallyUnowned
        ╰──GESLayer

Members

parent (GInitiallyUnowned) –
No description available
timeline (GESTimeline) –

the GESTimeline where this layer is being used.

min_nle_priority (int) –
No description available
max_nle_priority (int) –
No description available
priv (GESLayerPrivate) –
No description available
_ges_reserved ([ object ]) –
No description available

GESLayer

GObject
    ╰──GInitiallyUnowned
        ╰──GESLayer

Members

parent (GInitiallyUnowned) –
No description available
timeline (GESTimeline) –

the GESTimeline where this layer is being used.

min_nle_priority (Number) –
No description available
max_nle_priority (Number) –
No description available
priv (GESLayerPrivate) –
No description available
_ges_reserved ([ Object ]) –
No description available

Constructors

ges_layer_new

GESLayer *
ges_layer_new ()

Creates a new GESLayer.

Returns ( [transfer: floating] ) –

A new GESLayer


GES.Layer.new

def GES.Layer.new ():
    #python wrapper for 'ges_layer_new'

Creates a new GES.Layer.

Returns ( GES.Layer ) –

A new GES.Layer


GES.Layer.prototype.new

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

Creates a new GES.Layer.

Returns ( GES.Layer ) –

A new GES.Layer


Methods

ges_layer_add_asset

GESClip *
ges_layer_add_asset (GESLayer * layer,
                     GESAsset * asset,
                     GstClockTime start,
                     GstClockTime inpoint,
                     GstClockTime duration,
                     GESTrackType track_types)

Creates Clip from asset, adds it to layer and returns its pointer.

Parameters:

layer

a GESLayer

asset

The asset to add to

start

The start value to set on the new GESClip, if start == GST_CLOCK_TIME_NONE, it will be set to the current duration of layer

inpoint

The inpoint value to set on the new GESClip

duration

The duration value to set on the new GESClip

track_types

The GESTrackType to set on the the new GESClip

Returns ( [transfer: none] ) –

Created GESClip


GES.Layer.add_asset

def GES.Layer.add_asset (self, asset, start, inpoint, duration, track_types):
    #python wrapper for 'ges_layer_add_asset'

Creates Clip from asset, adds it to layer and returns its pointer.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

asset ( GES.Asset ) –

The asset to add to

start ( int ) –

The start value to set on the new GES.Clip, if start == GST_CLOCK_TIME_NONE, it will be set to the current duration of layer

inpoint ( int ) –

The inpoint value to set on the new GES.Clip

duration ( int ) –

The duration value to set on the new GES.Clip

track_types ( GES.TrackType ) –

The GES.TrackType to set on the the new GES.Clip

Returns ( GES.Clip ) –

Created GES.Clip


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'
}

Creates Clip from asset, adds it to layer and returns its pointer.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

asset ( GES.Asset ) –

The asset to add to

start ( Number ) –

The start value to set on the new GES.Clip, if start == GST_CLOCK_TIME_NONE, it will be set to the current duration of layer

inpoint ( Number ) –

The inpoint value to set on the new GES.Clip

duration ( Number ) –

The duration value to set on the new GES.Clip

track_types ( GES.TrackType ) –

The GES.TrackType to set on the the new GES.Clip

Returns ( GES.Clip ) –

Created GES.Clip


ges_layer_add_clip

gboolean
ges_layer_add_clip (GESLayer * layer,
                    GESClip * clip)

Adds the given clip to the layer. Sets the clip's parent, and thus takes ownership of the clip.

An clip can only be added to one layer.

Calling this method will construct and properly set all the media related elements on clip. If you need to know when those objects (actually GESTrackElement) are constructed, you should connect to the container::child-added signal which is emited right after those elements are ready to be used.

Parameters:

layer

a GESLayer

clip ( [transfer: floating] ) –

the GESClip to add.

Returns

TRUE if the clip was properly added to the layer, or FALSE if the layer refuses to add the clip.


GES.Layer.add_clip

def GES.Layer.add_clip (self, clip):
    #python wrapper for 'ges_layer_add_clip'

Adds the given clip to the layer. Sets the clip's parent, and thus takes ownership of the clip.

An clip can only be added to one layer.

Calling this method will construct and properly set all the media related elements on clip. If you need to know when those objects (actually GES.TrackElement) are constructed, you should connect to the container::child-added signal which is emited right after those elements are ready to be used.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

clip ( GES.Clip ) –

the GES.Clip to add.

Returns ( bool ) –

True if the clip was properly added to the layer, or False if the layer refuses to add the clip.


GES.Layer.prototype.add_clip

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

Adds the given clip to the layer. Sets the clip's parent, and thus takes ownership of the clip.

An clip can only be added to one layer.

Calling this method will construct and properly set all the media related elements on clip. If you need to know when those objects (actually GES.TrackElement) are constructed, you should connect to the container::child-added signal which is emited right after those elements are ready to be used.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

clip ( GES.Clip ) –

the GES.Clip to add.

Returns ( Number ) –

true if the clip was properly added to the layer, or false if the layer refuses to add the clip.


ges_layer_get_auto_transition

gboolean
ges_layer_get_auto_transition (GESLayer * layer)

Gets whether transitions are automatically added when objects overlap or not.

Parameters:

layer

a GESLayer

Returns

TRUE if transitions are automatically added, else FALSE.


GES.Layer.get_auto_transition

def GES.Layer.get_auto_transition (self):
    #python wrapper for 'ges_layer_get_auto_transition'

Gets whether transitions are automatically added when objects overlap or not.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

Returns ( bool ) –

True if transitions are automatically added, else False.


GES.Layer.prototype.get_auto_transition

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

Gets whether transitions are automatically added when objects overlap or not.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

Returns ( Number ) –

true if transitions are automatically added, else false.


ges_layer_get_clips

GList *
ges_layer_get_clips (GESLayer * layer)

Get the clips this layer contains.

Parameters:

layer

a GESLayer

Returns ( [transfer: full] [element-type GESClip] ) –

a GList of clips. The user is responsible for unreffing the contained objects and freeing the list.


GES.Layer.get_clips

def GES.Layer.get_clips (self):
    #python wrapper for 'ges_layer_get_clips'

Get the clips this layer contains.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

Returns ( [ GES.Clip ] ) –

a GLib.List of clips. The user is responsible for unreffing the contained objects and freeing the list.


GES.Layer.prototype.get_clips

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

Get the clips this layer contains.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

Returns ( [ GES.Clip ] ) –

a GLib.List of clips. The user is responsible for unreffing the contained objects and freeing the list.


ges_layer_get_clips_in_interval

GList *
ges_layer_get_clips_in_interval (GESLayer * layer,
                                 GstClockTime start,
                                 GstClockTime end)

Gets the clips which appear between start and end on layer.

Parameters:

layer

a GESLayer

start

start of the interval

end

end of the interval

Returns ( [transfer: full] [element-type GESClip] ) –

a GList of clips intersecting [@start, end) interval on layer.


GES.Layer.get_clips_in_interval

def GES.Layer.get_clips_in_interval (self, start, end):
    #python wrapper for 'ges_layer_get_clips_in_interval'

Gets the clips which appear between start and end on layer.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

start ( int ) –

start of the interval

end ( int ) –

end of the interval

Returns ( [ GES.Clip ] ) –

a GLib.List of clips intersecting [@start, end) interval on 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 which appear between start and end on layer.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

start ( Number ) –

start of the interval

end ( Number ) –

end of the interval

Returns ( [ GES.Clip ] ) –

a GLib.List of clips intersecting [@start, end) interval on layer.


ges_layer_get_duration

GstClockTime
ges_layer_get_duration (GESLayer * layer)

Lets you retrieve the duration of the layer, which means the end time of the last clip inside it

Parameters:

layer

The GESLayer to get the duration from

Returns

The duration of a layer


GES.Layer.get_duration

def GES.Layer.get_duration (self):
    #python wrapper for 'ges_layer_get_duration'

Lets you retrieve the duration of the layer, which means the end time of the last clip inside it

Parameters:

layer ( GES.Layer ) –

The GES.Layer to get the duration from

Returns ( int ) –

The duration of a layer


GES.Layer.prototype.get_duration

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

Lets you retrieve the duration of the layer, which means the end time of the last clip inside it

Parameters:

layer ( GES.Layer ) –

The GES.Layer to get the duration from

Returns ( Number ) –

The duration of a layer


ges_layer_get_priority

guint
ges_layer_get_priority (GESLayer * layer)

Get the priority of layer within the timeline.

Parameters:

layer

a GESLayer

Returns

The priority of the layer within the timeline.


GES.Layer.get_priority

def GES.Layer.get_priority (self):
    #python wrapper for 'ges_layer_get_priority'

Get the priority of layer within the timeline.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

Returns ( int ) –

The priority of the layer within the timeline.


GES.Layer.prototype.get_priority

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

Get the priority of layer within the timeline.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

Returns ( Number ) –

The priority of the layer within the timeline.


ges_layer_get_timeline

GESTimeline *
ges_layer_get_timeline (GESLayer * layer)

Get the GESTimeline in which GESLayer currently is.

Parameters:

layer

The GESLayer to get the parent GESTimeline from

Returns ( [transfer: none] [nullable] ) –

the GESTimeline in which GESLayer currently is or NULL if not in any timeline yet.


GES.Layer.get_timeline

def GES.Layer.get_timeline (self):
    #python wrapper for 'ges_layer_get_timeline'

Get the GES.Timeline in which GES.Layer currently is.

Parameters:

layer ( GES.Layer ) –

The GES.Layer to get the parent GES.Timeline from

Returns ( GES.Timeline ) –

the GES.Timeline in which GES.Layer currently is or None if not in any timeline yet.


GES.Layer.prototype.get_timeline

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

Get the GES.Timeline in which GES.Layer currently is.

Parameters:

layer ( GES.Layer ) –

The GES.Layer to get the parent GES.Timeline from

Returns ( GES.Timeline ) –

the GES.Timeline in which GES.Layer currently is or null if not in any timeline yet.


ges_layer_is_empty

gboolean
ges_layer_is_empty (GESLayer * layer)

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

Parameters:

layer

The GESLayer to check

Returns

TRUE if layer is empty, FALSE if it already contains at least one GESClip


GES.Layer.is_empty

def GES.Layer.is_empty (self):
    #python wrapper for 'ges_layer_is_empty'

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

Parameters:

layer ( GES.Layer ) –

The GES.Layer to check

Returns ( bool ) –

True if layer is empty, False if it already contains at least one GES.Clip


GES.Layer.prototype.is_empty

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

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

Parameters:

layer ( GES.Layer ) –

The GES.Layer to check

Returns ( Number ) –

true if layer is empty, false if it already contains at least one GES.Clip


ges_layer_remove_clip

gboolean
ges_layer_remove_clip (GESLayer * layer,
                       GESClip * clip)

Removes the given clip from the layer and unparents it. Unparenting it means the reference owned by layer on the clip will be removed. If you wish to use the clip after this function, make sure you call gst_object_ref before removing it from the layer.

Parameters:

layer

a GESLayer

clip

the GESClip to remove

Returns

TRUE if the clip could be removed, FALSE if the layer does not want to remove the clip.


GES.Layer.remove_clip

def GES.Layer.remove_clip (self, clip):
    #python wrapper for 'ges_layer_remove_clip'

Removes the given clip from the layer and unparents it. Unparenting it means the reference owned by layer on the clip will be removed. If you wish to use the clip after this function, make sure you call Gst.Object.ref before removing it from the layer.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

clip ( GES.Clip ) –

the GES.Clip to remove

Returns ( bool ) –

True if the clip could be removed, False if the layer does not want to remove the clip.


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 and unparents it. Unparenting it means the reference owned by layer on the clip will be removed. If you wish to use the clip after this function, make sure you call Gst.Object.prototype.ref before removing it from the layer.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

clip ( GES.Clip ) –

the GES.Clip to remove

Returns ( Number ) –

true if the clip could be removed, false if the layer does not want to remove the clip.


ges_layer_set_auto_transition

ges_layer_set_auto_transition (GESLayer * layer,
                               gboolean auto_transition)

Sets the layer to the given auto_transition. See the documentation of the property auto_transition for more information.

Parameters:

layer

a GESLayer

auto_transition

whether the auto_transition is active


GES.Layer.set_auto_transition

def GES.Layer.set_auto_transition (self, auto_transition):
    #python wrapper for 'ges_layer_set_auto_transition'

Sets the layer to the given auto_transition. See the documentation of the property auto_transition for more information.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

auto_transition ( bool ) –

whether the auto_transition is active


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 the layer to the given auto_transition. See the documentation of the property auto_transition for more information.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

auto_transition ( Number ) –

whether the auto_transition is active


ges_layer_set_priority

ges_layer_set_priority (GESLayer * layer,
                        guint priority)

Sets the layer to the given priority. See the documentation of the priority property for more information.

Parameters:

layer

a GESLayer

priority

the priority to set

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

def GES.Layer.set_priority (self, priority):
    #python wrapper for 'ges_layer_set_priority'

Sets the layer to the given priority. See the documentation of the priority property for more information.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

priority ( int ) –

the priority to set

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_priority

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

Sets the layer to the given priority. See the documentation of the priority property for more information.

Parameters:

layer ( GES.Layer ) –

a GES.Layer

priority ( Number ) –

the priority to set

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_set_timeline

ges_layer_set_timeline (GESLayer * layer,
                        GESTimeline * timeline)

Parameters:

layer
No description available
timeline
No description available

GES.Layer.set_timeline

def GES.Layer.set_timeline (self, timeline):
    #python wrapper for 'ges_layer_set_timeline'

Parameters:

layer ( GES.Layer ) –
No description available
timeline ( GES.Timeline ) –
No description available

GES.Layer.prototype.set_timeline

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

Parameters:

layer ( GES.Layer ) –
No description available
timeline ( GES.Timeline ) –
No description available

Signals

clip-added

clip_added_callback (GESLayer * self,
                     GESClip * clip,
                     gpointer user_data)

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

Parameters:

self
No description available
clip

the GESClip that was added.

user_data
No description available

Flags: Run First


clip-added

def clip_added_callback (self, clip, *user_data):
    #python callback for the 'clip-added' signal

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

Parameters:

self ( GES.Layer ) –
No description available
clip ( GES.Clip ) –

the GES.Clip that was added.

user_data ( variadic ) –
No description available

Flags: Run First


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 was added to the layer.

Parameters:

self ( GES.Layer ) –
No description available
clip ( GES.Clip ) –

the GES.Clip that was added.

user_data ( Object ) –
No description available

Flags: Run First


clip-removed

clip_removed_callback (GESLayer * self,
                       GESClip * clip,
                       gpointer user_data)

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

Parameters:

self
No description available
clip

the GESClip that was removed

user_data
No description available

Flags: Run First


clip-removed

def clip_removed_callback (self, clip, *user_data):
    #python callback for the 'clip-removed' signal

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

Parameters:

self ( GES.Layer ) –
No description available
clip ( GES.Clip ) –

the GES.Clip that was removed

user_data ( variadic ) –
No description available

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 was removed from the layer.

Parameters:

self ( GES.Layer ) –
No description available
clip ( GES.Clip ) –

the GES.Clip that was removed

user_data ( Object ) –
No description available

Flags: Run First


Properties

auto-transition

“auto-transition” gboolean

Sets whether transitions are added automagically when clips overlap.

Flags : Read / Write


auto_transition

“self.props.auto_transition” bool

Sets whether transitions are added automagically when clips overlap.

Flags : Read / Write


auto-transition

“auto-transition” Number

Sets whether transitions are added automagically when clips overlap.

Flags : Read / Write


priority

“priority” guint

The priority of the layer in the GESTimeline. 0 is the highest priority. Conceptually, a GESTimeline is a stack of GESLayers, 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 commited (with ges_timeline_commit) for the change to be taken into account.

Flags : Read / Write


priority

“self.props.priority” int

The priority of the layer in the GES.Timeline. 0 is the highest priority. Conceptually, a GES.Timeline is a stack of GESLayers, 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 commited (with GES.Timeline.commit) for the change to be taken into account.

Flags : Read / Write


priority

“priority” Number

The priority of the layer in the GES.Timeline. 0 is the highest priority. Conceptually, a GES.Timeline is a stack of GESLayers, 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 commited (with GES.Timeline.prototype.commit) for the change to be taken into account.

Flags : Read / Write


Virtual Methods

get_objects

GList *
get_objects (GESLayer * layer)

method to get the objects contained in the layer

Parameters:

layer
No description available
Returns
No description available

object_added

object_added (GESLayer * layer,
              GESClip * object)

Parameters:

layer
No description available
object
No description available

do_object_added

def do_object_added (layer, object):
    #python implementation of the 'object_added' virtual method

Parameters:

layer ( GES.Layer ) –
No description available
object ( GES.Clip ) –
No description available

vfunc_object_added

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

Parameters:

layer ( GES.Layer ) –
No description available
object ( GES.Clip ) –
No description available

object_removed

object_removed (GESLayer * layer,
                GESClip * object)

Parameters:

layer
No description available
object
No description available

do_object_removed

def do_object_removed (layer, object):
    #python implementation of the 'object_removed' virtual method

Parameters:

layer ( GES.Layer ) –
No description available
object ( GES.Clip ) –
No description available

vfunc_object_removed

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

Parameters:

layer ( GES.Layer ) –
No description available
object ( GES.Clip ) –
No description available

Constants

GES_TYPE_LAYER

#define GES_TYPE_LAYER ges_layer_get_type()

The results of the search are