docs/plugins/html/gst-plugins-base-plugins-textrender.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>textrender</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-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.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-textoverlay.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-theoradec.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-textrender.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-textrender.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-textrender.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-plugins-textrender.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-base-plugins-textrender"></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-textrender.top_of_page"></a>textrender</span></h2>
  38 <p>textrender — Renders a text string to an image bitmap</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-textrender.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstTextRender"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender-struct" title="struct GstTextRender">GstTextRender</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-base-plugins-textrender.object-hierarchy"></a><h2>Object Hierarchy</h2>
  49 <pre class="synopsis">
  50   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  51    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  52          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  53                +----GstTextRender
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="gst-plugins-base-plugins-textrender.properties"></a><h2>Properties</h2>
  58 <pre class="synopsis">
  59   "<a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--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
  60   "<a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--halignment" title='The "halignment" property'>halignment</a>"               <span class="type">GstTextRenderHAlign</span>   : Read / Write
  61   "<a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--line-alignment" title='The "line-alignment" property'>line-alignment</a>"           <span class="type">GstTextRenderLineAlign</span>  : Read / Write
  62   "<a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--valignment" title='The "valignment" property'>valignment</a>"               <span class="type">GstTextRenderVAlign</span>   : Read / Write
  63   "<a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--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
  64   "<a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--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
  65 </pre>
  66 </div>
  67 <div class="refsect1">
  68 <a name="gst-plugins-base-plugins-textrender.description"></a><h2>Description</h2>
  69 <p>
  70 This plugin renders text received on the text sink pad to a video
  71 buffer (retaining the alpha channel), so it can later be overlayed
  72 on top of video streams using other elements.
  73 </p>
  74 <p>
  75 The text can contain newline characters. (FIXME: What about text
  76 wrapping? It does not make sense in this context)
  77 </p>
  78 <p>
  79 </p>
  80 <div class="refsect2">
  81 <a name="idp6059632"></a><h3>Example launch lines</h3>
  82 <div class="informalexample">
  83   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  84     <tbody>
  85       <tr>
  86         <td class="listing_lines" align="right"><pre>1</pre></td>
  87         <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> textrender <span class="gtkdoc opt">!</span> xvimagesink</pre></td>
  88       </tr>
  89     </tbody>
  90   </table>
  91 </div>
  92
  93 </div>
  94 <p>
  95 </p>
  96 <div class="refsynopsisdiv">
  97 <h2>Synopsis</h2>
  98 <div class="refsect2">
  99 <a name="idp9372592"></a><h3>Element Information</h3>
 100 <div class="variablelist"><table border="0">
 101 <col align="left" valign="top">
 102 <tbody>
 103 <tr>
 104 <td><p><span class="term">plugin</span></p></td>
 105 <td>
 106             <a class="link" href="gst-plugins-base-plugins-plugin-pango.html#plugin-pango">pango</a>
 107           </td>
 108 </tr>
 109 <tr>
 110 <td><p><span class="term">author</span></p></td>
 111 <td>David Schleef &lt;ds@schleef.org&gt;, GStreamer maintainers &lt;gstreamer-devel@lists.sourceforge.net&gt;</td>
 112 </tr>
 113 <tr>
 114 <td><p><span class="term">class</span></p></td>
 115 <td>Filter/Editor/Video</td>
 116 </tr>
 117 </tbody>
 118 </table></div>
 119 </div>
 120 <hr>
 121 <div class="refsect2">
 122 <a name="idp12613232"></a><h3>Element Pads</h3>
 123 <div class="variablelist"><table border="0">
 124 <col align="left" valign="top">
 125 <tbody>
 126 <tr>
 127 <td><p><span class="term">name</span></p></td>
 128 <td>sink</td>
 129 </tr>
 130 <tr>
 131 <td><p><span class="term">direction</span></p></td>
 132 <td>sink</td>
 133 </tr>
 134 <tr>
 135 <td><p><span class="term">presence</span></p></td>
 136 <td>always</td>
 137 </tr>
 138 <tr>
 139 <td><p><span class="term">details</span></p></td>
 140 <td>text/x-pango-markup</td>
 141 </tr>
 142 <tr>
 143 <td><p><span class="term"></span></p></td>
 144 <td> text/plain</td>
 145 </tr>
 146 </tbody>
 147 </table></div>
 148 <div class="variablelist"><table border="0">
 149 <col align="left" valign="top">
 150 <tbody>
 151 <tr>
 152 <td><p><span class="term">name</span></p></td>
 153 <td>src</td>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term">direction</span></p></td>
 157 <td>source</td>
 158 </tr>
 159 <tr>
 160 <td><p><span class="term">presence</span></p></td>
 161 <td>always</td>
 162 </tr>
 163 <tr>
 164 <td><p><span class="term">details</span></p></td>
 165 <td>video/x-raw-yuv, format=(fourcc)AYUV, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 166 </tr>
 167 <tr>
 168 <td><p><span class="term"></span></p></td>
 169 <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>
 170 </tr>
 171 </tbody>
 172 </table></div>
 173 </div>
 174 </div>
 175 <p>
 176 </p>
 177 </div>
 178 <div class="refsect1">
 179 <a name="gst-plugins-base-plugins-textrender.details"></a><h2>Details</h2>
 180 <div class="refsect2">
 181 <a name="GstTextRender-struct"></a><h3>struct GstTextRender</h3>
 182 <pre class="programlisting">struct GstTextRender;</pre>
 183 <p>
 184 Opaque textrender data structure.
 185 </p>
 186 </div>
 187 </div>
 188 <div class="refsect1">
 189 <a name="gst-plugins-base-plugins-textrender.property-details"></a><h2>Property Details</h2>
 190 <div class="refsect2">
 191 <a name="GstTextRender--font-desc"></a><h3>The <code class="literal">"font-desc"</code> property</h3>
 192 <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>
 193 <p>Pango font description of font to be used for rendering. See documentation of pango_font_description_from_string for syntax.</p>
 194 <p>Default value: ""</p>
 195 </div>
 196 <hr>
 197 <div class="refsect2">
 198 <a name="GstTextRender--halignment"></a><h3>The <code class="literal">"halignment"</code> property</h3>
 199 <pre class="programlisting">  "halignment"               <span class="type">GstTextRenderHAlign</span>   : Read / Write</pre>
 200 <p>Horizontal alignment of the text.</p>
 201 <p>Default value: center</p>
 202 </div>
 203 <hr>
 204 <div class="refsect2">
 205 <a name="GstTextRender--line-alignment"></a><h3>The <code class="literal">"line-alignment"</code> property</h3>
 206 <pre class="programlisting">  "line-alignment"           <span class="type">GstTextRenderLineAlign</span>  : Read / Write</pre>
 207 <p>Alignment of text lines relative to each other.</p>
 208 <p>Default value: center</p>
 209 </div>
 210 <hr>
 211 <div class="refsect2">
 212 <a name="GstTextRender--valignment"></a><h3>The <code class="literal">"valignment"</code> property</h3>
 213 <pre class="programlisting">  "valignment"               <span class="type">GstTextRenderVAlign</span>   : Read / Write</pre>
 214 <p>Vertical alignment of the text.</p>
 215 <p>Default value: baseline</p>
 216 </div>
 217 <hr>
 218 <div class="refsect2">
 219 <a name="GstTextRender--xpad"></a><h3>The <code class="literal">"xpad"</code> property</h3>
 220 <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>
 221 <p>Horizontal paddding when using left/right alignment.</p>
 222 <p>Allowed values: &gt;= 0</p>
 223 <p>Default value: 25</p>
 224 </div>
 225 <hr>
 226 <div class="refsect2">
 227 <a name="GstTextRender--ypad"></a><h3>The <code class="literal">"ypad"</code> property</h3>
 228 <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>
 229 <p>Vertical padding when using top/bottom alignment.</p>
 230 <p>Allowed values: &gt;= 0</p>
 231 <p>Default value: 25</p>
 232 </div>
 233 </div>
 234 <div class="refsect1">
 235 <a name="gst-plugins-base-plugins-textrender.see-also"></a><h2>See Also</h2>
 236 <a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay"><span class="type">GstTextOverlay</span></a>
 237 </div>
 238 </div>
 239 <div class="footer">
 240 <hr>
 241           Generated by GTK-Doc V1.17</div>
 242 </body>
 243 </html>