README

Path: README
Last Update: Sat Jun 17 11:05:04 EEST 2006

Outcry

Outcry is a remotely controllable streamer for icecast.

At the moment it streams out mp3s and supports converting flacs and oggs to mp3 on the fly.

The remote control part is a web server that accepts and returns XML messages.

Requirements

Download

Installation

% rake package

% gem install pkg/outcry-x.y.gem

Usage

Run outcry:

% outcry -configfile /etc/outcry.yml

Replace /etc/outcry.yml with a suitable configuration file name. If Outcry can’t overwrite the file, it’ll output sensible default contents on standard output.

Next, you need to restart it. Press Ctrl-C to exit.

Next, edit the file configuration file

Then re-run outcry. It accepts a couple of arguments - run "outcry —help" for a listing.

The file shellfuncs.sh contains bash functions that make it easier to deal with Outcry if you don’t have any other frontend for it.

Messages

Set playlist

Method:post
Path:/control/setplaylist
Input format:<tracks> 
 <track>filename0</track>
 <track>filename1</track>
 ...
 <track>filenameN</track>

</tracks>

Returns:Nothing

Append to playlist

Method:post
Path:/control/append
Input format:See Set playlist
Retuns:Nothing

Insert to playlist

Method:post
Path:/control/insert
Input format:See Set playlist
Retuns:Nothing

Get playlist

Method:get
Path:/control/getplaylist
Input format:Nothing
Returns:<playlist> 
 <tracks>
  <track>filename0</track>
  <track>filename1</track>
  ...
  <track>filenameN</track>
 </tracks>
 <position>M</position>

</playlist>

M is a number between -1 (not playing) and N.

Jump to next

Method:post
Path:/control/next
Input format:Nothing
Returns:Nothing

Jump to previous

Method:post
Path:/control/previous
Input format:Nothing
Returns:Nothing

Jump to position

Method:post
Path:/control/position
Input format:<position>N</position>
Returns:Nothing

Author

Juri Pakaste <juri@iki.fi>

Copyright and license

Outcry is Copyright 2006 Juri Pakaste. It is licensed under a MIT-style license.

Copyright © 2006 Juri Pakaste

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

[Validate]