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>textrender: GStreamer Base Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-base Elements"> 9<link rel="prev" href="gst-plugins-base-plugins-textoverlay.html" title="textoverlay"> 10<link rel="next" href="gst-plugins-base-plugins-theoradec.html" title="theoradec"> 11<meta name="generator" content="GTK-Doc V1.28 (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="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-base-plugins-textrender.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-base-plugins-textrender.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-base-plugins-textrender.properties" class="shortcut">Properties</a></span> 21</td> 22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 24<td><a accesskey="p" href="gst-plugins-base-plugins-textoverlay.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gst-plugins-base-plugins-theoradec.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 26</tr></table> 27<div class="refentry"> 28<a name="gst-plugins-base-plugins-textrender"></a><div class="titlepage"></div> 29<div class="refnamediv"><table width="100%"><tr> 30<td valign="top"> 31<h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-textrender.top_of_page"></a>textrender</span></h2> 32<p>textrender</p> 33</td> 34<td class="gallery_image" valign="top" align="right"></td> 35</tr></table></div> 36<div class="refsect1"> 37<a name="gst-plugins-base-plugins-textrender.properties"></a><h2>Properties</h2> 38<div class="informaltable"><table class="informaltable" border="0"> 39<colgroup> 40<col width="150px" class="properties_type"> 41<col width="300px" class="properties_name"> 42<col width="200px" class="properties_flags"> 43</colgroup> 44<tbody> 45<tr> 46<td class="property_type"> 47<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 48<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--font-desc" title="The “font-desc” property">font-desc</a></td> 49<td class="property_flags">Write</td> 50</tr> 51<tr> 52<td class="property_type"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderHAlign" title="enum GstTextRenderHAlign"><span class="type">GstTextRenderHAlign</span></a></td> 53<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--halignment" title="The “halignment” property">halignment</a></td> 54<td class="property_flags">Read / Write</td> 55</tr> 56<tr> 57<td class="property_type"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderLineAlign" title="enum GstTextRenderLineAlign"><span class="type">GstTextRenderLineAlign</span></a></td> 58<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--line-alignment" title="The “line-alignment” property">line-alignment</a></td> 59<td class="property_flags">Read / Write</td> 60</tr> 61<tr> 62<td class="property_type"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderVAlign" title="enum GstTextRenderVAlign"><span class="type">GstTextRenderVAlign</span></a></td> 63<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--valignment" title="The “valignment” property">valignment</a></td> 64<td class="property_flags">Read / Write</td> 65</tr> 66<tr> 67<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 68<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--xpad" title="The “xpad” property">xpad</a></td> 69<td class="property_flags">Read / Write</td> 70</tr> 71<tr> 72<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 73<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--ypad" title="The “ypad” property">ypad</a></td> 74<td class="property_flags">Read / Write</td> 75</tr> 76</tbody> 77</table></div> 78</div> 79<a name="GstTextRender"></a><div class="refsect1"> 80<a name="gst-plugins-base-plugins-textrender.other"></a><h2>Types and Values</h2> 81<div class="informaltable"><table class="informaltable" width="100%" border="0"> 82<colgroup> 83<col width="150px" class="name"> 84<col class="description"> 85</colgroup> 86<tbody> 87<tr> 88<td class="datatype_keyword">struct</td> 89<td class="function_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender-struct" title="struct GstTextRender">GstTextRender</a></td> 90</tr> 91<tr> 92<td class="datatype_keyword">enum</td> 93<td class="function_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderHAlign" title="enum GstTextRenderHAlign">GstTextRenderHAlign</a></td> 94</tr> 95<tr> 96<td class="datatype_keyword">enum</td> 97<td class="function_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderLineAlign" title="enum GstTextRenderLineAlign">GstTextRenderLineAlign</a></td> 98</tr> 99<tr> 100<td class="datatype_keyword">enum</td> 101<td class="function_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderVAlign" title="enum GstTextRenderVAlign">GstTextRenderVAlign</a></td> 102</tr> 103</tbody> 104</table></div> 105</div> 106<div class="refsect1"> 107<a name="gst-plugins-base-plugins-textrender.object-hierarchy"></a><h2>Object Hierarchy</h2> 108<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 109 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 110 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 111 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 112 <span class="lineart">╰──</span> GstTextRender 113</pre> 114</div> 115<div class="refsect1"> 116<a name="gst-plugins-base-plugins-textrender.description"></a><h2>Description</h2> 117<p>This plugin renders text received on the text sink pad to a video 118buffer (retaining the alpha channel), so it can later be overlayed 119on top of video streams using other elements.</p> 120<p>The text can contain newline characters. (FIXME: What about text 121wrapping? It does not make sense in this context)</p> 122<div class="refsect3"> 123<a name="id-1.2.98.7.4"></a><h4>Example launch lines</h4> 124<div class="informalexample"> 125 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 126 <tbody> 127 <tr> 128 <td class="listing_lines" align="right"><pre>1</pre></td> 129 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> <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> textrender <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink</pre></td> 130 </tr> 131 </tbody> 132 </table> 133</div> 134 135<p></p> 136</div> 137<div class="refsynopsisdiv"> 138<h2>Synopsis</h2> 139<div class="refsect2"> 140<a name="id-1.2.98.7.5.1"></a><h3>Element Information</h3> 141<div class="variablelist"><table border="0" class="variablelist"> 142<colgroup> 143<col align="left" valign="top"> 144<col> 145</colgroup> 146<tbody> 147<tr> 148<td><p><span class="term">plugin</span></p></td> 149<td> 150 <a class="link" href="gst-plugins-base-plugins-plugin-pango.html#plugin-pango">pango</a> 151 </td> 152</tr> 153<tr> 154<td><p><span class="term">author</span></p></td> 155<td>David Schleef <ds@schleef.org>, GStreamer maintainers <gstreamer-devel@lists.freedesktop.org></td> 156</tr> 157<tr> 158<td><p><span class="term">class</span></p></td> 159<td>Filter/Editor/Video</td> 160</tr> 161</tbody> 162</table></div> 163</div> 164<hr> 165<div class="refsect2"> 166<a name="id-1.2.98.7.5.2"></a><h3>Element Pads</h3> 167<div class="variablelist"><table border="0" class="variablelist"> 168<colgroup> 169<col align="left" valign="top"> 170<col> 171</colgroup> 172<tbody> 173<tr> 174<td><p><span class="term">name</span></p></td> 175<td>sink</td> 176</tr> 177<tr> 178<td><p><span class="term">direction</span></p></td> 179<td>sink</td> 180</tr> 181<tr> 182<td><p><span class="term">presence</span></p></td> 183<td>always</td> 184</tr> 185<tr> 186<td><p><span class="term">details</span></p></td> 187<td>text/x-raw, format=(string){ pango-markup, utf8 }</td> 188</tr> 189</tbody> 190</table></div> 191<div class="variablelist"><table border="0" class="variablelist"> 192<colgroup> 193<col align="left" valign="top"> 194<col> 195</colgroup> 196<tbody> 197<tr> 198<td><p><span class="term">name</span></p></td> 199<td>src</td> 200</tr> 201<tr> 202<td><p><span class="term">direction</span></p></td> 203<td>source</td> 204</tr> 205<tr> 206<td><p><span class="term">presence</span></p></td> 207<td>always</td> 208</tr> 209<tr> 210<td><p><span class="term">details</span></p></td> 211<td>video/x-raw, format=(string){ AYUV, ARGB }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 212</tr> 213</tbody> 214</table></div> 215</div> 216</div> 217</div> 218<div class="refsect1"> 219<a name="gst-plugins-base-plugins-textrender.functions_details"></a><h2>Functions</h2> 220<p></p> 221</div> 222<div class="refsect1"> 223<a name="gst-plugins-base-plugins-textrender.other_details"></a><h2>Types and Values</h2> 224<div class="refsect2"> 225<a name="GstTextRender-struct"></a><h3>struct GstTextRender</h3> 226<pre class="programlisting">struct GstTextRender;</pre> 227<p>Opaque textrender data structure.</p> 228</div> 229<hr> 230<div class="refsect2"> 231<a name="GstTextRenderHAlign"></a><h3>enum GstTextRenderHAlign</h3> 232<p>Horizontal alignment of the text.</p> 233<div class="refsect3"> 234<a name="GstTextRenderHAlign.members"></a><h4>Members</h4> 235<div class="informaltable"><table class="informaltable" width="100%" border="0"> 236<colgroup> 237<col width="300px" class="enum_members_name"> 238<col class="enum_members_description"> 239<col width="200px" class="enum_members_annotations"> 240</colgroup> 241<tbody> 242<tr> 243<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-HALIGN-LEFT:CAPS"></a>GST_TEXT_RENDER_HALIGN_LEFT</p></td> 244<td class="enum_member_description"> 245<p>align text left</p> 246</td> 247<td class="enum_member_annotations"> </td> 248</tr> 249<tr> 250<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-HALIGN-CENTER:CAPS"></a>GST_TEXT_RENDER_HALIGN_CENTER</p></td> 251<td class="enum_member_description"> 252<p>align text center</p> 253</td> 254<td class="enum_member_annotations"> </td> 255</tr> 256<tr> 257<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-HALIGN-RIGHT:CAPS"></a>GST_TEXT_RENDER_HALIGN_RIGHT</p></td> 258<td class="enum_member_description"> 259<p>align text right</p> 260</td> 261<td class="enum_member_annotations"> </td> 262</tr> 263</tbody> 264</table></div> 265</div> 266</div> 267<hr> 268<div class="refsect2"> 269<a name="GstTextRenderLineAlign"></a><h3>enum GstTextRenderLineAlign</h3> 270<p>Alignment of text lines relative to each other</p> 271<div class="refsect3"> 272<a name="GstTextRenderLineAlign.members"></a><h4>Members</h4> 273<div class="informaltable"><table class="informaltable" width="100%" border="0"> 274<colgroup> 275<col width="300px" class="enum_members_name"> 276<col class="enum_members_description"> 277<col width="200px" class="enum_members_annotations"> 278</colgroup> 279<tbody> 280<tr> 281<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-LINE-ALIGN-LEFT:CAPS"></a>GST_TEXT_RENDER_LINE_ALIGN_LEFT</p></td> 282<td class="enum_member_description"> 283<p>lines are left-aligned</p> 284</td> 285<td class="enum_member_annotations"> </td> 286</tr> 287<tr> 288<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-LINE-ALIGN-CENTER:CAPS"></a>GST_TEXT_RENDER_LINE_ALIGN_CENTER</p></td> 289<td class="enum_member_description"> 290<p>lines are center-aligned</p> 291</td> 292<td class="enum_member_annotations"> </td> 293</tr> 294<tr> 295<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-LINE-ALIGN-RIGHT:CAPS"></a>GST_TEXT_RENDER_LINE_ALIGN_RIGHT</p></td> 296<td class="enum_member_description"> 297<p>lines are right-aligned</p> 298</td> 299<td class="enum_member_annotations"> </td> 300</tr> 301</tbody> 302</table></div> 303</div> 304</div> 305<hr> 306<div class="refsect2"> 307<a name="GstTextRenderVAlign"></a><h3>enum GstTextRenderVAlign</h3> 308<p>Vertical alignment of the text.</p> 309<div class="refsect3"> 310<a name="GstTextRenderVAlign.members"></a><h4>Members</h4> 311<div class="informaltable"><table class="informaltable" width="100%" border="0"> 312<colgroup> 313<col width="300px" class="enum_members_name"> 314<col class="enum_members_description"> 315<col width="200px" class="enum_members_annotations"> 316</colgroup> 317<tbody> 318<tr> 319<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-VALIGN-BASELINE:CAPS"></a>GST_TEXT_RENDER_VALIGN_BASELINE</p></td> 320<td class="enum_member_description"> 321<p>draw text on the baseline</p> 322</td> 323<td class="enum_member_annotations"> </td> 324</tr> 325<tr> 326<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-VALIGN-BOTTOM:CAPS"></a>GST_TEXT_RENDER_VALIGN_BOTTOM</p></td> 327<td class="enum_member_description"> 328<p>draw text on the bottom</p> 329</td> 330<td class="enum_member_annotations"> </td> 331</tr> 332<tr> 333<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-VALIGN-TOP:CAPS"></a>GST_TEXT_RENDER_VALIGN_TOP</p></td> 334<td class="enum_member_description"> 335<p>draw test on top</p> 336</td> 337<td class="enum_member_annotations"> </td> 338</tr> 339</tbody> 340</table></div> 341</div> 342</div> 343</div> 344<div class="refsect1"> 345<a name="gst-plugins-base-plugins-textrender.property-details"></a><h2>Property Details</h2> 346<div class="refsect2"> 347<a name="GstTextRender--font-desc"></a><h3>The <code class="literal">“font-desc”</code> property</h3> 348<pre class="programlisting"> “font-desc” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 349<p>Pango font description of font to be used for rendering. See documentation of pango_font_description_from_string for syntax.</p> 350<p>Flags: Write</p> 351<p>Default value: ""</p> 352</div> 353<hr> 354<div class="refsect2"> 355<a name="GstTextRender--halignment"></a><h3>The <code class="literal">“halignment”</code> property</h3> 356<pre class="programlisting"> “halignment” <a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderHAlign" title="enum GstTextRenderHAlign"><span class="type">GstTextRenderHAlign</span></a></pre> 357<p>Horizontal alignment of the text.</p> 358<p>Flags: Read / Write</p> 359<p>Default value: center</p> 360</div> 361<hr> 362<div class="refsect2"> 363<a name="GstTextRender--line-alignment"></a><h3>The <code class="literal">“line-alignment”</code> property</h3> 364<pre class="programlisting"> “line-alignment” <a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderLineAlign" title="enum GstTextRenderLineAlign"><span class="type">GstTextRenderLineAlign</span></a></pre> 365<p>Alignment of text lines relative to each other.</p> 366<p>Flags: Read / Write</p> 367<p>Default value: center</p> 368</div> 369<hr> 370<div class="refsect2"> 371<a name="GstTextRender--valignment"></a><h3>The <code class="literal">“valignment”</code> property</h3> 372<pre class="programlisting"> “valignment” <a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderVAlign" title="enum GstTextRenderVAlign"><span class="type">GstTextRenderVAlign</span></a></pre> 373<p>Vertical alignment of the text.</p> 374<p>Flags: Read / Write</p> 375<p>Default value: baseline</p> 376</div> 377<hr> 378<div class="refsect2"> 379<a name="GstTextRender--xpad"></a><h3>The <code class="literal">“xpad”</code> property</h3> 380<pre class="programlisting"> “xpad” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 381<p>Horizontal paddding when using left/right alignment.</p> 382<p>Flags: Read / Write</p> 383<p>Allowed values: >= 0</p> 384<p>Default value: 25</p> 385</div> 386<hr> 387<div class="refsect2"> 388<a name="GstTextRender--ypad"></a><h3>The <code class="literal">“ypad”</code> property</h3> 389<pre class="programlisting"> “ypad” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 390<p>Vertical padding when using top/bottom alignment.</p> 391<p>Flags: Read / Write</p> 392<p>Allowed values: >= 0</p> 393<p>Default value: 25</p> 394</div> 395</div> 396<div class="refsect1"> 397<a name="gst-plugins-base-plugins-textrender.see-also"></a><h2>See Also</h2> 398<p><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay"><span class="type">GstTextOverlay</span></a></p> 399</div> 400</div> 401<div class="footer"> 402<hr>Generated by GTK-Doc V1.28</div> 403</body> 404</html>
