summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMathieu Duponchelle <mathieu@centricular.com>2019-05-29 18:27:09 +0200
committerMathieu Duponchelle <mduponchelle1@gmail.com>2019-05-30 13:53:05 +0000
commit02ded087a45faeada1d644c0e7acc9234bde4860 (patch)
tree1bda506f8083b32b14ad03088e6d781404c5a9b9
parent1d90a0afc54721eaf8b046288e4c320c41f40a04 (diff)
downloadgstreamer-plugins-bad-02ded087a45faeada1d644c0e7acc9234bde4860.tar.gz
mpegtsmux: add SECTION comment
We include an example for injecting sections in the transport stream in the documentation
-rw-r--r--docs/meson.build1
-rw-r--r--gst/mpegtsmux/gstmpegtsmux.c11
2 files changed, 12 insertions, 0 deletions
diff --git a/docs/meson.build b/docs/meson.build
index cb4c6925e..955ad23c2 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -179,5 +179,6 @@ foreach plugin_name: list_plugin_res.stdout().split(':')
gst_c_source_filters: excludes,
gst_order_generated_subpages: true,
gst_plugin_name: plugin_name,
+ include_paths: join_paths(meson.current_source_dir(), '..'),
)]
endforeach
diff --git a/gst/mpegtsmux/gstmpegtsmux.c b/gst/mpegtsmux/gstmpegtsmux.c
index 7171602ea..c016953a6 100644
--- a/gst/mpegtsmux/gstmpegtsmux.c
+++ b/gst/mpegtsmux/gstmpegtsmux.c
@@ -82,6 +82,17 @@
*
*/
+/**
+ * SECTION: element-mpegtsmux
+ * @title: MPEG Transport Stream muxer
+ *
+ * mpegtsmux muxes different streams into an MPEG Transport stream
+ *
+ * SI sections can be specified through a custom event:
+ *
+ * {{ tests/examples/mpegts/ts-section-writer.c }}
+ */
+
#include "gstmpegtsmux.h"
#include <string.h>