icecast-stack

node-icecast-stack
==================

$3

This module offers an interface for retrieving the raw audio data and
parsing the metadata from a [SHOUTcast][] or [Icecast][] broadcast. Two API's
are offered: a low-level [StreamStack][] read and write interface (which
requires you to establish the connection to the net.Stream yourself), and a
more convenient high-level
ReadStream interface (which
creates a net.Stream connection, and uses the StreamStack interfaces
transparently).

Usage
-----

Here's a basic example of just piping the clean audio data to _stdout_,
while printing the HTTP response headers and metadata events to _stderr_:

`` javascript
var icecast = require('icecast-stack');

var url = 'http://67.205.85.183:5500'; // URL to a known Icecast stream
var stream = icecast.createReadStream(url);

// Fired when the net.Stream has it's 'connect' event.
stream.on('connect', function() {
console.error("Radio Stream connected!");
});

// Fired after the HTTP response headers have been received.
stream.on('response', function(res) {
console.error("Radio Stream response!");
console.error(res.headers);
});

// When a 'metadata' event happens, usually a new song is starting.
stream.on('metadata', function(metadata) {
var title = icecast.parseMetadata(metadata).StreamTitle;
console.error(title);
});

// Proxy the raw audio stream to 'stdout', redirect to a file!
stream.pipe(process.stdout);
`

Look in the examples directory for code of some more complex use-cases.

The most important use case of this is for HTML5 web apps that listen to
radio streams; the


Installation
------------

Installation through __npm__ is the most
straight-forward way to install the node-icecast-stack module:

` bash
$ npm install icecast-stack
`

Or just checking out this _git_ repo works as well:

` bash
$ git clone git://github.com/TooTallNate/node-icecast-stack.git
``

[NodeJS]: http://nodejs.org
[StreamStack]: http://github.com/TooTallNate/node-stream-stack
[SHOUTcast]: http://www.shoutcast.com
[Icecast]: http://icecast.org