Commit 4984c845 authored by Tim-Philipp Müller's avatar Tim-Philipp Müller
Browse files

docs: add GstAudioAggregator to docs

parent c84c5618
......@@ -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" />
......
......@@ -554,6 +554,47 @@ gst_audio_base_sink_slave_method_get_type
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>
......
......@@ -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>
......
......@@ -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
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment