summaryrefslogtreecommitdiffstats
path: root/gst/flv/gstflvmux.c
diff options
context:
space:
mode:
authorSebastian Dröge <sebastian.droege@collabora.co.uk>2009-04-22 19:52:05 +0200
committerSebastian Dröge <sebastian.droege@collabora.co.uk>2009-04-22 19:52:05 +0200
commit6734a9980e844d56b6c4b0bdad9dc2ce91e2dd1c (patch)
tree0ad62692fbf169f79b99cad984f2b6f4a265207c /gst/flv/gstflvmux.c
parent8e846331202bc831dd894f0100929b787e294ff9 (diff)
downloadgst-plugins-bad-6734a9980e844d56b6c4b0bdad9dc2ce91e2dd1c.tar.gz
gst-plugins-bad-6734a9980e844d56b6c4b0bdad9dc2ce91e2dd1c.tar.bz2
gst-plugins-bad-6734a9980e844d56b6c4b0bdad9dc2ce91e2dd1c.zip
flv: Add documentation to flvmux and flvdemux
Partially fixes bug #573737.
Diffstat (limited to 'gst/flv/gstflvmux.c')
-rw-r--r--gst/flv/gstflvmux.c13
1 files changed, 13 insertions, 0 deletions
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
*/