cairotextoverlay

cairotextoverlay — Adds text strings on top of a video buffer

Synopsis

                    GstCairoTextOverlay;

Object Hierarchy

  GObject
   +----GstObject
         +----GstElement
               +----GstCairoTextOverlay

Properties

  "deltax"                   gint                  : Write
  "deltay"                   gint                  : Write
  "font-desc"                gchar*                : Write
  "halign"                   gchar*                : Write
  "shaded-background"        gboolean              : Write
  "text"                     gchar*                : Write
  "valign"                   gchar*                : Write
  "xpad"                     gint                  : Write
  "ypad"                     gint                  : Write

Description

cairotextoverlay renders the text on top of the video frames.

Example launch line

gst-launch videotestsrc ! cairotextoverlay text="hello" ! autovideosink

Details

GstCairoTextOverlay

typedef struct _GstCairoTextOverlay GstCairoTextOverlay;

Property Details

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"                gchar*                : 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"                   gchar*                : 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"                     gchar*                : Write

Text to be display.

Default value: ""


The "valign" property

  "valign"                   gchar*                : Write

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

Default value: "baseline"


The "xpad" property

  "xpad"                     gint                  : Write

Horizontal paddding when using left/right alignment.

Default value: 25


The "ypad" property

  "ypad"                     gint                  : Write

Vertical padding when using top/bottom alignment.

Default value: 25