summaryrefslogtreecommitdiffstats
path: root/gst
diff options
context:
space:
mode:
authorSebastian Dröge <sebastian.droege@collabora.co.uk>2009-04-22 19:24:43 +0200
committerDave Robillard <dave@drobilla.net>2009-05-03 12:03:17 -0400
commit2e78fc52c5379384b4629c8f1de4decbbb971b36 (patch)
tree9791811f683f640e0a3354dd0a2f4a3bb079c82b /gst
parent8083a64f7a01b2edb2eb63355ac5b652455e1de5 (diff)
downloadgst-plugins-bad-2e78fc52c5379384b4629c8f1de4decbbb971b36.tar.gz
gst-plugins-bad-2e78fc52c5379384b4629c8f1de4decbbb971b36.tar.bz2
gst-plugins-bad-2e78fc52c5379384b4629c8f1de4decbbb971b36.zip
mxf: Add documentation to mxfmux and update the docs
Diffstat (limited to 'gst')
-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