docs: add input-selector and output-selector to docs
authorTim-Philipp Müller <tim.muller@collabora.co.uk>
Fri, 31 Dec 2010 00:48:55 +0000 (00:48 +0000)
committerTim-Philipp Müller <tim.muller@collabora.co.uk>
Fri, 31 Dec 2010 00:56:11 +0000 (00:56 +0000)
docs/plugins/Makefile.am
docs/plugins/gstreamer-plugins-docs.sgml
docs/plugins/gstreamer-plugins-sections.txt
docs/plugins/gstreamer-plugins.args
docs/plugins/gstreamer-plugins.hierarchy
docs/plugins/gstreamer-plugins.signals
docs/plugins/inspect/plugin-coreelements.xml

index bfd4fd6..0e44c57 100644 (file)
@@ -86,7 +86,9 @@ EXTRA_HFILES = \
        $(top_srcdir)/plugins/elements/gstfilesrc.h \
        $(top_srcdir)/plugins/elements/gstfilesink.h \
        $(top_srcdir)/plugins/elements/gstidentity.h \
+       $(top_srcdir)/plugins/elements/gstinputselector.h \
        $(top_srcdir)/plugins/elements/gstmultiqueue.h \
+       $(top_srcdir)/plugins/elements/gstoutputselector.h \
        $(top_srcdir)/plugins/elements/gstqueue.h \
        $(top_srcdir)/plugins/elements/gstqueue2.h \
        $(top_srcdir)/plugins/elements/gsttypefindelement.h \
index 89a707c..3d6a15c 100644 (file)
@@ -25,7 +25,9 @@
     <xi:include href="xml/element-filesrc.xml" />
     <xi:include href="xml/element-filesink.xml" />
     <xi:include href="xml/element-identity.xml" />
+    <xi:include href="xml/element-input-selector.xml" />
     <xi:include href="xml/element-multiqueue.xml" />
+    <xi:include href="xml/element-output-selector.xml" />
     <xi:include href="xml/element-queue.xml" />
     <xi:include href="xml/element-queue2.xml" />
     <xi:include href="xml/element-tee.xml" />
index 347921a..1854112 100644 (file)
@@ -126,6 +126,26 @@ gst_identity_get_type
 </SECTION>
 
 <SECTION>
+<FILE>element-input-selector</FILE>
+<TITLE>input-selector</TITLE>
+GstInputSelector
+<SUBSECTION Standard>
+GstInputSelectorClass
+GST_INPUT_SELECTOR
+GST_INPUT_SELECTOR_CLASS
+GST_IS_INPUT_SELECTOR
+GST_IS_INPUT_SELECTOR_CLASS
+GST_TYPE_INPUT_SELECTOR
+gst_input_selector_get_type
+GST_INPUT_SELECTOR_BROADCAST
+GST_INPUT_SELECTOR_GET_COND
+GST_INPUT_SELECTOR_GET_LOCK
+GST_INPUT_SELECTOR_LOCK
+GST_INPUT_SELECTOR_UNLOCK
+GST_INPUT_SELECTOR_WAIT
+</SECTION>
+
+<SECTION>
 <FILE>element-queue</FILE>
 <TITLE>queue</TITLE>
 GstQueue
@@ -176,6 +196,20 @@ gst_multi_queue_get_type
 </SECTION>
 
 <SECTION>
+<FILE>element-output-selector</FILE>
+<TITLE>output-selector</TITLE>
+GstOutputSelector
+<SUBSECTION Standard>
+GstOutputSelectorClass
+GST_OUTPUT_SELECTOR
+GST_OUTPUT_SELECTOR_CLASS
+GST_IS_OUTPUT_SELECTOR
+GST_IS_OUTPUT_SELECTOR_CLASS
+GST_TYPE_OUTPUT_SELECTOR
+gst_output_selector_get_type
+</SECTION>
+
+<SECTION>
 <FILE>element-typefind</FILE>
 <TITLE>typefind</TITLE>
 GstTypeFindElement
index 1338df5..d4d18e7 100644 (file)
 <DEFAULT>FALSE</DEFAULT>
 </ARG>
 
+<ARG>
+<NAME>GstOutputSelector::active-pad</NAME>
+<TYPE>GstPad*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Active pad</NICK>
+<BLURB>Currently active src pad.</BLURB>
+<DEFAULT></DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstOutputSelector::resend-latest</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Resend latest buffer</NICK>
+<BLURB>Resend latest buffer after a switch to a new pad.</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstInputSelector::active-pad</NAME>
+<TYPE>GstPad*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Active pad</NICK>
+<BLURB>The currently active sink pad.</BLURB>
+<DEFAULT></DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstInputSelector::n-pads</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Number of Pads</NICK>
+<BLURB>The number of sink pads.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstInputSelector::select-all</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Select all mode</NICK>
+<BLURB>Forwards data from all input pads.</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
index 21c2ed7..d6a33d1 100644 (file)
@@ -17,7 +17,9 @@ GObject
         GstIdentity
       GstBin
         GstPipeline
+      GstInputSelector
       GstMultiQueue
+      GstOutputSelector
       GstQueue
       GstQueue2
       GstTee
index 265feee..636d2e1 100644 (file)
@@ -107,3 +107,20 @@ GstMultiQueue *gstmultiqueue
 GstMultiQueue *gstmultiqueue
 </SIGNAL>
 
+<SIGNAL>
+<NAME>GstInputSelector::block</NAME>
+<RETURNS>gint64</RETURNS>
+<FLAGS>la</FLAGS>
+GstInputSelector *gstinputselector
+</SIGNAL>
+
+<SIGNAL>
+<NAME>GstInputSelector::switch</NAME>
+<RETURNS>void</RETURNS>
+<FLAGS>l</FLAGS>
+GstInputSelector *gstinputselector
+GstPad *arg1
+gint64  arg2
+gint64  arg3
+</SIGNAL>
+
index 9037730..e15c208 100644 (file)
       </pads>
     </element>
     <element>
+      <name>input-selector</name>
+      <longname>Input selector</longname>
+      <class>Generic</class>
+      <description>N-to-1 input stream selectoring</description>
+      <author>Julien Moutte &lt;julien@moutte.net&gt;, Jan Schmidt &lt;thaytan@mad.scientist.com&gt;, Wim Taymans &lt;wim.taymans@gmail.com&gt;</author>
+      <pads>
+        <caps>
+          <name>sink%d</name>
+          <direction>sink</direction>
+          <presence>request</presence>
+          <details>ANY</details>
+        </caps>
+        <caps>
+          <name>src</name>
+          <direction>source</direction>
+          <presence>always</presence>
+          <details>ANY</details>
+        </caps>
+      </pads>
+    </element>
+    <element>
       <name>multiqueue</name>
       <longname>MultiQueue</longname>
       <class>Generic</class>
       </pads>
     </element>
     <element>
+      <name>output-selector</name>
+      <longname>Output selector</longname>
+      <class>Generic</class>
+      <description>1-to-N output stream selector</description>
+      <author>Stefan Kost &lt;stefan.kost@nokia.com&gt;</author>
+      <pads>
+        <caps>
+          <name>sink</name>
+          <direction>sink</direction>
+          <presence>always</presence>
+          <details>ANY</details>
+        </caps>
+        <caps>
+          <name>src%d</name>
+          <direction>source</direction>
+          <presence>request</presence>
+          <details>ANY</details>
+        </caps>
+      </pads>
+    </element>
+    <element>
       <name>queue</name>
       <longname>Queue</longname>
       <class>Generic</class>