GESContainer

GESContainer

GObject
    ╰──GInitiallyUnowned
        ╰──GESTimelineElement
            ╰──GESContainer
                ╰──GESClip
                ╰──GESGroup

The GESContainer base class.

Members

parent (GESTimelineElement) –
No description available
children (GList *) –

A list of TimelineElement controlled by this Container. NOTE: Do not modify.

height (guint32) –

The span of priorities this container occupies

children_control_mode (GESChildrenControlMode) –
No description available
initiated_move (GESTimelineElement *) –
No description available

Class structure

GESContainerClass


GES.ContainerClass


GES.ContainerClass


GESContainer

GObject
    ╰──GInitiallyUnowned
        ╰──GESTimelineElement
            ╰──GESContainer
                ╰──GESClip
                ╰──GESGroup

The GESContainer base class.

Members

parent (GESTimelineElement) –
No description available
children ([ GESTimelineElement ]) –

A list of TimelineElement controlled by this Container. NOTE: Do not modify.

height (int) –

The span of priorities this container occupies

children_control_mode (GESChildrenControlMode) –
No description available
initiated_move (GESTimelineElement) –
No description available

GESContainer

GObject
    ╰──GInitiallyUnowned
        ╰──GESTimelineElement
            ╰──GESContainer
                ╰──GESClip
                ╰──GESGroup

The GESContainer base class.

Members

parent (GESTimelineElement) –
No description available
children ([ GESTimelineElement ]) –

A list of TimelineElement controlled by this Container. NOTE: Do not modify.

height (Number) –

The span of priorities this container occupies

children_control_mode (GESChildrenControlMode) –
No description available
initiated_move (GESTimelineElement) –
No description available

Methods

ges_container_add

gboolean
ges_container_add (GESContainer * container,
                   GESTimelineElement * child)

Add the GESTimelineElement to the container.

Parameters:

container

a GESContainer

child

the GESTimelineElement

Returns

TRUE on success, FALSE on failure.


GES.Container.add

def GES.Container.add (self, child):
    #python wrapper for 'ges_container_add'

Add the GES.TimelineElement to the container.

Parameters:

container ( GES.Container ) –

a GES.Container

Returns ( bool ) –

True on success, False on failure.


GES.Container.prototype.add

function GES.Container.prototype.add(child: GES.TimelineElement): {
    // javascript wrapper for 'ges_container_add'
}

Add the GES.TimelineElement to the container.

Parameters:

container ( GES.Container ) –

a GES.Container

Returns ( Number ) –

true on success, false on failure.


ges_container_edit

gboolean
ges_container_edit (GESContainer * container,
                    GList * layers,
                    gint new_layer_priority,
                    GESEditMode mode,
                    GESEdge edge,
                    guint64 position)

Edit container in the different exisiting GESEditMode modes. In the case of slide, and roll, you need to specify a GESEdge

Parameters:

container

the GESClip to edit

layers ( [element-type GESLayer] ) –

The layers you want the edit to happen in, NULL means that the edition is done in all the GESLayer contained in the current timeline.

new_layer_priority

The priority of the layer container should land in. If the layer you're trying to move the container to doesn't exist, it will be created automatically. -1 means no move.

mode

The GESEditMode in which the editition will happen.

edge

The GESEdge the edit should happen on.

position

The position at which to edit container (in nanosecond)

Returns

TRUE if the container as been edited properly, FALSE if an error occured

deprecated : 1.18: use #ges_timeline_element_edit instead.


GES.Container.edit

def GES.Container.edit (self, layers, new_layer_priority, mode, edge, position):
    #python wrapper for 'ges_container_edit'

Edit container in the different exisiting GES.EditMode modes. In the case of slide, and roll, you need to specify a GES.Edge

Parameters:

container ( GES.Container ) –

the GES.Clip to edit

layers ( [ GES.Layer ] ) –

The layers you want the edit to happen in, None means that the edition is done in all the GES.Layer contained in the current timeline.

new_layer_priority ( int ) –

The priority of the layer container should land in. If the layer you're trying to move the container to doesn't exist, it will be created automatically. -1 means no move.

mode ( GES.EditMode ) –

The GES.EditMode in which the editition will happen.

