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>rsvgoverlay: 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-rsvgdec.html" title="rsvgdec"> 10<link rel="next" href="gst-plugins-bad-plugins-rtmpsink.html" title="rtmpsink"> 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-rsvgoverlay.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-rsvgoverlay.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-rsvgoverlay.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-rsvgdec.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-rtmpsink.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-rsvgoverlay"></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-rsvgoverlay.top_of_page"></a>rsvgoverlay</span></h2> 32<p>rsvgoverlay</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-rsvgoverlay.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"> 47<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 48<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--data" title="The “data” property">data</a></td> 49<td class="property_flags">Write</td> 50</tr> 51<tr> 52<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 53<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--fit-to-frame" title="The “fit-to-frame” property">fit-to-frame</a></td> 54<td class="property_flags">Read / Write</td> 55</tr> 56<tr> 57<td class="property_type"> 58<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 59<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--location" title="The “location” property">location</a></td> 60<td class="property_flags">Write</td> 61</tr> 62<tr> 63<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 64<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--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#gint"><span class="type">gint</span></a></td> 69<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--y" title="The “y” property">y</a></td> 70<td class="property_flags">Read / Write</td> 71</tr> 72<tr> 73<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 74<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--height" title="The “height” property">height</a></td> 75<td class="property_flags">Read / Write</td> 76</tr> 77<tr> 78<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 79<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--height-relative" title="The “height-relative” property">height-relative</a></td> 80<td class="property_flags">Read / Write</td> 81</tr> 82<tr> 83<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 84<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--width" title="The “width” property">width</a></td> 85<td class="property_flags">Read / Write</td> 86</tr> 87<tr> 88<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 89<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--width-relative" title="The “width-relative” property">width-relative</a></td> 90<td class="property_flags">Read / Write</td> 91</tr> 92<tr> 93<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 94<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--x-relative" title="The “x-relative” property">x-relative</a></td> 95<td class="property_flags">Read / Write</td> 96</tr> 97<tr> 98<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 99<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--y-relative" title="The “y-relative” property">y-relative</a></td> 100<td class="property_flags">Read / Write</td> 101</tr> 102</tbody> 103</table></div> 104</div> 105<a name="GstRsvgOverlay"></a><div class="refsect1"> 106<a name="gst-plugins-bad-plugins-rsvgoverlay.other"></a><h2>Types and Values</h2> 107<div class="informaltable"><table class="informaltable" width="100%" border="0"> 108<colgroup> 109<col width="150px" class="name"> 110<col class="description"> 111</colgroup> 112<tbody><tr> 113<td class="datatype_keyword">struct</td> 114<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay-struct" title="struct GstRsvgOverlay">GstRsvgOverlay</a></td> 115</tr></tbody> 116</table></div> 117</div> 118<div class="refsect1"> 119<a name="gst-plugins-bad-plugins-rsvgoverlay.object-hierarchy"></a><h2>Object Hierarchy</h2> 120<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 121 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 122 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 123 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 124 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 125 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoFilter.html#GstVideoFilter-struct">GstVideoFilter</a> 126 <span class="lineart">╰──</span> GstRsvgOverlay 127</pre> 128</div> 129<div class="refsect1"> 130<a name="gst-plugins-bad-plugins-rsvgoverlay.description"></a><h2>Description</h2> 131<p>This elements overlays SVG graphics over the video. SVG data can 132either be specified through properties, or fed through the 133data-sink pad.</p> 134<p>Position and dimension of the SVG graphics can be achieved by 135specifying appropriate dimensions in the SVG file itself, but 136shortcuts are provided by the element to specify x/y position and 137width/height dimension, both in absolute form (pixels) and in 138relative form (percentage of video dimension).</p> 139<p>For any measure (x/y/width/height), the absolute value (in pixels) 140takes precedence over the relative one if both are 141specified. Absolute values must be set to 0 to disable them.</p> 142<p>If all parameters are 0, the image is displayed without rescaling 143at (0, 0) position.</p> 144<p>The fit-to-frame property is a shortcut for displaying the SVG 145overlay at (0, 0) position filling the whole screen. It modifies 146the values of the x/y/width/height attributes, by setting 147height-/width-relative to 1.0. and all other attributes to 0.</p> 148<div class="refsect3"> 149<a name="id-1.2.183.7.7"></a><h4>Example launch lines</h4> 150<div class="informalexample"> 151 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 152 <tbody> 153 <tr> 154 <td class="listing_lines" align="right"><pre>1</pre></td> 155 <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> videoconvert <span class="gtkdoc opt">!</span> rsvgoverlay location<span class="gtkdoc opt">=</span>foo<span class="gtkdoc opt">.</span>svg <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink</pre></td> 156 </tr> 157 </tbody> 158 </table> 159</div> 160 161<p> specifies the SVG location through the filename property.</p> 162<div class="informalexample"> 163 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 164 <tbody> 165 <tr> 166 <td class="listing_lines" align="right"><pre>1</pre></td> 167 <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> videoconvert <span class="gtkdoc opt">!</span> rsvgoverlay name<span class="gtkdoc opt">=</span>overlay <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink filesrc location<span class="gtkdoc opt">=</span>foo<span class="gtkdoc opt">.</span>svg <span class="gtkdoc opt">!</span> image<span class="gtkdoc opt">/</span>svg <span class="gtkdoc opt">!</span> overlay<span class="gtkdoc opt">.</span>data_sink</pre></td> 168 </tr> 169 </tbody> 170 </table> 171</div> 172 173<p> does the same by feeding data through the data_sink pad. You can also specify the SVG data itself as parameter:</p> 174<div class="informalexample"> 175 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 176 <tbody> 177 <tr> 178 <td class="listing_lines" align="right"><pre>1</pre></td> 179 <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> videoconvert <span class="gtkdoc opt">!</span> rsvgoverlay data<span class="gtkdoc opt">=</span><span class="string">'<svg viewBox="0 0 800 600"><image x="80%" y="80%" width="10%" height="10%" xlink:href="foo.jpg" /></svg>'</span> <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink</pre></td> 180 </tr> 181 </tbody> 182 </table> 183</div> 184 185<p></p> 186</div> 187<div class="refsynopsisdiv"> 188<h2>Synopsis</h2> 189<div class="refsect2"> 190<a name="id-1.2.183.7.8.1"></a><h3>Element Information</h3> 191<div class="variablelist"><table border="0" class="variablelist"> 192<colgroup> 193<col align="left" valign="top"> 194<col> 195</colgroup> 196<tbody> 197<tr> 198<td><p><span class="term">plugin</span></p></td> 199<td> 200 <a class="link" href="gst-plugins-bad-plugins-plugin-rsvg.html#plugin-rsvg">rsvg</a> 201 </td> 202</tr> 203<tr> 204<td><p><span class="term">author</span></p></td> 205<td>Olivier Aubert <olivier.aubert@liris.cnrs.fr></td> 206</tr> 207<tr> 208<td><p><span class="term">class</span></p></td> 209<td>Filter/Editor/Video</td> 210</tr> 211</tbody> 212</table></div> 213</div> 214<hr> 215<div class="refsect2"> 216<a name="id-1.2.183.7.8.2"></a><h3>Element Pads</h3> 217<div class="variablelist"><table border="0" class="variablelist"> 218<colgroup> 219<col align="left" valign="top"> 220<col> 221</colgroup> 222<tbody> 223<tr> 224<td><p><span class="term">name</span></p></td> 225<td>data_sink</td> 226</tr> 227<tr> 228<td><p><span class="term">direction</span></p></td> 229<td>sink</td> 230</tr> 231<tr> 232<td><p><span class="term">presence</span></p></td> 233<td>always</td> 234</tr> 235<tr> 236<td><p><span class="term">details</span></p></td> 237<td>image/svg+xml</td> 238</tr> 239<tr> 240<td><p><span class="term"></span></p></td> 241<td> image/svg</td> 242</tr> 243<tr> 244<td><p><span class="term"></span></p></td> 245<td> text/plain</td> 246</tr> 247</tbody> 248</table></div> 249<div class="variablelist"><table border="0" class="variablelist"> 250<colgroup> 251<col align="left" valign="top"> 252<col> 253</colgroup> 254<tbody> 255<tr> 256<td><p><span class="term">name</span></p></td> 257<td>sink</td> 258</tr> 259<tr> 260<td><p><span class="term">direction</span></p></td> 261<td>sink</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, format=(string)BGRA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 270</tr> 271</tbody> 272</table></div> 273<div class="variablelist"><table border="0" class="variablelist"> 274<colgroup> 275<col align="left" valign="top"> 276<col> 277</colgroup> 278<tbody> 279<tr> 280<td><p><span class="term">name</span></p></td> 281<td>src</td> 282</tr> 283<tr> 284<td><p><span class="term">direction</span></p></td> 285<td>source</td> 286</tr> 287<tr> 288<td><p><span class="term">presence</span></p></td> 289<td>always</td> 290</tr> 291<tr> 292<td><p><span class="term">details</span></p></td> 293<td>video/x-raw, format=(string)BGRA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 294</tr> 295</tbody> 296</table></div> 297</div> 298</div> 299</div> 300<div class="refsect1"> 301<a name="gst-plugins-bad-plugins-rsvgoverlay.functions_details"></a><h2>Functions</h2> 302<p></p> 303</div> 304<div class="refsect1"> 305<a name="gst-plugins-bad-plugins-rsvgoverlay.other_details"></a><h2>Types and Values</h2> 306<div class="refsect2"> 307<a name="GstRsvgOverlay-struct"></a><h3>struct GstRsvgOverlay</h3> 308<pre class="programlisting">struct GstRsvgOverlay;</pre> 309<p>Opaque object data structure.</p> 310</div> 311</div> 312<div class="refsect1"> 313<a name="gst-plugins-bad-plugins-rsvgoverlay.property-details"></a><h2>Property Details</h2> 314<div class="refsect2"> 315<a name="GstRsvgOverlay--data"></a><h3>The <code class="literal">“data”</code> property</h3> 316<pre class="programlisting"> “data” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 317<p>SVG data.</p> 318<p>Flags: Write</p> 319<p>Default value: ""</p> 320</div> 321<hr> 322<div class="refsect2"> 323<a name="GstRsvgOverlay--fit-to-frame"></a><h3>The <code class="literal">“fit-to-frame”</code> property</h3> 324<pre class="programlisting"> “fit-to-frame” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 325<p>Fit the SVG to fill the whole frame.</p> 326<p>Flags: Read / Write</p> 327<p>Default value: TRUE</p> 328</div> 329<hr> 330<div class="refsect2"> 331<a name="GstRsvgOverlay--location"></a><h3>The <code class="literal">“location”</code> property</h3> 332<pre class="programlisting"> “location” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 333<p>SVG file location.</p> 334<p>Flags: Write</p> 335<p>Default value: ""</p> 336</div> 337<hr> 338<div class="refsect2"> 339<a name="GstRsvgOverlay--x"></a><h3>The <code class="literal">“x”</code> property</h3> 340<pre class="programlisting"> “x” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 341<p>Specify an x offset.</p> 342<p>Flags: Read / Write</p> 343<p>Allowed values: >= -2147483647</p> 344<p>Default value: 0</p> 345</div> 346<hr> 347<div class="refsect2"> 348<a name="GstRsvgOverlay--y"></a><h3>The <code class="literal">“y”</code> property</h3> 349<pre class="programlisting"> “y” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 350<p>Specify a y offset.</p> 351<p>Flags: Read / Write</p> 352<p>Allowed values: >= -2147483647</p> 353<p>Default value: 0</p> 354</div> 355<hr> 356<div class="refsect2"> 357<a name="GstRsvgOverlay--height"></a><h3>The <code class="literal">“height”</code> property</h3> 358<pre class="programlisting"> “height” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 359<p>Specify a height in pixels.</p> 360<p>Flags: Read / Write</p> 361<p>Allowed values: >= -2147483647</p> 362<p>Default value: 0</p> 363</div> 364<hr> 365<div class="refsect2"> 366<a name="GstRsvgOverlay--height-relative"></a><h3>The <code class="literal">“height-relative”</code> property</h3> 367<pre class="programlisting"> “height-relative” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 368<p>Specify a height relative to the display size.</p> 369<p>Flags: Read / Write</p> 370<p>Default value: 0</p> 371</div> 372<hr> 373<div class="refsect2"> 374<a name="GstRsvgOverlay--width"></a><h3>The <code class="literal">“width”</code> property</h3> 375<pre class="programlisting"> “width” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 376<p>Specify a width in pixels.</p> 377<p>Flags: Read / Write</p> 378<p>Allowed values: >= -2147483647</p> 379<p>Default value: 0</p> 380</div> 381<hr> 382<div class="refsect2"> 383<a name="GstRsvgOverlay--width-relative"></a><h3>The <code class="literal">“width-relative”</code> property</h3> 384<pre class="programlisting"> “width-relative” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 385<p>Specify a width relative to the display size.</p> 386<p>Flags: Read / Write</p> 387<p>Default value: 0</p> 388</div> 389<hr> 390<div class="refsect2"> 391<a name="GstRsvgOverlay--x-relative"></a><h3>The <code class="literal">“x-relative”</code> property</h3> 392<pre class="programlisting"> “x-relative” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 393<p>Specify an x offset relative to the display size.</p> 394<p>Flags: Read / Write</p> 395<p>Default value: 0</p> 396</div> 397<hr> 398<div class="refsect2"> 399<a name="GstRsvgOverlay--y-relative"></a><h3>The <code class="literal">“y-relative”</code> property</h3> 400<pre class="programlisting"> “y-relative” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 401<p>Specify a y offset relative to the display size.</p> 402<p>Flags: Read / Write</p> 403<p>Default value: 0</p> 404</div> 405</div> 406</div> 407<div class="footer"> 408<hr>Generated by GTK-Doc V1.28</div> 409</body> 410</html>
