GES.TextOverlayClip

g GES.OperationClip GES.OperationClip GES.OverlayClip GES.OverlayClip GES.OperationClip->GES.OverlayClip GES.MetaContainer GES.MetaContainer GES.TimelineElement GES.TimelineElement GES.MetaContainer->GES.TimelineElement GES.Container GES.Container GES.Clip GES.Clip GES.Container->GES.Clip 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.TextOverlayClip GES.TextOverlayClip GES.OverlayClip->GES.TextOverlayClip GES.TimelineElement->GES.Container GObject.InitiallyUnowned->GES.TimelineElement GES.Clip->GES.OperationClip GES.Extractable->GES.TimelineElement

Subclasses:None

Methods

Inherited:GES.Clip (13), GES.Container (6), GES.TimelineElement (33), GObject.Object (40), GES.Extractable (3), GES.MetaContainer (37)
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_halign (halign)
  set_text (text)
  set_valign (valign)
  set_xpos (position)
  set_ypos (position)

Properties

Inherited:GES.Clip (2), GES.Container (1), GES.TimelineElement (9)
Name Type Flags Short Description
color int r/w/c The color of the text
font-desc str r/w/c Pango font description of font to be used for rendering. See documentation of pango_font_description_from_string for syntax.
halignment GES.TextHAlign r/w/c Horizontal alignment of the text
text str r/w/c The text to display
valignment GES.TextVAlign r/w/c Vertical alignment of the text
xpos float r/w/c The horizontal position
ypos float r/w/c The vertical position

Fields

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

Class Details

class GES.TextOverlayClip(**kwargs)
Bases:GES.OverlayClip
Abstract:No
Structure:GES.TextOverlayClipClass

Renders text onto the next lower priority stream using textrender.

classmethod new()[source]
Returns:The newly created GES.TextOverlayClip, or None if there was an error.
Return type:GES.TextOverlayClip or None

Creates a new GES.TextOverlayClip

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 used by self.
Return type:str

Get the pango font description used by self.

get_halignment()[source]
Returns:The horizontal aligment used by self.
Return type:GES.TextHAlign

Get the horizontal aligment used by self.

get_text()[source]
Returns:The text currently set on self.
Return type:str

Get the text currently set on self.

get_valignment()[source]
Returns:The vertical aligment used by self.
Return type:GES.TextVAlign

Get the vertical aligment used by self.

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) – the pango font description

Sets the pango font description of the text

set_halign(halign)[source]
Parameters:halign (GES.TextHAlign) – GES.TextHAlign

Sets the horizontal aligment of the text.

set_text(text)[source]
Parameters:text (str) – the text to render. an internal copy of this text will be made.

Sets the text this clip will render.

set_valign(valign)[source]
Parameters:valign (GES.TextVAlign) – GES.TextVAlign

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.

Property Details

GES.TextOverlayClip.props.color
Name:color
Type:int
Default Value:4294967295
Flags:READABLE, WRITABLE, CONSTRUCT

The color of the text

GES.TextOverlayClip.props.font_desc
Name:font-desc
Type:str
Default Value:'Serif 36'
Flags:READABLE, WRITABLE, CONSTRUCT

Pango font description string

GES.TextOverlayClip.props.halignment
Name:halignment
Type:GES.TextHAlign
Default Value:GES.TextHAlign.CENTER
Flags:READABLE, WRITABLE, CONSTRUCT

Horizontal alignment of the text

GES.TextOverlayClip.props.text
Name:text
Type:str
Default Value:''
Flags:READABLE, WRITABLE, CONSTRUCT

The text to diplay

GES.TextOverlayClip.props.valignment
Name:valignment
Type:GES.TextVAlign
Default Value:GES.TextVAlign.BASELINE
Flags:READABLE, WRITABLE, CONSTRUCT

Vertical alignent of the text

GES.TextOverlayClip.props.xpos
Name:xpos
Type:float
Default Value:0.5
Flags:READABLE, WRITABLE, CONSTRUCT

The horizontal position of the text

GES.TextOverlayClip.props.ypos
Name:ypos
Type:float
Default Value:0.5
Flags:READABLE, WRITABLE, CONSTRUCT

The vertical position of the text