summaryrefslogtreecommitdiffstats
path: root/gst/matroska
diff options
context:
space:
mode:
Diffstat (limited to 'gst/matroska')
-rw-r--r--gst/matroska/matroska-demux.c14
-rw-r--r--gst/matroska/matroska-demux.h2
-rw-r--r--gst/matroska/matroska-mux.c16
-rw-r--r--gst/matroska/matroska-mux.h2
4 files changed, 34 insertions, 0 deletions
diff --git a/gst/matroska/matroska-demux.c b/gst/matroska/matroska-demux.c
index 9e6adf94..5ed4f788 100644
--- a/gst/matroska/matroska-demux.c
+++ b/gst/matroska/matroska-demux.c
@@ -30,6 +30,20 @@
* TODO: seeking with incomplete or without CUE
*/
+/**
+ * SECTION:element-matroskademux
+ *
+ * matroskademux demuxes a Matroska file into the different contained streams.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch -v filesrc location=/path/to/mkv ! matroskademux ! vorbisdec ! audioconvert ! audioresample ! autoaudiosink
+ * ]| This pipeline demuxes a Matroska file and outputs the contained Vorbis audio.
+ * </refsect2>
+ */
+
+
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
diff --git a/gst/matroska/matroska-demux.h b/gst/matroska/matroska-demux.h
index 846ce289..744f593c 100644
--- a/gst/matroska/matroska-demux.h
+++ b/gst/matroska/matroska-demux.h
@@ -49,6 +49,8 @@ typedef enum {
typedef struct _GstMatroskaDemux {
GstEbmlRead parent;
+ /* < private > */
+
/* pads */
GstPad *sinkpad;
GPtrArray *src;
diff --git a/gst/matroska/matroska-mux.c b/gst/matroska/matroska-mux.c
index 97c4333c..3299d5f3 100644
--- a/gst/matroska/matroska-mux.c
+++ b/gst/matroska/matroska-mux.c
@@ -25,6 +25,22 @@
* - make sure timestamps are correctly scaled everywhere
*/
+/**
+ * SECTION:element-matroskamux
+ *
+ * matroskamux muxes different input streams into a Matroska file.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch -v filesrc location=/path/to/mp3 ! mp3parse ! matroskamux name=mux ! filesink location=test.mkv filesrc location=/path/to/theora.ogg ! oggdemux ! theoraparse ! mux.
+ * ]| This pipeline muxes an MP3 file and a Ogg Theora video into a Matroska file.
+ * |[
+ * gst-launch -v audiotestsrc num-buffers=100 ! audioconvert ! vorbisenc ! matroskamux ! filesink location=test.mka
+ * ]| This pipeline muxes a 440Hz sine wave encoded with the Vorbis codec into a Matroska file.
+ * </refsect2>
+ */
+
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
diff --git a/gst/matroska/matroska-mux.h b/gst/matroska/matroska-mux.h
index 867cf086..57828036 100644
--- a/gst/matroska/matroska-mux.h
+++ b/gst/matroska/matroska-mux.h
@@ -84,6 +84,8 @@ GstMatroskaPad;
typedef struct _GstMatroskaMux {
GstElement element;
+
+ /* < private > */
/* pads */
GstPad *srcpad;