textoverlay

textoverlay — Adds text strings on top of a video buffer

Synopsis

struct              GstTextOverlay;

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GstObject
               +----GstElement
                     +----GstBaseTextOverlay
                           +----GstTextOverlay

Properties

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

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 ]

Details

struct GstTextOverlay

struct GstTextOverlay;

Property Details

The "deltax" property

  "deltax"                   gint                  : Read / Write

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

Default value: 0


The "deltay" property

  "deltay"                   gint                  : Read / 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 (deprecated; use halignment).

Default value: "center"


The "shaded-background" property

  "shaded-background"        gboolean              : Read / Write

Whether to shade the background under the text area.

Default value: FALSE


The "text" property

  "text"                     gchar*                : Read / Write

Text to be display.

Default value: ""


The "valign" property

  "valign"                   gchar*                : Write

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

Default value: "baseline"


The "wrap-mode" property

  "wrap-mode"                GstTextOverlayWrapMode  : Read / Write

Whether to wrap the text and if so how.

Default value: wordchar


The "xpad" property

  "xpad"                     gint                  : Read / Write

Horizontal paddding when using left/right alignment.

Allowed values: >= 0

Default value: 25


The "ypad" property

  "ypad"                     gint                  : Read / Write

Vertical padding when using top/bottom alignment.

Allowed values: >= 0

Default value: 25


The "halignment" property

  "halignment"               GstTextOverlayHAlign  : Read / Write

Horizontal alignment of the text.

Default value: center


The "valignment" property

  "valignment"               GstTextOverlayVAlign  : Read / Write

Vertical alignment of the text.

Default value: baseline


The "line-alignment" property

  "line-alignment"           GstTextOverlayLineAlign  : Read / Write

Alignment of text lines relative to each other.

Default value: center


The "silent" property

  "silent"                   gboolean              : Read / Write

Whether to render the text string.

Default value: FALSE


The "wait-text" property

  "wait-text"                gboolean              : Read / Write

Whether to wait for subtitles.

Default value: TRUE


The "auto-resize" property

  "auto-resize"              gboolean              : Read / Write

Automatically adjust font size to screen-size.

Default value: TRUE


The "vertical-render" property

  "vertical-render"          gboolean              : Read / Write

Vertical Render.

Default value: FALSE


The "color" property

  "color"                    guint                 : Read / Write

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

Default value: 4294967295


The "xpos" property

  "xpos"                     gdouble               : Read / Write

Horizontal position when using position alignment.

Allowed values: [0,1]

Default value: 0.5


The "ypos" property

  "ypos"                     gdouble               : Read / Write

Vertical position when using position alignment.

Allowed values: [0,1]

Default value: 0.5