From 9ff8c9a7bbf329c5d7e728a59d2d5fd4b97eb9d3 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Sebastian=20Dr=C3=B6ge?= Date: Thu, 29 Oct 2009 11:41:33 +0100 Subject: [PATCH] queue2: Add to the docs --- docs/plugins/Makefile.am | 1 + docs/plugins/gstreamer-plugins-docs.sgml | 1 + docs/plugins/gstreamer-plugins-sections.txt | 19 +++- docs/plugins/gstreamer-plugins.args | 158 ++++++++++++++++++++++++++- docs/plugins/gstreamer-plugins.hierarchy | 1 + docs/plugins/inspect/plugin-coreelements.xml | 25 ++++- docs/plugins/inspect/plugin-coreindexers.xml | 4 +- 7 files changed, 200 insertions(+), 9 deletions(-) diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index 64e40cc..35f5c90 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 7fe39bf..a86fc82 100644 --- a/docs/plugins/gstreamer-plugins-docs.sgml +++ b/docs/plugins/gstreamer-plugins-docs.sgml @@ -27,6 +27,7 @@ + diff --git a/docs/plugins/gstreamer-plugins-sections.txt b/docs/plugins/gstreamer-plugins-sections.txt index 36be368..ac16702 100644 --- a/docs/plugins/gstreamer-plugins-sections.txt +++ b/docs/plugins/gstreamer-plugins-sections.txt @@ -128,7 +128,6 @@ gst_identity_get_type element-queue queue GstQueue -GstQueueSize GstQueueClass GST_QUEUE @@ -137,11 +136,29 @@ GST_QUEUE_CLASS GST_IS_QUEUE_CLASS GST_TYPE_QUEUE +GstQueueSize gst_queue_get_type GST_QUEUE_CLEAR_LEVEL
+element-queue2 +queue2 +GstQueue2 + +GstQueue2Class +GST_QUEUE2 +GST_QUEUE2_CAST +GST_IS_QUEUE2 +GST_QUEUE2_CLASS +GST_IS_QUEUE2_CLASS +GST_TYPE_QUEUE2 + +GstQueue2Size +gst_queue2_get_type +
+ +
element-multiqueue multiqueue GstMultiQueue diff --git a/docs/plugins/gstreamer-plugins.args b/docs/plugins/gstreamer-plugins.args index fc2ecaa..1b07fc0 100644 --- a/docs/plugins/gstreamer-plugins.args +++ b/docs/plugins/gstreamer-plugins.args @@ -271,7 +271,7 @@ GstFakeSink::num-buffers gint ->= -1 +>= G_MAXULONG rw num-buffers Number of buffers to accept going EOS. @@ -754,7 +754,7 @@ rw Extra Size (buffers) -Amount of buffers the queues can grow if one of them is empty (0=disable). +Amount of buffers the queues can grow if one of them is empty (0=disable) (NOT IMPLEMENTED). 5 @@ -764,7 +764,7 @@ rw Extra Size (kB) -Amount of data the queues can grow if one of them is empty (bytes, 0=disable). +Amount of data the queues can grow if one of them is empty (bytes, 0=disable) (NOT IMPLEMENTED). 10485760 @@ -774,7 +774,7 @@ rw Extra Size (ns) -Amount of time the queues can grow if one of them is empty (in ns, 0=disable). +Amount of time the queues can grow if one of them is empty (in ns, 0=disable) (NOT IMPLEMENTED). 3000000000 @@ -809,6 +809,36 @@ +GstMultiQueue::high-percent +gint +[0,100] +rw +High percent +High threshold for buffering to finish. +99 + + + +GstMultiQueue::low-percent +gint +[0,100] +rw +Low percent +Low threshold for buffering to start. +10 + + + +GstMultiQueue::use-buffering +gboolean + +rw +Use buffering +Emit GST_MESSAGE_BUFFERING based on low-/high-percent thresholds. +FALSE + + + GstBin::async-handling gboolean @@ -818,3 +848,123 @@ FALSE + +GstQueue2::current-level-buffers +guint + +r +Current level (buffers) +Current number of buffers in the queue. +0 + + + +GstQueue2::current-level-bytes +guint + +r +Current level (kB) +Current amount of data in the queue (bytes). +0 + + + +GstQueue2::current-level-time +guint64 + +r +Current level (ns) +Current amount of data in the queue (in ns). +0 + + + +GstQueue2::high-percent +gint +[0,100] +rw +High percent +High threshold for buffering to finish. +99 + + + +GstQueue2::low-percent +gint +[0,100] +rw +Low percent +Low threshold for buffering to start. +10 + + + +GstQueue2::max-size-buffers +guint + +rw +Max. size (buffers) +Max. number of buffers in the queue (0=disable). +100 + + + +GstQueue2::max-size-bytes +guint + +rw +Max. size (kB) +Max. amount of data in the queue (bytes, 0=disable). +2097152 + + + +GstQueue2::max-size-time +guint64 + +rw +Max. size (ns) +Max. amount of data in the queue (in ns, 0=disable). +2000000000 + + + +GstQueue2::temp-location +gchar* + +rw +Temporary File Location +Location to store temporary files in (Deprecated: Only read this property, use temp-tmpl to configure the name template). +NULL + + + +GstQueue2::temp-template +gchar* + +rw +Temporary File Template +File template to store temporary files in, should contain directory and XXXXXX. (NULL == disabled). +NULL + + + +GstQueue2::use-buffering +gboolean + +rw +Use buffering +Emit GST_MESSAGE_BUFFERING based on low-/high-percent thresholds. +FALSE + + + +GstQueue2::use-rate-estimate +gboolean + +rw +Use Rate Estimate +Estimate the bitrate of the stream to calculate time level. +TRUE + + diff --git a/docs/plugins/gstreamer-plugins.hierarchy b/docs/plugins/gstreamer-plugins.hierarchy index 8c09310..a32ec2c 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 ac3b82b..5ba9e96 100644 --- a/docs/plugins/inspect/plugin-coreelements.xml +++ b/docs/plugins/inspect/plugin-coreelements.xml @@ -3,10 +3,10 @@ standard GStreamer elements ../../plugins/elements/.libs/libgstcoreelements.so libgstcoreelements.so - 0.10.25 + 0.10.25.1 LGPL gstreamer - GStreamer source release + GStreamer git/prerelease Unknown package origin @@ -184,6 +184,27 @@ + queue2 + Queue 2 + Generic + Simple data queue + Erik Walthinsen <omega@cse.ogi.edu>, Wim Taymans <wim.taymans@gmail.com> + + + sink + sink + always +
ANY
+ + + src + source + always +
ANY
+ + + + tee Tee pipe fitting Generic diff --git a/docs/plugins/inspect/plugin-coreindexers.xml b/docs/plugins/inspect/plugin-coreindexers.xml index a61af2a..f1e988d 100644 --- a/docs/plugins/inspect/plugin-coreindexers.xml +++ b/docs/plugins/inspect/plugin-coreindexers.xml @@ -3,10 +3,10 @@ GStreamer core indexers ../../plugins/indexers/.libs/libgstcoreindexers.so libgstcoreindexers.so - 0.10.25 + 0.10.25.1 LGPL gstreamer - GStreamer source release + GStreamer git/prerelease Unknown package origin -- 2.7.4