Index: help/action_recording.page ================================================================== --- help/action_recording.page +++ help/action_recording.page @@ -10,11 +10,11 @@ Recording

Most stations that stream MP3 or OGG music can be recorded. This is accomplished through -the commandline tool "streamripper". If you select a station a press the [record] button, +the command-line tool "streamripper". If you select a station and press ● record, a console window should appear, where streamripper shows its progress.

Streamripper @@ -26,12 +26,12 @@

Format

Application

audio/*

xterm -e streamripper %srv

To configure a default download directory, use the -d option to streamripper. -For example xterm -e "streamripper -d /media/music/" would use an absolute path -instead of your home directory (or the current working directory).

+For example xterm -e "streamripper -d /media/music/" would use an absolute path. +Else it downloads to the current working directory (often your HOME path).

fIcy/fPls @@ -49,7 +49,19 @@

The recording settings have a specific entry for "video/youtube" URLs. To configure a specific download directory, use xterm -e "cd /media/music ; youtube-dl %srv" for example. (The cd trick works with streamripper too.)

+ +
+Wget for MOD files + +

To download audio files from The MOD Archive directly, you can define a +few custom handlers. Scroll/click on the empty row in the recording apps +table. There create a new recording MIME type audio/mod+zip with +a command like xterm -e wget %srv. Copy it alike for +audio/it+zip and audio/xm+zip to cover the most common +file types. Using curl would also work of course.

+
+ Index: help/channels.page ================================================================== --- help/channels.page +++ help/channels.page @@ -8,15 +8,17 @@ Channels

The tabs in the main window represent the music directory - channels/services. Each lists categories and streams from a - specific radio directory/website.

+ channels/services. Each lists categories/genres and their associated radios/streams.

Tabs +

The notebook tabs can also be repositioned with + Edit Channel tab position Left.

+

If you first select a channel tab, the categories should appear or be loading. Otherwise:

Select a channel tab

 @@ -23,12 +25,12 @@

Choose Channel Reload categories...

Pick a category/genre from the overview, left.

Individual channels provide different music/radio information. The table - views are mostly identical in each tab. (You could modify the datamap[] - in the plugin files if you wanted to adapt this.)

+ views are mostly identical in each tab. Some views may rename columns, or remove + them alltogether.

Available channels
Index: help/config_apps.page ================================================================== --- help/config_apps.page +++ help/config_apps.page @@ -20,12 +20,12 @@

XMMS2

xmms2 %m3u

audio

Amarok

amarok -l %pls

audio

Exaile

exaile %m3u

audio

Amarok

amarok -l %pls

audio

mplayer

mplayer %srv

console

-

VLC

vlc %u

video/*

-

Totem

totem %u

video/*

+

VLC

vlc %u

video

+

Totem

totem %u

video

Media Player

mplayer2.exe %pls

Win32

Some audio players open a second instance when you actually want to switch radios. In this case it's a common workaround to write pkill vlc ; vlc %u instead, @@ -35,11 +35,11 @@

Some applications, like Rhythmbox or Banshee, are primarily audio browsers, not players, and cannot be invoked with a play URL by other apps. This makes them less suitable for use with streamtuner2.

-
+
URL placeholders

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.

Index: help/configuration.page ================================================================== --- help/configuration.page +++ help/configuration.page @@ -8,12 +8,12 @@ F12 brings up the options window with the Player, Display, System and Plugin sections. Settings dialog -

There are various options for streamtuner2. -You can find the settings dialog in the edit menu as "Preferences" (last entry). +

There are various options for streamtuner2, available under Edit +Preferences or via F12.

It's separated into three main areas. @@ -50,13 +50,12 @@

video/youtube

vlc %srv

Application names are always lowercase binary names. Double click an entry to edit it.

-

After the application name, you can use a placeholder like "%pls" (which is the default, - and returns a direct URL often) or "%m3u" (where streamtuner creates local MP3 playlist file first) - and "%src" (a direct streaming server link, e.g. for VLC).

+

After the application name, you can use a placeholder like "%pls" (default), + or "%m3u" and "%src". See placeholders.

Catch-all entries like */* or a generic audio/* entry allow to configure a default player. While video/youtube is specific to the Youtube channel. And url/http a psdeudo MIME type to configure a web browser (for station homepages).

@@ -78,47 +77,117 @@ xterm there is x-terminal-emulator, or rxvt, gnome-terminal, xfce4-terminal, etc.)

- Display/GUI options - -

Most options here a self-explanatory. The options for the favicons define if station entries should - show little icons. Not all stations have one, so you might as well turn this off to conserve a little - memory.

- -

The number of stations setting is not honored by all channel plugins. Often it's not possible to - load more or fewer station entries. Some plugins have own settings (in the 'Plugins' section) even. - For the major plugins this however limits how much scroll text appears in the stream lists.

- -

"Retain deleted stations" keeps old entries, when you reload a category/genre. Shoutcast often - forgets stations or throws them out. If you keep this option enabled, these entries are kept in - streamtuner2. Browse down in the stations list to still see them.

- -

It's possible to select a Gtk+ theme. But not all themes work with all Gtk display engines, and - not all themes work with streamtuner2. You'll have to try.

- -

Remembering window states allows streamtuner2 to reconstruct which channel and category was last - selected. You can however disable this option, and instead manually save the window states/layout - in the edit menu, if you want.

- -

Setting another temporary directory might be useful, if you want to keep the temporary .m3u cache - files. They are created whenever you hit play. For archival or speed-up porposes you might want to keep - them elsewhere. They don't take a lot of space.

+ + Display/GUI options + + Display settings + + Display favicons +

The options for the favicons define if station entries should show little icons. + Not all stations have one, so you might as well turn this off to conserve a little memory.

+ + + Load favicons +

When starting to play a station, its homepage favicon is automatically retrieved in the + background. It's not going to be displayed right away, but after you reload the category/station list. + Alternatively use Channel Update favicons... to update all + station icons at once.

+ + + Show bookmark star +

Bookmarked stations will be marked with a ★ star in all other station lists / categories. + That doesn't often work for the same station entry from two different channel services / tabs though.

+ + + Gtk+ theme +

Be careful. While Gtk allows to select a different theme per application, not all themes + work right away. Switching the theme might hang streamtuner2. Just restart if that happens.

+ + + Save window states +

Automatically remember window size, selected channel tab, categories, or selected station. + Also keeps the width of station list columns. If disabled, you can manually save the current + layout/selections via Edit Save States.

+ + + + + Station loading + + Prefer HTML traversing (PyQuery) over regex +

Some channels provide proper APIs to fetch station lists. Others are just websites, that + require scraping listings out. Most channel tabs provide two alternative methods for that. + The DOM/HTML selection method is sometimes more reliable. As fallback streamtuner2 plugins + often use a regex to match text. Occassionally the regex method is actually more reliable, + because directory services often use frightful unstructured HTML. If available, both methods + are tried. You can influence the order with this setting.

+ + + [<input>250</input>] Limit stream number +

Constraints the length of station lists per category. + The number of stations setting is not honored by all channel plugins. Often it's not possible to + load more or fewer station entries. Some plugins have own settings (in the 'Plugins' section) even. + For the major plugins this however limits how much scroll text appears in the stream lists.

+ + + Retain deleted stations

When enabled, keeps old station entries when + updating/reloading a category/genre. Services often forget stations or throws them out when inavailable. + With this option enabled, these entries are kept in streamtuner2 as strikethrough entries (often + at the end of the list).

+ + + Update favouries from freshened URLs +

Streaming URLs in bookmarked stations get renewed on category reloads/updates. This isn't + very reliable, as often station titles change together with the streaming URLs.

+ + + google station homepages +

When playing a station that doesn't have a homepage entry, streamtuner2 tries to google + the station title. The found URL is then used/kept as station homepage. (Btw, station titles + like www.mymusicstation.com are automatically mapped to homepage URLs already.)

+ + + + + System + + Temporary files +

Streamtuner2 creates temporary .m3u files, if an audio player is configured to use %m3u files + instead of %pls or %srv URLs. For archival purposes, you might want to set a dedicated directory + for this. Leave this to the default /tmp else.

+ + + Config directory +

Is where streamtuner2 keeps its settings.json and channel caches, favicons, etc. + You can't set this in the config dialog. This is just for display. Set the XDG_CONFIG_HOME + environment variable to adapt.

+ + + Enable debug messages +

If you start streamtuner2 from a terminal window (xterm/rxvt), you can get a load of state + and processing or debug infos. Enable this only for testing, as it might slow down station + rendering.

+ + +
Plugin and Channel settings -

Each channel plugin can bring its own list of configuration settings. These are collected here.

+

This tab lists all available channel and feature plugins. Mark checkboxes for those plugins + you want to enable. You have to restart Streamtuner2 for any changes here to take effect.

-

The heading for each plugin allows to enable or disable it. To apply changed states you need to restart - streamtuner2 however.

+

Each channel plugin may come with its own set of addition configuration settings + below.

If you want to find out more about the short option descriptions (most settings are checkboxes), please have a look into the channels directory /usr/share/streamtuner2/channels/ and corresponding *.py files. These are readable, and sometimes contain more information.

Index: help/glossary.page ================================================================== --- help/glossary.page +++ help/glossary.page @@ -35,16 +35,15 @@ structure.

URL

URL stands for "Uniform Resource Locator" - and simply means hyperlinks and web addresses like - http://www.example.org/. There is also the hipster term "URI", - which is technically more general (but superseeded by "IRI" and - "IRL" anyway). In streamtuner2 the audio streaming link often - is an URL, as is the radio station homepage of course. (ISBN or - Mailto URIs don't make much sense for either.)

+ and simply refers to something retrievable hyperlinks or web addresses like + http://www.example.org/. Radio stations/streams are stored as URLs internally. + The more generic hipster term "URI" (long superseded by "IRI" anyway) + makes less sense in this context, because ISBN: or MailTo: references aren't + overly useful for such purposes.

 Radio

Plays music. Sometimes interrupted by advertisements. Index: help/index.page ================================================================== --- help/index.page +++ help/index.page @@ -30,12 +30,12 @@

Additional features
Index: help/technical.page ================================================================== --- help/technical.page +++ help/technical.page @@ -14,10 +14,11 @@ Dependencies

Python 2.7 or 3.x

PyGtk or PyGI

Gtk2 or Gtk3

 +

Requests/urllib3

 Soft dependencies

Python-LXML

Python-PyQuery