diff options
Diffstat (limited to 'docs/plugins/html/gstreamer-plugins-queue.html')
| -rw-r--r-- | docs/plugins/html/gstreamer-plugins-queue.html | 92 |
1 files changed, 68 insertions, 24 deletions
diff --git a/docs/plugins/html/gstreamer-plugins-queue.html b/docs/plugins/html/gstreamer-plugins-queue.html index 1285631..0aac199 100644 --- a/docs/plugins/html/gstreamer-plugins-queue.html +++ b/docs/plugins/html/gstreamer-plugins-queue.html @@ -3,7 +3,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>queue</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="GStreamer Core Plugins 1.0 Plugins Reference Manual"> <link rel="up" href="ch01.html" title="gstreamer Elements"> <link rel="prev" href="gstreamer-plugins-output-selector.html" title="output-selector"> @@ -63,6 +63,7 @@ enum <a class="link" href="gstreamer-plugins-queue.html#GstQueueL "<a class="link" href="gstreamer-plugins-queue.html#GstQueue--current-level-buffers" title='The "current-level-buffers" property'>current-level-buffers</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read "<a class="link" href="gstreamer-plugins-queue.html#GstQueue--current-level-bytes" title='The "current-level-bytes" property'>current-level-bytes</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read "<a class="link" href="gstreamer-plugins-queue.html#GstQueue--current-level-time" title='The "current-level-time" property'>current-level-time</a>" <span class="type">guint64</span> : Read + "<a class="link" href="gstreamer-plugins-queue.html#GstQueue--flush-on-eos" title='The "flush-on-eos" property'>flush-on-eos</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write "<a class="link" href="gstreamer-plugins-queue.html#GstQueue--leaky" title='The "leaky" property'>leaky</a>" <a class="link" href="gstreamer-plugins-queue.html#GstQueueLeaky" title="enum GstQueueLeaky"><span class="type">GstQueueLeaky</span></a> : Read / Write "<a class="link" href="gstreamer-plugins-queue.html#GstQueue--max-size-buffers" title='The "max-size-buffers" property'>max-size-buffers</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write "<a class="link" href="gstreamer-plugins-queue.html#GstQueue--max-size-bytes" title='The "max-size-bytes" property'>max-size-bytes</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write @@ -77,9 +78,9 @@ enum <a class="link" href="gstreamer-plugins-queue.html#GstQueueL <a name="gstreamer-plugins-queue.signals"></a><h2>Signals</h2> <pre class="synopsis"> "<a class="link" href="gstreamer-plugins-queue.html#GstQueue-overrun" title='The "overrun" signal'>overrun</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a> + "<a class="link" href="gstreamer-plugins-queue.html#GstQueue-pushing" title='The "pushing" signal'>pushing</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a> "<a class="link" href="gstreamer-plugins-queue.html#GstQueue-running" title='The "running" signal'>running</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a> "<a class="link" href="gstreamer-plugins-queue.html#GstQueue-underrun" title='The "underrun" signal'>underrun</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a> - "<a class="link" href="gstreamer-plugins-queue.html#GstQueue-pushing" title='The "pushing" signal'>pushing</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a> </pre> </div> <div class="refsect1"> @@ -122,9 +123,12 @@ up. Both signals are emitted from the context of the streaming thread. <div class="refsynopsisdiv"> <h2>Synopsis</h2> <div class="refsect2"> -<a name="idp11420640"></a><h3>Element Information</h3> -<div class="variablelist"><table border="0"> +<a name="idp10597232"></a><h3>Element Information</h3> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term">plugin</span></p></td> @@ -145,9 +149,12 @@ up. Both signals are emitted from the context of the streaming thread. </div> <hr> <div class="refsect2"> -<a name="idp11428096"></a><h3>Element Pads</h3> -<div class="variablelist"><table border="0"> +<a name="idp10604688"></a><h3>Element Pads</h3> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term">name</span></p></td> @@ -167,8 +174,11 @@ up. Both signals are emitted from the context of the streaming thread. </tr> </tbody> </table></div> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term">name</span></p></td> @@ -214,8 +224,11 @@ Opaque <a class="link" href="gstreamer-plugins-queue.html#GstQueue"><span class= <p> Buffer dropping scheme to avoid the queue to block when full. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><a name="GST-QUEUE-NO-LEAK:CAPS"></a><span class="term"><code class="literal">GST_QUEUE_NO_LEAK</code></span></p></td> @@ -260,6 +273,25 @@ Buffer dropping scheme to avoid the queue to block when full. </div> <hr> <div class="refsect2"> +<a name="GstQueue--flush-on-eos"></a><h3>The <code class="literal">"flush-on-eos"</code> property</h3> +<pre class="programlisting"> "flush-on-eos" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre> +<p> +Discard all data in the queue when an EOS event is received, and pass +on the EOS event as soon as possible (instead of waiting until all +buffers in the queue have been processed, which is the default behaviour). +</p> +<p> +Flushing the queue on EOS might be useful when capturing and encoding +from a live source, to finish up the recording quickly in cases when +the encoder is slow. Note that this might mean some data from the end of +the recoding data might be lost though (never more than the configured +max. sizes though). +</p> +<p>Default value: FALSE</p> +<p class="since">Since 1.2</p> +</div> +<hr> +<div class="refsect2"> <a name="GstQueue--leaky"></a><h3>The <code class="literal">"leaky"</code> property</h3> <pre class="programlisting"> "leaky" <a class="link" href="gstreamer-plugins-queue.html#GstQueueLeaky" title="enum GstQueueLeaky"><span class="type">GstQueueLeaky</span></a> : Read / Write</pre> <p>Where the queue leaks, if at all.</p> @@ -330,8 +362,11 @@ A buffer is full if the total amount of data inside it (num-buffers, time, size) is higher than the boundary values which can be set through the GObject properties. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>queue</code></em> :</span></p></td> @@ -346,16 +381,18 @@ GObject properties. </div> <hr> <div class="refsect2"> -<a name="GstQueue-running"></a><h3>The <code class="literal">"running"</code> signal</h3> +<a name="GstQueue-pushing"></a><h3>The <code class="literal">"pushing"</code> signal</h3> <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gstreamer-plugins-queue.html#GstQueue"><span class="type">GstQueue</span></a> *queue, <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-FIRST:CAPS"><code class="literal">Run First</code></a></pre> <p> -Reports that enough (min-threshold) data is in the queue. Use this signal -together with the underrun signal to pause the pipeline on underrun and -wait for the queue to fill-up before resume playback. +Reports when the queue has enough data to start pushing data again on the +source pad. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>queue</code></em> :</span></p></td> @@ -370,17 +407,19 @@ wait for the queue to fill-up before resume playback. </div> <hr> <div class="refsect2"> -<a name="GstQueue-underrun"></a><h3>The <code class="literal">"underrun"</code> signal</h3> +<a name="GstQueue-running"></a><h3>The <code class="literal">"running"</code> signal</h3> <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gstreamer-plugins-queue.html#GstQueue"><span class="type">GstQueue</span></a> *queue, <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-FIRST:CAPS"><code class="literal">Run First</code></a></pre> <p> -Reports that the buffer became empty (underrun). -A buffer is empty if the total amount of data inside it (num-buffers, time, -size) is lower than the boundary values which can be set through the -GObject properties. +Reports that enough (min-threshold) data is in the queue. Use this signal +together with the underrun signal to pause the pipeline on underrun and +wait for the queue to fill-up before resume playback. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>queue</code></em> :</span></p></td> @@ -395,15 +434,20 @@ GObject properties. </div> <hr> <div class="refsect2"> -<a name="GstQueue-pushing"></a><h3>The <code class="literal">"pushing"</code> signal</h3> +<a name="GstQueue-underrun"></a><h3>The <code class="literal">"underrun"</code> signal</h3> <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gstreamer-plugins-queue.html#GstQueue"><span class="type">GstQueue</span></a> *queue, <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-FIRST:CAPS"><code class="literal">Run First</code></a></pre> <p> -Reports when the queue has enough data to start pushing data again on the -source pad. +Reports that the buffer became empty (underrun). +A buffer is empty if the total amount of data inside it (num-buffers, time, +size) is lower than the boundary values which can be set through the +GObject properties. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>queue</code></em> :</span></p></td> |