initial setup

This commit is contained in:
Jurgis Sakalauskas
2022-12-13 12:04:09 +02:00
parent d06b57e196
commit 3c585ed076
7 changed files with 313 additions and 211 deletions
+7 -13
View File
@@ -1,17 +1,11 @@
# Simple example plugin for Kodi mediacenter
# Simple plugin for Kodi mediacenter
API client (GUI) for [kodi-api-server](https://github.com/sakaljurgis/kodi-api-server). Draft version, but fully functional.
Based on Roman V. M. example plugin: [plugin.video.example](https://github.com/romanvm/plugin.video.example)
This is a simple yet fully functional example of a video plugin for [Kodi](http://kodi.tv) mediacenter.
Please read the comments in the plugin code for more details.
An installable .zip can be downloaded from "[Releases](https://github.com/romanvm/plugin.video.example/releases)" tab.
Do **not** try to install a .zip generated by GitHub.
**Note**: the purpose of this example plugin is to show you how to organize and play your media content in Kodi.
The methods of obtaining such content, for example parsing websites or working with various APIs,
are beyond the scope of this example.
Compatible with Kodi 19.0 ("Matrix") and above that uses Python 3.
The plugin uses a pre-defined set of free sample videos from [www.vidsplay.com](http://www.vidsplay.com/).
**Warning**: the "master" branch is only compatible with Kody 19.0 ("Matrix") and above that uses Python 3
runtime for addons. For older versions based on Python 2 see the "python2" branch.
License: [GPL v.3](http://www.gnu.org/copyleft/gpl.html)
License: no licence
+9 -11
View File
@@ -1,25 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<addon id="plugin.video.example"
version="2.4.0"
name="Example Kodi Video Plugin"
provider-name="Roman_V_M">
<addon id="plugin.video.sklk"
version="0.0.21"
name="sklk"
provider-name="krk">
<requires>
<import addon="xbmc.python" version="3.0.0"/>
<import addon="script.module.simplejson" version="2.0.10"/>
</requires>
<extension point="xbmc.python.pluginsource" library="main.py">
<provides>video</provides>
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en">Example Kodi Video Plugin</summary>
<description lang="en_GB">An example video plugin for Kodi mediacenter.</description>
<disclaimer lang="en_GB">Free sample videos are provided by www.vidsplay.com.</disclaimer>
<summary lang="en">sklk pluginas</summary>
<description lang="en_GB">nera jokio aprasymo</description>
<disclaimer lang="en_GB">cia irgi nieko nera</disclaimer>
<assets>
<icon>icon.png</icon>
<fanart>fanart.jpg</fanart>
<screenshot>resources\screenshot-01.jpg</screenshot>
<screenshot>resources\screenshot-02.jpg</screenshot>
<screenshot>resources\screenshot-03.jpg</screenshot>
</assets>
<news>Updated with latest artwork metadata</news>
<news>jokiu naujienu..</news>
</extension>
</addon>
+273 -169
View File
@@ -1,63 +1,53 @@
# Module: main
# Author: Roman V. M.
# Created on: 28.11.2014
# License: GPL v.3 https://www.gnu.org/copyleft/gpl.html
"""
Example video plugin that is compatible with Kodi 19.x "Matrix" and above
"""
# -*- coding: utf-8 -*-
# Module: default
# Based on Roman V. M. example plugin https://github.com/romanvm/plugin.video.example
# still draft, but it works!
#xbmc.log("router objAPIresponse " + json.dumps(objAPIresponse))
#xbmcgui.Dialog().ok("name", json.dumps(objAPIresponse))
#my_addon = xbmcaddon.Addon()
#my_setting = my_addon.getSetting('my_setting') # returns the string 'true' or 'false'
#my_addon.setSetting('my_setting', 'false')
import sys
from urllib.parse import urlencode, parse_qsl
import xbmcgui
import xbmcplugin
import xbmcaddon
import urllib.request
import simplejson as json
from io import StringIO
import gzip
# Get the plugin url in plugin:// notation.
_URL = sys.argv[0]
_url = sys.argv[0]
# Get the plugin handle as an integer number.
_HANDLE = int(sys.argv[1])
_handle = int(sys.argv[1])
# Free sample videos are provided by www.vidsplay.com
# Here we use a fixed set of properties simply for demonstrating purposes
# In a "real life" plugin you will need to get info and links to video files/streams
# from some web-site or online service.
VIDEOS = {'Animals': [{'name': 'Crab',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/04/crab-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/04/crab.mp4',
'genre': 'Animals'},
{'name': 'Alligator',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/04/alligator-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/04/alligator.mp4',
'genre': 'Animals'},
{'name': 'Turtle',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/04/turtle-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/04/turtle.mp4',
'genre': 'Animals'}
],
'Cars': [{'name': 'Postal Truck',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/05/us_postal-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/05/us_postal.mp4',
'genre': 'Cars'},
{'name': 'Traffic',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/05/traffic1-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/05/traffic1.mp4',
'genre': 'Cars'},
{'name': 'Traffic Arrows',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/05/traffic_arrows-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/05/traffic_arrows.mp4',
'genre': 'Cars'}
],
'Food': [{'name': 'Chicken',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/05/bbq_chicken-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/05/bbqchicken.mp4',
'genre': 'Food'},
{'name': 'Hamburger',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/05/hamburger-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/05/hamburger.mp4',
'genre': 'Food'},
{'name': 'Pizza',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/05/pizza-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/05/pizza.mp4',
'genre': 'Food'}
]}
# todo - get from settings
#API_URL = "http://krk.sytes.net:8181/api"
#VIDEO_URL = "http://krk.sytes.net:8181"
#API_URL = xbmcplugin.getSetting(_handle, 'api_url') #if xbmcplugin.getSetting(_handle, 'api_url') else xbmc.getSetting("api_url")
my_addon = xbmcaddon.Addon()
API_URL = my_addon.getSetting('api_url') # returns the string 'true' or 'false'
VIDEO_URL = xbmcplugin.getSetting(_handle, 'video_url')
xbmcplugin.getSetting
def getHttpURL(url):
request = urllib.request.Request(url)
request.add_header('Accept-encoding', 'gzip')
response = urllib.request.urlopen(request)
if response.info().get('Content-Encoding') == 'gzip':
buf = StringIO(response.read())
f = gzip.GzipFile(fileobj=buf)
return f.read()
return response.read()
def get_url(**kwargs):
@@ -65,149 +55,244 @@ def get_url(**kwargs):
Create a URL for calling the plugin recursively from the given set of keyword arguments.
:param kwargs: "argument=value" pairs
:type kwargs: dict
:return: plugin call URL
:rtype: str
"""
return '{}?{}'.format(_URL, urlencode(kwargs))
return '{0}?{1}'.format(_url, urlencode(kwargs))
def get_categories():
"""
Get the list of video categories.
def list_APIresponse(objAPIresponse):
Here you can insert some parsing code that retrieves
the list of video categories (e.g. 'Movies', 'TV-shows', 'Documentaries' etc.)
from some site or API.
#xbmcgui.Dialog().ok("ok", "listing api response")
.. note:: Consider using `generator functions <https://wiki.python.org/moin/Generators>`_
instead of returning lists.
:return: The list of video categories
:rtype: types.GeneratorType
"""
return VIDEOS.keys()
def get_videos(category):
"""
Get the list of videofiles/streams.
Here you can insert some parsing code that retrieves
the list of video streams in the given category from some site or API.
.. note:: Consider using `generators functions <https://wiki.python.org/moin/Generators>`_
instead of returning lists.
:param category: Category name
:type category: str
:return: the list of videos in the category
:rtype: list
"""
return VIDEOS[category]
def list_categories():
"""
Create the list of video categories in the Kodi interface.
"""
# Set plugin category. It is displayed in some skins as the name
# of the current section.
xbmcplugin.setPluginCategory(_HANDLE, 'My Video Collection')
if 'category' in objAPIresponse:
xbmcplugin.setPluginCategory(_handle, objAPIresponse['category'])
# Set plugin content. It allows Kodi to select appropriate views
# for this type of content.
xbmcplugin.setContent(_HANDLE, 'videos')
# Get video categories
categories = get_categories()
# Iterate through categories
for category in categories:
if 'content' in objAPIresponse:
xbmcplugin.setContent(_handle, objAPIresponse['content'])
# Get items
if 'items' in objAPIresponse:
items = objAPIresponse['items']
# Iterate through items
for item in items:
# Create a list item with a text label and a thumbnail image.
list_item = xbmcgui.ListItem(label=category)
list_item = xbmcgui.ListItem(label=item['label'])
# Set graphics (thumbnail, fanart, banner, poster, landscape etc.) for the list item.
# Here we use the same image for all items for simplicity's sake.
# In a real-life plugin you need to set each image accordingly.
list_item.setArt({'thumb': VIDEOS[category][0]['thumb'],
'icon': VIDEOS[category][0]['thumb'],
'fanart': VIDEOS[category][0]['thumb']})
if 'thumb' in item:
list_item.setArt({'thumb': item['thumb']})
if 'icon' in item:
list_item.setArt({'icon': item['icon']})
if 'fanart' in item:
list_item.setArt({'fanart': item['fanart']})
# Set additional info for the list item.
# Here we use a category name for both properties for for simplicity's sake.
# setInfo allows to set various information for an item.
# For available properties see the following link:
# https://codedocs.xyz/xbmc/xbmc/group__python__xbmcgui__listitem.html#ga0b71166869bda87ad744942888fb5f14
# 'mediatype' is needed for a skin to display info for this ListItem correctly.
list_item.setInfo('video', {'title': category,
'genre': category,
'mediatype': 'video'})
# Create a URL for a plugin recursive call.
# Example: plugin://plugin.video.example/?action=listing&category=Animals
url = get_url(action='listing', category=category)
if 'title' in item:
list_item.setInfo('video', {'title': item['title']})
if 'mediatype' in item:
list_item.setInfo('video', {'mediatype': item['mediatype']})
if 'size' in item: #long (1024) - size in bytes
list_item.setInfo('video', {'size': item['size']})
if 'duration' in item: # integer (245) - duration in seconds
list_item.setInfo('video', {'duration': item['duration']})
if 'aired' in item: # string (2008-12-07)
list_item.setInfo('video', {'aired': item['aired']})
if 'date' in item: # string (d.m.Y / 01.01.2009) - file date
list_item.setInfo('video', {'date': item['date']})
if 'plot' in item: # string (Long Description)
list_item.setInfo('video', {'plot': item['plot']})
if 'plotoutline' in item: # string (Short Description)
list_item.setInfo('video', {'plotoutline': item['plotoutline']})
# add properties - why it is not working?
if 'IsPlayable' in item:
if item['IsPlayable']:
list_item.setProperty('IsPlayable', 'true') # must be unicode or str, not bool
# list_item.setProperty('IsPlayable', item['IsPlayable']) - this doesn't work
else:
list_item.setProperty('IsPlayable', 'false')
# is_folder = True means that this item opens a sub-list of lower level items.
is_folder = True
# Add our item to the Kodi virtual folder listing.
xbmcplugin.addDirectoryItem(_HANDLE, url, list_item, is_folder)
# Add a sort method for the virtual folder items (alphabetically, ignore articles)
xbmcplugin.addSortMethod(_HANDLE, xbmcplugin.SORT_METHOD_LABEL_IGNORE_THE)
# Finish creating a virtual folder.
xbmcplugin.endOfDirectory(_HANDLE)
if 'isFolder' in item:
is_folder = item['isFolder']
def list_videos(category):
"""
Create the list of playable videos in the Kodi interface.
:param category: Category name
:type category: str
"""
# Set plugin category. It is displayed in some skins as the name
# of the current section.
xbmcplugin.setPluginCategory(_HANDLE, category)
# Set plugin content. It allows Kodi to select appropriate views
# for this type of content.
xbmcplugin.setContent(_HANDLE, 'videos')
# Get the list of videos in the category.
videos = get_videos(category)
# Iterate through videos.
for video in videos:
# Create a list item with a text label and a thumbnail image.
list_item = xbmcgui.ListItem(label=video['name'])
# Set additional info for the list item.
# 'mediatype' is needed for skin to display info for this ListItem correctly.
list_item.setInfo('video', {'title': video['name'],
'genre': video['genre'],
'mediatype': 'video'})
# Set graphics (thumbnail, fanart, banner, poster, landscape etc.) for the list item.
# Here we use the same image for all items for simplicity's sake.
# In a real-life plugin you need to set each image accordingly.
list_item.setArt({'thumb': video['thumb'], 'icon': video['thumb'], 'fanart': video['thumb']})
# Set 'IsPlayable' property to 'true'.
# This is mandatory for playable items!
list_item.setProperty('IsPlayable', 'true')
# Create a URL for a plugin recursive call.
# Example: plugin://plugin.video.example/?action=play&video=http://www.vidsplay.com/wp-content/uploads/2017/04/crab.mp4
url = get_url(action='play', video=video['video'])
# Add the list item to a virtual Kodi folder.
# is_folder = False means that this item won't open any sub-list.
is_folder = False
# Example: plugin://plugin.video.example/?action=query&path=epg
# if path is available ->
# default action for folder is query,
# for file default is play, unless other action is provided
#if path is not provided
# action is ignore
if 'path' in item:
if is_folder:
url = get_url(action='query', path=item['path'])
else:
if 'action' in item:
if 'searchFor' in item:
url = get_url(action=item['action'], path=item['path'], searchFor=item['searchFor'])
else:
url = get_url(action=item['action'], path=item['path'])
else:
url = get_url(action='play', path=item['path'])
list_item.setProperty('IsPlayable', 'true')
else:
url = get_url(action='ignore')
# add context menus (if there are any)
if 'contextMenus' in item:
contextMenus = item['contextMenus']
listContextMenus = []
# Iterate through contextMenus
for contextMenu in contextMenus:
#should have a name (String) and urlParams (object)
params = contextMenu['urlParams']
cmUrl = '{0}?{1}'.format(_url, urlencode(params)) #context menu url
listContextMenus.append((contextMenu['name'], 'RunPlugin("' + cmUrl + '")'))
if len(contextMenus) > 0:
list_item.addContextMenuItems(listContextMenus)
# Add our item to the Kodi virtual folder listing.
xbmcplugin.addDirectoryItem(_HANDLE, url, list_item, is_folder)
# Add a sort method for the virtual folder items (alphabetically, ignore articles)
xbmcplugin.addSortMethod(_HANDLE, xbmcplugin.SORT_METHOD_LABEL_IGNORE_THE)
xbmcplugin.addDirectoryItem(_handle, url, list_item, is_folder)
# Add a sort method for the virtual folder items
if 'nosort' in objAPIresponse:
xbmcplugin.addSortMethod(_handle, xbmcplugin.SORT_METHOD_UNSORTED)
else:
#(alphabetically, ignore articles)
xbmcplugin.addSortMethod(_handle, xbmcplugin.SORT_METHOD_LABEL_IGNORE_THE)
xbmcplugin.addSortMethod(_handle, xbmcplugin.SORT_METHOD_DATE)
# Finish creating a virtual folder.
xbmcplugin.endOfDirectory(_HANDLE)
xbmcplugin.endOfDirectory(_handle)
def select_APIresponse(objAPIresponse):
if 'items' in objAPIresponse:
items = objAPIresponse['items']
arrItems = [] #for now this is arr of strings
# Iterate through items, collect all labels
for item in items:
arrItems.append(item['label'])
#show the list
dialog = xbmcgui.Dialog() #todo - let to choose own title
selected = dialog.select('Select...', arrItems)
#dialog.select('Choose a playlist', ['Playlist #1', 'Playlist #2', 'Playlist #3']) #list of strings / xbmcgui.ListItems - list of items shown in dialog.
if selected == -1:
pass
else:
#invoke self run on selected item
strPath = items[selected]['path']
url = get_url(action='query', path=strPath, selected=selected)
#xbmcgui.Dialog().ok("running Container.Update", url)
#xbmc.executebuiltin("Container.Update(" + url + ")")
xbmc.executebuiltin('Container.Update(%s)' % url)
def play_video(path):
"""
Play a video by the provided path.
:param path: Fully-qualified video URL
:param path: relative path or full path
:type path: str
"""
#xbmcgui.Dialog().ok("debug", "playvideo", path)
if 'http' not in path:
path = VIDEO_URL + path
# Create a playable item with a path to play.
play_item = xbmcgui.ListItem(path=path)
# Pass the item to the Kodi player.
xbmcplugin.setResolvedUrl(_HANDLE, True, listitem=play_item)
xbmcplugin.setResolvedUrl(_handle, True, listitem=play_item)
def queryAPI(paramstring):
strAPIresponse = getHttpURL(API_URL + "?" + paramstring)
#parsed response from server
objAPIresponse = json.loads(strAPIresponse)
#show message if message is received
if 'msgBoxOK' in objAPIresponse:
xbmcgui.Dialog().ok("message from server", objAPIresponse['msgBoxOK'])
if 'notification' in objAPIresponse:
xbmc.executebuiltin('Notification("Notification from server!", "' + objAPIresponse['notification'] + '")')
# to force the update the container (e.g. after file is deleted)
# can have a replace (string) to reset the path history and must have urlParams (object)
if 'forceUpdate' in objAPIresponse:
forceUpdate = objAPIresponse['forceUpdate']
if 'replace' in forceUpdate and 'urlParams' in forceUpdate:
fuUrl = '{0}?{1}'.format(_url, urlencode(forceUpdate['urlParams'])) #forceUpdate url
xbmc.executebuiltin("Container.Update(" + fuUrl + ", " + forceUpdate['replace'] + ")")
return
elif 'urlParams' in forceUpdate:
fuUrl = '{0}?{1}'.format(_url, urlencode(forceUpdate['urlParams'])) #forceUpdate url
xbmc.executebuiltin("Container.Update(" + fuUrl + ")")
return
#play video if play is received
if 'play' in objAPIresponse:
play_video(objAPIresponse['play'])
#always update list, unless instructed otherwise
if 'updateList' in objAPIresponse:
if objAPIresponse['updateList']:
list_APIresponse(objAPIresponse)
else:
list_APIresponse(objAPIresponse)
#refresh container
if 'refreshContainer' in objAPIresponse:
if objAPIresponse['refreshContainer']:
xbmc.executebuiltin("Container.Refresh")
#show list to select
if 'selectList' in objAPIresponse:
if objAPIresponse['selectList']:
#show a list of items to select
select_APIresponse(objAPIresponse)
#dialog.textviewer('Plot', 'Some movie plot.')
def router(paramstring):
"""
Router function that calls other functions
@@ -216,29 +301,48 @@ def router(paramstring):
:param paramstring: URL encoded plugin paramstring
:type paramstring: str
"""
# Parse a URL-encoded paramstring to the dictionary of
# {<parameter>: <value>} elements
params = dict(parse_qsl(paramstring))
# Check the parameters passed to the plugin
if params:
if params['action'] == 'listing':
# Display the list of videos in a provided category.
list_videos(params['category'])
if params['action'] == 'query':
# Query API server and generate list (or play video).
queryAPI(paramstring)
elif params['action'] == 'play':
# Play a video from a provided URL.
play_video(params['video'])
play_video(params['path'])
elif params['action'] == 'ignore':
# do nothing, this is info item
strVariable = "nothing"
elif params['action'] == 'search':
# show search dialog for now, later will query the server
dialog = xbmcgui.Dialog()
if 'searchFor' in params:
strSearchString = dialog.input("Search...", defaultt=params['searchFor'], type=xbmcgui.INPUT_ALPHANUM)
else:
strSearchString = dialog.input("Search...", type=xbmcgui.INPUT_ALPHANUM)
if strSearchString:
params['action'] = "query"
params['search'] = strSearchString
url = '{0}?{1}'.format(_url, urlencode(params))
#xbmc.executebuiltin("Container.Update(" + url + ")")
xbmc.executebuiltin('Container.Update(%s)' % url)
else:
# If the provided paramstring does not contain a supported action
# we raise an exception. This helps to catch coding errors,
# e.g. typos in action names.
raise ValueError('Invalid paramstring: {}!'.format(paramstring))
xbmcgui.Dialog().ok("Invalid paramstring:", paramstring)
#raise ValueError('Invalid paramstring: {0}!'.format(paramstring))
else:
# If the plugin is called from Kodi UI without any parameters,
# display the list of video categories
list_categories()
# display the list of items
queryAPI(paramstring)
if __name__ == '__main__':
# Call the router function and pass the plugin call parameters to it.
# We use string slicing to trim the leading '?' from the plugin call paramstring
router(sys.argv[2][1:])
Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

+6
View File
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<settings>
<setting id="my_setting" type="bool" default="true" label="My Setting"/>
<setting id="api_url" type="text" default="http://sklk.lt:8181/api" label="API URL"/>
<setting id="video_url" type="text" default="http://sklk.lt:8181" label="VIDEO URL"/>
</settings>