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>square: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements"> 9<link rel="prev" href="gst-plugins-bad-plugins-sphere.html" title="sphere"> 10<link rel="next" href="gst-plugins-bad-plugins-srtenc.html" title="srtenc"> 11<meta name="generator" content="GTK-Doc V1.28 (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="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-bad-plugins-square.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-square.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-square.properties" class="shortcut">Properties</a></span> 21</td> 22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 24<td><a accesskey="p" href="gst-plugins-bad-plugins-sphere.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gst-plugins-bad-plugins-srtenc.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 26</tr></table> 27<div class="refentry"> 28<a name="gst-plugins-bad-plugins-square"></a><div class="titlepage"></div> 29<div class="refnamediv"><table width="100%"><tr> 30<td valign="top"> 31<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-square.top_of_page"></a>square</span></h2> 32<p>square</p> 33</td> 34<td class="gallery_image" valign="top" align="right"></td> 35</tr></table></div> 36<div class="refsect1"> 37<a name="gst-plugins-bad-plugins-square.properties"></a><h2>Properties</h2> 38<div class="informaltable"><table class="informaltable" border="0"> 39<colgroup> 40<col width="150px" class="properties_type"> 41<col width="300px" class="properties_name"> 42<col width="200px" class="properties_flags"> 43</colgroup> 44<tbody> 45<tr> 46<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-square.html#GstSquare--height" title="The “height” property">height</a></td> 48<td class="property_flags">Read / Write</td> 49</tr> 50<tr> 51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-square.html#GstSquare--width" title="The “width” property">width</a></td> 53<td class="property_flags">Read / Write</td> 54</tr> 55<tr> 56<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td> 57<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-square.html#GstSquare--zoom" title="The “zoom” property">zoom</a></td> 58<td class="property_flags">Read / Write</td> 59</tr> 60</tbody> 61</table></div> 62</div> 63<a name="GstSquare"></a><div class="refsect1"> 64<a name="gst-plugins-bad-plugins-square.other"></a><h2>Types and Values</h2> 65<div class="informaltable"><table class="informaltable" width="100%" border="0"> 66<colgroup> 67<col width="150px" class="name"> 68<col class="description"> 69</colgroup> 70<tbody><tr> 71<td class="datatype_keyword">struct</td> 72<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-square.html#GstSquare-struct" title="struct GstSquare">GstSquare</a></td> 73</tr></tbody> 74</table></div> 75</div> 76<div class="refsect1"> 77<a name="gst-plugins-bad-plugins-square.object-hierarchy"></a><h2>Object Hierarchy</h2> 78<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 79 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 80 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 81 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 82 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 83 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoFilter.html#GstVideoFilter-struct">GstVideoFilter</a> 84 <span class="lineart">╰──</span> GstGeometricTransform 85 <span class="lineart">╰──</span> GstSquare 86</pre> 87</div> 88<div class="refsect1"> 89<a name="gst-plugins-bad-plugins-square.description"></a><h2>Description</h2> 90<p>The square element distorts the center part of the image into a square.</p> 91<div class="refsect3"> 92<a name="id-1.2.210.7.3"></a><h4>Example launch line</h4> 93<div class="informalexample"> 94 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 95 <tbody> 96 <tr> 97 <td class="listing_lines" align="right"><pre>1</pre></td> 98 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> <span class="gtkdoc opt">-</span>v videotestsrc <span class="gtkdoc opt">!</span> square zoom<span class="gtkdoc opt">=</span><span class="number">100</span> <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink</pre></td> 99 </tr> 100 </tbody> 101 </table> 102</div> 103 104<p></p> 105</div> 106<div class="refsynopsisdiv"> 107<h2>Synopsis</h2> 108<div class="refsect2"> 109<a name="id-1.2.210.7.4.1"></a><h3>Element Information</h3> 110<div class="variablelist"><table border="0" class="variablelist"> 111<colgroup> 112<col align="left" valign="top"> 113<col> 114</colgroup> 115<tbody> 116<tr> 117<td><p><span class="term">plugin</span></p></td> 118<td> 119 <a class="link" href="gst-plugins-bad-plugins-plugin-geometrictransform.html#plugin-geometrictransform">geometrictransform</a> 120 </td> 121</tr> 122<tr> 123<td><p><span class="term">author</span></p></td> 124<td>Filippo Argiolas <filippo.argiolas@gmail.com></td> 125</tr> 126<tr> 127<td><p><span class="term">class</span></p></td> 128<td>Transform/Effect/Video</td> 129</tr> 130</tbody> 131</table></div> 132</div> 133<hr> 134<div class="refsect2"> 135<a name="id-1.2.210.7.4.2"></a><h3>Element Pads</h3> 136<div class="variablelist"><table border="0" class="variablelist"> 137<colgroup> 138<col align="left" valign="top"> 139<col> 140</colgroup> 141<tbody> 142<tr> 143<td><p><span class="term">name</span></p></td> 144<td>sink</td> 145</tr> 146<tr> 147<td><p><span class="term">direction</span></p></td> 148<td>sink</td> 149</tr> 150<tr> 151<td><p><span class="term">presence</span></p></td> 152<td>always</td> 153</tr> 154<tr> 155<td><p><span class="term">details</span></p></td> 156<td>video/x-raw, format=(string){ ARGB, BGR, BGRA, BGRx, RGB, RGBA, RGBx, AYUV, xBGR, xRGB, GRAY8, GRAY16_BE, GRAY16_LE }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 157</tr> 158</tbody> 159</table></div> 160<div class="variablelist"><table border="0" class="variablelist"> 161<colgroup> 162<col align="left" valign="top"> 163<col> 164</colgroup> 165<tbody> 166<tr> 167<td><p><span class="term">name</span></p></td> 168<td>src</td> 169</tr> 170<tr> 171<td><p><span class="term">direction</span></p></td> 172<td>source</td> 173</tr> 174<tr> 175<td><p><span class="term">presence</span></p></td> 176<td>always</td> 177</tr> 178<tr> 179<td><p><span class="term">details</span></p></td> 180<td>video/x-raw, format=(string){ ARGB, BGR, BGRA, BGRx, RGB, RGBA, RGBx, AYUV, xBGR, xRGB, GRAY8, GRAY16_BE, GRAY16_LE }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 181</tr> 182</tbody> 183</table></div> 184</div> 185</div> 186</div> 187<div class="refsect1"> 188<a name="gst-plugins-bad-plugins-square.functions_details"></a><h2>Functions</h2> 189<p></p> 190</div> 191<div class="refsect1"> 192<a name="gst-plugins-bad-plugins-square.other_details"></a><h2>Types and Values</h2> 193<div class="refsect2"> 194<a name="GstSquare-struct"></a><h3>struct GstSquare</h3> 195<pre class="programlisting">struct GstSquare;</pre> 196</div> 197</div> 198<div class="refsect1"> 199<a name="gst-plugins-bad-plugins-square.property-details"></a><h2>Property Details</h2> 200<div class="refsect2"> 201<a name="GstSquare--height"></a><h3>The <code class="literal">“height”</code> property</h3> 202<pre class="programlisting"> “height” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 203<p>Height of the square, relative to the frame height.</p> 204<p>Flags: Read / Write</p> 205<p>Allowed values: [0,1]</p> 206<p>Default value: 0.5</p> 207</div> 208<hr> 209<div class="refsect2"> 210<a name="GstSquare--width"></a><h3>The <code class="literal">“width”</code> property</h3> 211<pre class="programlisting"> “width” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 212<p>Width of the square, relative to the frame width.</p> 213<p>Flags: Read / Write</p> 214<p>Allowed values: [0,1]</p> 215<p>Default value: 0.5</p> 216</div> 217<hr> 218<div class="refsect2"> 219<a name="GstSquare--zoom"></a><h3>The <code class="literal">“zoom”</code> property</h3> 220<pre class="programlisting"> “zoom” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 221<p>Zoom amount in the center region.</p> 222<p>Flags: Read / Write</p> 223<p>Allowed values: [1,100]</p> 224<p>Default value: 2</p> 225</div> 226</div> 227<div class="refsect1"> 228<a name="gst-plugins-bad-plugins-square.see-also"></a><h2>See Also</h2> 229<p>geometrictransform</p> 230</div> 231</div> 232<div class="footer"> 233<hr>Generated by GTK-Doc V1.28</div> 234</body> 235</html>
