cairotextoverlay

## cairotextoverlay cairotextoverlay — Adds text strings on top of a video buffer |

## Synopsis

    struct              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
      "silent"                   gboolean              : Write

## Description

## Synopsis

### Element Information

plugin | cairo
author | David Schleef <ds@schleef.org>
class | Filter/Editor/Video

### Element Pads

name | text_sink
direction | sink
presence | always
details | text/plain

name | video_sink
direction | sink
presence | always
details | video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]

name | src
direction | source
presence | always
details | video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]

## Details

### struct GstCairoTextOverlay

    struct GstCairoTextOverlay {
        GstElement            element;

        GstPad               *video_sinkpad;
        GstPad               *text_sinkpad;
        GstPad               *srcpad;

        GstCollectPads      *collect;
        GstCollectData      *video_collect_data;
        GstCollectData      *text_collect_data;
        GstPadEventFunction   collect_event;

        gint                  width;
        gint                  height;
        gint                  fps_n;
        gint                  fps_d;

        GstCairoTextOverlayVAlign  valign;
        GstCairoTextOverlayHAlign  halign;
        gint                  xpad;
        gint                  ypad;
        gint                  deltax;
        gint                  deltay;
        gchar                *default_text;
        gboolean              want_shading;

        guchar               *text_fill_image;
        guchar               *text_outline_image;
        gint                  font_height;
        gint                  text_x0, text_x1; /* start/end x position of text */
        gint                  text_dy;

        gboolean              need_render;

        gchar                *font;
        gint                  slant;
        gint                  weight;
        gdouble               scale;
        gboolean              silent;
    };

## 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

### The `"silent"` property

      "silent"                   gboolean              : Write

Whether to render the text string.

Default value: FALSE