docs/plugins/html/gst-plugins-good-plugins-cairotextoverlay.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>cairotextoverlay</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
   9 <link rel="prev" href="gst-plugins-good-plugins-cacasink.html" title="cacasink">
  10 <link rel="next" href="gst-plugins-good-plugins-cairotimeoverlay.html" title="cairotimeoverlay">
  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-good-plugins-cacasink.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 Good Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-good-plugins-cairotimeoverlay.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-good-plugins-cairotextoverlay.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-cairotextoverlay.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-cairotextoverlay.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-cairotextoverlay.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-cairotextoverlay"></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-good-plugins-cairotextoverlay.top_of_page"></a>cairotextoverlay</span></h2>
  38 <p>cairotextoverlay — 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-good-plugins-cairotextoverlay.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstCairoTextOverlay"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-cairotextoverlay.html#GstCairoTextOverlay-struct" title="struct GstCairoTextOverlay">GstCairoTextOverlay</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-cairotextoverlay.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                +----GstCairoTextOverlay
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="gst-plugins-good-plugins-cairotextoverlay.properties"></a><h2>Properties</h2>
  58 <pre class="synopsis">
  59   "<a class="link" href="gst-plugins-good-plugins-cairotextoverlay.html#GstCairoTextOverlay--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>                  : Write
  60   "<a class="link" href="gst-plugins-good-plugins-cairotextoverlay.html#GstCairoTextOverlay--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>                  : Write
  61   "<a class="link" href="gst-plugins-good-plugins-cairotextoverlay.html#GstCairoTextOverlay--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
  62   "<a class="link" href="gst-plugins-good-plugins-cairotextoverlay.html#GstCairoTextOverlay--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
  63   "<a class="link" href="gst-plugins-good-plugins-cairotextoverlay.html#GstCairoTextOverlay--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>              : Write
  64   "<a class="link" href="gst-plugins-good-plugins-cairotextoverlay.html#GstCairoTextOverlay--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>*                : Write
  65   "<a class="link" href="gst-plugins-good-plugins-cairotextoverlay.html#GstCairoTextOverlay--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
  66   "<a class="link" href="gst-plugins-good-plugins-cairotextoverlay.html#GstCairoTextOverlay--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>                  : Write
  67   "<a class="link" href="gst-plugins-good-plugins-cairotextoverlay.html#GstCairoTextOverlay--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>                  : Write
  68 </pre>
  69 </div>
  70 <div class="refsect1">
  71 <a name="gst-plugins-good-plugins-cairotextoverlay.description"></a><h2>Description</h2>
  72 <p>
  73 cairotextoverlay renders the text on top of the video frames.
  74 </p>
  75 <p>
  76 </p>
  77 <div class="refsect2">
  78 <a name="idp5496688"></a><h3>Example launch line</h3>
  79 <div class="informalexample">
  80   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  81     <tbody>
  82       <tr>
  83         <td class="listing_lines" align="right"><pre>1</pre></td>
  84         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch videotestsrc <span class="gtkdoc opt">!</span> cairotextoverlay text<span class="gtkdoc opt">=</span><span class="string">&quot;hello&quot;</span> <span class="gtkdoc opt">!</span> autovideosink</pre></td>
  85       </tr>
  86     </tbody>
  87   </table>
  88 </div>
  89
  90 </div>
  91 <p>
  92 </p>
  93 <div class="refsynopsisdiv">
  94 <h2>Synopsis</h2>
  95 <div class="refsect2">
  96 <a name="idp6962432"></a><h3>Element Information</h3>
  97 <div class="variablelist"><table border="0">
  98 <col align="left" valign="top">
  99 <tbody>
 100 <tr>
 101 <td><p><span class="term">plugin</span></p></td>
 102 <td>
 103             <a class="link" href="gst-plugins-good-plugins-plugin-cairo.html#plugin-cairo">cairo</a>
 104           </td>
 105 </tr>
 106 <tr>
 107 <td><p><span class="term">author</span></p></td>
 108 <td>David Schleef &lt;ds@schleef.org&gt;</td>
 109 </tr>
 110 <tr>
 111 <td><p><span class="term">class</span></p></td>
 112 <td>Filter/Editor/Video</td>
 113 </tr>
 114 </tbody>
 115 </table></div>
 116 </div>
 117 <hr>
 118 <div class="refsect2">
 119 <a name="idp6392960"></a><h3>Element Pads</h3>
 120 <div class="variablelist"><table border="0">
 121 <col align="left" valign="top">
 122 <tbody>
 123 <tr>
 124 <td><p><span class="term">name</span></p></td>
 125 <td>text_sink</td>
 126 </tr>
 127 <tr>
 128 <td><p><span class="term">direction</span></p></td>
 129 <td>sink</td>
 130 </tr>
 131 <tr>
 132 <td><p><span class="term">presence</span></p></td>
 133 <td>always</td>
 134 </tr>
 135 <tr>
 136 <td><p><span class="term">details</span></p></td>
 137 <td>text/plain</td>
 138 </tr>
 139 </tbody>
 140 </table></div>
 141 <div class="variablelist"><table border="0">
 142 <col align="left" valign="top">
 143 <tbody>
 144 <tr>
 145 <td><p><span class="term">name</span></p></td>
 146 <td>video_sink</td>
 147 </tr>
 148 <tr>
 149 <td><p><span class="term">direction</span></p></td>
 150 <td>sink</td>
 151 </tr>
 152 <tr>
 153 <td><p><span class="term">presence</span></p></td>
 154 <td>always</td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term">details</span></p></td>
 158 <td>video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 159 </tr>
 160 </tbody>
 161 </table></div>
 162 <div class="variablelist"><table border="0">
 163 <col align="left" valign="top">
 164 <tbody>
 165 <tr>
 166 <td><p><span class="term">name</span></p></td>
 167 <td>src</td>
 168 </tr>
 169 <tr>
 170 <td><p><span class="term">direction</span></p></td>
 171 <td>source</td>
 172 </tr>
 173 <tr>
 174 <td><p><span class="term">presence</span></p></td>
 175 <td>always</td>
 176 </tr>
 177 <tr>
 178 <td><p><span class="term">details</span></p></td>
 179 <td>video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 180 </tr>
 181 </tbody>
 182 </table></div>
 183 </div>
 184 </div>
 185 <p>
 186 </p>
 187 </div>
 188 <div class="refsect1">
 189 <a name="gst-plugins-good-plugins-cairotextoverlay.details"></a><h2>Details</h2>
 190 <div class="refsect2">
 191 <a name="GstCairoTextOverlay-struct"></a><h3>struct GstCairoTextOverlay</h3>
 192 <pre class="programlisting">struct GstCairoTextOverlay;</pre>
 193 <p>
 194 </p>
 195 </div>
 196 </div>
 197 <div class="refsect1">
 198 <a name="gst-plugins-good-plugins-cairotextoverlay.property-details"></a><h2>Property Details</h2>
 199 <div class="refsect2">
 200 <a name="GstCairoTextOverlay--deltax"></a><h3>The <code class="literal">"deltax"</code> property</h3>
 201 <pre class="programlisting">  "deltax"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Write</pre>
 202 <p>Shift X position to the left or to the right. Unit is pixels.</p>
 203 <p>Default value: 0</p>
 204 </div>
 205 <hr>
 206 <div class="refsect2">
 207 <a name="GstCairoTextOverlay--deltay"></a><h3>The <code class="literal">"deltay"</code> property</h3>
 208 <pre class="programlisting">  "deltay"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Write</pre>
 209 <p>Shift Y position up or down. Unit is pixels.</p>
 210 <p>Default value: 0</p>
 211 </div>
 212 <hr>
 213 <div class="refsect2">
 214 <a name="GstCairoTextOverlay--font-desc"></a><h3>The <code class="literal">"font-desc"</code> property</h3>
 215 <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>
 216 <p>Pango font description of font to be used for rendering. See documentation of pango_font_description_from_string for syntax.</p>
 217 <p>Default value: ""</p>
 218 </div>
 219 <hr>
 220 <div class="refsect2">
 221 <a name="GstCairoTextOverlay--halign"></a><h3>The <code class="literal">"halign"</code> property</h3>
 222 <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>
 223 <p>Horizontal alignment of the text. Can be either 'left', 'right', or 'center'.</p>
 224 <p>Default value: "center"</p>
 225 </div>
 226 <hr>
 227 <div class="refsect2">
 228 <a name="GstCairoTextOverlay--shaded-background"></a><h3>The <code class="literal">"shaded-background"</code> property</h3>
 229 <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>              : Write</pre>
 230 <p>Whether to shade the background under the text area.</p>
 231 <p>Default value: FALSE</p>
 232 </div>
 233 <hr>
 234 <div class="refsect2">
 235 <a name="GstCairoTextOverlay--text"></a><h3>The <code class="literal">"text"</code> property</h3>
 236 <pre class="programlisting">  "text"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write</pre>
 237 <p>Text to be display.</p>
 238 <p>Default value: ""</p>
 239 </div>
 240 <hr>
 241 <div class="refsect2">
 242 <a name="GstCairoTextOverlay--valign"></a><h3>The <code class="literal">"valign"</code> property</h3>
 243 <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>
 244 <p>Vertical alignment of the text. Can be either 'baseline', 'bottom', or 'top'.</p>
 245 <p>Default value: "baseline"</p>
 246 </div>
 247 <hr>
 248 <div class="refsect2">
 249 <a name="GstCairoTextOverlay--xpad"></a><h3>The <code class="literal">"xpad"</code> property</h3>
 250 <pre class="programlisting">  "xpad"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Write</pre>
 251 <p>Horizontal paddding when using left/right alignment.</p>
 252 <p>Default value: 25</p>
 253 </div>
 254 <hr>
 255 <div class="refsect2">
 256 <a name="GstCairoTextOverlay--ypad"></a><h3>The <code class="literal">"ypad"</code> property</h3>
 257 <pre class="programlisting">  "ypad"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Write</pre>
 258 <p>Vertical padding when using top/bottom alignment.</p>
 259 <p>Default value: 25</p>
 260 </div>
 261 </div>
 262 </div>
 263 <div class="footer">
 264 <hr>
 265           Generated by GTK-Doc V1.17</div>
 266 </body>
 267 </html>