Index: help/action_recording.page ================================================================== --- help/action_recording.page +++ help/action_recording.page @@ -2,31 +2,54 @@ type="guide" id="recording"> - + Save radio songs as MP3 files via streamripper. - Recording - -

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.

- -

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.

- -

You can influence all these behaviours with -arguments to the streamripper program. - Please refer to the manpage of streamripper. The options are too broad to list here. - You can set default arguments (e.g. another default save directory) in the Config > Apps - dialog.

- -

As alternative check out fIcy/fPls - for recording ICEcast/SHOUTcast streaming servers.

+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, +a console window should appear, where streamripper shows its progress.

+ + +
+Streamripper + +

The xterm -e prefix brings up the terminal popup, to follow streamrippers +progress. Remove that for silent downloads.

+ + + + +

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).

+
+ + +
+fIcy/fPls + +

As alternative to streamripper, check out fIcy/fPls +for recording ICEcast/SHOUTcast streaming servers.

+ +

It can be configured with xterm -e "fPls %srv" simply.

+
+ + +
+Youtube-DL + +

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.)

+
Index: help/cli.page ================================================================== --- help/cli.page +++ help/cli.page @@ -1,11 +1,11 @@ - + Console interface, exporting data. CLI (command line interface) Index: help/config_apps.page ================================================================== --- help/config_apps.page +++ help/config_apps.page @@ -2,17 +2,18 @@ type="guide" id="config_apps"> + Common applications to use as players. Audio players

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 + 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.

Index: help/configuration.page ================================================================== --- help/configuration.page +++ help/configuration.page @@ -1,90 +1,124 @@ - + - - F12 brings up the options window with the Player, Display, System and Plugin sections. + + 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). -

- - - It's separated into three main areas. - - Player -

Lists audio formats and the audio player applications, or recording tools below. - It's a file type to application table. Double click an entry for editing.

-
- - Options -

Influences the display of all stream/station lists, and contains some system settings.

-
- - Channel Plugins -

Every channel tab can have specific options. These are configured here. - Also you can disable channels you don't need.

-
-
- - -
- Player application settings -

MIME types are elaborate identifiers for file types; audio/mp3 for example represents MP3 files, and audio/ogg - means just OGG.

-

The text entry fields can hold the application name of an audio player. Often the application name - is just a lower case version of the program title.

-

Behind application names a placeholder can be used. On invocation such placeholders - get replaced with an URL (a http://..-Link) or filename for the selected radio stream.

-

Placeholders are introduced by a percent sign, and followed by letters. %m3u for example generates a .m3u file, - which most audio players understand. Otherwise try %pls, which might even be faster because streamtuner2 doesn't - have to download and preprocess it. Alternatively %srv instead gives a direct stream link.

-

Catch-all entries like */* or a generic audio/* entry allow to configure a default player. -

-

Recording

-

The second block of entries in the 'Apps' section specifies recording applications. - Here streamripper is preconfigured for audio streams, and youtube-dl for Youtube videos for instance. - To define a target directory, you can add commandline arguments to each. Also it's typically - helpful to leave the xterm prefix on, so you can follow the processing state. (Alternatively to - 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.

-
- -
- Plugin and Channel settings -

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

-

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

-

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.

-
- - - +Settings dialog + +

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

+ + + It's separated into three main areas. + + Player +

Lists audio formats and the audio player applications, or recording tools below. + It's a file type to application table. Double click an entry for editing.

+
+ + Options +

Influences the display of all stream/station lists, and contains some system settings.

+
+ + Channel Plugins +

Every channel tab can have specific options. These are configured here. + Also you can disable channels you don't need.

+
+
+ + +
+ + Player application settings + +

MIME types are categorzied identifiers for file types. Audio/mpeg for example represents MP3 files, + and audio/ogg means just OGG. And the player setting dialog simply associates an audio type with a + playback application:

+ +

Audacious

audacious %m3u

audio

+ + + + + + +

Format

Application

audio/mpeg

audacious

audio/ogg

audacious

audio/*

vlc --one-instance

video/*

totem

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).

+ +

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).

+ + +
+ + Recording Apps + +

The second block of entries in the 'Apps' section specifies recording applications. + Here streamripper is preconfigured for audio streams, and youtube-dl for Youtube videos for instance.

+ + + + +

audio/*

xterm -e streamripper %srv

video/youtube

xterm -e "youtube-dl %srv"

+ +

To define a target directory, you can add commandline arguments to each. Also it's typically + helpful to leave the xterm prefix on, so you can follow the processing state. (Alternatively to + 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.

+
+ +
+ Plugin and Channel settings + +

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

+ +

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

+ +

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/global_key.page ================================================================== --- help/global_key.page +++ help/global_key.page @@ -1,11 +1,11 @@ - + Global keyboard shortcut for radio switching. Global_key Index: help/glossary.page ================================================================== --- help/glossary.page +++ help/glossary.page @@ -1,11 +1,11 @@ - + Technical and streamtuner2 specific terminology and jargon. Glossary Index: help/index.page ================================================================== --- help/index.page +++ help/index.page @@ -25,12 +25,12 @@
Configuration
-
- Advanced topics +
+ Additional features