docs/plugins/html/gst-plugins-good-plugins-progressreport.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>progressreport</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-pngenc.html" title="pngenc">
  10 <link rel="next" href="gst-plugins-good-plugins-pulsesink.html" title="pulsesink">
  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-pngenc.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-pulsesink.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-progressreport.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-progressreport.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-progressreport.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-progressreport.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-progressreport"></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-progressreport.top_of_page"></a>progressreport</span></h2>
  38 <p>progressreport — Periodically query and report on processing progress</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-progressreport.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstProgressReport"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-progressreport.html#GstProgressReport-struct" title="struct GstProgressReport">GstProgressReport</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-progressreport.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                      +----GstProgressReport
  55 </pre>
  56 </div>
  57 <div class="refsect1">
  58 <a name="gst-plugins-good-plugins-progressreport.properties"></a><h2>Properties</h2>
  59 <pre class="synopsis">
  60   "<a class="link" href="gst-plugins-good-plugins-progressreport.html#GstProgressReport--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
  61   "<a class="link" href="gst-plugins-good-plugins-progressreport.html#GstProgressReport--update-freq" title='The "update-freq" property'>update-freq</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  62   "<a class="link" href="gst-plugins-good-plugins-progressreport.html#GstProgressReport--format" title='The "format" property'>format</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  63   "<a class="link" href="gst-plugins-good-plugins-progressreport.html#GstProgressReport--do-query" title='The "do-query" property'>do-query</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  64 </pre>
  65 </div>
  66 <div class="refsect1">
  67 <a name="gst-plugins-good-plugins-progressreport.description"></a><h2>Description</h2>
  68 <p>
  69 The progressreport element can be put into a pipeline to report progress,
  70 which is done by doing upstream duration and position queries in regular
  71 (real-time) intervals. Both the interval and the prefered query format
  72 can be specified via the <a class="link" href="gst-plugins-good-plugins-progressreport.html#GstProgressReport--update-freq" title='The "update-freq" property'><span class="type">"update-freq"</span></a> and the
  73 <a class="link" href="gst-plugins-good-plugins-progressreport.html#GstProgressReport--format" title='The "format" property'><span class="type">"format"</span></a> property.
  74 </p>
  75 <p>
  76 Element messages containing a "progress" structure are posted on the bus
  77 whenever progress has been queried (since gst-plugins-good 0.10.6 only).
  78 </p>
  79 <p>
  80 Since the element was originally designed for debugging purposes, it will
  81 by default also print information about the current progress to the
  82 terminal. This can be prevented by setting the <a class="link" href="gst-plugins-good-plugins-progressreport.html#GstProgressReport--silent" title='The "silent" property'><span class="type">"silent"</span></a>
  83 property to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.
  84 </p>
  85 <p>
  86 This element is most useful in transcoding pipelines or other situations
  87 where just querying the pipeline might not lead to the wanted result. For
  88 progress in TIME format, the element is best placed in a 'raw stream'
  89 section of the pipeline (or after any demuxers/decoders/parsers).
  90 </p>
  91 <p>
  92 Three more things should be pointed out: firstly, the element will only
  93 query progress when data flow happens. If data flow is stalled for some
  94 reason, no progress messages will be posted. Secondly, there are other
  95 elements (like qtdemux, for example) that may also post "progress" element
  96 messages on the bus. Applications should check the source of any element
  97 messages they receive, if needed. Finally, applications should not take
  98 action on receiving notification of progress being 100%, they should only
  99 take action when they receive an EOS message (since the progress reported
 100 is in reference to an internal point of a pipeline and not the pipeline as
 101 a whole).
 102 </p>
 103 <p>
 104 </p>
 105 <div class="refsect2">
 106 <a name="idp19641856"></a><h3>Example launch line</h3>
 107 <div class="informalexample">
 108   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 109     <tbody>
 110       <tr>
 111         <td class="listing_lines" align="right"><pre>1</pre></td>
 112         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>m filesrc location<span class="gtkdoc opt">=</span>foo<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> progressreport update<span class="gtkdoc opt">-</span>freq<span class="gtkdoc opt">=</span><span class="number">1</span> <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audioresample <span class="gtkdoc opt">!</span> autoaudiosink</pre></td>
 113       </tr>
 114     </tbody>
 115   </table>
 116 </div>
 117  This shows a progress query where a duration is available.
 118 <div class="informalexample">
 119   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 120     <tbody>
 121       <tr>
 122         <td class="listing_lines" align="right"><pre>1</pre></td>
 123         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>m audiotestsrc <span class="gtkdoc opt">!</span> progressreport update<span class="gtkdoc opt">-</span>freq<span class="gtkdoc opt">=</span><span class="number">1</span> <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> autoaudiosink</pre></td>
 124       </tr>
 125     </tbody>
 126   </table>
 127 </div>
 128  This shows a progress query where no duration is available.
 129 </div>
 130 <p>
 131 </p>
 132 <div class="refsynopsisdiv">
 133 <h2>Synopsis</h2>
 134 <div class="refsect2">
 135 <a name="idp17899488"></a><h3>Element Information</h3>
 136 <div class="variablelist"><table border="0">
 137 <col align="left" valign="top">
 138 <tbody>
 139 <tr>
 140 <td><p><span class="term">plugin</span></p></td>
 141 <td>
 142             <a class="link" href="gst-plugins-good-plugins-plugin-debug.html#plugin-debug">debug</a>
 143           </td>
 144 </tr>
 145 <tr>
 146 <td><p><span class="term">author</span></p></td>
 147 <td>Jan Schmidt &lt;thaytan@mad.scientist.com&gt;</td>
 148 </tr>
 149 <tr>
 150 <td><p><span class="term">class</span></p></td>
 151 <td>Testing</td>
 152 </tr>
 153 </tbody>
 154 </table></div>
 155 </div>
 156 <hr>
 157 <div class="refsect2">
 158 <a name="idp17619152"></a><h3>Element Pads</h3>
 159 <div class="variablelist"><table border="0">
 160 <col align="left" valign="top">
 161 <tbody>
 162 <tr>
 163 <td><p><span class="term">name</span></p></td>
 164 <td>sink</td>
 165 </tr>
 166 <tr>
 167 <td><p><span class="term">direction</span></p></td>
 168 <td>sink</td>
 169 </tr>
 170 <tr>
 171 <td><p><span class="term">presence</span></p></td>
 172 <td>always</td>
 173 </tr>
 174 <tr>
 175 <td><p><span class="term">details</span></p></td>
 176 <td>ANY</td>
 177 </tr>
 178 </tbody>
 179 </table></div>
 180 <div class="variablelist"><table border="0">
 181 <col align="left" valign="top">
 182 <tbody>
 183 <tr>
 184 <td><p><span class="term">name</span></p></td>
 185 <td>src</td>
 186 </tr>
 187 <tr>
 188 <td><p><span class="term">direction</span></p></td>
 189 <td>source</td>
 190 </tr>
 191 <tr>
 192 <td><p><span class="term">presence</span></p></td>
 193 <td>always</td>
 194 </tr>
 195 <tr>
 196 <td><p><span class="term">details</span></p></td>
 197 <td>ANY</td>
 198 </tr>
 199 </tbody>
 200 </table></div>
 201 </div>
 202 </div>
 203 <p>
 204 </p>
 205 </div>
 206 <div class="refsect1">
 207 <a name="gst-plugins-good-plugins-progressreport.details"></a><h2>Details</h2>
 208 <div class="refsect2">
 209 <a name="GstProgressReport-struct"></a><h3>struct GstProgressReport</h3>
 210 <pre class="programlisting">struct GstProgressReport;</pre>
 211 <p>
 212 </p>
 213 </div>
 214 </div>
 215 <div class="refsect1">
 216 <a name="gst-plugins-good-plugins-progressreport.property-details"></a><h2>Property Details</h2>
 217 <div class="refsect2">
 218 <a name="GstProgressReport--silent"></a><h3>The <code class="literal">"silent"</code> property</h3>
 219 <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>
 220 <p>Do not print output to stdout.</p>
 221 <p>Default value: FALSE</p>
 222 </div>
 223 <hr>
 224 <div class="refsect2">
 225 <a name="GstProgressReport--update-freq"></a><h3>The <code class="literal">"update-freq"</code> property</h3>
 226 <pre class="programlisting">  "update-freq"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 227 <p>Number of seconds between reports when data is flowing.</p>
 228 <p>Allowed values: &gt;= 1</p>
 229 <p>Default value: 5</p>
 230 </div>
 231 <hr>
 232 <div class="refsect2">
 233 <a name="GstProgressReport--format"></a><h3>The <code class="literal">"format"</code> property</h3>
 234 <pre class="programlisting">  "format"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 235 <p>Format to use for the querying.</p>
 236 <p>Default value: "auto"</p>
 237 </div>
 238 <hr>
 239 <div class="refsect2">
 240 <a name="GstProgressReport--do-query"></a><h3>The <code class="literal">"do-query"</code> property</h3>
 241 <pre class="programlisting">  "do-query"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 242 <p>Use a query instead of buffer metadata to determine stream position.</p>
 243 <p>Default value: TRUE</p>
 244 </div>
 245 </div>
 246 </div>
 247 <div class="footer">
 248 <hr>
 249           Generated by GTK-Doc V1.18</div>
 250 </body>
 251 </html>