summaryrefslogtreecommitdiffstats
path: root/gst/mxf/mxfmux.c
diff options
context:
space:
mode:
authorSebastian Dröge <sebastian.droege@collabora.co.uk>2009-04-22 19:24:43 +0200
committerSebastian Dröge <sebastian.droege@collabora.co.uk>2009-04-22 19:24:43 +0200
commite3664d57ad39c9168c18afaade39ba429b9ad672 (patch)
tree884a160dfb06129e892774e791f643712f3071b7 /gst/mxf/mxfmux.c
parentd4ff7292fd9d50ee19ff18cc7a7d0f0eaa93d76f (diff)
downloadgst-plugins-bad-e3664d57ad39c9168c18afaade39ba429b9ad672.tar.gz
gst-plugins-bad-e3664d57ad39c9168c18afaade39ba429b9ad672.tar.bz2
gst-plugins-bad-e3664d57ad39c9168c18afaade39ba429b9ad672.zip
mxf: Add documentation to mxfmux and update the docs
Diffstat (limited to 'gst/mxf/mxfmux.c')
-rw-r--r--gst/mxf/mxfmux.c13
1 files changed, 13 insertions, 0 deletions
diff --git a/gst/mxf/mxfmux.c b/gst/mxf/mxfmux.c
index d2cab0a7..3ca60a4e 100644
--- a/gst/mxf/mxfmux.c
+++ b/gst/mxf/mxfmux.c
@@ -17,6 +17,19 @@
* Boston, MA 02111-1307, USA.
*/
+/**
+ * SECTION:element-mxfmux
+ *
+ * mxfmux muxes different streams into an MXF file.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch -v filesrc location=/path/to/audio ! decodebin2 ! queue ! mxfmux name=m ! filesink location=file.mxf filesrc location=/path/to/video ! decodebin2 ! queue ! m.
+ * ]| This pipeline muxes an audio and video file into a single MXF file.
+ * </refsect2>
+ */
+
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif