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>zbar: 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-yadif.html" title="yadif"> 10<link rel="next" href="gst-plugins-bad-plugins-zebrastripe.html" title="zebrastripe"> 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-bad-plugins-zbar.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-zbar.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-zbar.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-yadif.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-zebrastripe.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-zbar"></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-zbar.top_of_page"></a>zbar</span></h2> 32<p>zbar</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-zbar.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#gboolean"><span class="type">gboolean</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-zbar.html#GstZBar--message" title="The “message” property">message</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#gboolean"><span class="type">gboolean</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-zbar.html#GstZBar--cache" title="The “cache” property">cache</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#gboolean"><span class="type">gboolean</span></a></td> 57<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-zbar.html#GstZBar--attach-frame" title="The “attach-frame” property">attach-frame</a></td> 58<td class="property_flags">Read / Write</td> 59</tr> 60</tbody> 61</table></div> 62</div> 63<a name="GstZBar"></a><div class="refsect1"> 64<a name="gst-plugins-bad-plugins-zbar.other"></a><h2>Types and Values</h2> 65<div class="informaltable"><table class="informaltable" width="100%" border="0"> 66<colgroup> 67<col width="150px" class="name"> 68<col class="description"> 69</colgroup> 70<tbody><tr> 71<td class="datatype_keyword">struct</td> 72<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-zbar.html#GstZBar-struct" title="struct GstZBar">GstZBar</a></td> 73</tr></tbody> 74</table></div> 75</div> 76<div class="refsect1"> 77<a name="gst-plugins-bad-plugins-zbar.object-hierarchy"></a><h2>Object Hierarchy</h2> 78<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 79 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 80 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 81 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 82 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 83 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoFilter.html#GstVideoFilter-struct">GstVideoFilter</a> 84 <span class="lineart">╰──</span> GstZBar 85</pre> 86</div> 87<div class="refsect1"> 88<a name="gst-plugins-bad-plugins-zbar.description"></a><h2>Description</h2> 89<p>Detect bar codes in the video streams and send them as element messages to 90the <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBus.html#GstBus-struct"><span class="type">GstBus</span></a> if .<a class="link" href="gst-plugins-bad-plugins-zbar.html#GstZBar--message" title="The “message” property"><span class="type">“message”</span></a> property is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>. 91If the .<a class="link" href="gst-plugins-bad-plugins-zbar.html#GstZBar--attach-frame" title="The “attach-frame” property"><span class="type">“attach-frame”</span></a> property is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the posted barcode message 92includes a sample of the frame where the barcode was detected (Since 1.6).</p> 93<p>The element generate messages named<code class="literal">barcode</code>. The structure containes these fields:</p> 94<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 95<li class="listitem"><p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> <code class="literal">timestamp</code>: the timestamp of the buffer that triggered the message.</p></li> 96<li class="listitem"><p>gchar * <code class="literal">type</code>: the symbol type.</p></li> 97<li class="listitem"><p>gchar * <code class="literal">symbol</code>: the deteted bar code data.</p></li> 98<li class="listitem"><p>gint <code class="literal">quality</code>: an unscaled, relative quantity: larger values are better than smaller 99values.</p></li> 100<li class="listitem"><p>GstSample <code class="literal">frame</code>: the frame in which the barcode message was detected, if 101the .<a class="link" href="gst-plugins-bad-plugins-zbar.html#GstZBar--attach-frame" title="The “attach-frame” property"><span class="type">“attach-frame”</span></a> property was set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> (Since 1.6)</p></li> 102</ul></div> 103<div class="refsect3"> 104<a name="id-1.2.262.7.5"></a><h4>Example launch lines</h4> 105<div class="informalexample"> 106 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 107 <tbody> 108 <tr> 109 <td class="listing_lines" align="right"><pre>1</pre></td> 110 <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>m v4l2src <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> zbar <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> xvimagesink</pre></td> 111 </tr> 112 </tbody> 113 </table> 114</div> 115 116<p> This pipeline will detect barcodes and send them as messages.</p> 117<div class="informalexample"> 118 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 119 <tbody> 120 <tr> 121 <td class="listing_lines" align="right"><pre>1</pre></td> 122 <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>m v4l2src <span class="gtkdoc opt">!</span> tee name<span class="gtkdoc opt">=</span>t <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> zbar <span class="gtkdoc opt">!</span> fakesink t<span class="gtkdoc opt">. !</span> queue <span class="gtkdoc opt">!</span> xvimagesink</pre></td> 123 </tr> 124 </tbody> 125 </table> 126</div> 127 128<p> Same as above, but running the filter on a branch to keep the display in color</p> 129</div> 130<div class="refsynopsisdiv"> 131<h2>Synopsis</h2> 132<div class="refsect2"> 133<a name="id-1.2.262.7.6.1"></a><h3>Element Information</h3> 134<div class="variablelist"><table border="0" class="variablelist"> 135<colgroup> 136<col align="left" valign="top"> 137<col> 138</colgroup> 139<tbody> 140<tr> 141<td><p><span class="term">plugin</span></p></td> 142<td> 143 <a class="link" href="gst-plugins-bad-plugins-plugin-zbar.html#plugin-zbar">zbar</a> 144 </td> 145</tr> 146<tr> 147<td><p><span class="term">author</span></p></td> 148<td>Stefan Kost <ensonic@users.sf.net></td> 149</tr> 150<tr> 151<td><p><span class="term">class</span></p></td> 152<td>Filter/Analyzer/Video</td> 153</tr> 154</tbody> 155</table></div> 156</div> 157<hr> 158<div class="refsect2"> 159<a name="id-1.2.262.7.6.2"></a><h3>Element Pads</h3> 160<div class="variablelist"><table border="0" class="variablelist"> 161<colgroup> 162<col align="left" valign="top"> 163<col> 164</colgroup> 165<tbody> 166<tr> 167<td><p><span class="term">name</span></p></td> 168<td>sink</td> 169</tr> 170<tr> 171<td><p><span class="term">direction</span></p></td> 172<td>sink</td> 173</tr> 174<tr> 175<td><p><span class="term">presence</span></p></td> 176<td>always</td> 177</tr> 178<tr> 179<td><p><span class="term">details</span></p></td> 180<td>video/x-raw, format=(string){ Y800, I420, YV12, NV12, NV21, Y41B, Y42B, YUV9, YVU9 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 181</tr> 182</tbody> 183</table></div> 184<div class="variablelist"><table border="0" class="variablelist"> 185<colgroup> 186<col align="left" valign="top"> 187<col> 188</colgroup> 189<tbody> 190<tr> 191<td><p><span class="term">name</span></p></td> 192<td>src</td> 193</tr> 194<tr> 195<td><p><span class="term">direction</span></p></td> 196<td>source</td> 197</tr> 198<tr> 199<td><p><span class="term">presence</span></p></td> 200<td>always</td> 201</tr> 202<tr> 203<td><p><span class="term">details</span></p></td> 204<td>video/x-raw, format=(string){ Y800, I420, YV12, NV12, NV21, Y41B, Y42B, YUV9, YVU9 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 205</tr> 206</tbody> 207</table></div> 208</div> 209</div> 210</div> 211<div class="refsect1"> 212<a name="gst-plugins-bad-plugins-zbar.functions_details"></a><h2>Functions</h2> 213<p></p> 214</div> 215<div class="refsect1"> 216<a name="gst-plugins-bad-plugins-zbar.other_details"></a><h2>Types and Values</h2> 217<div class="refsect2"> 218<a name="GstZBar-struct"></a><h3>struct GstZBar</h3> 219<pre class="programlisting">struct GstZBar;</pre> 220<p>Opaque data structure.</p> 221</div> 222</div> 223<div class="refsect1"> 224<a name="gst-plugins-bad-plugins-zbar.property-details"></a><h2>Property Details</h2> 225<div class="refsect2"> 226<a name="GstZBar--message"></a><h3>The <code class="literal">“message”</code> property</h3> 227<pre class="programlisting"> “message” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 228<p>Post a barcode message for each detected code.</p> 229<p>Flags: Read / Write</p> 230<p>Default value: TRUE</p> 231</div> 232<hr> 233<div class="refsect2"> 234<a name="GstZBar--cache"></a><h3>The <code class="literal">“cache”</code> property</h3> 235<pre class="programlisting"> “cache” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 236<p>Enable or disable the inter-image result cache.</p> 237<p>Flags: Read / Write</p> 238<p>Default value: FALSE</p> 239</div> 240<hr> 241<div class="refsect2"> 242<a name="GstZBar--attach-frame"></a><h3>The <code class="literal">“attach-frame”</code> property</h3> 243<pre class="programlisting"> “attach-frame” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 244<p>Attach a frame dump to each barcode message.</p> 245<p>Flags: Read / Write</p> 246<p>Default value: FALSE</p> 247</div> 248</div> 249</div> 250<div class="footer"> 251<hr>Generated by GTK-Doc V1.28</div> 252</body> 253</html>
