Mercurial > audlegacy-plugins
comparison README.icecast @ 2922:12588a9a458f
added some docs about Icecast plugin
author | Andrew O. Shadoura <bugzilla@tut.by> |
---|---|
date | Wed, 20 Aug 2008 02:46:53 +0300 |
parents | |
children | 2bcafe0a224e |
comparison
equal
deleted
inserted
replaced
2921:296fd6e83edb | 2922:12588a9a458f |
---|---|
1 Icecast plugin notes | |
2 -------------------- | |
3 | |
4 0. Build-time requirements | |
5 ========================== | |
6 | |
7 To build Icecast plugin successfully, you need at least: | |
8 | |
9 * Audacious development files (audacious-dev package) | |
10 | |
11 * Audacious plugins sources themselves | |
12 and all their build-time dependencies | |
13 | |
14 * libshout development files (libshout3-dev package) | |
15 | |
16 Please note that Icecast plugin must be compiled *after* FileWriter plugin, | |
17 as they share some pieces of code (namely, encoding backends and format | |
18 conversion routines). If you build all plugins, this is done automagically. | |
19 | |
20 | |
21 1. Run-time requirements | |
22 ======================== | |
23 | |
24 To run Icecast plugin, you need: | |
25 | |
26 * Icecast 2 server running somewhere, maybe at your local host, | |
27 to which you have "source" access | |
28 | |
29 * libshout version 2.0+ (libshout3 package) | |
30 | |
31 | |
32 2. Usage recommendations | |
33 ======================== | |
34 | |
35 The plugin is implemented as both output and effect. This means that you can | |
36 set it as the only Audacious output, if you don't need to hear anything, or | |
37 you can listen to music and send the same audio data to Icecast server. | |
38 | |
39 Please note that using plugin as effect is recommended. If you want to turn off | |
40 your speakers, just use Null audio output plugin. | |
41 | |
42 The next thing you need to do is to decide what kind of stream do you want. You | |
43 can use MPEG Layer 3 or Ogg Vorbis encoder. Currently supported are LAME and | |
44 vorbisenc. Depending on your system configuration you may or may not have LAME, | |
45 as it has patent problems with Fraunhofer IIS, and Debian doesn't provide | |
46 packages for it. | |
47 | |
48 If you are Debian user and want to use LAME anyway, refer to debian-multimedia | |
49 project. | |
50 | |
51 | |
52 3. Configuration | |
53 ================ | |
54 | |
55 First of all, you need to set up Icecast 2 properly. Note: previous versions of | |
56 Icecast as well as any versions of Shoutcast were not tested and are not | |
57 guaranteed to work at all. | |
58 | |
59 Usually, if you have single-user Icecast 2 setup, you should use user name | |
60 "source" and appropriate password. In either case, refer to Icecast 2 manual | |
61 for details. | |
62 | |
63 Mount point is a path on Icecast server, where your stream will be available. | |
64 I.e., if you have server at your local machine on default port, and mountpoint | |
65 is "/test", the whole URL of your stream would be | |
66 | |
67 http://127.1:8000/test | |
68 | |
69 If you don't specify mount point, mount point is set to "/". Don't do this. | |
70 | |
71 The connection timeout option is treated differently when plugin is in output | |
72 or effect mode. When being used as output plugin, this setting specifies the | |
73 time between last song ends (or "Stop" button click) and actual disconnect. | |
74 When being used as effect plugin, this setting specifies maximum time between | |
75 sequential portions of audio data sent to server. | |
76 | |
77 Plugin has internal buffer which collects audio data being sent to server. You | |
78 can fine tune size of this buffer. If buffer is too small, data will be sent | |
79 directly to the server bypassing this buffer. If buffer is too big, there can | |
80 be large pauses in audio data. | |
81 | |
82 You can set some information about your stream. First of all, you can provide | |
83 stream name, its description, music genre (or genres), URL of site where | |
84 listeners can read more about your radio. Also, you can ask server to list | |
85 the stream in any directories it knows about. Please refer to Icecast 2 | |
86 documentation for more details about this. | |
87 | |
88 -- Andrew O. Shadoura <bugzilla@tut.by> |