From 16e2bccc610d03f2019a3c8493fe65c69da0c4a2 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Mon, 8 Dec 2008 15:25:13 +0000 Subject: [PATCH] gst/playback/: Add basic docs to decodebin and link to decodebin from decodebin2. Original commit message from CVS: * gst/playback/gstdecodebin.c: * gst/playback/gstdecodebin2.c: Add basic docs to decodebin and link to decodebin from decodebin2. --- ChangeLog | 7 +++++++ gst/playback/gstdecodebin.c | 11 +++++++++++ gst/playback/gstdecodebin2.c | 6 +++--- 3 files changed, 21 insertions(+), 3 deletions(-) diff --git a/ChangeLog b/ChangeLog index 760ec54e1e..6b8c314460 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2008-12-08 Stefan Kost + + * gst/playback/gstdecodebin.c: + * gst/playback/gstdecodebin2.c: + Add basic docs to decodebin and link to decodebin from decodebin2. + + 2008-12-08 Wim Taymans Patch by: Olivier Crete diff --git a/gst/playback/gstdecodebin.c b/gst/playback/gstdecodebin.c index c38feb6cbd..59f3412211 100644 --- a/gst/playback/gstdecodebin.c +++ b/gst/playback/gstdecodebin.c @@ -17,6 +17,17 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-decodebin + * + * #GstBin that auto-magically constructs a decoding pipeline using available + * decoders and demuxers via auto-plugging. + * + * When using decodebin in your application, connect a signal handler to + * #GstDecodeBin::new-decoded-pad and connect your sinks from within the + * callback function. + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/gst/playback/gstdecodebin2.c b/gst/playback/gstdecodebin2.c index 1798cd1283..6db6b5bc69 100644 --- a/gst/playback/gstdecodebin2.c +++ b/gst/playback/gstdecodebin2.c @@ -24,11 +24,11 @@ * decoders and demuxers via auto-plugging. * * At this stage, decodebin2 is considered UNSTABLE. The API provided in the - * signals is expected to change in the near future. + * signals is expected to change in the near future. * - * To try out decodebin2, you can set the USE_DECODEBIN2 environment + * To try out decodebin2, you can set the USE_DECODEBIN2 environment * variable (USE_DECODEBIN2=1 for example). This will cause playbin to use - * decodebin2 instead of the older decodebin for its internal auto-plugging. + * decodebin2 instead of the older #GstDecodeBin for its internal auto-plugging. */ #ifdef HAVE_CONFIG_H