GES.Container

g GES.MetaContainer GES.MetaContainer GES.TimelineElement GES.TimelineElement GES.MetaContainer->GES.TimelineElement GES.Container GES.Container GObject.GInterface GObject.GInterface GObject.GInterface->GES.MetaContainer GES.Extractable GES.Extractable GObject.GInterface->GES.Extractable GObject.Object GObject.Object GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.Object->GObject.InitiallyUnowned GES.TimelineElement->GES.Container GObject.InitiallyUnowned->GES.TimelineElement GES.Extractable->GES.TimelineElement

Subclasses:GES.Clip, GES.Group

Methods

Inherited:GES.TimelineElement (33), GObject.Object (40), GES.Extractable (3), GES.MetaContainer (37)
Structs:GObject.ObjectClass (5)
class group (containers)
  add (child)
  edit (layers, new_layer_priority, mode, edge, position)
  get_children (recursive)
  remove (child)
  ungroup (recursive)

Virtual Methods

Inherited:GES.TimelineElement (14), GObject.Object (7), GES.Extractable (3)
  do_add_child (element)
  do_child_added (element)
  do_child_removed (element)
  do_edit (layers, new_layer_priority, mode, edge, position)
  do_remove_child (element)
  do_ungroup (recursive)

Properties

Inherited:GES.TimelineElement (9)
Name Type Flags Short Description
height int r The span of priorities this container occupies

Signals

Inherited:GES.TimelineElement (1), GObject.Object (1), GES.MetaContainer (1)
Name Short Description
child-added Will be emitted after a child was added to container.
child-removed Will be emitted after a child was removed from container.

Fields

Inherited:GES.TimelineElement (1), GObject.Object (1), GES.MetaContainer (1)
Name Type Access Description
children [GES.TimelineElement] r A list of TimelineElement controlled by this Container. NOTE: Do not modify.
children_control_mode GES.ChildrenControlMode r  
height int r The span of priorities this container occupies
initiated_move GES.TimelineElement r  
parent GES.TimelineElement r  

Class Details

class GES.Container(**kwargs)
Bases:GES.TimelineElement
Abstract:Yes
Structure:GES.ContainerClass

The GES.Container base class.

classmethod group(containers)[source]
Parameters:containers ([GES.Container] or None) – The GES.Container to group, they must all be in a same GES.Timeline
Returns:The GES.Container (subclass) resulting of the grouping
Return type:GES.Container

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

add(child)[source]
Parameters:child (GES.TimelineElement) – the GES.TimelineElement
Returns:True on success, False on failure.
Return type:bool

Add the GES.TimelineElement to the container.

edit(layers, new_layer_priority, mode, edge, position)[source]
Parameters:
  • layers ([GES.Layer]) – The layers you want the edit to happen in, None means that the edition is done in all the GES.Layers contained in the current timeline.
  • new_layer_priority (int) – The priority of the layer self 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 self (in nanosecond)
Returns:

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

Return type:

bool

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

get_children(recursive)[source]
Parameters:recursive (bool) – Whether to recursively get children in self
Returns:The list of timeline element contained in self.
Return type:[GES.TimelineElement]

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

remove(child)[source]
Parameters:child (GES.TimelineElement) – the GES.TimelineElement to release
Returns:True if the child was properly released, else False.
Return type:bool

Release the child from the control of self.

ungroup(recursive)[source]
Parameters:recursive (bool) – Wether to recursively ungroup self
Returns:The list of GES.Container resulting from the ungrouping operation The user is responsible for unreffing the contained objects and freeing the list.
Return type:[GES.Container]

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

do_add_child(element) virtual
Parameters:element (GES.TimelineElement) –
Return type:bool
do_child_added(element) virtual
Parameters:element (GES.TimelineElement) –
do_child_removed(element) virtual
Parameters:element (GES.TimelineElement) –
do_edit(layers, new_layer_priority, mode, edge, position) virtual
Parameters:
  • layers ([GES.Layer]) – The layers you want the edit to happen in, None means that the edition is done in all the GES.Layers 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:

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

Return type:

bool

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

do_remove_child(element) virtual
Parameters:element (GES.TimelineElement) –
Return type:bool
do_ungroup(recursive) virtual
Parameters:recursive (bool) – Wether to recursively ungroup container
Returns:The list of GES.Container resulting from the ungrouping operation The user is responsible for unreffing the contained objects and freeing the list.
Return type:[GES.Container]

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

Signal Details

GES.Container.signals.child_added(container, element)
Signal Name:

child-added

Flags:

RUN_FIRST

Parameters:

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.

GES.Container.signals.child_removed(container, element)
Signal Name:

child-removed

Flags:

RUN_FIRST

Parameters:

Will be emitted after a child was removed from container.

Property Details

GES.Container.props.height
Name:height
Type:int
Default Value:1
Flags:READABLE

The span of priorities which this container occupies.