<h1>The shout command</h1>

<hr>

<h2>Synopsis</h2>

<b>shout</b> ?<i>options</i>? <i>host</i> <i>port</i> <i>password</i>

<hr>

<h2>Description</h2>

The <b>shout</b> command opens a network socket to an icecast or shoutcast audio streaming server. The command returns a channel identifier that may be used in future invocations of commands like <b>puts</b> and <b>flush</b>.

The library takes care of stream synchronization. If data is provided too quickly, a <b>puts</b> or <b>flush</b> command will block as required. To avoid blocking, an application may make use of the <i>writable</i> fileevent. That event fires whenever the stream is ready to handle more data.

The following options may also be present before <u>host</u> to specify additional information about the connection:

<h2>Command Options</h2>
<dl>
<dt><b>-bitrate</b> <i>rate</i>
<dd>Specify the nominal bitrate of the stream
<dt><b>-channels</b> <i>num</i>
<dd>Specify the number of channels (usually one or two).
<dt><b>-description</b> <i>text</i>
<dd>Sets the description of this stream.
<dt><b>-format</b> <i>format</i>
<dd>Sets the audio format of this stream. The currently supported formats are: <b>ogg</b> (default) and <b>mp3</b>.
<dt><b>-genre</b> <i>list</i>
<dd>Sets the genre (or genres) of the stream. This is usually a keyword list, eg "pop rock rap".
<dt><b>-mount</b> <i>path</i>
<dd>Sets the mount point for this stream, for protocols that support this option.
<dt><b>-name</b> <i>text</i>
<dd>Sets the name of the stream.
<dt><b>-protocol</b> <i>protocol</i>
<dd>Set the protocol with which to connect to the server. Supported protocols are: <b>http</b> (default), <b>audiocast</b>, and <b>shoutcast</b>.
<dt><b>-public</b> <i>boolean</i>
<dd>Setting this to 1 asks the server to list the stream in any directories it knows about. To suppress listing, set this to 0. The default is 0.
<dt><b>-quality</b> <i>level</i>
<dd>Specify the Ogg Vorbis encoding quality of the stream.
<dt><b>-samplerate</b> <i>rate</i>
<dd>Specify the samplerate of the stream.
<dt><b>-url</b> <i>url</i>
<dd>Sets the URL of a site about this stream.
<dt><b>-user</b> <i>user</i>
<dd>Sets the user to authenticate as, for protocols that can use this parameter. The default is source.
</dl>

<h2>Configuration Options</h2>
The <b>chan configure</b> command can be used to modify the stream's metadata at any time during the lifetime of the connection.
<dl>
<dt><b>-song</b> <i>text</i>
<dd>Sets the song information for the stream. Only MP3 streams support this type of metadata update.
</dl>