blob: f9b494336b7a5f1aaeb0315b82566dee5888d9a4 [file] [log] [blame]
Olivier Naudan988c6f02012-04-16 07:16:25 -04001<!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>vertigotv</title>
6<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual">
8<link rel="up" href="ch01.html" title="gst-plugins-good Elements">
9<link rel="prev" href="gst-plugins-good-plugins-v4l2radio.html" title="v4l2radio">
10<link rel="next" href="gst-plugins-good-plugins-videobalance.html" title="videobalance">
11<meta name="generator" content="GTK-Doc V1.18 (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="2">
16<tr valign="middle">
17<td><a accesskey="p" href="gst-plugins-good-plugins-v4l2radio.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20<th width="100%" align="center">GStreamer Good Plugins 1.0 Plugins Reference Manual</th>
21<td><a accesskey="n" href="gst-plugins-good-plugins-videobalance.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22</tr>
23<tr><td colspan="5" class="shortcuts">
24<a href="#gst-plugins-good-plugins-vertigotv.synopsis" class="shortcut">Top</a>
25  | 
26 <a href="#gst-plugins-good-plugins-vertigotv.description" class="shortcut">Description</a>
27  | 
28 <a href="#gst-plugins-good-plugins-vertigotv.object-hierarchy" class="shortcut">Object Hierarchy</a>
29  | 
30 <a href="#gst-plugins-good-plugins-vertigotv.properties" class="shortcut">Properties</a>
31  | 
32 <a href="#gst-plugins-good-plugins-vertigotv.signals" class="shortcut">Signals</a>
33</td></tr>
34</table>
35<div class="refentry">
36<a name="gst-plugins-good-plugins-vertigotv"></a><div class="titlepage"></div>
37<div class="refnamediv"><table width="100%"><tr>
38<td valign="top">
39<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-vertigotv.top_of_page"></a>vertigotv</span></h2>
40<p>vertigotv — A loopback alpha blending effector with rotating and scaling</p>
41</td>
42<td valign="top" align="right"></td>
43</tr></table></div>
44<div class="refsynopsisdiv">
45<a name="gst-plugins-good-plugins-vertigotv.synopsis"></a><h2>Synopsis</h2>
46<a name="GstVertigoTV"></a><pre class="synopsis">struct <a class="link" href="gst-plugins-good-plugins-vertigotv.html#GstVertigoTV-struct" title="struct GstVertigoTV">GstVertigoTV</a>;
47</pre>
48</div>
49<div class="refsect1">
50<a name="gst-plugins-good-plugins-vertigotv.object-hierarchy"></a><h2>Object Hierarchy</h2>
51<pre class="synopsis">
52 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
53 +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
54 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
55 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
56 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
57 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideofilter.html#GstVideoFilter">GstVideoFilter</a>
58 +----GstVertigoTV
59</pre>
60</div>
61<div class="refsect1">
62<a name="gst-plugins-good-plugins-vertigotv.properties"></a><h2>Properties</h2>
63<pre class="synopsis">
64 "<a class="link" href="gst-plugins-good-plugins-vertigotv.html#GstVertigoTV--speed" title='The "speed" property'>speed</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write
65 "<a class="link" href="gst-plugins-good-plugins-vertigotv.html#GstVertigoTV--zoom-speed" title='The "zoom-speed" property'>zoom-speed</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write
66</pre>
67</div>
68<div class="refsect1">
69<a name="gst-plugins-good-plugins-vertigotv.signals"></a><h2>Signals</h2>
70<pre class="synopsis">
71 "<a class="link" href="gst-plugins-good-plugins-vertigotv.html#GstVertigoTV-reset-parms" title='The "reset-parms" signal'>reset-parms</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
72</pre>
73</div>
74<div class="refsect1">
75<a name="gst-plugins-good-plugins-vertigotv.description"></a><h2>Description</h2>
76<p>
77VertigoTV is a loopback alpha blending effector with rotating and scaling.
78</p>
79<p>
80</p>
81<div class="refsect2">
Sebastian Dröge463b56a2012-05-21 12:55:13 +020082<a name="idp5308992"></a><h3>Example launch line</h3>
Olivier Naudan988c6f02012-04-16 07:16:25 -040083<div class="informalexample">
84 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
85 <tbody>
86 <tr>
87 <td class="listing_lines" align="right"><pre>1</pre></td>
88 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v videotestsrc <span class="gtkdoc opt">!</span> vertigotv <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink</pre></td>
89 </tr>
90 </tbody>
91 </table>
92</div>
93 This pipeline shows the effect of vertigotv on a test stream.
94</div>
95<p>
96</p>
97<div class="refsynopsisdiv">
98<h2>Synopsis</h2>
99<div class="refsect2">
Sebastian Dröge463b56a2012-05-21 12:55:13 +0200100<a name="idp20062160"></a><h3>Element Information</h3>
Olivier Naudan988c6f02012-04-16 07:16:25 -0400101<div class="variablelist"><table border="0">
102<col align="left" valign="top">
103<tbody>
104<tr>
105<td><p><span class="term">plugin</span></p></td>
106<td>
107 <a class="link" href="gst-plugins-good-plugins-plugin-effectv.html#plugin-effectv">effectv</a>
108 </td>
109</tr>
110<tr>
111<td><p><span class="term">author</span></p></td>
112<td>Wim Taymans &lt;wim.taymans@gmail.be&gt;</td>
113</tr>
114<tr>
115<td><p><span class="term">class</span></p></td>
116<td>Filter/Effect/Video</td>
117</tr>
118</tbody>
119</table></div>
120</div>
121<hr>
122<div class="refsect2">
Sebastian Dröge463b56a2012-05-21 12:55:13 +0200123<a name="idp22485984"></a><h3>Element Pads</h3>
Olivier Naudan988c6f02012-04-16 07:16:25 -0400124<div class="variablelist"><table border="0">
125<col align="left" valign="top">
126<tbody>
127<tr>
128<td><p><span class="term">name</span></p></td>
129<td>sink</td>
130</tr>
131<tr>
132<td><p><span class="term">direction</span></p></td>
133<td>sink</td>
134</tr>
135<tr>
136<td><p><span class="term">presence</span></p></td>
137<td>always</td>
138</tr>
139<tr>
140<td><p><span class="term">details</span></p></td>
141<td>video/x-raw, format=(string){ RGBx, BGRx }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
142</tr>
143</tbody>
144</table></div>
145<div class="variablelist"><table border="0">
146<col align="left" valign="top">
147<tbody>
148<tr>
149<td><p><span class="term">name</span></p></td>
150<td>src</td>
151</tr>
152<tr>
153<td><p><span class="term">direction</span></p></td>
154<td>source</td>
155</tr>
156<tr>
157<td><p><span class="term">presence</span></p></td>
158<td>always</td>
159</tr>
160<tr>
161<td><p><span class="term">details</span></p></td>
162<td>video/x-raw, format=(string){ RGBx, BGRx }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
163</tr>
164</tbody>
165</table></div>
166</div>
167</div>
168<p>
169</p>
170</div>
171<div class="refsect1">
172<a name="gst-plugins-good-plugins-vertigotv.details"></a><h2>Details</h2>
173<div class="refsect2">
174<a name="GstVertigoTV-struct"></a><h3>struct GstVertigoTV</h3>
175<pre class="programlisting">struct GstVertigoTV;</pre>
176<p>
177</p>
178</div>
179</div>
180<div class="refsect1">
181<a name="gst-plugins-good-plugins-vertigotv.property-details"></a><h2>Property Details</h2>
182<div class="refsect2">
183<a name="GstVertigoTV--speed"></a><h3>The <code class="literal">"speed"</code> property</h3>
184<pre class="programlisting"> "speed" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write</pre>
185<p>Control the speed of movement.</p>
186<p>Allowed values: [0.01,100]</p>
187<p>Default value: 0.02</p>
188</div>
189<hr>
190<div class="refsect2">
191<a name="GstVertigoTV--zoom-speed"></a><h3>The <code class="literal">"zoom-speed"</code> property</h3>
192<pre class="programlisting"> "zoom-speed" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write</pre>
193<p>Control the rate of zooming.</p>
194<p>Allowed values: [1.01,1.1]</p>
195<p>Default value: 1.01</p>
196</div>
197</div>
198<div class="refsect1">
199<a name="gst-plugins-good-plugins-vertigotv.signal-details"></a><h2>Signal Details</h2>
200<div class="refsect2">
201<a name="GstVertigoTV-reset-parms"></a><h3>The <code class="literal">"reset-parms"</code> signal</h3>
202<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gst-plugins-good-plugins-vertigotv.html#GstVertigoTV"><span class="type">GstVertigoTV</span></a> *gstvertigotv,
203 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre>
204<p>
205</p>
206<div class="variablelist"><table border="0">
207<col align="left" valign="top">
208<tbody>
209<tr>
210<td><p><span class="term"><em class="parameter"><code>gstvertigotv</code></em> :</span></p></td>
211<td>the object which received the signal.</td>
212</tr>
213<tr>
214<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
215<td>user data set when the signal handler was connected.</td>
216</tr>
217</tbody>
218</table></div>
219</div>
220</div>
221</div>
222<div class="footer">
223<hr>
224 Generated by GTK-Doc V1.18</div>
225</body>
226</html>