D 2015-04-03T18:39:25.249
L write\sa\splugin
N text/x-markdown
P 0a769b31cf8219d526933e9c1538e6f32bc9cbf2
U mario
W 4235
Wrting a new plugin is often trivial.
Just create a new `channels/name.py` following this structure:
# title: MyPlugin
# description: my radio list
# version: 0.1
# type: channel
# category: radio
# url: http://www.mymusicstation.com/
# config: -
from channels import *
class myplugin (ChannelPlugin):
title = "MyNewChannel"
module = "myplugin"
has_search = False
titles = dict(listeners=False)
categories = []
catmap = {}
def update_categories(self):
self.categories = ["Pop", "Rock", "etc"]
def update_streams(self, cat, search=None):
entries = []
# ...
# get it from somewhere
# ...
return entries
The description block on top is used for the [plugin management](wiki/plugin+meta+data) (and documentative purposes). This is meant to cleanly separate in-application values (like .module or .has_search, .catmap) from attributes that just serve initialization.
Each plugin needs a `update_categories()` method. This can be a stub, if the channel plugin has a static list of genres. If so, just set the `categories = [...]` declaration right away. The method is only used if the default categories list is empty, needs to be renewed from the service (e.g. whenever the menu entry Channel>Update_categories is used). There's also a `catmap={}` dict in case category/genre titles have to be associated with service ids.
More importantly you need the `update_streams()` method to fetch station lists. It receives a `cat` parameter, for instance `"Pop"`. Then do whatever API query or website scraping (regex/pyquery) is necessary to populate a list.
Most plugins will return a list of dicts like:
{title: Radio123, url: http://pls, genre: Pop, playing: Song123}
The title is required, and the streaming URL of course. Other fields are mostly optional.
* Standard fields are:
* <kbd>genre</kbd> - the category name
* <kbd>title</kbd> - station title
* <kbd>url</kbd> - streaming url (to pls or m3u resource)
* <kbd>playing</kbd> - currently playing song, if any
* <kbd>homepage</kbd> - station homepage
* <kbd>bitrate</kbd> - (int) audio bitrate (like 128)
* <kbd>listeners</kbd> - (int) number of listeners
* <kbd>favicon</kbd> - url to favicon, if any
* <kbd>format</kbd> - to set a custom audio format (audio/ogg)
* Internal fields are:
* <kbd>state</kbd> - a gtk icon
* <kbd>deleted</kbd> - strikethrough for deleted entries
* <kbd>favourite</kbd> - add a star for bookmarked stations
* <kbd>search_col</kbd> - search color
* <kbd>search_set</kbd> - search state
* With a `datamap=[]` declaration custom field names could be displayed.
* Often you just want to rename the column titles however - per `title=dict(listeners="Whatever")` in the class declaration.
Received station lists get stored internally in a `streams={"Pop":[...]}` dict, and cached in the `~/.config/streamtuner2/cache/` directory of course.
There's also a `config=[]` list, in case your plugin needs to keep some settings. (For example an API key.)
The `has_search` class flag permits live server searches. If one is issued, the `update_streams()` method will be called with `cat=None` and `search="Find me maybe"` set instead.
* Other class options include `listformat="audio/x-scpls"` for declaring the station URL mime type (here `pls` for example).
* And `audioformat="audio/mpeg"` for the audio mime type.
* While `current=""` and `default="Pop"` can specify which category is visible per default, or currently active. (Both will be retired in later versions. More a clutch for current Gtk handling.)
* Other internal fields are listed in `channels/_generic.py`
To have a new plugin picked up, you need to copy/symlink the file into `/usr/share/streamtuner2/channels/`. It's imported from the `channels` module group automatically. Which allows relocatability, and later even local plugins. (Which is commonly unneeded featuritis though, so not yet implemented.)
Z 96e0dfc62135c19472e5e49e2f308dc4