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: GStreamer Good Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.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-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.28 (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="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-good-plugins-progressreport.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-good-plugins-progressreport.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-good-plugins-progressreport.properties" class="shortcut">Properties</a></span> 21</td> 22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 24<td><a accesskey="p" href="gst-plugins-good-plugins-pngenc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gst-plugins-good-plugins-pulsesink.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 26</tr></table> 27<div class="refentry"> 28<a name="gst-plugins-good-plugins-progressreport"></a><div class="titlepage"></div> 29<div class="refnamediv"><table width="100%"><tr> 30<td valign="top"> 31<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-progressreport.top_of_page"></a>progressreport</span></h2> 32<p>progressreport</p> 33</td> 34<td class="gallery_image" valign="top" align="right"></td> 35</tr></table></div> 36<div class="refsect1"> 37<a name="gst-plugins-good-plugins-progressreport.properties"></a><h2>Properties</h2> 38<div class="informaltable"><table class="informaltable" border="0"> 39<colgroup> 40<col width="150px" class="properties_type"> 41<col width="300px" class="properties_name"> 42<col width="200px" class="properties_flags"> 43</colgroup> 44<tbody> 45<tr> 46<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-good-plugins-progressreport.html#GstProgressReport--silent" title="The “silent” property">silent</a></td> 48<td class="property_flags">Read / Write</td> 49</tr> 50<tr> 51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-good-plugins-progressreport.html#GstProgressReport--update-freq" title="The “update-freq” property">update-freq</a></td> 53<td class="property_flags">Read / Write</td> 54</tr> 55<tr> 56<td class="property_type"> 57<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 58<td class="property_name"><a class="link" href="gst-plugins-good-plugins-progressreport.html#GstProgressReport--format" title="The “format” property">format</a></td> 59<td class="property_flags">Read / Write</td> 60</tr> 61<tr> 62<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 63<td class="property_name"><a class="link" href="gst-plugins-good-plugins-progressreport.html#GstProgressReport--do-query" title="The “do-query” property">do-query</a></td> 64<td class="property_flags">Read / Write</td> 65</tr> 66</tbody> 67</table></div> 68</div> 69<a name="GstProgressReport"></a><div class="refsect1"> 70<a name="gst-plugins-good-plugins-progressreport.other"></a><h2>Types and Values</h2> 71<div class="informaltable"><table class="informaltable" width="100%" border="0"> 72<colgroup> 73<col width="150px" class="name"> 74<col class="description"> 75</colgroup> 76<tbody><tr> 77<td class="datatype_keyword">struct</td> 78<td class="function_name"><a class="link" href="gst-plugins-good-plugins-progressreport.html#GstProgressReport-struct" title="struct GstProgressReport">GstProgressReport</a></td> 79</tr></tbody> 80</table></div> 81</div> 82<div class="refsect1"> 83<a name="gst-plugins-good-plugins-progressreport.object-hierarchy"></a><h2>Object Hierarchy</h2> 84<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 85 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 86 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 87 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 88 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 89 <span class="lineart">╰──</span> GstProgressReport 90</pre> 91</div> 92<div class="refsect1"> 93<a name="gst-plugins-good-plugins-progressreport.description"></a><h2>Description</h2> 94<p>The progressreport element can be put into a pipeline to report progress, 95which is done by doing upstream duration and position queries in regular 96(real-time) intervals. Both the interval and the prefered query format 97can 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 98<a class="link" href="gst-plugins-good-plugins-progressreport.html#GstProgressReport--format" title="The “format” property"><span class="type">“format”</span></a> property.</p> 99<p>Element messages containing a "progress" structure are posted on the bus 100whenever progress has been queried (since gst-plugins-good 0.10.6 only).</p> 101<p>Since the element was originally designed for debugging purposes, it will 102by default also print information about the current progress to the 103terminal. 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> 104property to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p> 105<p>This element is most useful in transcoding pipelines or other situations 106where just querying the pipeline might not lead to the wanted result. For 107progress in TIME format, the element is best placed in a 'raw stream' 108section of the pipeline (or after any demuxers/decoders/parsers).</p> 109<p>Three more things should be pointed out: firstly, the element will only 110query progress when data flow happens. If data flow is stalled for some 111reason, no progress messages will be posted. Secondly, there are other 112elements (like qtdemux, for example) that may also post "progress" element 113messages on the bus. Applications should check the source of any element 114messages they receive, if needed. Finally, applications should not take 115action on receiving notification of progress being 100%, they should only 116take action when they receive an EOS message (since the progress reported 117is in reference to an internal point of a pipeline and not the pipeline as 118a whole).</p> 119<div class="refsect2"> 120<a name="id-1.2.115.7.7"></a><h3>Example launch line</h3> 121<div class="informalexample"> 122 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 123 <tbody> 124 <tr> 125 <td class="listing_lines" align="right"><pre>1</pre></td> 126 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> <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> 127 </tr> 128 </tbody> 129 </table> 130</div> 131 This shows a progress query where a duration is available. 132<div class="informalexample"> 133 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 134 <tbody> 135 <tr> 136 <td class="listing_lines" align="right"><pre>1</pre></td> 137 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> <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> 138 </tr> 139 </tbody> 140 </table> 141</div> 142 This shows a progress query where no duration is available. 143</div> 144<div class="refsynopsisdiv"> 145<h2>Synopsis</h2> 146<div class="refsect2"> 147<a name="id-1.2.115.7.8.1"></a><h3>Element Information</h3> 148<div class="variablelist"><table border="0" class="variablelist"> 149<colgroup> 150<col align="left" valign="top"> 151<col> 152</colgroup> 153<tbody> 154<tr> 155<td><p><span class="term">plugin</span></p></td> 156<td> 157 <a class="link" href="gst-plugins-good-plugins-plugin-debug.html#plugin-debug">debug</a> 158 </td> 159</tr> 160<tr> 161<td><p><span class="term">author</span></p></td> 162<td>Jan Schmidt <thaytan@mad.scientist.com></td> 163</tr> 164<tr> 165<td><p><span class="term">class</span></p></td> 166<td>Testing</td> 167</tr> 168</tbody> 169</table></div> 170</div> 171<hr> 172<div class="refsect2"> 173<a name="id-1.2.115.7.8.2"></a><h3>Element Pads</h3> 174<div class="variablelist"><table border="0" class="variablelist"> 175<colgroup> 176<col align="left" valign="top"> 177<col> 178</colgroup> 179<tbody> 180<tr> 181<td><p><span class="term">name</span></p></td> 182<td>sink</td> 183</tr> 184<tr> 185<td><p><span class="term">direction</span></p></td> 186<td>sink</td> 187</tr> 188<tr> 189<td><p><span class="term">presence</span></p></td> 190<td>always</td> 191</tr> 192<tr> 193<td><p><span class="term">details</span></p></td> 194<td>ANY</td> 195</tr> 196</tbody> 197</table></div> 198<div class="variablelist"><table border="0" class="variablelist"> 199<colgroup> 200<col align="left" valign="top"> 201<col> 202</colgroup> 203<tbody> 204<tr> 205<td><p><span class="term">name</span></p></td> 206<td>src</td> 207</tr> 208<tr> 209<td><p><span class="term">direction</span></p></td> 210<td>source</td> 211</tr> 212<tr> 213<td><p><span class="term">presence</span></p></td> 214<td>always</td> 215</tr> 216<tr> 217<td><p><span class="term">details</span></p></td> 218<td>ANY</td> 219</tr> 220</tbody> 221</table></div> 222</div> 223</div> 224</div> 225<div class="refsect1"> 226<a name="gst-plugins-good-plugins-progressreport.functions_details"></a><h2>Functions</h2> 227<p></p> 228</div> 229<div class="refsect1"> 230<a name="gst-plugins-good-plugins-progressreport.other_details"></a><h2>Types and Values</h2> 231<div class="refsect2"> 232<a name="GstProgressReport-struct"></a><h3>struct GstProgressReport</h3> 233<pre class="programlisting">struct GstProgressReport;</pre> 234</div> 235</div> 236<div class="refsect1"> 237<a name="gst-plugins-good-plugins-progressreport.property-details"></a><h2>Property Details</h2> 238<div class="refsect2"> 239<a name="GstProgressReport--silent"></a><h3>The <code class="literal">“silent”</code> property</h3> 240<pre class="programlisting"> “silent” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 241<p>Do not print output to stdout.</p> 242<p>Flags: Read / Write</p> 243<p>Default value: FALSE</p> 244</div> 245<hr> 246<div class="refsect2"> 247<a name="GstProgressReport--update-freq"></a><h3>The <code class="literal">“update-freq”</code> property</h3> 248<pre class="programlisting"> “update-freq” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 249<p>Number of seconds between reports when data is flowing.</p> 250<p>Flags: Read / Write</p> 251<p>Allowed values: >= 1</p> 252<p>Default value: 5</p> 253</div> 254<hr> 255<div class="refsect2"> 256<a name="GstProgressReport--format"></a><h3>The <code class="literal">“format”</code> property</h3> 257<pre class="programlisting"> “format” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 258<p>Format to use for the querying.</p> 259<p>Flags: Read / Write</p> 260<p>Default value: "auto"</p> 261</div> 262<hr> 263<div class="refsect2"> 264<a name="GstProgressReport--do-query"></a><h3>The <code class="literal">“do-query”</code> property</h3> 265<pre class="programlisting"> “do-query” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 266<p>Use a query instead of buffer metadata to determine stream position.</p> 267<p>Flags: Read / Write</p> 268<p>Default value: TRUE</p> 269</div> 270</div> 271</div> 272<div class="footer"> 273<hr>Generated by GTK-Doc V1.28</div> 274</body> 275</html>
