~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-videomark.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2010-08-21 22:00:02 UTC
  • mto: (18.3.14 experimental) (1.2.16 upstream)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20100821220002-odvockt6147viosl
Tags: upstream-0.10.19.4
Import upstream version 0.10.19.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
47
47
<div class="refsect1" title="Object Hierarchy">
48
48
<a name="gst-plugins-bad-plugins-videomark.object-hierarchy"></a><h2>Object Hierarchy</h2>
49
49
<pre class="synopsis">
50
 
  <a href="http://library.gnome.org/devel/gobject/stable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
50
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
51
51
   +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
52
52
         +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
53
53
               +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
58
58
<div class="refsect1" title="Properties">
59
59
<a name="gst-plugins-bad-plugins-videomark.properties"></a><h2>Properties</h2>
60
60
<pre class="synopsis">
61
 
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--enabled" title='The "enabled" property'>enabled</a>"                  <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
62
 
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-count" title='The "pattern-count" property'>pattern-count</a>"            <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
63
 
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-data" title='The "pattern-data" property'>pattern-data</a>"             <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
64
 
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-data-count" title='The "pattern-data-count" property'>pattern-data-count</a>"       <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
65
 
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-height" title='The "pattern-height" property'>pattern-height</a>"           <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
66
 
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-width" title='The "pattern-width" property'>pattern-width</a>"            <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
67
 
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--bottom-offset" title='The "bottom-offset" property'>bottom-offset</a>"            <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
68
 
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--left-offset" title='The "left-offset" property'>left-offset</a>"              <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
69
 
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-data-uint64" title='The "pattern-data-uint64" property'>pattern-data-uint64</a>"      <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write / Construct
 
61
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--enabled" title='The "enabled" property'>enabled</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
 
62
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-count" title='The "pattern-count" property'>pattern-count</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
 
63
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-data" title='The "pattern-data" property'>pattern-data</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
 
64
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-data-count" title='The "pattern-data-count" property'>pattern-data-count</a>"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
 
65
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-height" title='The "pattern-height" property'>pattern-height</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
 
66
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-width" title='The "pattern-width" property'>pattern-width</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
 
67
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--bottom-offset" title='The "bottom-offset" property'>bottom-offset</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
 
68
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--left-offset" title='The "left-offset" property'>left-offset</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
 
69
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-data-uint64" title='The "pattern-data-uint64" property'>pattern-data-uint64</a>"      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write / Construct
70
70
</pre>
71
71
</div>
72
72
<div class="refsect1" title="Description">
88
88
mostly used together with the <a class="link" href="gst-plugins-bad-plugins-videodetect.html#GstVideoDetect"><span class="type">GstVideoDetect</span></a> plugin.
89
89
</p>
90
90
<div class="refsect2" title="Example launch line">
91
 
<a name="id498752"></a><h3>Example launch line</h3>
 
91
<a name="id596770"></a><h3>Example launch line</h3>
92
92
<div class="informalexample">
93
93
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
94
94
    <tbody>
119
119
<a name="gst-plugins-bad-plugins-videomark.property-details"></a><h2>Property Details</h2>
120
120
<div class="refsect2" title='The "enabled" property'>
121
121
<a name="GstVideoMark--enabled"></a><h3>The <code class="literal">"enabled"</code> property</h3>
122
 
<pre class="programlisting">  "enabled"                  <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
 
122
<pre class="programlisting">  "enabled"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
123
123
<p>Enable or disable the filter.</p>
124
124
<p>Default value: TRUE</p>
125
125
</div>
126
126
<hr>
127
127
<div class="refsect2" title='The "pattern-count" property'>
128
128
<a name="GstVideoMark--pattern-count"></a><h3>The <code class="literal">"pattern-count"</code> property</h3>
129
 
<pre class="programlisting">  "pattern-count"            <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
 
129
<pre class="programlisting">  "pattern-count"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
130
130
<p>The number of pattern markers.</p>
131
131
<p>Allowed values: &gt;= 0</p>
132
132
<p>Default value: 4</p>
134
134
<hr>
135
135
<div class="refsect2" title='The "pattern-data" property'>
136
136
<a name="GstVideoMark--pattern-data"></a><h3>The <code class="literal">"pattern-data"</code> property</h3>
137
 
<pre class="programlisting">  "pattern-data"             <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
137
<pre class="programlisting">  "pattern-data"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
138
138
<p>The extra data pattern markers.</p>
139
139
<p>Allowed values: &gt;= 0</p>
140
140
<p>Default value: 10</p>
142
142
<hr>
143
143
<div class="refsect2" title='The "pattern-data-count" property'>
144
144
<a name="GstVideoMark--pattern-data-count"></a><h3>The <code class="literal">"pattern-data-count"</code> property</h3>
145
 
<pre class="programlisting">  "pattern-data-count"       <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
 
145
<pre class="programlisting">  "pattern-data-count"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
146
146
<p>The number of extra data pattern markers.</p>
147
147
<p>Allowed values: [0,64]</p>
148
148
<p>Default value: 5</p>
150
150
<hr>
151
151
<div class="refsect2" title='The "pattern-height" property'>
152
152
<a name="GstVideoMark--pattern-height"></a><h3>The <code class="literal">"pattern-height"</code> property</h3>
153
 
<pre class="programlisting">  "pattern-height"           <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
 
153
<pre class="programlisting">  "pattern-height"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
154
154
<p>The height of the pattern markers.</p>
155
155
<p>Allowed values: &gt;= 1</p>
156
156
<p>Default value: 16</p>
158
158
<hr>
159
159
<div class="refsect2" title='The "pattern-width" property'>
160
160
<a name="GstVideoMark--pattern-width"></a><h3>The <code class="literal">"pattern-width"</code> property</h3>
161
 
<pre class="programlisting">  "pattern-width"            <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
 
161
<pre class="programlisting">  "pattern-width"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
162
162
<p>The width of the pattern markers.</p>
163
163
<p>Allowed values: &gt;= 1</p>
164
164
<p>Default value: 4</p>
166
166
<hr>
167
167
<div class="refsect2" title='The "bottom-offset" property'>
168
168
<a name="GstVideoMark--bottom-offset"></a><h3>The <code class="literal">"bottom-offset"</code> property</h3>
169
 
<pre class="programlisting">  "bottom-offset"            <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
 
169
<pre class="programlisting">  "bottom-offset"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
170
170
<p>The offset from the bottom border where the pattern starts.</p>
171
171
<p>Allowed values: &gt;= 0</p>
172
172
<p>Default value: 0</p>
174
174
<hr>
175
175
<div class="refsect2" title='The "left-offset" property'>
176
176
<a name="GstVideoMark--left-offset"></a><h3>The <code class="literal">"left-offset"</code> property</h3>
177
 
<pre class="programlisting">  "left-offset"              <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
 
177
<pre class="programlisting">  "left-offset"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
178
178
<p>The offset from the left border where the pattern starts.</p>
179
179
<p>Allowed values: &gt;= 0</p>
180
180
<p>Default value: 0</p>
182
182
<hr>
183
183
<div class="refsect2" title='The "pattern-data-uint64" property'>
184
184
<a name="GstVideoMark--pattern-data-uint64"></a><h3>The <code class="literal">"pattern-data-uint64"</code> property</h3>
185
 
<pre class="programlisting">  "pattern-data-uint64"      <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write / Construct</pre>
 
185
<pre class="programlisting">  "pattern-data-uint64"      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write / Construct</pre>
186
186
<p>The extra data pattern markers.</p>
187
187
<p>Default value: 10</p>
188
188
</div>