~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

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>videomark</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-videodetect.html" title="videodetect">
10
10
<link rel="next" href="gst-plugins-bad-plugins-videoparse.html" title="videoparse">
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-videomark.synopsis" class="shortcut">Top</a>
28
 
                 | 
29
 
                <a href="#gst-plugins-bad-plugins-videomark.description" class="shortcut">Description</a>
30
 
                 | 
31
 
                <a href="#gst-plugins-bad-plugins-videomark.object-hierarchy" class="shortcut">Object Hierarchy</a>
32
 
                 | 
33
 
                <a href="#gst-plugins-bad-plugins-videomark.properties" class="shortcut">Properties</a>
 
28
                   | 
 
29
                  <a href="#gst-plugins-bad-plugins-videomark.description" class="shortcut">Description</a>
 
30
                   | 
 
31
                  <a href="#gst-plugins-bad-plugins-videomark.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
32
                   | 
 
33
                  <a href="#gst-plugins-bad-plugins-videomark.properties" class="shortcut">Properties</a>
34
34
</td></tr>
35
35
</table>
36
36
<div class="refentry" title="videomark">
44
44
</tr></table></div>
45
45
<div class="refsynopsisdiv" title="Synopsis">
46
46
<a name="gst-plugins-bad-plugins-videomark.synopsis"></a><h2>Synopsis</h2>
47
 
<a name="GstVideoMark"></a><pre class="synopsis">
48
 
                    <a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark-struct" title="GstVideoMark">GstVideoMark</a>;
 
47
<a name="GstVideoMark"></a><pre class="synopsis">                    <a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark-struct" title="GstVideoMark">GstVideoMark</a>;
49
48
</pre>
50
49
</div>
51
50
<div class="refsect1" title="Object Hierarchy">
52
51
<a name="gst-plugins-bad-plugins-videomark.object-hierarchy"></a><h2>Object Hierarchy</h2>
53
52
<pre class="synopsis">
54
 
  <a
55
 
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
56
 
>GObject</a>
57
 
   +----<a
58
 
href="../gstreamer-0.10/GstObject.html"
59
 
>GstObject</a>
60
 
         +----<a
61
 
href="../gstreamer-0.10/GstElement.html"
62
 
>GstElement</a>
63
 
               +----<a
64
 
href="../gstreamer-libs-0.10/GstBaseTransform.html"
65
 
>GstBaseTransform</a>
66
 
                     +----<a
67
 
href="../gst-plugins-base-libs-0.10/gst-plugins-base-libs-gstvideofilter.html#GstVideoFilter"
68
 
>GstVideoFilter</a>
 
53
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
54
   +----<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstObject.html">GstObject</a>
 
55
         +----<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstElement.html">GstElement</a>
 
56
               +----<a href="/usr/share/gtk-doc/html/gstreamer-libs-0.10/GstBaseTransform.html">GstBaseTransform</a>
 
57
                     +----<a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-0.10/gst-plugins-base-libs-gstvideofilter.html#GstVideoFilter">GstVideoFilter</a>
69
58
                           +----GstVideoMark
70
59
</pre>
71
60
</div>
72
61
<div class="refsect1" title="Properties">
73
62
<a name="gst-plugins-bad-plugins-videomark.properties"></a><h2>Properties</h2>
74
63
<pre class="synopsis">
75
 
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--enabled" title='The "enabled" property'>enabled</a>"                  <a
76
 
href="../glib/glib-Basic-Types.html#gboolean"
77
 
>gboolean</a>              : Read / Write / Construct
78
 
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-count" title='The "pattern-count" property'>pattern-count</a>"            <a
79
 
href="../glib/glib-Basic-Types.html#gint"
80
 
>gint</a>                  : Read / Write / Construct
81
 
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-data" title='The "pattern-data" property'>pattern-data</a>"             <a
82
 
href="../glib/glib-Basic-Types.html#gint"
83
 
>gint</a>                  : Read / Write
84
 
  "<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
85
 
href="../glib/glib-Basic-Types.html#gint"
86
 
>gint</a>                  : Read / Write / Construct
87
 
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-height" title='The "pattern-height" property'>pattern-height</a>"           <a
88
 
href="../glib/glib-Basic-Types.html#gint"
89
 
