Tizen 2.0 Release
[framework/multimedia/gst-plugins-bad0.10.git] / docs / plugins / html / gst-plugins-bad-plugins-videomaxrate.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>videomaxrate</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer Bad Plugins 0.10 Plugins Reference Manual">
8 <link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9 <link rel="prev" href="gst-plugins-bad-plugins-videomark.html" title="videomark">
10 <link rel="next" href="gst-plugins-bad-plugins-videoparse.html" title="videoparse">
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-bad-plugins-videomark.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 Bad Plugins 0.10 Plugins Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-bad-plugins-videoparse.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-bad-plugins-videomaxrate.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-bad-plugins-videomaxrate.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-bad-plugins-videomaxrate.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-bad-plugins-videomaxrate.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="gst-plugins-bad-plugins-videomaxrate"></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-bad-plugins-videomaxrate.top_of_page"></a>videomaxrate</span></h2>
38 <p>videomaxrate — Drops extra frames</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv">
43 <a name="gst-plugins-bad-plugins-videomaxrate.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstVideoMaxRate"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-bad-plugins-videomaxrate.html#GstVideoMaxRate-struct" title="struct GstVideoMaxRate">GstVideoMaxRate</a>;
45 </pre>
46 </div>
47 <div class="refsect1">
48 <a name="gst-plugins-bad-plugins-videomaxrate.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                      +----GstVideoMaxRate
55 </pre>
56 </div>
57 <div class="refsect1">
58 <a name="gst-plugins-bad-plugins-videomaxrate.properties"></a><h2>Properties</h2>
59 <pre class="synopsis">
60   "<a class="link" href="gst-plugins-bad-plugins-videomaxrate.html#GstVideoMaxRate--average-period" title='The "average-period" property'>average-period</a>"           <span class="type">guint64</span>               : Read / Write
61 </pre>
62 </div>
63 <div class="refsect1">
64 <a name="gst-plugins-bad-plugins-videomaxrate.description"></a><h2>Description</h2>
65 <p>
66 This object will drop buffers that go beyond a certain buffer rate
67 (ie frame rate). It should work with any kind of data where each buffer
68 is independent. This currently means raw video frames and still image
69 formats.
70 </p>
71 <p>
72 The framerate is computed using a moving average. The period over which this
73 average is computed is configurable using the "average-period" property.
74 </p>
75 <div class="refsynopsisdiv">
76 <h2>Synopsis</h2>
77 <div class="refsect2">
78 <a name="idp23188528"></a><h3>Element Information</h3>
79 <div class="variablelist"><table border="0">
80 <col align="left" valign="top">
81 <tbody>
82 <tr>
83 <td><p><span class="term">plugin</span></p></td>
84 <td>
85             <a class="link" href="gst-plugins-bad-plugins-plugin-videomaxrate.html#plugin-videomaxrate">videomaxrate</a>
86           </td>
87 </tr>
88 <tr>
89 <td><p><span class="term">author</span></p></td>
90 <td>Justin Karneges &lt;justin@affinix.com&gt;</td>
91 </tr>
92 <tr>
93 <td><p><span class="term">class</span></p></td>
94 <td>Filter/Effect/Video</td>
95 </tr>
96 </tbody>
97 </table></div>
98 </div>
99 <hr>
100 <div class="refsect2">
101 <a name="idp20729168"></a><h3>Element Pads</h3>
102 <div class="variablelist"><table border="0">
103 <col align="left" valign="top">
104 <tbody>
105 <tr>
106 <td><p><span class="term">name</span></p></td>
107 <td>sink</td>
108 </tr>
109 <tr>
110 <td><p><span class="term">direction</span></p></td>
111 <td>sink</td>
112 </tr>
113 <tr>
114 <td><p><span class="term">presence</span></p></td>
115 <td>always</td>
116 </tr>
117 <tr>
118 <td><p><span class="term">details</span></p></td>
119 <td>video/x-raw-yuv</td>
120 </tr>
121 <tr>
122 <td><p><span class="term"></span></p></td>
123 <td> video/x-raw-rgb</td>
124 </tr>
125 <tr>
126 <td><p><span class="term"></span></p></td>
127 <td> video/x-raw-gray</td>
128 </tr>
129 <tr>
130 <td><p><span class="term"></span></p></td>
131 <td> image/jpeg</td>
132 </tr>
133 <tr>
134 <td><p><span class="term"></span></p></td>
135 <td> image/png</td>
136 </tr>
137 </tbody>
138 </table></div>
139 <div class="variablelist"><table border="0">
140 <col align="left" valign="top">
141 <tbody>
142 <tr>
143 <td><p><span class="term">name</span></p></td>
144 <td>src</td>
145 </tr>
146 <tr>
147 <td><p><span class="term">direction</span></p></td>
148 <td>source</td>
149 </tr>
150 <tr>
151 <td><p><span class="term">presence</span></p></td>
152 <td>always</td>
153 </tr>
154 <tr>
155 <td><p><span class="term">details</span></p></td>
156 <td>video/x-raw-yuv</td>
157 </tr>
158 <tr>
159 <td><p><span class="term"></span></p></td>
160 <td> video/x-raw-rgb</td>
161 </tr>
162 <tr>
163 <td><p><span class="term"></span></p></td>
164 <td> video/x-raw-gray</td>
165 </tr>
166 <tr>
167 <td><p><span class="term"></span></p></td>
168 <td> image/jpeg</td>
169 </tr>
170 <tr>
171 <td><p><span class="term"></span></p></td>
172 <td> image/png</td>
173 </tr>
174 </tbody>
175 </table></div>
176 </div>
177 </div>
178 <p>
179 </p>
180 </div>
181 <div class="refsect1">
182 <a name="gst-plugins-bad-plugins-videomaxrate.details"></a><h2>Details</h2>
183 <div class="refsect2">
184 <a name="GstVideoMaxRate-struct"></a><h3>struct GstVideoMaxRate</h3>
185 <pre class="programlisting">struct GstVideoMaxRate;</pre>
186 <p>
187 </p>
188 </div>
189 </div>
190 <div class="refsect1">
191 <a name="gst-plugins-bad-plugins-videomaxrate.property-details"></a><h2>Property Details</h2>
192 <div class="refsect2">
193 <a name="GstVideoMaxRate--average-period"></a><h3>The <code class="literal">"average-period"</code> property</h3>
194 <pre class="programlisting">  "average-period"           <span class="type">guint64</span>               : Read / Write</pre>
195 <p>Period over which to average the framerate (in ns).</p>
196 <p>Allowed values: [1,G_MAXLONG]</p>
197 <p>Default value: 1000000000</p>
198 </div>
199 </div>
200 <div class="refsect1">
201 <a name="gst-plugins-bad-plugins-videomaxrate.see-also"></a><h2>See Also</h2>
202 videorate
203 </div>
204 </div>
205 <div class="footer">
206 <hr>
207           Generated by GTK-Doc V1.18</div>
208 </body>
209 </html>