mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-11 18:05:37 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: doc fixes for audio library

Browse source 
Add sections docs for audiometa. Fix sections docs for audiochannels. Remove old
mixerutil section.
This commit is contained in:
Stefan Sauer 2014-01-31 23:27:03 +01:00
parent c9b493b853
commit 76ec6d3760
4 changed files with 13 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/libs/gst-plugins-base-libs-docs.sgml
View file

@ -59,7 +59,6 @@
<xi:include href="xml/gstaudiodecoder.xml" /> <xi:include href="xml/gstaudiodecoder.xml" />
<xi:include href="xml/gstaudioencoder.xml" /> <xi:include href="xml/gstaudioencoder.xml" />
<xi:include href="xml/gstaudiofilter.xml" /> <xi:include href="xml/gstaudiofilter.xml" />
<xi:include href="xml/gstaudiomixerutils.xml" />
<xi:include href="xml/gstaudiosink.xml" /> <xi:include href="xml/gstaudiosink.xml" />
<xi:include href="xml/gstaudiosrc.xml" /> <xi:include href="xml/gstaudiosrc.xml" />
<xi:include href="xml/gstaudiobasesink.xml" /> <xi:include href="xml/gstaudiobasesink.xml" />

7
docs/libs/gst-plugins-base-libs-sections.txt
View file

@ -372,13 +372,6 @@ GST_AUDIO_FILTER_INFO
GST_AUDIO_FILTER_RATE GST_AUDIO_FILTER_RATE
</SECTION> </SECTION>
<SECTION>
<FILE>gstaudiomixerutils</FILE>
<INCLUDE>gst/audio/mixerutils.h</INCLUDE>
GstAudioMixerFilterFunc
gst_audio_default_registry_mixer_filter
</SECTION>
<SECTION> <SECTION>
<FILE>gstaudiosink</FILE> <FILE>gstaudiosink</FILE>
<INCLUDE>gst/audio/gstaudiosink.h</INCLUDE> <INCLUDE>gst/audio/gstaudiosink.h</INCLUDE>

6
gst-libs/gst/audio/audio-channels.c
View file

@ -17,10 +17,10 @@
* Boston, MA 02110-1301, USA. * Boston, MA 02110-1301, USA.
*/ */
/** /**
* SECTION:gstaudio * SECTION:gstaudiochannels
* @short_description: Support library for audio elements * @short_description: Support library for audio channel handling
* *
* This library contains some helper functions for audio elements. * This library contains some helper functions for multichannel audio.
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

11
gst-libs/gst/audio/gstaudiometa.c
View file

@ -17,6 +17,15 @@
* Boston, MA 02110-1301, USA. * Boston, MA 02110-1301, USA.
*/ */
/**
* SECTION:gstaudiometa
* @short_description: Buffer metadata for audio downmix matrix handling
*
* #GstAudioDownmixMeta defines an audio downmix matrix to be send along with
* audio buffers. These functions in this module help to create and attach the
* meta as well as extracting it.
*/
#include <string.h> #include <string.h>
#include "gstaudiometa.h" #include "gstaudiometa.h"
@ -103,7 +112,7 @@ gst_buffer_get_audio_downmix_meta_for_channels (GstBuffer * buffer,
* @to_channels: The number of channels of the destination * @to_channels: The number of channels of the destination
* @matrix: The matrix coefficients. * @matrix: The matrix coefficients.
* *
* Attaches GstAudioDownmixMeta metadata to @buffer with the given parameters. * Attaches #GstAudioDownmixMeta metadata to @buffer with the given parameters.
* *
* @matrix is an two-dimensional array of @to_channels times @from_channels * @matrix is an two-dimensional array of @to_channels times @from_channels
* coefficients, i.e. the i-th output channels is constructed by multiplicating * coefficients, i.e. the i-th output channels is constructed by multiplicating