>gint</a>                  : Read / Write / Construct
90
 
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-width" title='The "pattern-width" property'>pattern-width</a>"            <a
91
 
href="../glib/glib-Basic-Types.html#gint"
92
 
>gint</a>                  : Read / Write / Construct
93
 
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--bottom-offset" title='The "bottom-offset" property'>bottom-offset</a>"            <a
94
 
href="../glib/glib-Basic-Types.html#gint"
95
 
>gint</a>                  : Read / Write / Construct
96
 
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--left-offset" title='The "left-offset" property'>left-offset</a>"              <a
97
 
href="../glib/glib-Basic-Types.html#gint"
98
 
>gint</a>                  : Read / Write / Construct
99
 
  "<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
100
 
href="../glib/glib-Basic-Types.html#guint64"
101
 
>guint64</a>               : Read / Write / Construct
 
64
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--enabled" title='The "enabled" property'>enabled</a>"                  <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
 
65
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-count" title='The "pattern-count" property'>pattern-count</a>"            <a href="/usr/share/gtk-doc/html/glib/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-data" title='The "pattern-data" property'>pattern-data</a>"             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
 
67
  "<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="/usr/share/gtk-doc/html/glib/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--pattern-height" title='The "pattern-height" property'>pattern-height</a>"           <a href="/usr/share/gtk-doc/html/glib/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-width" title='The "pattern-width" property'>pattern-width</a>"            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
 
70
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--bottom-offset" title='The "bottom-offset" property'>bottom-offset</a>"            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
 
71
  "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--left-offset" title='The "left-offset" property'>left-offset</a>"              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
 
72
  "<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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write / Construct
102
73
</pre>
103
74
</div>
104
75
<div class="refsect1" title="Description">
122
93
<p>
123
94
</p>
124
95
<div class="refsect2" title="Example launch line">
125
 
<a name="id3174489"></a><h3>Example launch line</h3>
126
 
<div class="informalexample"><pre class="programlisting">
127
 
gst-launch videotestsrc ! videomark ! ximagesink
128
 
</pre></div> Add the default black/white squares at the bottom left of the video frames.
 
96
<a name="id430198"></a><h3>Example launch line</h3>
 
97
<div class="informalexample">
 
98
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
99
    <tbody>
 
100
      <tr>
 
101
        <td class="listing_lines" align="right"><pre>1</pre></td>
 
102
        <td class="listing_code"><pre class="programlisting">gst<span class="symbol">-</span>launch videotestsrc <span class="symbol">!</span> videomark <span class="symbol">!</span> ximagesink</pre></td>
 
103
      </tr>
 
104
    </tbody>
 
105
  </table>
 
106
</div>
 
107
 Add the default black/white squares at the bottom left of the video frames.
129
108
</div>
130
109
<p>
131
110
</p>
132
111
<p>
133
112
Last reviewed on 2007-06-01 (0.10.6)</p>
134
 
<div class="refsynopsisdiv" title="Synopsis">
135
 
<h2>Synopsis</h2>
136
 
<div class="refsect2" title="Element Information">
137
 
<a name="id3174517"></a><h3>Element Information</h3>
138
 
<div class="variablelist"><table border="0">
139
 
<col align="left" valign="top">
140
 
<tbody>
141
 
<tr>
142
 
<td><p><span class="term">plugin</span></p></td>
143
 
<td>
144
 
            <a class="link" href="gst-plugins-bad-plugins-plugin-videosignal.html#plugin-videosignal">videosignal</a>
145
 
          </td>
146
 
</tr>
147
 
<tr>
148
 
<td><p><span class="term">author</span></p></td>
149
 
<td>Wim Taymans &lt;wim@fluendo.com&gt;</td>
150
 
</tr>
151
 
<tr>
152
 
<td><p><span class="term">class</span></p></td>
153
 
<td>Filter/Effect/Video</td>
154
 
</tr>
155
 
</tbody>
156
 
</table></div>
157
 
</div>
158
 
<hr>
159
 
<div class="refsect2" title="Element Pads">
160
 
<a name="id3174580"></a><h3>Element Pads</h3>
161
 
<div class="variablelist"><table border="0">
162
 
<col align="left" valign="top">
163
 
<tbody>
164
 
<tr>
165
 
<td><p><span class="term">name</span></p></td>
166
 
<td>src</td>
167
 
</tr>
168
 
<tr>
169
 
<td><p><span class="term">direction</span></p></td>
170
 
<td>source</td>
171
 
</tr>
172
 
<tr>
173
 
<td><p><span class="term">presence</span></p></td>
174
 
<td>always</td>
175
 
</tr>
176
 
<tr>
177
 
<td><p><span class="term">details</span></p></td>
178
 
<td>video/x-raw-yuv, format=(fourcc){ I420, YV12, Y41B, Y42B, Y444, YUY2, UYVY, AYUV, YVYU }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
179
 
</tr>
180
 
</tbody>
181
 
</table></div>
182
 
<div class="variablelist"><table border="0">
183
 
<col align="left" valign="top">
184
 
<tbody>
185
 
<tr>
186
 
<td><p><span class="term">name</span></p></td>
187
 
<td>sink</td>
188
 
</tr>
189
 
<tr>
190
 
<td><p><span class="term">direction</span></p></td>
191
 
<td>sink</td>
192
 
</tr>
193
 
<tr>
194
 
<td><p><span class="term">presence</span></p></td>
195
 
<td>always</td>
196
 
</tr>
197
 
<tr>
198
 
<td><p><span class="term">details</span></p></td>
199
 
<td>video/x-raw-yuv, format=(fourcc){ I420, YV12, Y41B, Y42B, Y444, YUY2, UYVY, AYUV, YVYU }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
200
 
</tr>
201
 
</tbody>
202
 
</table></div>
203
 
</div>
204
 
</div>
205
 
<p>
206
 
</p>
207
113
</div>
208
114
<div class="refsect1" title="Details">
209
115
<a name="gst-plugins-bad-plugins-videomark.details"></a><h2>Details</h2>
212
118
<pre class="programlisting">typedef struct _GstVideoMark GstVideoMark;</pre>
213
119
<p>
214
120
Opaque datastructure.</p>
215
 
<p>
216
 
</p>
217
121
</div>
218
122
</div>
219
123
<div class="refsect1" title="Property Details">
220
124
<a name="gst-plugins-bad-plugins-videomark.property-details"></a><h2>Property Details</h2>
221
125
<div class="refsect2" title='The "enabled" property'>
222
126
<a name="GstVideoMark--enabled"></a><h3>The <code class="literal">"enabled"</code> property</h3>
223
 
<pre class="programlisting">  "enabled"                  <a
224
 
href="../glib/glib-Basic-Types.html#gboolean"
225
 
>gboolean</a>              : Read / Write / Construct</pre>
 
127
<pre class="programlisting">  "enabled"                  <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
226
128
<p>Enable or disable the filter.</p>
227
129
<p>Default value: TRUE</p>
228
130
</div>
229
131
<hr>
230
132
<div class="refsect2" title='The "pattern-count" property'>
231
133
<a name="GstVideoMark--pattern-count"></a><h3>The <code class="literal">"pattern-count"</code> property</h3>
232
 
<pre class="programlisting">  "pattern-count"            <a
233
 
href="../glib/glib-Basic-Types.html#gint"
234
 
>gint</a>                  : Read / Write / Construct</pre>
 
134
<pre class="programlisting">  "pattern-count"            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
235
135
<p>The number of pattern markers.</p>
236
136
<p>Allowed values: &gt;= 0</p>
237
137
<p>Default value: 4</p>
239
139
<hr>
240
140
<div class="refsect2" title='The "pattern-data" property'>
241
141
<a name="GstVideoMark--pattern-data"></a><h3>The <code class="literal">"pattern-data"</code> property</h3>
242
 
<pre class="programlisting">  "pattern-data"             <a
243
 
href="../glib/glib-Basic-Types.html#gint"
244
 
>gint</a>                  : Read / Write</pre>
 
142
<pre class="programlisting">  "pattern-data"             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
245
143
<p>The extra data pattern markers.</p>
246
144
<p>Allowed values: &gt;= 0</p>
247
145
<p>Default value: 10</p>
249
147
<hr>
250
148
<div class="refsect2" title='The "pattern-data-count" property'>
251
149
<a name="GstVideoMark--pattern-data-count"></a><h3>The <code class="literal">"pattern-data-count"</code> property</h3>
252
 
<pre class="programlisting">  "pattern-data-count"       <a
253
 
