GStreamer Base Plugins 1.0 Plugins Reference Manual: textoverlay

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

## Properties

gint | deltax | Read / Write
gint | deltay | Read / Write
gchar * | font-desc | Write
gchar * | halign | Write
gboolean | shaded-background | Read / Write
gchar * | text | Read / Write
gchar * | valign | Write
GstTextOverlayWrapMode | wrap-mode | Read / Write
gint | xpad | Read / Write
gint | ypad | Read / Write
GstTextOverlayHAlign | halignment | Read / Write
GstTextOverlayVAlign | valignment | Read / Write
GstTextOverlayLineAlign | line-alignment | Read / Write
gboolean | silent | Read / Write
gboolean | wait-text | Read / Write
gboolean | auto-resize | Read / Write
gboolean | vertical-render | Read / Write
guint | color | Read / Write
gdouble | xpos | Read / Write
gdouble | ypos | Read / Write

## Types and Values

struct | GstTextOverlay

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── GstObject
                ╰── GstElement
                    ╰── GstBaseTextOverlay
                        ╰── GstTextOverlay

## Description

## Synopsis

### Element Information

plugin | pango
author | David Schleef <ds@schleef.org>, Zeeshan Ali <zeeshan.ali@nokia.com>
class | Filter/Editor/Video

### Element Pads

name | text_sink
direction | sink
presence | always
details | text/x-raw, format=(string){ pango-markup, utf8 }

name | video_sink
direction | sink
presence | always
details | video/x-raw, format=(string){ BGRx, RGBx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, I420, YV12, AYUV, YUY2, UYVY, v308, Y41B, Y42B, Y444, NV12, NV21, A420, YUV9, YVU9, IYU1, GRAY8 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]

name | src
direction | source
presence | always
details | video/x-raw, format=(string){ BGRx, RGBx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, I420, YV12, AYUV, YUY2, UYVY, v308, Y41B, Y42B, Y444, NV12, NV21, A420, YUV9, YVU9, IYU1, GRAY8 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]

## Functions

## Types and Values

### struct GstTextOverlay

    struct GstTextOverlay;

## Property Details

### The `“deltax”` property

      “deltax”                   gint

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

Flags: Read / Write

Default value: 0

### The `“deltay”` property

      “deltay”                   gint

Shift Y position up or down. Unit is pixels.

Flags: Read / Write

Default value: 0

### The `“font-desc”` property

      “font-desc”                gchar *

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

Flags: Write

Default value: ""

### The `“halign”` property

      “halign”                   gchar *

Horizontal alignment of the text (deprecated; use halignment).

Flags: Write

Default value: "center"

### The `“shaded-background”` property

      “shaded-background”        gboolean

Whether to shade the background under the text area.

Flags: Read / Write

Default value: FALSE

### The `“text”` property

      “text”                     gchar *

Text to be display.

Flags: Read / Write

Default value: ""

### The `“valign”` property

      “valign”                   gchar *

Vertical alignment of the text (deprecated; use valignment).

Flags: Write

Default value: "baseline"

### The `“wrap-mode”` property

      “wrap-mode”                GstTextOverlayWrapMode

Whether to wrap the text and if so how.

Flags: Read / Write

Default value: wordchar

### The `“xpad”` property

      “xpad”                     gint

Horizontal paddding when using left/right alignment.

Flags: Read / Write

Allowed values: >= 0

Default value: 25

### The `“ypad”` property

      “ypad”                     gint

Vertical padding when using top/bottom alignment.

Flags: Read / Write

Allowed values: >= 0

Default value: 25

### The `“halignment”` property

      “halignment”               GstTextOverlayHAlign

Horizontal alignment of the text.

Flags: Read / Write

Default value: center

### The `“valignment”` property

      “valignment”               GstTextOverlayVAlign

Vertical alignment of the text.

Flags: Read / Write

Default value: baseline

### The `“line-alignment”` property

      “line-alignment”           GstTextOverlayLineAlign

Alignment of text lines relative to each other.

Flags: Read / Write

Default value: center

### The `“silent”` property

      “silent”                   gboolean

Whether to render the text string.

Flags: Read / Write

Default value: FALSE

### The `“wait-text”` property

      “wait-text”                gboolean

Whether to wait for subtitles.

Flags: Read / Write

Default value: TRUE

### The `“auto-resize”` property

      “auto-resize”              gboolean

Automatically adjust font size to screen-size.

Flags: Read / Write

Default value: TRUE

### The `“vertical-render”` property

      “vertical-render”          gboolean

Vertical Render.

Flags: Read / Write

Default value: FALSE

### The `“color”` property

      “color”                    guint

Color to use for text (big-endian ARGB).

Flags: Read / Write

Default value: 4294967295

### The `“xpos”` property

      “xpos”                     gdouble

Horizontal position when using position alignment.

Flags: Read / Write

Allowed values: [0,1]

Default value: 0.5

### The `“ypos”` property

      “ypos”                     gdouble

Vertical position when using position alignment.

Flags: Read / Write

Allowed values: [0,1]

Default value: 0.5