textoverlay

textoverlay — Adds text strings on top of a video buffer

Synopsis




            GstTextOverlay;

Object Hierarchy


  GObject
   +----GstObject
         +----GstElement
               +----GstTextOverlay
                     +----GstTimeOverlay
                     +----GstClockOverlay

Properties


  "deltax"               gint                  : Write
  "deltay"               gint                  : Write
  "font-desc"            gchararray            : Write
  "halign"               gchararray            : Write
  "shaded-background"    gboolean              : Write
  "text"                 gchararray            : Write
  "valign"               gchararray            : Write
  "wrap-mode"            gchararray            : Write
  "xpad"                 gint                  : Write
  "ypad"                 gint                  : Write

Description

Element Information

plugin pango
authorDavid Schleef <ds@schleef.org>
classFilter/Editor/Video

Details

GstTextOverlay

typedef struct _GstTextOverlay GstTextOverlay;

Properties

The "deltax" property

  "deltax"               gint                  : Write

Shift X position to the left or to the right. Unit is pixels.

Default value: 0


The "deltay" property

  "deltay"               gint                  : Write

Shift Y position up or down. Unit is pixels.

Default value: 0


The "font-desc" property

  "font-desc"            gchararray            : Write

Pango font description of font to be used for rendering. See documentation of pango_font_description_from_string for syntax.

Default value: ""


The "halign" property

  "halign"               gchararray            : Write

Horizontal alignment of the text. Can be either 'left', 'right', or 'center'.

Default value: "center"


The "shaded-background" property

  "shaded-background"    gboolean              : Write

Whether to shade the background under the text area.

Default value: FALSE


The "text" property

  "text"                 gchararray            : Write

Text to be display.

Default value: ""


The "valign" property

  "valign"               gchararray            : Write

Vertical alignment of the text. Can be either 'baseline', 'bottom', or 'top'.

Default value: "baseline"


The "wrap-mode" property

  "wrap-mode"            gchararray            : Write

Whether to wrap the text and if so how.Can be either 'none', 'word', 'char' or 'wordchar'.

Default value: "wordchar"


The "xpad" property

  "xpad"                 gint                  : Write

Horizontal paddding when using left/right alignment.

Allowed values: >= 0

Default value: 25


The "ypad" property

  "ypad"                 gint                  : Write

Vertical padding when using top/bottom alignment.

Allowed values: >= 0

Default value: 25