• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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: GStreamer Bad 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 Bad Plugins 1.0 Plugins Reference Manual">
8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9<link rel="prev" href="gst-plugins-bad-plugins-openalsrc.html" title="openalsrc">
10<link rel="next" href="gst-plugins-bad-plugins-openexrdec.html" title="openexrdec">
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">|</span18                  <a href="#gst-plugins-bad-plugins-opencvtextoverlay.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#gst-plugins-bad-plugins-opencvtextoverlay.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span20                  <a href="#gst-plugins-bad-plugins-opencvtextoverlay.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-bad-plugins-openalsrc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25<td><a accesskey="n" href="gst-plugins-bad-plugins-openexrdec.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-bad-plugins-opencvtextoverlay"></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-bad-plugins-opencvtextoverlay.top_of_page"></a>opencvtextoverlay</span></h2>
32<p>opencvtextoverlay</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-bad-plugins-opencvtextoverlay.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"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--colorB" title="The “colorB” property">colorB</a></td>
48<td class="property_flags">Read / Write</td>
49</tr>
50<tr>
51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--colorG" title="The “colorG” property">colorG</a></td>
53<td class="property_flags">Read / Write</td>
54</tr>
55<tr>
56<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
57<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--colorR" title="The “colorR” property">colorR</a></td>
58<td class="property_flags">Read / Write</td>
59</tr>
60<tr>
61<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
62<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--height" title="The “height” property">height</a></td>
63<td class="property_flags">Read / Write</td>
64</tr>
65<tr>
66<td class="property_type">
67<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
68<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--text" title="The “text” property">text</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-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--thickness" title="The “thickness” property">thickness</a></td>
74<td class="property_flags">Read / Write</td>
75</tr>
76<tr>
77<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
78<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--width" title="The “width” property">width</a></td>
79<td class="property_flags">Read / Write</td>
80</tr>
81<tr>
82<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
83<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--xpos" title="The “xpos” property">xpos</a></td>
84<td class="property_flags">Read / Write</td>
85</tr>
86<tr>
87<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
88<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay--ypos" title="The “ypos” property">ypos</a></td>
89<td class="property_flags">Read / Write</td>
90</tr>
91</tbody>
92</table></div>
93</div>
94<a name="GstOpencvTextOverlay"></a><div class="refsect1">
95<a name="gst-plugins-bad-plugins-opencvtextoverlay.other"></a><h2>Types and Values</h2>
96<div class="informaltable"><table class="informaltable" width="100%" border="0">
97<colgroup>
98<col width="150px" class="name">
99<col class="description">
100</colgroup>
101<tbody><tr>
102<td class="datatype_keyword">struct</td>
103<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-opencvtextoverlay.html#GstOpencvTextOverlay-struct" title="struct GstOpencvTextOverlay">GstOpencvTextOverlay</a></td>
104</tr></tbody>
105</table></div>
106</div>
107<div class="refsect1">
108<a name="gst-plugins-bad-plugins-opencvtextoverlay.object-hierarchy"></a><h2>Object Hierarchy</h2>
109<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
110    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
111        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
112            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
113                <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a>
114                    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoFilter.html#GstVideoFilter-struct">GstVideoFilter</a>
115                        <span class="lineart">╰──</span> GstOpencvVideoFilter
116                            <span class="lineart">╰──</span> GstOpencvTextOverlay
117</pre>
118</div>
119<div class="refsect1">
120<a name="gst-plugins-bad-plugins-opencvtextoverlay.description"></a><h2>Description</h2>
121<p>opencvtextoverlay renders the text on top of the video frames</p>
122<div class="refsect2">
123<a name="id-1.2.158.7.3"></a><h3>Example launch line</h3>
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> videotestsrc <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> opencvtextoverlay text<span class="gtkdoc opt">=</span><span class="string">&quot;Opencv Text Overlay &quot;</span> <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> xvimagesink</pre></td>
130      </tr>
131    </tbody>
132  </table>
133</div>
134
135</div>
136<div class="refsynopsisdiv">
137<h2>Synopsis</h2>
138<div class="refsect2">
139<a name="id-1.2.158.7.4.1"></a><h3>Element Information</h3>
140<div class="variablelist"><table border="0" class="variablelist">
141<colgroup>
142<col align="left" valign="top">
143<col>
144</colgroup>
145<tbody>
146<tr>
147<td><p><span class="term">plugin</span></p></td>
148<td>
149            <a class="link" href="gst-plugins-bad-plugins-plugin-opencv.html#plugin-opencv">opencv</a>
150          </td>
151</tr>
152<tr>
153<td><p><span class="term">author</span></p></td>
154<td>sreerenj&lt;bsreerenj@gmail.com&gt;</td>
155</tr>
156<tr>
157<td><p><span class="term">class</span></p></td>
158<td>Filter/Effect/Video</td>
159</tr>
160</tbody>
161</table></div>
162</div>
163<hr>
164<div class="refsect2">
165<a name="id-1.2.158.7.4.2"></a><h3>Element Pads</h3>
166<div class="variablelist"><table border="0" class="variablelist">
167<colgroup>
168<col align="left" valign="top">
169<col>
170</colgroup>
171<tbody>
172<tr>
173<td><p><span class="term">name</span></p></td>
174<td>sink</td>
175</tr>
176<tr>
177<td><p><span class="term">direction</span></p></td>
178<td>sink</td>
179</tr>
180<tr>
181<td><p><span class="term">presence</span></p></td>
182<td>always</td>
183</tr>
184<tr>
185<td><p><span class="term">details</span></p></td>
186<td>video/x-raw, format=(string)RGB, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
187</tr>
188</tbody>
189</table></div>
190<div class="variablelist"><table border="0" class="variablelist">
191<colgroup>
192<col align="left" valign="top">
193<col>
194</colgroup>
195<tbody>
196<tr>
197<td><p><span class="term">name</span></p></td>
198<td>src</td>
199</tr>
200<tr>
201<td><p><span class="term">direction</span></p></td>
202<td>source</td>
203</tr>
204<tr>
205<td><p><span class="term">presence</span></p></td>
206<td>always</td>
207</tr>
208<tr>
209<td><p><span class="term">details</span></p></td>
210<td>video/x-raw, format=(string)RGB, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
211</tr>
212</tbody>
213</table></div>
214</div>
215</div>
216</div>
217<div class="refsect1">
218<a name="gst-plugins-bad-plugins-opencvtextoverlay.functions_details"></a><h2>Functions</h2>
219<p></p>
220</div>
221<div class="refsect1">
222<a name="gst-plugins-bad-plugins-opencvtextoverlay.other_details"></a><h2>Types and Values</h2>
223<div class="refsect2">
224<a name="GstOpencvTextOverlay-struct"></a><h3>struct GstOpencvTextOverlay</h3>
225<pre class="programlisting">struct GstOpencvTextOverlay;</pre>
226</div>
227</div>
228<div class="refsect1">
229<a name="gst-plugins-bad-plugins-opencvtextoverlay.property-details"></a><h2>Property Details</h2>
230<div class="refsect2">
231<a name="GstOpencvTextOverlay--colorB"></a><h3>The <code class="literal">“colorB”</code> property</h3>
232<pre class="programlisting">  “colorB”                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
233<p>Sets the color -B.</p>
234<p>Flags: Read / Write</p>
235<p>Allowed values: [0,255]</p>
236<p>Default value: 0</p>
237</div>
238<hr>
239<div class="refsect2">
240<a name="GstOpencvTextOverlay--colorG"></a><h3>The <code class="literal">“colorG”</code> property</h3>
241<pre class="programlisting">  “colorG”                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
242<p>Sets the color -G.</p>
243<p>Flags: Read / Write</p>
244<p>Allowed values: [0,255]</p>
245<p>Default value: 0</p>
246</div>
247<hr>
248<div class="refsect2">
249<a name="GstOpencvTextOverlay--colorR"></a><h3>The <code class="literal">“colorR”</code> property</h3>
250<pre class="programlisting">  “colorR”                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
251<p>Sets the color -R.</p>
252<p>Flags: Read / Write</p>
253<p>Allowed values: [0,255]</p>
254<p>Default value: 0</p>
255</div>
256<hr>
257<div class="refsect2">
258<a name="GstOpencvTextOverlay--height"></a><h3>The <code class="literal">“height”</code> property</h3>
259<pre class="programlisting">  “height”                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
260<p>Sets the height of fonts.</p>
261<p>Flags: Read / Write</p>
262<p>Allowed values: [1,5]</p>
263<p>Default value: 1</p>
264</div>
265<hr>
266<div class="refsect2">
267<a name="GstOpencvTextOverlay--text"></a><h3>The <code class="literal">“text”</code> property</h3>
268<pre class="programlisting">  “text”                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
269<p>Text to be display.</p>
270<p>Flags: Read / Write</p>
271<p>Default value: "Opencv Text Overlay"</p>
272</div>
273<hr>
274<div class="refsect2">
275<a name="GstOpencvTextOverlay--thickness"></a><h3>The <code class="literal">“thickness”</code> property</h3>
276<pre class="programlisting">  “thickness”                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
277<p>Sets the Thickness of Font.</p>
278<p>Flags: Read / Write</p>
279<p>Allowed values: &gt;= 0</p>
280<p>Default value: 2</p>
281</div>
282<hr>
283<div class="refsect2">
284<a name="GstOpencvTextOverlay--width"></a><h3>The <code class="literal">“width”</code> property</h3>
285<pre class="programlisting">  “width”                    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
286<p>Sets the width of fonts.</p>
287<p>Flags: Read / Write</p>
288<p>Allowed values: [1,5]</p>
289<p>Default value: 1</p>
290</div>
291<hr>
292<div class="refsect2">
293<a name="GstOpencvTextOverlay--xpos"></a><h3>The <code class="literal">“xpos”</code> property</h3>
294<pre class="programlisting">  “xpos”                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
295<p>Sets the Horizontal position.</p>
296<p>Flags: Read / Write</p>
297<p>Allowed values: &gt;= 0</p>
298<p>Default value: 50</p>
299</div>
300<hr>
301<div class="refsect2">
302<a name="GstOpencvTextOverlay--ypos"></a><h3>The <code class="literal">“ypos”</code> property</h3>
303<pre class="programlisting">  “ypos”                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
304<p>Sets the Vertical position.</p>
305<p>Flags: Read / Write</p>
306<p>Allowed values: &gt;= 0</p>
307<p>Default value: 50</p>
308</div>
309</div>
310</div>
311<div class="footer">
312<hr>Generated by GTK-Doc V1.28</div>
313</body>
314</html>