mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-23 18:21:04 +00:00
docs: add GstAudioAggregator to docs
This commit is contained in:
parent
c84c561810
commit
4984c84505
4 changed files with 49 additions and 5 deletions
|
@ -55,6 +55,7 @@
|
||||||
</para>
|
</para>
|
||||||
<xi:include href="xml/gstaudio.xml" />
|
<xi:include href="xml/gstaudio.xml" />
|
||||||
<xi:include href="xml/gstaudiometa.xml" />
|
<xi:include href="xml/gstaudiometa.xml" />
|
||||||
|
<xi:include href="xml/gstaudioaggregator.xml" />
|
||||||
<xi:include href="xml/gstaudiocdsrc.xml" />
|
<xi:include href="xml/gstaudiocdsrc.xml" />
|
||||||
<xi:include href="xml/gstaudioclock.xml" />
|
<xi:include href="xml/gstaudioclock.xml" />
|
||||||
<xi:include href="xml/gstaudiodecoder.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
|
GST_TYPE_AUDIO_BASE_SINK_SLAVE_METHOD
|
||||||
</SECTION>
|
</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>
|
<SECTION>
|
||||||
<FILE>gstaudiobasesrc</FILE>
|
<FILE>gstaudiobasesrc</FILE>
|
||||||
<INCLUDE>gst/audio/gstaudiobasesrc.h</INCLUDE>
|
<INCLUDE>gst/audio/gstaudiobasesrc.h</INCLUDE>
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
#include <gst/audio/gstaudioaggregator.h>
|
#include <gst/audio/gstaudioaggregator.h>
|
||||||
gst_audio_aggregator_get_type
|
gst_audio_aggregator_get_type
|
||||||
gst_audio_aggregator_pad_get_type
|
gst_audio_aggregator_pad_get_type
|
||||||
|
gst_audio_aggregator_convert_pad_get_type
|
||||||
#include <gst/audio/gstaudiocdsrc.h>
|
#include <gst/audio/gstaudiocdsrc.h>
|
||||||
gst_audio_cd_src_get_type
|
gst_audio_cd_src_get_type
|
||||||
#include <gst/audio/gstaudioclock.h>
|
#include <gst/audio/gstaudioclock.h>
|
||||||
|
|
|
@ -25,24 +25,25 @@
|
||||||
*/
|
*/
|
||||||
/**
|
/**
|
||||||
* SECTION: gstaudioaggregator
|
* SECTION: gstaudioaggregator
|
||||||
* @short_description: manages a set of pads with the purpose of
|
* @title: GstAudioAggregator
|
||||||
* aggregating their buffers for raw audio
|
* @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
|
* @see_also: #GstAggregator
|
||||||
*
|
*
|
||||||
* #GstAudioAggregator will perform conversion on the data arriving
|
* #GstAudioAggregator will perform conversion on the data arriving
|
||||||
* on its sink pads, based on the format expected downstream.
|
* on its sink pads, based on the format expected downstream.
|
||||||
*
|
*
|
||||||
* Subclasses can opt out of the conversion behaviour by setting
|
* 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
|
* Subclasses that wish to use the default conversion implementation
|
||||||
* should use a (subclass of) #GstAudioAggregatorConvertPad as their
|
* should use a (subclass of) #GstAudioAggregatorConvertPad as their
|
||||||
* #GstAggregatorClass.sinkpads_type, as it will cache the created
|
* #GstAggregatorClass.sinkpads_type, as it will cache the created
|
||||||
* #GstAudioConverter and install a property allowing to configure it,
|
* #GstAudioConverter and install a property allowing to configure it,
|
||||||
* #GstAudioAggregatorPadClass:converter-config.
|
* #GstAudioAggregatorPad:converter-config.
|
||||||
*
|
*
|
||||||
* Subclasses that wish to perform custom conversion should override
|
* Subclasses that wish to perform custom conversion should override
|
||||||
* #GstAudioAggregator.convert_buffer().
|
* #GstAudioAggregatorClass.convert_buffer().
|
||||||
*
|
*
|
||||||
* When conversion is enabled, #GstAudioAggregator will accept
|
* When conversion is enabled, #GstAudioAggregator will accept
|
||||||
* any type of raw audio caps and perform conversion
|
* any type of raw audio caps and perform conversion
|
||||||
|
|
Loading…
Reference in a new issue