Index: help/action_recording.page
==================================================================
--- help/action_recording.page
+++ help/action_recording.page
@@ -34,38 +34,54 @@
For example
As alternative to streamripper, check out fIcy/fPls for recording ICEcast/SHOUTcast streaming servers.
-It can be configured with
It can be configured with
You might also want to try a streamripper GUI or graphical +reimplementation. For instance there are:
+StreamRipStar (Java), works best per drag and drop.
Streamtastic (Java)
KStreamRipper, though no current version in distros.
VLC has built-in recording capabilities.
Which simplify defining a custom download directory, or how radio +streams are split (between advertisement breaks), and the naming scheme +for resulting *.mp3 filenames of course.
The recording settings have a specific entry for "video/youtube" URLs. To configure a specific download +
The recording settings have a specific entry for "video/youtube" URLs. To configure a custom download
directory, use
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 +
To download audio files from The MOD Archive directly, you can also
+define a custom handler. 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
GModplay
VLC (built-in support)
See recording - configuration if you want to enable the download mode. (Audio - files are packaged up in ZIP files on MODArchive.)
--one-instance option, which sometimes
works better. (And sometimes not.)
Some applications, like Rhythmbox or Banshee, are primarily playlist managers, not players, - and cannot be invoked with a play URL by other apps. This makes them less suitable for use with - streamtuner2. (Same goes for streamtuner2 of course. It's not a player, just a playlist tool.)
+ and cannot be invoked with a station URL. This makes them less suitable for use with streamtuner2. + (Same goes for streamtuner2 itself. It's not a player, but just a playlist browser.)Any listed application can be invoked with a different kind of - URL or filename. Most are rather flexible, but some depend on - specific playlist file types or URLs. You can control this by adding - a placeholder after the configured application name:
+Listed audio players get run with a streaming server address (URL). + These can either be direct MP3/Ogg servers (http://example.org:7843/) + and sometimes playlist files (http://example.org/listen.pls) + - depending on the channel directory.
+ +Most audio players automatically handle any station URLs. Some however + support just a few formats, or can't handle modern XSPF playlists for + instance. Which is why you can control this by adding a placeholder + after the configured application name:
Placeholder | Alternatives | URL/Filename type |
%pls | %url %u %r | Either a remote .pls resource (fastest), or a local .pls file (if converted) |
%m3u | %f %g %m | Provides a local .m3u file for the streaming station |
%jspf | %j | JSON playlist format (widely unsupported) |
%asx | Some obscure Windows playlist format (don't use that) | |
%smil | Standardized multimedia sequencing lists (which nobody uses either) |
Preferrably use the long %abbr names for configuration.
+Preferrably use the long %abbr names for configuration. The + default is %pls if you leave it out. (Most directories + already provide PLS files, which avoids any extra conversion by ST2 + which sometimes delay playback.)
+ +A few channels (like Jamendo) send custom JSON playlist snippets, + which no audio player would understand. Which is why they're always + pre-converted.
-Most audio players like pls, yet sometimes the - older m3u format more. Streamripper requires %srv for recording.
- -Leave it to the default %pls to avoid Streamtuner2 doing unneeded - extra conversions (just delays playback).
Most audio players like %pls, yet sometimes the + older %m3u format more. Streamripper requires %srv for recording.
+ +Use the newer %xspf format if your player supports + it. This format retains the maximum of station infos (such as + homepages etc.), and thus often makes for better bookmarking directly + in your player.
video/*
video/youtube
Application names are most always lowercase binary names. Double click an entry to edit it. - After editing the icon next to the application name will be updated. If it stays green, it's + After editing, the icon next to the application name will be updated. If it stays green, it's likely to work. If it turns red / into a stop symbol, then the entered name is likely incorrect.
After the application name, you can use a placeholder like "%pls" (default), - or "%m3u" and "%srv". See placeholders.
+After the application name, you can optionally use a placeholder like "%pls" (default), + "%m3u" (old), or "%xspf" (modern), and "%srv" (for direct + streaming URLs). 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 pseudo MIME type to configure a web browser (for station homepages).
@@ -159,11 +160,23 @@Streamtuner2 creates temporary .m3u files - for audio players that are 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.
+ for this. In recent versions streamtuner2 will create aWhen converting online station playlists, streamtuner2 creates temporary files like
+ shoutcast.11539398391891.m3u for your audio player. It'll keep those
+ files around until you quit streamtuner2. That speeds up switching between and reconnecting to
+ a previous station. It's in particular necessary when you use
Is where streamtuner2 keeps its
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.
Now "threading" is a somewhat technical term. It means that an
+ application runs different tasks internally at the same time. It's
+ used for snappier interfaces. However, it's also difficult to get
+ right at times. In Streamtuner2 some concurrent tasks conflict with
+ updating the Gtk3 user interface. Which is why the application may
+ crash even on reloading station lists or when switching between
+ categories too quickly. This is only an issue for Python3 on Gtk3 with
+ streamtuner2. In such cases you can disable the concurrent-tasking
+ mode. The GUI will appear slower at times, and freeze between fetching
+ lists, but remains stable on the upside. There's also a command line
+ flag
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 tabs
Each channel plugin may come with its own set of addition configuration settings - below.
+Each plugin can have its own little list of extra options. They'll be + applied right away for already active channel/feature plugins.
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.