blob: a2838ba6e0d86fe23bf1b71897708c9a1e51d0e1 [file] [log] [blame]
<!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.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.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="gst-plugins-bad-plugins-rsvgdec.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GStreamer Bad Plugins 1.0 Plugins Reference Manual</th>
<td><a accesskey="n" href="gst-plugins-bad-plugins-rtmpsink.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gst-plugins-bad-plugins-rsvgoverlay.synopsis" class="shortcut">Top</a>
 | 
<a href="#gst-plugins-bad-plugins-rsvgoverlay.description" class="shortcut">Description</a>
 | 
<a href="#gst-plugins-bad-plugins-rsvgoverlay.properties" class="shortcut">Properties</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 — Overlays SVG graphics over a video stream</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gst-plugins-bad-plugins-rsvgoverlay.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay" title="struct GstRsvgOverlay">GstRsvgOverlay</a>;
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-rsvgoverlay.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--data" title='The "data" property'>data</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write
"<a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--fit-to-frame" title='The "fit-to-frame" property'>fit-to-frame</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--location" title='The "location" property'>location</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write
"<a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--x" title='The "x" property'>x</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--y" title='The "y" property'>y</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--height" title='The "height" property'>height</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--height-relative" title='The "height-relative" property'>height-relative</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--width" title='The "width" property'>width</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--width-relative" title='The "width-relative" property'>width-relative</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--x-relative" title='The "x-relative" property'>x-relative</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-rsvgoverlay.html#GstRsvgOverlay--y-relative" title='The "y-relative" property'>y-relative</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-rsvgoverlay.description"></a><h2>Description</h2>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="idp11018832"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<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 &lt;olivier.aubert@liris.cnrs.fr&gt;</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="idp6380368"></a><h3>Element Pads</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<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">
<col align="left" valign="top">
<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-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>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<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-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>
</tr>
</tbody>
</table></div>
</div>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-rsvgoverlay.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GstRsvgOverlay"></a><h3>struct GstRsvgOverlay</h3>
<pre class="programlisting">struct GstRsvgOverlay {
GstVideoFilter element;
};
</pre>
<p>
</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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write</pre>
<p>SVG data.</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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>Fit the SVG to fill the whole frame.</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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write</pre>
<p>SVG file location.</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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
<p>Specify an x offset.</p>
<p>Allowed values: &gt;= -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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
<p>Specify a y offset.</p>
<p>Allowed values: &gt;= -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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
<p>Specify a height in pixels.</p>
<p>Allowed values: &gt;= -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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write</pre>
<p>Specify a height relative to the display size.</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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
<p>Specify a width in pixels.</p>
<p>Allowed values: &gt;= -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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write</pre>
<p>Specify a width relative to the display size.</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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write</pre>
<p>Specify an x offset relative to the display size.</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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write</pre>
<p>Specify a y offset relative to the display size.</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>