edge ( GES.Edge ) –

The GES.Edge the edit should happen on.

position ( int ) –

The position at which to edit container (in nanosecond)

Returns ( bool ) –

True if the container as been edited properly, False if an error occured

deprecated : 1.18: use #ges_timeline_element_edit instead.


GES.Container.prototype.edit

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

Edit container in the different exisiting GES.EditMode modes. In the case of slide, and roll, you need to specify a GES.Edge

Parameters:

container ( GES.Container ) –

the GES.Clip to edit

layers ( [ GES.Layer ] ) –

The layers you want the edit to happen in, null means that the edition is done in all the GES.Layer contained in the current timeline.

new_layer_priority ( Number ) –

The priority of the layer container should land in. If the layer you're trying to move the container to doesn't exist, it will be created automatically. -1 means no move.

mode ( GES.EditMode ) –

The GES.EditMode in which the editition will happen.

edge ( GES.Edge ) –

The GES.Edge the edit should happen on.

position ( Number ) –

The position at which to edit container (in nanosecond)

Returns ( Number ) –

true if the container as been edited properly, false if an error occured

deprecated : 1.18: use #ges_timeline_element_edit instead.


ges_container_get_children

GList *
ges_container_get_children (GESContainer * container,
                            gboolean recursive)

Get the list of GESTimelineElement contained in container The user is responsible for unreffing the contained objects and freeing the list.

Parameters:

container

a GESContainer

recursive

Whether to recursively get children in container

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

The list of timeline element contained in container.


GES.Container.get_children

def GES.Container.get_children (self, recursive):
    #python wrapper for 'ges_container_get_children'

Get the list of GES.TimelineElement contained in container The user is responsible for unreffing the contained objects and freeing the list.

Parameters:

container ( GES.Container ) –

a GES.Container

recursive ( bool ) –

Whether to recursively get children in container

Returns ( [ GES.TimelineElement ] ) –

The list of timeline element contained in container.


GES.Container.prototype.get_children

function GES.Container.prototype.get_children(recursive: Number): {
    // javascript wrapper for 'ges_container_get_children'
}

Get the list of GES.TimelineElement contained in container The user is responsible for unreffing the contained objects and freeing the list.

Parameters:

container ( GES.Container ) –

a GES.Container

recursive ( Number ) –

Whether to recursively get children in container

Returns ( [ GES.TimelineElement ] ) –

The list of timeline element contained in container.


ges_container_remove

gboolean
ges_container_remove (GESContainer * container,
                      GESTimelineElement * child)

Release the child from the control of container.

Parameters:

container

a GESContainer

child

the GESTimelineElement to release

Returns

TRUE if the child was properly released, else FALSE.


GES.Container.remove

def GES.Container.remove (self, child):
    #python wrapper for 'ges_container_remove'

Release the child from the control of container.

Parameters:

container ( GES.Container ) –

a GES.Container

child ( GES.TimelineElement ) –

the GES.TimelineElement to release

Returns ( bool ) –

True if the child was properly released, else False.


GES.Container.prototype.remove

function GES.Container.prototype.remove(child: GES.TimelineElement): {
    // javascript wrapper for 'ges_container_remove'
}

Release the child from the control of container.

Parameters:

container ( GES.Container ) –

a GES.Container

child ( GES.TimelineElement ) –

the GES.TimelineElement to release

Returns ( Number ) –

true if the child was properly released, else false.


ges_container_ungroup

GList *
ges_container_ungroup (GESContainer * container,
                       gboolean recursive)

Ungroups the GESTimelineElement contained in this GESContainer, creating new GESContainer containing those GESTimelineElement apropriately.

Parameters:

container ( [transfer: full] ) –

The GESContainer to ungroup

recursive

Wether to recursively ungroup container

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

The list of GESContainer resulting from the ungrouping operation The user is responsible for unreffing the contained objects and freeing the list.


GES.Container.ungroup

def GES.Container.ungroup (self, recursive):
    #python wrapper for 'ges_container_ungroup'

Ungroups the GES.TimelineElement contained in this GESContainer, creating new GES.Container containing those GES.TimelineElement apropriately.

Parameters:

container ( GES.Container ) –

