GES.MarkerList

g GES.MarkerList GES.MarkerList GObject.Object GObject.Object GObject.Object->GES.MarkerList

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new ()

add (position)

get_markers ()

move (marker, position)

remove (marker)

size ()

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name

Type

Flags

Short Description

flags

GES.MarkerFlags

r/w/c

Functionalities the marker list should be used for

Signals

Inherited:

GObject.Object (1)

Name

Short Description

marker-added

Will be emitted after the marker was added to the marker-list.

marker-moved

Will be emitted after the marker was moved to.

marker-removed

Will be emitted after the marker was removed the marker-list.

Fields

Inherited:

GObject.Object (1)

Class Details

class GES.MarkerList(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

GES.MarkerListClass

A GES.Marker can be colored by setting the GES.META_MARKER_COLOR meta.

New in version 1.18.

classmethod new()[source]
Returns:

A new GES.MarkerList

Return type:

GES.MarkerList

Creates a new GES.MarkerList.

New in version 1.18.

add(position)[source]
Parameters:

position (int) – The position of the new marker

Returns:

The newly-added marker, the list keeps ownership of the marker

Return type:

GES.Marker

New in version 1.18.

get_markers()[source]
Returns:

a GLib.List of the GES.Marker within the GES.MarkerList. The user will have to unref each GES.Marker and free the GLib.List.

Return type:

[GES.Marker]

New in version 1.18.

move(marker, position)[source]
Parameters:
Returns:

True if the marker could be moved, False otherwise (if the marker was not present in the list for example)

Return type:

bool

Moves a marker in a self to a new position

New in version 1.18.

remove(marker)[source]
Parameters:

marker (GES.Marker) –

Returns:

True if the marker could be removed, False otherwise (if the marker was not present in the list for example)

Return type:

bool

Removes marker from self, this decreases the refcount of the marker by 1.

New in version 1.18.

size()[source]
Returns:

The number of markers in self

Return type:

int

New in version 1.18.

Signal Details

GES.MarkerList.signals.marker_added(marker_list, position, marker)
Signal Name:

marker-added

Flags:

RUN_FIRST

Parameters:

Will be emitted after the marker was added to the marker-list.

New in version 1.18.

GES.MarkerList.signals.marker_moved(marker_list, previous_position, new_position, marker)
Signal Name:

marker-moved

Flags:

RUN_FIRST

Parameters:
  • marker_list (GES.MarkerList) – The object which received the signal

  • previous_position (int) – the previous position of the marker

  • new_position (int) – the new position of the marker

  • marker (GES.Marker) – the GES.Marker that was moved.

Will be emitted after the marker was moved to.

New in version 1.18.

GES.MarkerList.signals.marker_removed(marker_list, marker)
Signal Name:

marker-removed

Flags:

RUN_FIRST

Parameters:

Will be emitted after the marker was removed the marker-list.

New in version 1.18.

Property Details

GES.MarkerList.props.flags
Name:

flags

Type:

GES.MarkerFlags

Default Value:

GES.MarkerFlags.NONE

Flags:

READABLE, WRITABLE, CONSTRUCT

Flags indicating how markers on the list should be treated.

New in version 1.20.