Tizen 2.0 Release
[framework/multimedia/gst-plugins-good0.10.git] / docs / plugins / html / gst-plugins-good-plugins-rippletv.html
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>rippletv</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
9 <link rel="prev" href="gst-plugins-good-plugins-rgvolume.html" title="rgvolume">
10 <link rel="next" href="gst-plugins-good-plugins-rtpdec.html" title="rtpdec">
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-rgvolume.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 0.10 Plugins Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-good-plugins-rtpdec.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-rippletv.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-good-plugins-rippletv.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-good-plugins-rippletv.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-good-plugins-rippletv.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="gst-plugins-good-plugins-rippletv"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
36 <td valign="top">
37 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-rippletv.top_of_page"></a>rippletv</span></h2>
38 <p>rippletv — RippleTV does ripple mark effect on the video input</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv">
43 <a name="gst-plugins-good-plugins-rippletv.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstRippleTV"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-rippletv.html#GstRippleTV-struct" title="struct GstRippleTV">GstRippleTV</a>;
45 </pre>
46 </div>
47 <div class="refsect1">
48 <a name="gst-plugins-good-plugins-rippletv.object-hierarchy"></a><h2>Object Hierarchy</h2>
49 <pre class="synopsis">
50   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
51    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
52          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
53                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
54                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideofilter.html#GstVideoFilter">GstVideoFilter</a>
55                            +----GstRippleTV
56 </pre>
57 </div>
58 <div class="refsect1">
59 <a name="gst-plugins-good-plugins-rippletv.properties"></a><h2>Properties</h2>
60 <pre class="synopsis">
61   "<a class="link" href="gst-plugins-good-plugins-rippletv.html#GstRippleTV--mode" title='The "mode" property'>mode</a>"                     <span class="type">GstRippleTVMode</span>       : Read / Write
62   "<a class="link" href="gst-plugins-good-plugins-rippletv.html#GstRippleTV--reset" title='The "reset" property'>reset</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Write
63 </pre>
64 </div>
65 <div class="refsect1">
66 <a name="gst-plugins-good-plugins-rippletv.description"></a><h2>Description</h2>
67 <p>
68 RippleTV does ripple mark effect on the video input. The ripple is caused
69 by motion or random rain drops.
70 </p>
71 <p>
72 </p>
73 <div class="refsect2">
74 <a name="idp20238336"></a><h3>Example launch line</h3>
75 <div class="informalexample">
76   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
77     <tbody>
78       <tr>
79         <td class="listing_lines" align="right"><pre>1</pre></td>
80         <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> rippletv <span class="gtkdoc opt">!</span> ffmpegcolorspace <span class="gtkdoc opt">!</span> autovideosink</pre></td>
81       </tr>
82     </tbody>
83   </table>
84 </div>
85  This pipeline shows the effect of rippletv on a test stream.
86 </div>
87 <p>
88 </p>
89 <div class="refsynopsisdiv">
90 <h2>Synopsis</h2>
91 <div class="refsect2">
92 <a name="idp18051056"></a><h3>Element Information</h3>
93 <div class="variablelist"><table border="0">
94 <col align="left" valign="top">
95 <tbody>
96 <tr>
97 <td><p><span class="term">plugin</span></p></td>
98 <td>
99             <a class="link" href="gst-plugins-good-plugins-plugin-effectv.html#plugin-effectv">effectv</a>
100           </td>
101 </tr>
102 <tr>
103 <td><p><span class="term">author</span></p></td>
104 <td>FUKUCHI, Kentarou &lt;fukuchi@users.sourceforge.net&gt;, Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</td>
105 </tr>
106 <tr>
107 <td><p><span class="term">class</span></p></td>
108 <td>Filter/Effect/Video</td>
109 </tr>
110 </tbody>
111 </table></div>
112 </div>
113 <hr>
114 <div class="refsect2">
115 <a name="idp20186912"></a><h3>Element Pads</h3>
116 <div class="variablelist"><table border="0">
117 <col align="left" valign="top">
118 <tbody>
119 <tr>
120 <td><p><span class="term">name</span></p></td>
121 <td>sink</td>
122 </tr>
123 <tr>
124 <td><p><span class="term">direction</span></p></td>
125 <td>sink</td>
126 </tr>
127 <tr>
128 <td><p><span class="term">presence</span></p></td>
129 <td>always</td>
130 </tr>
131 <tr>
132 <td><p><span class="term">details</span></p></td>
133 <td>video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
134 </tr>
135 <tr>
136 <td><p><span class="term"></span></p></td>
137 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
138 </tr>
139 <tr>
140 <td><p><span class="term"></span></p></td>
141 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
142 </tr>
143 <tr>
144 <td><p><span class="term"></span></p></td>
145 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
146 </tr>
147 </tbody>
148 </table></div>
149 <div class="variablelist"><table border="0">
150 <col align="left" valign="top">
151 <tbody>
152 <tr>
153 <td><p><span class="term">name</span></p></td>
154 <td>src</td>
155 </tr>
156 <tr>
157 <td><p><span class="term">direction</span></p></td>
158 <td>source</td>
159 </tr>
160 <tr>
161 <td><p><span class="term">presence</span></p></td>
162 <td>always</td>
163 </tr>
164 <tr>
165 <td><p><span class="term">details</span></p></td>
166 <td>video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
167 </tr>
168 <tr>
169 <td><p><span class="term"></span></p></td>
170 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
171 </tr>
172 <tr>
173 <td><p><span class="term"></span></p></td>
174 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
175 </tr>
176 <tr>
177 <td><p><span class="term"></span></p></td>
178 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
179 </tr>
180 </tbody>
181 </table></div>
182 </div>
183 </div>
184 <p>
185 </p>
186 </div>
187 <div class="refsect1">
188 <a name="gst-plugins-good-plugins-rippletv.details"></a><h2>Details</h2>
189 <div class="refsect2">
190 <a name="GstRippleTV-struct"></a><h3>struct GstRippleTV</h3>
191 <pre class="programlisting">struct GstRippleTV;</pre>
192 <p>
193 </p>
194 </div>
195 </div>
196 <div class="refsect1">
197 <a name="gst-plugins-good-plugins-rippletv.property-details"></a><h2>Property Details</h2>
198 <div class="refsect2">
199 <a name="GstRippleTV--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
200 <pre class="programlisting">  "mode"                     <span class="type">GstRippleTVMode</span>       : Read / Write</pre>
201 <p>Mode.</p>
202 <p>Default value: Motion Detection</p>
203 </div>
204 <hr>
205 <div class="refsect2">
206 <a name="GstRippleTV--reset"></a><h3>The <code class="literal">"reset"</code> property</h3>
207 <pre class="programlisting">  "reset"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Write</pre>
208 <p>Reset all current ripples.</p>
209 <p>Default value: FALSE</p>
210 </div>
211 </div>
212 </div>
213 <div class="footer">
214 <hr>
215           Generated by GTK-Doc V1.18</div>
216 </body>
217 </html>