sys/oss/: Document OSS elements; add gtk-doc blurb with 'Since 0.10.5' for ossmixer's new device property.

Original commit message from CVS:
* sys/oss/gstossmixerelement.c: (gst_oss_mixer_element_class_init):
* sys/oss/gstosssink.c:
* sys/oss/gstosssrc.c:
Document OSS elements; add gtk-doc blurb with 'Since 0.10.5' for
ossmixer's new device property.
* docs/plugins/gst-plugins-good-plugins-docs.sgml:
* docs/plugins/gst-plugins-good-plugins-sections.txt:
Add docs for OSS elements.
* docs/plugins/inspect/plugin-aasink.xml:
* docs/plugins/inspect/plugin-alaw.xml:
* docs/plugins/inspect/plugin-alpha.xml:
* docs/plugins/inspect/plugin-alphacolor.xml:
* docs/plugins/inspect/plugin-annodex.xml:
* docs/plugins/inspect/plugin-apetag.xml:
* docs/plugins/inspect/plugin-auparse.xml:
* docs/plugins/inspect/plugin-autodetect.xml:
* docs/plugins/inspect/plugin-avi.xml:
* docs/plugins/inspect/plugin-cacasink.xml:
* docs/plugins/inspect/plugin-cairo.xml:
* docs/plugins/inspect/plugin-cdio.xml:
* docs/plugins/inspect/plugin-cutter.xml:
* docs/plugins/inspect/plugin-debug.xml:
* docs/plugins/inspect/plugin-dv.xml:
* docs/plugins/inspect/plugin-efence.xml:
* docs/plugins/inspect/plugin-effectv.xml:
* docs/plugins/inspect/plugin-esdsink.xml:
* docs/plugins/inspect/plugin-flac.xml:
* docs/plugins/inspect/plugin-flxdec.xml:
* docs/plugins/inspect/plugin-gconfelements.xml:
* docs/plugins/inspect/plugin-gdkpixbuf.xml:
* docs/plugins/inspect/plugin-goom.xml:
* docs/plugins/inspect/plugin-halelements.xml:
* docs/plugins/inspect/plugin-icydemux.xml:
* docs/plugins/inspect/plugin-id3demux.xml:
* docs/plugins/inspect/plugin-jpeg.xml:
* docs/plugins/inspect/plugin-level.xml:
* docs/plugins/inspect/plugin-matroska.xml:
* docs/plugins/inspect/plugin-mulaw.xml:
* docs/plugins/inspect/plugin-multipart.xml:
* docs/plugins/inspect/plugin-navigationtest.xml:
* docs/plugins/inspect/plugin-ossaudio.xml:
* docs/plugins/inspect/plugin-png.xml:
* docs/plugins/inspect/plugin-rtp.xml:
* docs/plugins/inspect/plugin-rtsp.xml:
* docs/plugins/inspect/plugin-shout2send.xml:
* docs/plugins/inspect/plugin-smpte.xml:
* docs/plugins/inspect/plugin-speex.xml:
* docs/plugins/inspect/plugin-taglib.xml:
* docs/plugins/inspect/plugin-udp.xml:
* docs/plugins/inspect/plugin-videobalance.xml:
* docs/plugins/inspect/plugin-videobox.xml:
* docs/plugins/inspect/plugin-videoflip.xml:
* docs/plugins/inspect/plugin-videomixer.xml:
* docs/plugins/inspect/plugin-wavenc.xml:
* docs/plugins/inspect/plugin-wavparse.xml:
* docs/plugins/inspect/plugin-ximagesrc.xml:
Update to CVS version.

3 files changed, 75 insertions, 0 deletions

diff --git a/sys/oss/gstossmixerelement.c b/sys/oss/gstossmixerelement.c
index 24e58763..34e6904f 100644
--- a/sys/oss/gstossmixerelement.c
+++ b/sys/oss/gstossmixerelement.c
@@ -17,6 +17,23 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-ossmixer
+ * @short_description: element to control sound input and output levels with OSS
+ *
+ * <refsect2>
+ * <para>
+ * This element lets you adjust sound input and output levels with the
+ * Open Sound System (OSS). It supports the GstMixer interface, which can be
+ * used to obtain a list of available mixer tracks. Set the mixer element to
+ * READY state before using the GstMixer interface on it.
+ * </para>
+ * <title>Example pipelines</title>
+ * <para>
+ * ossmixer can't be used in a sensible way in gst-launch.
+ * </para>
+ * </refsect2>
+ */
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"
@@ -78,6 +95,13 @@ gst_oss_mixer_element_class_init (GstOssMixerElementClass * klass)
   gobject_class->set_property = gst_oss_mixer_element_set_property;
   gobject_class->get_property = gst_oss_mixer_element_get_property;
 
+  /**
+   * GstOssMixerElement:device
+   *
+   * OSS mixer device (usually /dev/mixer)
+   *
+   * Since: 0.10.5
+   **/
   g_object_class_install_property (gobject_class, PROP_DEVICE,
       g_param_spec_string ("device", "Device",
           "OSS mixer device (usually /dev/mixer)", DEFAULT_DEVICE,
diff --git a/sys/oss/gstosssink.c b/sys/oss/gstosssink.c
index f2621071..9f2902a0 100644
--- a/sys/oss/gstosssink.c
+++ b/sys/oss/gstosssink.c
@@ -20,6 +20,37 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-osssink
+ * @short_description: output sound using OSS
+ *
+ * <refsect2>
+ * <para>
+ * This element lets you output sound using the Open Sound System (OSS).
+ * </para>
+ * <para>
+ * Note that you should almost always use generic audio conversion elements
+ * like audioconvert and audioresample in front of an audiosink to make sure
+ * your pipeline works under all circumstances (those conversion elements will
+ * act in passthrough-mode if no conversion is necessary).
+ * </para>
+ * <title>Example pipelines</title>
+ * <para>
+ * <programlisting>
+ * gst-launch -v audiotestsrc ! audioconvert ! volume volume=0.1 ! osssink
+ * </programlisting>
+ * will output a sine wave (continuous beep sound) to your sound card (with
+ * a very low volume as precaution).
+ * </para>
+ * <para>
+ * <programlisting>
+ * gst-launch -v filesrc location=music.ogg ! decodebin ! audioconvert ! audioresample ! osssink
+ * </programlisting>
+ * will play an Ogg/Vorbis audio file and output it using the Open Sound System.
+ * </para>
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/sys/oss/gstosssrc.c b/sys/oss/gstosssrc.c
index f740f91c..26eb6c6f 100644
--- a/sys/oss/gstosssrc.c
+++ b/sys/oss/gstosssrc.c
@@ -20,6 +20,26 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-osssrc
+ * @short_description: record sound from your sound card using OSS
+ *
+ * <refsect2>
+ * <para>
+ * This element lets you record sound using the Open Sound System (OSS).
+ * </para>
+ * <title>Example pipelines</title>
+ * <para>
+ * <programlisting>
+ * gst-launch -v osssrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=mymusic.ogg
+ * </programlisting>
+ * will record sound from your sound card using OSS and encode it to an
+ * Ogg/Vorbis file (this will only work if your mixer settings are right
+ * and the right inputs enabled etc.)
+ * </para>
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif