summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim@centricular.com>2017-12-02 15:44:48 +0000
committerTim-Philipp Müller <tim@centricular.com>2017-12-02 19:00:32 +0000
commite6dbbb385404c96f3229d0048caf84b73a3efaa9 (patch)
treebf7debc53572c7d4c193f761a50ec9e1746b6c19
parentcea9641fa970db502de1323d9945377794ba4065 (diff)
aggregator: hook up to docs
-rw-r--r--docs/libs/gstreamer-libs-docs.sgml3
-rw-r--r--docs/libs/gstreamer-libs-sections.txt42
-rw-r--r--docs/libs/gstreamer-libs.types3
-rw-r--r--libs/gst/base/gstaggregator.c20
4 files changed, 65 insertions, 3 deletions
diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml
index bca5d2fa7..0b94424d1 100644
--- a/docs/libs/gstreamer-libs-docs.sgml
+++ b/docs/libs/gstreamer-libs-docs.sgml
@@ -33,6 +33,9 @@
by elements and utillity classes that are most useful for plugin developers.
</para>
+ <xi:include href="xml/gstaggregator.xml" />
+ <xi:include href="xml/gstaggregatorpad.xml" />
+
<xi:include href="xml/gstbaseparse.xml" />
<xi:include href="xml/gstbasesrc.xml" />
<xi:include href="xml/gstbasesink.xml" />
diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt
index 2d9fe2a06..4a36b480a 100644
--- a/docs/libs/gstreamer-libs-sections.txt
+++ b/docs/libs/gstreamer-libs-sections.txt
@@ -170,7 +170,7 @@ gst_trigger_control_source_get_type
<SECTION>
<FILE>gstadapter</FILE>
<TITLE>GstAdapter</TITLE>
-<INCLUDE>gst/base/gstadapter.h</INCLUDE>
+<INCLUDE>gst/base/adapter.h</INCLUDE>
GstAdapter
gst_adapter_new
gst_adapter_clear
@@ -216,6 +216,46 @@ gst_adapter_get_type
</SECTION>
<SECTION>
+<FILE>gstaggregator</FILE>
+<TITLE>GstAggregator</TITLE>
+<INCLUDE>gst/base/base.h</INCLUDE>
+GstAggregator
+GstAggregatorClass
+gst_aggregator_finish_buffer
+gst_aggregator_set_src_caps
+gst_aggregator_get_latency
+gst_aggregator_get_buffer_pool
+gst_aggregator_get_allocator
+<SUBSECTION Standard>
+GST_IS_AGGREGATOR
+GST_IS_AGGREGATOR_CLASS
+GST_TYPE_AGGREGATOR
+GST_AGGREGATOR
+GST_AGGREGATOR_CLASS
+GST_AGGREGATOR_GET_CLASS
+gst_aggregator_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gstaggregatorpad</FILE>
+<TITLE>GstAggregatorPad</TITLE>
+GstAggregatorPad
+GstAggregatorPadClass
+gst_aggregator_pad_steal_buffer
+gst_aggregator_pad_get_buffer
+gst_aggregator_pad_drop_buffer
+gst_aggregator_pad_is_eos
+<SUBSECTION Standard>
+GST_IS_AGGREGATOR_PAD
+GST_IS_AGGREGATOR_PAD_CLASS
+GST_TYPE_AGGREGATOR_PAD
+GST_AGGREGATOR_PAD
+GST_AGGREGATOR_PAD_CLASS
+GST_AGGREGATOR_PAD_GET_CLASS
+gst_aggregator_pad_get_type
+</SECTION>
+
+<SECTION>
<FILE>gstbaseparse</FILE>
<TITLE>GstBaseParse</TITLE>
<INCLUDE>gst/base/gstbaseparse.h</INCLUDE>
diff --git a/docs/libs/gstreamer-libs.types b/docs/libs/gstreamer-libs.types
index 0d4b5a3f2..c68cf9eb0 100644
--- a/docs/libs/gstreamer-libs.types
+++ b/docs/libs/gstreamer-libs.types
@@ -3,6 +3,7 @@
% base classes
#include <gst/base/gstadapter.h>
+#include <gst/base/gstaggregator.h>
#include <gst/base/gstbaseparse.h>
#include <gst/base/gstbasesrc.h>
#include <gst/base/gstbasesink.h>
@@ -11,6 +12,8 @@
#include <gst/base/gstpushsrc.h>
gst_adapter_get_type
+gst_aggregator_get_type
+gst_aggregator_pad_get_type
gst_base_parse_get_type
gst_base_src_get_type
gst_base_sink_get_type
diff --git a/libs/gst/base/gstaggregator.c b/libs/gst/base/gstaggregator.c
index 9dddf837c..fd9281142 100644
--- a/libs/gst/base/gstaggregator.c
+++ b/libs/gst/base/gstaggregator.c
@@ -22,8 +22,8 @@
/**
* SECTION: gstaggregator
* @title: GstAggregator
- * @short_description: manages a set of pads with the purpose of
- * aggregating their buffers.
+ * @short_description: Base class for mixers and muxers, manages a set of input
+ * pads and aggregates their streams
* @see_also: gstcollectpads for historical reasons.
*
* Manages a set of pads with the purpose of aggregating their buffers.
@@ -61,6 +61,22 @@
* flag these buffers with GST_BUFFER_FLAG_GAP and GST_BUFFER_FLAG_DROPPABLE
* to ease their identification and subsequent processing.
*
+ * This class used to live in gst-plugins-bad and was moved to core.
+ *
+ * Since: 1.14
+ */
+
+/**
+ * SECTION: gstaggregatorpad
+ * @title: GstAggregatorPad
+ * @short_description: #GstPad subclass for pads managed by #GstAggregator
+ * @see_also: gstcollectpads for historical reasons.
+ *
+ * Pads managed by a #GstAggregor subclass.
+ *
+ * This class used to live in gst-plugins-bad and was moved to core.
+ *
+ * Since: 1.14
*/
#ifdef HAVE_CONFIG_H