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