summaryrefslogtreecommitdiffstats
path: root/gst
diff options
context:
space:
mode:
authorSebastian Dröge <sebastian.droege@collabora.co.uk>2009-04-22 19:52:05 +0200
committerDave Robillard <dave@drobilla.net>2009-05-03 12:03:17 -0400
commit50249ce03717eb815d9e5cd6eb3342f7148fa38e (patch)
treec8cd9bad71a98e3d4962d181971ae782344f6907 /gst
parent62a803e7a213c50fde885f719ef3a27aa13fed05 (diff)
downloadgst-plugins-bad-50249ce03717eb815d9e5cd6eb3342f7148fa38e.tar.gz
gst-plugins-bad-50249ce03717eb815d9e5cd6eb3342f7148fa38e.tar.bz2
gst-plugins-bad-50249ce03717eb815d9e5cd6eb3342f7148fa38e.zip
flv: Add documentation to flvmux and flvdemux
Partially fixes bug #573737.
Diffstat (limited to 'gst')
-rw-r--r--gst/flv/gstflvdemux.c13
-rw-r--r--gst/flv/gstflvdemux.h2
-rw-r--r--gst/flv/gstflvmux.c13
-rw-r--r--gst/flv/gstflvmux.h2
4 files changed, 30 insertions, 0 deletions
diff --git a/gst/flv/gstflvdemux.c b/gst/flv/gstflvdemux.c
index a2bbd7cb..f31a22e8 100644
--- a/gst/flv/gstflvdemux.c
+++ b/gst/flv/gstflvdemux.c
@@ -17,6 +17,19 @@
* Boston, MA 02111-1307, USA.
*/
+/**
+ * SECTION:element-flvdemux
+ *
+ * flvdemux demuxes an FLV file into the different contained streams.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch -v filesrc location=/path/to/flv ! flvdemux ! audioconvert ! autoaudiosink
+ * ]| This pipeline demuxes an FLV file and outputs the contained raw audio streams.
+ * </refsect2>
+ */
+
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
diff --git a/gst/flv/gstflvdemux.h b/gst/flv/gstflvdemux.h
index 1a675e7c..72c0bcd4 100644
--- a/gst/flv/gstflvdemux.h
+++ b/gst/flv/gstflvdemux.h
@@ -56,6 +56,8 @@ struct _GstFLVDemux
GstPad *audio_pad;
GstPad *video_pad;
+
+ /* <private> */
GstIndex *index;
gint index_id;
diff --git a/gst/flv/gstflvmux.c b/gst/flv/gstflvmux.c
index 2a7c9169..c1bd1205 100644
--- a/gst/flv/gstflvmux.c
+++ b/gst/flv/gstflvmux.c
@@ -18,6 +18,19 @@
* Boston, MA 02111-1307, USA.
*/
+/**
+ * SECTION:element-flvmux
+ *
+ * flvmux muxes different streams into an FLV file.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch -v filesrc location=/path/to/audio ! decodebin2 ! queue ! flvmux name=m ! filesink location=file.flv filesrc location=/path/to/video ! decodebin2 ! queue ! m.
+ * ]| This pipeline muxes an audio and video file into a single FLV file.
+ * </refsect2>
+ */
+
/* TODO:
* - Write metadata for the file, see FLV spec page 13
*/
diff --git a/gst/flv/gstflvmux.h b/gst/flv/gstflvmux.h
index c0af8e8f..3d634a4c 100644
--- a/gst/flv/gstflvmux.h
+++ b/gst/flv/gstflvmux.h
@@ -67,6 +67,8 @@ typedef struct _GstFlvMux {
GstPad *srcpad;
GstCollectPads *collect;
+
+ /* <private> */
GstPadEventFunction collect_event;
GstFlvMuxState state;