From 77aca24d0fcf4e6fd2089e0c23c46eb2b0cd29b9 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Tim-Philipp=20M=C3=BCller?= <tim.muller@collabora.co.uk>
Date: Thu, 30 Dec 2010 00:46:02 +0000
Subject: [PATCH] docs: add valve element to documentation

---
 docs/plugins/Makefile.am                     |  3 ++-
 docs/plugins/gstreamer-plugins-docs.sgml     |  1 +
 docs/plugins/gstreamer-plugins-sections.txt  | 17 +++++++++++++++++
 docs/plugins/gstreamer-plugins.args          | 14 ++++++++++++--
 docs/plugins/gstreamer-plugins.hierarchy     |  1 +
 docs/plugins/inspect/plugin-coreelements.xml | 21 +++++++++++++++++++++
 6 files changed, 54 insertions(+), 3 deletions(-)

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 0053e1e..bfd4fd6 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -90,7 +90,8 @@ EXTRA_HFILES = \
 	$(top_srcdir)/plugins/elements/gstqueue.h \
 	$(top_srcdir)/plugins/elements/gstqueue2.h \
 	$(top_srcdir)/plugins/elements/gsttypefindelement.h \
-	$(top_srcdir)/plugins/elements/gsttee.h
+	$(top_srcdir)/plugins/elements/gsttee.h \
+	$(top_srcdir)/plugins/elements/gstvalve.h
 
 # Images to copy into HTML directory.
 HTML_IMAGES =
diff --git a/docs/plugins/gstreamer-plugins-docs.sgml b/docs/plugins/gstreamer-plugins-docs.sgml
index a86fc82..89a707c 100644
--- a/docs/plugins/gstreamer-plugins-docs.sgml
+++ b/docs/plugins/gstreamer-plugins-docs.sgml
@@ -30,6 +30,7 @@
     <xi:include href="xml/element-queue2.xml" />
     <xi:include href="xml/element-tee.xml" />
     <xi:include href="xml/element-typefind.xml" />
+    <xi:include href="xml/element-valve.xml" />
   </chapter>
 
   <chapter>
diff --git a/docs/plugins/gstreamer-plugins-sections.txt b/docs/plugins/gstreamer-plugins-sections.txt
index 6f80cc5..347921a 100644
--- a/docs/plugins/gstreamer-plugins-sections.txt
+++ b/docs/plugins/gstreamer-plugins-sections.txt
@@ -71,6 +71,7 @@ GstFileSrc
 <SUBSECTION Standard>
 GstFileSrcClass
 GST_FILE_SRC
+GST_FILE_SRC_CAST
 GST_IS_FILE_SRC
 GST_TYPE_FILE_SRC
 GST_FILE_SRC_CLASS
@@ -155,6 +156,7 @@ GST_IS_QUEUE2_CLASS
 GST_TYPE_QUEUE2
 <SUBSECTION Private>
 GstQueue2Size
+GstQueue2Range
 gst_queue2_get_type
 </SECTION>
 
@@ -206,3 +208,18 @@ GST_IS_TEE_CLASS
 gst_tee_get_type
 </SECTION>
 
+<SECTION>
+<FILE>element-valve</FILE>
+<TITLE>valve</TITLE>
+GstValve
+<SUBSECTION Standard>
+GstValveClass
+GST_VALVE
+GST_IS_VALVE
+GST_TYPE_VALVE
+GST_VALVE_CLASS
+GST_IS_VALVE_CLASS
+<SUBSECTION Private>
+gst_valve_get_type
+</SECTION>
+
diff --git a/docs/plugins/gstreamer-plugins.args b/docs/plugins/gstreamer-plugins.args
index 3b0e6f1..1338df5 100644
--- a/docs/plugins/gstreamer-plugins.args
+++ b/docs/plugins/gstreamer-plugins.args
@@ -894,7 +894,7 @@
 <RANGE>[0,100]</RANGE>
 <FLAGS>rw</FLAGS>
 <NICK>High percent</NICK>
-<BLURB>High threshold for buffering to finish.</BLURB>
+<BLURB>High threshold for buffering to finish. Only used if use-buffering is True.</BLURB>
 <DEFAULT>99</DEFAULT>
 </ARG>
 
@@ -904,7 +904,7 @@
 <RANGE>[0,100]</RANGE>
 <FLAGS>rw</FLAGS>
 <NICK>Low percent</NICK>
-<BLURB>Low threshold for buffering to start.</BLURB>
+<BLURB>Low threshold for buffering to start. Only used if use-buffering is True.</BLURB>
 <DEFAULT>10</DEFAULT>
 </ARG>
 
@@ -998,3 +998,13 @@
 <DEFAULT>0</DEFAULT>
 </ARG>
 
+<ARG>
+<NAME>GstValve::drop</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Drop buffers and events</NICK>
+<BLURB>Whether to drop buffers and events or let them through.</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
diff --git a/docs/plugins/gstreamer-plugins.hierarchy b/docs/plugins/gstreamer-plugins.hierarchy
index 6d424b5..21c2ed7 100644
--- a/docs/plugins/gstreamer-plugins.hierarchy
+++ b/docs/plugins/gstreamer-plugins.hierarchy
@@ -22,6 +22,7 @@ GObject
       GstQueue2
       GstTee
       GstTypeFindElement
+      GstValve
     GstIndex
       GstFileIndex
       GstMemIndex
diff --git a/docs/plugins/inspect/plugin-coreelements.xml b/docs/plugins/inspect/plugin-coreelements.xml
index 261a6ac..9037730 100644
--- a/docs/plugins/inspect/plugin-coreelements.xml
+++ b/docs/plugins/inspect/plugin-coreelements.xml
@@ -246,5 +246,26 @@
         </caps>
       </pads>
     </element>
+    <element>
+      <name>valve</name>
+      <longname>Valve element</longname>
+      <class>Filter</class>
+      <description>Drops buffers and events or lets them through</description>
+      <author>Olivier Crete &lt;olivier.crete@collabora.co.uk&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>
   </elements>
 </plugin>
\ No newline at end of file
-- 
2.7.4