Overview
Context
Changes
Added help/action_homepage.page version [6aff0aa4e3].
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="homepage">
<info>
<link type="guide" xref="index#functions"/>
<desc>Start a web browser for a station.</desc>
<link type="guide" xref="streams#actions"/>
</info>
<title>Radio homepages</title>
<p>Most radio stations are listed with a homepage URL. Use the <gui>house</gui> symbol in the
toolbar or <guiseq><gui>right click</gui> <gui>homepage</gui></guiseq> to open it in a web browser.</p>
<p>Some homepage links are guessed, because for example Shoutcast doesn't list them anymore.
And if you play a station without homepage URL, it automatically gets googled (but will not
be displayed until you reselect the category.)
</p>
<section>
<title>Channel service</title>
<p>You can also open channel homepages. Either from the <gui>Channel</gui> menu, or via
double clicking the channel tab.</p>
</section>
</page>
|
| | | | | | | | | | | | | | | | | | | | | | | | | |
Added help/action_playing.page version [5d9920a793].
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="playing">
<info>
<link type="guide" xref="index#browsing"/>
<desc>Double click a station to start it in your audio player.</desc>
<link type="guide" xref="streams#actions"/>
</info>
<title>Playing</title>
<p>Simply double click a station to start it with your audio player.</p>
<p>In streamtuner2 you can configure different audio players for different audio
formats. In the 'Apps' section of the settings dialog, there is one application associated
with each audio file (MIME) type. Per default this is audacious, but you can certainly use
any other application.</p>
<note><p>Note however, that some audio players will start twice and won't
allow easy station switching. In these circumstance it might be sensible to write
a wrapper script, or configure special commandline arguments to your favoured audio
player.</p></note>
<p>It's also possible to save a station entry as .m3u or .pls file, and load this manually
in your player. You might even want to collect such .m3u files for archival / backup
purposes.</p>
</page>
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Added help/action_recording.page version [cde631e935].
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="recording">
<info>
<link type="guide" xref="streams#actions"/>
<link type="guide" xref="configuration#apps"/>
<link type="guide" xref="index#functions"/>
<desc>Save radio songs as MP3 files via streamripper.</desc>
</info>
<title>Recording</title>
<p>Most stations that stream MP3 or OGG music can be recorded. This is accomplished by
the commandline tool "streamripper". If you select a station a press the [record] button,
a console window should appear. Within that streamripper outputs its current activity.</p>
<p>Per default recorded streams are written into the current directory. Often this is your
home directory. And streamripper automatically creates a directory with the recorded
radio station title as name. Within that directory the individual music titles are split
into separate .mp3 files.</p>
<p>You can influence all these behaviours with -arguments to the streamripper program.
Please refer to the manpage of streamripper. The options are too various to list here.
You can set default arguments (e.g. another default save directory) in the 'Apps' section of
the streamtuner2 configuration dialog.</p>
</page>
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | |
Added help/action_saving.page version [5282d9d62b].
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="saving">
<info>
<link type="guide" xref="index#functions"/>
<link type="guide" xref="streams#actions"/>
<desc>Export a station entry as .m3u/.pls file.</desc>
</info>
<title>Saving</title>
<p>You can export the currently selected stream using <guiseq><gui>Station</gui> <gui>Save</gui></guiseq>. A file
dialog opens, where you can adapt the title. The extension of the filename decides on
the saved link format. Per default a .m3u file is created, because most audio players
understand this format.</p>
<p> But you can also save in .pls
or .xspf or .asx or .smil format. Note that the lower right dropdown
has no effect, you must edit the filename field.</p>
</page>
|
| | | | | | | | | | | | | | | | | | | | |
Added help/channel_bookmarks.page version [4ccec575d5].
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="bookmarks">
<info>
<link type="guide" xref="index#channels"/>
<link type="guide" xref="channels#list"/>
<link type="guide" xref="streams#actions"/>
<desc>Collect favourites via bookmark function, entry editing and deleting.</desc>
</info>
<title>Bookmarks</title>
<p>It's easy to lose the overview when you browse through the various channel tabs, genres
and internet radio stations. Therefore streamtuner2 allows to create bookmarks. This way
you can collect favoured streams in a single place.</p>
<p>Just right click a station you want to bookmark, and choose bookmark in the context
menu. Alternatively you can use the Streams entry in the application menu. Once bookmarked
you can see the station entry in the (!) "bookmarks" tab, under "favourite". That's where
they all go.</p>
<section id="editing">
<title>Editing</title>
<p>Entries can be removed from the bookmark list again. Use the edit menu for that.</p>
<p>Bookmarked stations are shown with a star in all other channel tabs. If you delete the
entry there, it won't remove it from the real bookmarks list.</p>
</section>
<section id="other">
<title>Subcategories</title>
<p>The bookmarks tab can display other categories besides "favourite". For example the
search feature creates a "search", while the "timer" and "links" plugins also display
lists here.</p>
</section>
</page>
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Added help/channel_internetradioorguk.page version [a86a3a05a6].
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="internet_radio_org_uk">
<info>
<link type="guide" xref="index#channels"/>
<link type="guide" xref="channels#list"/>
<link type="guide" xref="configuration#plugins"/>
<desc>Large radio directory from the UK.</desc>
</info>
<title>Internet-Radio.org.uk</title>
<p>I-R.org.uk is a good alternative to Shoutcast. It also lacks channel homepage in most
cases, but is a likewise encyclopedical directory. Genres are similiar to Shoutcast.</p>
<note><p>Note that this plugin uses its own setting for how many links to retrieve. Instead
of stream numbers, it only counts pages. This is a lazyness related bug.</p></note>
</page>
|
| | | | | | | | | | | | | | | | | | |
Added help/channel_jamendo.page version [8c3bbdc135].
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="jamendo">
<info>
<link type="guide" xref="index#channels"/>
<link type="guide" xref="channels#list"/>
<desc>Creative Commons music and artist hub.</desc>
</info>
<title>Jamendo</title>
<p>Jamendo is a Creative Comments licensing oriented music distributor. It hosts audio
files for individual musicians and artists. Tracks and albums can thus be downloaded
free of charge. Yeah, imagine that.</p>
<p>The streamtuner2 plugin for Jamendo is pretty limited at the moment. It just provides
a quick overview over top artists and most listened albums from each genre. To browse
the whole collections, better go to the Jamendo homepage or use Rhythmbox.</p>
</page>
|
| | | | | | | | | | | | | | | | | | | |
Added help/channel_myoggradio.page version [5b9350e4ba].
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="myoggradio">
<info>
<link type="guide" xref="index#channels"/>
<link type="guide" xref="channels#list"/>
<link type="guide" xref="configuration#plugins"/>
<desc>Open source stream directory.</desc>
</info>
<title>MyOggRadio</title>
<p><link href="http://ehm.homelinux.org/MyOggRadio/">MyOggRadio</link> is an open
source internet radio directory project. Since it provides its station list as
JSON it is very well supported.</p>
<p>Because the directory is currently still rather small, streamtuner2 provides the
option to share radion station links. Use the <guiseq><gui>Station</gui> <gui>Extensions</gui> <gui>Share...</gui></guiseq>
menu entry to upload the currently selected radio (from your favourite bookmarks).</p>
<p>The personal section is empty, unless you specify an user account in the settings
and actually bookmarks stations on the MyOggRadio web site. Shared entries are not
automatically in the MOR favorite list.</p>
<terms>
<title>Channel options.</title>
<item>
<title><code>Login settings</code></title>
<p>If you want to upload station infos to MyOggRadio, you need an account there. Registration
is free and doesn't require personal information nor email address. Specify username and
password separated with a : colon in this field.</p>
</item>
<item>
<title><code>stream URL format</code></title>
<p>When uploading stations, the streaming URL can be converted into RAW format. You
can however leave it as .PLS link file.</p>
</item>
</terms>
</page>
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Added help/channel_shoutcast.page version [1887fb607e].
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="shoutcast">
<info>
<link type="guide" xref="index#channels"/>
<link type="guide" xref="channels#list"/>
<link type="guide" xref="configuration#plugins"/>
<desc>One of the bigger radio station lists.</desc>
</info>
<title>Shoutcast</title>
<p>SHOUTcast is the name of a MP3 streaming server software. It automatically collects all
station lists on shoutcast.com.
</p>
<list>
<item><p>Station entries usually provide current playing information.</p></item>
<item><p>Stream links are plain PLS files.</p></item>
<item><p>Genres are subcategorized, so the main groups in the category
list must often be expanded to see the interesting entries.</p></item>
</list>
<terms>
<title>There are a few plugin options for this channel.</title>
<item>
<title><code>PyQuery parsing</code></title>
<p>Uses an XML parser to extract station data from within HTML <tags> of the shoutcast.com site. This is
slower, but often more reliable than regular expressions, which look for plain text markers.</p>
</item>
<item>
<title><code>debug output</code></title>
<p>Prints verbose messages to the console. This option is used while developing extensions for Streamtuner2.</p>
</item>
</terms>
</page>
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Added help/channel_xiph.page version [f4792784b2].
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="xiph">
<info>
<link type="guide" xref="index#channels"/>
<link type="guide" xref="channels#list"/>
<link type="guide" xref="configuration#plugins"/>
<desc>ICEcast radio directory.</desc>
</info>
<title>Xiph.org</title>
<p>Xiph.org is a non-profit organization, which develops and promotes the OGG audio format.
It also hosts a list of ICEcast streaming stations (ICEcast is the non-commercial pendant
to the SHOUTcast server.)</p>
<p>This channel is especially easy to read by Streamtuner2, because the source data is already
provided as <XML> file. However, it lacks some essential informaitons like station
homepages and listener numbers.</p>
<p>Xiph also uses the .xspf format, instead of .pls stream links</p>
<terms>
<title>Channel options.</title>
<item>
<title><code>Filter by minimum bitrate</code></title>
<p>The bitrate of an audio stream determines the music quality. Many Xiph streams have simple
and low quality microphone sources. To filter these out, and only leave high quality music
stations, you can therefore set this option. OGG starts to sound good with 128 kbit/s (whereas
MP3 often needs 192 at least).</p>
</item>
</terms>
</page>
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Added help/channels.page version [3889f26dc8].
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="channels">
<info>
<link type="guide" xref="index#browsing"/>
<desc>Switching through the channel tabs, different radio directoriy services.</desc>
</info>
<title>Channels</title>
<p>The tabs in the main window represent the music directory channels. Each lists
categories and streams from a specific radio directory.</p>
<media type="image" mime="image/png" src="img/channels.png">Tabs</media>
<p>If you first select a channel tab, the categories should appear or be loading.
Otherwise:</p>
<steps>
<item><p>Select a channel tab</p></item>
<item><p>Choose <guiseq><gui>Channel</gui> <gui>Reload categories...</gui></guiseq></p></item>
<item><p>Pick a category/genre from the overview, left.</p></item>
</steps>
<p>Individual channels provide different music/radio information. The table
views are however identical in each tab. You could modify the <code>datamap[]</code>
in the plugin files, if you want to adapt this.</p>
<section id="list">
<title>Available channels</title>
</section>
<section id="homepage">
<title>Channel service homepage</title>
<p>You can dobule click the channel tab to view the website of a directory services.
Alternatively there is an entry in the <gui>Channel</gui> menu.</p>
</section>
<section id="homepage">
<title>Channel menu options</title>
<terms>
<item>
<title>Homepage of directory service</title>
<p>Opens a webbrowser with the current channels website.</p>
</item>
<item>
<title>Reload</title>
<p>Updates the current category and displays fresh station lists.</p>
</item>
<item>
<title>Update favicons...</title>
<p>Starts assembling favicons for the current list of stations in the background.
To actually display the freshly loaded favicons, reselect the current category.</p>
</item>
<item>
<title>Reload category tree</title>
<p>Updates the genre list in the left category pane.
For most channels the category list is already complete, but it might
change over time. So this option often only is used for initializing streamtuner2
channels when the list is empty.</p>
</item>
</terms>
<p>The channel menu also contains a list of available channels. Select an entry to switch
into that tab.</p>
</section>
</page>
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Added help/cli.page version [82b8e7b014].
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="cli">
<info>
<link type="guide" xref="index#advanced"/>
<desc>Console interface, exporting data.</desc>
</info>
<title>CLI (command line interface)</title>
<p>Streamtuner2 is a graphical tool. But it also has a limited commandline interface,
which can be used to query station information. This is useful for interfacing with
other applications.</p>
<p>Open a terminal and call <code>streamtuner2 help</code> to get an overview over
available commands.</p>
<terms>
<title>Examples</title>
<item>
<title><code>streamtuner2 play "station"</code></title>
<p>This command looks through all channel plugins, and finds a station containing the
mentioned title. In the shell you must put the station title in quotes, if it contains
e.g. spaces. You can optionally specify a channelname before the station title.</p>
</item>
<item>
<title><code>streamtuner2 url [channel] "station"</code></title>
<p>Just looks up the streaming URL for a given station. If no channel name is given,
ST2 searches through all available channel plugins again.</p>
</item>
<item>
<title><code>streamtuner2 stream shoutcast "station"</code></title>
<p>Prints available station data as JSON</p>
</item>
<item>
<title><code>streamtuner2 category internet_radio_org_uk "Pop"</code></title>
<p>Loads fresh data from the specified channel service, and prints out JSON data for
the whole category. Note that the category name must have the excact case.</p>
</item>
<item>
<title><code>streamtuner2 categories channel</code></title>
<p>Fetches the current list of available categories/genres for a channel service.</p>
</item>
</terms>
<p>Specifying a channel name is often optional. If you add one, it should be all-lowercase.
You can also give a list, like "shoutcast,xiph" which would be searched then.</p>
</page>
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Added help/config_apps.page version [c1d5b4e9e9].
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="config_apps">
<info>
<link type="guide" xref="configuration#apps"/>
<desc>Common applications to use as players.</desc>
</info>
<title>Audio players</title>
<p>On BSD/Linux systems there are a plethora of audio players. In streamtuner2 you can
configure most of them as target application. Mostly it makes sense to use a single
application for all audio formats. But at least the */* media type should be handled
by a generic player, like vlc.</p>
<table shade="rows" rules="rows cols">
<tr><td>Audacious</td><td>audacious %m3u</td><td>audio</td></tr>
<tr><td>XMMS2</td><td>xmms2 %m3u</td><td>audio</td></tr>
<tr><td>Amarok</td><td>amarok -l %pls</td><td>audio</td></tr>
<tr><td>Exaile</td><td>exaile %m3u</td><td>audio</td></tr>
<tr><td>Amarok</td><td>amarok -l %pls</td><td>audio</td></tr>
<tr><td>mplayer</td><td>mplayer %srv</td><td>console</td></tr>
<tr><td>VLC</td><td>vlc %u</td><td>video/*</td></tr>
<tr><td>Totem</td><td>totem %u</td><td>video/*</td></tr>
<tr><td>Media Player</td><td>mplayer2.exe %pls</td><td>Win32</td></tr>
</table>
<p>Some audio players open a second instance when you actually want to switch radios.
In this case it's a common workaround to write <code>pkill vlc ; vlc %u</code> instead.
This ends the previous player and starts it anew.</p>
<p>Some applications, like Rhythmbox or Banshee, are pure GUI applications and cannot
be invoked with a play URL by other apps. This makes them unsuitable for use with
streamtuner2.</p>
<section id="abbr">
<title>URL placeholders</title>
<p>Any listed application can be invoked with a different kind of URL or filename.be invoked with a play URL by other apps.
Which to use often depends on the application.</p>
<table shade="rows" rules="rows cols">
<tr><td>Placeholder</td><td>Alternatives</td><td>URL/Filename type</td></tr>
<tr><td>%m3u</td><td>%f %g %m</td><td>Provides a local .m3u file for the streaming station</td></tr>
<tr><td>%pls</td><td>%url %u %r</td><td>Either a remote .pls resource, or a local .pls file (if converted)</td></tr>
<tr><td>%srv</td><td>%d %s</td><td>Direct link to first streaming address, e.g. http://72.5.9.33:7500</td></tr>
</table>
<p>You sould preferrably use the long forms. Most audio players like %m3u most, while
streamripper needs %srv for recording.</p>
</section>
</page>
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Added help/configuration.page version [f270174d2c].