add more elements to the docs

Original commit message from CVS:
add more elements to the docs
This commit is contained in:
Thomas Vander Stichele 2005-09-11 21:45:24 +00:00
parent 307d58b70a
commit 9e01408713
9 changed files with 82 additions and 8 deletions

View file

@ -1,3 +1,15 @@
2005-09-11 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/plugins/gst-plugins-base-plugins-docs.sgml:
* docs/plugins/gst-plugins-base-plugins-sections.txt:
* docs/plugins/inspect/plugin-ffmpegcolorspace.xml:
* docs/plugins/tmpl/element-tcpserversink.sgml:
* gst/ffmpegcolorspace/gstffmpeg.c:
* gst/ffmpegcolorspace/gstffmpegcolorspace.c:
* gst/videotestsrc/gstvideotestsrc.c:
* gst/volume/gstvolume.c:
add more elements to the docs
2005-09-09 Jan Schmidt <thaytan@mad.scientist.com> 2005-09-09 Jan Schmidt <thaytan@mad.scientist.com>
* check/Makefile.am: * check/Makefile.am:

View file

@ -12,8 +12,11 @@
<chapter> <chapter>
<title>gst-plugins-base Elements</title> <title>gst-plugins-base Elements</title>
<xi:include href="xml/element-ffmpegcolorspace.xml" />
<xi:include href="xml/element-multifdsink.xml" /> <xi:include href="xml/element-multifdsink.xml" />
<xi:include href="xml/element-tcpserversink.xml" /> <xi:include href="xml/element-tcpserversink.xml" />
<xi:include href="xml/element-videotestsrc.xml" />
<xi:include href="xml/element-volume.xml" />
<!-- <!--
<xi:include href="xml/element-gnomevfssink.xml" /> <xi:include href="xml/element-gnomevfssink.xml" />
--> -->

View file

@ -1,4 +1,11 @@
<SECTION> <SECTION>
<FILE>element-ffmpegcolorspace</FILE>
GstFFMpegColorspace
<TITLE>ffmpegcolorspace</TITLE>
<SUBSECTION Standard>
GstFFMpegColorspaceClass
</SECTION>
<FILE>element-multifdsink</FILE> <FILE>element-multifdsink</FILE>
GstMultiFdSink GstMultiFdSink
GstMultiFdSinkFlags GstMultiFdSinkFlags
@ -35,6 +42,20 @@ GstGnomeVFSSink
GstGnomeVFSSinkClass GstGnomeVFSSinkClass
</SECTION> </SECTION>
<SECTION>
<FILE>element-videotestsrc</FILE>
<TITLE>videotestsrc</TITLE>
<SUBSECTION Standard>
GstVideoTestSrcClass
</SECTION>
<FILE>element-volume</FILE>
GstVolume
<TITLE>volume</TITLE>
<SUBSECTION Standard>
GstVolumeClass
</SECTION>
<SECTION> <SECTION>
<FILE>element-vorbisenc</FILE> <FILE>element-vorbisenc</FILE>

View file

@ -1,9 +1,9 @@
<plugin> <plugin>
<name>ffmpegcolorspace</name> <name>ffmpegcolorspace</name>
<description>colorspace conversion copied from FFMpeg</description> <description>colorspace conversion copied from FFMpeg 0.4.9-pre1</description>
<filename>../../gst/ffmpegcolorspace/.libs/libgstffmpegcolorspace.so</filename> <filename>../../gst/ffmpegcolorspace/.libs/libgstffmpegcolorspace.so</filename>
<basename>libgstffmpegcolorspace.so</basename> <basename>libgstffmpegcolorspace.so</basename>
<version>0.4.9-pre1</version> <version>0.9.2.1</version>
<license>LGPL</license> <license>LGPL</license>
<source>gst-plugins-base</source> <source>gst-plugins-base</source>
<package>FFMpeg</package> <package>FFMpeg</package>

View file

@ -2,10 +2,9 @@
tcpserversink tcpserversink
<!-- ##### SECTION Short_Description ##### --> <!-- ##### SECTION Short_Description ##### -->
Send data as a server over the network via TCP
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<include xmlns="http://www.w3.org/2003/XInclude" href="element-tcpserversink-details.xml" />
<para> <para>
</para> </para>

View file

@ -44,6 +44,5 @@ plugin_init (GstPlugin * plugin)
GST_PLUGIN_DEFINE (GST_VERSION_MAJOR, GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
GST_VERSION_MINOR, GST_VERSION_MINOR,
"ffmpegcolorspace", "ffmpegcolorspace",
"colorspace conversion copied from FFMpeg", "colorspace conversion copied from FFMpeg " FFMPEG_VERSION,
plugin_init, plugin_init, VERSION, "LGPL", "FFMpeg", "http://ffmpeg.sourceforge.net/")
FFMPEG_VERSION, "LGPL", "FFMpeg", "http://ffmpeg.sourceforge.net/")

View file

@ -19,6 +19,19 @@
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/**
* SECTION:element-ffmpegcolorspace
*
* <refsect2>
* <title>Example launch line</title>
* <para>
* <programlisting>
* gst-launch -v videotestsrc ! video/x-raw-yuv,format=\(fourcc\)YUY2 ! ffmpegcolorspace ! ximagesink
* </programlisting>
* </para>
* </refsect2>
*/
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
#include "config.h" #include "config.h"
#endif #endif

View file

@ -18,6 +18,18 @@
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/**
* SECTION:element-videotestsrc
*
* <refsect2>
* <title>Example launch line</title>
* <para>
* <programlisting>
* gst-launch -v videotestsrc pattern=snow ! ximagesink
* </programlisting>
* </para>
* </refsect2>
*/
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
#include "config.h" #include "config.h"

View file

@ -21,6 +21,21 @@
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/**
* SECTION:element-volume
*
* <refsect2>
* <title>Example launch line</title>
* <para>
* <programlisting>
* gst-launch -v -m sinesrc ! volume volume=0.5 ! level ! fakesink silent=TRUE
* </programlisting>
* This pipeline shows that the level of sinesrc has been halved compared to
* the same pipeline without the volume element.
* </para>
* </refsect2>
*/
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
#include "config.h" #include "config.h"
#endif #endif