GES.TextOverlay

g GES.Extractable GES.Extractable GES.TimelineElement GES.TimelineElement GES.Extractable->GES.TimelineElement GES.MetaContainer GES.MetaContainer GES.MetaContainer->GES.TimelineElement GES.Operation GES.Operation GES.TextOverlay GES.TextOverlay GES.Operation->GES.TextOverlay GES.TrackElement GES.TrackElement GES.TimelineElement->GES.TrackElement GES.TrackElement->GES.Operation 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

Methods

Inherited:

GES.TrackElement (22), GES.TimelineElement (38), GObject.Object (37), GES.Extractable (3), GES.MetaContainer (40)

Structs:

GObject.ObjectClass (5)

class

new ()

get_color ()

get_font_desc ()

get_halignment ()

get_text ()

get_valignment ()

get_xpos ()

get_ypos ()

set_color (color)

set_font_desc (font_desc)

set_halignment (halign)

set_text (text)

set_valignment (valign)

set_xpos (position)

set_ypos (position)

Virtual Methods

Inherited:

GES.TrackElement (5), GES.TimelineElement (18), GObject.Object (7), GES.Extractable (3)

Properties

Inherited:

GES.TrackElement (5), GES.TimelineElement (9)

Signals

Inherited:

GES.TrackElement (2), GES.TimelineElement (3), GObject.Object (1), GES.MetaContainer (1)

Fields

Inherited:

GES.TrackElement (2), GES.TimelineElement (3), GObject.Object (1), GES.MetaContainer (1)

Name

Type

Access

Description

parent

GES.Operation

r

Class Details

class GES.TextOverlay(**kwargs)
Bases:

GES.Operation

Abstract:

No

Structure:

GES.TextOverlayClass

classmethod new()[source]
Returns:

The newly created GES.TextOverlay or None if something went wrong.

Return type:

GES.TextOverlay or None

Creates a new GES.TextOverlay.

Deprecated since version 1.18: This should never be called by applications as this will be created by clips.

get_color()[source]
Returns:

The color used by source.

Return type:

int

Get the color used by source.

get_font_desc()[source]
Returns:

The pango font description currently set on source.

Return type:

str or None

Get the pango font description currently set on source.

get_halignment()[source]
Returns:

The horizontal aligment used by source.

Return type:

GES.TextHAlign

Get the horizontal aligment used by source.

get_text()[source]
Returns:

The text currently set on source.

Return type:

str or None

Get the text currently set on source.

get_valignment()[source]
Returns:

The vertical aligment used by source.

Return type:

GES.TextVAlign

Get the vertical aligment used by source.

get_xpos()[source]
Returns:

The horizontal position used by source.

Return type:

float

Get the horizontal position used by source.

get_ypos()[source]
Returns:

The vertical position used by source.

Return type:

float

Get the vertical position used by source.

set_color(color)[source]
Parameters:

color (int) – The color self is being set to

Sets the color of the text.

set_font_desc(font_desc)[source]
Parameters:

font_desc (str or None) – the pango font description

Sets the pango font description of the text this track element will render.

set_halignment(halign)[source]
Parameters:

halign (GES.TextHAlign) – The GES.TextHAlign defining the horizontal alignment of the text render by self.

Sets the horizontal aligment of the text.

set_text(text)[source]
Parameters:

text (str or None) – the text to render. an internal copy of this text will be made.

Sets the text this track element will render.

set_valignment(valign)[source]
Parameters:

valign (GES.TextVAlign) – The GES.TextVAlign defining the vertical alignment of the text render by self.

Sets the vertical aligment of the text.

set_xpos(position)[source]
Parameters:

position (float) – The horizontal position self is being set to

Sets the horizontal position of the text.

set_ypos(position)[source]
Parameters:

position (float) – The vertical position self is being set to

Sets the vertical position of the text.