GES.Group

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

Subclasses:None

Fields

Inherited:GES.Container (2), GES.TimelineElement (3), GObject.Object (1), GES.MetaContainer (1)
Name Type Access Description
parent GES.Container r  

Class Details

class GES.Group(**kwargs)
Bases:GES.Container
Abstract:No
Structure:GES.GroupClass

A GES.Group controls one or more GES.Container-s (usually GES.Clip-s, but it can also control other GES.Group-s). Its children must share the same GES.Timeline, but can otherwise lie in separate GES.Layer-s and have different timings.

To initialise a group, you may want to use GES.Container.group(), and similarly use GES.Container.ungroup() to dispose of it.

A group will maintain the relative GES.TimelineElement :start times of its children, as well as their relative layer GES.Layer :priority. Therefore, if one of its children has its GES.TimelineElement :start set, all other children will have their GES.TimelineElement :start shifted by the same amount. Similarly, if one of its children moves to a new layer, the other children will also change layers to maintain the difference in their layer priorities. For example, if a child moves from a layer with GES.Layer :priority 1 to a layer with priority 3, then another child that was in a layer with priority 0 will move to the layer with priority 2.

The GES.Group :start of a group refers to the earliest start time of its children. If the group’s GES.Group :start is set, all the children will be shifted equally such that the earliest start time will match the set value. The GES.Group :duration of a group is the difference between the earliest start time and latest end time of its children. If the group’s GES.Group :duration is increased, the children whose end time matches the end of the group will be extended accordingly. If it is decreased, then any child whose end time exceeds the new end time will also have their duration decreased accordingly.

A group may span several layers, but for methods such as GES.TimelineElement.get_layer_priority() and GES.TimelineElement.edit() a group is considered to have a layer priority that is the highest GES.Layer :priority (numerically, the smallest) of all the layers it spans.

classmethod new()[source]
Returns:The new empty group.
Return type:GES.Group

Created a new empty group. You may wish to use GES.Container.group() instead, which can return a different GES.Container subclass if possible.