The GES.Container to ungroup

recursive ( bool ) –

Wether to recursively ungroup container

Returns ( [ GES.Container ] ) –

The list of GES.Container resulting from the ungrouping operation The user is responsible for unreffing the contained objects and freeing the list.


GES.Container.prototype.ungroup

function GES.Container.prototype.ungroup(recursive: Number): {
    // javascript wrapper for 'ges_container_ungroup'
}

Ungroups the GES.TimelineElement contained in this GESContainer, creating new GES.Container containing those GES.TimelineElement apropriately.

Parameters:

container ( GES.Container ) –

The GES.Container to ungroup

recursive ( Number ) –

Wether to recursively ungroup container

Returns ( [ GES.Container ] ) –

The list of GES.Container resulting from the ungrouping operation The user is responsible for unreffing the contained objects and freeing the list.


Functions

ges_container_group

GESContainer *
ges_container_group (GList * containers)

Groups the GESContainer-s provided in containers. It creates a subclass of GESContainer, depending on the containers provided in containers. Basically, if all the containers in containers should be contained in a same clip (all the GESTrackElement they contain have the exact same start/inpoint/duration and are in the same layer), it will create a GESClip otherwise a GESGroup will be created

Parameters:

containers ( [transfer: none] [element-type GESContainer] [allow-none] ) –

The GESContainer to group, they must all be in a same GESTimeline

Returns ( [transfer: none] ) –

The GESContainer (subclass) resulting of the grouping


GES.Container.group

def GES.Container.group (containers):
    #python wrapper for 'ges_container_group'

Groups the GES.Container-s provided in containers. It creates a subclass of GES.Container, depending on the containers provided in containers. Basically, if all the containers in containers should be contained in a same clip (all the GES.TrackElement they contain have the exact same start/inpoint/duration and are in the same layer), it will create a GES.Clip otherwise a GES.Group will be created

Parameters:

containers ( [ GES.Container ] ) –

The GES.Container to group, they must all be in a same GES.Timeline

Returns ( GES.Container ) –

The GES.Container (subclass) resulting of the grouping


GES.Container.prototype.group

function GES.Container.prototype.group(containers: [ GES.Container ]): {
    // javascript wrapper for 'ges_container_group'
}

Groups the GES.Container-s provided in containers. It creates a subclass of GES.Container, depending on the containers provided in containers. Basically, if all the containers in containers should be contained in a same clip (all the GES.TrackElement they contain have the exact same start/inpoint/duration and are in the same layer), it will create a GES.Clip otherwise a GES.Group will be created

Parameters:

containers ( [ GES.Container ] ) –

The GES.Container to group, they must all be in a same GES.Timeline

Returns ( GES.Container ) –

The GES.Container (subclass) resulting of the grouping


Signals

child-added

child_added_callback (GESContainer * self,
                      GESTimelineElement * element,
                      gpointer user_data)

Will be emitted after a child was added to container. Usually you should connect with g_signal_connect_after as in the first emission stage, the signal emission might get stopped internally.

Parameters:

self
No description available
element

the GESTimelineElement that was added.

user_data
No description available

Flags: Run First


child-added

def child_added_callback (self, element, *user_data):
    #python callback for the 'child-added' signal

Will be emitted after a child was added to container. Usually you should connect with g_signal_connect_after (not introspectable) as in the first emission stage, the signal emission might get stopped internally.

Parameters:

self ( GES.Container ) –
No description available
element ( GES.TimelineElement ) –

the GES.TimelineElement that was added.

user_data ( variadic ) –
No description available

Flags: Run First


child-added

function child_added_callback(self: GES.Container, element: GES.TimelineElement, user_data: Object): {
    // javascript callback for the 'child-added' signal
}

Will be emitted after a child was added to container. Usually you should connect with g_signal_connect_after (not introspectable) as in the first emission stage, the signal emission might get stopped internally.

Parameters:

self ( GES.Container ) –
No description available
element ( GES.TimelineElement ) –

the GES.TimelineElement that was added.

user_data ( Object ) –
No description available

Flags: Run First


child-removed

child_removed_callback (GESContainer * self,
                        GESTimelineElement * element,
                        gpointer user_data)

Will be emitted after a child was removed from container.

Parameters:

self
No description available
element

the GESTimelineElement that was removed.

user_data
No description available

Flags: Run Last


child-removed

def child_removed_callback (self, element, *user_data):
    #python callback for the 'child-removed' signal

Will be emitted after a child was removed from container.

Parameters:

self ( GES.Container ) –
No description available
element ( GES.TimelineElement ) –

the GES.TimelineElement that was removed.

user_data ( variadic ) –
No description available

Flags: Run Last


child-removed

function child_removed_callback(self: GES.Container, element: GES.TimelineElement, user_data: Object): {
    // javascript callback for the 'child-removed' signal
}

Will be emitted after a child was removed from container.

Parameters:

self ( GES.Container ) –
No description available
element ( GES.TimelineElement ) –

the GES.TimelineElement that was removed.

user_data ( Object ) –
No description available

Flags: Run Last


Properties

height

“height” guint

The span of priorities which this container occupies.

Flags : Read


height

“self.props.height” int

The span of priorities which this container occupies.

Flags : Read


height

“height” Number

The span of priorities which this container occupies.

Flags : Read


Virtual Methods

add_child

gboolean
add_child (GESContainer * container,
           GESTimelineElement * element)

Virtual method to add a child

Parameters:

container
No description available
element
No description available
Returns
No description available

do_add_child

def do_add_child (container, element):
    #python implementation of the 'add_child' virtual method

Virtual method to add a child

Parameters:

container ( GES.Container ) –
No description available
element ( GES.TimelineElement ) –
No description available
Returns ( bool ) –
No description available

vfunc_add_child

function vfunc_add_child(container: GES.Container, element: GES.TimelineElement): {
    // javascript implementation of the 'add_child' virtual method
}

Virtual method to add a child

Parameters:

container ( GES.Container ) –
No description available
element ( GES.TimelineElement ) –
No description available
Returns ( Number ) –
No description available

child_added

child_added (GESContainer * container,
             GESTimelineElement * element)

Virtual method that is called right after a GESTimelineElement is added

Parameters:

container
No description available
element
No description available

do_child_added

def do_child_added (container, element):
    #python implementation of the 'child_added' virtual method

Virtual method that is called right after a GES.TimelineElement is added

Parameters:

container ( GES.Container ) –
No description available
element ( GES.TimelineElement ) –
No description available

vfunc_child_added

function vfunc_child_added(container: GES.Container, element: GES.TimelineElement): {
    // javascript implementation of the 'child_added' virtual method
}

Virtual method that is called right after a GES.TimelineElement is added

Parameters:

container ( GES.Container ) –
No description available
element ( GES.TimelineElement ) –
No description available

child_removed

child_removed (GESContainer * container,
               GESTimelineElement * element)

Virtual method that is called right after a GESTimelineElement is removed

Parameters:

container
No description available
element
No description available

do_child_removed

def do_child_removed (container, element):
    #python implementation of the 'child_removed' virtual method

Virtual method that is called right after a GES.TimelineElement is removed

Parameters:

container ( GES.Container ) –
No description available
element ( GES.TimelineElement ) –
No description available

vfunc_child_removed

function vfunc_child_removed(container: GES.Container, element: GES.TimelineElement): {
    // javascript implementation of the 'child_removed' virtual method
}

Virtual method that is called right after a GES.TimelineElement is removed

Parameters:

container ( GES.Container ) –
No description available
element ( GES.TimelineElement ) –
No description available

edit

gboolean
edit (GESContainer * container,
      GList * layers,
      gint new_layer_priority,
      GESEditMode mode,
      GESEdge edge,
      guint64 position)

Parameters:

container
No description available
layers
No description available
new_layer_priority
No description available
mode
No description available
edge
No description available
position
No description available
Returns
No description available

do_edit

def do_edit (container, layers, new_layer_priority, mode, edge, position):
    #python implementation of the 'edit' virtual method

Parameters:

container ( GES.Container ) –
No description available
layers ( [ GES.Layer ] ) –
No description available
new_layer_priority ( int ) –
No description available
mode ( GES.EditMode ) –
No description available
edge ( GES.Edge ) –
No description available
position ( int ) –
No description available
Returns ( bool ) –
No description available

