docs/plugins/html/gst-plugins-bad-plugins-opencvtextoverlay.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>opencvtextoverlay</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Bad Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
   9 <link rel="prev" href="gst-plugins-bad-plugins-templatematch.html" title="templatematch">
  10 <link rel="next" href="gst-plugins-bad-plugins-tiger.html" title="tiger">
  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-bad-plugins-templatematch.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 Bad Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-bad-plugins-tiger.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-bad-plugins-opencvtextoverlay.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-bad-plugins-opencvtextoverlay.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-bad-plugins-opencvtextoverlay.properties" class="shortcut">Properties</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="gst-plugins-bad-plugins-opencvtextoverlay"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-opencvtextoverlay.top_of_page"></a>opencvtextoverlay</span></h2>
  36 <p>opencvtextoverlay — Write text on the top of video</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="gst-plugins-bad-plugins-opencvtextoverlay.synopsis"></a><h2>Synopsis</h2>
  42 <a name="GstNuvDemux"></a><pre class="synopsis">                    <a class="link" href="gst-plugins-bad-plugins-nuvdemux.html#GstNuvDemux-struct" title="GstNuvDemux">GstNuvDemux</a>;
  43 struct              <a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay" title="struct GstOpencvTextOverlay">GstOpencvTextOverlay</a>;
  44 </pre>
  45 </div>
  46 <div class="refsect1">
  47 <a name="gst-plugins-bad-plugins-opencvtextoverlay.properties"></a><h2>Properties</h2>
  48 <pre class="synopsis">
  49   "<a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--colorB" title='The "colorB" property'>colorB</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  50   "<a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--colorG" title='The "colorG" property'>colorG</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  51   "<a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--colorR" title='The "colorR" property'>colorR</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  52   "<a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--height" title='The "height" property'>height</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  53   "<a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--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
  54   "<a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--thickness" title='The "thickness" property'>thickness</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  55   "<a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--width" title='The "width" property'>width</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  56   "<a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--xpos" title='The "xpos" property'>xpos</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  57   "<a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--ypos" title='The "ypos" property'>ypos</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  58 </pre>
  59 </div>
  60 <div class="refsect1">
  61 <a name="gst-plugins-bad-plugins-opencvtextoverlay.description"></a><h2>Description</h2>
  62 <div class="refsynopsisdiv">
  63 <h2>Synopsis</h2>
  64 <div class="refsect2">
  65 <a name="idp18890528"></a><h3>Element Information</h3>
  66 <div class="variablelist"><table border="0">
  67 <col align="left" valign="top">
  68 <tbody>
  69 <tr>
  70 <td><p><span class="term">plugin</span></p></td>
  71 <td>
  72             <a class="link" href="gst-plugins-bad-plugins-plugin-opencv.html#plugin-opencv">opencv</a>
  73           </td>
  74 </tr>
  75 <tr>
  76 <td><p><span class="term">author</span></p></td>
  77 <td>sreerenj&lt;bsreerenj@gmail.com&gt;</td>
  78 </tr>
  79 <tr>
  80 <td><p><span class="term">class</span></p></td>
  81 <td>Filter/Effect/Video</td>
  82 </tr>
  83 </tbody>
  84 </table></div>
  85 </div>
  86 <hr>
  87 <div class="refsect2">
  88 <a name="idp22852672"></a><h3>Element Pads</h3>
  89 <div class="variablelist"><table border="0">
  90 <col align="left" valign="top">
  91 <tbody>
  92 <tr>
  93 <td><p><span class="term">name</span></p></td>
  94 <td>sink</td>
  95 </tr>
  96 <tr>
  97 <td><p><span class="term">direction</span></p></td>
  98 <td>sink</td>
  99 </tr>
 100 <tr>
 101 <td><p><span class="term">presence</span></p></td>
 102 <td>always</td>
 103 </tr>
 104 <tr>
 105 <td><p><span class="term">details</span></p></td>
 106 <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>
 107 </tr>
 108 </tbody>
 109 </table></div>
 110 <div class="variablelist"><table border="0">
 111 <col align="left" valign="top">
 112 <tbody>
 113 <tr>
 114 <td><p><span class="term">name</span></p></td>
 115 <td>src</td>
 116 </tr>
 117 <tr>
 118 <td><p><span class="term">direction</span></p></td>
 119 <td>source</td>
 120 </tr>
 121 <tr>
 122 <td><p><span class="term">presence</span></p></td>
 123 <td>always</td>
 124 </tr>
 125 <tr>
 126 <td><p><span class="term">details</span></p></td>
 127 <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>
 128 </tr>
 129 </tbody>
 130 </table></div>
 131 </div>
 132 </div>
 133 <p>
 134 </p>
 135 </div>
 136 <div class="refsect1">
 137 <a name="gst-plugins-bad-plugins-opencvtextoverlay.details"></a><h2>Details</h2>
 138 <div class="refsect2">
 139 <a name="GstNuvDemux-struct"></a><h3>GstNuvDemux</h3>
 140 <pre class="programlisting">typedef struct _GstNuvDemux GstNuvDemux;</pre>
 141 <p>
 142 </p>
 143 </div>
 144 <hr>
 145 <div class="refsect2">
 146 <a name="GstOpencvTextOverlay"></a><h3>struct GstOpencvTextOverlay</h3>
 147 <pre class="programlisting">struct GstOpencvTextOverlay {
 148   GstElement element;
 149
 150   GstPad *sinkpad, *srcpad;
 151
 152   IplImage *cvImage;
 153   CvMemStorage *cvStorage;
 154   CvFont font;
 155
 156   gint xpos;
 157   gint ypos;
 158   gint thickness;
 159   gint colorR,colorG,colorB;
 160   gdouble height;
 161   gdouble width;
 162   gchar *textbuf;
 163 };
 164 </pre>
 165 <p>
 166 </p>
 167 </div>
 168 </div>
 169 <div class="refsect1">
 170 <a name="gst-plugins-bad-plugins-opencvtextoverlay.property-details"></a><h2>Property Details</h2>
 171 <div class="refsect2">
 172 <a name="GstOpencvTextOverlay--colorB"></a><h3>The <code class="literal">"colorB"</code> property</h3>
 173 <pre class="programlisting">  "colorB"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 174 <p>Sets the color -B.</p>
 175 <p>Allowed values: [0,255]</p>
 176 <p>Default value: 0</p>
 177 </div>
 178 <hr>
 179 <div class="refsect2">
 180 <a name="GstOpencvTextOverlay--colorG"></a><h3>The <code class="literal">"colorG"</code> property</h3>
 181 <pre class="programlisting">  "colorG"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 182 <p>Sets the color -G.</p>
 183 <p>Allowed values: [0,255]</p>
 184 <p>Default value: 0</p>
 185 </div>
 186 <hr>
 187 <div class="refsect2">
 188 <a name="GstOpencvTextOverlay--colorR"></a><h3>The <code class="literal">"colorR"</code> property</h3>
 189 <pre class="programlisting">  "colorR"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 190 <p>Sets the color -R.</p>
 191 <p>Allowed values: [0,255]</p>
 192 <p>Default value: 0</p>
 193 </div>
 194 <hr>
 195 <div class="refsect2">
 196 <a name="GstOpencvTextOverlay--height"></a><h3>The <code class="literal">"height"</code> property</h3>
 197 <pre class="programlisting">  "height"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 198 <p>Sets the height of fonts.</p>
 199 <p>Allowed values: [1,5]</p>
 200 <p>Default value: 1</p>
 201 </div>
 202 <hr>
 203 <div class="refsect2">
 204 <a name="GstOpencvTextOverlay--text"></a><h3>The <code class="literal">"text"</code> property</h3>
 205 <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>
 206 <p>Text to be display.</p>
 207 <p>Default value: ""</p>
 208 </div>
 209 <hr>
 210 <div class="refsect2">
 211 <a name="GstOpencvTextOverlay--thickness"></a><h3>The <code class="literal">"thickness"</code> property</h3>
 212 <pre class="programlisting">  "thickness"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 213 <p>Sets the Thickness of Font.</p>
 214 <p>Allowed values: &gt;= 0</p>
 215 <p>Default value: 2</p>
 216 </div>
 217 <hr>
 218 <div class="refsect2">
 219 <a name="GstOpencvTextOverlay--width"></a><h3>The <code class="literal">"width"</code> property</h3>
 220 <pre class="programlisting">  "width"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 221 <p>Sets the width of fonts.</p>
 222 <p>Allowed values: [1,5]</p>
 223 <p>Default value: 1</p>
 224 </div>
 225 <hr>
 226 <div class="refsect2">
 227 <a name="GstOpencvTextOverlay--xpos"></a><h3>The <code class="literal">"xpos"</code> property</h3>
 228 <pre class="programlisting">  "xpos"                     <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>Sets the Horizontal position.</p>
 230 <p>Allowed values: &gt;= 0</p>
 231 <p>Default value: 50</p>
 232 </div>
 233 <hr>
 234 <div class="refsect2">
 235 <a name="GstOpencvTextOverlay--ypos"></a><h3>The <code class="literal">"ypos"</code> property</h3>
 236 <pre class="programlisting">  "ypos"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 237 <p>Sets the Vertical position.</p>
 238 <p>Allowed values: &gt;= 0</p>
 239 <p>Default value: 50</p>
 240 </div>
 241 </div>
 242 </div>
 243 <div class="footer">
 244 <hr>
 245           Generated by GTK-Doc V1.18</div>
 246 </body>
 247 </html>