← Back to branch summary

~ubuntu-branches/ubuntu/quantal/gst-plugins-bad-multiverse0.10/quantal

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2007-05-03 19:52:54 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20070503195254-4dovmz251nut3yrt
Tags: 0.10.4+cvs20070502-1
* New CVS snapshot.
* debian/rules,
  debian/build-deps.in:
  + Update build dependencies.
* debian/gstreamer-plugins-bad-multiverse.install:
  + Add x264 plugin.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/plugins/html/gst-plugins-bad-plugins-videocrop.html
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=US-ASCII">
5
 
<title>videocrop</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
7
 
<link rel="start" href="index.html" title="GStreamer Bad Plugins 0.10 Plugins Reference Manual">
8
 
<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9
 
<link rel="prev" href="gst-plugins-bad-plugins-trm.html" title="trm">
10
 
<link rel="next" href="gst-plugins-bad-plugins-wavpackdec.html" title="wavpackdec">
11
 
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="chapter" href="ch01.html" title="gst-plugins-bad Elements">
14
 
<link rel="chapter" href="ch02.html" title="gst-plugins-bad Plugins">
15
 
</head>
16
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
17
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
18
 
<tr valign="middle">
19
 
<td><a accesskey="p" href="gst-plugins-bad-plugins-trm.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
20
 
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
21
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
22
 
<th width="100%" align="center">GStreamer Bad Plugins 0.10 Plugins Reference Manual</th>
23
 
<td><a accesskey="n" href="gst-plugins-bad-plugins-wavpackdec.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
24
 
</tr>
25
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id53676" class="shortcut">Top</a>
26
 
                  &#160;|&#160;
27
 
                  <a href="#id296222" class="shortcut">Description</a>
28
 
                  &#160;|&#160;
29
 
                  <a href="#id310885" class="shortcut">Object Hierarchy</a>
30
 
                  &#160;|&#160;
31
 
                  <a href="#id310921" class="shortcut">Properties</a></nobr></td></tr>
32
 
</table>
33
 
<div class="refentry" lang="en">
34
 
<a name="gst-plugins-bad-plugins-videocrop"></a><div class="titlepage"></div>
35
 
<div class="refnamediv"><table width="100%"><tr>
36
 
<td valign="top">
37
 
<h2>
38
 
<a name="id53676"></a><span class="refentrytitle">videocrop</span>
39
 
</h2>
40
 
<p>videocrop &#8212; Crops video into a user-defined region</p>
41
 
</td>
42
 
<td valign="top" align="right"></td>
43
 
</tr></table></div>
44
 
<div class="refsynopsisdiv">
45
 
<h2>Synopsis</h2>
46
 
<a name="GstVideoCrop"></a><pre class="synopsis">
47
 
 
48
 
 
49
 
 
50
 
            <a href="gst-plugins-bad-plugins-videocrop.html#GstVideoCrop-struct">GstVideoCrop</a>;
51
 
 
52
 
</pre>
53
 
</div>
54
 
<div class="refsect1" lang="en">
55
 
<a name="id310885"></a><h2>Object Hierarchy</h2>
56
 
<pre class="synopsis">
57
 
 
58
 
  GObject
59
 
   +----GstObject
60
 
         +----GstElement
61
 
               +----GstBaseTransform
62
 
                     +----GstVideoCrop
63
 
</pre>
64
 
</div>
65
 
<div class="refsect1" lang="en">
66
 
<a name="id310921"></a><h2>Properties</h2>
67
 
<pre class="synopsis">
68
 
 
69
 
  "<a href="gst-plugins-bad-plugins-videocrop.html#GstVideoCrop--bottom">bottom</a>"               gint                  : Read / Write
70
 
  "<a href="gst-plugins-bad-plugins-videocrop.html#GstVideoCrop--left">left</a>"                 gint                  : Read / Write
71
 
  "<a href="gst-plugins-bad-plugins-videocrop.html#GstVideoCrop--right">right</a>"                gint                  : Read / Write
72
 
  "<a href="gst-plugins-bad-plugins-videocrop.html#GstVideoCrop--top">top</a>"                  gint                  : Read / Write
73
 
</pre>
74
 
</div>
75
 
<div class="refsect1" lang="en">
76
 
<a name="id296222"></a><h2>Description</h2>
77
 
<p>
78
 
</p>
79
 
<div class="refsect2" lang="en">
80
 
<a name="id296235"></a><p>
81
 
This element crops video frames, meaning it can remove parts of the
82
 
picture on the left, right, top or bottom of the picture and output
83
 
a smaller picture than the input picture, with the unwanted parts at the
84
 
border removed.
85
 
</p>
86
 
<p>
87
 
The videocrop element is similar to the videobox element, but its main
88
 
goal is to support a multitude of formats as efficiently as possible.
89
 
Unlike videbox, it cannot add borders to the picture and unlike videbox
90
 
it will always output images in exactly the same format as the input image.
91
 
</p>
92
 
<p>
93
 
If there is nothing to crop, the element will operate in pass-through mode.
94
 
</p>
95
 
<p>
96
 
Note that no special efforts are made to handle chroma-subsampled formats
97
 
in the case of odd-valued cropping and compensate for sub-unit chroma plane
98
 
