docs/libs/: Add docs for libgstcdda/GstCddaBaseSrc.
authorTim-Philipp Müller <tim@centricular.net>
Wed, 28 Dec 2005 18:19:25 +0000 (18:19 +0000)
committerTim-Philipp Müller <tim@centricular.net>
Wed, 28 Dec 2005 18:19:25 +0000 (18:19 +0000)
Original commit message from CVS:
* docs/libs/Makefile.am:
* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* docs/libs/gst-plugins-base-libs.types:
Add docs for libgstcdda/GstCddaBaseSrc.
* gst-libs/gst/interfaces/mixertrack.h:
Do one struct member per line with a semicolon at the end, that way
even gtk-doc might parse it without complaining.

ChangeLog
docs/libs/Makefile.am
docs/libs/gst-plugins-base-libs-docs.sgml
docs/libs/gst-plugins-base-libs-sections.txt
docs/libs/gst-plugins-base-libs.types
gst-libs/gst/interfaces/mixertrack.h

index 345a97a..b1add0f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,17 @@
 2005-12-28  Tim-Philipp Müller  <tim at centricular dot net>
 
+       * docs/libs/Makefile.am:
+       * docs/libs/gst-plugins-base-libs-docs.sgml:
+       * docs/libs/gst-plugins-base-libs-sections.txt:
+       * docs/libs/gst-plugins-base-libs.types:
+         Add docs for libgstcdda/GstCddaBaseSrc.
+
+       * gst-libs/gst/interfaces/mixertrack.h:
+         Do one struct member per line with a semicolon at the end, that way
+         even gtk-doc might parse it without complaining.
+
+2005-12-28  Tim-Philipp Müller  <tim at centricular dot net>
+
        * configure.ac:
        * gst-libs/gst/Makefile.am:
        * gst-libs/gst/cdda/Makefile.am:
index 7d7530c..6c64e59 100644 (file)
@@ -64,7 +64,8 @@ CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.c
 
 SCANOBJ_DEPS = \
        $(top_builddir)/gst-libs/gst/interfaces/libgstinterfaces-@GST_MAJORMINOR@.la \
-       $(top_builddir)/gst-libs/gst/audio/libgstaudio-@GST_MAJORMINOR@.la
+       $(top_builddir)/gst-libs/gst/audio/libgstaudio-@GST_MAJORMINOR@.la \
+       $(top_builddir)/gst-libs/gst/cdda/libgstcdda-@GST_MAJORMINOR@.la
 
 # Header files to ignore when scanning.
 IGNORE_HFILES = 
index 05edf77..2ba2f8c 100644 (file)
@@ -6,6 +6,7 @@
 
 <!ENTITY GstCompiling SYSTEM "compiling.sgml">
 <!ENTITY GstAudio SYSTEM "xml/gstaudio.xml">
+<!ENTITY GstCddaBaseSrc SYSTEM "xml/gstcddabasesrc.xml">
 <!ENTITY GstVideoSink SYSTEM "xml/gstvideosink.xml">
 <!ENTITY GstVideoFilter SYSTEM "xml/gstvideofilter.xml">
 <!ENTITY GstColorBalance SYSTEM "xml/gstcolorbalance.xml">
@@ -65,6 +66,17 @@ This library should be linked to by getting cflags and libs from
     &GstXOverlay;
   </chapter>
 
+  <chapter id="gstreamer-cdda">
+    <title>CDDA Library</title>
+    <para>
+This library should be linked to by getting cflags and libs from
+<filename>gstreamer-plugins-base.pc</filename> and adding
+<filename>-lgstcdda-&GST_MAJORMINOR;</filename> to the library flags.
+    </para>
+    &GstCddaBaseSrc;
+  </chapter>
+
+
   <chapter id="gstreamer-gconf">
     <title>GConf Library</title>
     <para>
index e789882..888e85c 100644 (file)
@@ -10,6 +10,19 @@ gst_audio_structure_set_int
 </SECTION>
 
 <SECTION>
+<FILE>gstcddabasesrc</FILE>
+<INCLUDE>gst/cdda/gstcddabasesrc.h</INCLUDE>
+GstCddaBaseSrc
+GstCddaBaseSrcTrack
+GstCddaBaseSrcMode
+gst_cdda_base_src_add_track
+GST_TAG_CDDA_CDDB_DISCID
+GST_TAG_CDDA_CDDB_DISCID_FULL
+GST_TAG_CDDA_MUSICBRAINZ_DISCID
+GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL
+</SECTION>
+
+<SECTION>
 <FILE>gstcolorbalance</FILE>
 <INCLUDE>gst/interfaces/colorbalance.h</INCLUDE>
 GstColorBalance
@@ -130,3 +143,9 @@ GstVideoFilterClass
 </SECTION>
 
 
+<SECTION>
+<FILE>private</FILE>
+sha_init
+sha_final
+sha_update
+</SECTION>
index 630a0be..a04977d 100644 (file)
@@ -7,3 +7,6 @@ gst_ring_buffer_get_type
 
 gst_color_balance_get_type
 gst_color_balance_channel_get_type
+
+#include <gst/cdda/gstcddabasesrc.h>
+gst_cdda_base_src_get_type
index 49ff96d..bd88eec 100644 (file)
@@ -76,9 +76,9 @@ struct _GstMixerTrack {
   gchar             *label;
   /* FIXME: flags should be guint32. Change in 0.9 */
   GstMixerTrackFlags flags;
-  gint               num_channels,
-                     min_volume,
-                     max_volume;
+  gint               num_channels;
+  gint               min_volume;
+  gint               max_volume;
 };
 
 struct _GstMixerTrackClass {