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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Tony Espy
  • Date: 2009-12-04 13:17:51 UTC
  • mfrom: (18.4.7 squeeze)
  • Revision ID: james.westby@ubuntu.com-20091204131751-hpo02yltrcsmy1xh
Tags: 0.10.17-1ubuntu1
* Merge from Debian testing (LP: #481645), remaining changes:
  - Removed plugins that are now provided -good
    - libgstdtmf.so
    - libgstvalve.so
    - libgstautoconvert.so
    - libgstrtpmux.so
    - libgstliveadder.so

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>videoanalyse</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
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-valve.html" title="valve">
52
52
<a name="gst-plugins-bad-plugins-videoanalyse.object-hierarchy"></a><h2>Object Hierarchy</h2>
53
53
<pre class="synopsis">
54
54
  <a
55
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
55
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
56
56
>GObject</a>
57
57
   +----<a
58
 
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstObject.html"
 
58
href="../gstreamer-0.10/GstObject.html"
59
59
>GstObject</a>
60
60
         +----<a
61
 
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstElement.html"
 
61
href="../gstreamer-0.10/GstElement.html"
62
62
>GstElement</a>
63
63
               +----<a
64
 
href="/usr/share/gtk-doc/html/gstreamer-libs-0.10/GstBaseTransform.html"
 
64
href="../gstreamer-libs-0.10/GstBaseTransform.html"
65
65
>GstBaseTransform</a>
66
66
                     +----<a
67
 
href="/usr/share/gtk-doc/html/gst-plugins-base-libs-0.10/gst-plugins-base-libs-gstvideofilter.html#GstVideoFilter"
 
67
href="../gst-plugins-base-libs-0.10/gst-plugins-base-libs-gstvideofilter.html#GstVideoFilter"
68
68
>GstVideoFilter</a>
69
69
                           +----GstVideoAnalyse
70
70
</pre>
73
73
<a name="gst-plugins-bad-plugins-videoanalyse.properties"></a><h2>Properties</h2>
74
74
<pre class="synopsis">
75
75
  "<a class="link" href="gst-plugins-bad-plugins-videoanalyse.html#GstVideoAnalyse--message" title='The "message" property'>message</a>"                  <a
76
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
76
href="../glib/glib-Basic-Types.html#gboolean"
77
77
>gboolean</a>              : Read / Write / Construct
78
78
</pre>
79
79
</div>
82
82
<p>
83
83
This plugin analyses every video frame and if the <a class="link" href="gst-plugins-bad-plugins-videoanalyse.html#GstVideoAnalyse--message" title='The "message" property'><span class="type">"message"</span></a>
84
84
property is <a
85
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
 
85
href="../glib/glib-Standard-Macros.html#TRUE--CAPS"
86
86
><span class="type">TRUE</span></a>, posts an element message with video statistics called
87
87
<code class="classname">"GstVideoAnalyse"</code>.
88
88
</p>
92
92
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
93
93
<li class="listitem"><p>
94
94
  <a
95
 
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html#GstClockTime"
 
95
href="../gstreamer-0.10/GstClock.html#GstClockTime"
96
96
><span class="type">GstClockTime</span></a>
97
97
  <code class="classname">"timestamp"</code>:
98
98
  the timestamp of the buffer that triggered the message.
99
99
  </p></li>
100
100
<li class="listitem"><p>
101
101
  <a
102
 
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html#GstClockTime"
 
102
href="../gstreamer-0.10/GstClock.html#GstClockTime"
103
103
><span class="type">GstClockTime</span></a>
104
104
  <code class="classname">"stream-time"</code>:
105
105
  the stream time of the buffer.
106
106
  </p></li>
107
107
<li class="listitem"><p>
108
108
  <a
109
 
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html#GstClockTime"
 
109
href="../gstreamer-0.10/GstClock.html#GstClockTime"
110
110
><span class="type">GstClockTime</span></a>
111
111
  <code class="classname">"running-time"</code>:
112
112
  the running_time of the buffer.
113
113
  </p></li>
114
114
<li class="listitem"><p>
115
115
  <a
116
 
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html#GstClockTime"
 
116
href="../gstreamer-0.10/GstClock.html#GstClockTime"
117
117
><span class="type">GstClockTime</span></a>
118
118
  <code class="classname">"duration"</code>:
119
119
  the duration of the buffer.
120
120
  </p></li>
121
121
<li class="listitem"><p>
122
122
  <a
123
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"
 
123
href="../glib/glib-Basic-Types.html#gdouble"
124
124
><span class="type">gdouble</span></a>
125
125
  <code class="classname">"brightness"</code>:
126
126
  the average brightness of the frame.
127
127
  </p></li>
128
128
<li class="listitem"><p>
129
129
  <a
130
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"
 
130
href="../glib/glib-Basic-Types.html#gdouble"
131
131
><span class="type">gdouble</span></a>
132
132
  <code class="classname">"brightness-variance"</code>:
133
133
  the brightness variance of the frame.
138
138
<p>
139
139
</p>
140
140
<div class="refsect2" title="Example launch line">
141
 
<a name="id521218"></a><h3>Example launch line</h3>
 
141
<a name="id2897645"></a><h3>Example launch line</h3>
142
142
<div class="informalexample"><pre class="programlisting">
143
143
gst-launch -m videotestsrc ! videoanalyse ! ffmpegcolorspace ! ximagesink
144
144
</pre></div> This pipeline emits messages to the console for each frame that has been analysed. 
150
150
<div class="refsynopsisdiv" title="Synopsis">
151
151
<h2>Synopsis</h2>
152
152
<div class="refsect2" title="Element Information">
153
 
<a name="id521242"></a><h3>Element Information</h3>
 
153
<a name="id2897673"></a><h3>Element Information</h3>
154
154
<div class="variablelist"><table border="0">
155
155
<col align="left" valign="top">
156
156
<tbody>
173
173
</div>
174
174
<hr>
175
175
<div class="refsect2" title="Element Pads">
176
 
<a name="id521304"></a><h3>Element Pads</h3>
 
176
<a name="id2897736"></a><h3>Element Pads</h3>
177
177
<div class="variablelist"><table border="0">
178
178
<col align="left" valign="top">
179
179
<tbody>
237
237
<div class="refsect2" title='The "message" property'>
238
238
<a name="GstVideoAnalyse--message"></a><h3>The <code class="literal">"message"</code> property</h3>
239
239
<pre class="programlisting">  "message"                  <a
240
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
240
href="../glib/glib-Basic-Types.html#gboolean"
241
241
>gboolean</a>              : Read / Write / Construct</pre>
242
242
<p>Post statics messages.</p>
243
243
<p>Default value: TRUE</p>