shifts for such formats in the case where the "left" or "top" property is
99
 
set to an odd number. This doesn't matter for most use cases, but it might
100
 
matter for yours.
101
 
</p>
102
 
<h3>Example launch line</h3>
103
 
<p>
104
 
</p>
105
 
<pre class="programlisting">
106
 
gst-launch -v videotestsrc ! videocrop top=42 left=1 right=4 bottom=0 ! ximagesink
107
 
</pre>
108
 
<p>
109
 
</p>
110
 
</div>
111
 
<div class="refsect2" lang="en">
112
 
<a name="id300468"></a><h3>Element Information</h3>
113
 
<div class="variablelist">
114
 
<span class="term">plugin</span>
115
 
          <a href="gst-plugins-bad-plugins-plugin-videocrop.html#plugin-videocrop">videocrop</a>
116
 
        
117
 
          <a href="gst-plugins-bad-plugins-plugin-videocrop.html#plugin-videocrop">videocrop</a>
118
 
        <a href="gst-plugins-bad-plugins-plugin-videocrop.html#plugin-videocrop">videocrop</a><span class="term">author</span>Tim-Philipp M&#252;ller &lt;tim centricular net&gt;Tim-Philipp M&#252;ller &lt;tim centricular net&gt;<span class="term">class</span>Filter/Effect/VideoFilter/Effect/Video<table border="0">
119
 
<col align="left" valign="top">
120
 
<tbody>
121
 
<tr>
122
 
<td>
123
 
<span class="term">plugin</span></td>
124
 
<td>
125
 
          <a href="gst-plugins-bad-plugins-plugin-videocrop.html#plugin-videocrop">videocrop</a>
126
 
        </td>
127
 
</tr>
128
 
<tr>
129
 
<td>
130
 
<span class="term">author</span></td>
131
 
<td>Tim-Philipp M&#252;ller &lt;tim centricular net&gt;</td>
132
 
</tr>
133
 
<tr>
134
 
<td>
135
 
<span class="term">class</span></td>
136
 
<td>Filter/Effect/Video</td>
137
 
</tr>
138
 
</tbody>
139
 
</table>
140
 
</div>
141
 
</div>
142
 
<p>
143
 
 
144
 
</p>
145
 
</div>
146
 
<div class="refsect1" lang="en">
147
 
<a name="id300536"></a><h2>Details</h2>
148
 
<div class="refsect2" lang="en">
149
 
<a name="id300547"></a><h3>
150
 
<a name="GstVideoCrop-struct"></a>GstVideoCrop</h3>
151
 
<a class="indexterm" name="id300559"></a><pre class="programlisting">typedef struct _GstVideoCrop GstVideoCrop;</pre>
152
 
<p>
153
 
 
154
 
</p>
155
 
</div>
156
 
</div>
157
 
<div class="refsect1" lang="en">
158
 
<a name="id300575"></a><h2>Property Details</h2>
159
 
<div class="refsect2" lang="en">
160
 
<a name="id300586"></a><h3>
161
 
<a name="GstVideoCrop--bottom"></a>The "<code class="literal">bottom</code>" property</h3>
162
 
<a class="indexterm" name="id312540"></a><pre class="programlisting">  "bottom"               gint                  : Read / Write</pre>
163
 
<p>Pixels to crop at bottom.</p>
164
 
<p>Allowed values: &gt;= 0</p>
165
 
<p>Default value: 0</p>
166
 
</div>
167
 
<hr>
168
 
<div class="refsect2" lang="en">
169
 
<a name="id312568"></a><h3>
170
 
<a name="GstVideoCrop--left"></a>The "<code class="literal">left</code>" property</h3>
171
 
<a class="indexterm" name="id312583"></a><pre class="programlisting">  "left"                 gint                  : Read / Write</pre>
172
 
<p>Pixels to crop at left.</p>
173
 
<p>Allowed values: &gt;= 0</p>
174
 
<p>Default value: 0</p>
175
 
</div>
176
 
<hr>
177
 
<div class="refsect2" lang="en">
178
 
<a name="id312611"></a><h3>
179
 
<a name="GstVideoCrop--right"></a>The "<code class="literal">right</code>" property</h3>
180
 
<a class="indexterm" name="id312625"></a><pre class="programlisting">  "right"                gint                  : Read / Write</pre>
181
 
<p>Pixels to crop at right.</p>
182
 
<p>Allowed values: &gt;= 0</p>
183
 
<p>Default value: 0</p>
184
 
</div>
185
 
<hr>
186
 
<div class="refsect2" lang="en">
187
 
<a name="id312654"></a><h3>
188
 
<a name="GstVideoCrop--top"></a>The "<code class="literal">top</code>" property</h3>
189
 
<a class="indexterm" name="id312669"></a><pre class="programlisting">  "top"                  gint                  : Read / Write</pre>
190
 
<p>Pixels to crop at top.</p>
191
 
<p>Allowed values: &gt;= 0</p>
192
 
<p>Default value: 0</p>
193
 
</div>
194
 
</div>
195
 
<div class="refsect1" lang="en">
196
 
<a name="id312699"></a><h2>See Also</h2>
197
 
GstVideoBox
198
 
</div>
199
 
</div>
200
 
</body>
201
 
</html>