PlexKodiConnect/resources/lib/json_rpc.py

627 lines
17 KiB
Python
Raw Normal View History

#!/usr/bin/env python
# -*- coding: utf-8 -*-
2017-12-08 17:53:01 +11:00
"""
Collection of functions using the Kodi JSON RPC interface.
See http://kodi.wiki/view/JSON-RPC_API
"""
from __future__ import absolute_import, division, unicode_literals
2017-12-09 06:32:10 +11:00
from json import loads, dumps
from xbmc import executeJSONRPC
2019-01-09 04:00:54 +11:00
from . import kodi_constants, timing, variables as v
JSON_FROM_KODITYPE = {
v.KODI_TYPE_MOVIE: ('VideoLibrary.GetMovieDetails',
kodi_constants.FIELDS_MOVIES),
v.KODI_TYPE_SHOW: ('VideoLibrary.GetTVShowDetails',
kodi_constants.FIELDS_TVSHOWS),
v.KODI_TYPE_SEASON: ('VideoLibrary.GetSeasonDetails',
kodi_constants.FIELDS_SEASON),
v.KODI_TYPE_EPISODE: ('VideoLibrary.GetEpisodeDetails',
kodi_constants.FIELDS_EPISODES),
v.KODI_TYPE_ARTIST: ('AudioLibrary.GetArtistDetails',
kodi_constants.FIELDS_ARTISTS),
v.KODI_TYPE_ALBUM: ('AudioLibrary.GetAlbumDetails',
kodi_constants.FIELDS_ALBUMS),
v.KODI_TYPE_SONG: ('AudioLibrary.GetSongDetails',
kodi_constants.FIELDS_SONGS),
v.KODI_TYPE_SET: ('VideoLibrary.GetMovieSetDetails',
[]),
}
2018-06-22 03:24:37 +10:00
2017-12-10 00:35:08 +11:00
2017-12-15 23:22:12 +11:00
class JsonRPC(object):
2017-12-09 06:32:10 +11:00
"""
Used for all Kodi JSON RPC calls.
"""
id_ = 1
2017-12-15 23:22:12 +11:00
version = "2.0"
2017-12-09 06:32:10 +11:00
def __init__(self, method, **kwargs):
"""
2017-12-15 23:22:12 +11:00
Initialize with the Kodi method, e.g. 'Player.GetActivePlayers'
2017-12-09 06:32:10 +11:00
"""
self.method = method
2017-12-15 23:22:12 +11:00
self.params = None
for arg in kwargs:
2017-12-09 06:32:10 +11:00
self.arg = arg
def _query(self):
query = {
2017-12-15 23:22:12 +11:00
'jsonrpc': self.version,
2017-12-09 06:32:10 +11:00
'id': self.id_,
'method': self.method,
}
if self.params is not None:
query['params'] = self.params
return dumps(query)
def execute(self, params=None):
"""
Pass any params as a dict. Will return Kodi's answer as a dict.
"""
self.params = params
return loads(executeJSONRPC(self._query()))
2017-12-08 17:53:01 +11:00
def get_players():
"""
Returns all the active Kodi players (usually 3) in a dict:
{
'video': {'playerid': int, 'type': 'video'}
'audio': ...
'picture': ...
}
"""
ret = {}
for player in JsonRPC("Player.GetActivePlayers").execute()['result']:
2017-12-08 17:53:01 +11:00
player['playerid'] = int(player['playerid'])
ret[player['type']] = player
return ret
def get_player_ids():
"""
Returns a list of all the active Kodi player ids (usually 3) as int
"""
ret = []
for player in get_players().values():
ret.append(player['playerid'])
return ret
def get_playlist_id(typus):
"""
Returns the corresponding Kodi playlist id as an int
typus: Kodi playlist types: 'video', 'audio' or 'picture'
Returns None if nothing was found
"""
for playlist in get_playlists():
if playlist.get('type') == typus:
return playlist.get('playlistid')
def get_playlists():
"""
Returns a list of all the Kodi playlists, e.g.
[
{u'playlistid': 0, u'type': u'audio'},
{u'playlistid': 1, u'type': u'video'},
{u'playlistid': 2, u'type': u'picture'}
]
"""
2017-12-09 05:43:06 +11:00
try:
2017-12-15 23:22:12 +11:00
ret = JsonRPC('Playlist.GetPlaylists').execute()['result']
2017-12-09 05:43:06 +11:00
except KeyError:
ret = []
return ret
def get_volume():
"""
Returns the Kodi volume as an int between 0 (min) and 100 (max)
"""
2017-12-15 23:22:12 +11:00
return JsonRPC('Application.GetProperties').execute(
2017-12-09 05:43:06 +11:00
{"properties": ['volume']})['result']['volume']
2017-12-08 17:53:01 +11:00
def set_volume(volume):
"""
Set's the volume (for Kodi overall, not only a player).
Feed with an int
"""
2017-12-15 23:22:12 +11:00
return JsonRPC('Application.SetVolume').execute({"volume": volume})
2017-12-09 05:43:06 +11:00
def get_muted():
"""
Returns True if Kodi is muted, False otherwise
"""
2017-12-15 23:22:12 +11:00
return JsonRPC('Application.GetProperties').execute(
2017-12-09 05:43:06 +11:00
{"properties": ['muted']})['result']['muted']
2017-12-08 17:53:01 +11:00
def play():
"""
Toggles all Kodi players to play
"""
for playerid in get_player_ids():
2017-12-15 23:22:12 +11:00
JsonRPC("Player.PlayPause").execute({"playerid": playerid,
2017-12-08 17:53:01 +11:00
"play": True})
def pause():
"""
Pauses playback for all Kodi players
"""
for playerid in get_player_ids():
2017-12-15 23:22:12 +11:00
JsonRPC("Player.PlayPause").execute({"playerid": playerid,
2017-12-08 17:53:01 +11:00
"play": False})
def stop():
"""
Stops playback for all Kodi players
"""
for playerid in get_player_ids():
2017-12-15 23:22:12 +11:00
JsonRPC("Player.Stop").execute({"playerid": playerid})
2017-12-08 17:53:01 +11:00
def seek_to(offset):
"""
Seeks all Kodi players to offset [int] in milliseconds
2017-12-08 17:53:01 +11:00
"""
for playerid in get_player_ids():
return JsonRPC("Player.Seek").execute(
2017-12-08 17:53:01 +11:00
{"playerid": playerid,
2018-11-19 00:59:17 +11:00
"value": timing.millis_to_kodi_time(offset)})
2017-12-08 17:53:01 +11:00
def smallforward():
"""
Small step forward for all Kodi players
"""
for playerid in get_player_ids():
2017-12-15 23:22:12 +11:00
JsonRPC("Player.Seek").execute({"playerid": playerid,
2017-12-08 17:53:01 +11:00
"value": "smallforward"})
def smallbackward():
"""
Small step backward for all Kodi players
"""
for playerid in get_player_ids():
2017-12-15 23:22:12 +11:00
JsonRPC("Player.Seek").execute({"playerid": playerid,
2017-12-08 17:53:01 +11:00
"value": "smallbackward"})
def skipnext():
"""
Skips to the next item to play for all Kodi players
"""
for playerid in get_player_ids():
2017-12-15 23:22:12 +11:00
JsonRPC("Player.GoTo").execute({"playerid": playerid,
2017-12-08 17:53:01 +11:00
"to": "next"})
def skipprevious():
2018-02-04 03:03:36 +11:00
"""
Skips to the previous item to play for all Kodi players
Using a HACK to make sure we're not just starting same item over again
"""
for playerid in get_player_ids():
try:
skipto(get_position(playerid) - 1)
except (KeyError, TypeError):
pass
def wont_work_skipprevious():
2017-12-08 17:53:01 +11:00
"""
Skips to the previous item to play for all Kodi players
"""
for playerid in get_player_ids():
2017-12-15 23:22:12 +11:00
JsonRPC("Player.GoTo").execute({"playerid": playerid,
2017-12-08 17:53:01 +11:00
"to": "previous"})
def skipto(position):
"""
Skips to the position [int] of the current playlist
"""
for playerid in get_player_ids():
JsonRPC("Player.GoTo").execute({"playerid": playerid,
"to": position})
2017-12-08 17:53:01 +11:00
def input_up():
"""
2017-12-09 06:35:32 +11:00
Tells Kodi the user pushed up
2017-12-08 17:53:01 +11:00
"""
2017-12-15 23:22:12 +11:00
return JsonRPC("Input.Up").execute()
2017-12-08 17:53:01 +11:00
def input_down():
"""
2017-12-09 06:35:32 +11:00
Tells Kodi the user pushed down
2017-12-08 17:53:01 +11:00
"""
2017-12-15 23:22:12 +11:00
return JsonRPC("Input.Down").execute()
2017-12-08 17:53:01 +11:00
def input_left():
"""
2017-12-09 06:35:32 +11:00
Tells Kodi the user pushed left
2017-12-08 17:53:01 +11:00
"""
2017-12-15 23:22:12 +11:00
return JsonRPC("Input.Left").execute()
2017-12-08 17:53:01 +11:00
def input_right():
"""
2017-12-09 06:35:32 +11:00
Tells Kodi the user pushed left
2017-12-08 17:53:01 +11:00
"""
2017-12-15 23:22:12 +11:00
return JsonRPC("Input.Right").execute()
2017-12-08 17:53:01 +11:00
def input_select():
"""
2017-12-09 06:35:32 +11:00
Tells Kodi the user pushed select
2017-12-08 17:53:01 +11:00
"""
2017-12-15 23:22:12 +11:00
return JsonRPC("Input.Select").execute()
2017-12-08 17:53:01 +11:00
def input_home():
"""
2017-12-09 06:35:32 +11:00
Tells Kodi the user pushed home
2017-12-08 17:53:01 +11:00
"""
2017-12-15 23:22:12 +11:00
return JsonRPC("Input.Home").execute()
2017-12-08 17:53:01 +11:00
def input_back():
"""
2017-12-09 06:35:32 +11:00
Tells Kodi the user pushed back
2017-12-08 17:53:01 +11:00
"""
2017-12-15 23:22:12 +11:00
return JsonRPC("Input.Back").execute()
2017-12-09 05:43:06 +11:00
2017-12-09 23:47:19 +11:00
def input_sendtext(text):
"""
Tells Kodi the user sent text [unicode]
"""
2017-12-15 23:22:12 +11:00
return JsonRPC("Input.SendText").execute({'test': text, 'done': False})
2017-12-09 23:47:19 +11:00
2017-12-21 19:28:06 +11:00
def playlist_get_items(playlistid):
2017-12-09 05:43:06 +11:00
"""
playlistid: [int] id of the Kodi playlist
Returns a list of Kodi playlist items as dicts with the keys specified in
properties. Or an empty list if unsuccessful. Example:
2017-12-21 19:28:06 +11:00
[
{
u'file':u'smb://nas/PlexMovies/3 Idiots 2009 pt1.mkv',
u'title': u'3 Idiots',
u'type': u'movie', # IF possible! Else key missing
u'id': 3, # IF possible! Else key missing
u'label': u'3 Idiots'}]
2017-12-09 05:43:06 +11:00
"""
2017-12-15 23:22:12 +11:00
reply = JsonRPC('Playlist.GetItems').execute({
2017-12-09 05:43:06 +11:00
'playlistid': playlistid,
2017-12-21 19:28:06 +11:00
'properties': ['title', 'file']
2017-12-09 05:43:06 +11:00
})
try:
reply = reply['result']['items']
except KeyError:
reply = []
return reply
def playlist_add(playlistid, item):
"""
Adds an item to the Kodi playlist with id playlistid. item is either the
dict
{'file': filepath as string}
or
{kodi_type: kodi_id}
Returns a dict with the key 'error' if unsuccessful.
"""
2017-12-15 23:22:12 +11:00
return JsonRPC('Playlist.Add').execute({'playlistid': playlistid,
2017-12-09 05:43:06 +11:00
'item': item})
def playlist_insert(params):
"""
Insert item(s) into playlist. Does not work for picture playlists (aka
slideshows). params is the dict
{
'playlistid': [int]
'position': [int]
'item': <item>
}
item is either the dict
{'file': filepath as string}
or
{kodi_type: kodi_id}
Returns a dict with the key 'error' if something went wrong.
"""
2017-12-15 23:22:12 +11:00
return JsonRPC('Playlist.Insert').execute(params)
2017-12-09 05:43:06 +11:00
def playlist_remove(playlistid, position):
"""
Removes the playlist item at position from the playlist
position: [int]
Returns a dict with the key 'error' if something went wrong.
"""
2017-12-15 23:22:12 +11:00
return JsonRPC('Playlist.Remove').execute({'playlistid': playlistid,
2017-12-09 05:43:06 +11:00
'position': position})
def get_setting(setting):
"""
2017-12-09 06:24:36 +11:00
Returns the Kodi setting (GetSettingValue), a [str], or None if not
possible
2017-12-09 05:43:06 +11:00
"""
try:
2017-12-15 23:22:12 +11:00
ret = JsonRPC('Settings.GetSettingValue').execute(
2017-12-09 05:43:06 +11:00
{'setting': setting})['result']['value']
except (KeyError, TypeError):
ret = None
return ret
def set_setting(setting, value):
"""
Sets the Kodi setting, a [str], to value
"""
2017-12-15 23:22:12 +11:00
return JsonRPC('Settings.SetSettingValue').execute(
2017-12-09 05:43:06 +11:00
{'setting': setting, 'value': value})
def get_tv_shows(params):
"""
Returns a list of tv shows for params (check the Kodi wiki)
"""
2017-12-15 23:22:12 +11:00
ret = JsonRPC('VideoLibrary.GetTVShows').execute(params)
2017-12-09 05:43:06 +11:00
try:
ret = ret['result']['tvshows']
2017-12-09 05:43:06 +11:00
except (KeyError, TypeError):
ret = []
return ret
def get_episodes(params):
"""
Returns a list of tv show episodes for params (check the Kodi wiki)
"""
2017-12-15 23:22:12 +11:00
ret = JsonRPC('VideoLibrary.GetEpisodes').execute(params)
2017-12-09 05:43:06 +11:00
try:
ret = ret['result']['episodes']
2017-12-09 05:43:06 +11:00
except (KeyError, TypeError):
ret = []
return ret
2017-12-11 05:01:22 +11:00
def get_item(playerid):
"""
2017-12-14 06:14:27 +11:00
UNRELIABLE on playback startup! (as other JSON and Python Kodi functions)
2017-12-11 05:01:22 +11:00
Returns the following for the currently playing item:
{
u'title': u'Okja',
u'type': u'movie',
u'id': 258,
u'file': u'smb://...movie.mkv',
u'label': u'Okja'
}
"""
2017-12-15 23:22:12 +11:00
return JsonRPC('Player.GetItem').execute({
2017-12-11 05:01:22 +11:00
'playerid': playerid,
'properties': ['title', 'file']})['result']['item']
def get_current_audio_stream_index(playerid):
"""
Returns the currently active audio stream index [int]
"""
return JsonRPC('Player.GetProperties').execute({
'playerid': playerid,
'properties': ['currentaudiostream']})['result']['currentaudiostream']['index']
def get_current_subtitle_stream_index(playerid):
"""
Returns the currently active subtitle stream index [int] or None if there
are no subs
PICKING UP CHANGES ON SUBTITLES IS CURRENTLY BROKEN ON THE KODI SIDE! The
JSON reply won't change even though subtitles are changed :-(
"""
try:
return JsonRPC('Player.GetProperties').execute({
'playerid': playerid,
'properties': ['currentsubtitle', ]})['result']['currentsubtitle']['index']
except KeyError:
pass
def get_subtitle_enabled(playerid):
"""
Returns True if a subtitle is currently enabled, False otherwise.
PICKING UP CHANGES ON SUBTITLES IS CURRENTLY BROKEN ON THE KODI SIDE! The
JSON reply won't change even though subtitles are changed :-(
"""
return JsonRPC('Player.GetProperties').execute({
'playerid': playerid,
'properties': ['subtitleenabled', ]})['result']['subtitleenabled']
2017-12-09 23:47:19 +11:00
def get_player_props(playerid):
"""
Returns a dict for the active Kodi player with the following values:
{
'type' [str] the Kodi player type, e.g. 'video'
'time' The current item's time in Kodi time
'totaltime' The current item's total length in Kodi time
2017-12-11 05:01:22 +11:00
'speed' [int] playback speed, 0 is paused, 1 is playing
2017-12-09 23:47:19 +11:00
'shuffled' [bool] True if shuffled
'repeat' [str] 'off', 'one', 'all'
'position' [int] position in playlist (or -1)
'playlistid' [int] the Kodi playlist id (or -1)
}
"""
2017-12-15 23:22:12 +11:00
return JsonRPC('Player.GetProperties').execute({
2017-12-09 23:47:19 +11:00
'playerid': playerid,
'properties': ['type',
'time',
'totaltime',
'speed',
'shuffled',
'repeat',
'position',
2017-12-11 05:01:22 +11:00
'playlistid',
'currentvideostream',
'currentaudiostream',
'subtitleenabled',
'currentsubtitle']})['result']
2017-12-09 23:47:19 +11:00
def get_position(playerid):
"""
Returns the currently playing item's position [int] within the playlist
"""
return JsonRPC('Player.GetProperties').execute({
'playerid': playerid,
'properties': ['position']})['result']['position']
2017-12-09 05:43:06 +11:00
def current_audiostream(playerid):
"""
Returns a dict of the active audiostream for playerid [int]:
{
'index': [int], audiostream index
'language': [str]
'name': [str]
'codec': [str]
'bitrate': [int]
'channels': [int]
}
or an empty dict if unsuccessful
"""
2017-12-15 23:22:12 +11:00
ret = JsonRPC('Player.GetProperties').execute(
2017-12-09 05:43:06 +11:00
{'properties': ['currentaudiostream'], 'playerid': playerid})
try:
ret = ret['result']['currentaudiostream']
except (KeyError, TypeError):
ret = {}
return ret
def current_subtitle(playerid):
"""
Returns a dict of the active subtitle for playerid [int]:
{
'index': [int], subtitle index
'language': [str]
'name': [str]
}
or an empty dict if unsuccessful
"""
2017-12-15 23:22:12 +11:00
ret = JsonRPC('Player.GetProperties').execute(
2017-12-09 05:43:06 +11:00
{'properties': ['currentsubtitle'], 'playerid': playerid})
try:
ret = ret['result']['currentsubtitle']
except (KeyError, TypeError):
ret = {}
return ret
def subtitle_enabled(playerid):
"""
Returns True if a subtitle is enabled, False otherwise
"""
2017-12-15 23:22:12 +11:00
ret = JsonRPC('Player.GetProperties').execute(
2017-12-09 05:43:06 +11:00
{'properties': ['subtitleenabled'], 'playerid': playerid})
try:
ret = ret['result']['subtitleenabled']
except (KeyError, TypeError):
ret = False
return ret
2017-12-09 23:47:19 +11:00
def ping():
"""
Pings the JSON RPC interface
"""
2017-12-15 23:22:12 +11:00
return JsonRPC('JSONRPC.Ping').execute()
def activate_window(window, parameters):
"""
Pass the parameters as str/unicode to open the corresponding window
"""
return JsonRPC('GUI.ActivateWindow').execute({'window': window,
'parameters': [parameters]})
def settings_getsections():
'''
Retrieve all Kodi settings sections
'''
return JsonRPC('Settings.GetSections').execute({'level': 'expert'})
def settings_getcategories():
'''
Retrieve all Kodi settings categories (one level below sections)
'''
return JsonRPC('Settings.GetCategories').execute({'level': 'expert'})
def settings_getsettings(filter_params):
'''
Get all the settings for
filter_params = {'category': <str>, 'section': <str>}
e.g. = {'category':'videoplayer', 'section':'player'}
'''
return JsonRPC('Settings.GetSettings').execute({
'level': 'expert',
'filter': filter_params
})
def settings_getsettingvalue(setting):
'''
Pass in the setting id as a string (as retrieved from settings_getsettings),
e.g. 'videoplayer.autoplaynextitem' or None is something went wrong
'''
ret = JsonRPC('Settings.GetSettingValue').execute({'setting': setting})
try:
ret = ret['result']['value']
except (TypeError, KeyError):
ret = None
return ret
def settings_setsettingvalue(setting, value):
'''
Set the Kodi setting (str) to value (type depends, see JSON wiki)
'''
return JsonRPC('Settings.SetSettingValue').execute({
'setting': setting,
'value': value
})
2019-01-09 04:00:54 +11:00
def item_details(kodi_id, kodi_type):
'''
Returns the Kodi item dict for this item
'''
json, fields = JSON_FROM_KODITYPE[kodi_type]
ret = JsonRPC(json).execute({'%sid' % kodi_type: kodi_id,
'properties': fields})
try:
return ret['result']['%sdetails' % kodi_type]
except (KeyError, TypeError):
return {}