vfunc_edit

function vfunc_edit(container: GES.Container, layers: [ GES.Layer ], new_layer_priority: Number, mode: GES.EditMode, edge: GES.Edge, position: Number): {
    // javascript implementation of the 'edit' virtual method
}

Parameters:

container ( GES.Container ) –
No description available
layers ( [ GES.Layer ] ) –
No description available
new_layer_priority ( Number ) –
No description available
mode ( GES.EditMode ) –
No description available
edge ( GES.Edge ) –
No description available
position ( Number ) –
No description available
Returns ( Number ) –
No description available

remove_child

gboolean
remove_child (GESContainer * container,
              GESTimelineElement * element)

Virtual method to remove a child

Parameters:

container
No description available
element
No description available
Returns
No description available

do_remove_child

def do_remove_child (container, element):
    #python implementation of the 'remove_child' virtual method

Virtual method to remove a child

Parameters:

container ( GES.Container ) –
No description available
element ( GES.TimelineElement ) –
No description available
Returns ( bool ) –
No description available

vfunc_remove_child

function vfunc_remove_child(container: GES.Container, element: GES.TimelineElement): {
    // javascript implementation of the 'remove_child' virtual method
}

Virtual method to remove a child

Parameters:

container ( GES.Container ) –
No description available
element ( GES.TimelineElement ) –
No description available
Returns ( Number ) –
No description available

ungroup

GList *
ungroup (GESContainer * container,
         gboolean recursive)

Ungroups the GESTimelineElement contained in this GESContainer, creating new

Parameters:

container
No description available
recursive
No description available
Returns
No description available

do_ungroup

def do_ungroup (container, recursive):
    #python implementation of the 'ungroup' virtual method

Ungroups the GES.TimelineElement contained in this GES.Container, creating new

Parameters:

container ( GES.Container ) –
No description available
recursive ( bool ) –
No description available
Returns ( [ GES.Container ] ) –
No description available

vfunc_ungroup

function vfunc_ungroup(container: GES.Container, recursive: Number): {
    // javascript implementation of the 'ungroup' virtual method
}

Ungroups the GES.TimelineElement contained in this GES.Container, creating new

Parameters:

container ( GES.Container ) –
No description available
recursive ( Number ) –
No description available
Returns ( [ GES.Container ] ) –
No description available

Function Macros

GES_CONTAINER_CHILDREN

#define GES_CONTAINER_CHILDREN(obj) (((GESContainer*)obj)->children)

A GList containing the children of object

Parameters:

obj

a GESContainer


GES_CONTAINER_HEIGHT

#define GES_CONTAINER_HEIGHT(obj) (((GESContainer*)obj)->height)

The span of priorities this object occupies.

Parameters:

obj

a GESContainer


Enumerations

GESChildrenControlMode

Members

GES_CHILDREN_UPDATE (0) –
No description available
GES_CHILDREN_IGNORE_NOTIFIES (1) –
No description available
GES_CHILDREN_UPDATE_OFFSETS (2) –
No description available
GES_CHILDREN_UPDATE_ALL_VALUES (3) –
No description available
GES_CHILDREN_LAST (4) –
No description available

GES.ChildrenControlMode

Members

GES.ChildrenControlMode.UPDATE (0) –
No description available
GES.ChildrenControlMode.IGNORE_NOTIFIES (1) –
No description available
GES.ChildrenControlMode.UPDATE_OFFSETS (2) –
No description available
GES.ChildrenControlMode.UPDATE_ALL_VALUES (3) –
No description available
GES.ChildrenControlMode.LAST (4) –
No description available

GES.ChildrenControlMode

Members

GES.ChildrenControlMode.UPDATE (0) –
No description available
GES.ChildrenControlMode.IGNORE_NOTIFIES (1) –
No description available
GES.ChildrenControlMode.UPDATE_OFFSETS (2) –
No description available
GES.ChildrenControlMode.UPDATE_ALL_VALUES (3) –
No description available
GES.ChildrenControlMode.LAST (4) –
No description available

Constants

GES_TYPE_CONTAINER

#define GES_TYPE_CONTAINER             ges_container_get_type()

The results of the search are