mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-10-02 16:52:42 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: add valve element to documentation

Browse source
This commit is contained in:
Tim-Philipp Müller 2010-12-30 00:46:02 +00:00
parent 9c34e289b8
commit 77aca24d0f
6 changed files with 54 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/plugins/Makefile.am
View file

@ -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 =

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

@ -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>

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

@ -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>

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

@ -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>

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

@ -22,6 +22,7 @@ GObject
GstQueue2
GstTee
GstTypeFindElement
GstValve
GstIndex
GstFileIndex
GstMemIndex

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

@ -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>