docs/plugins/html/gst-plugins-base-plugins-textoverlay.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>textoverlay</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-base Elements">
   9 <link rel="prev" href="gst-plugins-base-plugins-tcpserversink.html" title="tcpserversink">
  10 <link rel="next" href="gst-plugins-base-plugins-textrender.html" title="textrender">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gst-plugins-base-plugins-tcpserversink.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Base Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-plugins-textrender.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-base-plugins-textoverlay.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-textoverlay.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-textoverlay.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-plugins-textoverlay.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-base-plugins-textoverlay"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-textoverlay.top_of_page"></a>textoverlay</span></h2>
  38 <p>textoverlay — Adds text strings on top of a video buffer</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="gst-plugins-base-plugins-textoverlay.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstTextOverlay"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay-struct" title="struct GstTextOverlay">GstTextOverlay</a>;
  45 enum                <a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlayVAlign" title="enum GstTextOverlayVAlign">GstTextOverlayVAlign</a>;
  46 enum                <a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlayHAlign" title="enum GstTextOverlayHAlign">GstTextOverlayHAlign</a>;
  47 enum                <a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlayWrapMode" title="enum GstTextOverlayWrapMode">GstTextOverlayWrapMode</a>;
  48 </pre>
  49 </div>
  50 <div class="refsect1">
  51 <a name="gst-plugins-base-plugins-textoverlay.object-hierarchy"></a><h2>Object Hierarchy</h2>
  52 <pre class="synopsis">
  53   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  54    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  55          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  56                +----GstTextOverlay
  57                      +----<a class="link" href="gst-plugins-base-plugins-clockoverlay.html#GstClockOverlay">GstClockOverlay</a>
  58                      +----<a class="link" href="gst-plugins-base-plugins-timeoverlay.html#GstTimeOverlay">GstTimeOverlay</a>
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="gst-plugins-base-plugins-textoverlay.properties"></a><h2>Properties</h2>
  63 <pre class="synopsis">
  64   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--deltax" title='The "deltax" property'>deltax</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  65   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--deltay" title='The "deltay" property'>deltay</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  66   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--font-desc" title='The "font-desc" property'>font-desc</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write
  67   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--halign" title='The "halign" property'>halign</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write
  68   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--shaded-background" title='The "shaded-background" property'>shaded-background</a>"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  69   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--text" title='The "text" property'>text</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  70   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--valign" title='The "valign" property'>valign</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write
  71   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--wrap-mode" title='The "wrap-mode" property'>wrap-mode</a>"                <a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlayWrapMode" title="enum GstTextOverlayWrapMode"><span class="type">GstTextOverlayWrapMode</span></a>  : Read / Write
  72   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--xpad" title='The "xpad" property'>xpad</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  73   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--ypad" title='The "ypad" property'>ypad</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  74   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--halignment" title='The "halignment" property'>halignment</a>"               <a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlayHAlign" title="enum GstTextOverlayHAlign"><span class="type">GstTextOverlayHAlign</span></a>  : Read / Write
  75   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--valignment" title='The "valignment" property'>valignment</a>"               <a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlayVAlign" title="enum GstTextOverlayVAlign"><span class="type">GstTextOverlayVAlign</span></a>  : Read / Write
  76   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--line-alignment" title='The "line-alignment" property'>line-alignment</a>"           <span class="type">GstTextOverlayLineAlign</span>  : Read / Write
  77   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--silent" title='The "silent" property'>silent</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  78   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--wait-text" title='The "wait-text" property'>wait-text</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  79   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--auto-resize" title='The "auto-resize" property'>auto-resize</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  80   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--vertical-render" title='The "vertical-render" property'>vertical-render</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  81   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--color" title='The "color" property'>color</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  82   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--xpos" title='The "xpos" property'>xpos</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  83   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--ypos" title='The "ypos" property'>ypos</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  84   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--outline-color" title='The "outline-color" property'>outline-color</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  85   "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--shadow" title='The "shadow" property'>shadow</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  86 </pre>
  87 </div>
  88 <div class="refsect1">
  89 <a name="gst-plugins-base-plugins-textoverlay.description"></a><h2>Description</h2>
  90 <div class="refsynopsisdiv">
  91 <h2>Synopsis</h2>
  92 <div class="refsect2">
  93 <a name="idp13778336"></a><h3>Element Information</h3>
  94 <div class="variablelist"><table border="0">
  95 <col align="left" valign="top">
  96 <tbody>
  97 <tr>
  98 <td><p><span class="term">plugin</span></p></td>
  99 <td>
 100             <a class="link" href="gst-plugins-base-plugins-plugin-pango.html#plugin-pango">pango</a>
 101           </td>
 102 </tr>
 103 <tr>
 104 <td><p><span class="term">author</span></p></td>
 105 <td>David Schleef &lt;ds@schleef.org&gt;, Zeeshan Ali &lt;zeeshan.ali@nokia.com&gt;</td>
 106 </tr>
 107 <tr>
 108 <td><p><span class="term">class</span></p></td>
 109 <td>Filter/Editor/Video</td>
 110 </tr>
 111 </tbody>
 112 </table></div>
 113 </div>
 114 <hr>
 115 <div class="refsect2">
 116 <a name="idp12277856"></a><h3>Element Pads</h3>
 117 <div class="variablelist"><table border="0">
 118 <col align="left" valign="top">
 119 <tbody>
 120 <tr>
 121 <td><p><span class="term">name</span></p></td>
 122 <td>text_sink</td>
 123 </tr>
 124 <tr>
 125 <td><p><span class="term">direction</span></p></td>
 126 <td>sink</td>
 127 </tr>
 128 <tr>
 129 <td><p><span class="term">presence</span></p></td>
 130 <td>always</td>
 131 </tr>
 132 <tr>
 133 <td><p><span class="term">details</span></p></td>
 134 <td>text/x-pango-markup</td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term"></span></p></td>
 138 <td> text/plain</td>
 139 </tr>
 140 </tbody>
 141 </table></div>
 142 <div class="variablelist"><table border="0">
 143 <col align="left" valign="top">
 144 <tbody>
 145 <tr>
 146 <td><p><span class="term">name</span></p></td>
 147 <td>video_sink</td>
 148 </tr>
 149 <tr>
 150 <td><p><span class="term">direction</span></p></td>
 151 <td>sink</td>
 152 </tr>
 153 <tr>
 154 <td><p><span class="term">presence</span></p></td>
 155 <td>always</td>
 156 </tr>
 157 <tr>
 158 <td><p><span class="term">details</span></p></td>
 159 <td>video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 160 </tr>
 161 <tr>
 162 <td><p><span class="term"></span></p></td>
 163 <td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 164 </tr>
 165 <tr>
 166 <td><p><span class="term"></span></p></td>
 167 <td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 168 </tr>
 169 <tr>
 170 <td><p><span class="term"></span></p></td>
 171 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 172 </tr>
 173 <tr>
 174 <td><p><span class="term"></span></p></td>
 175 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 176 </tr>
 177 <tr>
 178 <td><p><span class="term"></span></p></td>
 179 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 180 </tr>
 181 <tr>
 182 <td><p><span class="term"></span></p></td>
 183 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 184 </tr>
 185 <tr>
 186 <td><p><span class="term"></span></p></td>
 187 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 188 </tr>
 189 <tr>
 190 <td><p><span class="term"></span></p></td>
 191 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 192 </tr>
 193 <tr>
 194 <td><p><span class="term"></span></p></td>
 195 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 196 </tr>
 197 <tr>
 198 <td><p><span class="term"></span></p></td>
 199 <td> video/x-surface</td>
 200 </tr>
 201 <tr>
 202 <td><p><span class="term"></span></p></td>
 203 <td> video/x-raw-yuv, format=(fourcc){ I420, YV12, AYUV, YUY2, UYVY, v308, v210, v216, Y41B, Y42B, Y444, Y800, Y16 , NV12, NV21, UYVP, A420, YUV9, IYU1 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 204 </tr>
 205 </tbody>
 206 </table></div>
 207 <div class="variablelist"><table border="0">
 208 <col align="left" valign="top">
 209 <tbody>
 210 <tr>
 211 <td><p><span class="term">name</span></p></td>
 212 <td>src</td>
 213 </tr>
 214 <tr>
 215 <td><p><span class="term">direction</span></p></td>
 216 <td>source</td>
 217 </tr>
 218 <tr>
 219 <td><p><span class="term">presence</span></p></td>
 220 <td>always</td>
 221 </tr>
 222 <tr>
 223 <td><p><span class="term">details</span></p></td>
 224 <td>video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 225 </tr>
 226 <tr>
 227 <td><p><span class="term"></span></p></td>
 228 <td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 229 </tr>
 230 <tr>
 231 <td><p><span class="term"></span></p></td>
 232 <td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 233 </tr>
 234 <tr>
 235 <td><p><span class="term"></span></p></td>
 236 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 237 </tr>
 238 <tr>
 239 <td><p><span class="term"></span></p></td>
 240 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 241 </tr>
 242 <tr>
 243 <td><p><span class="term"></span></p></td>
 244 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 245 </tr>
 246 <tr>
 247 <td><p><span class="term"></span></p></td>
 248 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 249 </tr>
 250 <tr>
 251 <td><p><span class="term"></span></p></td>
 252 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 253 </tr>
 254 <tr>
 255 <td><p><span class="term"></span></p></td>
 256 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 257 </tr>
 258 <tr>
 259 <td><p><span class="term"></span></p></td>
 260 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 261 </tr>
 262 <tr>
 263 <td><p><span class="term"></span></p></td>
 264 <td> video/x-surface</td>
 265 </tr>
 266 <tr>
 267 <td><p><span class="term"></span></p></td>
 268 <td> video/x-raw-yuv, format=(fourcc){ I420, YV12, AYUV, YUY2, UYVY, v308, v210, v216, Y41B, Y42B, Y444, Y800, Y16 , NV12, NV21, UYVP, A420, YUV9, IYU1 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 269 </tr>
 270 </tbody>
 271 </table></div>
 272 </div>
 273 </div>
 274 <p>
 275 </p>
 276 </div>
 277 <div class="refsect1">
 278 <a name="gst-plugins-base-plugins-textoverlay.details"></a><h2>Details</h2>
 279 <div class="refsect2">
 280 <a name="GstTextOverlay-struct"></a><h3>struct GstTextOverlay</h3>
 281 <pre class="programlisting">struct GstTextOverlay;</pre>
 282 <p>
 283 </p>
 284 </div>
 285 <hr>
 286 <div class="refsect2">
 287 <a name="GstTextOverlayVAlign"></a><h3>enum GstTextOverlayVAlign</h3>
 288 <pre class="programlisting">typedef enum {
 289     GST_TEXT_OVERLAY_VALIGN_BASELINE,
 290     GST_TEXT_OVERLAY_VALIGN_BOTTOM,
 291     GST_TEXT_OVERLAY_VALIGN_TOP,
 292     GST_TEXT_OVERLAY_VALIGN_POS,
 293     GST_TEXT_OVERLAY_VALIGN_CENTER
 294 } GstTextOverlayVAlign;
 295 </pre>
 296 <p>
 297 </p>
 298 </div>
 299 <hr>
 300 <div class="refsect2">
 301 <a name="GstTextOverlayHAlign"></a><h3>enum GstTextOverlayHAlign</h3>
 302 <pre class="programlisting">typedef enum {
 303     GST_TEXT_OVERLAY_HALIGN_LEFT,
 304     GST_TEXT_OVERLAY_HALIGN_CENTER,
 305     GST_TEXT_OVERLAY_HALIGN_RIGHT,
 306     GST_TEXT_OVERLAY_HALIGN_UNUSED,
 307     GST_TEXT_OVERLAY_HALIGN_POS
 308 } GstTextOverlayHAlign;
 309 </pre>
 310 <p>
 311 </p>
 312 </div>
 313 <hr>
 314 <div class="refsect2">
 315 <a name="GstTextOverlayWrapMode"></a><h3>enum GstTextOverlayWrapMode</h3>
 316 <pre class="programlisting">typedef enum {
 317     GST_TEXT_OVERLAY_WRAP_MODE_NONE = -1,
 318     GST_TEXT_OVERLAY_WRAP_MODE_WORD = PANGO_WRAP_WORD,
 319     GST_TEXT_OVERLAY_WRAP_MODE_CHAR = PANGO_WRAP_CHAR,
 320     GST_TEXT_OVERLAY_WRAP_MODE_WORD_CHAR = PANGO_WRAP_WORD_CHAR
 321 } GstTextOverlayWrapMode;
 322 </pre>
 323 <p>
 324 </p>
 325 </div>
 326 </div>
 327 <div class="refsect1">
 328 <a name="gst-plugins-base-plugins-textoverlay.property-details"></a><h2>Property Details</h2>
 329 <div class="refsect2">
 330 <a name="GstTextOverlay--deltax"></a><h3>The <code class="literal">"deltax"</code> property</h3>
 331 <pre class="programlisting">  "deltax"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 332 <p>Shift X position to the left or to the right. Unit is pixels.</p>
 333 <p>Default value: 0</p>
 334 </div>
 335 <hr>
 336 <div class="refsect2">
 337 <a name="GstTextOverlay--deltay"></a><h3>The <code class="literal">"deltay"</code> property</h3>
 338 <pre class="programlisting">  "deltay"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 339 <p>Shift Y position up or down. Unit is pixels.</p>
 340 <p>Default value: 0</p>
 341 </div>
 342 <hr>
 343 <div class="refsect2">
 344 <a name="GstTextOverlay--font-desc"></a><h3>The <code class="literal">"font-desc"</code> property</h3>
 345 <pre class="programlisting">  "font-desc"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write</pre>
 346 <p>Pango font description of font to be used for rendering. See documentation of pango_font_description_from_string for syntax.</p>
 347 <p>Default value: ""</p>
 348 </div>
 349 <hr>
 350 <div class="refsect2">
 351 <a name="GstTextOverlay--halign"></a><h3>The <code class="literal">"halign"</code> property</h3>
 352 <pre class="programlisting">  "halign"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write</pre>
 353 <p>Horizontal alignment of the text (deprecated; use halignment).</p>
 354 <p>Default value: "center"</p>
 355 </div>
 356 <hr>
 357 <div class="refsect2">
 358 <a name="GstTextOverlay--shaded-background"></a><h3>The <code class="literal">"shaded-background"</code> property</h3>
 359 <pre class="programlisting">  "shaded-background"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 360 <p>Whether to shade the background under the text area.</p>
 361 <p>Default value: FALSE</p>
 362 </div>
 363 <hr>
 364 <div class="refsect2">
 365 <a name="GstTextOverlay--text"></a><h3>The <code class="literal">"text"</code> property</h3>
 366 <pre class="programlisting">  "text"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 367 <p>Text to be display.</p>
 368 <p>Default value: ""</p>
 369 </div>
 370 <hr>
 371 <div class="refsect2">
 372 <a name="GstTextOverlay--valign"></a><h3>The <code class="literal">"valign"</code> property</h3>
 373 <pre class="programlisting">  "valign"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write</pre>
 374 <p>Vertical alignment of the text (deprecated; use valignment).</p>
 375 <p>Default value: "baseline"</p>
 376 </div>
 377 <hr>
 378 <div class="refsect2">
 379 <a name="GstTextOverlay--wrap-mode"></a><h3>The <code class="literal">"wrap-mode"</code> property</h3>
 380 <pre class="programlisting">  "wrap-mode"                <a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlayWrapMode" title="enum GstTextOverlayWrapMode"><span class="type">GstTextOverlayWrapMode</span></a>  : Read / Write</pre>
 381 <p>Whether to wrap the text and if so how.</p>
 382 <p>Default value: wordchar</p>
 383 </div>
 384 <hr>
 385 <div class="refsect2">
 386 <a name="GstTextOverlay--xpad"></a><h3>The <code class="literal">"xpad"</code> property</h3>
 387 <pre class="programlisting">  "xpad"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 388 <p>Horizontal paddding when using left/right alignment.</p>
 389 <p>Allowed values: &gt;= 0</p>
 390 <p>Default value: 25</p>
 391 </div>
 392 <hr>
 393 <div class="refsect2">
 394 <a name="GstTextOverlay--ypad"></a><h3>The <code class="literal">"ypad"</code> property</h3>
 395 <pre class="programlisting">  "ypad"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 396 <p>Vertical padding when using top/bottom alignment.</p>
 397 <p>Allowed values: &gt;= 0</p>
 398 <p>Default value: 25</p>
 399 </div>
 400 <hr>
 401 <div class="refsect2">
 402 <a name="GstTextOverlay--halignment"></a><h3>The <code class="literal">"halignment"</code> property</h3>
 403 <pre class="programlisting">  "halignment"               <a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlayHAlign" title="enum GstTextOverlayHAlign"><span class="type">GstTextOverlayHAlign</span></a>  : Read / Write</pre>
 404 <p>Horizontal alignment of the text.</p>
 405 <p>Default value: center</p>
 406 </div>
 407 <hr>
 408 <div class="refsect2">
 409 <a name="GstTextOverlay--valignment"></a><h3>The <code class="literal">"valignment"</code> property</h3>
 410 <pre class="programlisting">  "valignment"               <a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlayVAlign" title="enum GstTextOverlayVAlign"><span class="type">GstTextOverlayVAlign</span></a>  : Read / Write</pre>
 411 <p>Vertical alignment of the text.</p>
 412 <p>Default value: baseline</p>
 413 </div>
 414 <hr>
 415 <div class="refsect2">
 416 <a name="GstTextOverlay--line-alignment"></a><h3>The <code class="literal">"line-alignment"</code> property</h3>
 417 <pre class="programlisting">  "line-alignment"           <span class="type">GstTextOverlayLineAlign</span>  : Read / Write</pre>
 418 <p>Alignment of text lines relative to each other.</p>
 419 <p>Default value: center</p>
 420 </div>
 421 <hr>
 422 <div class="refsect2">
 423 <a name="GstTextOverlay--silent"></a><h3>The <code class="literal">"silent"</code> property</h3>
 424 <pre class="programlisting">  "silent"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 425 <p>Whether to render the text string.</p>
 426 <p>Default value: FALSE</p>
 427 </div>
 428 <hr>
 429 <div class="refsect2">
 430 <a name="GstTextOverlay--wait-text"></a><h3>The <code class="literal">"wait-text"</code> property</h3>
 431 <pre class="programlisting">  "wait-text"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 432 <p>Whether to wait for subtitles.</p>
 433 <p>Default value: TRUE</p>
 434 </div>
 435 <hr>
 436 <div class="refsect2">
 437 <a name="GstTextOverlay--auto-resize"></a><h3>The <code class="literal">"auto-resize"</code> property</h3>
 438 <pre class="programlisting">  "auto-resize"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 439 <p>Automatically adjust font size to screen-size.</p>
 440 <p>Default value: TRUE</p>
 441 </div>
 442 <hr>
 443 <div class="refsect2">
 444 <a name="GstTextOverlay--vertical-render"></a><h3>The <code class="literal">"vertical-render"</code> property</h3>
 445 <pre class="programlisting">  "vertical-render"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 446 <p>Vertical Render.</p>
 447 <p>Default value: FALSE</p>
 448 </div>
 449 <hr>
 450 <div class="refsect2">
 451 <a name="GstTextOverlay--color"></a><h3>The <code class="literal">"color"</code> property</h3>
 452 <pre class="programlisting">  "color"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 453 <p>Color to use for text (big-endian ARGB).</p>
 454 <p>Default value: 4294967295</p>
 455 </div>
 456 <hr>
 457 <div class="refsect2">
 458 <a name="GstTextOverlay--xpos"></a><h3>The <code class="literal">"xpos"</code> property</h3>
 459 <pre class="programlisting">  "xpos"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 460 <p>Horizontal position when using position alignment.</p>
 461 <p>Allowed values: [0,1]</p>
 462 <p>Default value: 0.5</p>
 463 </div>
 464 <hr>
 465 <div class="refsect2">
 466 <a name="GstTextOverlay--ypos"></a><h3>The <code class="literal">"ypos"</code> property</h3>
 467 <pre class="programlisting">  "ypos"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 468 <p>Vertical position when using position alignment.</p>
 469 <p>Allowed values: [0,1]</p>
 470 <p>Default value: 0.5</p>
 471 </div>
 472 <hr>
 473 <div class="refsect2">
 474 <a name="GstTextOverlay--outline-color"></a><h3>The <code class="literal">"outline-color"</code> property</h3>
 475 <pre class="programlisting">  "outline-color"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 476 <p>Color to use for outline the text (big-endian ARGB).</p>
 477 <p>Default value: 4278190080</p>
 478 </div>
 479 <hr>
 480 <div class="refsect2">
 481 <a name="GstTextOverlay--shadow"></a><h3>The <code class="literal">"shadow"</code> property</h3>
 482 <pre class="programlisting">  "shadow"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 483 <p>Whether to create a shadow of the letters under the text.</p>
 484 <p>Default value: TRUE</p>
 485 </div>
 486 </div>
 487 </div>
 488 <div class="footer">
 489 <hr>
 490           Generated by GTK-Doc V1.18</div>
 491 </body>
 492 </html>