~ubuntu-branches/ubuntu/precise/gst-plugins-bad0.10/precise-proposed

« back to all changes in this revision

Viewing changes to docs/plugins/html/gst-plugins-bad-plugins-zbar.html

Tags: upstream-0.10.17.2
Import upstream version 0.10.17.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>zbar</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="GStreamer Bad Plugins 0.10 Plugins Reference Manual">
8
8
<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9
9
<link rel="prev" href="gst-plugins-bad-plugins-wildmidi.html" title="wildmidi">
10
10
<link rel="next" href="ch02.html" title="gst-plugins-bad Plugins">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="ch01.html" title="gst-plugins-bad Elements">
14
14
<link rel="chapter" href="ch02.html" title="gst-plugins-bad Plugins">
25
25
</tr>
26
26
<tr><td colspan="5" class="shortcuts">
27
27
<a href="#gst-plugins-bad-plugins-zbar.synopsis" class="shortcut">Top</a>
28
 
                 | 
29
 
                <a href="#gst-plugins-bad-plugins-zbar.description" class="shortcut">Description</a>
 
28
                   | 
 
29
                  <a href="#gst-plugins-bad-plugins-zbar.description" class="shortcut">Description</a>
 
30
                   | 
 
31
                  <a href="#gst-plugins-bad-plugins-zbar.properties" class="shortcut">Properties</a>
30
32
</td></tr>
31
33
</table>
32
34
<div class="refentry" title="zbar">
40
42
</tr></table></div>
41
43
<div class="refsynopsisdiv" title="Synopsis">
42
44
<a name="gst-plugins-bad-plugins-zbar.synopsis"></a><h2>Synopsis</h2>
 
45
<pre class="synopsis">                    <a class="link" href="gst-plugins-bad-plugins-zbar.html#GstZBar" title="GstZBar">GstZBar</a>;
 
46
</pre>
 
47
</div>
 
48
<div class="refsect1" title="Properties">
 
49
<a name="gst-plugins-bad-plugins-zbar.properties"></a><h2>Properties</h2>
43
50
<pre class="synopsis">
44
 
                    <a class="link" href="gst-plugins-bad-plugins-zbar.html#GstZBar" title="GstZBar">GstZBar</a>;
 
51
  "<a class="link" href="gst-plugins-bad-plugins-zbar.html#GstZBar--message" title='The "message" property'>message</a>"                  <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
45
52
</pre>
46
53
</div>
47
54
<div class="refsect1" title="Description">
48
55
<a name="gst-plugins-bad-plugins-zbar.description"></a><h2>Description</h2>
49
56
<p>
50
57
Detect bar codes in the video streams and send them as element messages to
51
 
the <a
52
 
href="../gstreamer-0.10/GstBus.html"
53
 
><span class="type">GstBus</span></a> if .<span class="type">"message"</span> property is <a
54
 
href="../glib/glib-Standard-Macros.html#TRUE--CAPS"
55
 
><code class="literal">TRUE</code></a>.
 
58
the <a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstBus.html"><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>.
56
59
</p>
57
60
<p>
58
61
The element generate messages named
61
64
</p>
62
65
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
63
66
<li class="listitem"><p>
64
 
  <a
65
 
href="../gstreamer-0.10/GstClock.html#GstClockTime"
66
 
><span class="type">GstClockTime</span></a>
 
67
  <a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a>
67
68
  <code class="classname">"timestamp"</code>:
68
69
  the timestamp of the buffer that triggered the message.
69
70
  </p></li>
89
90
<p>
90
91
</p>
91
92
<div class="refsect2" title="Example launch lines">
92
 
<a name="id3117130"></a><h3>Example launch lines</h3>
93
 
<div class="informalexample"><pre class="programlisting">
94
 
gst-launch -m v4l2src ! ffmpegcolorspace ! zbar ! ffmpegcolorspace ! xvimagesink
95
 
</pre></div> This pipeline will detect barcodes and send them as messages.
96
 
<div class="informalexample"><pre class="programlisting">
97
 
gst-launch -m v4l2src ! tee name=t ! queue ! ffmpegcolorspace ! zbar ! fakesink t. ! queue ! xvimagesink
98
 
</pre></div> Same as above, but running the filter on a branch to keep the display in color
99
 
</div>
100
 
<div class="refsynopsisdiv" title="Synopsis">
101
 
<h2>Synopsis</h2>
102
 
<div class="refsect2" title="Element Information">
103
 
<a name="id3118106"></a><h3>Element Information</h3>
104
 
<div class="variablelist"><table border="0">
105
 
<col align="left" valign="top">
106
 
<tbody>
107
 
<tr>
108
 
<td><p><span class="term">plugin</span></p></td>
109
 
<td>
110
 
            <a class="link" href="gst-plugins-bad-plugins-plugin-zbar.html#plugin-zbar">zbar</a>
111
 
          </td>
112
 
</tr>
113
 
<tr>
114
 
<td><p><span class="term">author</span></p></td>
115
 
<td>Stefan Kost &lt;ensonic@users.sf.net&gt;</td>
116
 
</tr>
117
 
<tr>
118
 
<td><p><span class="term">class</span></p></td>
119
 
<td>Filter/Analyzer/Video</td>
120
 
</tr>
121
 
</tbody>
122
 
</table></div>
123
 
</div>
124
 
<hr>
125
 
<div class="refsect2" title="Element Pads">
126
 
<a name="id3178615"></a><h3>Element Pads</h3>
127
 
<div class="variablelist"><table border="0">
128
 
<col align="left" valign="top">
129
 
<tbody>
130
 
<tr>
131
 
<td><p><span class="term">name</span></p></td>
132
 
<td>src</td>
133
 
</tr>
134
 
<tr>
135
 
<td><p><span class="term">direction</span></p></td>
136
 
<td>source</td>
137
 
</tr>
138
 
<tr>
139
 
<td><p><span class="term">presence</span></p></td>
140
 
<td>always</td>
141
 
</tr>
142
 
<tr>
143
 
<td><p><span class="term">details</span></p></td>
144
 
<td>video/x-raw-yuv, format=(fourcc){ Y800 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</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>sink</td>
154
 
</tr>
155
 
<tr>
156
 
<td><p><span class="term">direction</span></p></td>
157
 
<td>sink</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){ Y800 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
166
 
</tr>
167
 
</tbody>
168
 
</table></div>
169
 
</div>
170
 
</div>
171
 
<p>
172
 
</p>
 
93
<a name="id434496"></a><h3>Example launch lines</h3>
 
94
<div class="informalexample">
 
95
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
96
    <tbody>
 
97
      <tr>
 
98
        <td class="listing_lines" align="right"><pre>1</pre></td>
 
99
        <td class="listing_code"><pre class="programlisting">gst<span class="symbol">-</span>launch <span class="symbol">-</span>m v4l2src <span class="symbol">!</span> ffmpegcolorspace <span class="symbol">!</span> zbar <span class="symbol">!</span> ffmpegcolorspace <span class="symbol">!</span> xvimagesink</pre></td>
 
100
      </tr>
 
101
    </tbody>
 
102
  </table>
 
103
</div>
 
104
 This pipeline will detect barcodes and send them as messages.
 
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="symbol">-</span>launch <span class="symbol">-</span>m v4l2src <span class="symbol">!</span> tee name<span class="symbol">=</span>t <span class="symbol">!</span> queue <span class="symbol">!</span> ffmpegcolorspace <span class="symbol">!</span> zbar <span class="symbol">!</span> fakesink t<span class="symbol">. !</span> queue <span class="symbol">!</span> xvimagesink</pre></td>
 
111
      </tr>
 
112
    </tbody>
 
113
  </table>
 
114
</div>
 
115
 Same as above, but running the filter on a branch to keep the display in color
 
116
</div>
173
117
</div>
174
118
<div class="refsect1" title="Details">
175
119
<a name="gst-plugins-bad-plugins-zbar.details"></a><h2>Details</h2>
176
120
<div class="refsect2" title="GstZBar">
177
121
<a name="GstZBar"></a><h3>GstZBar</h3>
178
122
<pre class="programlisting">typedef struct {
179
 
  GstVideoFilter videofilter;
180
 
 
181
 
  /* format */
182
 
  gint width;
183
 
  gint height;
184
 
 
185
 
  /* properties */
186
 
  gboolean message;
187
 
  
188
 
  /* internals */
189
 
  zbar_image_scanner_t *scanner;
190
123
} GstZBar;
191
124
</pre>
192
125
<p>
193
126
Opaque data structure.</p>
194
 
<p>
195
 
</p>
 
127
</div>
 
128
</div>
 
129
<div class="refsect1" title="Property Details">
 
130
<a name="gst-plugins-bad-plugins-zbar.property-details"></a><h2>Property Details</h2>
 
131
<div class="refsect2" title='The "message" property'>
 
132
<a name="GstZBar--message"></a><h3>The <code class="literal">"message"</code> property</h3>
 
133
<pre class="programlisting">  "message"                  <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
134
<p>Post a barcode message for each detected code.</p>
 
135
<p>Default value: TRUE</p>
196
136
</div>
197
137
</div>
198
138
</div>
199
139
<div class="footer">
200
140
<hr>
201
 
          Generated by GTK-Doc V1.11</div>
 
141
          Generated by GTK-Doc V1.13</div>
202
142
</body>
203
 
</html>
 
143
</html>
 
 
b'\\ No newline at end of file'