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>faceoverlay: 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-facedetect.html" title="facedetect"> 10<link rel="next" href="gst-plugins-bad-plugins-fakevideosink.html" title="fakevideosink"> 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-faceoverlay.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-faceoverlay.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-faceoverlay.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gst-plugins-bad-plugins-faceoverlay.properties" class="shortcut">Properties</a></span> 22</td> 23<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 24<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 25<td><a accesskey="p" href="gst-plugins-bad-plugins-facedetect.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 26<td><a accesskey="n" href="gst-plugins-bad-plugins-fakevideosink.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 27</tr></table> 28<div class="refentry"> 29<a name="gst-plugins-bad-plugins-faceoverlay"></a><div class="titlepage"></div> 30<div class="refnamediv"><table width="100%"><tr> 31<td valign="top"> 32<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-faceoverlay.top_of_page"></a>faceoverlay</span></h2> 33<p>faceoverlay</p> 34</td> 35<td class="gallery_image" valign="top" align="right"></td> 36</tr></table></div> 37<div class="refsect1"> 38<a name="gst-plugins-bad-plugins-faceoverlay.properties"></a><h2>Properties</h2> 39<div class="informaltable"><table class="informaltable" border="0"> 40<colgroup> 41<col width="150px" class="properties_type"> 42<col width="300px" class="properties_name"> 43<col width="200px" class="properties_flags"> 44</colgroup> 45<tbody> 46<tr> 47<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 48<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-faceoverlay.html#GstFaceOverlay--h" title="The “h” property">h</a></td> 49<td class="property_flags">Read / Write</td> 50</tr> 51<tr> 52<td class="property_type"> 53<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 54<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-faceoverlay.html#GstFaceOverlay--location" title="The “location” property">location</a></td> 55<td class="property_flags">Read / Write</td> 56</tr> 57<tr> 58<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 59<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-faceoverlay.html#GstFaceOverlay--w" title="The “w” property">w</a></td> 60<td class="property_flags">Read / Write</td> 61</tr> 62<tr> 63<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 64<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-faceoverlay.html#GstFaceOverlay--x" title="The “x” property">x</a></td> 65<td class="property_flags">Read / Write</td> 66</tr> 67<tr> 68<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 69<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-faceoverlay.html#GstFaceOverlay--y" title="The “y” property">y</a></td> 70<td class="property_flags">Read / Write</td> 71</tr> 72</tbody> 73</table></div> 74</div> 75<a name="GstFaceOverlay"></a><div class="refsect1"> 76<a name="gst-plugins-bad-plugins-faceoverlay.other"></a><h2>Types and Values</h2> 77<div class="informaltable"><table class="informaltable" width="100%" border="0"> 78<colgroup> 79<col width="150px" class="name"> 80<col class="description"> 81</colgroup> 82<tbody><tr> 83<td class="datatype_keyword">struct</td> 84<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-faceoverlay.html#GstFaceOverlay-struct" title="struct GstFaceOverlay">GstFaceOverlay</a></td> 85</tr></tbody> 86</table></div> 87</div> 88<div class="refsect1"> 89<a name="gst-plugins-bad-plugins-faceoverlay.object-hierarchy"></a><h2>Object Hierarchy</h2> 90<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 91 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 92 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 93 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 94 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBin.html#GstBin-struct">GstBin</a> 95 <span class="lineart">╰──</span> GstFaceOverlay 96</pre> 97</div> 98<div class="refsect1"> 99<a name="gst-plugins-bad-plugins-faceoverlay.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 100<p> 101GstFaceOverlay implements 102 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstChildProxy.html#GstChildProxy-struct">GstChildProxy</a>.</p> 103</div> 104<div class="refsect1"> 105<a name="gst-plugins-bad-plugins-faceoverlay.description"></a><h2>Description</h2> 106<p>Overlays a SVG image over a detected face in a video stream. 107x, y, w, and h properties are optional, and change the image position and 108size relative to the detected face position and size.</p> 109<div class="refsect2"> 110<a name="id-1.2.84.8.3"></a><h3>Example launch line</h3> 111<div class="informalexample"> 112 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 113 <tbody> 114 <tr> 115 <td class="listing_lines" align="right"><pre>1</pre></td> 116 <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> autovideosrc <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> faceoverlay location<span class="gtkdoc opt">=/</span>path<span class="gtkdoc opt">/</span>to<span class="gtkdoc opt">/</span>gnome<span class="gtkdoc opt">-</span>video<span class="gtkdoc opt">-</span>effects<span class="gtkdoc opt">/</span>pixmaps<span class="gtkdoc opt">/</span>bow<span class="gtkdoc opt">.</span>svg x<span class="gtkdoc opt">=</span><span class="number">0.5</span> y<span class="gtkdoc opt">=</span><span class="number">0.5</span> w<span class="gtkdoc opt">=</span><span class="number">0.7</span> h<span class="gtkdoc opt">=</span><span class="number">0.7</span> <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink</pre></td> 117 </tr> 118 </tbody> 119 </table> 120</div> 121 122</div> 123<div class="refsynopsisdiv"> 124<h2>Synopsis</h2> 125<div class="refsect2"> 126<a name="id-1.2.84.8.4.1"></a><h3>Element Information</h3> 127<div class="variablelist"><table border="0" class="variablelist"> 128<colgroup> 129<col align="left" valign="top"> 130<col> 131</colgroup> 132<tbody> 133<tr> 134<td><p><span class="term">plugin</span></p></td> 135<td> 136 <a class="link" href="gst-plugins-bad-plugins-plugin-faceoverlay.html#plugin-faceoverlay">faceoverlay</a> 137 </td> 138</tr> 139<tr> 140<td><p><span class="term">author</span></p></td> 141<td>Laura Lucas Alday <lauralucas@gmail.com></td> 142</tr> 143<tr> 144<td><p><span class="term">class</span></p></td> 145<td>Filter/Editor/Video</td> 146</tr> 147</tbody> 148</table></div> 149</div> 150<hr> 151<div class="refsect2"> 152<a name="id-1.2.84.8.4.2"></a><h3>Element Pads</h3> 153<div class="variablelist"><table border="0" class="variablelist"> 154<colgroup> 155<col align="left" valign="top"> 156<col> 157</colgroup> 158<tbody> 159<tr> 160<td><p><span class="term">name</span></p></td> 161<td>sink</td> 162</tr> 163<tr> 164<td><p><span class="term">direction</span></p></td> 165<td>sink</td> 166</tr> 167<tr> 168<td><p><span class="term">presence</span></p></td> 169<td>always</td> 170</tr> 171<tr> 172<td><p><span class="term">details</span></p></td> 173<td>video/x-raw, format=(string){ RGB }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 174</tr> 175</tbody> 176</table></div> 177<div class="variablelist"><table border="0" class="variablelist"> 178<colgroup> 179<col align="left" valign="top"> 180<col> 181</colgroup> 182<tbody> 183<tr> 184<td><p><span class="term">name</span></p></td> 185<td>src</td> 186</tr> 187<tr> 188<td><p><span class="term">direction</span></p></td> 189<td>source</td> 190</tr> 191<tr> 192<td><p><span class="term">presence</span></p></td> 193<td>always</td> 194</tr> 195<tr> 196<td><p><span class="term">details</span></p></td> 197<td>video/x-raw, format=(string){ BGRA }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 198</tr> 199</tbody> 200</table></div> 201</div> 202</div> 203</div> 204<div class="refsect1"> 205<a name="gst-plugins-bad-plugins-faceoverlay.functions_details"></a><h2>Functions</h2> 206<p></p> 207</div> 208<div class="refsect1"> 209<a name="gst-plugins-bad-plugins-faceoverlay.other_details"></a><h2>Types and Values</h2> 210<div class="refsect2"> 211<a name="GstFaceOverlay-struct"></a><h3>struct GstFaceOverlay</h3> 212<pre class="programlisting">struct GstFaceOverlay;</pre> 213</div> 214</div> 215<div class="refsect1"> 216<a name="gst-plugins-bad-plugins-faceoverlay.property-details"></a><h2>Property Details</h2> 217<div class="refsect2"> 218<a name="GstFaceOverlay--h"></a><h3>The <code class="literal">“h”</code> property</h3> 219<pre class="programlisting"> “h” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 220<p>Specify image height relative to face height.</p> 221<p>Flags: Read / Write</p> 222<p>Allowed values: >= 0</p> 223<p>Default value: 1</p> 224</div> 225<hr> 226<div class="refsect2"> 227<a name="GstFaceOverlay--location"></a><h3>The <code class="literal">“location”</code> property</h3> 228<pre class="programlisting"> “location” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 229<p>Location of SVG file to use for face overlay.</p> 230<p>Flags: Read / Write</p> 231<p>Default value: ""</p> 232</div> 233<hr> 234<div class="refsect2"> 235<a name="GstFaceOverlay--w"></a><h3>The <code class="literal">“w”</code> property</h3> 236<pre class="programlisting"> “w” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 237<p>Specify image width relative to face width.</p> 238<p>Flags: Read / Write</p> 239<p>Allowed values: >= 0</p> 240<p>Default value: 1</p> 241</div> 242<hr> 243<div class="refsect2"> 244<a name="GstFaceOverlay--x"></a><h3>The <code class="literal">“x”</code> property</h3> 245<pre class="programlisting"> “x” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 246<p>Specify image x relative to detected face x.</p> 247<p>Flags: Read / Write</p> 248<p>Default value: 0</p> 249</div> 250<hr> 251<div class="refsect2"> 252<a name="GstFaceOverlay--y"></a><h3>The <code class="literal">“y”</code> property</h3> 253<pre class="programlisting"> “y” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 254<p>Specify image y relative to detected face y.</p> 255<p>Flags: Read / Write</p> 256<p>Default value: 0</p> 257</div> 258</div> 259</div> 260<div class="footer"> 261<hr>Generated by GTK-Doc V1.28</div> 262</body> 263</html>
