tizen 2.0 init
[framework/multimedia/gst-plugins-good0.10.git] / docs / plugins / html / gst-plugins-good-plugins-videobox.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=UTF-8">
5 <title>videobox</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
9 <link rel="prev" href="gst-plugins-good-plugins-videobalance.html" title="videobalance">
10 <link rel="next" href="gst-plugins-good-plugins-videocrop.html" title="videocrop">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="gst-plugins-good-plugins-videobalance.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GStreamer Good Plugins 0.10 Plugins Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-good-plugins-videocrop.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-good-plugins-videobox.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-good-plugins-videobox.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-good-plugins-videobox.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-good-plugins-videobox.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="gst-plugins-good-plugins-videobox"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
36 <td valign="top">
37 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-videobox.top_of_page"></a>videobox</span></h2>
38 <p>videobox — Resizes a video by adding borders or cropping</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv">
43 <a name="gst-plugins-good-plugins-videobox.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstVideoBox"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-videobox.html#GstVideoBox-struct" title="struct GstVideoBox">GstVideoBox</a>;
45 </pre>
46 </div>
47 <div class="refsect1">
48 <a name="gst-plugins-good-plugins-videobox.object-hierarchy"></a><h2>Object Hierarchy</h2>
49 <pre class="synopsis">
50   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
51    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
52          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
53                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
54                      +----GstVideoBox
55 </pre>
56 </div>
57 <div class="refsect1">
58 <a name="gst-plugins-good-plugins-videobox.properties"></a><h2>Properties</h2>
59 <pre class="synopsis">
60   "<a class="link" href="gst-plugins-good-plugins-videobox.html#GstVideoBox--alpha" title='The "alpha" property'>alpha</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
61   "<a class="link" href="gst-plugins-good-plugins-videobox.html#GstVideoBox--border-alpha" title='The "border-alpha" property'>border-alpha</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
62   "<a class="link" href="gst-plugins-good-plugins-videobox.html#GstVideoBox--bottom" title='The "bottom" property'>bottom</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
63   "<a class="link" href="gst-plugins-good-plugins-videobox.html#GstVideoBox--fill" title='The "fill" property'>fill</a>"                     <span class="type">GstVideoBoxFill</span>       : Read / Write
64   "<a class="link" href="gst-plugins-good-plugins-videobox.html#GstVideoBox--left" title='The "left" property'>left</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
65   "<a class="link" href="gst-plugins-good-plugins-videobox.html#GstVideoBox--right" title='The "right" property'>right</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
66   "<a class="link" href="gst-plugins-good-plugins-videobox.html#GstVideoBox--top" title='The "top" property'>top</a>"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
67   "<a class="link" href="gst-plugins-good-plugins-videobox.html#GstVideoBox--autocrop" title='The "autocrop" property'>autocrop</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
68 </pre>
69 </div>
70 <div class="refsect1">
71 <a name="gst-plugins-good-plugins-videobox.description"></a><h2>Description</h2>
72 <p>
73 This plugin crops or enlarges the image. It takes 4 values as input, a
74 top, bottom, left and right offset. Positive values will crop that much
75 pixels from the respective border of the image, negative values will add
76 that much pixels. When pixels are added, you can specify their color. 
77 Some predefined colors are usable with an enum property.
78 </p>
79 <p>
80 The plugin is alpha channel aware and will try to negotiate with a format
81 that supports alpha channels first. When alpha channel is active two
82 other properties, alpha and border_alpha can be used to set the alpha
83 values of the inner picture and the border respectively. an alpha value of
84 0.0 means total transparency, 1.0 is opaque.
85 </p>
86 <p>
87 The videobox plugin has many uses such as doing a mosaic of pictures, 
88 letterboxing video, cutting out pieces of video, picture in picture, etc..
89 </p>
90 <p>
91 Setting autocrop to true changes the behavior of the plugin so that
92 caps determine crop properties rather than the other way around: given
93 input and output dimensions, the crop values are selected so that the
94 smaller frame is effectively centered in the larger frame.  This
95 involves either cropping or padding.
96 </p>
97 <p>
98 If you use autocrop there is little point in setting the other
99 properties manually because they will be overriden if the caps change,
100 but nothing stops you from doing so.
101 </p>
102 <p>
103 Sample pipeline:
104 </p>
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
110 2</pre></td>
111         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch videotestsrc <span class="gtkdoc opt">!</span> videobox autocrop<span class="gtkdoc opt">=</span><span class="keyword">true</span> <span class="gtkdoc opt">!</span> \
112   <span class="string">&quot;video/x-raw-yuv, width=600, height=400&quot;</span> <span class="gtkdoc opt">!</span> ffmpegcolorspace <span class="gtkdoc opt">!</span> ximagesink</pre></td>
113       </tr>
114     </tbody>
115   </table>
116 </div>
117
118 <p>
119 </p>
120 <div class="refsynopsisdiv">
121 <h2>Synopsis</h2>
122 <div class="refsect2">
123 <a name="idp23741312"></a><h3>Element Information</h3>
124 <div class="variablelist"><table border="0">
125 <col align="left" valign="top">
126 <tbody>
127 <tr>
128 <td><p><span class="term">plugin</span></p></td>
129 <td>
130             <a class="link" href="gst-plugins-good-plugins-plugin-videobox.html#plugin-videobox">videobox</a>
131           </td>
132 </tr>
133 <tr>
134 <td><p><span class="term">author</span></p></td>
135 <td>Wim Taymans &lt;wim@fluendo.com&gt;</td>
136 </tr>
137 <tr>
138 <td><p><span class="term">class</span></p></td>
139 <td>Filter/Effect/Video</td>
140 </tr>
141 </tbody>
142 </table></div>
143 </div>
144 <hr>
145 <div class="refsect2">
146 <a name="idp19373248"></a><h3>Element Pads</h3>
147 <div class="variablelist"><table border="0">
148 <col align="left" valign="top">
149 <tbody>
150 <tr>
151 <td><p><span class="term">name</span></p></td>
152 <td>sink</td>
153 </tr>
154 <tr>
155 <td><p><span class="term">direction</span></p></td>
156 <td>sink</td>
157 </tr>
158 <tr>
159 <td><p><span class="term">presence</span></p></td>
160 <td>always</td>
161 </tr>
162 <tr>
163 <td><p><span class="term">details</span></p></td>
164 <td>video/x-raw-yuv, format=(fourcc)AYUV, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
165 </tr>
166 <tr>
167 <td><p><span class="term"></span></p></td>
168 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
169 </tr>
170 <tr>
171 <td><p><span class="term"></span></p></td>
172 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
173 </tr>
174 <tr>
175 <td><p><span class="term"></span></p></td>
176 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
177 </tr>
178 <tr>
179 <td><p><span class="term"></span></p></td>
180 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
181 </tr>
182 <tr>
183 <td><p><span class="term"></span></p></td>
184 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
185 </tr>
186 <tr>
187 <td><p><span class="term"></span></p></td>
188 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
189 </tr>
190 <tr>
191 <td><p><span class="term"></span></p></td>
192 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
193 </tr>
194 <tr>
195 <td><p><span class="term"></span></p></td>
196 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
197 </tr>
198 <tr>
199 <td><p><span class="term"></span></p></td>
200 <td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
201 </tr>
202 <tr>
203 <td><p><span class="term"></span></p></td>
204 <td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
205 </tr>
206 <tr>
207 <td><p><span class="term"></span></p></td>
208 <td> video/x-raw-yuv, format=(fourcc)Y444, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
209 </tr>
210 <tr>
211 <td><p><span class="term"></span></p></td>
212 <td> video/x-raw-yuv, format=(fourcc)Y42B, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
213 </tr>
214 <tr>
215 <td><p><span class="term"></span></p></td>
216 <td> video/x-raw-yuv, format=(fourcc)YUY2, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
217 </tr>
218 <tr>
219 <td><p><span class="term"></span></p></td>
220 <td> video/x-raw-yuv, format=(fourcc)YVYU, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
221 </tr>
222 <tr>
223 <td><p><span class="term"></span></p></td>
224 <td> video/x-raw-yuv, format=(fourcc)UYVY, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
225 </tr>
226 <tr>
227 <td><p><span class="term"></span></p></td>
228 <td> video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
229 </tr>
230 <tr>
231 <td><p><span class="term"></span></p></td>
232 <td> video/x-raw-yuv, format=(fourcc)YV12, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
233 </tr>
234 <tr>
235 <td><p><span class="term"></span></p></td>
236 <td> video/x-raw-yuv, format=(fourcc)Y41B, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
237 </tr>
238 <tr>
239 <td><p><span class="term"></span></p></td>
240 <td> video/x-raw-gray, bpp=(int)8, depth=(int)8, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
241 </tr>
242 <tr>
243 <td><p><span class="term"></span></p></td>
244 <td> video/x-raw-gray, bpp=(int)16, depth=(int)16, endianness=(int)4321, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
245 </tr>
246 <tr>
247 <td><p><span class="term"></span></p></td>
248 <td> video/x-raw-gray, bpp=(int)16, depth=(int)16, endianness=(int)1234, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
249 </tr>
250 </tbody>
251 </table></div>
252 <div class="variablelist"><table border="0">
253 <col align="left" valign="top">
254 <tbody>
255 <tr>
256 <td><p><span class="term">name</span></p></td>
257 <td>src</td>
258 </tr>
259 <tr>
260 <td><p><span class="term">direction</span></p></td>
261 <td>source</td>
262 </tr>
263 <tr>
264 <td><p><span class="term">presence</span></p></td>
265 <td>always</td>
266 </tr>
267 <tr>
268 <td><p><span class="term">details</span></p></td>
269 <td>video/x-raw-yuv, format=(fourcc)AYUV, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
270 </tr>
271 <tr>
272 <td><p><span class="term"></span></p></td>
273 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
274 </tr>
275 <tr>
276 <td><p><span class="term"></span></p></td>
277 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
278 </tr>
279 <tr>
280 <td><p><span class="term"></span></p></td>
281 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
282 </tr>
283 <tr>
284 <td><p><span class="term"></span></p></td>
285 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
286 </tr>
287 <tr>
288 <td><p><span class="term"></span></p></td>
289 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
290 </tr>
291 <tr>
292 <td><p><span class="term"></span></p></td>
293 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
294 </tr>
295 <tr>
296 <td><p><span class="term"></span></p></td>
297 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
298 </tr>
299 <tr>
300 <td><p><span class="term"></span></p></td>
301 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
302 </tr>
303 <tr>
304 <td><p><span class="term"></span></p></td>
305 <td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
306 </tr>
307 <tr>
308 <td><p><span class="term"></span></p></td>
309 <td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
310 </tr>
311 <tr>
312 <td><p><span class="term"></span></p></td>
313 <td> video/x-raw-yuv, format=(fourcc)Y444, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
314 </tr>
315 <tr>
316 <td><p><span class="term"></span></p></td>
317 <td> video/x-raw-yuv, format=(fourcc)Y42B, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
318 </tr>
319 <tr>
320 <td><p><span class="term"></span></p></td>
321 <td> video/x-raw-yuv, format=(fourcc)YUY2, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
322 </tr>
323 <tr>
324 <td><p><span class="term"></span></p></td>
325 <td> video/x-raw-yuv, format=(fourcc)YVYU, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
326 </tr>
327 <tr>
328 <td><p><span class="term"></span></p></td>
329 <td> video/x-raw-yuv, format=(fourcc)UYVY, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
330 </tr>
331 <tr>
332 <td><p><span class="term"></span></p></td>
333 <td> video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
334 </tr>
335 <tr>
336 <td><p><span class="term"></span></p></td>
337 <td> video/x-raw-yuv, format=(fourcc)YV12, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
338 </tr>
339 <tr>
340 <td><p><span class="term"></span></p></td>
341 <td> video/x-raw-yuv, format=(fourcc)Y41B, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
342 </tr>
343 <tr>
344 <td><p><span class="term"></span></p></td>
345 <td> video/x-raw-gray, bpp=(int)8, depth=(int)8, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
346 </tr>
347 <tr>
348 <td><p><span class="term"></span></p></td>
349 <td> video/x-raw-gray, bpp=(int)16, depth=(int)16, endianness=(int)4321, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
350 </tr>
351 <tr>
352 <td><p><span class="term"></span></p></td>
353 <td> video/x-raw-gray, bpp=(int)16, depth=(int)16, endianness=(int)1234, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
354 </tr>
355 </tbody>
356 </table></div>
357 </div>
358 </div>
359 <p>
360 </p>
361 </div>
362 <div class="refsect1">
363 <a name="gst-plugins-good-plugins-videobox.details"></a><h2>Details</h2>
364 <div class="refsect2">
365 <a name="GstVideoBox-struct"></a><h3>struct GstVideoBox</h3>
366 <pre class="programlisting">struct GstVideoBox;</pre>
367 <p>
368 </p>
369 </div>
370 </div>
371 <div class="refsect1">
372 <a name="gst-plugins-good-plugins-videobox.property-details"></a><h2>Property Details</h2>
373 <div class="refsect2">
374 <a name="GstVideoBox--alpha"></a><h3>The <code class="literal">"alpha"</code> property</h3>
375 <pre class="programlisting">  "alpha"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
376 <p>Alpha value picture.</p>
377 <p>Allowed values: [0,1]</p>
378 <p>Default value: 1</p>
379 </div>
380 <hr>
381 <div class="refsect2">
382 <a name="GstVideoBox--border-alpha"></a><h3>The <code class="literal">"border-alpha"</code> property</h3>
383 <pre class="programlisting">  "border-alpha"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
384 <p>Alpha value of the border.</p>
385 <p>Allowed values: [0,1]</p>
386 <p>Default value: 1</p>
387 </div>
388 <hr>
389 <div class="refsect2">
390 <a name="GstVideoBox--bottom"></a><h3>The <code class="literal">"bottom"</code> property</h3>
391 <pre class="programlisting">  "bottom"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
392 <p>Pixels to box at bottom (&lt;0 = add a border).</p>
393 <p>Default value: 0</p>
394 </div>
395 <hr>
396 <div class="refsect2">
397 <a name="GstVideoBox--fill"></a><h3>The <code class="literal">"fill"</code> property</h3>
398 <pre class="programlisting">  "fill"                     <span class="type">GstVideoBoxFill</span>       : Read / Write</pre>
399 <p>How to fill the borders.</p>
400 <p>Default value: Black</p>
401 </div>
402 <hr>
403 <div class="refsect2">
404 <a name="GstVideoBox--left"></a><h3>The <code class="literal">"left"</code> property</h3>
405 <pre class="programlisting">  "left"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
406 <p>Pixels to box at left (&lt;0  = add a border).</p>
407 <p>Default value: 0</p>
408 </div>
409 <hr>
410 <div class="refsect2">
411 <a name="GstVideoBox--right"></a><h3>The <code class="literal">"right"</code> property</h3>
412 <pre class="programlisting">  "right"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
413 <p>Pixels to box at right (&lt;0 = add a border).</p>
414 <p>Default value: 0</p>
415 </div>
416 <hr>
417 <div class="refsect2">
418 <a name="GstVideoBox--top"></a><h3>The <code class="literal">"top"</code> property</h3>
419 <pre class="programlisting">  "top"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
420 <p>Pixels to box at top (&lt;0 = add a border).</p>
421 <p>Default value: 0</p>
422 </div>
423 <hr>
424 <div class="refsect2">
425 <a name="GstVideoBox--autocrop"></a><h3>The <code class="literal">"autocrop"</code> property</h3>
426 <pre class="programlisting">  "autocrop"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
427 <p>
428 If set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> videobox will automatically crop/pad the input
429 video to be centered in the output.
430 </p>
431 <p>Default value: FALSE</p>
432 <p class="since">Since 0.10.16</p>
433 </div>
434 </div>
435 <div class="refsect1">
436 <a name="gst-plugins-good-plugins-videobox.see-also"></a><h2>See Also</h2>
437 <a class="link" href="gst-plugins-good-plugins-videocrop.html#GstVideoCrop"><span class="type">GstVideoCrop</span></a>
438 </div>
439 </div>
440 <div class="footer">
441 <hr>
442           Generated by GTK-Doc V1.18</div>
443 </body>
444 </html>