docs/plugins/html/gst-plugins-bad-plugins-fpsdisplaysink.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>fpsdisplaysink</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-fisheye.html" title="fisheye">
  10 <link rel="next" href="gst-plugins-bad-plugins-freeze.html" title="freeze">
  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-fisheye.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-freeze.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-fpsdisplaysink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-bad-plugins-fpsdisplaysink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-bad-plugins-fpsdisplaysink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-bad-plugins-fpsdisplaysink.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-bad-plugins-fpsdisplaysink.properties" class="shortcut">Properties</a>
  33                    |
  34                   <a href="#gst-plugins-bad-plugins-fpsdisplaysink.signals" class="shortcut">Signals</a>
  35 </td></tr>
  36 </table>
  37 <div class="refentry">
  38 <a name="gst-plugins-bad-plugins-fpsdisplaysink"></a><div class="titlepage"></div>
  39 <div class="refnamediv"><table width="100%"><tr>
  40 <td valign="top">
  41 <h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-fpsdisplaysink.top_of_page"></a>fpsdisplaysink</span></h2>
  42 <p>fpsdisplaysink — Shows the current frame-rate and drop-rate of the videosink as overlay or text on stdout</p>
  43 </td>
  44 <td valign="top" align="right"></td>
  45 </tr></table></div>
  46 <div class="refsynopsisdiv">
  47 <a name="gst-plugins-bad-plugins-fpsdisplaysink.synopsis"></a><h2>Synopsis</h2>
  48 <a name="GstFPSDisplaySink"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink-struct" title="struct GstFPSDisplaySink">GstFPSDisplaySink</a>;
  49 </pre>
  50 </div>
  51 <div class="refsect1">
  52 <a name="gst-plugins-bad-plugins-fpsdisplaysink.object-hierarchy"></a><h2>Object Hierarchy</h2>
  53 <pre class="synopsis">
  54   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  55    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  56          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  57                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstBin.html">GstBin</a>
  58                      +----GstFPSDisplaySink
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="gst-plugins-bad-plugins-fpsdisplaysink.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  63 <p>
  64 GstFPSDisplaySink implements
  65  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstChildProxy.html">GstChildProxy</a>.</p>
  66 </div>
  67 <div class="refsect1">
  68 <a name="gst-plugins-bad-plugins-fpsdisplaysink.properties"></a><h2>Properties</h2>
  69 <pre class="synopsis">
  70   "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink--sync" title='The "sync" property'>sync</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  71   "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink--text-overlay" title='The "text-overlay" property'>text-overlay</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  72   "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink--video-sink" title='The "video-sink" property'>video-sink</a>"               <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a>*           : Read / Write
  73   "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink--fps-update-interval" title='The "fps-update-interval" property'>fps-update-interval</a>"      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  74   "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink--max-fps" title='The "max-fps" property'>max-fps</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read
  75   "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink--min-fps" title='The "min-fps" property'>min-fps</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read
  76   "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink--signal-fps-measurements" title='The "signal-fps-measurements" property'>signal-fps-measurements</a>"  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  77   "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink--frames-dropped" title='The "frames-dropped" property'>frames-dropped</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read
  78   "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink--frames-rendered" title='The "frames-rendered" property'>frames-rendered</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read
  79   "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink--last-message" title='The "last-message" property'>last-message</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  80   "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink--silent" title='The "silent" property'>silent</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  81 </pre>
  82 </div>
  83 <div class="refsect1">
  84 <a name="gst-plugins-bad-plugins-fpsdisplaysink.signals"></a><h2>Signals</h2>
  85 <pre class="synopsis">
  86   "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink-fps-measurements" title='The "fps-measurements" signal'>fps-measurements</a>"                               : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  87 </pre>
  88 </div>
  89 <div class="refsect1">
  90 <a name="gst-plugins-bad-plugins-fpsdisplaysink.description"></a><h2>Description</h2>
  91 <p>
  92 Can display the current and average framerate as a testoverlay or on stdout.
  93 </p>
  94 <p>
  95 </p>
  96 <div class="refsect2">
  97 <a name="idp13627392"></a><h3>Example launch lines</h3>
  98 <div class="informalexample">
  99   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 100     <tbody>
 101       <tr>
 102         <td class="listing_lines" align="right"><pre>1
 103 2
 104 3
 105 4</pre></td>
 106         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch videotestsrc <span class="gtkdoc opt">!</span> fpsdisplaysink
 107 gst<span class="gtkdoc opt">-</span>launch videotestsrc <span class="gtkdoc opt">!</span> fpsdisplaysink text<span class="gtkdoc opt">-</span>overlay<span class="gtkdoc opt">=</span><span class="keyword">false</span>
 108 gst<span class="gtkdoc opt">-</span>launch filesrc location<span class="gtkdoc opt">=</span>video<span class="gtkdoc opt">.</span>avi <span class="gtkdoc opt">!</span> decodebin2 name<span class="gtkdoc opt">=</span>d <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> fpsdisplaysink d<span class="gtkdoc opt">. !</span> queue <span class="gtkdoc opt">!</span> fakesink sync<span class="gtkdoc opt">=</span><span class="keyword">true</span>
 109 gst<span class="gtkdoc opt">-</span>launch playbin2 uri<span class="gtkdoc opt">=</span>file<span class="gtkdoc opt">:</span><span class="gtkdoc slc">///path/to/video.avi video-sink=&quot;fpsdisplaysink&quot; audio-sink=fakesink</span></pre></td>
 110       </tr>
 111     </tbody>
 112   </table>
 113 </div>
 114
 115 </div>
 116 <p>
 117 </p>
 118 <div class="refsynopsisdiv">
 119 <h2>Synopsis</h2>
 120 <div class="refsect2">
 121 <a name="idp13630368"></a><h3>Element Information</h3>
 122 <div class="variablelist"><table border="0">
 123 <col align="left" valign="top">
 124 <tbody>
 125 <tr>
 126 <td><p><span class="term">plugin</span></p></td>
 127 <td>
 128             <a class="link" href="gst-plugins-bad-plugins-plugin-debugutilsbad.html#plugin-debugutilsbad">debugutilsbad</a>
 129           </td>
 130 </tr>
 131 <tr>
 132 <td><p><span class="term">author</span></p></td>
 133 <td>Zeeshan Ali &lt;zeeshan.ali@nokia.com&gt;, Stefan Kost &lt;stefan.kost@nokia.com&gt;</td>
 134 </tr>
 135 <tr>
 136 <td><p><span class="term">class</span></p></td>
 137 <td>Sink/Video</td>
 138 </tr>
 139 </tbody>
 140 </table></div>
 141 </div>
 142 <hr>
 143 <div class="refsect2">
 144 <a name="idp13637776"></a><h3>Element Pads</h3>
 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>sink</td>
 151 </tr>
 152 <tr>
 153 <td><p><span class="term">direction</span></p></td>
 154 <td>sink</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>ANY</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-bad-plugins-fpsdisplaysink.details"></a><h2>Details</h2>
 173 <div class="refsect2">
 174 <a name="GstFPSDisplaySink-struct"></a><h3>struct GstFPSDisplaySink</h3>
 175 <pre class="programlisting">struct GstFPSDisplaySink;</pre>
 176 <p>
 177 </p>
 178 </div>
 179 </div>
 180 <div class="refsect1">
 181 <a name="gst-plugins-bad-plugins-fpsdisplaysink.property-details"></a><h2>Property Details</h2>
 182 <div class="refsect2">
 183 <a name="GstFPSDisplaySink--sync"></a><h3>The <code class="literal">"sync"</code> property</h3>
 184 <pre class="programlisting">  "sync"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 185 <p>Sync on the clock (if the internally used sink doesn't have this property it will be ignored.</p>
 186 <p>Default value: TRUE</p>
 187 </div>
 188 <hr>
 189 <div class="refsect2">
 190 <a name="GstFPSDisplaySink--text-overlay"></a><h3>The <code class="literal">"text-overlay"</code> property</h3>
 191 <pre class="programlisting">  "text-overlay"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 192 <p>Whether to use text-overlay.</p>
 193 <p>Default value: TRUE</p>
 194 </div>
 195 <hr>
 196 <div class="refsect2">
 197 <a name="GstFPSDisplaySink--video-sink"></a><h3>The <code class="literal">"video-sink"</code> property</h3>
 198 <pre class="programlisting">  "video-sink"               <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a>*           : Read / Write</pre>
 199 <p>Video sink to use (Must only be called on NULL state).</p>
 200 </div>
 201 <hr>
 202 <div class="refsect2">
 203 <a name="GstFPSDisplaySink--fps-update-interval"></a><h3>The <code class="literal">"fps-update-interval"</code> property</h3>
 204 <pre class="programlisting">  "fps-update-interval"      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 205 <p>Time between consecutive frames per second measures and update  (in ms). Should be set on NULL state.</p>
 206 <p>Allowed values: &gt;= 1</p>
 207 <p>Default value: 500</p>
 208 </div>
 209 <hr>
 210 <div class="refsect2">
 211 <a name="GstFPSDisplaySink--max-fps"></a><h3>The <code class="literal">"max-fps"</code> property</h3>
 212 <pre class="programlisting">  "max-fps"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read</pre>
 213 <p>Maximum fps rate measured. Reset when going from NULL to READY.-1 means no measurement has yet been done.</p>
 214 <p>Allowed values: &gt;= -1</p>
 215 <p>Default value: -1</p>
 216 </div>
 217 <hr>
 218 <div class="refsect2">
 219 <a name="GstFPSDisplaySink--min-fps"></a><h3>The <code class="literal">"min-fps"</code> property</h3>
 220 <pre class="programlisting">  "min-fps"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read</pre>
 221 <p>Minimum fps rate measured. Reset when going from NULL to READY.-1 means no measurement has yet been done.</p>
 222 <p>Allowed values: &gt;= -1</p>
 223 <p>Default value: -1</p>
 224 </div>
 225 <hr>
 226 <div class="refsect2">
 227 <a name="GstFPSDisplaySink--signal-fps-measurements"></a><h3>The <code class="literal">"signal-fps-measurements"</code> property</h3>
 228 <pre class="programlisting">  "signal-fps-measurements"  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 229 <p>If the fps-measurements signal should be emited.</p>
 230 <p>Default value: FALSE</p>
 231 </div>
 232 <hr>
 233 <div class="refsect2">
 234 <a name="GstFPSDisplaySink--frames-dropped"></a><h3>The <code class="literal">"frames-dropped"</code> property</h3>
 235 <pre class="programlisting">  "frames-dropped"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read</pre>
 236 <p>Number of frames dropped by the sink.</p>
 237 <p>Default value: 0</p>
 238 </div>
 239 <hr>
 240 <div class="refsect2">
 241 <a name="GstFPSDisplaySink--frames-rendered"></a><h3>The <code class="literal">"frames-rendered"</code> property</h3>
 242 <pre class="programlisting">  "frames-rendered"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read</pre>
 243 <p>Number of frames rendered.</p>
 244 <p>Default value: 0</p>
 245 </div>
 246 <hr>
 247 <div class="refsect2">
 248 <a name="GstFPSDisplaySink--last-message"></a><h3>The <code class="literal">"last-message"</code> property</h3>
 249 <pre class="programlisting">  "last-message"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 250 <p>The message describing current status.</p>
 251 <p>Default value: NULL</p>
 252 </div>
 253 <hr>
 254 <div class="refsect2">
 255 <a name="GstFPSDisplaySink--silent"></a><h3>The <code class="literal">"silent"</code> property</h3>
 256 <pre class="programlisting">  "silent"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 257 <p>Don't produce last_message events.</p>
 258 <p>Default value: FALSE</p>
 259 </div>
 260 </div>
 261 <div class="refsect1">
 262 <a name="gst-plugins-bad-plugins-fpsdisplaysink.signal-details"></a><h2>Signal Details</h2>
 263 <div class="refsect2">
 264 <a name="GstFPSDisplaySink-fps-measurements"></a><h3>The <code class="literal">"fps-measurements"</code> signal</h3>
 265 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink"><span class="type">GstFPSDisplaySink</span></a> *fpsdisplaysink,
 266                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>            fps,
 267                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>            droprate,
 268                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>            avgfps,
 269                                                         <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-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 270 <p>
 271 Signals the application about the measured fps
 272 </p>
 273 <div class="variablelist"><table border="0">
 274 <col align="left" valign="top">
 275 <tbody>
 276 <tr>
 277 <td><p><span class="term"><em class="parameter"><code>fpsdisplaysink</code></em> :</span></p></td>
 278 <td>a <a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink"><span class="type">GstFPSDisplaySink</span></a>
 279 </td>
 280 </tr>
 281 <tr>
 282 <td><p><span class="term"><em class="parameter"><code>fps</code></em> :</span></p></td>
 283 <td>The current measured fps</td>
 284 </tr>
 285 <tr>
 286 <td><p><span class="term"><em class="parameter"><code>droprate</code></em> :</span></p></td>
 287 <td>The rate at which buffers are being dropped</td>
 288 </tr>
 289 <tr>
 290 <td><p><span class="term"><em class="parameter"><code>avgfps</code></em> :</span></p></td>
 291 <td>The average fps</td>
 292 </tr>
 293 <tr>
 294 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 295 <td>user data set when the signal handler was connected.</td>
 296 </tr>
 297 </tbody>
 298 </table></div>
 299 <p class="since">Since 0.10.20</p>
 300 </div>
 301 </div>
 302 </div>
 303 <div class="footer">
 304 <hr>
 305           Generated by GTK-Doc V1.18</div>
 306 </body>
 307 </html>