From 9e0140871340d175be9d9dc37510e8123f111775 Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Sun, 11 Sep 2005 21:45:24 +0000 Subject: [PATCH] add more elements to the docs Original commit message from CVS: add more elements to the docs --- ChangeLog | 14 ++++++++++++- .../gst-plugins-base-plugins-docs.sgml | 3 +++ .../gst-plugins-base-plugins-sections.txt | 21 +++++++++++++++++++ .../inspect/plugin-ffmpegcolorspace.xml | 4 ++-- docs/plugins/tmpl/element-tcpserversink.sgml | 3 +-- gst/ffmpegcolorspace/gstffmpeg.c | 5 ++--- gst/ffmpegcolorspace/gstffmpegcolorspace.c | 13 ++++++++++++ gst/videotestsrc/gstvideotestsrc.c | 12 +++++++++++ gst/volume/gstvolume.c | 15 +++++++++++++ 9 files changed, 82 insertions(+), 8 deletions(-) diff --git a/ChangeLog b/ChangeLog index 9dce39f2eb..15c0a7330f 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,15 @@ +2005-09-11 Thomas Vander Stichele + + * 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 * check/Makefile.am: @@ -5,7 +17,7 @@ (run_pipeline), (GST_START_TEST), (simple_launch_lines_suite): Add extra tests for basetransform based components. Comment out the test_element_negotiation test until we decide - if it's testing correct behaviour. + if it's testing correct behaviour. * ext/libvisual/visual.c: (gst_visual_init), (get_buffer), (gst_visual_chain), (gst_visual_change_state): Slightly more correct but still bogus timestamping. diff --git a/docs/plugins/gst-plugins-base-plugins-docs.sgml b/docs/plugins/gst-plugins-base-plugins-docs.sgml index ce6d633c3d..0495a9fa5b 100644 --- a/docs/plugins/gst-plugins-base-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-base-plugins-docs.sgml @@ -12,8 +12,11 @@ gst-plugins-base Elements + + + diff --git a/docs/plugins/gst-plugins-base-plugins-sections.txt b/docs/plugins/gst-plugins-base-plugins-sections.txt index 32a509d5f1..a76f4ecd4e 100644 --- a/docs/plugins/gst-plugins-base-plugins-sections.txt +++ b/docs/plugins/gst-plugins-base-plugins-sections.txt @@ -1,4 +1,11 @@
+element-ffmpegcolorspace +GstFFMpegColorspace +ffmpegcolorspace + +GstFFMpegColorspaceClass +
+ element-multifdsink GstMultiFdSink GstMultiFdSinkFlags @@ -35,6 +42,20 @@ GstGnomeVFSSink GstGnomeVFSSinkClass +
+element-videotestsrc +videotestsrc + +GstVideoTestSrcClass +
+ + +element-volume +GstVolume +volume + +GstVolumeClass +
element-vorbisenc diff --git a/docs/plugins/inspect/plugin-ffmpegcolorspace.xml b/docs/plugins/inspect/plugin-ffmpegcolorspace.xml index b3e1e40c76..a3014943bd 100644 --- a/docs/plugins/inspect/plugin-ffmpegcolorspace.xml +++ b/docs/plugins/inspect/plugin-ffmpegcolorspace.xml @@ -1,9 +1,9 @@ ffmpegcolorspace - colorspace conversion copied from FFMpeg + colorspace conversion copied from FFMpeg 0.4.9-pre1 ../../gst/ffmpegcolorspace/.libs/libgstffmpegcolorspace.so libgstffmpegcolorspace.so - 0.4.9-pre1 + 0.9.2.1 LGPL gst-plugins-base FFMpeg diff --git a/docs/plugins/tmpl/element-tcpserversink.sgml b/docs/plugins/tmpl/element-tcpserversink.sgml index a3434fc89a..b04d3b9a28 100644 --- a/docs/plugins/tmpl/element-tcpserversink.sgml +++ b/docs/plugins/tmpl/element-tcpserversink.sgml @@ -2,10 +2,9 @@ tcpserversink -Send data as a server over the network via TCP + - diff --git a/gst/ffmpegcolorspace/gstffmpeg.c b/gst/ffmpegcolorspace/gstffmpeg.c index ba418df551..a8d9e0374b 100644 --- a/gst/ffmpegcolorspace/gstffmpeg.c +++ b/gst/ffmpegcolorspace/gstffmpeg.c @@ -44,6 +44,5 @@ plugin_init (GstPlugin * plugin) GST_PLUGIN_DEFINE (GST_VERSION_MAJOR, GST_VERSION_MINOR, "ffmpegcolorspace", - "colorspace conversion copied from FFMpeg", - plugin_init, - FFMPEG_VERSION, "LGPL", "FFMpeg", "http://ffmpeg.sourceforge.net/") + "colorspace conversion copied from FFMpeg " FFMPEG_VERSION, + plugin_init, VERSION, "LGPL", "FFMpeg", "http://ffmpeg.sourceforge.net/") diff --git a/gst/ffmpegcolorspace/gstffmpegcolorspace.c b/gst/ffmpegcolorspace/gstffmpegcolorspace.c index be0ea2cfcc..76409f99c2 100644 --- a/gst/ffmpegcolorspace/gstffmpegcolorspace.c +++ b/gst/ffmpegcolorspace/gstffmpegcolorspace.c @@ -19,6 +19,19 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-ffmpegcolorspace + * + * + * Example launch line + * + * + * gst-launch -v videotestsrc ! video/x-raw-yuv,format=\(fourcc\)YUY2 ! ffmpegcolorspace ! ximagesink + * + * + * + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/gst/videotestsrc/gstvideotestsrc.c b/gst/videotestsrc/gstvideotestsrc.c index 6271c5e9a0..ee16bc8a4f 100644 --- a/gst/videotestsrc/gstvideotestsrc.c +++ b/gst/videotestsrc/gstvideotestsrc.c @@ -18,6 +18,18 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-videotestsrc + * + * + * Example launch line + * + * + * gst-launch -v videotestsrc pattern=snow ! ximagesink + * + * + * + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/gst/volume/gstvolume.c b/gst/volume/gstvolume.c index 98bdbbc82e..b7d4fd0aa3 100644 --- a/gst/volume/gstvolume.c +++ b/gst/volume/gstvolume.c @@ -21,6 +21,21 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-volume + * + * + * Example launch line + * + * + * gst-launch -v -m sinesrc ! volume volume=0.5 ! level ! fakesink silent=TRUE + * + * This pipeline shows that the level of sinesrc has been halved compared to + * the same pipeline without the volume element. + * + * + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif