1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>shout2send: GStreamer Good Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-good Elements"> 9<link rel="prev" href="gst-plugins-good-plugins-shapewipe.html" title="shapewipe"> 10<link rel="next" href="gst-plugins-good-plugins-smptealpha.html" title="smptealpha"> 11<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> 12<link rel="stylesheet" href="style.css" type="text/css"> 13</head> 14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-good-plugins-shout2send.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-good-plugins-shout2send.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gst-plugins-good-plugins-shout2send.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gst-plugins-good-plugins-shout2send.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> 22 <a href="#gst-plugins-good-plugins-shout2send.signals" class="shortcut">Signals</a></span> 23</td> 24<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 25<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 26<td><a accesskey="p" href="gst-plugins-good-plugins-shapewipe.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 27<td><a accesskey="n" href="gst-plugins-good-plugins-smptealpha.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 28</tr></table> 29<div class="refentry"> 30<a name="gst-plugins-good-plugins-shout2send"></a><div class="titlepage"></div> 31<div class="refnamediv"><table width="100%"><tr> 32<td valign="top"> 33<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-shout2send.top_of_page"></a>shout2send</span></h2> 34<p>shout2send</p> 35</td> 36<td class="gallery_image" valign="top" align="right"></td> 37</tr></table></div> 38<div class="refsect1"> 39<a name="gst-plugins-good-plugins-shout2send.properties"></a><h2>Properties</h2> 40<div class="informaltable"><table class="informaltable" border="0"> 41<colgroup> 42<col width="150px" class="properties_type"> 43<col width="300px" class="properties_name"> 44<col width="200px" class="properties_flags"> 45</colgroup> 46<tbody> 47<tr> 48<td class="property_type"> 49<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 50<td class="property_name"><a class="link" href="gst-plugins-good-plugins-shout2send.html#GstShout2send--description" title="The “description” property">description</a></td> 51<td class="property_flags">Read / Write</td> 52</tr> 53<tr> 54<td class="property_type"> 55<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 56<td class="property_name"><a class="link" href="gst-plugins-good-plugins-shout2send.html#GstShout2send--genre" title="The “genre” property">genre</a></td> 57<td class="property_flags">Read / Write</td> 58</tr> 59<tr> 60<td class="property_type"> 61<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 62<td class="property_name"><a class="link" href="gst-plugins-good-plugins-shout2send.html#GstShout2send--ip" title="The “ip” property">ip</a></td> 63<td class="property_flags">Read / Write</td> 64</tr> 65<tr> 66<td class="property_type"> 67<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 68<td class="property_name"><a class="link" href="gst-plugins-good-plugins-shout2send.html#GstShout2send--mount" title="The “mount” property">mount</a></td> 69<td class="property_flags">Read / Write</td> 70</tr> 71<tr> 72<td class="property_type"> 73<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 74<td class="property_name"><a class="link" href="gst-plugins-good-plugins-shout2send.html#GstShout2send--password" title="The “password” property">password</a></td> 75<td class="property_flags">Read / Write</td> 76</tr> 77<tr> 78<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 79<td class="property_name"><a class="link" href="gst-plugins-good-plugins-shout2send.html#GstShout2send--port" title="The “port” property">port</a></td> 80<td class="property_flags">Read / Write</td> 81</tr> 82<tr> 83<td class="property_type"><span class="type">GstShout2SendProtocol</span></td> 84<td class="property_name"><a class="link" href="gst-plugins-good-plugins-shout2send.html#GstShout2send--protocol" title="The “protocol” property">protocol</a></td> 85<td class="property_flags">Read / Write</td> 86</tr> 87<tr> 88<td class="property_type"> 89<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 90<td class="property_name"><a class="link" href="gst-plugins-good-plugins-shout2send.html#GstShout2send--streamname" title="The “streamname” property">streamname</a></td> 91<td class="property_flags">Read / Write</td> 92</tr> 93<tr> 94<td class="property_type"> 95<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 96<td class="property_name"><a class="link" href="gst-plugins-good-plugins-shout2send.html#GstShout2send--url" title="The “url” property">url</a></td> 97<td class="property_flags">Read / Write</td> 98</tr> 99<tr> 100<td class="property_type"> 101<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 102<td class="property_name"><a class="link" href="gst-plugins-good-plugins-shout2send.html#GstShout2send--username" title="The “username” property">username</a></td> 103<td class="property_flags">Read / Write</td> 104</tr> 105<tr> 106<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 107<td class="property_name"><a class="link" href="gst-plugins-good-plugins-shout2send.html#GstShout2send--public" title="The “public” property">public</a></td> 108<td class="property_flags">Read / Write</td> 109</tr> 110<tr> 111<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 112<td class="property_name"><a class="link" href="gst-plugins-good-plugins-shout2send.html#GstShout2send--timeout" title="The “timeout” property">timeout</a></td> 113<td class="property_flags">Read / Write</td> 114</tr> 115</tbody> 116</table></div> 117</div> 118<div class="refsect1"> 119<a name="gst-plugins-good-plugins-shout2send.signals"></a><h2>Signals</h2> 120<div class="informaltable"><table class="informaltable" border="0"> 121<colgroup> 122<col width="150px" class="signals_return"> 123<col width="300px" class="signals_name"> 124<col width="200px" class="signals_flags"> 125</colgroup> 126<tbody><tr> 127<td class="signal_type"><span class="returnvalue">void</span></td> 128<td class="signal_name"><a class="link" href="gst-plugins-good-plugins-shout2send.html#GstShout2send-connection-problem" title="The “connection-problem” signal">connection-problem</a></td> 129<td class="signal_flags">Cleanup</td> 130</tr></tbody> 131</table></div> 132</div> 133<a name="GstShout2send"></a><div class="refsect1"> 134<a name="gst-plugins-good-plugins-shout2send.other"></a><h2>Types and Values</h2> 135<div class="informaltable"><table class="informaltable" width="100%" border="0"> 136<colgroup> 137<col width="150px" class="name"> 138<col class="description"> 139</colgroup> 140<tbody><tr> 141<td class="datatype_keyword">struct</td> 142<td class="function_name"><a class="link" href="gst-plugins-good-plugins-shout2send.html#GstShout2send-struct" title="struct GstShout2send">GstShout2send</a></td> 143</tr></tbody> 144</table></div> 145</div> 146<div class="refsect1"> 147<a name="gst-plugins-good-plugins-shout2send.object-hierarchy"></a><h2>Object Hierarchy</h2> 148<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 149 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 150 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 151 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 152 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseSink.html#GstBaseSink-struct">GstBaseSink</a> 153 <span class="lineart">╰──</span> GstShout2send 154</pre> 155</div> 156<div class="refsect1"> 157<a name="gst-plugins-good-plugins-shout2send.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 158<p> 159GstShout2send implements 160 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstTagSetter.html#GstTagSetter-struct">GstTagSetter</a>.</p> 161</div> 162<div class="refsect1"> 163<a name="gst-plugins-good-plugins-shout2send.description"></a><h2>Description</h2> 164<p>shout2send pushes a media stream to an Icecast server</p> 165<div class="refsect2"> 166<a name="id-1.2.243.9.3"></a><h3>Example launch line</h3> 167<div class="informalexample"> 168 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 169 <tbody> 170 <tr> 171 <td class="listing_lines" align="right"><pre>1</pre></td> 172 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> uridecodebin uri<span class="gtkdoc opt">=</span>file<span class="gtkdoc opt">:</span><span class="gtkdoc slc">///path/to/audiofile ! audioconvert ! vorbisenc ! oggmux ! shout2send mount=/stream.ogg port=8000 username=source password=somepassword ip=server_IP_address_or_hostname</span></pre></td> 173 </tr> 174 </tbody> 175 </table> 176</div> 177 This pipeline demuxes, decodes, re-encodes and re-muxes an audio 178media file into oggvorbis and sends the resulting stream to an Icecast 179server. Properties mount, port, username and password are all server-config 180dependent. 181</div> 182<div class="refsynopsisdiv"> 183<h2>Synopsis</h2> 184<div class="refsect2"> 185<a name="id-1.2.243.9.4.1"></a><h3>Element Information</h3> 186<div class="variablelist"><table border="0" class="variablelist"> 187<colgroup> 188<col align="left" valign="top"> 189<col> 190</colgroup> 191<tbody> 192<tr> 193<td><p><span class="term">plugin</span></p></td> 194<td> 195 <a class="link" href="gst-plugins-good-plugins-plugin-shout2.html#plugin-shout2">shout2</a> 196 </td> 197</tr> 198<tr> 199<td><p><span class="term">author</span></p></td> 200<td>Wim Taymans <wim.taymans@chello.be>, Pedro Corte-Real <typo@netcabo.pt>, Zaheer Abbas Merali <zaheerabbas at merali dot org></td> 201</tr> 202<tr> 203<td><p><span class="term">class</span></p></td> 204<td>Sink/Network</td> 205</tr> 206</tbody> 207</table></div> 208</div> 209<hr> 210<div class="refsect2"> 211<a name="id-1.2.243.9.4.2"></a><h3>Element Pads</h3> 212<div class="variablelist"><table border="0" class="variablelist"> 213<colgroup> 214<col align="left" valign="top"> 215<col> 216</colgroup> 217<tbody> 218<tr> 219<td><p><span class="term">name</span></p></td> 220<td>sink</td> 221</tr> 222<tr> 223<td><p><span class="term">direction</span></p></td> 224<td>sink</td> 225</tr> 226<tr> 227<td><p><span class="term">presence</span></p></td> 228<td>always</td> 229</tr> 230<tr> 231<td><p><span class="term">details</span></p></td> 232<td>application/ogg</td> 233</tr> 234<tr> 235<td><p><span class="term"></span></p></td> 236<td> audio/ogg</td> 237</tr> 238<tr> 239<td><p><span class="term"></span></p></td> 240<td> video/ogg</td> 241</tr> 242<tr> 243<td><p><span class="term"></span></p></td> 244<td> audio/mpeg, mpegversion=(int)1, layer=(int)[ 1, 3 ]</td> 245</tr> 246<tr> 247<td><p><span class="term"></span></p></td> 248<td> video/webm</td> 249</tr> 250<tr> 251<td><p><span class="term"></span></p></td> 252<td> audio/webm</td> 253</tr> 254</tbody> 255</table></div> 256</div> 257</div> 258</div> 259<div class="refsect1"> 260<a name="gst-plugins-good-plugins-shout2send.functions_details"></a><h2>Functions</h2> 261<p></p> 262</div> 263<div class="refsect1"> 264<a name="gst-plugins-good-plugins-shout2send.other_details"></a><h2>Types and Values</h2> 265<div class="refsect2"> 266<a name="GstShout2send-struct"></a><h3>struct GstShout2send</h3> 267<pre class="programlisting">struct GstShout2send;</pre> 268</div> 269</div> 270<div class="refsect1"> 271<a name="gst-plugins-good-plugins-shout2send.property-details"></a><h2>Property Details</h2> 272<div class="refsect2"> 273<a name="GstShout2send--description"></a><h3>The <code class="literal">“description”</code> property</h3> 274<pre class="programlisting"> “description” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 275<p>description.</p> 276<p>Flags: Read / Write</p> 277<p>Default value: ""</p> 278</div> 279<hr> 280<div class="refsect2"> 281<a name="GstShout2send--genre"></a><h3>The <code class="literal">“genre”</code> property</h3> 282<pre class="programlisting"> “genre” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 283<p>genre.</p> 284<p>Flags: Read / Write</p> 285<p>Default value: ""</p> 286</div> 287<hr> 288<div class="refsect2"> 289<a name="GstShout2send--ip"></a><h3>The <code class="literal">“ip”</code> property</h3> 290<pre class="programlisting"> “ip” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 291<p>IP address or hostname.</p> 292<p>Flags: Read / Write</p> 293<p>Default value: "127.0.0.1"</p> 294</div> 295<hr> 296<div class="refsect2"> 297<a name="GstShout2send--mount"></a><h3>The <code class="literal">“mount”</code> property</h3> 298<pre class="programlisting"> “mount” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 299<p>mount.</p> 300<p>Flags: Read / Write</p> 301<p>Default value: ""</p> 302</div> 303<hr> 304<div class="refsect2"> 305<a name="GstShout2send--password"></a><h3>The <code class="literal">“password”</code> property</h3> 306<pre class="programlisting"> “password” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 307<p>password.</p> 308<p>Flags: Read / Write</p> 309<p>Default value: "hackme"</p> 310</div> 311<hr> 312<div class="refsect2"> 313<a name="GstShout2send--port"></a><h3>The <code class="literal">“port”</code> property</h3> 314<pre class="programlisting"> “port” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 315<p>port.</p> 316<p>Flags: Read / Write</p> 317<p>Allowed values: [1,65535]</p> 318<p>Default value: 8000</p> 319</div> 320<hr> 321<div class="refsect2"> 322<a name="GstShout2send--protocol"></a><h3>The <code class="literal">“protocol”</code> property</h3> 323<pre class="programlisting"> “protocol” <span class="type">GstShout2SendProtocol</span></pre> 324<p>Connection Protocol to use.</p> 325<p>Flags: Read / Write</p> 326<p>Default value: Http Protocol (icecast 2.x)</p> 327</div> 328<hr> 329<div class="refsect2"> 330<a name="GstShout2send--streamname"></a><h3>The <code class="literal">“streamname”</code> property</h3> 331<pre class="programlisting"> “streamname” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 332<p>name of the stream.</p> 333<p>Flags: Read / Write</p> 334<p>Default value: ""</p> 335</div> 336<hr> 337<div class="refsect2"> 338<a name="GstShout2send--url"></a><h3>The <code class="literal">“url”</code> property</h3> 339<pre class="programlisting"> “url” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 340<p>the stream's homepage URL.</p> 341<p>Flags: Read / Write</p> 342<p>Default value: ""</p> 343</div> 344<hr> 345<div class="refsect2"> 346<a name="GstShout2send--username"></a><h3>The <code class="literal">“username”</code> property</h3> 347<pre class="programlisting"> “username” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 348<p>username.</p> 349<p>Flags: Read / Write</p> 350<p>Default value: "source"</p> 351</div> 352<hr> 353<div class="refsect2"> 354<a name="GstShout2send--public"></a><h3>The <code class="literal">“public”</code> property</h3> 355<pre class="programlisting"> “public” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 356<p>If the stream should be listed on the server's stream directory.</p> 357<p>Flags: Read / Write</p> 358<p>Default value: FALSE</p> 359</div> 360<hr> 361<div class="refsect2"> 362<a name="GstShout2send--timeout"></a><h3>The <code class="literal">“timeout”</code> property</h3> 363<pre class="programlisting"> “timeout” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 364<p>Max amount of time to wait for network activity, in milliseconds.</p> 365<p>Flags: Read / Write</p> 366<p>Allowed values: >= 1</p> 367<p>Default value: 10000</p> 368</div> 369</div> 370<div class="refsect1"> 371<a name="gst-plugins-good-plugins-shout2send.signal-details"></a><h2>Signal Details</h2> 372<div class="refsect2"> 373<a name="GstShout2send-connection-problem"></a><h3>The <code class="literal">“connection-problem”</code> signal</h3> 374<pre class="programlisting"><span class="returnvalue">void</span> 375user_function (<a class="link" href="gst-plugins-good-plugins-shout2send.html#GstShout2send"><span class="type">GstShout2send</span></a> *gstshout2send, 376 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> arg1, 377 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> 378<p>Flags: Cleanup</p> 379</div> 380</div> 381</div> 382<div class="footer"> 383<hr>Generated by GTK-Doc V1.28</div> 384</body> 385</html>
