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.75.2">
   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.17 (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-timeoverlay.html#GstTimeOverlay">GstTimeOverlay</a>
  58                      +----<a class="link" href="gst-plugins-base-plugins-clockoverlay.html#GstClockOverlay">GstClockOverlay</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 </pre>
  85 </div>
  86 <div class="refsect1">
  87 <a name="gst-plugins-base-plugins-textoverlay.description"></a><h2>Description</h2>
  88 <p>
  89 This plugin renders text on top of a video stream. This can be either
  90 static text or text from buffers received on the text sink pad, e.g.
  91 as produced by the subparse element. If the text sink pad is not linked,
  92 the text set via the "text" property will be rendered. If the text sink
  93 pad is linked, text will be rendered as it is received on that pad,
  94 honouring and matching the buffer timestamps of both input streams.
  95 </p>
  96 <p>
  97 The text can contain newline characters and text wrapping is enabled by
  98 default.
  99 </p>
 100 <p>
 101 </p>
 102 <div class="refsect2">
 103 <a name="idp13316752"></a><h3>Example launch lines</h3>
 104 <div class="informalexample">
 105   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 106     <tbody>
 107       <tr>
 108         <td class="listing_lines" align="right"><pre>1</pre></td>
 109         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v videotestsrc <span class="gtkdoc opt">!</span> textoverlay text<span class="gtkdoc opt">=</span><span class="string">&quot;Room A&quot;</span> valign<span class="gtkdoc opt">=</span>top halign<span class="gtkdoc opt">=</span>left <span class="gtkdoc opt">!</span> xvimagesink</pre></td>
 110       </tr>
 111     </tbody>
 112   </table>
 113 </div>
 114  Here is a simple pipeline that displays a static text in the top left
 115 corner of the video picture
 116 <div class="informalexample">
 117   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 118     <tbody>
 119       <tr>
 120         <td class="listing_lines" align="right"><pre>1</pre></td>
 121         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v filesrc location<span class="gtkdoc opt">=</span>subtitles<span class="gtkdoc opt">.</span>srt <span class="gtkdoc opt">!</span> subparse <span class="gtkdoc opt">!</span> txt<span class="gtkdoc opt">.</span>   videotestsrc <span class="gtkdoc opt">!</span> timeoverlay <span class="gtkdoc opt">!</span> textoverlay name<span class="gtkdoc opt">=</span>txt shaded<span class="gtkdoc opt">-</span>background<span class="gtkdoc opt">=</span>yes <span class="gtkdoc opt">!</span> xvimagesink</pre></td>
 122       </tr>
 123     </tbody>
 124   </table>
 125 </div>
 126  Here is another pipeline that displays subtitles from an .srt subtitle
 127 file, centered at the bottom of the picture and with a rectangular shading
 128 around the text in the background:
 129 <p>
 130 If you do not have such a subtitle file, create one looking like this
 131 in a text editor:
 132 </p>
 133 <div class="informalexample">
 134   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 135     <tbody>
 136       <tr>
 137         <td class="listing_lines" align="right"><pre>1
 138 2
 139 3
 140 4
 141 5
 142 6
 143 7
 144 8
 145 9
 146 10
 147 11
 148 12
 149 13</pre></td>
 150         <td class="listing_code"><pre class="programlisting"><span class="number">1</span>
 151 <span class="number">00</span><span class="gtkdoc opt">:</span><span class="number">00</span><span class="gtkdoc opt">:</span><span class="number">03</span><span class="gtkdoc opt">,</span><span class="number">000</span> <span class="gtkdoc opt">--&gt;</span> <span class="number">00</span><span class="gtkdoc opt">:</span><span class="number">00</span><span class="gtkdoc opt">:</span><span class="number">05</span><span class="gtkdoc opt">,</span><span class="number">000</span>
 152 Hello? <span class="gtkdoc opt">(</span><span class="number">3</span><span class="gtkdoc opt">-</span><span class="number">5</span>s<span class="gtkdoc opt">)</span>
 153
 154 <span class="number">2</span>
 155 <span class="number">00</span><span class="gtkdoc opt">:</span><span class="number">00</span><span class="gtkdoc opt">:</span><span class="number">08</span><span class="gtkdoc opt">,</span><span class="number">000</span> <span class="gtkdoc opt">--&gt;</span> <span class="number">00</span><span class="gtkdoc opt">:</span><span class="number">00</span><span class="gtkdoc opt">:</span><span class="number">13</span><span class="gtkdoc opt">,</span><span class="number">000</span>
 156 Yes<span class="gtkdoc opt">,</span> <span class="keyword">this</span> is a subtitle<span class="gtkdoc opt">.</span> Don<span class="string">'t</span>
 157 <span class="string">you like it? (8-13s)</span>
 158 <span class="string"></span>
 159 <span class="string">3</span>
 160 <span class="string">00:00:18,826 --&gt; 00:01:02,886</span>
 161 <span class="string">Uh? What are you talking about?</span>
 162 <span class="string">I don'</span>t <span class="function">understand</span>  <span class="gtkdoc opt">(</span><span class="number">18</span><span class="gtkdoc opt">-</span><span class="number">62</span>s<span class="gtkdoc opt">)</span></pre></td>
 163       </tr>
 164     </tbody>
 165   </table>
 166 </div>
 167
 168 <p>
 169 </p>
 170 </div>
 171 <p>
 172 </p>
 173 <div class="refsynopsisdiv">
 174 <h2>Synopsis</h2>
 175 <div class="refsect2">
 176 <a name="idp6601408"></a><h3>Element Information</h3>
 177 <div class="variablelist"><table border="0">
 178 <col align="left" valign="top">
 179 <tbody>
 180 <tr>
 181 <td><p><span class="term">plugin</span></p></td>
 182 <td>
 183             <a class="link" href="gst-plugins-base-plugins-plugin-pango.html#plugin-pango">pango</a>
 184           </td>
 185 </tr>
 186 <tr>
 187 <td><p><span class="term">author</span></p></td>
 188 <td>David Schleef &lt;ds@schleef.org&gt;, Zeeshan Ali &lt;zeeshan.ali@nokia.com&gt;</td>
 189 </tr>
 190 <tr>
 191 <td><p><span class="term">class</span></p></td>
 192 <td>Filter/Editor/Video</td>
 193 </tr>
 194 </tbody>
 195 </table></div>
 196 </div>
 197 <hr>
 198 <div class="refsect2">
 199 <a name="idp9587280"></a><h3>Element Pads</h3>
 200 <div class="variablelist"><table border="0">
 201 <col align="left" valign="top">
 202 <tbody>
 203 <tr>
 204 <td><p><span class="term">name</span></p></td>
 205 <td>text_sink</td>
 206 </tr>
 207 <tr>
 208 <td><p><span class="term">direction</span></p></td>
 209 <td>sink</td>
 210 </tr>
 211 <tr>
 212 <td><p><span class="term">presence</span></p></td>
 213 <td>always</td>
 214 </tr>
 215 <tr>
 216 <td><p><span class="term">details</span></p></td>
 217 <td>text/x-pango-markup</td>
 218 </tr>
 219 <tr>
 220 <td><p><span class="term"></span></p></td>
 221 <td> text/plain</td>
 222 </tr>
 223 </tbody>
 224 </table></div>
 225 <div class="variablelist"><table border="0">
 226 <col align="left" valign="top">
 227 <tbody>
 228 <tr>
 229 <td><p><span class="term">name</span></p></td>
 230 <td>video_sink</td>
 231 </tr>
 232 <tr>
 233 <td><p><span class="term">direction</span></p></td>
 234 <td>sink</td>
 235 </tr>
 236 <tr>
 237 <td><p><span class="term">presence</span></p></td>
 238 <td>always</td>
 239 </tr>
 240 <tr>
 241 <td><p><span class="term">details</span></p></td>
 242 <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>
 243 </tr>
 244 <tr>
 245 <td><p><span class="term"></span></p></td>
 246 <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>
 247 </tr>
 248 <tr>
 249 <td><p><span class="term"></span></p></td>
 250 <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>
 251 </tr>
 252 <tr>
 253 <td><p><span class="term"></span></p></td>
 254 <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>
 255 </tr>
 256 <tr>
 257 <td><p><span class="term"></span></p></td>
 258 <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>
 259 </tr>
 260 <tr>
 261 <td><p><span class="term"></span></p></td>
 262 <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>
 263 </tr>
 264 <tr>
 265 <td><p><span class="term"></span></p></td>
 266 <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>
 267 </tr>
 268 <tr>
 269 <td><p><span class="term"></span></p></td>
 270 <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>
 271 </tr>
 272 <tr>
 273 <td><p><span class="term"></span></p></td>
 274 <td> video/x-raw-yuv, format=(fourcc){ AYUV, I420, UYVY, NV12, NV21 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 275 </tr>
 276 </tbody>
 277 </table></div>
 278 <div class="variablelist"><table border="0">
 279 <col align="left" valign="top">
 280 <tbody>
 281 <tr>
 282 <td><p><span class="term">name</span></p></td>
 283 <td>src</td>
 284 </tr>
 285 <tr>
 286 <td><p><span class="term">direction</span></p></td>
 287 <td>source</td>
 288 </tr>
 289 <tr>
 290 <td><p><span class="term">presence</span></p></td>
 291 <td>always</td>
 292 </tr>
 293 <tr>
 294 <td><p><span class="term">details</span></p></td>
 295 <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>
 296 </tr>
 297 <tr>
 298 <td><p><span class="term"></span></p></td>
 299 <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>
 300 </tr>
 301 <tr>
 302 <td><p><span class="term"></span></p></td>
 303 <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>
 304 </tr>
 305 <tr>
 306 <td><p><span class="term"></span></p></td>
 307 <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>
 308 </tr>
 309 <tr>
 310 <td><p><span class="term"></span></p></td>
 311 <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>
 312 </tr>
 313 <tr>
 314 <td><p><span class="term"></span></p></td>
 315 <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>
 316 </tr>
 317 <tr>
 318 <td><p><span class="term"></span></p></td>
 319 <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>
 320 </tr>
 321 <tr>
 322 <td><p><span class="term"></span></p></td>
 323 <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>
 324 </tr>
 325 <tr>
 326 <td><p><span class="term"></span></p></td>
 327 <td> video/x-raw-yuv, format=(fourcc){ AYUV, I420, UYVY, NV12, NV21 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 328 </tr>
 329 </tbody>
 330 </table></div>
 331 </div>
 332 </div>
 333 <p>
 334 </p>
 335 </div>
 336 <div class="refsect1">
 337 <a name="gst-plugins-base-plugins-textoverlay.details"></a><h2>Details</h2>
 338 <div class="refsect2">
 339 <a name="GstTextOverlay-struct"></a><h3>struct GstTextOverlay</h3>
 340 <pre class="programlisting">struct GstTextOverlay;</pre>
 341 <p>
 342 Opaque textoverlay object structure
 343 </p>
 344 </div>
 345 <hr>
 346 <div class="refsect2">
 347 <a name="GstTextOverlayVAlign"></a><h3>enum GstTextOverlayVAlign</h3>
 348 <pre class="programlisting">typedef enum {
 349     GST_TEXT_OVERLAY_VALIGN_BASELINE,
 350     GST_TEXT_OVERLAY_VALIGN_BOTTOM,
 351     GST_TEXT_OVERLAY_VALIGN_TOP,
 352     GST_TEXT_OVERLAY_VALIGN_POS,
 353     GST_TEXT_OVERLAY_VALIGN_CENTER
 354 } GstTextOverlayVAlign;
 355 </pre>
 356 <p>
 357 Vertical alignment of the text.
 358 </p>
 359 <div class="variablelist"><table border="0">
 360 <col align="left" valign="top">
 361 <tbody>
 362 <tr>
 363 <td><p><a name="GST-TEXT-OVERLAY-VALIGN-BASELINE:CAPS"></a><span class="term"><code class="literal">GST_TEXT_OVERLAY_VALIGN_BASELINE</code></span></p></td>
 364 <td>draw text on the baseline
 365 </td>
 366 </tr>
 367 <tr>
 368 <td><p><a name="GST-TEXT-OVERLAY-VALIGN-BOTTOM:CAPS"></a><span class="term"><code class="literal">GST_TEXT_OVERLAY_VALIGN_BOTTOM</code></span></p></td>
 369 <td>draw text on the bottom
 370 </td>
 371 </tr>
 372 <tr>
 373 <td><p><a name="GST-TEXT-OVERLAY-VALIGN-TOP:CAPS"></a><span class="term"><code class="literal">GST_TEXT_OVERLAY_VALIGN_TOP</code></span></p></td>
 374 <td>draw text on top
 375 </td>
 376 </tr>
 377 <tr>
 378 <td><p><a name="GST-TEXT-OVERLAY-VALIGN-POS:CAPS"></a><span class="term"><code class="literal">GST_TEXT_OVERLAY_VALIGN_POS</code></span></p></td>
 379 <td>draw text according to the <a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--ypos" title='The "ypos" property'><span class="type">"ypos"</span></a> property
 380 </td>
 381 </tr>
 382 <tr>
 383 <td><p><a name="GST-TEXT-OVERLAY-VALIGN-CENTER:CAPS"></a><span class="term"><code class="literal">GST_TEXT_OVERLAY_VALIGN_CENTER</code></span></p></td>
 384 <td>draw text vertically centered
 385 </td>
 386 </tr>
 387 </tbody>
 388 </table></div>
 389 </div>
 390 <hr>
 391 <div class="refsect2">
 392 <a name="GstTextOverlayHAlign"></a><h3>enum GstTextOverlayHAlign</h3>
 393 <pre class="programlisting">typedef enum {
 394     GST_TEXT_OVERLAY_HALIGN_LEFT,
 395     GST_TEXT_OVERLAY_HALIGN_CENTER,
 396     GST_TEXT_OVERLAY_HALIGN_RIGHT,
 397     GST_TEXT_OVERLAY_HALIGN_UNUSED,
 398     GST_TEXT_OVERLAY_HALIGN_POS
 399 } GstTextOverlayHAlign;
 400 </pre>
 401 <p>
 402 Horizontal alignment of the text.
 403 </p>
 404 <div class="variablelist"><table border="0">
 405 <col align="left" valign="top">
 406 <tbody>
 407 <tr>
 408 <td><p><a name="GST-TEXT-OVERLAY-HALIGN-LEFT:CAPS"></a><span class="term"><code class="literal">GST_TEXT_OVERLAY_HALIGN_LEFT</code></span></p></td>
 409 <td>align text left
 410 </td>
 411 </tr>
 412 <tr>
 413 <td><p><a name="GST-TEXT-OVERLAY-HALIGN-CENTER:CAPS"></a><span class="term"><code class="literal">GST_TEXT_OVERLAY_HALIGN_CENTER</code></span></p></td>
 414 <td>align text center
 415 </td>
 416 </tr>
 417 <tr>
 418 <td><p><a name="GST-TEXT-OVERLAY-HALIGN-RIGHT:CAPS"></a><span class="term"><code class="literal">GST_TEXT_OVERLAY_HALIGN_RIGHT</code></span></p></td>
 419 <td>align text right
 420 </td>
 421 </tr>
 422 <tr>
 423 <td><p><a name="GST-TEXT-OVERLAY-HALIGN-UNUSED:CAPS"></a><span class="term"><code class="literal">GST_TEXT_OVERLAY_HALIGN_UNUSED</code></span></p></td>
 424 <td>
 425 </td>
 426 </tr>
 427 <tr>
 428 <td><p><a name="GST-TEXT-OVERLAY-HALIGN-POS:CAPS"></a><span class="term"><code class="literal">GST_TEXT_OVERLAY_HALIGN_POS</code></span></p></td>
 429 <td>position text according to the <a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--xpos" title='The "xpos" property'><span class="type">"xpos"</span></a> property
 430 </td>
 431 </tr>
 432 </tbody>
 433 </table></div>
 434 </div>
 435 <hr>
 436 <div class="refsect2">
 437 <a name="GstTextOverlayWrapMode"></a><h3>enum GstTextOverlayWrapMode</h3>
 438 <pre class="programlisting">typedef enum {
 439     GST_TEXT_OVERLAY_WRAP_MODE_NONE = -1,
 440     GST_TEXT_OVERLAY_WRAP_MODE_WORD = PANGO_WRAP_WORD,
 441     GST_TEXT_OVERLAY_WRAP_MODE_CHAR = PANGO_WRAP_CHAR,
 442     GST_TEXT_OVERLAY_WRAP_MODE_WORD_CHAR = PANGO_WRAP_WORD_CHAR
 443 } GstTextOverlayWrapMode;
 444 </pre>
 445 <p>
 446 Whether to wrap the text and if so how.
 447 </p>
 448 <div class="variablelist"><table border="0">
 449 <col align="left" valign="top">
 450 <tbody>
 451 <tr>
 452 <td><p><a name="GST-TEXT-OVERLAY-WRAP-MODE-NONE:CAPS"></a><span class="term"><code class="literal">GST_TEXT_OVERLAY_WRAP_MODE_NONE</code></span></p></td>
 453 <td>no wrapping
 454 </td>
 455 </tr>
 456 <tr>
 457 <td><p><a name="GST-TEXT-OVERLAY-WRAP-MODE-WORD:CAPS"></a><span class="term"><code class="literal">GST_TEXT_OVERLAY_WRAP_MODE_WORD</code></span></p></td>
 458 <td>do word wrapping
 459 </td>
 460 </tr>
 461 <tr>
 462 <td><p><a name="GST-TEXT-OVERLAY-WRAP-MODE-CHAR:CAPS"></a><span class="term"><code class="literal">GST_TEXT_OVERLAY_WRAP_MODE_CHAR</code></span></p></td>
 463 <td>do char wrapping
 464 </td>
 465 </tr>
 466 <tr>
 467 <td><p><a name="GST-TEXT-OVERLAY-WRAP-MODE-WORD-CHAR:CAPS"></a><span class="term"><code class="literal">GST_TEXT_OVERLAY_WRAP_MODE_WORD_CHAR</code></span></p></td>
 468 <td>do word and char wrapping
 469 </td>
 470 </tr>
 471 </tbody>
 472 </table></div>
 473 </div>
 474 </div>
 475 <div class="refsect1">
 476 <a name="gst-plugins-base-plugins-textoverlay.property-details"></a><h2>Property Details</h2>
 477 <div class="refsect2">
 478 <a name="GstTextOverlay--deltax"></a><h3>The <code class="literal">"deltax"</code> property</h3>
 479 <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>
 480 <p>Shift X position to the left or to the right. Unit is pixels.</p>
 481 <p>Default value: 0</p>
 482 </div>
 483 <hr>
 484 <div class="refsect2">
 485 <a name="GstTextOverlay--deltay"></a><h3>The <code class="literal">"deltay"</code> property</h3>
 486 <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>
 487 <p>Shift Y position up or down. Unit is pixels.</p>
 488 <p>Default value: 0</p>
 489 </div>
 490 <hr>
 491 <div class="refsect2">
 492 <a name="GstTextOverlay--font-desc"></a><h3>The <code class="literal">"font-desc"</code> property</h3>
 493 <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>
 494 <p>Pango font description of font to be used for rendering. See documentation of pango_font_description_from_string for syntax.</p>
 495 <p>Default value: ""</p>
 496 </div>
 497 <hr>
 498 <div class="refsect2">
 499 <a name="GstTextOverlay--halign"></a><h3>The <code class="literal">"halign"</code> property</h3>
 500 <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>
 501 <p>Horizontal alignment of the text (deprecated; use halignment).</p>
 502 <p>Default value: "center"</p>
 503 </div>
 504 <hr>
 505 <div class="refsect2">
 506 <a name="GstTextOverlay--shaded-background"></a><h3>The <code class="literal">"shaded-background"</code> property</h3>
 507 <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>
 508 <p>Whether to shade the background under the text area.</p>
 509 <p>Default value: FALSE</p>
 510 </div>
 511 <hr>
 512 <div class="refsect2">
 513 <a name="GstTextOverlay--text"></a><h3>The <code class="literal">"text"</code> property</h3>
 514 <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>
 515 <p>Text to be display.</p>
 516 <p>Default value: ""</p>
 517 </div>
 518 <hr>
 519 <div class="refsect2">
 520 <a name="GstTextOverlay--valign"></a><h3>The <code class="literal">"valign"</code> property</h3>
 521 <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>
 522 <p>Vertical alignment of the text (deprecated; use valignment).</p>
 523 <p>Default value: "baseline"</p>
 524 </div>
 525 <hr>
 526 <div class="refsect2">
 527 <a name="GstTextOverlay--wrap-mode"></a><h3>The <code class="literal">"wrap-mode"</code> property</h3>
 528 <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>
 529 <p>Whether to wrap the text and if so how.</p>
 530 <p>Default value: wordchar</p>
 531 </div>
 532 <hr>
 533 <div class="refsect2">
 534 <a name="GstTextOverlay--xpad"></a><h3>The <code class="literal">"xpad"</code> property</h3>
 535 <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>
 536 <p>Horizontal paddding when using left/right alignment.</p>
 537 <p>Allowed values: &gt;= 0</p>
 538 <p>Default value: 25</p>
 539 </div>
 540 <hr>
 541 <div class="refsect2">
 542 <a name="GstTextOverlay--ypad"></a><h3>The <code class="literal">"ypad"</code> property</h3>
 543 <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>
 544 <p>Vertical padding when using top/bottom alignment.</p>
 545 <p>Allowed values: &gt;= 0</p>
 546 <p>Default value: 25</p>
 547 </div>
 548 <hr>
 549 <div class="refsect2">
 550 <a name="GstTextOverlay--halignment"></a><h3>The <code class="literal">"halignment"</code> property</h3>
 551 <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>
 552 <p>Horizontal alignment of the text.</p>
 553 <p>Default value: center</p>
 554 </div>
 555 <hr>
 556 <div class="refsect2">
 557 <a name="GstTextOverlay--valignment"></a><h3>The <code class="literal">"valignment"</code> property</h3>
 558 <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>
 559 <p>Vertical alignment of the text.</p>
 560 <p>Default value: baseline</p>
 561 </div>
 562 <hr>
 563 <div class="refsect2">
 564 <a name="GstTextOverlay--line-alignment"></a><h3>The <code class="literal">"line-alignment"</code> property</h3>
 565 <pre class="programlisting">  "line-alignment"           <span class="type">GstTextOverlayLineAlign</span>  : Read / Write</pre>
 566 <p>
 567 Alignment of text lines relative to each other (for multi-line text)
 568 </p>
 569 <p>Default value: center</p>
 570 <p class="since">Since 0.10.15</p>
 571 </div>
 572 <hr>
 573 <div class="refsect2">
 574 <a name="GstTextOverlay--silent"></a><h3>The <code class="literal">"silent"</code> property</h3>
 575 <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>
 576 <p>
 577 If set, no text is rendered. Useful to switch off text rendering
 578 temporarily without removing the textoverlay element from the pipeline.
 579 </p>
 580 <p>Default value: FALSE</p>
 581 <p class="since">Since 0.10.15</p>
 582 </div>
 583 <hr>
 584 <div class="refsect2">
 585 <a name="GstTextOverlay--wait-text"></a><h3>The <code class="literal">"wait-text"</code> property</h3>
 586 <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>
 587 <p>
 588 If set, the video will block until a subtitle is received on the text pad.
 589 If video and subtitles are sent in sync, like from the same demuxer, this
 590 property should be set.
 591 </p>
 592 <p>Default value: TRUE</p>
 593 <p class="since">Since 0.10.20</p>
 594 </div>
 595 <hr>
 596 <div class="refsect2">
 597 <a name="GstTextOverlay--auto-resize"></a><h3>The <code class="literal">"auto-resize"</code> property</h3>
 598 <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>
 599 <p>Automatically adjust font size to screen-size.</p>
 600 <p>Default value: TRUE</p>
 601 </div>
 602 <hr>
 603 <div class="refsect2">
 604 <a name="GstTextOverlay--vertical-render"></a><h3>The <code class="literal">"vertical-render"</code> property</h3>
 605 <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>
 606 <p>Vertical Render.</p>
 607 <p>Default value: FALSE</p>
 608 </div>
 609 <hr>
 610 <div class="refsect2">
 611 <a name="GstTextOverlay--color"></a><h3>The <code class="literal">"color"</code> property</h3>
 612 <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>
 613 <p>
 614 Color of the rendered text.
 615 </p>
 616 <p>Default value: 4294967295</p>
 617 <p class="since">Since 0.10.31</p>
 618 </div>
 619 <hr>
 620 <div class="refsect2">
 621 <a name="GstTextOverlay--xpos"></a><h3>The <code class="literal">"xpos"</code> property</h3>
 622 <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>
 623 <p>
 624 Horizontal position of the rendered text when using positioned alignment.
 625 </p>
 626 <p>Allowed values: [0,1]</p>
 627 <p>Default value: 0.5</p>
 628 <p class="since">Since 0.10.31</p>
 629 </div>
 630 <hr>
 631 <div class="refsect2">
 632 <a name="GstTextOverlay--ypos"></a><h3>The <code class="literal">"ypos"</code> property</h3>
 633 <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>
 634 <p>
 635 Vertical position of the rendered text when using positioned alignment.
 636 </p>
 637 <p>Allowed values: [0,1]</p>
 638 <p>Default value: 0.5</p>
 639 <p class="since">Since 0.10.31</p>
 640 </div>
 641 </div>
 642 <div class="refsect1">
 643 <a name="gst-plugins-base-plugins-textoverlay.see-also"></a><h2>See Also</h2>
 644 <a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender"><span class="type">GstTextRender</span></a>, <a class="link" href="gst-plugins-base-plugins-clockoverlay.html#GstClockOverlay"><span class="type">GstClockOverlay</span></a>, <a class="link" href="gst-plugins-base-plugins-timeoverlay.html#GstTimeOverlay"><span class="type">GstTimeOverlay</span></a>, <span class="type">GstSubParse</span>
 645 </div>
 646 </div>
 647 <div class="footer">
 648 <hr>
 649           Generated by GTK-Doc V1.17</div>
 650 </body>
 651 </html>