summaryrefslogtreecommitdiff
path: root/docs/plugins
diff options
context:
space:
mode:
authorWim Taymans <wtaymans@redhat.com>2014-05-08 14:51:12 +0200
committerWim Taymans <wtaymans@redhat.com>2014-05-08 16:54:57 +0200
commit451d0e3b0d1f02d599dd83843e94e2e0719e99d9 (patch)
tree286a749004742bbe8da8859bf0696abdf51648b6 /docs/plugins
parentb0ae6166f15911615bce55935e45a04c62ad0667 (diff)
downloadbuffer: update docs
Diffstat (limited to 'docs/plugins')
-rw-r--r--docs/plugins/Makefile.am1
-rw-r--r--docs/plugins/gstreamer-plugins-docs.sgml1
-rw-r--r--docs/plugins/gstreamer-plugins-sections.txt15
-rw-r--r--docs/plugins/gstreamer-plugins.args70
-rw-r--r--docs/plugins/gstreamer-plugins.hierarchy1
-rw-r--r--docs/plugins/inspect/plugin-coreelements.xml25
6 files changed, 111 insertions, 2 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 19f28da3e..1bab2b733 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -55,6 +55,7 @@ IGNORE_CFILES =
EXTRA_HFILES = \
$(top_srcdir)/plugins/elements/gstcapsfilter.h \
+ $(top_srcdir)/plugins/elements/gstdownloadbuffer.h \
$(top_srcdir)/plugins/elements/gstfakesrc.h \
$(top_srcdir)/plugins/elements/gstfakesink.h \
$(top_srcdir)/plugins/elements/gstfdsink.h \
diff --git a/docs/plugins/gstreamer-plugins-docs.sgml b/docs/plugins/gstreamer-plugins-docs.sgml
index 799632055..72c2e792f 100644
--- a/docs/plugins/gstreamer-plugins-docs.sgml
+++ b/docs/plugins/gstreamer-plugins-docs.sgml
@@ -18,6 +18,7 @@
<chapter>
<title>gstreamer Elements</title>
<xi:include href="xml/element-capsfilter.xml" />
+ <xi:include href="xml/element-downloadbuffer.xml" />
<xi:include href="xml/element-fakesrc.xml" />
<xi:include href="xml/element-fakesink.xml" />
<xi:include href="xml/element-fdsink.xml" />
diff --git a/docs/plugins/gstreamer-plugins-sections.txt b/docs/plugins/gstreamer-plugins-sections.txt
index 83e085792..ac4451ce1 100644
--- a/docs/plugins/gstreamer-plugins-sections.txt
+++ b/docs/plugins/gstreamer-plugins-sections.txt
@@ -126,6 +126,21 @@ gst_capsfilter_get_type
</SECTION>
<SECTION>
+<FILE>element-downloadbuffer</FILE>
+<TITLE>downloadbuffer</TITLE>
+GstDownloadBuffer
+<SUBSECTION Standard>
+GstDownloadBufferSize
+GstDownloadBufferClass
+GST_DOWNLOAD_BUFFER_CAST
+GST_DOWNLOAD_BUFFER
+GST_DOWNLOAD_BUFFER_CLASS
+GST_IS_DOWNLOAD_BUFFER
+GST_IS_DOWNLOAD_BUFFER_CLASS
+GST_TYPE_DOWNLOAD_BUFFER
+</SECTION>
+
+<SECTION>
<FILE>element-identity</FILE>
<TITLE>identity</TITLE>
GstIdentity
diff --git a/docs/plugins/gstreamer-plugins.args b/docs/plugins/gstreamer-plugins.args
index 88dfe0e1a..5d3afc571 100644
--- a/docs/plugins/gstreamer-plugins.args
+++ b/docs/plugins/gstreamer-plugins.args
@@ -998,3 +998,73 @@
<DEFAULT></DEFAULT>
</ARG>
+<ARG>
+<NAME>GstDownloadBuffer::high-percent</NAME>
+<TYPE>gint</TYPE>
+<RANGE>[0,100]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>High percent</NICK>
+<BLURB>High threshold for buffering to finish. Only used if use-buffering is True.</BLURB>
+<DEFAULT>99</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstDownloadBuffer::low-percent</NAME>
+<TYPE>gint</TYPE>
+<RANGE>[0,100]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Low percent</NICK>
+<BLURB>Low threshold for buffering to start. Only used if use-buffering is True.</BLURB>
+<DEFAULT>10</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstDownloadBuffer::max-size-bytes</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Max. size (kB)</NICK>
+<BLURB>Max. amount of data to buffer (bytes, 0=disable).</BLURB>
+<DEFAULT>2097152</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstDownloadBuffer::max-size-time</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Max. size (ns)</NICK>
+<BLURB>Max. amount of data to buffer (in ns, 0=disable).</BLURB>
+<DEFAULT>2000000000</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstDownloadBuffer::temp-location</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Temporary File Location</NICK>
+<BLURB>Location to store temporary files in (Only read this property, use temp-template to configure the name template).</BLURB>
+<DEFAULT>NULL</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstDownloadBuffer::temp-remove</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Remove the Temporary File</NICK>
+<BLURB>Remove the temp-location after use.</BLURB>
+<DEFAULT>TRUE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstDownloadBuffer::temp-template</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Temporary File Template</NICK>
+<BLURB>File template to store temporary files in, should contain directory and XXXXXX. (NULL == disabled).</BLURB>
+<DEFAULT>NULL</DEFAULT>
+</ARG>
+
diff --git a/docs/plugins/gstreamer-plugins.hierarchy b/docs/plugins/gstreamer-plugins.hierarchy
index 8f411fecf..9195eb1c8 100644
--- a/docs/plugins/gstreamer-plugins.hierarchy
+++ b/docs/plugins/gstreamer-plugins.hierarchy
@@ -22,6 +22,7 @@ GObject
GstIdentity
GstBin
GstPipeline
+ GstDownloadBuffer
GstFunnel
GstInputSelector
GstMultiQueue
diff --git a/docs/plugins/inspect/plugin-coreelements.xml b/docs/plugins/inspect/plugin-coreelements.xml
index b7c52aa11..932a54012 100644
--- a/docs/plugins/inspect/plugin-coreelements.xml
+++ b/docs/plugins/inspect/plugin-coreelements.xml
@@ -3,10 +3,10 @@
<description>GStreamer core elements</description>
<filename>../../plugins/elements/.libs/libgstcoreelements.so</filename>
<basename>libgstcoreelements.so</basename>
- <version>1.3.1</version>
+ <version>1.3.1.1</version>
<license>LGPL</license>
<source>gstreamer</source>
- <package>GStreamer source release</package>
+ <package>GStreamer git</package>
<origin>Unknown package origin</origin>
<elements>
<element>
@@ -31,6 +31,27 @@
</pads>
</element>
<element>
+ <name>downloadbuffer</name>
+ <longname>DownloadBuffer</longname>
+ <class>Generic</class>
+ <description>Download Buffer element</description>
+ <author>Wim Taymans &lt;wim.taymans@gmail.com&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>
+ <element>
<name>fakesink</name>
<longname>Fake Sink</longname>
<class>Sink</class>