summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Dröge <sebastian.droege@collabora.co.uk>2009-10-29 11:41:33 +0100
committerSebastian Dröge <sebastian.droege@collabora.co.uk>2009-10-29 11:41:33 +0100
commit9ff8c9a7bbf329c5d7e728a59d2d5fd4b97eb9d3 (patch)
tree38881db0c03317905c2850ba63ec2567d13a4eeb
parent22fbce48bbeec967de3b5ff70d17c659464caef7 (diff)
queue2: Add to the docs
-rw-r--r--docs/plugins/Makefile.am1
-rw-r--r--docs/plugins/gstreamer-plugins-docs.sgml1
-rw-r--r--docs/plugins/gstreamer-plugins-sections.txt19
-rw-r--r--docs/plugins/gstreamer-plugins.args158
-rw-r--r--docs/plugins/gstreamer-plugins.hierarchy1
-rw-r--r--docs/plugins/inspect/plugin-coreelements.xml25
-rw-r--r--docs/plugins/inspect/plugin-coreindexers.xml4
7 files changed, 200 insertions, 9 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 64e40cc86f..35f5c90477 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -88,6 +88,7 @@ EXTRA_HFILES = \
$(top_srcdir)/plugins/elements/gstidentity.h \
$(top_srcdir)/plugins/elements/gstmultiqueue.h \
$(top_srcdir)/plugins/elements/gstqueue.h \
+ $(top_srcdir)/plugins/elements/gstqueue2.h \
$(top_srcdir)/plugins/elements/gsttypefindelement.h \
$(top_srcdir)/plugins/elements/gsttee.h
diff --git a/docs/plugins/gstreamer-plugins-docs.sgml b/docs/plugins/gstreamer-plugins-docs.sgml
index 7fe39bfc80..a86fc82054 100644
--- a/docs/plugins/gstreamer-plugins-docs.sgml
+++ b/docs/plugins/gstreamer-plugins-docs.sgml
@@ -27,6 +27,7 @@
<xi:include href="xml/element-identity.xml" />
<xi:include href="xml/element-multiqueue.xml" />
<xi:include href="xml/element-queue.xml" />
+ <xi:include href="xml/element-queue2.xml" />
<xi:include href="xml/element-tee.xml" />
<xi:include href="xml/element-typefind.xml" />
</chapter>
diff --git a/docs/plugins/gstreamer-plugins-sections.txt b/docs/plugins/gstreamer-plugins-sections.txt
index 36be368e40..ac16702c6f 100644
--- a/docs/plugins/gstreamer-plugins-sections.txt
+++ b/docs/plugins/gstreamer-plugins-sections.txt
@@ -128,7 +128,6 @@ gst_identity_get_type
<FILE>element-queue</FILE>
<TITLE>queue</TITLE>
GstQueue
-GstQueueSize
<SUBSECTION Standard>
GstQueueClass
GST_QUEUE
@@ -137,11 +136,29 @@ GST_QUEUE_CLASS
GST_IS_QUEUE_CLASS
GST_TYPE_QUEUE
<SUBSECTION Private>
+GstQueueSize
gst_queue_get_type
GST_QUEUE_CLEAR_LEVEL
</SECTION>
<SECTION>
+<FILE>element-queue2</FILE>
+<TITLE>queue2</TITLE>
+GstQueue2
+<SUBSECTION Standard>
+GstQueue2Class
+GST_QUEUE2
+GST_QUEUE2_CAST
+GST_IS_QUEUE2
+GST_QUEUE2_CLASS
+GST_IS_QUEUE2_CLASS
+GST_TYPE_QUEUE2
+<SUBSECTION Private>
+GstQueue2Size
+gst_queue2_get_type
+</SECTION>
+
+<SECTION>
<FILE>element-multiqueue</FILE>
<TITLE>multiqueue</TITLE>
GstMultiQueue
diff --git a/docs/plugins/gstreamer-plugins.args b/docs/plugins/gstreamer-plugins.args
index fc2ecaa451..1b07fc041d 100644
--- a/docs/plugins/gstreamer-plugins.args
+++ b/docs/plugins/gstreamer-plugins.args
@@ -271,7 +271,7 @@
<ARG>
<NAME>GstFakeSink::num-buffers</NAME>
<TYPE>gint</TYPE>
-<RANGE>>= -1</RANGE>
+<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>rw</FLAGS>
<NICK>num-buffers</NICK>
<BLURB>Number of buffers to accept going EOS.</BLURB>
@@ -754,7 +754,7 @@
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Extra Size (buffers)</NICK>
-<BLURB>Amount of buffers the queues can grow if one of them is empty (0=disable).</BLURB>
+<BLURB>Amount of buffers the queues can grow if one of them is empty (0=disable) (NOT IMPLEMENTED).</BLURB>
<DEFAULT>5</DEFAULT>
</ARG>
@@ -764,7 +764,7 @@
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Extra Size (kB)</NICK>
-<BLURB>Amount of data the queues can grow if one of them is empty (bytes, 0=disable).</BLURB>
+<BLURB>Amount of data the queues can grow if one of them is empty (bytes, 0=disable) (NOT IMPLEMENTED).</BLURB>
<DEFAULT>10485760</DEFAULT>
</ARG>
@@ -774,7 +774,7 @@
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Extra Size (ns)</NICK>
-<BLURB>Amount of time the queues can grow if one of them is empty (in ns, 0=disable).</BLURB>
+<BLURB>Amount of time the queues can grow if one of them is empty (in ns, 0=disable) (NOT IMPLEMENTED).</BLURB>
<DEFAULT>3000000000</DEFAULT>
</ARG>
@@ -809,6 +809,36 @@
</ARG>
<ARG>
+<NAME>GstMultiQueue::high-percent</NAME>
+<TYPE>gint</TYPE>
+<RANGE>[0,100]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>High percent</NICK>
+<BLURB>High threshold for buffering to finish.</BLURB>
+<DEFAULT>99</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstMultiQueue::low-percent</NAME>
+<TYPE>gint</TYPE>
+<RANGE>[0,100]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Low percent</NICK>
+<BLURB>Low threshold for buffering to start.</BLURB>
+<DEFAULT>10</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstMultiQueue::use-buffering</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Use buffering</NICK>
+<BLURB>Emit GST_MESSAGE_BUFFERING based on low-/high-percent thresholds.</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
+<ARG>
<NAME>GstBin::async-handling</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
@@ -818,3 +848,123 @@
<DEFAULT>FALSE</DEFAULT>
</ARG>
+<ARG>
+<NAME>GstQueue2::current-level-buffers</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Current level (buffers)</NICK>
+<BLURB>Current number of buffers in the queue.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstQueue2::current-level-bytes</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Current level (kB)</NICK>
+<BLURB>Current amount of data in the queue (bytes).</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstQueue2::current-level-time</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Current level (ns)</NICK>
+<BLURB>Current amount of data in the queue (in ns).</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstQueue2::high-percent</NAME>
+<TYPE>gint</TYPE>
+<RANGE>[0,100]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>High percent</NICK>
+<BLURB>High threshold for buffering to finish.</BLURB>
+<DEFAULT>99</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstQueue2::low-percent</NAME>
+<TYPE>gint</TYPE>
+<RANGE>[0,100]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Low percent</NICK>
+<BLURB>Low threshold for buffering to start.</BLURB>
+<DEFAULT>10</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstQueue2::max-size-buffers</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Max. size (buffers)</NICK>
+<BLURB>Max. number of buffers in the queue (0=disable).</BLURB>
+<DEFAULT>100</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstQueue2::max-size-bytes</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Max. size (kB)</NICK>
+<BLURB>Max. amount of data in the queue (bytes, 0=disable).</BLURB>
+<DEFAULT>2097152</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstQueue2::max-size-time</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Max. size (ns)</NICK>
+<BLURB>Max. amount of data in the queue (in ns, 0=disable).</BLURB>
+<DEFAULT>2000000000</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstQueue2::temp-location</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Temporary File Location</NICK>
+<BLURB>Location to store temporary files in (Deprecated: Only read this property, use temp-tmpl to configure the name template).</BLURB>
+<DEFAULT>NULL</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstQueue2::temp-template</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Temporary File Template</NICK>
+<BLURB>File template to store temporary files in, should contain directory and XXXXXX. (NULL == disabled).</BLURB>
+<DEFAULT>NULL</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstQueue2::use-buffering</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Use buffering</NICK>
+<BLURB>Emit GST_MESSAGE_BUFFERING based on low-/high-percent thresholds.</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstQueue2::use-rate-estimate</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Use Rate Estimate</NICK>
+<BLURB>Estimate the bitrate of the stream to calculate time level.</BLURB>
+<DEFAULT>TRUE</DEFAULT>
+</ARG>
+
diff --git a/docs/plugins/gstreamer-plugins.hierarchy b/docs/plugins/gstreamer-plugins.hierarchy
index 8c09310a6d..a32ec2cf8d 100644
--- a/docs/plugins/gstreamer-plugins.hierarchy
+++ b/docs/plugins/gstreamer-plugins.hierarchy
@@ -22,6 +22,7 @@ GObject
GstFdSink
GstFileSink
GstQueue
+ GstQueue2
GstTee
GstTypeFindElement
GstMultiQueue
diff --git a/docs/plugins/inspect/plugin-coreelements.xml b/docs/plugins/inspect/plugin-coreelements.xml
index ac3b82b27e..5ba9e9680c 100644
--- a/docs/plugins/inspect/plugin-coreelements.xml
+++ b/docs/plugins/inspect/plugin-coreelements.xml
@@ -3,10 +3,10 @@
<description>standard GStreamer elements</description>
<filename>../../plugins/elements/.libs/libgstcoreelements.so</filename>
<basename>libgstcoreelements.so</basename>
- <version>0.10.25</version>
+ <version>0.10.25.1</version>
<license>LGPL</license>
<source>gstreamer</source>
- <package>GStreamer source release</package>
+ <package>GStreamer git/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>
@@ -184,6 +184,27 @@
</pads>
</element>
<element>
+ <name>queue2</name>
+ <longname>Queue 2</longname>
+ <class>Generic</class>
+ <description>Simple data queue</description>
+ <author>Erik Walthinsen &lt;omega@cse.ogi.edu&gt;, Wim Taymans &lt;wim.taymans@gmail.com&gt;</author>
+ <pads>
+ <caps>
+ <name>sink</name>
+ <direction>sink</direction>
+ <presence>always</presence>
+ <details>ANY</details>
+ </caps>
+ <caps>
+ <name>src</name>
+ <direction>source</direction>
+ <presence>always</presence>
+ <details>ANY</details>
+ </caps>
+ </pads>
+ </element>
+ <element>
<name>tee</name>
<longname>Tee pipe fitting</longname>
<class>Generic</class>
diff --git a/docs/plugins/inspect/plugin-coreindexers.xml b/docs/plugins/inspect/plugin-coreindexers.xml
index a61af2a91b..f1e988dedd 100644
--- a/docs/plugins/inspect/plugin-coreindexers.xml
+++ b/docs/plugins/inspect/plugin-coreindexers.xml
@@ -3,10 +3,10 @@
<description>GStreamer core indexers</description>
<filename>../../plugins/indexers/.libs/libgstcoreindexers.so</filename>
<basename>libgstcoreindexers.so</basename>
- <version>0.10.25</version>
+ <version>0.10.25.1</version>
<license>LGPL</license>
<source>gstreamer</source>
- <package>GStreamer source release</package>
+ <package>GStreamer git/prerelease</package>
<origin>Unknown package origin</origin>
<elements>