diff options
author | Tim-Philipp Müller <tim@centricular.com> | 2018-02-13 17:10:22 +0000 |
---|---|---|
committer | Tim-Philipp Müller <tim@centricular.com> | 2018-02-13 17:10:42 +0000 |
commit | 4984c8450509a9d0f1d4f3ec8ff7f1df35eef472 (patch) | |
tree | 2b185701cd4c3d1056d8402021f4537dba6da63b | |
parent | c84c561810bb94867f28af93d4a344e073248cca (diff) |
docs: add GstAudioAggregator to docs
-rw-r--r-- | docs/libs/gst-plugins-base-libs-docs.sgml | 1 | ||||
-rw-r--r-- | docs/libs/gst-plugins-base-libs-sections.txt | 41 | ||||
-rw-r--r-- | docs/libs/gst-plugins-base-libs.types | 1 | ||||
-rw-r--r-- | gst-libs/gst/audio/gstaudioaggregator.c | 11 |
4 files changed, 49 insertions, 5 deletions
diff --git a/docs/libs/gst-plugins-base-libs-docs.sgml b/docs/libs/gst-plugins-base-libs-docs.sgml index fa2bef597..c6014a02d 100644 --- a/docs/libs/gst-plugins-base-libs-docs.sgml +++ b/docs/libs/gst-plugins-base-libs-docs.sgml @@ -55,6 +55,7 @@ </para> <xi:include href="xml/gstaudio.xml" /> <xi:include href="xml/gstaudiometa.xml" /> + <xi:include href="xml/gstaudioaggregator.xml" /> <xi:include href="xml/gstaudiocdsrc.xml" /> <xi:include href="xml/gstaudioclock.xml" /> <xi:include href="xml/gstaudiodecoder.xml" /> diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt index 9b2a88e9e..362e95af2 100644 --- a/docs/libs/gst-plugins-base-libs-sections.txt +++ b/docs/libs/gst-plugins-base-libs-sections.txt @@ -555,6 +555,47 @@ GST_TYPE_AUDIO_BASE_SINK_SLAVE_METHOD </SECTION> <SECTION> +<FILE>gstaudioaggregator</FILE> +<INCLUDE>gst/audio/audio.h</INCLUDE> +GstAudioAggregator +GstAudioAggregatorClass + +gst_audio_aggregator_set_sink_caps + +GstAudioAggregatorPad +GstAudioAggregatorPadClass + +GstAudioAggregatorConvertPad +GstAudioAggregatorConvertPadClass +<SUBSECTION Standard> +GstAudioAggregatorPrivate +GST_AUDIO_AGGREGATOR +GST_IS_AUDIO_AGGREGATOR +GST_TYPE_AUDIO_AGGREGATOR +gst_audio_aggregator_get_type +GST_AUDIO_AGGREGATOR_CLASS +GST_IS_AUDIO_AGGREGATOR_CLASS +GST_AUDIO_AGGREGATOR_GET_CLASS +gst_audio_aggregator_get_type + +GST_IS_AUDIO_AGGREGATOR_PAD +GST_IS_AUDIO_AGGREGATOR_PADCLASS +GST_TYPE_AUDIO_AGGREGATOR_PAD +GST_AUDIO_AGGREGATOR_PAD +GST_AUDIO_AGGREGATOR_PAD_CLASS +GST_AUDIO_AGGREGATOR_PAD_GET_CLASS +gst_audio_aggregator_pad_get_type + +GST_IS_AUDIO_AGGREGATOR_CONVERT_PAD +GST_IS_AUDIO_AGGREGATOR_CONVERT_PADCLASS +GST_TYPE_AUDIO_AGGREGATOR_CONVERT_PAD +GST_AUDIO_AGGREGATOR_CONVERT_PAD +GST_AUDIO_AGGREGATOR_CONVERT_PAD_CLASS +GST_AUDIO_AGGREGATOR_CONVERT_PAD_GET_CLASS +gst_audio_aggregator_convert_pad_get_type +</SECTION> + +<SECTION> <FILE>gstaudiobasesrc</FILE> <INCLUDE>gst/audio/gstaudiobasesrc.h</INCLUDE> GstAudioBaseSrc diff --git a/docs/libs/gst-plugins-base-libs.types b/docs/libs/gst-plugins-base-libs.types index a97e95220..485e36b6e 100644 --- a/docs/libs/gst-plugins-base-libs.types +++ b/docs/libs/gst-plugins-base-libs.types @@ -3,6 +3,7 @@ #include <gst/audio/gstaudioaggregator.h> gst_audio_aggregator_get_type gst_audio_aggregator_pad_get_type +gst_audio_aggregator_convert_pad_get_type #include <gst/audio/gstaudiocdsrc.h> gst_audio_cd_src_get_type #include <gst/audio/gstaudioclock.h> diff --git a/gst-libs/gst/audio/gstaudioaggregator.c b/gst-libs/gst/audio/gstaudioaggregator.c index fa9911b31..a6ae49195 100644 --- a/gst-libs/gst/audio/gstaudioaggregator.c +++ b/gst-libs/gst/audio/gstaudioaggregator.c @@ -25,24 +25,25 @@ */ /** * SECTION: gstaudioaggregator - * @short_description: manages a set of pads with the purpose of - * aggregating their buffers for raw audio + * @title: GstAudioAggregator + * @short_description: Base class that manages a set of audio input pads + * with the purpose of aggregating or mixing their raw audio input buffers * @see_also: #GstAggregator * * #GstAudioAggregator will perform conversion on the data arriving * on its sink pads, based on the format expected downstream. * * Subclasses can opt out of the conversion behaviour by setting - * #GstAudioAggregator.convert_buffer() to %NULL. + * #GstAudioAggregatorClass.convert_buffer() to %NULL. * * Subclasses that wish to use the default conversion implementation * should use a (subclass of) #GstAudioAggregatorConvertPad as their * #GstAggregatorClass.sinkpads_type, as it will cache the created * #GstAudioConverter and install a property allowing to configure it, - * #GstAudioAggregatorPadClass:converter-config. + * #GstAudioAggregatorPad:converter-config. * * Subclasses that wish to perform custom conversion should override - * #GstAudioAggregator.convert_buffer(). + * #GstAudioAggregatorClass.convert_buffer(). * * When conversion is enabled, #GstAudioAggregator will accept * any type of raw audio caps and perform conversion |