From e6321ecb741e61af68393aa46677e045683263cb Mon Sep 17 00:00:00 2001
From: "Reynaldo H. Verdejo Pinochet" <r.verdejo@sisa.samsung.com>
Date: Fri, 27 Dec 2013 12:27:32 -0300
Subject: [PATCH] shout2send: docs, add a sample pipeline

And finish adding shout2send to the docs while at it

https://bugzilla.gnome.org/show_bug.cgi?id=721342
---
 docs/plugins/Makefile.am                         |  1 +
 docs/plugins/gst-plugins-good-plugins-docs.sgml  |  1 +
 .../gst-plugins-good-plugins-sections.txt        | 14 ++++++++++++++
 ext/shout2/gstshout2.c                           | 16 ++++++++++++++++
 4 files changed, 32 insertions(+)

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 379074c0dc..cf2750a7e6 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -69,6 +69,7 @@ EXTRA_HFILES = \
 	$(top_srcdir)/ext/libpng/gstpngenc.h \
 	$(top_srcdir)/ext/raw1394/gstdv1394src.h \
 	$(top_srcdir)/ext/raw1394/gsthdv1394src.h \
+	$(top_srcdir)/ext/shout2/gstshout2.h \
 	$(top_srcdir)/ext/soup/gstsouphttpsrc.h \
 	$(top_srcdir)/ext/taglib/gstapev2mux.h \
 	$(top_srcdir)/ext/taglib/gstid3v2mux.h \
diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index 148c6390a0..f4ac3217de 100644
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -152,6 +152,7 @@
     <xi:include href="xml/element-scaletempo.xml" />
     <xi:include href="xml/element-shagadelictv.xml" />
     <xi:include href="xml/element-shapewipe.xml" />
+    <xi:include href="xml/element-shout2send.xml" />
     <xi:include href="xml/element-smpte.xml" />
     <xi:include href="xml/element-smptealpha.xml" />
     <xi:include href="xml/element-souphttpsrc.xml" />
diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index 86ecacb56d..de8f4b8303 100644
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -1843,6 +1843,20 @@ GST_TYPE_SHAPE_WIPE
 gst_shape_wipe_get_type
 </SECTION>
 
+<SECTION>
+<FILE>element-shout2send</FILE>
+<TITLE>shout2send</TITLE>
+GstShout2send
+<SUBSECTION Standard>
+GstShout2sendClass
+GST_SHOUT2SEND
+GST_SHOUT2SEND_CLASS
+GST_IS_SHOUT2SEND
+GST_IS_SHOUT2SEND_CLASS
+GST_TYPE_SHOUT2SEND
+gst_shout2send_get_type
+</SECTION>
+
 <SECTION>
 <FILE>element-smpte</FILE>
 <TITLE>smpte</TITLE>
diff --git a/ext/shout2/gstshout2.c b/ext/shout2/gstshout2.c
index 045cfeb307..f58295f664 100644
--- a/ext/shout2/gstshout2.c
+++ b/ext/shout2/gstshout2.c
@@ -19,6 +19,22 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:element-shout2send
+ *
+ * shout2send pushes a media stream to an Icecast server
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch uridecodebin uri=file:///path/to/audiofile ! audioconvert ! vorbisenc ! oggmux ! shout2send mount=/stream.ogg port=8000 username=source password=somepassword ip=server_IP_address_or_hostname
+ * ]| This pipeline demuxes, decodes, re-encodes and re-muxes an audio
+ * media file into oggvorbis and sends the resulting stream to an Icecast
+ * server. Properties mount, port, username and password are all server-config
+ * dependent.
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif