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 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
|
<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>→ Feature plugins</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#extra" title="Additional features">Additional features</a> » </div>
<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#extra" title="Additional features">Additional features</a> » <a class="trail" href="pluginmanager2.html" title="Plugin Manager 2 - 📦 Add">Plugin Manager 2 - <span class="key"><kbd>📦 Add</kbd></span> </a> » </div>
<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#extra" title="Additional features">Additional features</a> » <a class="trail" href="pluginmanager2.html" title="Plugin Manager 2 - 📦 Add">Plugin Manager 2 - <span class="key"><kbd>📦 Add</kbd></span> </a> » <a class="trail" href="configuration.html#plugins" title="Channel and feature plugins and settings">Channel and feature plugins and settings</a> » </div>
</div></div>
<div class="body">
<div class="hgroup"><h1 class="title"><span class="title">→ Feature plugins</span></h1></div>
<div class="region">
<div class="contents"></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h2 class="title"><span class="title"><span class="key"><kbd>🔌 Feature</kbd></span> plugins and settings</span></h2></div>
<div class="region">
<div class="contents"><p class="p">Extra functionality and behaviour changes are available in
the <span class="key"><kbd>🔌 Feature</kbd></span> <span class="link"><a href="configuration.html" title="Configuration / Settings dialog">configuration</a></span>
section.</p></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h3 class="title"><span class="title">🔌 Filter Bitrate</span></h3></div>
<div class="region"><div class="contents">
<p class="p">Some channels provide lower-quality audio streams. In particular
Xiph lists some awful radio stations. And this plugin helps filtering
those out of station lists.</p>
<div class="list"><div class="inner"><div class="region"><ul class="list">
<li class="list"><p class="p">MP3 streams often start to sound okay at 96kbit/s.</p></li>
<li class="list"><p class="p">Whereas OGG Vorbis or AAC are sometimes acceptable at 64kbit/s already.</p></li>
</ul></div></div></div>
<p class="p">Note that you may end up with empty channel lists
altogether if you set these options too high. Some channels provide all
their streams with 64kbit/s only.</p>
</div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h3 class="title"><span class="title">🔌 Channel toolbar link</span></h3></div>
<div class="region"><div class="contents">
<p class="p">Adds a toolbar entry which shows the current channel/directory
service title and its homepage link. Such as:</p>
<div class="code"><pre class="contents "><span class="span"> ▶ ● 🏠 Shoutcast</span>
play rcrd hmpg <span class="link"><a href="http://shoutcast.com/" title="http://shoutcast.com/">//shoutcast.com/</a></span>
</pre></div>
<p class="p">It depends on the "update window title" option being enabled.</p>
</div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h3 class="title"><span class="title">🔌 Export all stations</span></h3></div>
<div class="region"><div class="contents">
<p class="p">There's an "Export All" plugin available. It adds an entry under
<span class="guiseq"><span class="gui">Main menu</span> ▸ <span class="gui">Extensions</span> ▸ <span class="gui">Export all stations</span></span>.
Which allows to export all stations from the currently visible channel category.</p>
<div class="list"><div class="inner"><div class="region"><ul class="list">
<li class="list"><p class="p">This is of course intended primarily for saving your bookmarks.</p></li>
<li class="list"><p class="p">And it allows to import radio lists into any other music player or playlist collection/management app (such as Rhythmbox).</p></li>
<li class="list"><p class="p">You can set the desired playlist format in the file saving dialog that pops up.</p></li>
</ul></div></div></div>
</div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h3 class="title"><span class="title">🔌 RadioTray hook</span></h3></div>
<div class="region"><div class="contents">
<p class="p">This plugin enables an extra category in the <span class="key"><kbd>bookmarks</kbd></span> tab.
It shows bookmarked stations from the RadioTray application, if that's
installed. Additionally it adds a context option to save new stations
from Streamtuner2 to RadioTray. The mapping option influences if added
radios are recategorized in RadioTray.</p>
<div class="note" title="Note"><div class="inner"><div class="region"><div class="contents"><p class="p"> Please see the Wiki for further <span class="link"><a href="http://fossil.include-once.org/streamtuner2/wiki/radiotray" title="http://fossil.include-once.org/streamtuner2/wiki/radiotray">setup instructions</a></span>.</p></div></div></div></div>
</div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h3 class="title"><span class="title">🔌 User Agent Switcher</span></h3></div>
<div class="region"><div class="contents">
<p class="p">This plugin merely masks Streamtuner2 as an ordinary web browser when retrieving station lists.</p>
<div class="list"><div class="inner"><div class="region"><ul class="list">
<li class="list"><p class="p"> It's technically unneeded, as ST2 isn't stressful to directory websites and not blocked anywhere. </p></li>
<li class="list"><p class="p">It's only useful as additional privacy feature really, but shouldn't be used habitually. </p></li>
</ul></div></div></div>
</div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h3 class="title"><span class="title">🔌 History</span></h3></div>
<div class="region"><div class="contents"><p class="p">Provides the small "history" category in the bookmarks tab. The length of
which is configurable (defaults to 20).</p></div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h3 class="title"><span class="title">🔌 Links to directory services</span></h3></div>
<div class="region"><div class="contents"><p class="p">Adds a list of weblinks to other online music services in the "links" category
within the bookmarks tab.</p></div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h3 class="title"><span class="title">🔌 Recording options</span></h3></div>
<div class="region"><div class="contents">
<p class="p">Overrides the <span class="gui"><span class="key"><kbd>●</kbd></span> record</span> button to
not start streamripper right away. Instead it prompts for additional
settings before proceeding.</p>
<p class="p">Common options are conveniently listed and saveable on a per-station
basis. Which allows to suppress stream editing (record just one long
MP3 file), or file naming schemes.</p>
<p class="p">Additionally it supports options of following recording backends:</p>
<div class="list"><div class="inner"><div class="region"><ul class="list">
<li class="list"><p class="p"><span class="app">streamrippper</span> - for radio stations</p></li>
<li class="list"><p class="p"><span class="app">fPls/fIcy</span> - for radio stations</p></li>
<li class="list"><p class="p"><span class="app">youtube-dl</span> - video downloads</p></li>
<li class="list"><p class="p"><span class="app">wget</span> - plain MOD/ZIP files</p></li>
</ul></div></div></div>
<p class="p">The plugin provides config options of its own, such as a default
output directory, or how many / how detailed options to show.</p>
</div></div>
</div></div>
</div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h2 class="title"><span class="title">Core feature plugins</span></h2></div>
<div class="region"><div class="contents">
<p class="p">Following plugins are covered more in-depth in the according manual
sections:</p>
<div class="list"><div class="inner"><div class="region"><ul class="list">
<li class="list"><p class="p"><span class="link"><a href="dragndrop.html" title="Drag'n'drop">🔌 Drag and Drop</a></span></p></li>
<li class="list"><p class="p"><span class="link"><a href="favicon.html" title="Station favicons">🔌 Favicons</a></span></p></li>
<li class="list"><p class="p"><span class="link"><a href="global_key.html" title="Global_key">🔌 Global key shortcut</a></span></p></li>
<li class="list"><p class="p"><span class="link"><a href="timer.html" title="Timer">🔌 Timer</a></span></p></li>
<li class="list"><p class="p"><span class="link"><a href="specbuttons.html" title="Special extra/mini buttons">🔌 Specbuttons</a></span></p></li>
</ul></div></div></div>
<p class="p">The "<span class="link"><a href="search.html" title="Searching">search</a></span>",
"<span class="link"><a href="configuration.html" title="Configuration / Settings dialog">configwin</a></span>" and
"<span class="link"><a href="edit.html" title="Edit">streamedit</a></span>" plugins are considered
built-ins and cannot be disabled.</p>
</div></div>
</div></div>
<div id="contrib" class="sect"><div class="inner">
<div class="hgroup"><h2 class="title"><span class="title">Downloadable contrib/ feature plugins</span></h2></div>
<div class="region">
<div class="contents"><p class="p">The <span class="link"><a href="pluginmanager2.html" title="Plugin Manager 2 - 📦 Add">Plugin Manager</a></span> lists more
downloadable feature plugins in the <span class="key"><kbd>📦 Add</kbd></span> tab.</p></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h4 class="subtitle"><span class="subtitle">🔌 Soundcloud streaming</span></h4></div>
<div class="region"><div class="contents">
<p class="p">Enables playback of soundcloud.com links, which are only used
in the <span class="link"><a href="channel_reddit.html" title="channel_reddit">📻 Reddit</a></span> plugin currently.
Homepage links are transformed into direct MP3 streaming addresses
on playback.</p>
<div class="note" title="Note"><div class="inner"><div class="region"><div class="contents"><p class="p">Depends on python-soundcloud, which you can install per
<span class="cmd">pip install soundcloud</span>.</p></div></div></div></div>
<p class="p"> Alternatively you could configure an external player like <span class="link"><a href="http://github.com/rekado/soundCLI" title="http://github.com/rekado/soundCLI">soundcli</a></span> of course.
Use the pseudo type "audio/soundcloud" for the player settings table.</p>
</div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h4 class="subtitle"><span class="subtitle">🔌 dev_faulthandler</span></h4></div>
<div class="region"><div class="contents"><p class="p">This is a pure development plugin, meant to debug ST2 crashes.</p></div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h4 class="subtitle"><span class="subtitle">🔌 bookmarks_show_extra</span></h4></div>
<div class="region"><div class="contents"><p class="p">Is a slim UI adaption to show the `extra` field in the bookmarks
channel. This field can contain user comments, but is used per default
to store the originating channel in.</p></div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h4 class="subtitle"><span class="subtitle">🔌 new_station</span></h4></div>
<div class="region"><div class="contents"><p class="p">(Still unfinished). Small plugin to provide an "Add station..."
menu entry. Note that ST2 is not meant as playlist manager, which is
why this isn't a built-in feature. However, it's oft-requested anyway.</p></div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h4 class="subtitle"><span class="subtitle">🔌 tmp_clean_multiurl</span></h4></div>
<div class="region"><div class="contents"><p class="p">Strips extra space-separate URLs from station list. (Currently only
required for 📻 RadioSure channel. Later ST2 versions will likely support
such entries per default again).</p></div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h4 class="subtitle"><span class="subtitle">🔌 Gtk theme setting</span></h4></div>
<div class="region"><div class="contents">
<p class="p">You can set a custom theme for Streamtuner2 using the gtk_theme
plugin. It ought to list all available themes for Gtk2 or Gtk3 in
the according dropdown box. The "apply instantly" option may help
with enabling them right away.</p>
<div class="note note-bug" title="Bug"><div class="inner"><div class="region"><div class="contents"><p class="p">Take note that not all Gtk themes will work,
and some might crash streamtuner2.</p></div></div></div></div>
<p class="p">If you see ST2 hang at startup, then either edit
<span class="file">settings.json</span> to remove the <span class="cmd">"theme": "..."</span>
name, or use the <span class="code"><span class="app">streamtuner2 -d gtk_theme</span></span>
start command.</p>
<p class="p">To install/enable themes just for ST2, you could create a
<span class="file">~/.config/streamtuner2/themes/</span> folder, or one below
<span class="file">/usr/share/streamtuner2/themes/</span> even.</p>
</div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h4 class="subtitle"><span class="subtitle">🔌 stop_button</span></h4></div>
<div class="region"><div class="contents"><p class="p">Adds the toolbar button to stop streamripper/fpls - same as in
streamtuner1. Has become kind of redundant due to the newer
<span class="link"><a href="specbuttons.html" title="Special extra/mini buttons">🔌 specbuttons</a></span> plugin.</p></div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h4 class="subtitle"><span class="subtitle">🔌 Config prefs</span></h4></div>
<div class="region"><div class="contents">
<p class="p">Introduces three main menu entries:</p>
<div class="list"><div class="inner"><div class="region"><ul class="list">
<li class="list">
<div class="title title-item"><h4><span class="title"><span class="guiseq"><span class="gui">Station</span> ▸ <span class="gui">Extensions</span> ▸ <span class="gui">Config save</span></span></span></h4></div>
<p class="p">Saves the streamtuner2.json file verbatim.</p>
</li>
<li class="list">
<div class="title title-item"><h4><span class="title"><span class="guiseq"><span class="gui">Station</span> ▸ <span class="gui">Extensions</span> ▸ <span class="gui">Config restore</span></span></span></h4></div>
<p class="p">While the file dialog incorrectly says and behaves like a file
save dialog, it does in fact open and load the JSON file.</p>
</li>
<li class="list">
<div class="title title-item"><h4><span class="title"><span class="guiseq"><span class="gui">Station</span> ▸ <span class="gui">Extensions</span> ▸ <span class="gui">Config delete</span></span></span></h4></div>
<p class="p">The config reset additionally opens the settings window and
requires you to hit <span class="key"><kbd>Save</kbd></span> for confirmation. In any case
ST2 should also be restarted afterwards to unload disabled plugins.</p>
</li>
</ul></div></div></div>
</div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h4 class="subtitle"><span class="subtitle">🔌 Cache reset</span></h4></div>
<div class="region"><div class="contents"><p class="p">Adds a <span class="key"><kbd>Cache reset</kbd></span> button in the Options tab of
the settings window. It shows how much space all cache files of
ST2 occupy. Usually the icons take up most, while the channel/station
archive is often just 2-3 MB. Temporary m3u/pls files can also
be deleted. → Tick the parts you want to have removed before hitting
the reset button.</p></div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h4 class="subtitle"><span class="subtitle">🔌 OGG Icon</span></h4></div>
<div class="region"><div class="contents"><p class="p">Introduces small state icons to make higher-quality Vorbis and
Opus stations stand out. (Not all channels provide exact format
information, so you'll mostly notice for Jamendo and Xiph.) </p></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#extra" title="Additional features">Additional features</a></li>
<li class="links "><a href="configuration.html#plugins" title="Channel and feature plugins and settings">Channel and feature plugins and settings</a></li>
<li class="links ">
<a href="pluginmanager2.html" title="Plugin Manager 2 - 📦 Add">Plugin Manager 2 - <span class="key"><kbd>📦 Add</kbd></span> </a><span class="desc"> — User plugin installation</span>
</li>
</ul></div>
</div></div></div>
</div>
</div>
<div class="clear"></div>
</div>
<div class="footer"></div>
</div></body>
</html>
|