mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-10 00:12:48 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: add input-selector and output-selector to docs

Browse source
This commit is contained in:
Tim-Philipp Müller 2010-12-31 00:48:55 +00:00
parent d692735f49
commit 30d24e1d55
7 changed files with 149 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/plugins/Makefile.am
View file

@ -86,7 +86,9 @@ EXTRA_HFILES = \
$(top_srcdir)/plugins/elements/gstfilesrc.h \ $(top_srcdir)/plugins/elements/gstfilesrc.h \
$(top_srcdir)/plugins/elements/gstfilesink.h \ $(top_srcdir)/plugins/elements/gstfilesink.h \
$(top_srcdir)/plugins/elements/gstidentity.h \ $(top_srcdir)/plugins/elements/gstidentity.h \
$(top_srcdir)/plugins/elements/gstinputselector.h \
$(top_srcdir)/plugins/elements/gstmultiqueue.h \ $(top_srcdir)/plugins/elements/gstmultiqueue.h \
$(top_srcdir)/plugins/elements/gstoutputselector.h \
$(top_srcdir)/plugins/elements/gstqueue.h \ $(top_srcdir)/plugins/elements/gstqueue.h \
$(top_srcdir)/plugins/elements/gstqueue2.h \ $(top_srcdir)/plugins/elements/gstqueue2.h \
$(top_srcdir)/plugins/elements/gsttypefindelement.h \ $(top_srcdir)/plugins/elements/gsttypefindelement.h \

2
docs/plugins/gstreamer-plugins-docs.sgml
View file

@ -25,7 +25,9 @@
<xi:include href="xml/element-filesrc.xml" /> <xi:include href="xml/element-filesrc.xml" />
<xi:include href="xml/element-filesink.xml" /> <xi:include href="xml/element-filesink.xml" />
<xi:include href="xml/element-identity.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-multiqueue.xml" />
<xi:include href="xml/element-output-selector.xml" />
<xi:include href="xml/element-queue.xml" /> <xi:include href="xml/element-queue.xml" />
<xi:include href="xml/element-queue2.xml" /> <xi:include href="xml/element-queue2.xml" />
<xi:include href="xml/element-tee.xml" /> <xi:include href="xml/element-tee.xml" />

34
docs/plugins/gstreamer-plugins-sections.txt
View file

@ -125,6 +125,26 @@ GST_IS_IDENTITY_CLASS
gst_identity_get_type gst_identity_get_type
</SECTION> </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> <SECTION>
<FILE>element-queue</FILE> <FILE>element-queue</FILE>
<TITLE>queue</TITLE> <TITLE>queue</TITLE>
@ -175,6 +195,20 @@ GST_TYPE_MULTI_QUEUE
gst_multi_queue_get_type gst_multi_queue_get_type
</SECTION> </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> <SECTION>
<FILE>element-typefind</FILE> <FILE>element-typefind</FILE>
<TITLE>typefind</TITLE> <TITLE>typefind</TITLE>

50
docs/plugins/gstreamer-plugins.args
View file

@ -1008,3 +1008,53 @@
<DEFAULT>FALSE</DEFAULT> <DEFAULT>FALSE</DEFAULT>
</ARG> </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>

2
docs/plugins/gstreamer-plugins.hierarchy
View file

@ -17,7 +17,9 @@ GObject
GstIdentity GstIdentity
GstBin GstBin
GstPipeline GstPipeline
GstInputSelector
GstMultiQueue GstMultiQueue
GstOutputSelector
GstQueue GstQueue
GstQueue2 GstQueue2
GstTee GstTee

17
docs/plugins/gstreamer-plugins.signals
View file

@ -107,3 +107,20 @@ GstMultiQueue *gstmultiqueue
GstMultiQueue *gstmultiqueue GstMultiQueue *gstmultiqueue
</SIGNAL> </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>

42
docs/plugins/inspect/plugin-coreelements.xml
View file

@ -141,6 +141,27 @@
</caps> </caps>
</pads> </pads>
</element> </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> <element>
<name>multiqueue</name> <name>multiqueue</name>
<longname>MultiQueue</longname> <longname>MultiQueue</longname>
@ -162,6 +183,27 @@
</caps> </caps>
</pads> </pads>
</element> </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> <element>
<name>queue</name> <name>queue</name>
<longname>Queue</longname> <longname>Queue</longname>