href="../glib/glib-Basic-Types.html#gint"
254
 
>gint</a>                  : Read / Write / Construct</pre>
 
150
<pre class="programlisting">  "pattern-data-count"       <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
255
151
<p>The number of extra data pattern markers.</p>
256
152
<p>Allowed values: [0,64]</p>
257
153
<p>Default value: 5</p>
259
155
<hr>
260
156
<div class="refsect2" title='The "pattern-height" property'>
261
157
<a name="GstVideoMark--pattern-height"></a><h3>The <code class="literal">"pattern-height"</code> property</h3>
262
 
<pre class="programlisting">  "pattern-height"           <a
263
 
href="../glib/glib-Basic-Types.html#gint"
264
 
>gint</a>                  : Read / Write / Construct</pre>
 
158
<pre class="programlisting">  "pattern-height"           <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
265
159
<p>The height of the pattern markers.</p>
266
160
<p>Allowed values: &gt;= 1</p>
267
161
<p>Default value: 16</p>
269
163
<hr>
270
164
<div class="refsect2" title='The "pattern-width" property'>
271
165
<a name="GstVideoMark--pattern-width"></a><h3>The <code class="literal">"pattern-width"</code> property</h3>
272
 
<pre class="programlisting">  "pattern-width"            <a
273
 
href="../glib/glib-Basic-Types.html#gint"
274
 
>gint</a>                  : Read / Write / Construct</pre>
 
166
<pre class="programlisting">  "pattern-width"            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
275
167
<p>The width of the pattern markers.</p>
276
168
<p>Allowed values: &gt;= 1</p>
277
169
<p>Default value: 4</p>
279
171
<hr>
280
172
<div class="refsect2" title='The "bottom-offset" property'>
281
173
<a name="GstVideoMark--bottom-offset"></a><h3>The <code class="literal">"bottom-offset"</code> property</h3>
282
 
<pre class="programlisting">  "bottom-offset"            <a
283
 
href="../glib/glib-Basic-Types.html#gint"
284
 
>gint</a>                  : Read / Write / Construct</pre>
 
174
<pre class="programlisting">  "bottom-offset"            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
285
175
<p>The offset from the bottom border where the pattern starts.</p>
286
176
<p>Allowed values: &gt;= 0</p>
287
177
<p>Default value: 0</p>
289
179
<hr>
290
180
<div class="refsect2" title='The "left-offset" property'>
291
181
<a name="GstVideoMark--left-offset"></a><h3>The <code class="literal">"left-offset"</code> property</h3>
292
 
<pre class="programlisting">  "left-offset"              <a
293
 
href="../glib/glib-Basic-Types.html#gint"
294
 
>gint</a>                  : Read / Write / Construct</pre>
 
182
<pre class="programlisting">  "left-offset"              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
295
183
<p>The offset from the left border where the pattern starts.</p>
296
184
<p>Allowed values: &gt;= 0</p>
297
185
<p>Default value: 0</p>
299
187
<hr>
300
188
<div class="refsect2" title='The "pattern-data-uint64" property'>
301
189
<a name="GstVideoMark--pattern-data-uint64"></a><h3>The <code class="literal">"pattern-data-uint64"</code> property</h3>
302
 
<pre class="programlisting">  "pattern-data-uint64"      <a
303
 
href="../glib/glib-Basic-Types.html#guint64"
304
 
>guint64</a>               : Read / Write / Construct</pre>
 
190
<pre class="programlisting">  "pattern-data-uint64"      <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write / Construct</pre>
305
191
<p>The extra data pattern markers.</p>
306
192
<p>Default value: 10</p>
307
193
</div>
308
194
</div>
309
195
<div class="refsect1" title="See Also">
310
196
<a name="gst-plugins-bad-plugins-videomark.see-also"></a><h2>See Also</h2>
311
 
#GstVideoDetect
 
197
<a class="link" href="gst-plugins-bad-plugins-videodetect.html#GstVideoDetect"><span class="type">GstVideoDetect</span></a>
312
198
</div>
313
199
</div>
314
200
<div class="footer">
315
201
<hr>
316
 
          Generated by GTK-Doc V1.11</div>
 
202
          Generated by GTK-Doc V1.13</div>
317
203
</body>
318
 
</html>
 
204
</html>
 
 
b'\\ No newline at end of file'