<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<title>Settings dialog</title>
<link rel="stylesheet" type="text/css" href="C.css">
<script type="text/javascript" src="jquery.js"></script><script type="text/javascript" src="jquery.syntax.js"></script><script type="text/javascript" src="yelp.js"></script>
</head>
<body><div class="page" role="main">
<div class="header"><div class="trails" role="navigation"><div class="trail">
<a class="trail" href="index.html" title="♪ Streamtuner2"><span class="media"><span class="media media-image"><img src="img/logo.png" class="media media-inline" alt="♪"></span></span> Streamtuner2 </a> › <a class="trail" href="index.html#configuration" title="Configuration">Configuration</a> » </div></div></div>
<div class="body">
<div class="hgroup"><h1 class="title"><span class="title">Settings dialog</span></h1></div>
<div class="region">
<div class="contents">
<p class="p">
There are various options for streamtuner2, available under <span class="guiseq"><span class="gui">Edit</span> ▸ <span class="gui">Preferences</span></span> or via <span class="key"><kbd>F12</kbd></span>.
</p>
<p class="p"><span class="media"><span class="media media-image"><img src="img/configtabs.png" class="media media-inline" alt=""></span></span></p>
<div class="terms"><div class="inner">
<div class="title title-terms"><h2><span class="title">It's separated into different sections/tabs.</span></h2></div>
<div class="region"><dl class="terms">
<dt class="terms">🔊 Player</dt>
<dd class="terms"><p class="p">Lists audio formats and the audio player applications, or recording tools below.
It's a map of file-types to applications. Double click an entry to edit it.</p></dd>
<dt class="terms">☑ Options</dt>
<dd class="terms"><p class="p">Influences the display of all stream/station lists, and contains some
behaviour and system settings.</p></dd>
<dt class="terms">📻 Channel Plugins</dt>
<dd class="terms"><p class="p">Every channel tab can have specific options. These are configured here.
Also you can disable channels you don't need.</p></dd>
<dt class="terms">🔌 Feature Plugins</dt>
<dd class="terms"><p class="p">Another class of plugins enables internal functions, or adds extra menu
entries, or configuration options.</p></dd>
<dt class="terms">📦 Add</dt>
<dd class="terms"><p class="p">The <span class="link"><a href="pluginmanager2.html" title="Plugin Manager 2">Plugin Manager 2</a></span> adds another
tab for updating or installing new plugins.</p></dd>
</dl></div>
</div></div>
</div>
<div id="apps" class="sect"><div class="inner">
<div class="hgroup"><h2 class="title"><span class="title">Player application settings</span></h2></div>
<div class="region"><div class="contents">
<p class="p">MIME types are categorzied identifiers for file types. <span class="var">Audio/mpeg</span> for
example represents MP3 files, and <span class="var">audio/ogg</span> means just OGG. And the player
setting dialog simply associates an audio type with a playback application:</p>
<div class="table"><div class="inner"><div class="region"><table class="table">
<thead><tr>
<td><p class="p">Format</p></td>
<td style="border-left-style: solid;"><p class="p">Application</p></td>
</tr></thead>
<tr>
<td><p class="p"><span class="var">audio/mpeg</span></p></td>
<td style="border-left-style: solid;"><p class="p"><span class="cmd">audacious</span></p></td>
</tr>
<tr class="shade">
<td style="border-top-style: solid;"><p class="p"><span class="var">audio/ogg</span></p></td>
<td style="border-top-style: solid;border-left-style: solid;"><p class="p"><span class="cmd">audacious</span></p></td>
</tr>
<tr>
<td style="border-top-style: solid;"><p class="p"><span class="var">audio/*</span></p></td>
<td style="border-top-style: solid;border-left-style: solid;"><p class="p"><span class="cmd">vlc --one-instance</span></p></td>
</tr>
<tr class="shade">
<td style="border-top-style: solid;"><p class="p"><span class="var">video/*</span></p></td>
<td style="border-top-style: solid;border-left-style: solid;"><p class="p"><span class="cmd">totem</span></p></td>
</tr>
<tr>
<td style="border-top-style: solid;"><p class="p"><span class="var">video/youtube</span></p></td>
<td style="border-top-style: solid;border-left-style: solid;"><p class="p"><span class="cmd">vlc %srv</span></p></td>
</tr>
</table></div></div></div>
<p class="p">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
likely to work. If it turns red / into a stop symbol, then the entered name is likely incorrect.</p>
<p class="p"><span class="media"><span class="media media-image"><img src="img/configapps.png" class="media media-inline" alt=""></span></span></p>
<p class="p">After the application name, you can optionally use a placeholder like "<span class="var">%pls</span>" (default),
"<span class="var">%m3u</span>" (old), or "<span class="var">%xspf</span>" (modern), and "<span class="var">%srv</span>" (for direct
streaming URLs). See <span class="link"><a href="config_apps.html#placeholders" title="URL placeholders">placeholders</a></span>.</p>
<p class="p">Catch-all entries like <span class="var">*/*</span> or a generic <span class="var">audio/*</span> entry allow to
configure a default player. While <span class="var">video/youtube</span> is specific to the Youtube
channel. And <span class="var">url/http</span> a pseudo MIME type to configure a web browser (for
station homepages).</p>
<p class="p">In practice you only need one entry for <span class="var">audio/*</span> and one for
<span class="var">video/*</span>, both can use the same player even. You can remove default entries by
clearing both the Format field and its associated Application. Add completely new
associations through the emtpy line. (Reopen the dialog to add another one.)</p>
<div class="links topiclinks"><div class="inner"><div class="region"><div class="linkdiv "><a class="linkdiv" href="config_apps.html" title="Audio players"><span class="title">Audio players</span><span class="linkdiv-dash"> — </span><span class="desc">Common applications to use as players.</span></a></div></div></div></div>
</div></div>
</div></div>
<div id="recording" class="sect"><div class="inner">
<div class="hgroup"><h2 class="title"><span class="title">Recording Apps</span></h2></div>
<div class="region"><div class="contents">
<p class="p">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.</p>
<div class="table"><div class="inner"><div class="region"><table class="table">
<tr>
<td><p class="p"><span class="var">audio/*</span></p></td>
<td style="border-left-style: solid;"><p class="p"><span class="cmd">xterm -e streamripper %srv</span></p></td>
</tr>
<tr class="shade">
<td style="border-top-style: solid;"><p class="p"><span class="var">video/youtube</span></p></td>
<td style="border-top-style: solid;border-left-style: solid;"><p class="p"><span class="cmd">xterm -e "youtube-dl %srv"</span></p></td>
</tr>
</table></div></div></div>
<p class="p">To define a target directory, you can often 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.)</p>
<div class="links topiclinks"><div class="inner"><div class="region"><div class="linkdiv "><a class="linkdiv" href="recording.html" title="Recording"><span class="title">Recording</span><span class="linkdiv-dash"> — </span><span class="desc">Save radio songs as MP3 files via streamripper.</span></a></div></div></div></div>
</div></div>
</div></div>
<div id="gui" class="sect"><div class="inner">
<div class="hgroup"><h2 class="title"><span class="title">Display/GUI options</span></h2></div>
<div class="region"><div class="contents">
<div class="terms"><div class="inner">
<div class="title title-terms"><h3><span class="title">Display settings</span></h3></div>
<div class="region"><dl class="terms">
<dt class="terms">Display favicons</dt>
<dd class="terms"><p class="p">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.</p></dd>
<dt class="terms">Load favicons</dt>
<dd class="terms"><p class="p">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 <span class="guiseq"><span class="gui">Channel</span> ▸ <span class="gui">Update favicons...</span></span> to update all
station icons at once.</p></dd>
<dt class="terms">Show bookmark star</dt>
<dd class="terms"><p class="p">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.</p></dd>
<dt class="terms">Save window states</dt>
<dd class="terms"><p class="p">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 <span class="guiseq"><span class="gui">Edit</span> ▸ <span class="gui">Save States</span></span>.</p></dd>
</dl></div>
</div></div>
<div class="terms"><div class="inner">
<div class="title title-terms"><h3><span class="title">Station loading</span></h3></div>
<div class="region"><dl class="terms">
<dt class="terms">Prefer HTML traversing (PyQuery) over regex</dt>
<dd class="terms"><p class="p">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 slower, but more reliable. As fallback streamtuner2
plugins often use a regex to match text. Occassionally the regex method is surprisingly more exact,
because directory services often use frightful unstructured HTML. If available, both methods
are tried. You can influence the order with this setting, and thus speed it up.</p></dd>
<dt class="terms">[<span class="input">250</span>] Limit stream number</dt>
<dd class="terms"><p class="p"> Constraints the length of station lists per category.
The number of stations option 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 many scrollable entries appear in the stream lists.</p></dd>
<dt class="terms">Retain deleted stations</dt>
<dd class="terms"><p class="p">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).</p></dd>
<dt class="terms">Update favouries from freshened URLs</dt>
<dd class="terms"><p class="p">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.</p></dd>
<dt class="terms">google station homepages</dt>
<dd class="terms"><p class="p">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.)</p></dd>
</dl></div>
</div></div>
<div class="terms"><div class="inner">
<div class="title title-terms"><h3><span class="title">Playlist</span></h3></div>
<div class="region"><dl class="terms">
<dt class="terms">Reuse .m3u/.pls files</dt>
<dd class="terms"><p class="p">When converting online station playlists,
streamtuner2 creates temporary files like <span class="var">shoutcast.11539398391891.m3u</span> for
your audio player. It'll keep those files around in /tmp/streamtuner2 until you quit.
That speeds up switching between and reconnecting to a previous station. It's in
particular necessary when you use <span class="key"><kbd>⏭</kbd></span> or <span class="key"><kbd>⏪</kbd></span> directly in your player.
For <span class="var">%pls</span> references your player typically usues the online-only playlist
files anyway. If you disable this option, then converted pls/m3u/xspf files get
recreated repeatedly.</p></dd>
<dt class="terms">Forgo any playlist conversion</dt>
<dd class="terms">
<p class="p">Per default most server playlists (be they .pls or .m3u, .xpsf) are converted.
All player/recording apps receive a default <span class="var">%pls</span> file normally.
Set this option to disable any such placeholders from the Player tab, and avoid
streamtuner2 pre-downloading any m3u/pls/xspf. Instead your audio player gets passed
the literal server/playlist streaming URL then.</p>
<div class="note" title="Note"><div class="inner"><div class="region"><div class="contents"><p class="p">Note that this is only
a minor speedup, but may trip up some applications. A few channel sources don't
even provide standard stream addresses and playlists. (Jamendo albums for example really
need pre-conversion; no audio player can deal with such custom JSON playlists).
In short: you don't normally want to enable this flag - unless you run into problems
with streamtuner2 taking too long, or when it hang by accidentially downloading streams
itself.</p></div></div></div></div>
</dd>
</dl></div>
</div></div>
<div class="terms"><div class="inner">
<div class="title title-terms"><h3><span class="title">System</span></h3></div>
<div class="region"><dl class="terms">
<dt class="terms">Temporary files</dt>
<dd class="terms"><p class="p">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. In recent
versions streamtuner2 will create a <span class="file">/tmp/streamtuner2</span> directory for itself.
(You cannot set just `/tmp` anymore, because that will be mapped to the longer name.
You can trick the old behaviour with `/tmp/.` however. Don't do that unless you have a
reason).</p></dd>
<dt class="terms">Config directory</dt>
<dd class="terms"><p class="p">Is where streamtuner2 keeps its <span class="file">settings.json</span> and channel caches, favicons, etc.
You can't set this in the config dialog. This is just for display. Set the <span class="sys">XDG_CONFIG_HOME</span>
environment variable to adapt.</p></dd>
<dt class="terms">Enable debug messages</dt>
<dd class="terms"><p class="p">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.</p></dd>
<dt class="terms">Disable threading</dt>
<dd class="terms"><p class="p">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 <span class="cmd">--nt</span> to enable this workaround.</p></dd>
</dl></div>
</div></div>
</div></div>
</div></div>
<div id="plugins" class="sect"><div class="inner">
<div class="hgroup"><h2 class="title"><span class="title">Channel and feature plugins and settings</span></h2></div>
<div class="region">
<div class="contents">
<p class="p">The tabs <span class="key"><kbd>📻 Channels</kbd></span> lists all available directory services.
While the <span class="key"><kbd>🔌 Features</kbd></span> group provides internal or menu enhancements.
Disabling or enabling a plugin however requires a restart of Streamtuner2
to take effect. (Unless the <span class="link"><a href="pluginmanager2.html" title="Plugin Manager 2">Plugin Manager 2</a></span>
is enabled, with its <span class="key"><kbd>📦 Add</kbd></span> tab visible.)</p>
<p class="p"><span class="media"><span class="media media-image"><img src="img/configplugins.png" class="media media-inline" alt=""></span></span></p>
<p class="p">Each plugin can have its own little list of extra options. They'll be
applied right away for already active channel/feature plugins.</p>
<div class="links topiclinks"><div class="inner"><div class="region">
<div class="linkdiv "><a class="linkdiv" href="internet_radio_org_uk.html" title="Internet-Radio"><span class="title">Internet-Radio</span><span class="linkdiv-dash"> — </span><span class="desc">Large radio directory from the UK.</span></a></div>
<div class="linkdiv "><a class="linkdiv" href="jamendo.html" title="Jamendo"><span class="title">Jamendo</span><span class="linkdiv-dash"> — </span><span class="desc">Creative Commons music and artist hub.</span></a></div>
<div class="linkdiv "><a class="linkdiv" href="myoggradio.html" title="MyOggRadio"><span class="title">MyOggRadio</span><span class="linkdiv-dash"> — </span><span class="desc">Open source stream directory.</span></a></div>
<div class="linkdiv "><a class="linkdiv" href="radionomy.html" title="Radionomy"><span class="title">Radionomy</span><span class="linkdiv-dash"> — </span><span class="desc">Large internet streaming provider</span></a></div>
<div class="linkdiv "><a class="linkdiv" href="surfmusik.html" title="SurfMusic"><span class="title">SurfMusic</span><span class="linkdiv-dash"> — </span><span class="desc">International radio listings.</span></a></div>
<div class="linkdiv "><a class="linkdiv" href="tunein.html" title="TuneIn"><span class="title">TuneIn</span><span class="linkdiv-dash"> — </span><span class="desc">Radio and Podcast directory.</span></a></div>
<div class="linkdiv "><a class="linkdiv" href="xiph.html" title="Xiph.org"><span class="title">Xiph.org</span><span class="linkdiv-dash"> — </span><span class="desc">ICEcast radio directory.</span></a></div>
<div class="linkdiv "><a class="linkdiv" href="youtube.html" title="Youtube"><span class="title">Youtube</span><span class="linkdiv-dash"> — </span><span class="desc">Youtube music/video listings.</span></a></div>
<div class="linkdiv "><a class="linkdiv" href="filtermusic.html" title="filtermusic"><span class="title">filtermusic</span><span class="linkdiv-dash"> — </span><span class="desc">Selection of the best radio stations</span></a></div>
</div></div></div>
</div>
<div class="sect sect-links" role="navigation">
<div class="hgroup"></div>
<div class="contents"><div class="links guidelinks"><div class="inner">
<div class="title"><h3><span class="title">More Information</span></h3></div>
<div class="region"><ul><li class="links ">
<a href="pluginmanager2.html" title="Plugin Manager 2">Plugin Manager 2</a><span class="desc"> — User plugin installation</span>
</li></ul></div>
</div></div></div>
</div>
</div>
</div></div>
<div id="note" class="sect"><div class="inner">
<div class="hgroup"></div>
<div class="region"><div class="contents"><div class="note" title="Note"><div class="inner"><div class="region"><div class="contents"><p class="p">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 somewhat readable even to non-programmers, and sometimes contain more information.</p></div></div></div></div></div></div>
</div></div>
<div class="sect sect-links" role="navigation">
<div class="hgroup"></div>
<div class="contents"><div class="links guidelinks"><div class="inner">
<div class="title"><h2><span class="title">More Information</span></h2></div>
<div class="region"><ul><li class="links "><a href="index.html#configuration" title="Configuration">Configuration</a></li></ul></div>
</div></div></div>
</div>
</div>
<div class="clear"></div>
</div>
<div class="footer"></div>
</div></body>
</html>