summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim@centricular.net>2012-12-14 15:13:19 +0000
committerTim-Philipp Müller <tim@centricular.net>2012-12-14 15:13:19 +0000
commitef547ff48ec042e070c822a5088f6cf7021b47c6 (patch)
tree29f09b966faa4a6465a9aa52cfdaeb0d5e3781b1 /docs
parent61913ab7b4b66fb5d653217730f375b27c39f598 (diff)
docs: add scaletempo to docs
Diffstat (limited to 'docs')
-rw-r--r--docs/plugins/Makefile.am1
-rw-r--r--docs/plugins/gst-plugins-good-plugins-docs.sgml1
-rw-r--r--docs/plugins/gst-plugins-good-plugins-sections.txt14
-rw-r--r--docs/plugins/gst-plugins-good-plugins.args68
-rw-r--r--docs/plugins/gst-plugins-good-plugins.hierarchy3
-rw-r--r--docs/plugins/inspect/plugin-audiofx.xml21
6 files changed, 99 insertions, 9 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 6cc27da21..8722b31cd 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -98,6 +98,7 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/audiofx/audiowsincband.h \
$(top_srcdir)/gst/audiofx/audiowsinclimit.h \
$(top_srcdir)/gst/audiofx/audiofirfilter.h \
+ $(top_srcdir)/gst/audiofx/gstscaletempo.h \
$(top_srcdir)/gst/audioparsers/gstaacparse.h \
$(top_srcdir)/gst/audioparsers/gstac3parse.h \
$(top_srcdir)/gst/audioparsers/gstamrparse.h \
diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index 420b94bb8..67c76f74d 100644
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -138,6 +138,7 @@
<xi:include href="xml/element-rtpptdemux.xml" />
<xi:include href="xml/element-rtpsession.xml" />
<xi:include href="xml/element-rtpssrcdemux.xml" />
+ <xi:include href="xml/element-scaletempo.xml" />
<xi:include href="xml/element-shagadelictv.xml" />
<xi:include href="xml/element-shapewipe.xml" />
<xi:include href="xml/element-smpte.xml" />
diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index 252593c43..a87c62156 100644
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -2269,6 +2269,20 @@ gst_rippletv_get_type
</SECTION>
<SECTION>
+<FILE>element-scaletempo</FILE>
+<TITLE>scaletempo</TITLE>
+GstScaletempo
+<SUBSECTION Standard>
+GstScaletempoClass
+GST_IS_SCALETEMPO
+GST_IS_SCALETEMPO_CLASS
+GST_SCALETEMPO
+GST_SCALETEMPO_CLASS
+GST_TYPE_SCALETEMPO
+gst_scaletempo_get_type
+</SECTION>
+
+<SECTION>
<FILE>element-shagadelictv</FILE>
<TITLE>shagadelictv</TITLE>
GstShagadelicTV
diff --git a/docs/plugins/gst-plugins-good-plugins.args b/docs/plugins/gst-plugins-good-plugins.args
index 646f8e278..1abe7039e 100644
--- a/docs/plugins/gst-plugins-good-plugins.args
+++ b/docs/plugins/gst-plugins-good-plugins.args
@@ -253,7 +253,7 @@
<TYPE>gint</TYPE>
<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>rw</FLAGS>
-<NICK>Start Index</NICK>
+<NICK>Stop Index</NICK>
<BLURB>Stop value of index. The special value -1 means no stop.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
@@ -899,6 +899,16 @@
</ARG>
<ARG>
+<NAME>GstRTSPSrc::udp-reconnect</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Reconnect to the server</NICK>
+<BLURB>Reconnect to the server if RTSP connection is closed when doing UDP.</BLURB>
+<DEFAULT>TRUE</DEFAULT>
+</ARG>
+
+<ARG>
<NAME>GstRTPDec::skip</NAME>
<TYPE>gint</TYPE>
<RANGE></RANGE>
@@ -3261,40 +3271,40 @@
<ARG>
<NAME>GstVideoCrop::bottom</NAME>
<TYPE>gint</TYPE>
-<RANGE>>= 0</RANGE>
+<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Bottom</NICK>
-<BLURB>Pixels to crop at bottom.</BLURB>
+<BLURB>Pixels to crop at bottom (-1 to auto-crop).</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVideoCrop::left</NAME>
<TYPE>gint</TYPE>
-<RANGE>>= 0</RANGE>
+<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Left</NICK>
-<BLURB>Pixels to crop at left.</BLURB>
+<BLURB>Pixels to crop at left (-1 to auto-crop).</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVideoCrop::right</NAME>
<TYPE>gint</TYPE>
-<RANGE>>= 0</RANGE>
+<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Right</NICK>
-<BLURB>Pixels to crop at right.</BLURB>
+<BLURB>Pixels to crop at right (-1 to auto-crop).</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVideoCrop::top</NAME>
<TYPE>gint</TYPE>
-<RANGE>>= 0</RANGE>
+<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Top</NICK>
-<BLURB>Pixels to crop at top.</BLURB>
+<BLURB>Pixels to crop at top (-1 to auto-crop).</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
@@ -23398,3 +23408,43 @@
<DEFAULT>TRUE</DEFAULT>
</ARG>
+<ARG>
+<NAME>GstScaletempo::overlap</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[0,1]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Overlap Length</NICK>
+<BLURB>Percentage of stride to overlap.</BLURB>
+<DEFAULT>0.2</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstScaletempo::rate</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[-2.14748e+09,2.14748e+09]</RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Playback Rate</NICK>
+<BLURB>Current playback rate.</BLURB>
+<DEFAULT>1</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstScaletempo::search</NAME>
+<TYPE>guint</TYPE>
+<RANGE><= 500</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Search Length</NICK>
+<BLURB>Length in milliseconds to search for best overlap position.</BLURB>
+<DEFAULT>14</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstScaletempo::stride</NAME>
+<TYPE>guint</TYPE>
+<RANGE>[1,5000]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Stride Length</NICK>
+<BLURB>Length in milliseconds to output each stride.</BLURB>
+<DEFAULT>30</DEFAULT>
+</ARG>
+
diff --git a/docs/plugins/gst-plugins-good-plugins.hierarchy b/docs/plugins/gst-plugins-good-plugins.hierarchy
index bd2a43a44..06ab38046 100644
--- a/docs/plugins/gst-plugins-good-plugins.hierarchy
+++ b/docs/plugins/gst-plugins-good-plugins.hierarchy
@@ -103,6 +103,7 @@ GObject
GstProgressReport
GstRgAnalysis
GstRgLimiter
+ GstScaletempo
GstTagInject
GstVideoFilter
GstAgingTV
@@ -203,6 +204,7 @@ GObject
GstRtpSPEEXDepay
GstRtpSV3VDepay
GstRtpTheoraDepay
+ GstRtpVP8Depay
GstRtpVRawDepay
GstRtpVorbisDepay
GstRtpXQTDepay
@@ -237,6 +239,7 @@ GObject
GstRtpMPAPay
GstRtpSPEEXPay
GstRtpTheoraPay
+ GstRtpVP8Pay
GstRtpVRawPay
GstRtpVorbisPay
GstRTPDec
diff --git a/docs/plugins/inspect/plugin-audiofx.xml b/docs/plugins/inspect/plugin-audiofx.xml
index 0b790f6fc..210f67811 100644
--- a/docs/plugins/inspect/plugin-audiofx.xml
+++ b/docs/plugins/inspect/plugin-audiofx.xml
@@ -261,5 +261,26 @@
</caps>
</pads>
</element>
+ <element>
+ <name>scaletempo</name>
+ <longname>Scaletempo</longname>
+ <class>Filter/Effect/Rate</class>
+ <description>Sync audio tempo with playback rate</description>
+ <author>Rov Juvano &lt;rovjuvano@users.sourceforge.net&gt;</author>
+ <pads>
+ <caps>
+ <name>sink</name>
+ <direction>sink</direction>
+ <presence>always</presence>
+ <details>audio/x-raw, format=(string)F32LE, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]; audio/x-raw, format=(string)S16LE, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
+ </caps>
+ <caps>
+ <name>src</name>
+ <direction>source</direction>
+ <presence>always</presence>
+ <details>audio/x-raw, format=(string)F32LE, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]; audio/x-raw, format=(string)S16LE, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
+ </caps>
+ </pads>
+ </element>
</elements>
</plugin> \ No newline at end of file