Archive:JSON-RPC API/v4: Difference between revisions
Jump to navigation
Jump to search
>Sam (fixed) |
>Sam (fixed) |
||
| Line 187: | Line 187: | ||
'method': 'JSONRPC.Introspect', | 'method': 'JSONRPC.Introspect', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': { | 'result': { | ||
} | } | ||
| Line 237: | Line 237: | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': { | 'result': { | ||
'controlnotify': undefined /* boolean, required */, | 'controlnotify': undefined /* boolean, required */, | ||
'controlplayback': undefined /* boolean, required */, | 'controlplayback': undefined /* boolean, required */, | ||
'controlpower': undefined /* boolean, required */, | 'controlpower': undefined /* boolean, required */, | ||
'navigate': undefined /* boolean, required */, | 'navigate': undefined /* boolean, required */, | ||
'readdata': undefined /* boolean, required */, | 'readdata': undefined /* boolean, required */, | ||
| Line 609: | Line 607: | ||
'type': 'unknown' /* string */, | 'type': 'unknown' /* string */, | ||
'votes': '' /* string */, | 'votes': '' /* string */, | ||
'writer': '' /* string */, | 'writer': '' /* string */, | ||
'director': '' /* string */, | 'director': '' /* string */, | ||
| Line 640: | Line 637: | ||
] | ] | ||
}, | }, | ||
'file': '' /* string */, | 'file': '' /* string */, | ||
'lastplayed': '' /* string */, | 'lastplayed': '' /* string */, | ||
| Line 945: | Line 941: | ||
} or { /* no additional properties allowed */ | } or { /* no additional properties allowed */ | ||
'path': undefined /* string, required */, | 'path': undefined /* string, required */, | ||
'random': true /* boolean | 'random': true /* boolean */, | ||
'recursive': true /* boolean */ | 'recursive': true /* boolean */ | ||
} | } | ||
} | } | ||
| Line 981: | Line 967: | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 | 'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */ | ||
} | } | ||
} | } | ||
| Line 1,058: | Line 1,043: | ||
'params': { | 'params': { | ||
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */, | 'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */, | ||
'value': 0 /* number, id: Player.Position.Percentage, minimum: 0, maximum: 100, Percentage value to seek to */ or { /* | 'value': 0 /* number, id: Player.Position.Percentage, minimum: 0, maximum: 100, Percentage value to seek to */ or { /* no additional properties allowed, Time to seek to */ | ||
'hours': 0 /* integer, minimum: 0, maximum: 23 */, | 'hours': 0 /* integer, minimum: 0, maximum: 23 */, | ||
'milliseconds': 0 /* integer, minimum: 0, maximum: 999 */, | 'milliseconds': 0 /* integer, minimum: 0, maximum: 999 */, | ||
| Line 1,127: | Line 1,112: | ||
'params': { | 'params': { | ||
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */, | 'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */, | ||
'speed': undefined /* integer */ or | 'speed': undefined /* integer */ or undefined /* string */ | ||
} | } | ||
} | } | ||
| Line 1,154: | Line 1,139: | ||
'params': { | 'params': { | ||
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */, | 'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */, | ||
'subtitle': undefined /* string */ or undefined /* integer, minimum: 0, Index of the subtitle to display | 'subtitle': undefined /* string */ or undefined /* integer, minimum: 0, Index of the subtitle to display */ | ||
} | } | ||
} | } | ||
| Line 1,462: | Line 1,446: | ||
'type': 'unknown' /* string */, | 'type': 'unknown' /* string */, | ||
'votes': '' /* string */, | 'votes': '' /* string */, | ||
'writer': '' /* string */, | 'writer': '' /* string */, | ||
'director': '' /* string */, | 'director': '' /* string */, | ||
| Line 1,493: | Line 1,476: | ||
] | ] | ||
}, | }, | ||
'file': '' /* string */, | 'file': '' /* string */, | ||
'lastplayed': '' /* string */, | 'lastplayed': '' /* string */, | ||
| Line 1,685: | Line 1,667: | ||
'directory': undefined /* string, required */, | 'directory': undefined /* string, required */, | ||
'media': 'video' /* string, id: Files.Media */, | 'media': 'video' /* string, id: Files.Media */, | ||
'properties': [ /* id: List.Fields. | 'properties': [ /* id: List.Fields.All */ | ||
undefined /* string */ | undefined /* string */ | ||
], | ], | ||
| Line 1,707: | Line 1,689: | ||
'file': '' /* string */, | 'file': '' /* string */, | ||
'filetype': undefined /* string, required */, | 'filetype': undefined /* string, required */, | ||
'album': '' /* string */, | 'album': '' /* string */, | ||
'albumartist': '' /* string */, | 'albumartist': '' /* string */, | ||
| Line 1,753: | Line 1,732: | ||
'type': 'unknown' /* string */, | 'type': 'unknown' /* string */, | ||
'votes': '' /* string */, | 'votes': '' /* string */, | ||
'writer': '' /* string */, | 'writer': '' /* string */, | ||
'director': '' /* string */, | 'director': '' /* string */, | ||
| Line 1,784: | Line 1,762: | ||
] | ] | ||
}, | }, | ||
'lastplayed': '' /* string */, | 'lastplayed': '' /* string */, | ||
'plot': '' /* string */, | 'plot': '' /* string */, | ||
| Line 1,894: | Line 1,871: | ||
'type': undefined /* required */ | 'type': undefined /* required */ | ||
} | } | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 2,352: | Line 2,319: | ||
'duration': 0 /* integer */, | 'duration': 0 /* integer */, | ||
'file': '' /* string */, | 'file': '' /* string */, | ||
'lyrics': '' /* string */, | 'lyrics': '' /* string */, | ||
'musicbrainzartistid': '' /* string */, | 'musicbrainzartistid': '' /* string */, | ||
| Line 2,374: | Line 2,340: | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===AudioLibrary. | ===AudioLibrary.GetSongDetails=== | ||
Retrieve | Retrieve details about a specific song | ||
====Permissions==== | ====Permissions==== | ||
ReadData | ReadData | ||
| Line 2,382: | Line 2,348: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'AudioLibrary. | 'method': 'AudioLibrary.GetSongDetails', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
'properties': [ /* id: Audio.Fields. | 'songid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | ||
'properties': [ /* id: Audio.Fields.Song */ | |||
undefined /* string */ | undefined /* string */ | ||
] | ] | ||
} | } | ||
} | } | ||
| Line 2,404: | Line 2,362: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'AudioLibrary. | 'method': 'AudioLibrary.GetSongDetails', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': { | 'result': { | ||
' | 'songdetails': { /* id: Audio.Details.Song */ | ||
'album': '' /* string */, | |||
'albumartist': '' /* string */, | |||
'albumid': -1 /* integer, id: Library.Id, minimum: 1 */, | |||
'artistid': -1 /* integer, id: Library.Id, minimum: 1 */, | |||
'comment': '' /* string */, | |||
'duration': 0 /* integer */, | |||
'file': '' /* string */, | |||
'lyrics': '' /* string */, | |||
'musicbrainzartistid': '' /* string */, | |||
'musicbrainztrackid': '' /* string */, | |||
'playcount': 0 /* integer */, | |||
'songid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | |||
'track': 0 /* integer */, | |||
'artist': '' /* string */, | |||
'musicbrainzalbumartistid': '' /* string */, | |||
'musicbrainzalbumid': '' /* string */, | |||
'rating': 0 /* integer */, | |||
'title': '' /* string */, | |||
'year': 0 /* integer */, | |||
'genre': '' /* string */, | |||
'fanart': '' /* string */, | |||
'thumbnail': '' /* string */, | |||
' | 'label': undefined /* string, required */ | ||
' | |||
' | |||
} | } | ||
} | } | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===AudioLibrary. | ===AudioLibrary.GetSongs=== | ||
Retrieve | Retrieve all songs from specified album, artist or genre | ||
====Permissions==== | ====Permissions==== | ||
ReadData | ReadData | ||
| Line 2,445: | Line 2,401: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'AudioLibrary. | 'method': 'AudioLibrary.GetSongs', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
'artistid': -1 /* integer, id: Library.Id, minimum: 1 */, | |||
'albumid': -1 /* integer, id: Library.Id, minimum: 1 */, | |||
'genreid': -1 /* integer, id: Library.Id, minimum: 1 */, | |||
'properties': [ /* id: Audio.Fields.Song */ | 'properties': [ /* id: Audio.Fields.Song */ | ||
undefined /* string */ | undefined /* string */ | ||
| Line 2,467: | Line 2,426: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'AudioLibrary. | 'method': 'AudioLibrary.GetSongs', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': { | 'result': { | ||
| Line 2,484: | Line 2,443: | ||
'duration': 0 /* integer */, | 'duration': 0 /* integer */, | ||
'file': '' /* string */, | 'file': '' /* string */, | ||
'lyrics': '' /* string */, | 'lyrics': '' /* string */, | ||
'musicbrainzartistid': '' /* string */, | 'musicbrainzartistid': '' /* string */, | ||
| Line 2,506: | Line 2,464: | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===AudioLibrary. | ===AudioLibrary.Scan=== | ||
Scans the audio sources for new library items | |||
====Permissions==== | ====Permissions==== | ||
UpdateData | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'AudioLibrary. | 'method': 'AudioLibrary.Scan', | ||
'id': undefined /* integer, required */ | 'id': undefined /* integer, required */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 2,528: | Line 2,480: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'AudioLibrary. | 'method': 'AudioLibrary.Scan', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': | 'result': undefined /* string */ | ||
} | |||
</syntaxhighlight> | |||
=VideoLibrary= | |||
Video Library information | |||
==Notifications== | |||
===VideoLibrary.OnRemove=== | |||
A video item has been removed. | |||
====Returns==== | |||
<syntaxhighlight lang="javascript"> | |||
{ | |||
'jsonrpc': '2.0', | |||
'method': 'VideoLibrary.OnRemove', | |||
'params': undefined /* string, required */ or { /* required */ | |||
'id': -1 /* integer, required, id: Library.Id, minimum: 1 */, | |||
'type': undefined /* required */ | |||
} | } | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | ===VideoLibrary.OnUpdate=== | ||
A video item has been updated. | |||
====Returns==== | |||
==== | |||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'VideoLibrary.OnUpdate', | ||
' | 'params': undefined /* string, required */ or { /* required */ | ||
'id': -1 /* integer, required, id: Library.Id, minimum: 1 */, | |||
'playcount': -1 /* integer, minimum: 0 */, | |||
' | 'type': undefined /* string ('movie', 'tvshow', 'episode', 'musicvideo'), required, id: Notifications.Library.Video.Type */ | ||
' | } | ||
' | } | ||
</syntaxhighlight> | |||
==Methods== | |||
===VideoLibrary.Clean=== | |||
Cleans the video library from non-existent items | |||
====Permissions==== | |||
RemoveData | |||
====Syntax==== | |||
<syntaxhighlight lang="javascript"> | |||
{ | |||
'jsonrpc': '2.0', | |||
'method': 'VideoLibrary.Clean', | |||
'id': undefined /* integer, required */ | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 2,593: | Line 2,532: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'VideoLibrary.Clean', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result | 'result': undefined /* string */ | ||
} | |||
</syntaxhighlight> | |||
===VideoLibrary.Export=== | |||
Exports all items from the video library | |||
====Permissions==== | |||
WriteFile | |||
====Syntax==== | |||
} | |||
</syntaxhighlight> | |||
=== | |||
====Permissions==== | |||
====Syntax==== | |||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'VideoLibrary.Export', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
' | 'options': { /* no additional properties allowed */ | ||
'path': undefined /* string, required, minimum length: 1, Path to the directory to where the data should be exported */ | |||
} or { /* no additional properties allowed */ | |||
'actorthumbs': false /* boolean, Whether to export actor thumbnails */, | |||
'images': false /* boolean, Whether to export thumbnails and fanart images */, | |||
'overwrite': false /* boolean, Whether to overwrite existing exported files */ | |||
{ | } | ||
} | } | ||
} | } | ||
| Line 2,696: | Line 2,562: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'VideoLibrary.Export', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': undefined /* string */ | 'result': undefined /* string */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | ===VideoLibrary.GetEpisodeDetails=== | ||
Retrieve details about a specific tv show episode | |||
====Permissions==== | ====Permissions==== | ||
ReadData | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'VideoLibrary.GetEpisodeDetails', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
' | 'episodeid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | ||
' | 'properties': [ /* id: Video.Fields.Episode */ | ||
undefined /* string, Requesting the cast and/or resume field will result in increased response times */ | |||
undefined /* string, | |||
] | ] | ||
} | } | ||
| Line 2,741: | Line 2,589: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'VideoLibrary.GetEpisodeDetails', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': | 'result': { | ||
'episodedetails': { /* id: Video.Details.Episode */ | |||
'cast': [ /* array, id: Video.Cast */ | |||
{ /* no additional properties allowed */ | |||
'name': undefined /* string, required */, | |||
'role': undefined /* string, required */, | |||
'thumbnail': '' /* string */ | |||
} | |||
], | |||
{ | 'episode': 0 /* integer */, | ||
'episodeid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | |||
'firstaired': '' /* string */, | |||
'originaltitle': '' /* string */, | |||
'productioncode': '' /* string */, | |||
'rating': 0 /* number */, | |||
'season': 0 /* integer */, | |||
'showtitle': '' /* string */, | |||
'tvshowid': -1 /* integer, id: Library.Id, minimum: 1 */, | |||
'votes': '' /* string */, | |||
'writer': '' /* string */, | |||
'director': '' /* string */, | |||
'resume': { /* id: Video.Resume, no additional properties allowed */ | |||
'position': 0 /* number, minimum: 0 */, | |||
'total': 0 /* number, minimum: 0 */ | |||
}, | |||
'runtime': '' /* string */, | |||
'streamdetails': { /* id: Video.Streams, no additional properties allowed */ | |||
'audio': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'channels': 0 /* integer */, | |||
'codec': '' /* string */, | |||
'language': '' /* string */ | |||
} | |||
], | |||
'subtitle': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'language': '' /* string */ | |||
} | |||
], | |||
'video': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'aspect': 0 /* number */, | |||
'codec': '' /* string */, | |||
'duration': 0 /* integer */, | |||
'height': 0 /* integer */, | |||
'width': 0 /* integer */ | |||
} | |||
] | |||
}, | |||
'file': '' /* string */, | |||
'lastplayed': '' /* string */, | |||
'plot': '' /* string */, | |||
'title': '' /* string */, | |||
'playcount': 0 /* integer */, | |||
'fanart': '' /* string */, | |||
'thumbnail': '' /* string */, | |||
'label': undefined /* string, required */ | |||
} | |||
} | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=VideoLibrary= | ===VideoLibrary.GetEpisodes=== | ||
Retrieve all tv show episodes | |||
== | ====Permissions==== | ||
= | ReadData | ||
====Syntax==== | |||
==== | |||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetEpisodes', | ||
' | 'id': undefined /* integer, required */, | ||
' | 'params': { | ||
' | 'tvshowid': -1 /* integer, id: Library.Id, minimum: 1 */, | ||
'season': -1 /* integer, minimum: 0 */, | |||
'properties': [ /* id: Video.Fields.Episode */ | |||
undefined /* string, Requesting the cast and/or resume field will result in increased response times */ | |||
], | |||
'limits': { /* id: List.Limits, no additional properties allowed */ | |||
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */, | |||
'start': 0 /* integer, minimum: 0 */ | |||
}, | |||
'sort': { /* id: List.Sort */ | |||
'ignorearticle': false /* boolean */, | |||
'method': 'none' /* string */, | |||
'order': 'ascending' /* string */ | |||
} | |||
} | } | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
====Returns==== | ====Returns==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetEpisodes', | ||
' | 'id': undefined /* integer, required */, | ||
} | 'result': { | ||
'episodes': [ /* array */ | |||
{ /* id: Video.Details.Episode */ | |||
'cast': [ /* array, id: Video.Cast */ | |||
{ /* no additional properties allowed */ | |||
'name': undefined /* string, required */, | |||
'role': undefined /* string, required */, | |||
'thumbnail': '' /* string */ | |||
} | |||
], | |||
'episode': 0 /* integer */, | |||
'episodeid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | |||
'firstaired': '' /* string */, | |||
'originaltitle': '' /* string */, | |||
'productioncode': '' /* string */, | |||
'rating': 0 /* number */, | |||
'season': 0 /* integer */, | |||
'showtitle': '' /* string */, | |||
'tvshowid': -1 /* integer, id: Library.Id, minimum: 1 */, | |||
'votes': '' /* string */, | |||
'writer': '' /* string */, | |||
'director': '' /* string */, | |||
'resume': { /* id: Video.Resume, no additional properties allowed */ | |||
'position': 0 /* number, minimum: 0 */, | |||
'total': 0 /* number, minimum: 0 */ | |||
}, | |||
'runtime': '' /* string */, | |||
'streamdetails': { /* id: Video.Streams, no additional properties allowed */ | |||
'audio': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'channels': 0 /* integer */, | |||
'codec': '' /* string */, | |||
'language': '' /* string */ | |||
} | |||
], | |||
'subtitle': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'language': '' /* string */ | |||
} | |||
], | |||
'video': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'aspect': 0 /* number */, | |||
'codec': '' /* string */, | |||
'duration': 0 /* integer */, | |||
'height': 0 /* integer */, | |||
'width': 0 /* integer */ | |||
} | |||
] | |||
}, | |||
'file': '' /* string */, | |||
'lastplayed': '' /* string */, | |||
'plot': '' /* string */, | |||
'title': '' /* string */, | |||
'playcount': 0 /* integer */, | |||
'fanart': '' /* string */, | |||
'thumbnail': '' /* string */, | |||
'label': undefined /* string, required */ | |||
} | |||
], | |||
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */ | |||
'end': -1 /* integer, minimum: 0 */, | |||
'start': 0 /* integer, minimum: 0 */, | |||
'total': undefined /* integer, required, minimum: 0 */ | |||
} | |||
} | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===VideoLibrary.GetGenres=== | |||
Retrieve all genres | |||
====Permissions==== | |||
ReadData | |||
===VideoLibrary. | |||
====Permissions==== | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetGenres', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
' | 'type': undefined /* string, required */, | ||
' | 'properties': [ /* id: Library.Fields.Genre */ | ||
} | undefined /* string */ | ||
' | ], | ||
' | 'limits': { /* id: List.Limits, no additional properties allowed */ | ||
' | 'end': -1 /* integer, minimum: 0, The number of items in the list being returned */, | ||
'start': 0 /* integer, minimum: 0 */ | |||
}, | |||
'sort': { /* id: List.Sort */ | |||
'ignorearticle': false /* boolean */, | |||
'method': 'none' /* string */, | |||
'order': 'ascending' /* string */ | |||
} | } | ||
} | } | ||
| Line 2,877: | Line 2,785: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetGenres', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': undefined /* string */ | 'result': { | ||
} | 'genres': [ /* array, required */ | ||
</syntaxhighlight> | { /* id: Library.Details.Genre */ | ||
===VideoLibrary. | 'genreid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | ||
Retrieve details about a specific | 'thumbnail': '' /* string */, | ||
'title': '' /* string */, | |||
'label': undefined /* string, required */ | |||
} | |||
], | |||
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */ | |||
'end': -1 /* integer, minimum: 0 */, | |||
'start': 0 /* integer, minimum: 0 */, | |||
'total': undefined /* integer, required, minimum: 0 */ | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
===VideoLibrary.GetMovieDetails=== | |||
Retrieve details about a specific movie | |||
====Permissions==== | ====Permissions==== | ||
ReadData | ReadData | ||
| Line 2,890: | Line 2,812: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetMovieDetails', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
' | 'movieid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | ||
'properties': [ /* id: Video.Fields. | 'properties': [ /* id: Video.Fields.Movie */ | ||
undefined /* string, Requesting the cast and/or resume field will result in increased response times */ | undefined /* string, Requesting the cast, set, showling and/or resume field will result in increased response times */ | ||
] | ] | ||
} | } | ||
| Line 2,904: | Line 2,826: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetMovieDetails', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': { | 'result': { | ||
' | 'moviedetails': { /* id: Video.Details.Movie */ | ||
'cast': [ /* array, id: Video.Cast */ | 'cast': [ /* array, id: Video.Cast */ | ||
{ /* no additional properties allowed */ | { /* no additional properties allowed */ | ||
| Line 2,915: | Line 2,837: | ||
} | } | ||
], | ], | ||
' | 'country': '' /* string */, | ||
' | 'genre': '' /* string */, | ||
' | 'imdbnumber': '' /* string */, | ||
'movieid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | |||
'mpaa': '' /* string */, | |||
'originaltitle': '' /* string */, | 'originaltitle': '' /* string */, | ||
'plotoutline': '' /* string */, | |||
'premiered': '' /* string */, | |||
'productioncode': '' /* string */, | 'productioncode': '' /* string */, | ||
'rating': 0 /* number */, | 'rating': 0 /* number */, | ||
' | 'set': [ /* array, id: Array.String */ | ||
' | undefined /* string, minimum length: 1 */ | ||
' | ], | ||
'setid': [ /* array, id: Array.Integer */ | |||
undefined /* integer */ | |||
], | |||
'showlink': '' /* string */, | |||
'sorttitle': '' /* string */, | |||
'studio': '' /* string */, | |||
'tagline': '' /* string */, | |||
'top250': 0 /* integer */, | |||
'trailer': '' /* string */, | |||
'votes': '' /* string */, | 'votes': '' /* string */, | ||
'writer': '' /* string */, | 'writer': '' /* string */, | ||
'year': 0 /* integer */, | |||
'director': '' /* string */, | 'director': '' /* string */, | ||
'resume': { /* id: Video.Resume, no additional properties allowed */ | 'resume': { /* id: Video.Resume, no additional properties allowed */ | ||
| Line 2,955: | Line 2,891: | ||
] | ] | ||
}, | }, | ||
'file': '' /* string */, | 'file': '' /* string */, | ||
'lastplayed': '' /* string */, | 'lastplayed': '' /* string */, | ||
| Line 2,968: | Line 2,903: | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===VideoLibrary. | ===VideoLibrary.GetMovieSetDetails=== | ||
Retrieve | Retrieve details about a specific movie set | ||
====Permissions==== | ====Permissions==== | ||
ReadData | ReadData | ||
| Line 2,976: | Line 2,911: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetMovieSetDetails', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
' | 'setid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | ||
'properties': [ /* id: Video.Fields.MovieSet */ | |||
'properties': [ /* id: Video.Fields. | undefined /* string */ | ||
undefined /* string | |||
], | ], | ||
'limits': { /* id: List.Limits, no additional properties allowed */ | 'movies': { | ||
'limits': { /* id: List.Limits, no additional properties allowed */ | |||
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */, | |||
'start': 0 /* integer, minimum: 0 */ | |||
}, | |||
'properties': [ /* id: Video.Fields.Movie */ | |||
undefined /* string, Requesting the cast, set, showling and/or resume field will result in increased response times */ | |||
], | |||
} | 'sort': { /* id: List.Sort */ | ||
} | 'ignorearticle': false /* boolean */, | ||
'method': 'none' /* string */, | |||
'order': 'ascending' /* string */ | |||
} | |||
} | |||
} | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 3,000: | Line 2,939: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetMovieSetDetails', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': { | 'result': { | ||
' | 'setdetails': { /* id: Video.Details.MovieSet.Extended */ | ||
'movies': [ /* array */ | |||
{ /* id: Video.Details.Movie */ | |||
'cast': [ /* array, id: Video.Cast */ | |||
' | |||
{ /* no additional properties allowed */ | { /* no additional properties allowed */ | ||
' | 'name': undefined /* string, required */, | ||
' | 'role': undefined /* string, required */, | ||
' | 'thumbnail': '' /* string */ | ||
} | } | ||
], | ], | ||
' | 'country': '' /* string */, | ||
'genre': '' /* string */, | |||
'imdbnumber': '' /* string */, | |||
'movieid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | |||
'mpaa': '' /* string */, | |||
'originaltitle': '' /* string */, | |||
'plotoutline': '' /* string */, | |||
'premiered': '' /* string */, | |||
'productioncode': '' /* string */, | |||
'rating': 0 /* number */, | |||
'set': [ /* array, id: Array.String */ | |||
undefined /* string, minimum length: 1 */ | |||
], | |||
'setid': [ /* array, id: Array.Integer */ | |||
undefined /* integer */ | |||
], | ], | ||
' | 'showlink': '' /* string */, | ||
{ /* no additional properties allowed */ | 'sorttitle': '' /* string */, | ||
'aspect': 0 /* number */, | 'studio': '' /* string */, | ||
'tagline': '' /* string */, | |||
'top250': 0 /* integer */, | |||
'trailer': '' /* string */, | |||
'votes': '' /* string */, | |||
'writer': '' /* string */, | |||
'year': 0 /* integer */, | |||
'director': '' /* string */, | |||
'resume': { /* id: Video.Resume, no additional properties allowed */ | |||
'position': 0 /* number, minimum: 0 */, | |||
'total': 0 /* number, minimum: 0 */ | |||
}, | |||
'runtime': '' /* string */, | |||
'streamdetails': { /* id: Video.Streams, no additional properties allowed */ | |||
'audio': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'channels': 0 /* integer */, | |||
'codec': '' /* string */, | |||
'language': '' /* string */ | |||
} | |||
' | ], | ||
' | 'subtitle': [ /* array, minimum items: 1 */ | ||
' | { /* no additional properties allowed */ | ||
} | 'language': '' /* string */ | ||
} | } | ||
} | ], | ||
</syntaxhighlight> | 'video': [ /* array, minimum items: 1 */ | ||
===VideoLibrary. | { /* no additional properties allowed */ | ||
Retrieve all | 'aspect': 0 /* number */, | ||
====Permissions==== | 'codec': '' /* string */, | ||
ReadData | 'duration': 0 /* integer */, | ||
====Syntax==== | 'height': 0 /* integer */, | ||
'width': 0 /* integer */ | |||
} | |||
] | |||
}, | |||
'file': '' /* string */, | |||
'lastplayed': '' /* string */, | |||
'plot': '' /* string */, | |||
'title': '' /* string */, | |||
'playcount': 0 /* integer */, | |||
'fanart': '' /* string */, | |||
'thumbnail': '' /* string */, | |||
'label': undefined /* string, required */ | |||
} | |||
], | |||
'setid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | |||
'title': '' /* string */, | |||
'playcount': 0 /* integer */, | |||
'fanart': '' /* string */, | |||
'thumbnail': '' /* string */, | |||
'label': undefined /* string, required */ | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
===VideoLibrary.GetMovieSets=== | |||
Retrieve all movie sets | |||
====Permissions==== | |||
ReadData | |||
====Syntax==== | |||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetMovieSets', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
'properties': [ /* id: Video.Fields.MovieSet */ | |||
'properties': [ /* id: | |||
undefined /* string */ | undefined /* string */ | ||
], | ], | ||
| Line 3,102: | Line 3,056: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetMovieSets', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': { | 'result': { | ||
' | 'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */ | ||
{ /* id: | 'end': -1 /* integer, minimum: 0 */, | ||
' | 'start': 0 /* integer, minimum: 0 */, | ||
'total': undefined /* integer, required, minimum: 0 */ | |||
}, | |||
'sets': [ /* array */ | |||
{ /* id: Video.Details.MovieSet */ | |||
'setid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | |||
'title': '' /* string */, | |||
'playcount': 0 /* integer */, | |||
'fanart': '' /* string */, | |||
'thumbnail': '' /* string */, | 'thumbnail': '' /* string */, | ||
'label': undefined /* string, required */ | 'label': undefined /* string, required */ | ||
} | } | ||
] | ] | ||
} | } | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===VideoLibrary. | ===VideoLibrary.GetMovies=== | ||
Retrieve | Retrieve all movies | ||
====Permissions==== | ====Permissions==== | ||
ReadData | ReadData | ||
| Line 3,129: | Line 3,085: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetMovies', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
'properties': [ /* id: Video.Fields.Movie */ | 'properties': [ /* id: Video.Fields.Movie */ | ||
undefined /* string, Requesting the cast, set, showling and/or resume field will result in increased response times */ | undefined /* string, Requesting the cast, set, showling and/or resume field will result in increased response times */ | ||
] | ], | ||
'limits': { /* id: List.Limits, no additional properties allowed */ | |||
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */, | |||
'start': 0 /* integer, minimum: 0 */ | |||
}, | |||
'sort': { /* id: List.Sort */ | |||
'ignorearticle': false /* boolean */, | |||
'method': 'none' /* string */, | |||
'order': 'ascending' /* string */ | |||
} | |||
} | } | ||
} | } | ||
| Line 3,143: | Line 3,107: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetMovies', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': { | 'result': { | ||
' | 'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */ | ||
'end': -1 /* integer, minimum: 0 */, | |||
'start': 0 /* integer, minimum: 0 */, | |||
'total': undefined /* integer, required, minimum: 0 */ | |||
}, | |||
'movies': [ /* array */ | |||
{ /* id: Video.Details.Movie */ | |||
'cast': [ /* array, id: Video.Cast */ | |||
' | |||
' | |||
' | |||
' | |||
{ /* no additional properties allowed */ | { /* no additional properties allowed */ | ||
' | 'name': undefined /* string, required */, | ||
' | 'role': undefined /* string, required */, | ||
' | 'thumbnail': '' /* string */ | ||
} | } | ||
], | ], | ||
' | 'country': '' /* string */, | ||
'genre': '' /* string */, | |||
'imdbnumber': '' /* string */, | |||
'movieid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | |||
'mpaa': '' /* string */, | |||
'originaltitle': '' /* string */, | |||
'plotoutline': '' /* string */, | |||
'premiered': '' /* string */, | |||
'productioncode': '' /* string */, | |||
'rating': 0 /* number */, | |||
'set': [ /* array, id: Array.String */ | |||
undefined /* string, minimum length: 1 */ | |||
], | |||
'setid': [ /* array, id: Array.Integer */ | |||
undefined /* integer */ | |||
], | ], | ||
' | 'showlink': '' /* string */, | ||
'sorttitle': '' /* string */, | |||
'studio': '' /* string */, | |||
'tagline': '' /* string */, | |||
'top250': 0 /* integer */, | |||
'trailer': '' /* string */, | |||
'votes': '' /* string */, | |||
'writer': '' /* string */, | |||
'year': 0 /* integer */, | |||
'director': '' /* string */, | |||
'resume': { /* id: Video.Resume, no additional properties allowed */ | |||
'position': 0 /* number, minimum: 0 */, | |||
'total': 0 /* number, minimum: 0 */ | |||
}, | |||
'runtime': '' /* string */, | |||
'streamdetails': { /* id: Video.Streams, no additional properties allowed */ | |||
'audio': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'channels': 0 /* integer */, | |||
'codec': '' /* string */, | |||
'language': '' /* string */ | |||
} | |||
], | |||
'subtitle': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'language': '' /* string */ | |||
} | |||
], | |||
'video': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'aspect': 0 /* number */, | |||
'codec': '' /* string */, | |||
'duration': 0 /* integer */, | |||
'height': 0 /* integer */, | |||
'width': 0 /* integer */ | |||
} | |||
] | |||
}, | |||
'file': '' /* string */, | |||
'lastplayed': '' /* string */, | |||
'plot': '' /* string */, | |||
'title': '' /* string */, | |||
'playcount': 0 /* integer */, | |||
'fanart': '' /* string */, | |||
'thumbnail': '' /* string */, | |||
'label': undefined /* string, required */ | |||
' | |||
' | |||
' | |||
} | } | ||
] | |||
} | } | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==== | ===VideoLibrary.GetMusicVideoDetails=== | ||
Retrieve details about a specific music video | |||
====Permissions==== | |||
ReadData | |||
====Syntax==== | |||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetMusicVideoDetails', | ||
'id': undefined /* integer, required */, | |||
'params': { | |||
'musicvideoid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | |||
'properties': [ /* id: Video.Fields.MusicVideo */ | |||
undefined /* string, Requesting the resume field will result in increased response times */ | |||
] | |||
} | |||
} | |||
</syntaxhighlight> | |||
====Returns==== | |||
<syntaxhighlight lang="javascript"> | |||
{ | |||
'jsonrpc': '2.0', | |||
'method': 'VideoLibrary.GetMusicVideoDetails', | |||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': { | 'result': { | ||
' | 'musicvideodetails': { /* id: Video.Details.MusicVideo */ | ||
' | 'album': '' /* string */, | ||
'artist': '' /* string */, | |||
'genre': '' /* string */, | |||
'musicvideoid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | |||
'studio': '' /* string */, | |||
'track': 0 /* integer */, | |||
'year': 0 /* integer */, | |||
'director': '' /* string */, | |||
'resume': { /* id: Video.Resume, no additional properties allowed */ | |||
'position': 0 /* number, minimum: 0 */, | |||
'total': 0 /* number, minimum: 0 */ | |||
}, | |||
'runtime': '' /* string */, | |||
'streamdetails': { /* id: Video.Streams, no additional properties allowed */ | |||
'audio': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'channels': 0 /* integer */, | |||
'codec': '' /* string */, | |||
'language': '' /* string */ | |||
} | |||
], | |||
'subtitle': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'language': '' /* string */ | |||
} | |||
], | |||
'video': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'aspect': 0 /* number */, | |||
'codec': '' /* string */, | |||
'duration': 0 /* integer */, | |||
'height': 0 /* integer */, | |||
'width': 0 /* integer */ | |||
} | |||
] | |||
}, | |||
'file': '' /* string */, | |||
'lastplayed': '' /* string */, | |||
'plot': '' /* string */, | |||
'title': '' /* string */, | |||
'playcount': 0 /* integer */, | |||
'fanart': '' /* string */, | |||
'thumbnail': '' /* string */, | |||
'label': undefined /* string, required */ | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
===VideoLibrary.GetMusicVideos=== | |||
Retrieve all music videos | |||
====Permissions==== | |||
ReadData | |||
====Syntax==== | |||
<syntaxhighlight lang="javascript"> | |||
{ | |||
'jsonrpc': '2.0', | |||
'method': 'VideoLibrary.GetMusicVideos', | |||
'title': '' /* string */, | |||
'playcount': 0 /* integer */, | |||
'fanart': '' /* string */, | |||
'thumbnail': '' /* string */, | |||
'label': undefined /* string, required */ | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
===VideoLibrary. | |||
Retrieve all | |||
====Permissions==== | |||
ReadData | |||
====Syntax==== | |||
<syntaxhighlight lang="javascript"> | |||
{ | |||
'jsonrpc': '2.0', | |||
'method': 'VideoLibrary. | |||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
'properties': [ /* id: Video.Fields. | 'artistid': -1 /* integer, id: Library.Id, minimum: 1 */, | ||
undefined /* string */ | 'albumid': -1 /* integer, id: Library.Id, minimum: 1 */, | ||
'properties': [ /* id: Video.Fields.MusicVideo */ | |||
undefined /* string, Requesting the resume field will result in increased response times */ | |||
], | ], | ||
'limits': { /* id: List.Limits, no additional properties allowed */ | 'limits': { /* id: List.Limits, no additional properties allowed */ | ||
| Line 3,375: | Line 3,297: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetMusicVideos', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': { | 'result': { | ||
| Line 3,383: | Line 3,305: | ||
'total': undefined /* integer, required, minimum: 0 */ | 'total': undefined /* integer, required, minimum: 0 */ | ||
}, | }, | ||
' | 'musicvideos': [ /* array */ | ||
{ /* id: Video.Details. | { /* id: Video.Details.MusicVideo */ | ||
' | 'album': '' /* string */, | ||
'title': '' /* string */, | 'artist': '' /* string */, | ||
'playcount': 0 /* integer */, | 'genre': '' /* string */, | ||
'fanart': '' /* string */, | 'musicvideoid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | ||
'thumbnail': '' /* string */, | 'studio': '' /* string */, | ||
'label': undefined /* string, required */ | 'track': 0 /* integer */, | ||
} | 'year': 0 /* integer */, | ||
] | 'director': '' /* string */, | ||
} | 'resume': { /* id: Video.Resume, no additional properties allowed */ | ||
} | 'position': 0 /* number, minimum: 0 */, | ||
</syntaxhighlight> | 'total': 0 /* number, minimum: 0 */ | ||
===VideoLibrary. | }, | ||
Retrieve all | 'runtime': '' /* string */, | ||
====Permissions==== | 'streamdetails': { /* id: Video.Streams, no additional properties allowed */ | ||
ReadData | 'audio': [ /* array, minimum items: 1 */ | ||
====Syntax==== | { /* no additional properties allowed */ | ||
<syntaxhighlight lang="javascript"> | 'channels': 0 /* integer */, | ||
{ | 'codec': '' /* string */, | ||
'language': '' /* string */ | |||
} | |||
], | |||
'subtitle': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'language': '' /* string */ | |||
} | |||
], | |||
'video': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'aspect': 0 /* number */, | |||
'codec': '' /* string */, | |||
'duration': 0 /* integer */, | |||
'height': 0 /* integer */, | |||
'width': 0 /* integer */ | |||
} | |||
] | |||
}, | |||
'file': '' /* string */, | |||
'lastplayed': '' /* string */, | |||
'plot': '' /* string */, | |||
'title': '' /* string */, | |||
'playcount': 0 /* integer */, | |||
'fanart': '' /* string */, | |||
'thumbnail': '' /* string */, | |||
'label': undefined /* string, required */ | |||
} | |||
] | |||
} | |||
} | |||
</syntaxhighlight> | |||
===VideoLibrary.GetRecentlyAddedEpisodes=== | |||
Retrieve all recently added tv episodes | |||
====Permissions==== | |||
ReadData | |||
====Syntax==== | |||
<syntaxhighlight lang="javascript"> | |||
{ | |||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetRecentlyAddedEpisodes', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
'properties': [ /* id: Video.Fields. | 'properties': [ /* id: Video.Fields.Episode */ | ||
undefined /* string, Requesting the cast | undefined /* string, Requesting the cast and/or resume field will result in increased response times */ | ||
], | ], | ||
'limits': { /* id: List.Limits, no additional properties allowed */ | 'limits': { /* id: List.Limits, no additional properties allowed */ | ||
| Line 3,426: | Line 3,386: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetRecentlyAddedEpisodes', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': { | 'result': { | ||
' | 'episodes': [ /* array */ | ||
{ /* id: Video.Details.Episode */ | |||
{ /* id: Video.Details. | |||
'cast': [ /* array, id: Video.Cast */ | 'cast': [ /* array, id: Video.Cast */ | ||
{ /* no additional properties allowed */ | { /* no additional properties allowed */ | ||
| Line 3,443: | Line 3,398: | ||
} | } | ||
], | ], | ||
' | 'episode': 0 /* integer */, | ||
'episodeid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | |||
'firstaired': '' /* string */, | |||
' | |||
' | |||
'originaltitle': '' /* string */, | 'originaltitle': '' /* string */, | ||
'productioncode': '' /* string */, | 'productioncode': '' /* string */, | ||
'rating': 0 /* number */, | 'rating': 0 /* number */, | ||
' | 'season': 0 /* integer */, | ||
'showtitle': '' /* string */, | |||
'tvshowid': -1 /* integer, id: Library.Id, minimum: 1 */, | |||
' | |||
' | |||
'votes': '' /* string */, | 'votes': '' /* string */, | ||
'writer': '' /* string */, | 'writer': '' /* string */, | ||
'director': '' /* string */, | 'director': '' /* string */, | ||
'resume': { /* id: Video.Resume, no additional properties allowed */ | 'resume': { /* id: Video.Resume, no additional properties allowed */ | ||
| Line 3,497: | Line 3,438: | ||
] | ] | ||
}, | }, | ||
'file': '' /* string */, | 'file': '' /* string */, | ||
'lastplayed': '' /* string */, | 'lastplayed': '' /* string */, | ||
| Line 3,507: | Line 3,447: | ||
'label': undefined /* string, required */ | 'label': undefined /* string, required */ | ||
} | } | ||
] | ], | ||
} | 'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */ | ||
} | 'end': -1 /* integer, minimum: 0 */, | ||
'start': 0 /* integer, minimum: 0 */, | |||
'total': undefined /* integer, required, minimum: 0 */ | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===VideoLibrary. | ===VideoLibrary.GetRecentlyAddedMovies=== | ||
Retrieve | Retrieve all recently added movies | ||
====Permissions==== | ====Permissions==== | ||
ReadData | ReadData | ||
| Line 3,519: | Line 3,464: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetRecentlyAddedMovies', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
' | 'properties': [ /* id: Video.Fields.Movie */ | ||
' | undefined /* string, Requesting the cast, set, showling and/or resume field will result in increased response times */ | ||
], | |||
'limits': { /* id: List.Limits, no additional properties allowed */ | |||
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */, | |||
'start': 0 /* integer, minimum: 0 */ | |||
}, | |||
'sort': { /* id: List.Sort */ | |||
'ignorearticle': false /* boolean */, | |||
'method': 'none' /* string */, | |||
'order': 'ascending' /* string */ | |||
} | |||
} | } | ||
} | } | ||
| Line 3,533: | Line 3,486: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetRecentlyAddedMovies', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': { | 'result': { | ||
' | 'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */ | ||
'end': -1 /* integer, minimum: 0 */, | |||
'start': 0 /* integer, minimum: 0 */, | |||
'total': undefined /* integer, required, minimum: 0 */ | |||
' | }, | ||
'movies': [ /* array */ | |||
{ /* id: Video.Details.Movie */ | |||
' | 'cast': [ /* array, id: Video.Cast */ | ||
' | |||
{ /* no additional properties allowed */ | { /* no additional properties allowed */ | ||
' | 'name': undefined /* string, required */, | ||
' | 'role': undefined /* string, required */, | ||
' | 'thumbnail': '' /* string */ | ||
} | } | ||
], | ], | ||
' | 'country': '' /* string */, | ||
'genre': '' /* string */, | |||
'imdbnumber': '' /* string */, | |||
'movieid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | |||
'mpaa': '' /* string */, | |||
'originaltitle': '' /* string */, | |||
'plotoutline': '' /* string */, | |||
'premiered': '' /* string */, | |||
'productioncode': '' /* string */, | |||
'rating': 0 /* number */, | |||
'set': [ /* array, id: Array.String */ | |||
undefined /* string, minimum length: 1 */ | |||
], | |||
'setid': [ /* array, id: Array.Integer */ | |||
undefined /* integer */ | |||
], | ], | ||
' | 'showlink': '' /* string */, | ||
{ /* no additional properties allowed */ | 'sorttitle': '' /* string */, | ||
'aspect': 0 /* number */, | 'studio': '' /* string */, | ||
'tagline': '' /* string */, | |||
'top250': 0 /* integer */, | |||
'trailer': '' /* string */, | |||
'votes': '' /* string */, | |||
'writer': '' /* string */, | |||
'year': 0 /* integer */, | |||
'director': '' /* string */, | |||
'resume': { /* id: Video.Resume, no additional properties allowed */ | |||
'position': 0 /* number, minimum: 0 */, | |||
'total': 0 /* number, minimum: 0 */ | |||
}, | |||
'runtime': '' /* string */, | |||
'streamdetails': { /* id: Video.Streams, no additional properties allowed */ | |||
'audio': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'channels': 0 /* integer */, | |||
'codec': '' /* string */, | |||
} | 'language': '' /* string */ | ||
} | } | ||
</syntaxhighlight> | ], | ||
===VideoLibrary. | 'subtitle': [ /* array, minimum items: 1 */ | ||
Retrieve all music videos | { /* no additional properties allowed */ | ||
====Permissions==== | 'language': '' /* string */ | ||
ReadData | } | ||
], | |||
'video': [ /* array, minimum items: 1 */ | |||
{ /* no additional properties allowed */ | |||
'aspect': 0 /* number */, | |||
'codec': '' /* string */, | |||
'duration': 0 /* integer */, | |||
'height': 0 /* integer */, | |||
'width': 0 /* integer */ | |||
} | |||
] | |||
}, | |||
'file': '' /* string */, | |||
'lastplayed': '' /* string */, | |||
'plot': '' /* string */, | |||
'title': '' /* string */, | |||
'playcount': 0 /* integer */, | |||
'fanart': '' /* string */, | |||
'thumbnail': '' /* string */, | |||
'label': undefined /* string, required */ | |||
} | |||
] | |||
} | |||
} | |||
</syntaxhighlight> | |||
===VideoLibrary.GetRecentlyAddedMusicVideos=== | |||
Retrieve all recently added music videos | |||
====Permissions==== | |||
ReadData | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetRecentlyAddedMusicVideos', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
'properties': [ /* id: Video.Fields.MusicVideo */ | 'properties': [ /* id: Video.Fields.MusicVideo */ | ||
undefined /* string, Requesting the resume field will result in increased response times */ | undefined /* string, Requesting the resume field will result in increased response times */ | ||
| Line 3,618: | Line 3,600: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetRecentlyAddedMusicVideos', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': { | 'result': { | ||
| Line 3,664: | Line 3,646: | ||
] | ] | ||
}, | }, | ||
'file': '' /* string */, | 'file': '' /* string */, | ||
'lastplayed': '' /* string */, | 'lastplayed': '' /* string */, | ||
| Line 3,678: | Line 3,659: | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===VideoLibrary. | ===VideoLibrary.GetSeasons=== | ||
Retrieve all | Retrieve all tv seasons | ||
====Permissions==== | ====Permissions==== | ||
ReadData | ReadData | ||
| Line 3,686: | Line 3,667: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetSeasons', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
'properties': [ /* id: Video.Fields. | 'tvshowid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | ||
undefined /* string | 'properties': [ /* id: Video.Fields.Season */ | ||
undefined /* string */ | |||
], | ], | ||
'limits': { /* id: List.Limits, no additional properties allowed */ | 'limits': { /* id: List.Limits, no additional properties allowed */ | ||
| Line 3,708: | Line 3,690: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetSeasons', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': { | 'result': { | ||
' | 'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */ | ||
'end': -1 /* integer, minimum: 0 */, | |||
'start': 0 /* integer, minimum: 0 */, | |||
'total': undefined /* integer, required, minimum: 0 */ | |||
}, | |||
'seasons': [ /* array */ | |||
{ /* id: Video.Details.Season */ | |||
'episode': 0 /* integer */, | 'episode': 0 /* integer */, | ||
' | 'season': undefined /* integer, required */, | ||
'showtitle': '' /* string */, | 'showtitle': '' /* string */, | ||
'tvshowid': -1 /* integer, id: Library.Id, minimum: 1 */, | 'tvshowid': -1 /* integer, id: Library.Id, minimum: 1 */, | ||
'playcount': 0 /* integer */, | |||
'fanart': '' /* string */, | |||
'thumbnail': '' /* string */, | |||
'label': undefined /* string, required */ | |||
} | |||
] | |||
} | |||
'playcount': 0 /* integer */, | |||
'fanart': '' /* string */, | |||
'thumbnail': '' /* string */, | |||
'label': undefined /* string, required */ | |||
} | |||
] | |||
} | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===VideoLibrary. | ===VideoLibrary.GetTVShowDetails=== | ||
Retrieve | Retrieve details about a specific tv show | ||
====Permissions==== | ====Permissions==== | ||
ReadData | ReadData | ||
| Line 3,787: | Line 3,721: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetTVShowDetails', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
' | 'tvshowid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | ||
'properties': [ /* id: Video.Fields.TVShow */ | |||
undefined /* string, Requesting the cast field will result in increased response times */ | |||
] | |||
' | |||
} | } | ||
} | } | ||
| Line 3,809: | Line 3,735: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetTVShowDetails', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': { | 'result': { | ||
' | 'tvshowdetails': { /* id: Video.Details.TVShow */ | ||
'cast': [ /* array, id: Video.Cast */ | |||
{ /* no additional properties allowed */ | |||
'name': undefined /* string, required */, | |||
'role': undefined /* string, required */, | |||
'thumbnail': '' /* string */ | |||
} | |||
], | |||
'episode': 0 /* integer */, | |||
'episodeguide': '' /* string */, | |||
'genre': '' /* string */, | |||
'imdbnumber': '' /* string */, | |||
'mpaa': '' /* string */, | |||
'originaltitle': '' /* string */, | |||
'premiered': '' /* string */, | |||
'rating': 0 /* number */, | |||
'sorttitle': '' /* string */, | |||
'studio': '' /* string */, | |||
'tvshowid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | |||
'votes': '' /* string */, | |||
'year': 0 /* integer */, | |||
'file': '' /* string */, | |||
'lastplayed': '' /* string */, | |||
'plot': '' /* string */, | |||
'title': '' /* string */, | |||
'playcount': 0 /* integer */, | |||
'fanart': '' /* string */, | |||
'thumbnail': '' /* string */, | |||
'label': undefined /* string, required */ | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
===VideoLibrary.GetTVShows=== | |||
Retrieve all tv shows | |||
====Permissions==== | |||
ReadData | |||
====Syntax==== | |||
<syntaxhighlight lang="javascript"> | |||
{ | |||
'jsonrpc': '2.0', | |||
'method': 'VideoLibrary.GetTVShows', | |||
'id': undefined /* integer, required */, | |||
'params': { | |||
'properties': [ /* id: Video.Fields.TVShow */ | |||
undefined /* string, Requesting the cast field will result in increased response times */ | |||
], | |||
'limits': { /* id: List.Limits, no additional properties allowed */ | |||
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */, | |||
'start': 0 /* integer, minimum: 0 */ | |||
}, | |||
'sort': { /* id: List.Sort */ | |||
'ignorearticle': false /* boolean */, | |||
'method': 'none' /* string */, | |||
'order': 'ascending' /* string */ | |||
} | |||
} | } | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | ====Returns==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.GetTVShows', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
' | 'result': { | ||
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */ | |||
'end': -1 /* integer, minimum: 0 */, | |||
'start': 0 /* integer, minimum: 0 */, | |||
'limits': { /* id: List. | 'total': undefined /* integer, required, minimum: 0 */ | ||
'end': -1 /* integer, minimum: 0 | |||
'start': 0 /* integer, minimum: 0 */ | |||
}, | }, | ||
' | 'tvshows': [ /* array */ | ||
{ /* id: Video.Details.TVShow */ | |||
'cast': [ /* array, id: Video.Cast */ | |||
{ /* no additional properties allowed */ | |||
'name': undefined /* string, required */, | |||
'role': undefined /* string, required */, | |||
'thumbnail': '' /* string */ | |||
} | |||
], | |||
'episode': 0 /* integer */, | |||
'episodeguide': '' /* string */, | |||
'genre': '' /* string */, | |||
'imdbnumber': '' /* string */, | |||
'mpaa': '' /* string */, | |||
'originaltitle': '' /* string */, | |||
'premiered': '' /* string */, | |||
'rating': 0 /* number */, | |||
'sorttitle': '' /* string */, | |||
'studio': '' /* string */, | |||
'tvshowid': -1 /* integer, required, id: Library.Id, minimum: 1 */, | |||
'votes': '' /* string */, | |||
'year': 0 /* integer */, | |||
'file': '' /* string */, | |||
'lastplayed': '' /* string */, | |||
'plot': '' /* string */, | |||
'title': '' /* string */, | |||
'playcount': 0 /* integer */, | |||
'fanart': '' /* string */, | |||
'thumbnail': '' /* string */, | |||
'label': undefined /* string, required */ | |||
} | |||
] | |||
} | } | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
====Returns==== | ===VideoLibrary.Scan=== | ||
Scans the video sources for new library items | |||
====Permissions==== | |||
UpdateData | |||
====Syntax==== | |||
<syntaxhighlight lang="javascript"> | |||
{ | |||
'jsonrpc': '2.0', | |||
'method': 'VideoLibrary.Scan', | |||
'id': undefined /* integer, required */ | |||
} | |||
</syntaxhighlight> | |||
====Returns==== | |||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': 'VideoLibrary. | 'method': 'VideoLibrary.Scan', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result | 'result': undefined /* string */ | ||
} | |||
</syntaxhighlight> | |||
=Input= | |||
Allows limited navigation within XBMC | |||
==Methods== | |||
===Input.Back=== | |||
Goes back in GUI | |||
====Permissions==== | |||
Navigate | |||
====Syntax==== | |||
<syntaxhighlight lang="javascript"> | |||
{ | |||
'jsonrpc': '2.0', | |||
'method': 'Input.Back', | |||
'id': undefined /* integer, required */ | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | ====Returns==== | ||
<syntaxhighlight lang="javascript"> | |||
{ | |||
'jsonrpc': '2.0', | |||
'method': 'Input.Back', | |||
'id': undefined /* integer, required */, | |||
'result': undefined /* string */ | |||
} | |||
</syntaxhighlight> | |||
===Input.Down=== | |||
Navigate down in GUI | |||
====Permissions==== | ====Permissions==== | ||
Navigate | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Input.Down', | ||
'id': undefined /* integer, required */ | 'id': undefined /* integer, required */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 4,015: | Line 3,905: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Input.Down', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result | 'result': undefined /* string */ | ||
} | |||
</syntaxhighlight> | |||
===Input.Home=== | |||
Goes to home window in GUI | |||
} | |||
</syntaxhighlight> | |||
=== | |||
====Permissions==== | ====Permissions==== | ||
Navigate | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Input.Home', | ||
'id': undefined /* integer, required */ | 'id': undefined /* integer, required */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 4,061: | Line 3,926: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Input.Home', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result | 'result': undefined /* string */ | ||
} | |||
</syntaxhighlight> | |||
===Input.Left=== | |||
Navigate left in GUI | |||
} | |||
</syntaxhighlight> | |||
=== | |||
====Permissions==== | ====Permissions==== | ||
Navigate | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Input.Left', | ||
'id': undefined /* integer, required */ | 'id': undefined /* integer, required */ | ||
' | } | ||
</syntaxhighlight> | |||
====Returns==== | |||
<syntaxhighlight lang="javascript"> | |||
{ | |||
'jsonrpc': '2.0', | |||
'method': 'Input.Left', | |||
'id': undefined /* integer, required */, | |||
'result': undefined /* string */ | |||
} | |||
</syntaxhighlight> | |||
===Input.Right=== | |||
Navigate right in GUI | |||
====Permissions==== | |||
Navigate | |||
====Syntax==== | |||
<syntaxhighlight lang="javascript"> | |||
{ | |||
'jsonrpc': '2.0', | |||
'method': 'Input.Right', | |||
'id': undefined /* integer, required */ | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 4,130: | Line 3,968: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Input.Right', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result | 'result': undefined /* string */ | ||
} | |||
</syntaxhighlight> | |||
===Input.Select=== | |||
Select current item in GUI | |||
====Permissions==== | |||
Navigate | |||
} | |||
</syntaxhighlight> | |||
=== | |||
====Permissions==== | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Input.Select', | ||
'id': undefined /* integer, required */ | 'id': undefined /* integer, required */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 4,195: | Line 3,989: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Input.Select', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': undefined /* string */ | 'result': undefined /* string */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | ===Input.Up=== | ||
Navigate up in GUI | |||
====Permissions==== | ====Permissions==== | ||
Navigate | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Input.Up', | ||
'id': undefined /* integer, required */ | 'id': undefined /* integer, required */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 4,219: | Line 4,010: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Input.Up', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': undefined /* string */ | 'result': undefined /* string */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | =Application= | ||
Application information and control | |||
==Methods== | |||
===Application.GetProperties=== | |||
Retrieves the values of the given properties | |||
====Permissions==== | ====Permissions==== | ||
ReadData | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Application.GetProperties', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
' | 'properties': [ /* array, required, all items must be unique */ | ||
'volume' /* string, id: Application.Property.Name */ | |||
] | |||
} | } | ||
} | } | ||
| Line 4,243: | Line 4,039: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Application.GetProperties', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': undefined /* string */ | 'result': { /* id: Application.Property.Value */ | ||
'muted': false /* boolean */, | |||
'name': '' /* string, minimum length: 1 */, | |||
'version': { | |||
'major': undefined /* integer, required, minimum: 0 */, | |||
'minor': undefined /* integer, required, minimum: 0 */, | |||
'revision': undefined /* string */ or undefined /* integer, minimum: 0 */, | |||
'tag': undefined /* string, required */ | |||
}, | |||
'volume': 0 /* integer */ | |||
} | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | ===Application.Quit=== | ||
Quit application | |||
====Permissions==== | ====Permissions==== | ||
ControlPower | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Application.Quit', | ||
'id': undefined /* integer, required */ | 'id': undefined /* integer, required */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 4,267: | Line 4,070: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Application.Quit', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': undefined /* string */ | 'result': undefined /* string */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | ===Application.SetMute=== | ||
Toggle mute/unmute | |||
====Permissions==== | ====Permissions==== | ||
ControlPlayback | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Application.SetMute', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
' | 'mute': undefined /* boolean */ or undefined /* string */ | ||
} | } | ||
} | } | ||
| Line 4,291: | Line 4,094: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Application.SetMute', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': undefined /* | 'result': undefined /* boolean, Mute state */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | ===Application.SetVolume=== | ||
Set the current volume | |||
====Permissions==== | ====Permissions==== | ||
ControlPlayback | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Application.SetVolume', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
' | 'volume': undefined /* integer, required, minimum: 0, maximum: 100 */ | ||
} | } | ||
} | } | ||
| Line 4,333: | Line 4,118: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'Application.SetVolume', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': undefined /* | 'result': undefined /* integer, minimum: 0 */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | =System= | ||
System controls and information | |||
=== | ==Notifications== | ||
===System.OnLowBattery=== | |||
==== | The system is on low battery. | ||
====Returns==== | |||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'System.OnLowBattery', | ||
'params': undefined /* string, required */ or undefined /* null, required */ | |||
'params | } | ||
} | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===System.OnQuit=== | |||
XBMC will be closed. | |||
====Returns==== | ====Returns==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'System.OnQuit', | ||
' | 'params': undefined /* string, required */ or undefined /* null, required */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | ===System.OnRestart=== | ||
The system will be restarted. | |||
====Returns==== | |||
==== | |||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'System.OnRestart', | ||
'params': undefined /* string, required */ or undefined /* null, required */ | |||
'params': | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===System.OnSleep=== | |||
The system will be suspended. | |||
====Returns==== | ====Returns==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'System.OnSleep', | ||
' | 'params': undefined /* string, required */ or undefined /* null, required */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | ===System.OnWake=== | ||
The system woke up from suspension. | |||
====Returns==== | |||
==== | |||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'System.OnWake', | ||
'params': undefined /* string, required */ or undefined /* null, required */ | |||
} | |||
</syntaxhighlight> | |||
==Methods== | |||
===System.GetProperties=== | |||
Retrieves the values of the given properties | |||
====Permissions==== | |||
ReadData | |||
====Syntax==== | |||
<syntaxhighlight lang="javascript"> | |||
{ | |||
'jsonrpc': '2.0', | |||
'method': 'System.GetProperties', | |||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'params': { | 'params': { | ||
' | 'properties': [ /* array, required, all items must be unique */ | ||
'canshutdown' /* string, id: System.Property.Name */ | |||
] | |||
] | |||
} | } | ||
} | } | ||
| Line 4,481: | Line 4,198: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'System.GetProperties', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': | 'result': { /* id: System.Property.Value */ | ||
'canhibernate': false /* boolean */, | |||
'canreboot': false /* boolean */, | |||
'canshutdown': false /* boolean */, | |||
'cansuspend': false /* boolean */ | |||
} | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
= | ===System.Hibernate=== | ||
Puts the system running XBMC into hibernate mode | |||
== | |||
====Permissions==== | ====Permissions==== | ||
ControlPower | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'System.Hibernate', | ||
'id': undefined /* integer, required */ | 'id': undefined /* integer, required */ | ||
} | } | ||
| Line 4,505: | Line 4,224: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'System.Hibernate', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': undefined /* string */ | 'result': undefined /* string */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | ===System.Reboot=== | ||
Reboots the system running XBMC | |||
====Permissions==== | ====Permissions==== | ||
ControlPower | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'System.Reboot', | ||
'id': undefined /* integer, required */ | 'id': undefined /* integer, required */ | ||
} | } | ||
| Line 4,526: | Line 4,245: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'System.Reboot', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': undefined /* string */ | 'result': undefined /* string */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | ===System.Shutdown=== | ||
Shuts the system running XBMC down | |||
====Permissions==== | ====Permissions==== | ||
ControlPower | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'System.Shutdown', | ||
'id': undefined /* integer, required */ | 'id': undefined /* integer, required */ | ||
} | } | ||
| Line 4,547: | Line 4,266: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'System.Shutdown', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': undefined /* string */ | 'result': undefined /* string */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | ===System.Suspend=== | ||
Suspends the system running XBMC | |||
====Permissions==== | ====Permissions==== | ||
ControlPower | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'System.Suspend', | ||
'id': undefined /* integer, required */ | 'id': undefined /* integer, required */ | ||
} | } | ||
| Line 4,568: | Line 4,287: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'System.Suspend', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': undefined /* string */ | 'result': undefined /* string */ | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | =XBMC= | ||
Dumping ground for very XBMC specific operations | |||
==Methods== | |||
===XBMC.GetInfoBooleans=== | |||
Retrieve info booleans about XBMC and the system | |||
====Permissions==== | ====Permissions==== | ||
ReadData | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'XBMC.GetInfoBooleans', | ||
'id': undefined /* integer, required */ | 'id': undefined /* integer, required */, | ||
'params': { | |||
'booleans': [ /* array, required, minimum items: 1 */ | |||
undefined /* string */ | |||
] | |||
} | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 4,589: | Line 4,316: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'XBMC.GetInfoBooleans', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': | 'result': { /* List of key-value pairs of the retrieved info booleans */ | ||
} | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | ===XBMC.GetInfoLabels=== | ||
Retrieve info labels about XBMC and the system | |||
====Permissions==== | ====Permissions==== | ||
ReadData | |||
====Syntax==== | ====Syntax==== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'XBMC.GetInfoLabels', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
' | 'params': { | ||
'labels': [ /* array, required, minimum items: 1, See http://wiki.xbmc.org/index.php?title=InfoLabels for a list of possible info labels */ | |||
undefined /* string */ | |||
] | |||
} | |||
{ | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 4,631: | Line 4,344: | ||
{ | { | ||
'jsonrpc': '2.0', | 'jsonrpc': '2.0', | ||
'method': ' | 'method': 'XBMC.GetInfoLabels', | ||
'id': undefined /* integer, required */, | 'id': undefined /* integer, required */, | ||
'result': { /* List of key-value pairs of the retrieved info labels */ | |||
'result': { /* List of key-value pairs of the retrieved info labels */ | |||
} | } | ||
} | } | ||
Revision as of 04:07, 21 June 2012
| JSON-RPC Pages |
|---|
| Main JSON-RPC Page |
| - v8 (Krypton) |
| - v10 (Leia) |
| - v12 (Matrix) |
| - v13 (Nexus) |
| - v14 (Omega) |
| Examples |
| All JSON-RPC Pages |
Version 4 is a stable version of XBMC's JSON-RPC API and is published with the release of Eden. It is a complete re-write and re-structuring of version 2 and therefore isn't backwards compatible to it. The main reason for this was the need to make this version fully compatible with all the functionality, features and requirements of the JSON-RPC 2.0 specification. This was a main concern during early development to make it easier for third party developers and applications to interact with XBMC's JSON-RPC API by using existing JSON-RPC libraries.
An rough and incomplete list of changes compared to version 2 can be found here. A more complete and detailed list can be found in the forum.
Documentation (JSON Schema)
Starting with JSON-RPC API version 3 a new way of API documentation has been introduced. All methods and data types are described using JSON Schema. This provides third party developers with an always complete and up-to-date documentation by calling JSONRPC.Introspect even during periods of heavy development. Furthermore the same method and data type specification that can be used by third party developers as a documentation is used by XBMC to check and verify method parameters and their values on every JSON-RPC request and allows to provide detailed error messages in case of a bad or missing parameter.
Supported features of JSON Schema
| Schema | IETF Draft 03 |
|---|---|
| type | Yes |
| properties | Yes |
| patternProperties | No |
| additionalProperties | Yes |
| items | Yes |
| additionalItems | Yes |
| required | Yes |
| dependencies | No |
| minimum | Yes |
| maximum | Yes |
| Schema | IETF Draft 03 |
|---|---|
| exclusiveMinimum | Yes |
| exclusiveMaximum | Yes |
| minItems | Yes |
| maxItems | Yes |
| uniqueItems | Yes |
| pattern | No |
| minLength | Yes |
| maxLength | Yes |
| enum | Yes |
| default | Yes |
| Schema | IETF Draft 03 |
|---|---|
| title | No |
| description | Yes |
| format | No |
| divisibleBy | Yes |
| disallow | No |
| extends | Yes |
| id | Yes |
| $ref | Yes |
| $schema | No |
| Hyper Schema | No |
Error message
If XBMC detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is
{
"type": "object",
"properties": {
"code": { "type": "integer", "required": true },
"message": { "type": "string", "required": true },
"data": { "type": "object",
"properties": {
"method": { "type": "string", "required": true },
"stack": { "type": "object", "id": "Error.Stack",
"properties": {
"name": { "type": "string", "required": true },
"type": { "type": "string", "required": true },
"message": { "type": "string", "required": true },
"property": { "$ref": "Error.Stack" }
}
}
}
}
}
}
|
JSONRPC
A variety of standard JSONRPC calls
Methods
JSONRPC.Introspect
Enumerates all actions and descriptions
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'JSONRPC.Introspect',
'id': undefined /* integer, required */,
'params': {
'getdescriptions': true /* boolean */,
'getmetadata': false /* boolean */,
'filterbytransport': true /* boolean */,
'filter': {
'getreferences': true /* boolean, Whether or not to print the schema for referenced types */,
'id': undefined /* string, required, Name of a namespace, method or type */,
'type': undefined /* string, required, Type of the given name */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'JSONRPC.Introspect',
'id': undefined /* integer, required */,
'result': {
}
}
JSONRPC.NotifyAll
Notify all other connected clients
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'JSONRPC.NotifyAll',
'id': undefined /* integer, required */,
'params': {
'sender': undefined /* string, required */,
'message': undefined /* string, required */,
'data': null /* any */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'JSONRPC.NotifyAll',
'id': undefined /* integer, required */,
'result': undefined /* any */
}
JSONRPC.Permission
Retrieve the clients permissions
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'JSONRPC.Permission',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'JSONRPC.Permission',
'id': undefined /* integer, required */,
'result': {
'controlnotify': undefined /* boolean, required */,
'controlplayback': undefined /* boolean, required */,
'controlpower': undefined /* boolean, required */,
'navigate': undefined /* boolean, required */,
'readdata': undefined /* boolean, required */,
'removedata': undefined /* boolean, required */,
'updatedata': undefined /* boolean, required */,
'writefile': undefined /* boolean, required */
}
}
JSONRPC.Ping
Ping responder
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'JSONRPC.Ping',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'JSONRPC.Ping',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
JSONRPC.Version
Retrieve the jsonrpc protocol version
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'JSONRPC.Version',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'JSONRPC.Version',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player
Manages all available players
Notifications
Player.OnPause
Playback of a media item has been paused. If there is no ID available extra information will be provided.
Returns
{
'jsonrpc': '2.0',
'method': 'Player.OnPause',
'params': undefined /* string, required */ or { /* required, id: Player.Notifications.Data */
'item': { /* An unknown item does not have any additional information. */
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* An item known to the database has an identification. */
'id': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* A movie item has a title and may have a release year. */
'title': undefined /* string, required */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */,
'year': 0 /* integer */
} or { /* A tv episode has a title and may have an episode number, season number and the title of the show it belongs to. */
'episode': 0 /* integer */,
'season': 0 /* integer */,
'showtitle': '' /* string */,
'title': undefined /* string, required */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* A music video has a title and may have an album and an artist. */
'album': '' /* string */,
'artist': '' /* string */,
'title': undefined /* string, required */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* A song has a title and may have an album, an artist and a track number. */
'album': '' /* string */,
'artist': '' /* string */,
'title': undefined /* string, required */,
'track': 0 /* integer */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
},
'player': { /* required, id: Player.Notifications.Player */
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */,
'speed': 0 /* integer */
}
}
}
Player.OnPlay
Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.
Returns
{
'jsonrpc': '2.0',
'method': 'Player.OnPlay',
'params': undefined /* string, required */ or { /* required, id: Player.Notifications.Data */
'item': { /* An unknown item does not have any additional information. */
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* An item known to the database has an identification. */
'id': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* A movie item has a title and may have a release year. */
'title': undefined /* string, required */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */,
'year': 0 /* integer */
} or { /* A tv episode has a title and may have an episode number, season number and the title of the show it belongs to. */
'episode': 0 /* integer */,
'season': 0 /* integer */,
'showtitle': '' /* string */,
'title': undefined /* string, required */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* A music video has a title and may have an album and an artist. */
'album': '' /* string */,
'artist': '' /* string */,
'title': undefined /* string, required */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* A song has a title and may have an album, an artist and a track number. */
'album': '' /* string */,
'artist': '' /* string */,
'title': undefined /* string, required */,
'track': 0 /* integer */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
},
'player': { /* required, id: Player.Notifications.Player */
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */,
'speed': 0 /* integer */
}
}
}
Player.OnSeek
The playback position has been changed. If there is no ID available extra information will be provided.
Returns
{
'jsonrpc': '2.0',
'method': 'Player.OnSeek',
'params': undefined /* string, required */ or { /* required */
'item': { /* An unknown item does not have any additional information. */
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* An item known to the database has an identification. */
'id': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* A movie item has a title and may have a release year. */
'title': undefined /* string, required */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */,
'year': 0 /* integer */
} or { /* A tv episode has a title and may have an episode number, season number and the title of the show it belongs to. */
'episode': 0 /* integer */,
'season': 0 /* integer */,
'showtitle': '' /* string */,
'title': undefined /* string, required */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* A music video has a title and may have an album and an artist. */
'album': '' /* string */,
'artist': '' /* string */,
'title': undefined /* string, required */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* A song has a title and may have an album, an artist and a track number. */
'album': '' /* string */,
'artist': '' /* string */,
'title': undefined /* string, required */,
'track': 0 /* integer */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
},
'player': { /* required, id: Player.Notifications.Player.Seek */
'seekoffset': { /* id: Global.Time, no additional properties allowed */
'hours': undefined /* integer, required, minimum: 0, maximum: 23 */,
'milliseconds': undefined /* integer, required, minimum: 0, maximum: 999 */,
'minutes': undefined /* integer, required, minimum: 0, maximum: 59 */,
'seconds': undefined /* integer, required, minimum: 0, maximum: 59 */
},
'time': { /* id: Global.Time, no additional properties allowed */
'hours': undefined /* integer, required, minimum: 0, maximum: 23 */,
'milliseconds': undefined /* integer, required, minimum: 0, maximum: 999 */,
'minutes': undefined /* integer, required, minimum: 0, maximum: 59 */,
'seconds': undefined /* integer, required, minimum: 0, maximum: 59 */
},
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */,
'speed': 0 /* integer */
}
}
}
Player.OnSpeedChanged
Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.
Returns
{
'jsonrpc': '2.0',
'method': 'Player.OnSpeedChanged',
'params': undefined /* string, required */ or { /* required, id: Player.Notifications.Data */
'item': { /* An unknown item does not have any additional information. */
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* An item known to the database has an identification. */
'id': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* A movie item has a title and may have a release year. */
'title': undefined /* string, required */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */,
'year': 0 /* integer */
} or { /* A tv episode has a title and may have an episode number, season number and the title of the show it belongs to. */
'episode': 0 /* integer */,
'season': 0 /* integer */,
'showtitle': '' /* string */,
'title': undefined /* string, required */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* A music video has a title and may have an album and an artist. */
'album': '' /* string */,
'artist': '' /* string */,
'title': undefined /* string, required */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* A song has a title and may have an album, an artist and a track number. */
'album': '' /* string */,
'artist': '' /* string */,
'title': undefined /* string, required */,
'track': 0 /* integer */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
},
'player': { /* required, id: Player.Notifications.Player */
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */,
'speed': 0 /* integer */
}
}
}
Player.OnStop
Playback of a media item has been stopped. If there is no ID available extra information will be provided.
Returns
{
'jsonrpc': '2.0',
'method': 'Player.OnStop',
'params': undefined /* string, required */ or { /* required */
'item': { /* An unknown item does not have any additional information. */
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* An item known to the database has an identification. */
'id': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* A movie item has a title and may have a release year. */
'title': undefined /* string, required */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */,
'year': 0 /* integer */
} or { /* A tv episode has a title and may have an episode number, season number and the title of the show it belongs to. */
'episode': 0 /* integer */,
'season': 0 /* integer */,
'showtitle': '' /* string */,
'title': undefined /* string, required */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* A music video has a title and may have an album and an artist. */
'album': '' /* string */,
'artist': '' /* string */,
'title': undefined /* string, required */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
} or { /* A song has a title and may have an album, an artist and a track number. */
'album': '' /* string */,
'artist': '' /* string */,
'title': undefined /* string, required */,
'track': 0 /* integer */,
'type': 'unknown' /* string, required, id: Player.Notifications.Item.Type */
}
}
}
Methods
Player.GetActivePlayers
Returns all active players
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.GetActivePlayers',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.GetActivePlayers',
'id': undefined /* integer, required */,
'result': [ /* array, all items must be unique */
{
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */,
'type': 'video' /* string, required, id: Player.Type */
}
]
}
Player.GetItem
Retrieves the currently played item
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.GetItem',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */,
'properties': [ /* id: List.Fields.All */
undefined /* string */
]
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.GetItem',
'id': undefined /* integer, required */,
'result': {
'item': { /* required, id: List.Item.All */
'album': '' /* string */,
'albumartist': '' /* string */,
'albumid': -1 /* integer, id: Library.Id, minimum: 1 */,
'artistid': -1 /* integer, id: Library.Id, minimum: 1 */,
'cast': [ /* array, id: Video.Cast */
{ /* no additional properties allowed */
'name': undefined /* string, required */,
'role': undefined /* string, required */,
'thumbnail': '' /* string */
}
],
'comment': '' /* string */,
'country': '' /* string */,
'duration': 0 /* integer */,
'episode': 0 /* integer */,
'firstaired': '' /* string */,
'id': -1 /* integer, id: Library.Id, minimum: 1 */,
'imdbnumber': '' /* string */,
'lyrics': '' /* string */,
'mpaa': '' /* string */,
'musicbrainzartistid': '' /* string */,
'musicbrainztrackid': '' /* string */,
'originaltitle': '' /* string */,
'plotoutline': '' /* string */,
'premiered': '' /* string */,
'productioncode': '' /* string */,
'season': 0 /* integer */,
'set': [ /* array, id: Array.String */
undefined /* string, minimum length: 1 */
],
'setid': [ /* array, id: Array.Integer */
undefined /* integer */
],
'showlink': '' /* string */,
'showtitle': '' /* string */,
'studio': '' /* string */,
'tagline': '' /* string */,
'top250': 0 /* integer */,
'track': 0 /* integer */,
'trailer': '' /* string */,
'tvshowid': -1 /* integer, id: Library.Id, minimum: 1 */,
'type': 'unknown' /* string */,
'votes': '' /* string */,
'writer': '' /* string */,
'director': '' /* string */,
'resume': { /* id: Video.Resume, no additional properties allowed */
'position': 0 /* number, minimum: 0 */,
'total': 0 /* number, minimum: 0 */
},
'runtime': '' /* string */,
'streamdetails': { /* id: Video.Streams, no additional properties allowed */
'audio': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'channels': 0 /* integer */,
'codec': '' /* string */,
'language': '' /* string */
}
],
'subtitle': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'language': '' /* string */
}
],
'video': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'aspect': 0 /* number */,
'codec': '' /* string */,
'duration': 0 /* integer */,
'height': 0 /* integer */,
'width': 0 /* integer */
}
]
},
'file': '' /* string */,
'lastplayed': '' /* string */,
'plot': '' /* string */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */,
'artist': '' /* string */,
'musicbrainzalbumartistid': '' /* string */,
'musicbrainzalbumid': '' /* string */,
'rating': 0 /* integer */,
'year': 0 /* integer */,
'genre': '' /* string */
}
}
}
Player.GetProperties
Retrieves the values of the given properties
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.GetProperties',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */,
'properties': [ /* array, required, all items must be unique */
'type' /* string, id: Player.Property.Name */
]
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.GetProperties',
'id': undefined /* integer, required */,
'result': { /* id: Player.Property.Value */
'audiostreams': [ /* array */
{ /* id: Player.Audio.Stream */
'index': undefined /* integer, required, minimum: 0 */,
'language': undefined /* string, required */,
'name': undefined /* string, required */
}
],
'canchangespeed': false /* boolean */,
'canmove': false /* boolean */,
'canrepeat': false /* boolean */,
'canrotate': false /* boolean */,
'canseek': false /* boolean */,
'canshuffle': false /* boolean */,
'canzoom': false /* boolean */,
'currentaudiostream': { /* id: Player.Audio.Stream.Extended */
'bitrate': undefined /* integer, required */,
'channels': undefined /* integer, required */,
'codec': undefined /* string, required */,
'index': undefined /* integer, required, minimum: 0 */,
'language': undefined /* string, required */,
'name': undefined /* string, required */
},
'currentsubtitle': { /* id: Player.Subtitle */
'index': undefined /* integer, required, minimum: 0 */,
'language': undefined /* string, required */,
'name': undefined /* string, required */
},
'partymode': false /* boolean */,
'percentage': 0 /* number, id: Player.Position.Percentage, minimum: 0, maximum: 100 */,
'playlistid': -1 /* integer, id: Playlist.Id, minimum: 0, maximum: 2 */,
'position': -1 /* integer, id: Playlist.Position, minimum: 0 */,
'repeat': 'off' /* string, id: Player.Repeat */,
'shuffled': false /* boolean */,
'speed': 0 /* integer */,
'subtitleenabled': false /* boolean */,
'subtitles': [ /* array */
{ /* id: Player.Subtitle */
'index': undefined /* integer, required, minimum: 0 */,
'language': undefined /* string, required */,
'name': undefined /* string, required */
}
],
'time': { /* id: Global.Time, no additional properties allowed */
'hours': undefined /* integer, required, minimum: 0, maximum: 23 */,
'milliseconds': undefined /* integer, required, minimum: 0, maximum: 999 */,
'minutes': undefined /* integer, required, minimum: 0, maximum: 59 */,
'seconds': undefined /* integer, required, minimum: 0, maximum: 59 */
},
'totaltime': { /* id: Global.Time, no additional properties allowed */
'hours': undefined /* integer, required, minimum: 0, maximum: 23 */,
'milliseconds': undefined /* integer, required, minimum: 0, maximum: 999 */,
'minutes': undefined /* integer, required, minimum: 0, maximum: 59 */,
'seconds': undefined /* integer, required, minimum: 0, maximum: 59 */
},
'type': 'video' /* string, id: Player.Type */
}
}
Player.GoNext
Go to next item on the playlist
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.GoNext',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.GoNext',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.GoPrevious
Go to previous item on the playlist
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.GoPrevious',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.GoPrevious',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.GoTo
Go to item at the given position in the playlist
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.GoTo',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */,
'position': -1 /* integer, required, id: Playlist.Position, minimum: 0 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.GoTo',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.MoveDown
If picture is zoomed move viewport down
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.MoveDown',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.MoveDown',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.MoveLeft
If picture is zoomed move viewport left otherwise skip previous
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.MoveLeft',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.MoveLeft',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.MoveRight
If picture is zoomed move viewport right otherwise skip next
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.MoveRight',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.MoveRight',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.MoveUp
If picture is zoomed move viewport up
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.MoveUp',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.MoveUp',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.Open
Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.Open',
'id': undefined /* integer, required */,
'params': {
'item': { /* no additional properties allowed */
'playlistid': -1 /* integer, required, id: Playlist.Id, minimum: 0, maximum: 2 */,
'position': -1 /* integer, id: Playlist.Position, minimum: 0 */
} or { /* no additional properties allowed */
'file': undefined /* string, required, Path to a file (not a directory) to be added to the playlist */
} or { /* no additional properties allowed */
'directory': undefined /* string, required */
} or { /* no additional properties allowed */
'movieid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'episodeid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'musicvideoid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'artistid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'albumid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'songid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'genreid': -1 /* integer, required, id: Library.Id, minimum: 1, Identification of a genre from the AudioLibrary */
} or { /* no additional properties allowed */
'path': undefined /* string, required */,
'random': true /* boolean */,
'recursive': true /* boolean */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.Open',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.PlayPause
Pauses or unpause playback and returns the new state
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.PlayPause',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.PlayPause',
'id': undefined /* integer, required */,
'result': { /* required, id: Player.Speed */
'speed': 0 /* integer */
}
}
Player.Repeat
Set the repeat mode of the player
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.Repeat',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */,
'state': 'off' /* string, required, id: Player.Repeat */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.Repeat',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.Rotate
Rotates current picture
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.Rotate',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.Rotate',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.Seek
Seek through the playing item
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.Seek',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */,
'value': 0 /* number, id: Player.Position.Percentage, minimum: 0, maximum: 100, Percentage value to seek to */ or { /* no additional properties allowed, Time to seek to */
'hours': 0 /* integer, minimum: 0, maximum: 23 */,
'milliseconds': 0 /* integer, minimum: 0, maximum: 999 */,
'minutes': 0 /* integer, minimum: 0, maximum: 59 */,
'seconds': 0 /* integer, minimum: 0, maximum: 59 */
} or undefined /* string, Seek by predefined jumps */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.Seek',
'id': undefined /* integer, required */,
'result': {
'percentage': 0 /* number, id: Player.Position.Percentage, minimum: 0, maximum: 100 */,
'time': { /* id: Global.Time, no additional properties allowed */
'hours': undefined /* integer, required, minimum: 0, maximum: 23 */,
'milliseconds': undefined /* integer, required, minimum: 0, maximum: 999 */,
'minutes': undefined /* integer, required, minimum: 0, maximum: 59 */,
'seconds': undefined /* integer, required, minimum: 0, maximum: 59 */
},
'totaltime': { /* id: Global.Time, no additional properties allowed */
'hours': undefined /* integer, required, minimum: 0, maximum: 23 */,
'milliseconds': undefined /* integer, required, minimum: 0, maximum: 999 */,
'minutes': undefined /* integer, required, minimum: 0, maximum: 59 */,
'seconds': undefined /* integer, required, minimum: 0, maximum: 59 */
}
}
}
Player.SetAudioStream
Set the audio stream played by the player
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.SetAudioStream',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */,
'stream': undefined /* string */ or undefined /* integer, minimum: 0, Index of the audio stream to play */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.SetAudioStream',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.SetSpeed
Set the speed of the current playback
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.SetSpeed',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */,
'speed': undefined /* integer */ or undefined /* string */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.SetSpeed',
'id': undefined /* integer, required */,
'result': { /* required, id: Player.Speed */
'speed': 0 /* integer */
}
}
Player.SetSubtitle
Set the subtitle displayed by the player
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.SetSubtitle',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */,
'subtitle': undefined /* string */ or undefined /* integer, minimum: 0, Index of the subtitle to display */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.SetSubtitle',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.Shuffle
Shuffle items in the player
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.Shuffle',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.Shuffle',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.Stop
Stops playback
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.Stop',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.Stop',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.UnShuffle
Unshuffle items in the player
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.UnShuffle',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.UnShuffle',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.Zoom
Zooms current picture
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.Zoom',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */,
'value': undefined /* integer, required, minimum: 1, maximum: 10, Zoom level */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.Zoom',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.ZoomIn
Zoom in once
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.ZoomIn',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.ZoomIn',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Player.ZoomOut
Zoom out once
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Player.ZoomOut',
'id': undefined /* integer, required */,
'params': {
'playerid': -1 /* integer, required, id: Player.Id, minimum: 0, maximum: 2 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Player.ZoomOut',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Playlist
Playlist modification
Methods
Playlist.Add
Add item(s) to playlist
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Playlist.Add',
'id': undefined /* integer, required */,
'params': {
'playlistid': -1 /* integer, required, id: Playlist.Id, minimum: 0, maximum: 2 */,
'item': { /* no additional properties allowed */
'file': undefined /* string, required, Path to a file (not a directory) to be added to the playlist */
} or { /* no additional properties allowed */
'directory': undefined /* string, required */
} or { /* no additional properties allowed */
'movieid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'episodeid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'musicvideoid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'artistid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'albumid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'songid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'genreid': -1 /* integer, required, id: Library.Id, minimum: 1, Identification of a genre from the AudioLibrary */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Playlist.Add',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Playlist.Clear
Clear playlist
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Playlist.Clear',
'id': undefined /* integer, required */,
'params': {
'playlistid': -1 /* integer, required, id: Playlist.Id, minimum: 0, maximum: 2 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Playlist.Clear',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Playlist.GetItems
Get all items from playlist
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'Playlist.GetItems',
'id': undefined /* integer, required */,
'params': {
'playlistid': -1 /* integer, required, id: Playlist.Id, minimum: 0, maximum: 2 */,
'properties': [ /* id: List.Fields.All */
undefined /* string */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Playlist.GetItems',
'id': undefined /* integer, required */,
'result': {
'items': [ /* array, required */
{ /* id: List.Item.All */
'album': '' /* string */,
'albumartist': '' /* string */,
'albumid': -1 /* integer, id: Library.Id, minimum: 1 */,
'artistid': -1 /* integer, id: Library.Id, minimum: 1 */,
'cast': [ /* array, id: Video.Cast */
{ /* no additional properties allowed */
'name': undefined /* string, required */,
'role': undefined /* string, required */,
'thumbnail': '' /* string */
}
],
'comment': '' /* string */,
'country': '' /* string */,
'duration': 0 /* integer */,
'episode': 0 /* integer */,
'firstaired': '' /* string */,
'id': -1 /* integer, id: Library.Id, minimum: 1 */,
'imdbnumber': '' /* string */,
'lyrics': '' /* string */,
'mpaa': '' /* string */,
'musicbrainzartistid': '' /* string */,
'musicbrainztrackid': '' /* string */,
'originaltitle': '' /* string */,
'plotoutline': '' /* string */,
'premiered': '' /* string */,
'productioncode': '' /* string */,
'season': 0 /* integer */,
'set': [ /* array, id: Array.String */
undefined /* string, minimum length: 1 */
],
'setid': [ /* array, id: Array.Integer */
undefined /* integer */
],
'showlink': '' /* string */,
'showtitle': '' /* string */,
'studio': '' /* string */,
'tagline': '' /* string */,
'top250': 0 /* integer */,
'track': 0 /* integer */,
'trailer': '' /* string */,
'tvshowid': -1 /* integer, id: Library.Id, minimum: 1 */,
'type': 'unknown' /* string */,
'votes': '' /* string */,
'writer': '' /* string */,
'director': '' /* string */,
'resume': { /* id: Video.Resume, no additional properties allowed */
'position': 0 /* number, minimum: 0 */,
'total': 0 /* number, minimum: 0 */
},
'runtime': '' /* string */,
'streamdetails': { /* id: Video.Streams, no additional properties allowed */
'audio': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'channels': 0 /* integer */,
'codec': '' /* string */,
'language': '' /* string */
}
],
'subtitle': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'language': '' /* string */
}
],
'video': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'aspect': 0 /* number */,
'codec': '' /* string */,
'duration': 0 /* integer */,
'height': 0 /* integer */,
'width': 0 /* integer */
}
]
},
'file': '' /* string */,
'lastplayed': '' /* string */,
'plot': '' /* string */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */,
'artist': '' /* string */,
'musicbrainzalbumartistid': '' /* string */,
'musicbrainzalbumid': '' /* string */,
'rating': 0 /* integer */,
'year': 0 /* integer */,
'genre': '' /* string */
}
],
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
}
}
}
Playlist.GetPlaylists
Returns all existing playlists
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'Playlist.GetPlaylists',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'Playlist.GetPlaylists',
'id': undefined /* integer, required */,
'result': [ /* array, all items must be unique */
{
'playlistid': -1 /* integer, required, id: Playlist.Id, minimum: 0, maximum: 2 */,
'type': 'unknown' /* string, required, id: Playlist.Type */
}
]
}
Playlist.GetProperties
Retrieves the values of the given properties
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'Playlist.GetProperties',
'id': undefined /* integer, required */,
'params': {
'playlistid': -1 /* integer, required, id: Playlist.Id, minimum: 0, maximum: 2 */,
'properties': [ /* array, required, all items must be unique */
'type' /* string, id: Playlist.Property.Name */
]
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Playlist.GetProperties',
'id': undefined /* integer, required */,
'result': { /* id: Playlist.Property.Value */
'size': 0 /* integer, minimum: 0 */,
'type': 'unknown' /* string, id: Playlist.Type */
}
}
Playlist.Insert
Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Playlist.Insert',
'id': undefined /* integer, required */,
'params': {
'playlistid': -1 /* integer, required, id: Playlist.Id, minimum: 0, maximum: 2 */,
'position': -1 /* integer, required, id: Playlist.Position, minimum: 0 */,
'item': { /* no additional properties allowed */
'file': undefined /* string, required, Path to a file (not a directory) to be added to the playlist */
} or { /* no additional properties allowed */
'directory': undefined /* string, required */
} or { /* no additional properties allowed */
'movieid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'episodeid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'musicvideoid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'artistid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'albumid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'songid': -1 /* integer, required, id: Library.Id, minimum: 1 */
} or { /* no additional properties allowed */
'genreid': -1 /* integer, required, id: Library.Id, minimum: 1, Identification of a genre from the AudioLibrary */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Playlist.Insert',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Playlist.Remove
Remove item from playlist. Does not work for picture playlists (aka slideshows).
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Playlist.Remove',
'id': undefined /* integer, required */,
'params': {
'playlistid': -1 /* integer, required, id: Playlist.Id, minimum: 0, maximum: 2 */,
'position': -1 /* integer, required, id: Playlist.Position, minimum: 0 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Playlist.Remove',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Playlist.Swap
Swap items in the playlist. Does not work for picture playlists (aka slideshows).
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Playlist.Swap',
'id': undefined /* integer, required */,
'params': {
'playlistid': -1 /* integer, required, id: Playlist.Id, minimum: 0, maximum: 2 */,
'position1': -1 /* integer, required, id: Playlist.Position, minimum: 0 */,
'position2': -1 /* integer, required, id: Playlist.Position, minimum: 0 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Playlist.Swap',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Files
Shares information
Methods
Files.GetDirectory
Get the directories and files in the given directory
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'Files.GetDirectory',
'id': undefined /* integer, required */,
'params': {
'directory': undefined /* string, required */,
'media': 'video' /* string, id: Files.Media */,
'properties': [ /* id: List.Fields.All */
undefined /* string */
],
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Files.GetDirectory',
'id': undefined /* integer, required */,
'result': {
'files': [ /* array, required */
{ /* id: List.Item.File */
'file': '' /* string */,
'filetype': undefined /* string, required */,
'album': '' /* string */,
'albumartist': '' /* string */,
'albumid': -1 /* integer, id: Library.Id, minimum: 1 */,
'artistid': -1 /* integer, id: Library.Id, minimum: 1 */,
'cast': [ /* array, id: Video.Cast */
{ /* no additional properties allowed */
'name': undefined /* string, required */,
'role': undefined /* string, required */,
'thumbnail': '' /* string */
}
],
'comment': '' /* string */,
'country': '' /* string */,
'duration': 0 /* integer */,
'episode': 0 /* integer */,
'firstaired': '' /* string */,
'id': -1 /* integer, id: Library.Id, minimum: 1 */,
'imdbnumber': '' /* string */,
'lyrics': '' /* string */,
'mpaa': '' /* string */,
'musicbrainzartistid': '' /* string */,
'musicbrainztrackid': '' /* string */,
'originaltitle': '' /* string */,
'plotoutline': '' /* string */,
'premiered': '' /* string */,
'productioncode': '' /* string */,
'season': 0 /* integer */,
'set': [ /* array, id: Array.String */
undefined /* string, minimum length: 1 */
],
'setid': [ /* array, id: Array.Integer */
undefined /* integer */
],
'showlink': '' /* string */,
'showtitle': '' /* string */,
'studio': '' /* string */,
'tagline': '' /* string */,
'top250': 0 /* integer */,
'track': 0 /* integer */,
'trailer': '' /* string */,
'tvshowid': -1 /* integer, id: Library.Id, minimum: 1 */,
'type': 'unknown' /* string */,
'votes': '' /* string */,
'writer': '' /* string */,
'director': '' /* string */,
'resume': { /* id: Video.Resume, no additional properties allowed */
'position': 0 /* number, minimum: 0 */,
'total': 0 /* number, minimum: 0 */
},
'runtime': '' /* string */,
'streamdetails': { /* id: Video.Streams, no additional properties allowed */
'audio': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'channels': 0 /* integer */,
'codec': '' /* string */,
'language': '' /* string */
}
],
'subtitle': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'language': '' /* string */
}
],
'video': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'aspect': 0 /* number */,
'codec': '' /* string */,
'duration': 0 /* integer */,
'height': 0 /* integer */,
'width': 0 /* integer */
}
]
},
'lastplayed': '' /* string */,
'plot': '' /* string */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */,
'artist': '' /* string */,
'musicbrainzalbumartistid': '' /* string */,
'musicbrainzalbumid': '' /* string */,
'rating': 0 /* integer */,
'year': 0 /* integer */,
'genre': '' /* string */
}
],
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
}
}
}
Files.GetSources
Get the sources of the media windows
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'Files.GetSources',
'id': undefined /* integer, required */,
'params': {
'media': 'video' /* string, required, id: Files.Media */,
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Files.GetSources',
'id': undefined /* integer, required */,
'result': {
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
},
'sources': [ /* array, required, id: List.Items.Sources */
{
'file': undefined /* string, required */
}
]
}
}
Files.PrepareDownload
Provides a way to download a given file (e.g. providing an URL to the real file location)
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'Files.PrepareDownload',
'id': undefined /* integer, required */,
'params': {
'path': undefined /* string, required */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Files.PrepareDownload',
'id': undefined /* integer, required */,
'result': {
'details': undefined /* any, required, Transport specific details on how/from where to download the given file */,
'mode': undefined /* string, required, Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol */,
'protocol': undefined /* string, required */
}
}
AudioLibrary
Audio Library information
Notifications
AudioLibrary.OnRemove
An audio item has been removed.
Returns
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.OnRemove',
'params': undefined /* string, required */ or { /* required */
'id': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'type': undefined /* required */
}
}
AudioLibrary.OnUpdate
An audio item has been updated.
Returns
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.OnUpdate',
'params': undefined /* string, required */ or { /* required */
'id': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'type': undefined /* string ('song'), required, id: Notifications.Library.Audio.Type */
}
}
Methods
AudioLibrary.Clean
Cleans the audio library from non-existent items
Permissions
RemoveData
Syntax
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.Clean',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.Clean',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
AudioLibrary.Export
Exports all items from the audio library
Permissions
WriteFile
Syntax
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.Export',
'id': undefined /* integer, required */,
'params': {
'options': { /* no additional properties allowed */
'path': undefined /* string, required, minimum length: 1, Path to the directory to where the data should be exported */
} or { /* no additional properties allowed */
'images': false /* boolean, Whether to export thumbnails and fanart images */,
'overwrite': false /* boolean, Whether to overwrite existing exported files */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.Export',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
AudioLibrary.GetAlbumDetails
Retrieve details about a specific album
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetAlbumDetails',
'id': undefined /* integer, required */,
'params': {
'albumid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'properties': [ /* id: Audio.Fields.Album */
undefined /* string */
]
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetAlbumDetails',
'id': undefined /* integer, required */,
'result': {
'albumdetails': { /* id: Audio.Details.Album */
'albumid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'albumlabel': '' /* string */,
'artistid': -1 /* integer, id: Library.Id, minimum: 1 */,
'description': '' /* string */,
'mood': '' /* string */,
'style': '' /* string */,
'theme': '' /* string */,
'type': '' /* string */,
'artist': '' /* string */,
'musicbrainzalbumartistid': '' /* string */,
'musicbrainzalbumid': '' /* string */,
'rating': 0 /* integer */,
'title': '' /* string */,
'year': 0 /* integer */,
'genre': '' /* string */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
}
}
AudioLibrary.GetAlbums
Retrieve all albums from specified artist or genre
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetAlbums',
'id': undefined /* integer, required */,
'params': {
'artistid': -1 /* integer, id: Library.Id, minimum: 1 */,
'genreid': -1 /* integer, id: Library.Id, minimum: 1 */,
'properties': [ /* id: Audio.Fields.Album */
undefined /* string */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetAlbums',
'id': undefined /* integer, required */,
'result': {
'albums': [ /* array */
{ /* id: Audio.Details.Album */
'albumid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'albumlabel': '' /* string */,
'artistid': -1 /* integer, id: Library.Id, minimum: 1 */,
'description': '' /* string */,
'mood': '' /* string */,
'style': '' /* string */,
'theme': '' /* string */,
'type': '' /* string */,
'artist': '' /* string */,
'musicbrainzalbumartistid': '' /* string */,
'musicbrainzalbumid': '' /* string */,
'rating': 0 /* integer */,
'title': '' /* string */,
'year': 0 /* integer */,
'genre': '' /* string */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
],
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
}
}
}
AudioLibrary.GetArtistDetails
Retrieve details about a specific artist
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetArtistDetails',
'id': undefined /* integer, required */,
'params': {
'artistid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'properties': [ /* id: Audio.Fields.Artist */
undefined /* string */
]
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetArtistDetails',
'id': undefined /* integer, required */,
'result': {
'artistdetails': { /* id: Audio.Details.Artist */
'artist': undefined /* string, required */,
'artistid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'born': '' /* string */,
'description': '' /* string */,
'died': '' /* string */,
'disbanded': '' /* string */,
'formed': '' /* string */,
'instrument': '' /* string */,
'mood': '' /* string */,
'musicbrainzartistid': '' /* string */,
'style': '' /* string */,
'yearsactive': '' /* string */,
'genre': '' /* string */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
}
}
AudioLibrary.GetArtists
Retrieve all artists
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetArtists',
'id': undefined /* integer, required */,
'params': {
'albumartistsonly': undefined /* null */ or undefined /* boolean */,
'genreid': -1 /* integer, id: Library.Id, minimum: 1 */,
'properties': [ /* id: Audio.Fields.Artist */
undefined /* string */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetArtists',
'id': undefined /* integer, required */,
'result': {
'artists': [ /* array */
{ /* id: Audio.Details.Artist */
'artist': undefined /* string, required */,
'artistid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'born': '' /* string */,
'description': '' /* string */,
'died': '' /* string */,
'disbanded': '' /* string */,
'formed': '' /* string */,
'instrument': '' /* string */,
'mood': '' /* string */,
'musicbrainzartistid': '' /* string */,
'style': '' /* string */,
'yearsactive': '' /* string */,
'genre': '' /* string */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
],
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
}
}
}
AudioLibrary.GetGenres
Retrieve all genres
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetGenres',
'id': undefined /* integer, required */,
'params': {
'properties': [ /* id: Library.Fields.Genre */
undefined /* string */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetGenres',
'id': undefined /* integer, required */,
'result': {
'genres': [ /* array, required */
{ /* id: Library.Details.Genre */
'genreid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'thumbnail': '' /* string */,
'title': '' /* string */,
'label': undefined /* string, required */
}
],
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
}
}
}
AudioLibrary.GetRecentlyAddedAlbums
Retrieve recently added albums
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetRecentlyAddedAlbums',
'id': undefined /* integer, required */,
'params': {
'properties': [ /* id: Audio.Fields.Album */
undefined /* string */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetRecentlyAddedAlbums',
'id': undefined /* integer, required */,
'result': {
'albums': [ /* array */
{ /* id: Audio.Details.Album */
'albumid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'albumlabel': '' /* string */,
'artistid': -1 /* integer, id: Library.Id, minimum: 1 */,
'description': '' /* string */,
'mood': '' /* string */,
'style': '' /* string */,
'theme': '' /* string */,
'type': '' /* string */,
'artist': '' /* string */,
'musicbrainzalbumartistid': '' /* string */,
'musicbrainzalbumid': '' /* string */,
'rating': 0 /* integer */,
'title': '' /* string */,
'year': 0 /* integer */,
'genre': '' /* string */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
],
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
}
}
}
AudioLibrary.GetRecentlyAddedSongs
Retrieve recently added songs
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetRecentlyAddedSongs',
'id': undefined /* integer, required */,
'params': {
'albumlimit': -1 /* integer, id: List.Amount, minimum: 0, The amount of recently added albums from which to return the songs */,
'properties': [ /* id: Audio.Fields.Song */
undefined /* string */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetRecentlyAddedSongs',
'id': undefined /* integer, required */,
'result': {
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
},
'songs': [ /* array */
{ /* id: Audio.Details.Song */
'album': '' /* string */,
'albumartist': '' /* string */,
'albumid': -1 /* integer, id: Library.Id, minimum: 1 */,
'artistid': -1 /* integer, id: Library.Id, minimum: 1 */,
'comment': '' /* string */,
'duration': 0 /* integer */,
'file': '' /* string */,
'lyrics': '' /* string */,
'musicbrainzartistid': '' /* string */,
'musicbrainztrackid': '' /* string */,
'playcount': 0 /* integer */,
'songid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'track': 0 /* integer */,
'artist': '' /* string */,
'musicbrainzalbumartistid': '' /* string */,
'musicbrainzalbumid': '' /* string */,
'rating': 0 /* integer */,
'title': '' /* string */,
'year': 0 /* integer */,
'genre': '' /* string */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
]
}
}
AudioLibrary.GetSongDetails
Retrieve details about a specific song
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetSongDetails',
'id': undefined /* integer, required */,
'params': {
'songid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'properties': [ /* id: Audio.Fields.Song */
undefined /* string */
]
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetSongDetails',
'id': undefined /* integer, required */,
'result': {
'songdetails': { /* id: Audio.Details.Song */
'album': '' /* string */,
'albumartist': '' /* string */,
'albumid': -1 /* integer, id: Library.Id, minimum: 1 */,
'artistid': -1 /* integer, id: Library.Id, minimum: 1 */,
'comment': '' /* string */,
'duration': 0 /* integer */,
'file': '' /* string */,
'lyrics': '' /* string */,
'musicbrainzartistid': '' /* string */,
'musicbrainztrackid': '' /* string */,
'playcount': 0 /* integer */,
'songid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'track': 0 /* integer */,
'artist': '' /* string */,
'musicbrainzalbumartistid': '' /* string */,
'musicbrainzalbumid': '' /* string */,
'rating': 0 /* integer */,
'title': '' /* string */,
'year': 0 /* integer */,
'genre': '' /* string */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
}
}
AudioLibrary.GetSongs
Retrieve all songs from specified album, artist or genre
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetSongs',
'id': undefined /* integer, required */,
'params': {
'artistid': -1 /* integer, id: Library.Id, minimum: 1 */,
'albumid': -1 /* integer, id: Library.Id, minimum: 1 */,
'genreid': -1 /* integer, id: Library.Id, minimum: 1 */,
'properties': [ /* id: Audio.Fields.Song */
undefined /* string */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.GetSongs',
'id': undefined /* integer, required */,
'result': {
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
},
'songs': [ /* array */
{ /* id: Audio.Details.Song */
'album': '' /* string */,
'albumartist': '' /* string */,
'albumid': -1 /* integer, id: Library.Id, minimum: 1 */,
'artistid': -1 /* integer, id: Library.Id, minimum: 1 */,
'comment': '' /* string */,
'duration': 0 /* integer */,
'file': '' /* string */,
'lyrics': '' /* string */,
'musicbrainzartistid': '' /* string */,
'musicbrainztrackid': '' /* string */,
'playcount': 0 /* integer */,
'songid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'track': 0 /* integer */,
'artist': '' /* string */,
'musicbrainzalbumartistid': '' /* string */,
'musicbrainzalbumid': '' /* string */,
'rating': 0 /* integer */,
'title': '' /* string */,
'year': 0 /* integer */,
'genre': '' /* string */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
]
}
}
AudioLibrary.Scan
Scans the audio sources for new library items
Permissions
UpdateData
Syntax
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.Scan',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'AudioLibrary.Scan',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
VideoLibrary
Video Library information
Notifications
VideoLibrary.OnRemove
A video item has been removed.
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.OnRemove',
'params': undefined /* string, required */ or { /* required */
'id': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'type': undefined /* required */
}
}
VideoLibrary.OnUpdate
A video item has been updated.
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.OnUpdate',
'params': undefined /* string, required */ or { /* required */
'id': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'playcount': -1 /* integer, minimum: 0 */,
'type': undefined /* string ('movie', 'tvshow', 'episode', 'musicvideo'), required, id: Notifications.Library.Video.Type */
}
}
Methods
VideoLibrary.Clean
Cleans the video library from non-existent items
Permissions
RemoveData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.Clean',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.Clean',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
VideoLibrary.Export
Exports all items from the video library
Permissions
WriteFile
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.Export',
'id': undefined /* integer, required */,
'params': {
'options': { /* no additional properties allowed */
'path': undefined /* string, required, minimum length: 1, Path to the directory to where the data should be exported */
} or { /* no additional properties allowed */
'actorthumbs': false /* boolean, Whether to export actor thumbnails */,
'images': false /* boolean, Whether to export thumbnails and fanart images */,
'overwrite': false /* boolean, Whether to overwrite existing exported files */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.Export',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
VideoLibrary.GetEpisodeDetails
Retrieve details about a specific tv show episode
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetEpisodeDetails',
'id': undefined /* integer, required */,
'params': {
'episodeid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'properties': [ /* id: Video.Fields.Episode */
undefined /* string, Requesting the cast and/or resume field will result in increased response times */
]
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetEpisodeDetails',
'id': undefined /* integer, required */,
'result': {
'episodedetails': { /* id: Video.Details.Episode */
'cast': [ /* array, id: Video.Cast */
{ /* no additional properties allowed */
'name': undefined /* string, required */,
'role': undefined /* string, required */,
'thumbnail': '' /* string */
}
],
'episode': 0 /* integer */,
'episodeid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'firstaired': '' /* string */,
'originaltitle': '' /* string */,
'productioncode': '' /* string */,
'rating': 0 /* number */,
'season': 0 /* integer */,
'showtitle': '' /* string */,
'tvshowid': -1 /* integer, id: Library.Id, minimum: 1 */,
'votes': '' /* string */,
'writer': '' /* string */,
'director': '' /* string */,
'resume': { /* id: Video.Resume, no additional properties allowed */
'position': 0 /* number, minimum: 0 */,
'total': 0 /* number, minimum: 0 */
},
'runtime': '' /* string */,
'streamdetails': { /* id: Video.Streams, no additional properties allowed */
'audio': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'channels': 0 /* integer */,
'codec': '' /* string */,
'language': '' /* string */
}
],
'subtitle': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'language': '' /* string */
}
],
'video': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'aspect': 0 /* number */,
'codec': '' /* string */,
'duration': 0 /* integer */,
'height': 0 /* integer */,
'width': 0 /* integer */
}
]
},
'file': '' /* string */,
'lastplayed': '' /* string */,
'plot': '' /* string */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
}
}
VideoLibrary.GetEpisodes
Retrieve all tv show episodes
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetEpisodes',
'id': undefined /* integer, required */,
'params': {
'tvshowid': -1 /* integer, id: Library.Id, minimum: 1 */,
'season': -1 /* integer, minimum: 0 */,
'properties': [ /* id: Video.Fields.Episode */
undefined /* string, Requesting the cast and/or resume field will result in increased response times */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetEpisodes',
'id': undefined /* integer, required */,
'result': {
'episodes': [ /* array */
{ /* id: Video.Details.Episode */
'cast': [ /* array, id: Video.Cast */
{ /* no additional properties allowed */
'name': undefined /* string, required */,
'role': undefined /* string, required */,
'thumbnail': '' /* string */
}
],
'episode': 0 /* integer */,
'episodeid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'firstaired': '' /* string */,
'originaltitle': '' /* string */,
'productioncode': '' /* string */,
'rating': 0 /* number */,
'season': 0 /* integer */,
'showtitle': '' /* string */,
'tvshowid': -1 /* integer, id: Library.Id, minimum: 1 */,
'votes': '' /* string */,
'writer': '' /* string */,
'director': '' /* string */,
'resume': { /* id: Video.Resume, no additional properties allowed */
'position': 0 /* number, minimum: 0 */,
'total': 0 /* number, minimum: 0 */
},
'runtime': '' /* string */,
'streamdetails': { /* id: Video.Streams, no additional properties allowed */
'audio': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'channels': 0 /* integer */,
'codec': '' /* string */,
'language': '' /* string */
}
],
'subtitle': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'language': '' /* string */
}
],
'video': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'aspect': 0 /* number */,
'codec': '' /* string */,
'duration': 0 /* integer */,
'height': 0 /* integer */,
'width': 0 /* integer */
}
]
},
'file': '' /* string */,
'lastplayed': '' /* string */,
'plot': '' /* string */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
],
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
}
}
}
VideoLibrary.GetGenres
Retrieve all genres
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetGenres',
'id': undefined /* integer, required */,
'params': {
'type': undefined /* string, required */,
'properties': [ /* id: Library.Fields.Genre */
undefined /* string */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetGenres',
'id': undefined /* integer, required */,
'result': {
'genres': [ /* array, required */
{ /* id: Library.Details.Genre */
'genreid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'thumbnail': '' /* string */,
'title': '' /* string */,
'label': undefined /* string, required */
}
],
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
}
}
}
VideoLibrary.GetMovieDetails
Retrieve details about a specific movie
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetMovieDetails',
'id': undefined /* integer, required */,
'params': {
'movieid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'properties': [ /* id: Video.Fields.Movie */
undefined /* string, Requesting the cast, set, showling and/or resume field will result in increased response times */
]
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetMovieDetails',
'id': undefined /* integer, required */,
'result': {
'moviedetails': { /* id: Video.Details.Movie */
'cast': [ /* array, id: Video.Cast */
{ /* no additional properties allowed */
'name': undefined /* string, required */,
'role': undefined /* string, required */,
'thumbnail': '' /* string */
}
],
'country': '' /* string */,
'genre': '' /* string */,
'imdbnumber': '' /* string */,
'movieid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'mpaa': '' /* string */,
'originaltitle': '' /* string */,
'plotoutline': '' /* string */,
'premiered': '' /* string */,
'productioncode': '' /* string */,
'rating': 0 /* number */,
'set': [ /* array, id: Array.String */
undefined /* string, minimum length: 1 */
],
'setid': [ /* array, id: Array.Integer */
undefined /* integer */
],
'showlink': '' /* string */,
'sorttitle': '' /* string */,
'studio': '' /* string */,
'tagline': '' /* string */,
'top250': 0 /* integer */,
'trailer': '' /* string */,
'votes': '' /* string */,
'writer': '' /* string */,
'year': 0 /* integer */,
'director': '' /* string */,
'resume': { /* id: Video.Resume, no additional properties allowed */
'position': 0 /* number, minimum: 0 */,
'total': 0 /* number, minimum: 0 */
},
'runtime': '' /* string */,
'streamdetails': { /* id: Video.Streams, no additional properties allowed */
'audio': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'channels': 0 /* integer */,
'codec': '' /* string */,
'language': '' /* string */
}
],
'subtitle': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'language': '' /* string */
}
],
'video': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'aspect': 0 /* number */,
'codec': '' /* string */,
'duration': 0 /* integer */,
'height': 0 /* integer */,
'width': 0 /* integer */
}
]
},
'file': '' /* string */,
'lastplayed': '' /* string */,
'plot': '' /* string */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
}
}
VideoLibrary.GetMovieSetDetails
Retrieve details about a specific movie set
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetMovieSetDetails',
'id': undefined /* integer, required */,
'params': {
'setid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'properties': [ /* id: Video.Fields.MovieSet */
undefined /* string */
],
'movies': {
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'properties': [ /* id: Video.Fields.Movie */
undefined /* string, Requesting the cast, set, showling and/or resume field will result in increased response times */
],
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetMovieSetDetails',
'id': undefined /* integer, required */,
'result': {
'setdetails': { /* id: Video.Details.MovieSet.Extended */
'movies': [ /* array */
{ /* id: Video.Details.Movie */
'cast': [ /* array, id: Video.Cast */
{ /* no additional properties allowed */
'name': undefined /* string, required */,
'role': undefined /* string, required */,
'thumbnail': '' /* string */
}
],
'country': '' /* string */,
'genre': '' /* string */,
'imdbnumber': '' /* string */,
'movieid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'mpaa': '' /* string */,
'originaltitle': '' /* string */,
'plotoutline': '' /* string */,
'premiered': '' /* string */,
'productioncode': '' /* string */,
'rating': 0 /* number */,
'set': [ /* array, id: Array.String */
undefined /* string, minimum length: 1 */
],
'setid': [ /* array, id: Array.Integer */
undefined /* integer */
],
'showlink': '' /* string */,
'sorttitle': '' /* string */,
'studio': '' /* string */,
'tagline': '' /* string */,
'top250': 0 /* integer */,
'trailer': '' /* string */,
'votes': '' /* string */,
'writer': '' /* string */,
'year': 0 /* integer */,
'director': '' /* string */,
'resume': { /* id: Video.Resume, no additional properties allowed */
'position': 0 /* number, minimum: 0 */,
'total': 0 /* number, minimum: 0 */
},
'runtime': '' /* string */,
'streamdetails': { /* id: Video.Streams, no additional properties allowed */
'audio': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'channels': 0 /* integer */,
'codec': '' /* string */,
'language': '' /* string */
}
],
'subtitle': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'language': '' /* string */
}
],
'video': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'aspect': 0 /* number */,
'codec': '' /* string */,
'duration': 0 /* integer */,
'height': 0 /* integer */,
'width': 0 /* integer */
}
]
},
'file': '' /* string */,
'lastplayed': '' /* string */,
'plot': '' /* string */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
],
'setid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
}
}
VideoLibrary.GetMovieSets
Retrieve all movie sets
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetMovieSets',
'id': undefined /* integer, required */,
'params': {
'properties': [ /* id: Video.Fields.MovieSet */
undefined /* string */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetMovieSets',
'id': undefined /* integer, required */,
'result': {
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
},
'sets': [ /* array */
{ /* id: Video.Details.MovieSet */
'setid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
]
}
}
VideoLibrary.GetMovies
Retrieve all movies
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetMovies',
'id': undefined /* integer, required */,
'params': {
'properties': [ /* id: Video.Fields.Movie */
undefined /* string, Requesting the cast, set, showling and/or resume field will result in increased response times */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetMovies',
'id': undefined /* integer, required */,
'result': {
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
},
'movies': [ /* array */
{ /* id: Video.Details.Movie */
'cast': [ /* array, id: Video.Cast */
{ /* no additional properties allowed */
'name': undefined /* string, required */,
'role': undefined /* string, required */,
'thumbnail': '' /* string */
}
],
'country': '' /* string */,
'genre': '' /* string */,
'imdbnumber': '' /* string */,
'movieid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'mpaa': '' /* string */,
'originaltitle': '' /* string */,
'plotoutline': '' /* string */,
'premiered': '' /* string */,
'productioncode': '' /* string */,
'rating': 0 /* number */,
'set': [ /* array, id: Array.String */
undefined /* string, minimum length: 1 */
],
'setid': [ /* array, id: Array.Integer */
undefined /* integer */
],
'showlink': '' /* string */,
'sorttitle': '' /* string */,
'studio': '' /* string */,
'tagline': '' /* string */,
'top250': 0 /* integer */,
'trailer': '' /* string */,
'votes': '' /* string */,
'writer': '' /* string */,
'year': 0 /* integer */,
'director': '' /* string */,
'resume': { /* id: Video.Resume, no additional properties allowed */
'position': 0 /* number, minimum: 0 */,
'total': 0 /* number, minimum: 0 */
},
'runtime': '' /* string */,
'streamdetails': { /* id: Video.Streams, no additional properties allowed */
'audio': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'channels': 0 /* integer */,
'codec': '' /* string */,
'language': '' /* string */
}
],
'subtitle': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'language': '' /* string */
}
],
'video': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'aspect': 0 /* number */,
'codec': '' /* string */,
'duration': 0 /* integer */,
'height': 0 /* integer */,
'width': 0 /* integer */
}
]
},
'file': '' /* string */,
'lastplayed': '' /* string */,
'plot': '' /* string */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
]
}
}
VideoLibrary.GetMusicVideoDetails
Retrieve details about a specific music video
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetMusicVideoDetails',
'id': undefined /* integer, required */,
'params': {
'musicvideoid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'properties': [ /* id: Video.Fields.MusicVideo */
undefined /* string, Requesting the resume field will result in increased response times */
]
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetMusicVideoDetails',
'id': undefined /* integer, required */,
'result': {
'musicvideodetails': { /* id: Video.Details.MusicVideo */
'album': '' /* string */,
'artist': '' /* string */,
'genre': '' /* string */,
'musicvideoid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'studio': '' /* string */,
'track': 0 /* integer */,
'year': 0 /* integer */,
'director': '' /* string */,
'resume': { /* id: Video.Resume, no additional properties allowed */
'position': 0 /* number, minimum: 0 */,
'total': 0 /* number, minimum: 0 */
},
'runtime': '' /* string */,
'streamdetails': { /* id: Video.Streams, no additional properties allowed */
'audio': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'channels': 0 /* integer */,
'codec': '' /* string */,
'language': '' /* string */
}
],
'subtitle': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'language': '' /* string */
}
],
'video': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'aspect': 0 /* number */,
'codec': '' /* string */,
'duration': 0 /* integer */,
'height': 0 /* integer */,
'width': 0 /* integer */
}
]
},
'file': '' /* string */,
'lastplayed': '' /* string */,
'plot': '' /* string */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
}
}
VideoLibrary.GetMusicVideos
Retrieve all music videos
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetMusicVideos',
'id': undefined /* integer, required */,
'params': {
'artistid': -1 /* integer, id: Library.Id, minimum: 1 */,
'albumid': -1 /* integer, id: Library.Id, minimum: 1 */,
'properties': [ /* id: Video.Fields.MusicVideo */
undefined /* string, Requesting the resume field will result in increased response times */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetMusicVideos',
'id': undefined /* integer, required */,
'result': {
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
},
'musicvideos': [ /* array */
{ /* id: Video.Details.MusicVideo */
'album': '' /* string */,
'artist': '' /* string */,
'genre': '' /* string */,
'musicvideoid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'studio': '' /* string */,
'track': 0 /* integer */,
'year': 0 /* integer */,
'director': '' /* string */,
'resume': { /* id: Video.Resume, no additional properties allowed */
'position': 0 /* number, minimum: 0 */,
'total': 0 /* number, minimum: 0 */
},
'runtime': '' /* string */,
'streamdetails': { /* id: Video.Streams, no additional properties allowed */
'audio': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'channels': 0 /* integer */,
'codec': '' /* string */,
'language': '' /* string */
}
],
'subtitle': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'language': '' /* string */
}
],
'video': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'aspect': 0 /* number */,
'codec': '' /* string */,
'duration': 0 /* integer */,
'height': 0 /* integer */,
'width': 0 /* integer */
}
]
},
'file': '' /* string */,
'lastplayed': '' /* string */,
'plot': '' /* string */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
]
}
}
VideoLibrary.GetRecentlyAddedEpisodes
Retrieve all recently added tv episodes
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetRecentlyAddedEpisodes',
'id': undefined /* integer, required */,
'params': {
'properties': [ /* id: Video.Fields.Episode */
undefined /* string, Requesting the cast and/or resume field will result in increased response times */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetRecentlyAddedEpisodes',
'id': undefined /* integer, required */,
'result': {
'episodes': [ /* array */
{ /* id: Video.Details.Episode */
'cast': [ /* array, id: Video.Cast */
{ /* no additional properties allowed */
'name': undefined /* string, required */,
'role': undefined /* string, required */,
'thumbnail': '' /* string */
}
],
'episode': 0 /* integer */,
'episodeid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'firstaired': '' /* string */,
'originaltitle': '' /* string */,
'productioncode': '' /* string */,
'rating': 0 /* number */,
'season': 0 /* integer */,
'showtitle': '' /* string */,
'tvshowid': -1 /* integer, id: Library.Id, minimum: 1 */,
'votes': '' /* string */,
'writer': '' /* string */,
'director': '' /* string */,
'resume': { /* id: Video.Resume, no additional properties allowed */
'position': 0 /* number, minimum: 0 */,
'total': 0 /* number, minimum: 0 */
},
'runtime': '' /* string */,
'streamdetails': { /* id: Video.Streams, no additional properties allowed */
'audio': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'channels': 0 /* integer */,
'codec': '' /* string */,
'language': '' /* string */
}
],
'subtitle': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'language': '' /* string */
}
],
'video': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'aspect': 0 /* number */,
'codec': '' /* string */,
'duration': 0 /* integer */,
'height': 0 /* integer */,
'width': 0 /* integer */
}
]
},
'file': '' /* string */,
'lastplayed': '' /* string */,
'plot': '' /* string */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
],
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
}
}
}
VideoLibrary.GetRecentlyAddedMovies
Retrieve all recently added movies
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetRecentlyAddedMovies',
'id': undefined /* integer, required */,
'params': {
'properties': [ /* id: Video.Fields.Movie */
undefined /* string, Requesting the cast, set, showling and/or resume field will result in increased response times */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetRecentlyAddedMovies',
'id': undefined /* integer, required */,
'result': {
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
},
'movies': [ /* array */
{ /* id: Video.Details.Movie */
'cast': [ /* array, id: Video.Cast */
{ /* no additional properties allowed */
'name': undefined /* string, required */,
'role': undefined /* string, required */,
'thumbnail': '' /* string */
}
],
'country': '' /* string */,
'genre': '' /* string */,
'imdbnumber': '' /* string */,
'movieid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'mpaa': '' /* string */,
'originaltitle': '' /* string */,
'plotoutline': '' /* string */,
'premiered': '' /* string */,
'productioncode': '' /* string */,
'rating': 0 /* number */,
'set': [ /* array, id: Array.String */
undefined /* string, minimum length: 1 */
],
'setid': [ /* array, id: Array.Integer */
undefined /* integer */
],
'showlink': '' /* string */,
'sorttitle': '' /* string */,
'studio': '' /* string */,
'tagline': '' /* string */,
'top250': 0 /* integer */,
'trailer': '' /* string */,
'votes': '' /* string */,
'writer': '' /* string */,
'year': 0 /* integer */,
'director': '' /* string */,
'resume': { /* id: Video.Resume, no additional properties allowed */
'position': 0 /* number, minimum: 0 */,
'total': 0 /* number, minimum: 0 */
},
'runtime': '' /* string */,
'streamdetails': { /* id: Video.Streams, no additional properties allowed */
'audio': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'channels': 0 /* integer */,
'codec': '' /* string */,
'language': '' /* string */
}
],
'subtitle': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'language': '' /* string */
}
],
'video': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'aspect': 0 /* number */,
'codec': '' /* string */,
'duration': 0 /* integer */,
'height': 0 /* integer */,
'width': 0 /* integer */
}
]
},
'file': '' /* string */,
'lastplayed': '' /* string */,
'plot': '' /* string */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
]
}
}
VideoLibrary.GetRecentlyAddedMusicVideos
Retrieve all recently added music videos
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetRecentlyAddedMusicVideos',
'id': undefined /* integer, required */,
'params': {
'properties': [ /* id: Video.Fields.MusicVideo */
undefined /* string, Requesting the resume field will result in increased response times */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetRecentlyAddedMusicVideos',
'id': undefined /* integer, required */,
'result': {
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
},
'musicvideos': [ /* array */
{ /* id: Video.Details.MusicVideo */
'album': '' /* string */,
'artist': '' /* string */,
'genre': '' /* string */,
'musicvideoid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'studio': '' /* string */,
'track': 0 /* integer */,
'year': 0 /* integer */,
'director': '' /* string */,
'resume': { /* id: Video.Resume, no additional properties allowed */
'position': 0 /* number, minimum: 0 */,
'total': 0 /* number, minimum: 0 */
},
'runtime': '' /* string */,
'streamdetails': { /* id: Video.Streams, no additional properties allowed */
'audio': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'channels': 0 /* integer */,
'codec': '' /* string */,
'language': '' /* string */
}
],
'subtitle': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'language': '' /* string */
}
],
'video': [ /* array, minimum items: 1 */
{ /* no additional properties allowed */
'aspect': 0 /* number */,
'codec': '' /* string */,
'duration': 0 /* integer */,
'height': 0 /* integer */,
'width': 0 /* integer */
}
]
},
'file': '' /* string */,
'lastplayed': '' /* string */,
'plot': '' /* string */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
]
}
}
VideoLibrary.GetSeasons
Retrieve all tv seasons
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetSeasons',
'id': undefined /* integer, required */,
'params': {
'tvshowid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'properties': [ /* id: Video.Fields.Season */
undefined /* string */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetSeasons',
'id': undefined /* integer, required */,
'result': {
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
},
'seasons': [ /* array */
{ /* id: Video.Details.Season */
'episode': 0 /* integer */,
'season': undefined /* integer, required */,
'showtitle': '' /* string */,
'tvshowid': -1 /* integer, id: Library.Id, minimum: 1 */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
]
}
}
VideoLibrary.GetTVShowDetails
Retrieve details about a specific tv show
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetTVShowDetails',
'id': undefined /* integer, required */,
'params': {
'tvshowid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'properties': [ /* id: Video.Fields.TVShow */
undefined /* string, Requesting the cast field will result in increased response times */
]
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetTVShowDetails',
'id': undefined /* integer, required */,
'result': {
'tvshowdetails': { /* id: Video.Details.TVShow */
'cast': [ /* array, id: Video.Cast */
{ /* no additional properties allowed */
'name': undefined /* string, required */,
'role': undefined /* string, required */,
'thumbnail': '' /* string */
}
],
'episode': 0 /* integer */,
'episodeguide': '' /* string */,
'genre': '' /* string */,
'imdbnumber': '' /* string */,
'mpaa': '' /* string */,
'originaltitle': '' /* string */,
'premiered': '' /* string */,
'rating': 0 /* number */,
'sorttitle': '' /* string */,
'studio': '' /* string */,
'tvshowid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'votes': '' /* string */,
'year': 0 /* integer */,
'file': '' /* string */,
'lastplayed': '' /* string */,
'plot': '' /* string */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
}
}
VideoLibrary.GetTVShows
Retrieve all tv shows
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetTVShows',
'id': undefined /* integer, required */,
'params': {
'properties': [ /* id: Video.Fields.TVShow */
undefined /* string, Requesting the cast field will result in increased response times */
],
'limits': { /* id: List.Limits, no additional properties allowed */
'end': -1 /* integer, minimum: 0, The number of items in the list being returned */,
'start': 0 /* integer, minimum: 0 */
},
'sort': { /* id: List.Sort */
'ignorearticle': false /* boolean */,
'method': 'none' /* string */,
'order': 'ascending' /* string */
}
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.GetTVShows',
'id': undefined /* integer, required */,
'result': {
'limits': { /* required, id: List.LimitsReturned, no additional properties allowed */
'end': -1 /* integer, minimum: 0 */,
'start': 0 /* integer, minimum: 0 */,
'total': undefined /* integer, required, minimum: 0 */
},
'tvshows': [ /* array */
{ /* id: Video.Details.TVShow */
'cast': [ /* array, id: Video.Cast */
{ /* no additional properties allowed */
'name': undefined /* string, required */,
'role': undefined /* string, required */,
'thumbnail': '' /* string */
}
],
'episode': 0 /* integer */,
'episodeguide': '' /* string */,
'genre': '' /* string */,
'imdbnumber': '' /* string */,
'mpaa': '' /* string */,
'originaltitle': '' /* string */,
'premiered': '' /* string */,
'rating': 0 /* number */,
'sorttitle': '' /* string */,
'studio': '' /* string */,
'tvshowid': -1 /* integer, required, id: Library.Id, minimum: 1 */,
'votes': '' /* string */,
'year': 0 /* integer */,
'file': '' /* string */,
'lastplayed': '' /* string */,
'plot': '' /* string */,
'title': '' /* string */,
'playcount': 0 /* integer */,
'fanart': '' /* string */,
'thumbnail': '' /* string */,
'label': undefined /* string, required */
}
]
}
}
VideoLibrary.Scan
Scans the video sources for new library items
Permissions
UpdateData
Syntax
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.Scan',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'VideoLibrary.Scan',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Input
Allows limited navigation within XBMC
Methods
Input.Back
Goes back in GUI
Permissions
Navigate
Syntax
{
'jsonrpc': '2.0',
'method': 'Input.Back',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'Input.Back',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Input.Down
Navigate down in GUI
Permissions
Navigate
Syntax
{
'jsonrpc': '2.0',
'method': 'Input.Down',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'Input.Down',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Input.Home
Goes to home window in GUI
Permissions
Navigate
Syntax
{
'jsonrpc': '2.0',
'method': 'Input.Home',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'Input.Home',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Input.Left
Navigate left in GUI
Permissions
Navigate
Syntax
{
'jsonrpc': '2.0',
'method': 'Input.Left',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'Input.Left',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Input.Right
Navigate right in GUI
Permissions
Navigate
Syntax
{
'jsonrpc': '2.0',
'method': 'Input.Right',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'Input.Right',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Input.Select
Select current item in GUI
Permissions
Navigate
Syntax
{
'jsonrpc': '2.0',
'method': 'Input.Select',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'Input.Select',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Input.Up
Navigate up in GUI
Permissions
Navigate
Syntax
{
'jsonrpc': '2.0',
'method': 'Input.Up',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'Input.Up',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Application
Application information and control
Methods
Application.GetProperties
Retrieves the values of the given properties
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'Application.GetProperties',
'id': undefined /* integer, required */,
'params': {
'properties': [ /* array, required, all items must be unique */
'volume' /* string, id: Application.Property.Name */
]
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Application.GetProperties',
'id': undefined /* integer, required */,
'result': { /* id: Application.Property.Value */
'muted': false /* boolean */,
'name': '' /* string, minimum length: 1 */,
'version': {
'major': undefined /* integer, required, minimum: 0 */,
'minor': undefined /* integer, required, minimum: 0 */,
'revision': undefined /* string */ or undefined /* integer, minimum: 0 */,
'tag': undefined /* string, required */
},
'volume': 0 /* integer */
}
}
Application.Quit
Quit application
Permissions
ControlPower
Syntax
{
'jsonrpc': '2.0',
'method': 'Application.Quit',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'Application.Quit',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
Application.SetMute
Toggle mute/unmute
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Application.SetMute',
'id': undefined /* integer, required */,
'params': {
'mute': undefined /* boolean */ or undefined /* string */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Application.SetMute',
'id': undefined /* integer, required */,
'result': undefined /* boolean, Mute state */
}
Application.SetVolume
Set the current volume
Permissions
ControlPlayback
Syntax
{
'jsonrpc': '2.0',
'method': 'Application.SetVolume',
'id': undefined /* integer, required */,
'params': {
'volume': undefined /* integer, required, minimum: 0, maximum: 100 */
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'Application.SetVolume',
'id': undefined /* integer, required */,
'result': undefined /* integer, minimum: 0 */
}
System
System controls and information
Notifications
System.OnLowBattery
The system is on low battery.
Returns
{
'jsonrpc': '2.0',
'method': 'System.OnLowBattery',
'params': undefined /* string, required */ or undefined /* null, required */
}
System.OnQuit
XBMC will be closed.
Returns
{
'jsonrpc': '2.0',
'method': 'System.OnQuit',
'params': undefined /* string, required */ or undefined /* null, required */
}
System.OnRestart
The system will be restarted.
Returns
{
'jsonrpc': '2.0',
'method': 'System.OnRestart',
'params': undefined /* string, required */ or undefined /* null, required */
}
System.OnSleep
The system will be suspended.
Returns
{
'jsonrpc': '2.0',
'method': 'System.OnSleep',
'params': undefined /* string, required */ or undefined /* null, required */
}
System.OnWake
The system woke up from suspension.
Returns
{
'jsonrpc': '2.0',
'method': 'System.OnWake',
'params': undefined /* string, required */ or undefined /* null, required */
}
Methods
System.GetProperties
Retrieves the values of the given properties
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'System.GetProperties',
'id': undefined /* integer, required */,
'params': {
'properties': [ /* array, required, all items must be unique */
'canshutdown' /* string, id: System.Property.Name */
]
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'System.GetProperties',
'id': undefined /* integer, required */,
'result': { /* id: System.Property.Value */
'canhibernate': false /* boolean */,
'canreboot': false /* boolean */,
'canshutdown': false /* boolean */,
'cansuspend': false /* boolean */
}
}
System.Hibernate
Puts the system running XBMC into hibernate mode
Permissions
ControlPower
Syntax
{
'jsonrpc': '2.0',
'method': 'System.Hibernate',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'System.Hibernate',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
System.Reboot
Reboots the system running XBMC
Permissions
ControlPower
Syntax
{
'jsonrpc': '2.0',
'method': 'System.Reboot',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'System.Reboot',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
System.Shutdown
Shuts the system running XBMC down
Permissions
ControlPower
Syntax
{
'jsonrpc': '2.0',
'method': 'System.Shutdown',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'System.Shutdown',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
System.Suspend
Suspends the system running XBMC
Permissions
ControlPower
Syntax
{
'jsonrpc': '2.0',
'method': 'System.Suspend',
'id': undefined /* integer, required */
}
Returns
{
'jsonrpc': '2.0',
'method': 'System.Suspend',
'id': undefined /* integer, required */,
'result': undefined /* string */
}
XBMC
Dumping ground for very XBMC specific operations
Methods
XBMC.GetInfoBooleans
Retrieve info booleans about XBMC and the system
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'XBMC.GetInfoBooleans',
'id': undefined /* integer, required */,
'params': {
'booleans': [ /* array, required, minimum items: 1 */
undefined /* string */
]
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'XBMC.GetInfoBooleans',
'id': undefined /* integer, required */,
'result': { /* List of key-value pairs of the retrieved info booleans */
}
}
XBMC.GetInfoLabels
Retrieve info labels about XBMC and the system
Permissions
ReadData
Syntax
{
'jsonrpc': '2.0',
'method': 'XBMC.GetInfoLabels',
'id': undefined /* integer, required */,
'params': {
'labels': [ /* array, required, minimum items: 1, See http://wiki.xbmc.org/index.php?title=InfoLabels for a list of possible info labels */
undefined /* string */
]
}
}
Returns
{
'jsonrpc': '2.0',
'method': 'XBMC.GetInfoLabels',
'id': undefined /* integer, required */,
'result': { /* List of key-value pairs of the retrieved info labels */
}
}
JSON-RPC 2.0 compatibility
| Version | Method calls | Notifications (server-side) |
Notifications (client-side) |
Parameters by-name |
Parameters by-position |
Batch requests |
|---|---|---|---|---|---|---|
| Version 4 | Yes | Yes | Yes | Yes | Yes | Yes |