Archive:JSON-RPC API/v6
Development | JSON-RPC API | v6 |
Version 6 is a stable version of XBMC's JSON-RPC API and is published with the release of XBMC v12 (Frodo) and v13 (Gotham) . It comes with support for WebSockets as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with XBMC's JSON-RPC API and can therefore also profit from additional features like notifications.
Some of the methods have been changed or removed, so v6 is not 100% backwards compatible with older versions. A rough and incomplete list of changes compared to version 4 can be found here. A more complete and detailed list can be found in the forum.
JSON-RPC 2.0 compatibility
Version | Method calls | Notifications (server-side) |
Notifications (client-side) |
Parameters by-name |
Parameters by-position |
Batch requests |
---|---|---|---|---|---|---|
Version 6 | Yes | Yes | Yes | Yes | Yes | Yes |
Documentation (JSON Schema)
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" } } } } } } } |
Namespaces
The XBMC JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:
JSONRPC A variety of standard JSONRPC calls Player Manages all available players Playlist Playlist modification Files Shares information AudioLibrary Audio Library information VideoLibrary Video Library information Input Allows limited navigation within XBMC Application Application information and control System System controls and information Favourites Favourites GetFavourites and AddFavourite Profiles Support for Profiles operations to XBMC. Settings Allows manipulation of {{name}} settings. Textures with GetTextures and RemoveTexture XBMC Dumping ground for very {{name}} specific operations |
Methods
Addons
Addons.ExecuteAddon
Executes the given addon with the given parameters (if possible)
Permissions:
- ExecuteAddon
Parameters:
- string addonid
- [ mixed params = null ]
- [ boolean wait = False ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "name": "addonid", "required": true, "type": "string" }, { "name": "params", "type": [ { "additionalProperties": { "type": "string", "default": "" }, "type": "object" }, { "items": { "type": "string" }, "type": "array" } ], "default": null }, { "name": "wait", "type": "boolean", "default": false } ], "description": "Executes the given addon with the given parameters (if possible)", "returns": { "type": "string" } } |
Addons.GetAddonDetails
Gets the details of a specific addon
Permissions:
- ReadData
Parameters:
- string addonid
- [ Addon.Fields properties ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- Addon.Details addon
JSON Schema Description |
---|
{ "params": [ { "name": "addonid", "required": true, "type": "string" }, { "$ref": "Addon.Fields", "name": "properties" } ], "description": "Gets the details of a specific addon", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "addon": { "$ref": "Addon.Details", "required": true } }, "type": "object" } } |
Addons.GetAddons
Gets all available addons
Permissions:
- ReadData
Parameters:
- [ Addon.Types type = "unknown" ]
- [ Addon.Content content = "unknown" ]
- [ mixed enabled = "all" ]
- [ Addon.Fields properties ]
- [ List.Limits limits ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Addon.Details[] addons ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Addon.Types", "name": "type", "default": "unknown" }, { "$ref": "Addon.Content", "description": "Content provided by the addon. Only considered for plugins and scripts.", "name": "content", "default": "unknown" }, { "name": "enabled", "type": [ { "type": "boolean" }, { "enums": [ "all" ], "type": "string" } ], "default": "all" }, { "$ref": "Addon.Fields", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" } ], "description": "Gets all available addons", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "addons": { "items": { "$ref": "Addon.Details" }, "type": "array" } }, "type": "object" } } |
Addons.SetAddonEnabled
Enables/Disables a specific addon
Permissions:
- ManageAddon
Parameters:
- string addonid
- Global.Toggle enabled
Returns: string
JSON Schema Description |
---|
{ "params": [ { "name": "addonid", "required": true, "type": "string" }, { "$ref": "Global.Toggle", "name": "enabled", "required": true } ], "description": "Enables/Disables a specific addon", "returns": { "type": "string" } } |
Application
Application.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- Application.Property.Name[] properties
Returns: Application.Property.Value
JSON Schema Description |
---|
{ "params": [ { "uniqueItems": true, "items": { "$ref": "Application.Property.Name" }, "name": "properties", "type": "array", "required": true } ], "description": "Retrieves the values of the given properties", "returns": { "$ref": "Application.Property.Value" } } |
Application.Quit
Quit application
Permissions:
- ControlPower
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Quit application", "returns": { "type": "string" } } |
Application.SetMute
Toggle mute/unmute
Permissions:
- ControlPlayback
Parameters:
- Global.Toggle mute
Returns: boolean
JSON Schema Description |
---|
{ "params": [ { "$ref": "Global.Toggle", "name": "mute", "required": true } ], "description": "Toggle mute/unmute", "returns": { "description": "Mute state", "type": "boolean" } } |
Application.SetVolume
Set the current volume
Permissions:
- ControlPlayback
Parameters:
- mixed volume
Returns: integer
JSON Schema Description |
---|
{ "params": [ { "name": "volume", "required": true, "type": [ { "minimum": 0, "type": "integer", "maximum": 100 }, { "$ref": "Global.IncrementDecrement" } ] } ], "description": "Set the current volume", "returns": { "type": "integer" } } |
AudioLibrary
AudioLibrary.Clean
Cleans the audio library from non-existent items
Permissions:
- RemoveData
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Cleans the audio library from non-existent items", "returns": { "type": "string" } } |
AudioLibrary.Export
Exports all items from the audio library
Permissions:
- WriteFile
Parameters:
- [ mixed options ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "name": "options", "type": [ { "additionalProperties": false, "properties": { "path": { "description": "Path to the directory to where the data should be exported", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "overwrite": { "description": "Whether to overwrite existing exported files", "type": "boolean", "default": false }, "images": { "description": "Whether to export thumbnails and fanart images", "type": "boolean", "default": false } }, "type": "object" } ] } ], "description": "Exports all items from the audio library", "returns": { "type": "string" } } |
AudioLibrary.GetAlbumDetails
Retrieve details about a specific album
Permissions:
- ReadData
Parameters:
- Library.Id albumid
- [ Audio.Fields.Album properties ]
Returns:
Type: object
Properties:
- [ Audio.Details.Album albumdetails ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "albumid", "required": true }, { "$ref": "Audio.Fields.Album", "name": "properties" } ], "description": "Retrieve details about a specific album", "returns": { "properties": { "albumdetails": { "$ref": "Audio.Details.Album" } }, "type": "object" } } |
AudioLibrary.GetAlbums
Retrieve all albums from specified artist or genre
Permissions:
- ReadData
Parameters:
- [ Audio.Fields.Album properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
- [ mixed filter ]
Returns:
Type: object
Properties:
- [ Audio.Details.Album[] albums ]
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "params": [ { "$ref": "Audio.Fields.Album", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "name": "filter", "type": [ { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "$ref": "List.Filter.Albums" } ] } ], "description": "Retrieve all albums from specified artist or genre", "returns": { "properties": { "albums": { "items": { "$ref": "Audio.Details.Album" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" } } |
AudioLibrary.GetArtistDetails
Retrieve details about a specific artist
Permissions:
- ReadData
Parameters:
- Library.Id artistid
- [ Audio.Fields.Artist properties ]
Returns:
Type: object
Properties:
- [ Audio.Details.Artist artistdetails ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "artistid", "required": true }, { "$ref": "Audio.Fields.Artist", "name": "properties" } ], "description": "Retrieve details about a specific artist", "returns": { "properties": { "artistdetails": { "$ref": "Audio.Details.Artist" } }, "type": "object" } } |
AudioLibrary.GetArtists
Retrieve all artists
Permissions:
- ReadData
Parameters:
- [ Optional.Boolean albumartistsonly = null ]
- [ Audio.Fields.Artist properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
- [ mixed filter ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Audio.Details.Artist[] artists ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Optional.Boolean", "description": "Whether or not to include artists only appearing in compilations. If the parameter is not passed or is passed as null the GUI setting will be used", "name": "albumartistsonly", "default": null }, { "$ref": "Audio.Fields.Artist", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "name": "filter", "type": [ { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "albumid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "album": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "songid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "$ref": "List.Filter.Artists" } ] } ], "description": "Retrieve all artists", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "artists": { "items": { "$ref": "Audio.Details.Artist" }, "type": "array" } }, "type": "object" } } |
AudioLibrary.GetGenres
Retrieve all genres
Permissions:
- ReadData
Parameters:
- [ Library.Fields.Genre properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- Library.Details.Genre[] genres
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Fields.Genre", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "description": "Retrieve all genres", "returns": { "properties": { "genres": { "items": { "$ref": "Library.Details.Genre" }, "required": true, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" } } |
AudioLibrary.GetRecentlyAddedAlbums
Retrieve recently added albums
Permissions:
- ReadData
Parameters:
- [ Audio.Fields.Album properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- [ Audio.Details.Album[] albums ]
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "params": [ { "$ref": "Audio.Fields.Album", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "description": "Retrieve recently added albums", "returns": { "properties": { "albums": { "items": { "$ref": "Audio.Details.Album" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" } } |
AudioLibrary.GetRecentlyAddedSongs
Retrieve recently added songs
Permissions:
- ReadData
Parameters:
- [ List.Amount albumlimit = -1 ]
- [ Audio.Fields.Song properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Audio.Details.Song[] songs ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "List.Amount", "description": "The amount of recently added albums from which to return the songs", "name": "albumlimit", "default": -1 }, { "$ref": "Audio.Fields.Song", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "description": "Retrieve recently added songs", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "songs": { "items": { "$ref": "Audio.Details.Song" }, "type": "array" } }, "type": "object" } } |
AudioLibrary.GetRecentlyPlayedAlbums
Retrieve recently played albums
Permissions:
- ReadData
Parameters:
- [ Audio.Fields.Album properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- [ Audio.Details.Album[] albums ]
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "params": [ { "$ref": "Audio.Fields.Album", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "description": "Retrieve recently played albums", "returns": { "properties": { "albums": { "items": { "$ref": "Audio.Details.Album" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" } } |
AudioLibrary.GetRecentlyPlayedSongs
Retrieve recently played songs
Permissions:
- ReadData
Parameters:
- [ Audio.Fields.Song properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Audio.Details.Song[] songs ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Audio.Fields.Song", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "description": "Retrieve recently played songs", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "songs": { "items": { "$ref": "Audio.Details.Song" }, "type": "array" } }, "type": "object" } } |
AudioLibrary.GetSongDetails
Retrieve details about a specific song
Permissions:
- ReadData
Parameters:
- Library.Id songid
- [ Audio.Fields.Song properties ]
Returns:
Type: object
Properties:
- [ Audio.Details.Song songdetails ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "songid", "required": true }, { "$ref": "Audio.Fields.Song", "name": "properties" } ], "description": "Retrieve details about a specific song", "returns": { "properties": { "songdetails": { "$ref": "Audio.Details.Song" } }, "type": "object" } } |
AudioLibrary.GetSongs
Retrieve all songs from specified album, artist or genre
Permissions:
- ReadData
Parameters:
- [ Audio.Fields.Song properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
- [ mixed filter ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Audio.Details.Song[] songs ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Audio.Fields.Song", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "name": "filter", "type": [ { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "albumid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "album": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "$ref": "List.Filter.Songs" } ] } ], "description": "Retrieve all songs from specified album, artist or genre", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "songs": { "items": { "$ref": "Audio.Details.Song" }, "type": "array" } }, "type": "object" } } |
AudioLibrary.Scan
Scans the audio sources for new library items
Permissions:
- UpdateData
Parameters:
- [ string directory = "" ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "name": "directory", "type": "string", "default": "" } ], "description": "Scans the audio sources for new library items", "returns": { "type": "string" } } |
AudioLibrary.SetAlbumDetails
Update the given album with the given details
Permissions:
- UpdateData
Parameters:
- Library.Id albumid
- [ Optional.String title = null ]
- [ mixed artist = null ]
- [ Optional.String description = null ]
- [ mixed genre = null ]
- [ mixed theme = null ]
- [ mixed mood = null ]
- [ mixed style = null ]
- [ Optional.String type = null ]
- [ Optional.String albumlabel = null ]
- [ Optional.Integer rating = null ]
- [ Optional.Integer year = null ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "albumid", "required": true }, { "$ref": "Optional.String", "name": "title", "default": null }, { "name": "artist", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "$ref": "Optional.String", "name": "description", "default": null }, { "name": "genre", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "name": "theme", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "name": "mood", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "name": "style", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "$ref": "Optional.String", "name": "type", "default": null }, { "$ref": "Optional.String", "name": "albumlabel", "default": null }, { "$ref": "Optional.Integer", "name": "rating", "default": null }, { "$ref": "Optional.Integer", "name": "year", "default": null } ], "description": "Update the given album with the given details", "returns": { "type": "string" } } |
AudioLibrary.SetArtistDetails
Update the given artist with the given details
Permissions:
- UpdateData
Parameters:
- Library.Id artistid
- [ Optional.String artist = null ]
- [ mixed instrument = null ]
- [ mixed style = null ]
- [ mixed mood = null ]
- [ Optional.String born = null ]
- [ Optional.String formed = null ]
- [ Optional.String description = null ]
- [ mixed genre = null ]
- [ Optional.String died = null ]
- [ Optional.String disbanded = null ]
- [ mixed yearsactive = null ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "artistid", "required": true }, { "$ref": "Optional.String", "name": "artist", "default": null }, { "name": "instrument", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "name": "style", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "name": "mood", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "$ref": "Optional.String", "name": "born", "default": null }, { "$ref": "Optional.String", "name": "formed", "default": null }, { "$ref": "Optional.String", "name": "description", "default": null }, { "name": "genre", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "$ref": "Optional.String", "name": "died", "default": null }, { "$ref": "Optional.String", "name": "disbanded", "default": null }, { "name": "yearsactive", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null } ], "description": "Update the given artist with the given details", "returns": { "type": "string" } } |
AudioLibrary.SetSongDetails
Update the given song with the given details
Permissions:
- UpdateData
Parameters:
- Library.Id songid
- [ Optional.String title = null ]
- [ mixed artist = null ]
- [ mixed albumartist = null ]
- [ mixed genre = null ]
- [ Optional.Integer year = null ]
- [ Optional.Integer rating = null ]
- [ Optional.String album = null ]
- [ Optional.Integer track = null ]
- [ Optional.Integer disc = null ]
- [ Optional.Integer duration = null ]
- [ Optional.String comment = null ]
- [ Optional.String musicbrainztrackid = null ]
- [ Optional.String musicbrainzartistid = null ]
- [ Optional.String musicbrainzalbumid = null ]
- [ Optional.String musicbrainzalbumartistid = null ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "songid", "required": true }, { "$ref": "Optional.String", "name": "title", "default": null }, { "name": "artist", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "name": "albumartist", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "name": "genre", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "$ref": "Optional.Integer", "name": "year", "default": null }, { "$ref": "Optional.Integer", "name": "rating", "default": null }, { "$ref": "Optional.String", "name": "album", "default": null }, { "$ref": "Optional.Integer", "name": "track", "default": null }, { "$ref": "Optional.Integer", "name": "disc", "default": null }, { "$ref": "Optional.Integer", "name": "duration", "default": null }, { "$ref": "Optional.String", "name": "comment", "default": null }, { "$ref": "Optional.String", "name": "musicbrainztrackid", "default": null }, { "$ref": "Optional.String", "name": "musicbrainzartistid", "default": null }, { "$ref": "Optional.String", "name": "musicbrainzalbumid", "default": null }, { "$ref": "Optional.String", "name": "musicbrainzalbumartistid", "default": null } ], "description": "Update the given song with the given details", "returns": { "type": "string" } } |
Files
Files.Download
Downloads the given file
Permissions:
- ReadData
Parameters:
- string path
Returns: any
JSON Schema Description |
---|
{ "params": [ { "name": "path", "required": true, "type": "string" } ], "description": "Downloads the given file", "returns": { "type": "any" } } |
Files.GetDirectory
Get the directories and files in the given directory
Permissions:
- ReadData
Parameters:
- string directory
- [ Files.Media media = "files" ]
- [ List.Fields.Files properties ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- List.Item.File[] files
JSON Schema Description |
---|
{ "params": [ { "name": "directory", "required": true, "type": "string" }, { "$ref": "Files.Media", "name": "media", "default": "files" }, { "$ref": "List.Fields.Files", "name": "properties" }, { "$ref": "List.Sort", "name": "sort" } ], "description": "Get the directories and files in the given directory", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "files": { "items": { "$ref": "List.Item.File" }, "required": true, "type": "array" } }, "type": "object" } } |
Files.GetFileDetails
Get details for a specific file
Permissions:
- ReadData
Parameters:
- string file
- [ Files.Media media = "files" ]
- [ List.Fields.Files properties ]
Returns:
Type: object
Properties:
- List.Item.File filedetails
JSON Schema Description |
---|
{ "params": [ { "description": "Full path to the file", "name": "file", "type": "string", "required": true }, { "$ref": "Files.Media", "name": "media", "default": "files" }, { "$ref": "List.Fields.Files", "name": "properties" } ], "description": "Get details for a specific file", "returns": { "properties": { "filedetails": { "$ref": "List.Item.File", "required": true } }, "type": "object" } } |
Files.GetSources
Get the sources of the media windows
Permissions:
- ReadData
Parameters:
- Files.Media media
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- List.Items.Sources sources
JSON Schema Description |
---|
{ "params": [ { "$ref": "Files.Media", "name": "media", "required": true }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "description": "Get the sources of the media windows", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "sources": { "$ref": "List.Items.Sources", "required": true } }, "type": "object" } } |
Files.PrepareDownload
Provides a way to download a given file (e.g. providing an URL to the real file location)
Permissions:
- ReadData
Parameters:
- string path
Returns:
Type: object
Properties:
- string mode
- string protocol
- any details
JSON Schema Description |
---|
{ "params": [ { "name": "path", "required": true, "type": "string" } ], "description": "Provides a way to download a given file (e.g. providing an URL to the real file location)", "returns": { "properties": { "mode": { "enums": [ "redirect", "direct" ], "description": "Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol", "required": true, "type": "string" }, "protocol": { "enums": [ "http" ], "required": true, "type": "string" }, "details": { "description": "Transport specific details on how/from where to download the given file", "required": true, "type": "any" } }, "type": "object" } } |
GUI
GUI.ActivateWindow
Activates the given window
Permissions:
- ControlGUI
Parameters:
- GUI.Window window
- [ array[1..X] parameters ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "GUI.Window", "name": "window", "required": true }, { "minItems": 1, "items": { "minLength": 1, "type": "string" }, "name": "parameters", "type": "array" } ], "description": "Activates the given window", "returns": { "type": "string" } } |
GUI.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- GUI.Property.Name[] properties
Returns: GUI.Property.Value
JSON Schema Description |
---|
{ "params": [ { "uniqueItems": true, "items": { "$ref": "GUI.Property.Name" }, "name": "properties", "type": "array", "required": true } ], "description": "Retrieves the values of the given properties", "returns": { "$ref": "GUI.Property.Value" } } |
GUI.SetFullscreen
Toggle fullscreen/GUI
Permissions:
- ControlGUI
Parameters:
- Global.Toggle fullscreen
Returns: boolean
JSON Schema Description |
---|
{ "params": [ { "$ref": "Global.Toggle", "name": "fullscreen", "required": true } ], "description": "Toggle fullscreen/GUI", "returns": { "description": "Fullscreen state", "type": "boolean" } } |
GUI.ShowNotification
Shows a GUI notification
Permissions:
- ControlGUI
Parameters:
- string title
- string message
- [ mixed image = "" ]
- [ integer displaytime = 5000 ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "name": "title", "required": true, "type": "string" }, { "name": "message", "required": true, "type": "string" }, { "name": "image", "type": [ { "enums": [ "info", "warning", "error" ], "type": "string" }, { "type": "string" } ], "default": "" }, { "minimum": 1500, "description": "The time in milliseconds the notification will be visible", "name": "displaytime", "default": 5000, "type": "integer" } ], "description": "Shows a GUI notification", "returns": { "type": "string" } } |
Input
Input.Back
Goes back in GUI
Permissions:
- Navigate
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Goes back in GUI", "returns": { "type": "string" } } |
Input.ContextMenu
Shows the context menu
Permissions:
- Navigate
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Shows the context menu", "returns": { "type": "string" } } |
Input.Down
Navigate down in GUI
Permissions:
- Navigate
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Navigate down in GUI", "returns": { "type": "string" } } |
Input.ExecuteAction
Execute a specific action
Permissions:
- Navigate
Parameters:
- Input.Action action
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Input.Action", "name": "action", "required": true } ], "description": "Execute a specific action", "returns": { "type": "string" } } |
Input.Home
Goes to home window in GUI
Permissions:
- Navigate
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Goes to home window in GUI", "returns": { "type": "string" } } |
Input.Info
Shows the information dialog
Permissions:
- Navigate
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Shows the information dialog", "returns": { "type": "string" } } |
Input.Left
Navigate left in GUI
Permissions:
- Navigate
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Navigate left in GUI", "returns": { "type": "string" } } |
Input.Right
Navigate right in GUI
Permissions:
- Navigate
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Navigate right in GUI", "returns": { "type": "string" } } |
Input.Select
Select current item in GUI
Permissions:
- Navigate
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Select current item in GUI", "returns": { "type": "string" } } |
Input.SendText
Send a generic (unicode) text
Permissions:
- Navigate
Parameters:
- string text
- [ boolean done = True ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "description": "Unicode text", "name": "text", "type": "string", "required": true }, { "description": "Whether this is the whole input or not (closes an open input dialog if true).", "name": "done", "default": true, "type": "boolean" } ], "description": "Send a generic (unicode) text", "returns": { "type": "string" } } |
Input.ShowCodec
Show codec information of the playing item
Permissions:
- Navigate
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Show codec information of the playing item", "returns": { "type": "string" } } |
Input.ShowOSD
Show the on-screen display for the current player
Permissions:
- Navigate
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Show the on-screen display for the current player", "returns": { "type": "string" } } |
Input.Up
Navigate up in GUI
Permissions:
- Navigate
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Navigate up in GUI", "returns": { "type": "string" } } |
JSONRPC
JSONRPC.GetConfiguration
Get client-specific configurations
Permissions:
- ReadData
Parameters: None
Returns: Configuration
JSON Schema Description |
---|
{ "params": [], "description": "Get client-specific configurations", "returns": { "$ref": "Configuration" } } |
JSONRPC.Introspect
Enumerates all actions and descriptions
Permissions:
- ReadData
Parameters:
- [ boolean getdescriptions = True ]
- [ boolean getmetadata = False ]
- [ boolean filterbytransport = True ]
- [ object filter ]
Properties:
- [ boolean getreferences = True ]
- string id
- string type
Returns:
Type: object
JSON Schema Description |
---|
{ "params": [ { "name": "getdescriptions", "type": "boolean", "default": true }, { "name": "getmetadata", "type": "boolean", "default": false }, { "name": "filterbytransport", "type": "boolean", "default": true }, { "name": "filter", "properties": { "getreferences": { "description": "Whether or not to print the schema for referenced types", "type": "boolean", "default": true }, "id": { "description": "Name of a namespace, method or type", "required": true, "type": "string" }, "type": { "enums": [ "method", "namespace", "type", "notification" ], "description": "Type of the given name", "required": true, "type": "string" } }, "type": "object" } ], "description": "Enumerates all actions and descriptions", "returns": { "additionalProperties": false, "type": "object" } } |
JSONRPC.NotifyAll
Notify all other connected clients
Permissions:
- ReadData
Parameters:
- string sender
- string message
- [ any data = null ]
Returns: any
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "message", "required": true, "type": "string" }, { "name": "data", "type": "any", "default": null } ], "description": "Notify all other connected clients", "returns": { "type": "any" } } |
JSONRPC.Permission
Retrieve the clients permissions
Permissions:
- ReadData
Parameters: None
Returns:
Type: object
Properties:
- boolean readdata
- boolean writefile
- boolean controlpvr
- boolean controlsystem
- boolean removedata
- boolean controlplayback
- boolean navigate
- boolean controlpower
- boolean executeaddon
- boolean manageaddon
- boolean controlgui
- boolean controlnotify
- boolean updatedata
JSON Schema Description |
---|
{ "params": [], "description": "Retrieve the clients permissions", "returns": { "properties": { "readdata": { "required": true, "type": "boolean" }, "writefile": { "required": true, "type": "boolean" }, "controlpvr": { "required": true, "type": "boolean" }, "controlsystem": { "required": true, "type": "boolean" }, "removedata": { "required": true, "type": "boolean" }, "controlplayback": { "required": true, "type": "boolean" }, "navigate": { "required": true, "type": "boolean" }, "controlpower": { "required": true, "type": "boolean" }, "executeaddon": { "required": true, "type": "boolean" }, "manageaddon": { "required": true, "type": "boolean" }, "controlgui": { "required": true, "type": "boolean" }, "controlnotify": { "required": true, "type": "boolean" }, "updatedata": { "required": true, "type": "boolean" } }, "type": "object" } } |
JSONRPC.Ping
Ping responder
Permissions:
- ReadData
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Ping responder", "returns": { "type": "string" } } |
JSONRPC.SetConfiguration
Change the client-specific configuration
Permissions:
- ControlNotify
Parameters:
- [ object notifications ]
Properties:
- [ Optional.Boolean gui = null ]
- [ Optional.Boolean other = null ]
- [ Optional.Boolean input = null ]
- [ Optional.Boolean videolibrary = null ]
- [ Optional.Boolean audiolibrary = null ]
- [ Optional.Boolean playlist = null ]
- [ Optional.Boolean system = null ]
- [ Optional.Boolean player = null ]
- [ Optional.Boolean application = null ]
Returns: Configuration
JSON Schema Description |
---|
{ "params": [ { "name": "notifications", "properties": { "gui": { "$ref": "Optional.Boolean", "default": null }, "other": { "$ref": "Optional.Boolean", "default": null }, "input": { "$ref": "Optional.Boolean", "default": null }, "videolibrary": { "$ref": "Optional.Boolean", "default": null }, "audiolibrary": { "$ref": "Optional.Boolean", "default": null }, "playlist": { "$ref": "Optional.Boolean", "default": null }, "system": { "$ref": "Optional.Boolean", "default": null }, "player": { "$ref": "Optional.Boolean", "default": null }, "application": { "$ref": "Optional.Boolean", "default": null } }, "type": "object" } ], "description": "Change the client-specific configuration", "returns": { "$ref": "Configuration" } } |
JSONRPC.Version
Retrieve the JSON-RPC protocol version.
Permissions:
- ReadData
Parameters: None
Returns:
Type: object
Properties:
- integer minor
- integer patch
- integer major
JSON Schema Description |
---|
{ "params": [], "description": "Retrieve the JSON-RPC protocol version.", "returns": { "properties": { "minor": { "minimum": 0, "description": "Bumped on backwards compatible additions/changes to the API definition", "required": true, "type": "integer" }, "patch": { "minimum": 0, "description": "Bumped on any changes to the internal implementation but not to the API definition", "required": true, "type": "integer" }, "major": { "minimum": 0, "description": "Bumped on backwards incompatible changes to the API definition", "required": true, "type": "integer" } }, "type": "object" } } |
PVR
PVR.GetChannelDetails
Retrieves the details of a specific channel
Permissions:
- ReadData
Parameters:
- Library.Id channelid
- [ PVR.Fields.Channel properties ]
Returns:
Type: object
Properties:
- [ PVR.Details.Channel channeldetails ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "channelid", "required": true }, { "$ref": "PVR.Fields.Channel", "name": "properties" } ], "description": "Retrieves the details of a specific channel", "returns": { "properties": { "channeldetails": { "$ref": "PVR.Details.Channel" } }, "type": "object" } } |
PVR.GetChannelGroupDetails
Retrieves the details of a specific channel group
Permissions:
- ReadData
Parameters:
- PVR.ChannelGroup.Id channelgroupid
- [ object channels ]
Properties:
- [ List.Limits limits ]
- [ PVR.Fields.Channel properties ]
Returns:
Type: object
Properties:
- [ PVR.Details.ChannelGroup.Extended channelgroupdetails ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "PVR.ChannelGroup.Id", "name": "channelgroupid", "required": true }, { "name": "channels", "properties": { "limits": { "$ref": "List.Limits" }, "properties": { "$ref": "PVR.Fields.Channel" } }, "type": "object" } ], "description": "Retrieves the details of a specific channel group", "returns": { "properties": { "channelgroupdetails": { "$ref": "PVR.Details.ChannelGroup.Extended" } }, "type": "object" } } |
PVR.GetChannelGroups
Retrieves the channel groups for the specified type
Permissions:
- ReadData
Parameters:
- PVR.Channel.Type channeltype
- [ List.Limits limits ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- PVR.Details.ChannelGroup[] channelgroups
JSON Schema Description |
---|
{ "params": [ { "$ref": "PVR.Channel.Type", "name": "channeltype", "required": true }, { "$ref": "List.Limits", "name": "limits" } ], "description": "Retrieves the channel groups for the specified type", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "channelgroups": { "items": { "$ref": "PVR.Details.ChannelGroup" }, "required": true, "type": "array" } }, "type": "object" } } |
PVR.GetChannels
Retrieves the channel list
Permissions:
- ReadData
Parameters:
- PVR.ChannelGroup.Id channelgroupid
- [ PVR.Fields.Channel properties ]
- [ List.Limits limits ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- PVR.Details.Channel[] channels
JSON Schema Description |
---|
{ "params": [ { "$ref": "PVR.ChannelGroup.Id", "name": "channelgroupid", "required": true }, { "$ref": "PVR.Fields.Channel", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" } ], "description": "Retrieves the channel list", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "channels": { "items": { "$ref": "PVR.Details.Channel" }, "required": true, "type": "array" } }, "type": "object" } } |
PVR.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- PVR.Property.Name[] properties
Returns: PVR.Property.Value
JSON Schema Description |
---|
{ "params": [ { "uniqueItems": true, "items": { "$ref": "PVR.Property.Name" }, "name": "properties", "type": "array", "required": true } ], "description": "Retrieves the values of the given properties", "returns": { "$ref": "PVR.Property.Value" } } |
PVR.Record
Toggle recording of a channel
Permissions:
- ControlPVR
Parameters:
- [ Global.Toggle record = "toggle" ]
- [ mixed channel = "current" ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Global.Toggle", "name": "record", "default": "toggle" }, { "name": "channel", "type": [ { "enums": [ "current" ], "type": "string" }, { "$ref": "Library.Id" } ], "default": "current" } ], "description": "Toggle recording of a channel", "returns": { "type": "string" } } |
PVR.Scan
Starts a channel scan
Permissions:
- ControlPVR
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Starts a channel scan", "returns": { "type": "string" } } |
Player
Player.GetActivePlayers
Returns all active players
Permissions:
- ReadData
Parameters: None
Returns:
Type: array
JSON Schema Description |
---|
{ "params": [], "description": "Returns all active players", "returns": { "uniqueItems": true, "items": { "properties": { "type": { "$ref": "Player.Type", "required": true }, "playerid": { "$ref": "Player.Id", "required": true } }, "type": "object" }, "type": "array" } } |
Player.GetItem
Retrieves the currently played item
Permissions:
- ReadData
Parameters:
- Player.Id playerid
- [ List.Fields.All properties ]
Returns:
Type: object
Properties:
- List.Item.All item
JSON Schema Description |
---|
{ "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "$ref": "List.Fields.All", "name": "properties" } ], "description": "Retrieves the currently played item", "returns": { "properties": { "item": { "$ref": "List.Item.All", "required": true } }, "type": "object" } } |
Player.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- Player.Id playerid
- Player.Property.Name[] properties
Returns: Player.Property.Value
JSON Schema Description |
---|
{ "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "uniqueItems": true, "items": { "$ref": "Player.Property.Name" }, "name": "properties", "type": "array", "required": true } ], "description": "Retrieves the values of the given properties", "returns": { "$ref": "Player.Property.Value" } } |
Player.GoTo
Go to previous/next/specific item in the playlist
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed to
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "name": "to", "required": true, "type": [ { "enums": [ "previous", "next" ], "type": "string" }, { "$ref": "Playlist.Position", "description": "position in playlist" } ] } ], "description": "Go to previous/next/specific item in the playlist", "returns": { "type": "string" } } |
Player.Move
If picture is zoomed move viewport left/right/up/down otherwise skip previous/next
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- string direction
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "enums": [ "left", "right", "up", "down" ], "name": "direction", "required": true, "type": "string" } ], "description": "If picture is zoomed move viewport left/right/up/down otherwise skip previous/next", "returns": { "type": "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
Parameters:
- [ mixed item ]
- [ object options ]
Properties:
- [ Optional.Boolean shuffled = null ]
- [ mixed repeat = null ]
- [ mixed resume = False ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "name": "item", "type": [ { "additionalProperties": false, "properties": { "position": { "$ref": "Playlist.Position", "default": 0 }, "playlistid": { "$ref": "Playlist.Id", "required": true } }, "type": "object" }, { "$ref": "Playlist.Item" }, { "additionalProperties": false, "properties": { "path": { "required": true, "type": "string" }, "random": { "description": "Deprecated, use the shuffled property of the options parameter instead", "type": "boolean", "default": true }, "recursive": { "type": "boolean", "default": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "partymode": { "type": [ { "enums": [ "music", "video" ], "type": "string" }, { "description": "Path to a smartplaylist (*.xsp) file", "minLength": 5, "type": "string" } ], "default": "" } }, "type": "object" }, { "additionalProperties": false, "properties": { "channelid": { "$ref": "Library.Id", "required": true } }, "type": "object" } ] }, { "additionalProperties": false, "name": "options", "properties": { "shuffled": { "$ref": "Optional.Boolean", "default": null }, "repeat": { "type": [ { "type": "null" }, { "$ref": "Player.Repeat" } ], "default": null }, "resume": { "type": [ { "description": "Whether to resume from the resume point or not", "type": "boolean" }, { "$ref": "Player.Position.Percentage", "description": "Percentage value to start from" }, { "$ref": "Player.Position.Time", "description": "Time to start from" } ], "default": false } }, "type": "object" } ], "description": "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.", "returns": { "type": "string" } } |
Player.PlayPause
Pauses or unpause playback and returns the new state
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- [ Global.Toggle play = "toggle" ]
Returns: Player.Speed
JSON Schema Description |
---|
{ "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "$ref": "Global.Toggle", "name": "play", "default": "toggle" } ], "description": "Pauses or unpause playback and returns the new state", "returns": { "$ref": "Player.Speed" } } |
Player.Rotate
Rotates current picture
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- [ string value = "clockwise" ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "enums": [ "clockwise", "counterclockwise" ], "name": "value", "type": "string", "default": "clockwise" } ], "description": "Rotates current picture", "returns": { "type": "string" } } |
Player.Seek
Seek through the playing item
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed value
Returns:
Type: object
Properties:
- [ Player.Position.Percentage percentage = 0 ]
- [ Global.Time time ]
- [ Global.Time totaltime ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "name": "value", "required": true, "type": [ { "$ref": "Player.Position.Percentage", "description": "Percentage value to seek to" }, { "$ref": "Player.Position.Time", "description": "Time to seek to" }, { "enums": [ "smallforward", "smallbackward", "bigforward", "bigbackward" ], "description": "Seek by predefined jumps", "type": "string" } ] } ], "description": "Seek through the playing item", "returns": { "properties": { "percentage": { "$ref": "Player.Position.Percentage", "default": 0 }, "time": { "$ref": "Global.Time" }, "totaltime": { "$ref": "Global.Time" } }, "type": "object" } } |
Player.SetAudioStream
Set the audio stream played by the player
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed stream
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "name": "stream", "required": true, "type": [ { "enums": [ "previous", "next" ], "type": "string" }, { "minimum": 0, "description": "Index of the audio stream to play", "type": "integer" } ] } ], "description": "Set the audio stream played by the player", "returns": { "type": "string" } } |
Player.SetPartymode
Turn partymode on or off
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- Global.Toggle partymode
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "$ref": "Global.Toggle", "name": "partymode", "required": true } ], "description": "Turn partymode on or off", "returns": { "type": "string" } } |
Player.SetRepeat
Set the repeat mode of the player
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed repeat
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "name": "repeat", "required": true, "type": [ { "$ref": "Player.Repeat" }, { "enums": [ "cycle" ], "type": "string" } ] } ], "description": "Set the repeat mode of the player", "returns": { "type": "string" } } |
Player.SetShuffle
Shuffle/Unshuffle items in the player
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- Global.Toggle shuffle
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "$ref": "Global.Toggle", "name": "shuffle", "required": true } ], "description": "Shuffle/Unshuffle items in the player", "returns": { "type": "string" } } |
Player.SetSpeed
Set the speed of the current playback
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed speed
Returns: Player.Speed
JSON Schema Description |
---|
{ "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "name": "speed", "required": true, "type": [ { "enums": [ -32, -16, -8, -4, -2, -1, 0, 1, 2, 4, 8, 16, 32 ], "type": "integer" }, { "$ref": "Global.IncrementDecrement" } ] } ], "description": "Set the speed of the current playback", "returns": { "$ref": "Player.Speed" } } |
Player.SetSubtitle
Set the subtitle displayed by the player
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed subtitle
- [ boolean enable = False ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "name": "subtitle", "required": true, "type": [ { "enums": [ "previous", "next", "off", "on" ], "type": "string" }, { "minimum": 0, "description": "Index of the subtitle to display", "type": "integer" } ] }, { "description": "Whether to enable subtitles to be displayed after setting the new subtitle", "name": "enable", "default": false, "type": "boolean" } ], "description": "Set the subtitle displayed by the player", "returns": { "type": "string" } } |
Player.Stop
Stops playback
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true } ], "description": "Stops playback", "returns": { "type": "string" } } |
Player.Zoom
Zoom current picture
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed zoom
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "name": "zoom", "required": true, "type": [ { "enums": [ "in", "out" ], "type": "string" }, { "minimum": 1, "description": "zoom level", "type": "integer", "maximum": 10 } ] } ], "description": "Zoom current picture", "returns": { "type": "string" } } |
Playlist
Playlist.Add
Add item(s) to playlist
Permissions:
- ControlPlayback
Parameters:
- Playlist.Id playlistid
- Playlist.Item item
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "$ref": "Playlist.Item", "name": "item", "required": true } ], "description": "Add item(s) to playlist", "returns": { "type": "string" } } |
Playlist.Clear
Clear playlist
Permissions:
- ControlPlayback
Parameters:
- Playlist.Id playlistid
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true } ], "description": "Clear playlist", "returns": { "type": "string" } } |
Playlist.GetItems
Get all items from playlist
Permissions:
- ReadData
Parameters:
- Playlist.Id playlistid
- [ List.Fields.All properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- List.Item.All[] items
JSON Schema Description |
---|
{ "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "$ref": "List.Fields.All", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "description": "Get all items from playlist", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "items": { "items": { "$ref": "List.Item.All" }, "required": true, "type": "array" } }, "type": "object" } } |
Playlist.GetPlaylists
Returns all existing playlists
Permissions:
- ReadData
Parameters: None
Returns:
Type: array
JSON Schema Description |
---|
{ "params": [], "description": "Returns all existing playlists", "returns": { "uniqueItems": true, "items": { "properties": { "playlistid": { "$ref": "Playlist.Id", "required": true }, "type": { "$ref": "Playlist.Type", "required": true } }, "type": "object" }, "type": "array" } } |
Playlist.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- Playlist.Id playlistid
- Playlist.Property.Name[] properties
Returns: Playlist.Property.Value
JSON Schema Description |
---|
{ "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "uniqueItems": true, "items": { "$ref": "Playlist.Property.Name" }, "name": "properties", "type": "array", "required": true } ], "description": "Retrieves the values of the given properties", "returns": { "$ref": "Playlist.Property.Value" } } |
Playlist.Insert
Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).
Permissions:
- ControlPlayback
Parameters:
- Playlist.Id playlistid
- Playlist.Position position
- Playlist.Item item
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "$ref": "Playlist.Position", "name": "position", "required": true }, { "$ref": "Playlist.Item", "name": "item", "required": true } ], "description": "Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).", "returns": { "type": "string" } } |
Playlist.Remove
Remove item from playlist. Does not work for picture playlists (aka slideshows).
Permissions:
- ControlPlayback
Parameters:
- Playlist.Id playlistid
- Playlist.Position position
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "$ref": "Playlist.Position", "name": "position", "required": true } ], "description": "Remove item from playlist. Does not work for picture playlists (aka slideshows).", "returns": { "type": "string" } } |
Playlist.Swap
Swap items in the playlist. Does not work for picture playlists (aka slideshows).
Permissions:
- ControlPlayback
Parameters:
- Playlist.Id playlistid
- Playlist.Position position1
- Playlist.Position position2
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "$ref": "Playlist.Position", "name": "position1", "required": true }, { "$ref": "Playlist.Position", "name": "position2", "required": true } ], "description": "Swap items in the playlist. Does not work for picture playlists (aka slideshows).", "returns": { "type": "string" } } |
System
System.EjectOpticalDrive
Ejects or closes the optical disc drive (if available)
Permissions:
- ControlSystem
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Ejects or closes the optical disc drive (if available)", "returns": { "type": "string" } } |
System.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- System.Property.Name[] properties
Returns: System.Property.Value
JSON Schema Description |
---|
{ "params": [ { "uniqueItems": true, "items": { "$ref": "System.Property.Name" }, "name": "properties", "type": "array", "required": true } ], "description": "Retrieves the values of the given properties", "returns": { "$ref": "System.Property.Value" } } |
System.Hibernate
Puts the system running XBMC into hibernate mode
Permissions:
- ControlPower
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Puts the system running {{name}} into hibernate mode", "returns": { "type": "string" } } |
System.Reboot
Reboots the system running XBMC
Permissions:
- ControlPower
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Reboots the system running XBMC", "returns": { "type": "string" } } |
System.Shutdown
Shuts the system running XBMC down
Permissions:
- ControlPower
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Shuts the system running {{name}} down", "returns": { "type": "string" } } |
System.Suspend
Suspends the system running XBMC
Permissions:
- ControlPower
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Suspends the system running XBMC", "returns": { "type": "string" } } |
VideoLibrary
VideoLibrary.Clean
Cleans the video library from non-existent items
Permissions:
- RemoveData
Parameters: None
Returns: string
JSON Schema Description |
---|
{ "params": [], "description": "Cleans the video library from non-existent items", "returns": { "type": "string" } } |
VideoLibrary.Export
Exports all items from the video library
Permissions:
- WriteFile
Parameters:
- [ mixed options ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "name": "options", "type": [ { "additionalProperties": false, "properties": { "path": { "description": "Path to the directory to where the data should be exported", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "overwrite": { "description": "Whether to overwrite existing exported files", "type": "boolean", "default": false }, "actorthumbs": { "description": "Whether to export actor thumbnails", "type": "boolean", "default": false }, "images": { "description": "Whether to export thumbnails and fanart images", "type": "boolean", "default": false } }, "type": "object" } ] } ], "description": "Exports all items from the video library", "returns": { "type": "string" } } |
VideoLibrary.GetEpisodeDetails
Retrieve details about a specific tv show episode
Permissions:
- ReadData
Parameters:
- Library.Id episodeid
- [ Video.Fields.Episode properties ]
Returns:
Type: object
Properties:
- [ Video.Details.Episode episodedetails ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "episodeid", "required": true }, { "$ref": "Video.Fields.Episode", "name": "properties" } ], "description": "Retrieve details about a specific tv show episode", "returns": { "properties": { "episodedetails": { "$ref": "Video.Details.Episode" } }, "type": "object" } } |
VideoLibrary.GetEpisodes
Retrieve all tv show episodes
Permissions:
- ReadData
Parameters:
- [ Library.Id tvshowid = -1 ]
- [ integer season = -1 ]
- [ Video.Fields.Episode properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
- [ mixed filter ]
Returns:
Type: object
Properties:
- [ Video.Details.Episode[] episodes ]
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "tvshowid", "default": -1 }, { "minimum": 0, "name": "season", "type": "integer", "default": -1 }, { "$ref": "Video.Fields.Episode", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "name": "filter", "type": [ { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "description": "Requires tvshowid to be set", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "description": "Requires tvshowid to be set", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "year": { "minimum": 0, "required": true, "type": "integer" } }, "type": "object" }, { "additionalProperties": false, "properties": { "actor": { "description": "Requires tvshowid to be set", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "director": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "$ref": "List.Filter.Episodes" } ] } ], "description": "Retrieve all tv show episodes", "returns": { "properties": { "episodes": { "items": { "$ref": "Video.Details.Episode" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" } } |
VideoLibrary.GetGenres
Retrieve all genres
Permissions:
- ReadData
Parameters:
- string type
- [ Library.Fields.Genre properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- Library.Details.Genre[] genres
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "params": [ { "enums": [ "movie", "tvshow", "musicvideo" ], "name": "type", "required": true, "type": "string" }, { "$ref": "Library.Fields.Genre", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "description": "Retrieve all genres", "returns": { "properties": { "genres": { "items": { "$ref": "Library.Details.Genre" }, "required": true, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" } } |
VideoLibrary.GetMovieDetails
Retrieve details about a specific movie
Permissions:
- ReadData
Parameters:
- Library.Id movieid
- [ Video.Fields.Movie properties ]
Returns:
Type: object
Properties:
- [ Video.Details.Movie moviedetails ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "movieid", "required": true }, { "$ref": "Video.Fields.Movie", "name": "properties" } ], "description": "Retrieve details about a specific movie", "returns": { "properties": { "moviedetails": { "$ref": "Video.Details.Movie" } }, "type": "object" } } |
VideoLibrary.GetMovieSetDetails
Retrieve details about a specific movie set
Permissions:
- ReadData
Parameters:
- Library.Id setid
- [ Video.Fields.MovieSet properties ]
- [ object movies ]
Properties:
- [ List.Limits limits ]
- [ Video.Fields.Movie properties ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- [ Video.Details.MovieSet.Extended setdetails ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "setid", "required": true }, { "$ref": "Video.Fields.MovieSet", "name": "properties" }, { "name": "movies", "properties": { "limits": { "$ref": "List.Limits" }, "properties": { "$ref": "Video.Fields.Movie" }, "sort": { "$ref": "List.Sort" } }, "type": "object" } ], "description": "Retrieve details about a specific movie set", "returns": { "properties": { "setdetails": { "$ref": "Video.Details.MovieSet.Extended" } }, "type": "object" } } |
VideoLibrary.GetMovieSets
Retrieve all movie sets
Permissions:
- ReadData
Parameters:
- [ Video.Fields.MovieSet properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Video.Details.MovieSet[] sets ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Video.Fields.MovieSet", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "description": "Retrieve all movie sets", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "sets": { "items": { "$ref": "Video.Details.MovieSet" }, "type": "array" } }, "type": "object" } } |
VideoLibrary.GetMovies
Retrieve all movies
Permissions:
- ReadData
Parameters:
- [ Video.Fields.Movie properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
- [ mixed filter ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Video.Details.Movie[] movies ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Video.Fields.Movie", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "name": "filter", "type": [ { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "year": { "minimum": 0, "required": true, "type": "integer" } }, "type": "object" }, { "additionalProperties": false, "properties": { "actor": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "director": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "studio": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "country": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "setid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "set": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "tag": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "$ref": "List.Filter.Movies" } ] } ], "description": "Retrieve all movies", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "movies": { "items": { "$ref": "Video.Details.Movie" }, "type": "array" } }, "type": "object" } } |
VideoLibrary.GetMusicVideoDetails
Retrieve details about a specific music video
Permissions:
- ReadData
Parameters:
- Library.Id musicvideoid
- [ Video.Fields.MusicVideo properties ]
Returns:
Type: object
Properties:
- [ Video.Details.MusicVideo musicvideodetails ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "musicvideoid", "required": true }, { "$ref": "Video.Fields.MusicVideo", "name": "properties" } ], "description": "Retrieve details about a specific music video", "returns": { "properties": { "musicvideodetails": { "$ref": "Video.Details.MusicVideo" } }, "type": "object" } } |
VideoLibrary.GetMusicVideos
Retrieve all music videos
Permissions:
- ReadData
Parameters:
- [ Video.Fields.MusicVideo properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
- [ mixed filter ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Video.Details.MusicVideo[] musicvideos ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Video.Fields.MusicVideo", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "name": "filter", "type": [ { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "year": { "minimum": 0, "required": true, "type": "integer" } }, "type": "object" }, { "additionalProperties": false, "properties": { "director": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "studio": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "tag": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "$ref": "List.Filter.MusicVideos" } ] } ], "description": "Retrieve all music videos", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "musicvideos": { "items": { "$ref": "Video.Details.MusicVideo" }, "type": "array" } }, "type": "object" } } |
VideoLibrary.GetRecentlyAddedEpisodes
Retrieve all recently added tv episodes
Permissions:
- ReadData
Parameters:
- [ Video.Fields.Episode properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- [ Video.Details.Episode[] episodes ]
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "params": [ { "$ref": "Video.Fields.Episode", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "description": "Retrieve all recently added tv episodes", "returns": { "properties": { "episodes": { "items": { "$ref": "Video.Details.Episode" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" } } |
VideoLibrary.GetRecentlyAddedMovies
Retrieve all recently added movies
Permissions:
- ReadData
Parameters:
- [ Video.Fields.Movie properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Video.Details.Movie[] movies ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Video.Fields.Movie", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "description": "Retrieve all recently added movies", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "movies": { "items": { "$ref": "Video.Details.Movie" }, "type": "array" } }, "type": "object" } } |
VideoLibrary.GetRecentlyAddedMusicVideos
Retrieve all recently added music videos
Permissions:
- ReadData
Parameters:
- [ Video.Fields.MusicVideo properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Video.Details.MusicVideo[] musicvideos ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Video.Fields.MusicVideo", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "description": "Retrieve all recently added music videos", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "musicvideos": { "items": { "$ref": "Video.Details.MusicVideo" }, "type": "array" } }, "type": "object" } } |
VideoLibrary.GetSeasons
Retrieve all tv seasons
Permissions:
- ReadData
Parameters:
- Library.Id tvshowid
- [ Video.Fields.Season properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Video.Details.Season[] seasons ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "tvshowid", "required": true }, { "$ref": "Video.Fields.Season", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "description": "Retrieve all tv seasons", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "seasons": { "items": { "$ref": "Video.Details.Season" }, "type": "array" } }, "type": "object" } } |
VideoLibrary.GetTVShowDetails
Retrieve details about a specific tv show
Permissions:
- ReadData
Parameters:
- Library.Id tvshowid
- [ Video.Fields.TVShow properties ]
Returns:
Type: object
Properties:
- [ Video.Details.TVShow tvshowdetails ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "tvshowid", "required": true }, { "$ref": "Video.Fields.TVShow", "name": "properties" } ], "description": "Retrieve details about a specific tv show", "returns": { "properties": { "tvshowdetails": { "$ref": "Video.Details.TVShow" } }, "type": "object" } } |
VideoLibrary.GetTVShows
Retrieve all tv shows
Permissions:
- ReadData
Parameters:
- [ Video.Fields.TVShow properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
- [ mixed filter ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Video.Details.TVShow[] tvshows ]
JSON Schema Description |
---|
{ "params": [ { "$ref": "Video.Fields.TVShow", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "name": "filter", "type": [ { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "year": { "minimum": 0, "required": true, "type": "integer" } }, "type": "object" }, { "additionalProperties": false, "properties": { "actor": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "studio": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "tag": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "$ref": "List.Filter.TVShows" } ] } ], "description": "Retrieve all tv shows", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "tvshows": { "items": { "$ref": "Video.Details.TVShow" }, "type": "array" } }, "type": "object" } } |
VideoLibrary.RemoveEpisode
Removes the given episode from the library
Permissions:
- RemoveData
Parameters:
- Library.Id episodeid
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "episodeid", "required": true } ], "description": "Removes the given episode from the library", "returns": { "type": "string" } } |
VideoLibrary.RemoveMovie
Removes the given movie from the library
Permissions:
- RemoveData
Parameters:
- Library.Id movieid
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "movieid", "required": true } ], "description": "Removes the given movie from the library", "returns": { "type": "string" } } |
VideoLibrary.RemoveMusicVideo
Removes the given music video from the library
Permissions:
- RemoveData
Parameters:
- Library.Id musicvideoid
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "musicvideoid", "required": true } ], "description": "Removes the given music video from the library", "returns": { "type": "string" } } |
VideoLibrary.RemoveTVShow
Removes the given tv show from the library
Permissions:
- RemoveData
Parameters:
- Library.Id tvshowid
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "tvshowid", "required": true } ], "description": "Removes the given tv show from the library", "returns": { "type": "string" } } |
VideoLibrary.Scan
Scans the video sources for new library items
Permissions:
- UpdateData
Parameters:
- [ string directory = "" ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "name": "directory", "type": "string", "default": "" } ], "description": "Scans the video sources for new library items", "returns": { "type": "string" } } |
VideoLibrary.SetEpisodeDetails
Update the given episode with the given details
Permissions:
- UpdateData
Parameters:
- Library.Id episodeid
- [ Optional.String title = null ]
- [ Optional.Integer playcount = null ]
- [ Optional.Integer runtime = null ]
- [ mixed director = null ]
- [ Optional.String plot = null ]
- [ Optional.Number rating = null ]
- [ Optional.String votes = null ]
- [ Optional.String lastplayed = null ]
- [ mixed writer = null ]
- [ Optional.String firstaired = null ]
- [ Optional.String productioncode = null ]
- [ Optional.Integer season = null ]
- [ Optional.Integer episode = null ]
- [ Optional.String originaltitle = null ]
- [ Optional.String thumbnail = null ]
- [ Optional.String fanart = null ]
- [ mixed art = null ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "episodeid", "required": true }, { "$ref": "Optional.String", "name": "title", "default": null }, { "$ref": "Optional.Integer", "name": "playcount", "default": null }, { "$ref": "Optional.Integer", "description": "Runtime in seconds", "name": "runtime", "default": null }, { "name": "director", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "$ref": "Optional.String", "name": "plot", "default": null }, { "$ref": "Optional.Number", "name": "rating", "default": null }, { "$ref": "Optional.String", "name": "votes", "default": null }, { "$ref": "Optional.String", "name": "lastplayed", "default": null }, { "name": "writer", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "$ref": "Optional.String", "name": "firstaired", "default": null }, { "$ref": "Optional.String", "name": "productioncode", "default": null }, { "$ref": "Optional.Integer", "name": "season", "default": null }, { "$ref": "Optional.Integer", "name": "episode", "default": null }, { "$ref": "Optional.String", "name": "originaltitle", "default": null }, { "$ref": "Optional.String", "name": "thumbnail", "default": null }, { "$ref": "Optional.String", "name": "fanart", "default": null }, { "name": "art", "type": [ { "type": "null" }, { "$ref": "Media.Artwork" } ], "default": null } ], "description": "Update the given episode with the given details", "returns": { "type": "string" } } |
VideoLibrary.SetMovieDetails
Update the given movie with the given details
Permissions:
- UpdateData
Parameters:
- Library.Id movieid
- [ Optional.String title = null ]
- [ Optional.Integer playcount = null ]
- [ Optional.Integer runtime = null ]
- [ mixed director = null ]
- [ mixed studio = null ]
- [ Optional.Integer year = null ]
- [ Optional.String plot = null ]
- [ mixed genre = null ]
- [ Optional.Number rating = null ]
- [ Optional.String mpaa = null ]
- [ Optional.String imdbnumber = null ]
- [ Optional.String votes = null ]
- [ Optional.String lastplayed = null ]
- [ Optional.String originaltitle = null ]
- [ Optional.String trailer = null ]
- [ Optional.String tagline = null ]
- [ Optional.String plotoutline = null ]
- [ mixed writer = null ]
- [ mixed country = null ]
- [ Optional.Integer top250 = null ]
- [ Optional.String sorttitle = null ]
- [ Optional.String set = null ]
- [ mixed showlink = null ]
- [ Optional.String thumbnail = null ]
- [ Optional.String fanart = null ]
- [ mixed tag = null ]
- [ mixed art = null ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "movieid", "required": true }, { "$ref": "Optional.String", "name": "title", "default": null }, { "$ref": "Optional.Integer", "name": "playcount", "default": null }, { "$ref": "Optional.Integer", "description": "Runtime in seconds", "name": "runtime", "default": null }, { "name": "director", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "name": "studio", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "$ref": "Optional.Integer", "name": "year", "default": null }, { "$ref": "Optional.String", "name": "plot", "default": null }, { "name": "genre", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "$ref": "Optional.Number", "name": "rating", "default": null }, { "$ref": "Optional.String", "name": "mpaa", "default": null }, { "$ref": "Optional.String", "name": "imdbnumber", "default": null }, { "$ref": "Optional.String", "name": "votes", "default": null }, { "$ref": "Optional.String", "name": "lastplayed", "default": null }, { "$ref": "Optional.String", "name": "originaltitle", "default": null }, { "$ref": "Optional.String", "name": "trailer", "default": null }, { "$ref": "Optional.String", "name": "tagline", "default": null }, { "$ref": "Optional.String", "name": "plotoutline", "default": null }, { "name": "writer", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "name": "country", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "$ref": "Optional.Integer", "name": "top250", "default": null }, { "$ref": "Optional.String", "name": "sorttitle", "default": null }, { "$ref": "Optional.String", "name": "set", "default": null }, { "name": "showlink", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "$ref": "Optional.String", "name": "thumbnail", "default": null }, { "$ref": "Optional.String", "name": "fanart", "default": null }, { "name": "tag", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "name": "art", "type": [ { "type": "null" }, { "$ref": "Media.Artwork" } ], "default": null } ], "description": "Update the given movie with the given details", "returns": { "type": "string" } } |
VideoLibrary.SetMusicVideoDetails
Update the given music video with the given details
Permissions:
- UpdateData
Parameters:
- Library.Id musicvideoid
- [ Optional.String title = null ]
- [ Optional.Integer playcount = null ]
- [ Optional.Integer runtime = null ]
- [ mixed director = null ]
- [ mixed studio = null ]
- [ Optional.Integer year = null ]
- [ Optional.String plot = null ]
- [ Optional.String album = null ]
- [ mixed artist = null ]
- [ mixed genre = null ]
- [ Optional.Integer track = null ]
- [ Optional.String lastplayed = null ]
- [ Optional.String thumbnail = null ]
- [ Optional.String fanart = null ]
- [ mixed tag = null ]
- [ mixed art = null ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "musicvideoid", "required": true }, { "$ref": "Optional.String", "name": "title", "default": null }, { "$ref": "Optional.Integer", "name": "playcount", "default": null }, { "$ref": "Optional.Integer", "description": "Runtime in seconds", "name": "runtime", "default": null }, { "name": "director", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "name": "studio", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "$ref": "Optional.Integer", "name": "year", "default": null }, { "$ref": "Optional.String", "name": "plot", "default": null }, { "$ref": "Optional.String", "name": "album", "default": null }, { "name": "artist", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "name": "genre", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "$ref": "Optional.Integer", "name": "track", "default": null }, { "$ref": "Optional.String", "name": "lastplayed", "default": null }, { "$ref": "Optional.String", "name": "thumbnail", "default": null }, { "$ref": "Optional.String", "name": "fanart", "default": null }, { "name": "tag", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "name": "art", "type": [ { "type": "null" }, { "$ref": "Media.Artwork" } ], "default": null } ], "description": "Update the given music video with the given details", "returns": { "type": "string" } } |
VideoLibrary.SetTVShowDetails
Update the given tvshow with the given details
Permissions:
- UpdateData
Parameters:
- Library.Id tvshowid
- [ Optional.String title = null ]
- [ Optional.Integer playcount = null ]
- [ mixed studio = null ]
- [ Optional.String plot = null ]
- [ mixed genre = null ]
- [ Optional.Number rating = null ]
- [ Optional.String mpaa = null ]
- [ Optional.String imdbnumber = null ]
- [ Optional.String premiered = null ]
- [ Optional.String votes = null ]
- [ Optional.String lastplayed = null ]
- [ Optional.String originaltitle = null ]
- [ Optional.String sorttitle = null ]
- [ Optional.String episodeguide = null ]
- [ Optional.String thumbnail = null ]
- [ Optional.String fanart = null ]
- [ mixed tag = null ]
- [ mixed art = null ]
Returns: string
JSON Schema Description |
---|
{ "params": [ { "$ref": "Library.Id", "name": "tvshowid", "required": true }, { "$ref": "Optional.String", "name": "title", "default": null }, { "$ref": "Optional.Integer", "name": "playcount", "default": null }, { "name": "studio", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "$ref": "Optional.String", "name": "plot", "default": null }, { "name": "genre", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "$ref": "Optional.Number", "name": "rating", "default": null }, { "$ref": "Optional.String", "name": "mpaa", "default": null }, { "$ref": "Optional.String", "name": "imdbnumber", "default": null }, { "$ref": "Optional.String", "name": "premiered", "default": null }, { "$ref": "Optional.String", "name": "votes", "default": null }, { "$ref": "Optional.String", "name": "lastplayed", "default": null }, { "$ref": "Optional.String", "name": "originaltitle", "default": null }, { "$ref": "Optional.String", "name": "sorttitle", "default": null }, { "$ref": "Optional.String", "name": "episodeguide", "default": null }, { "$ref": "Optional.String", "name": "thumbnail", "default": null }, { "$ref": "Optional.String", "name": "fanart", "default": null }, { "name": "tag", "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "default": null }, { "name": "art", "type": [ { "type": "null" }, { "$ref": "Media.Artwork" } ], "default": null } ], "description": "Update the given tvshow with the given details", "returns": { "type": "string" } } |
XBMC
XBMC.GetInfoBooleans
Retrieve info booleans about XBMC and the system
Permissions:
- ReadData
Parameters:
- array[1..X] booleans
Returns:
Type: object
JSON Schema Description |
---|
{ "params": [ { "minItems": 1, "items": { "type": "string" }, "name": "booleans", "type": "array", "required": true } ], "description": "Retrieve info booleans about {{name}} and the system", "returns": { "additionalProperties": { "type": "string", "default": "" }, "description": "Object containing key-value pairs of the retrieved info booleans", "type": "object" } } |
XBMC.GetInfoLabels
Retrieve info labels about XBMC and the system
Permissions:
- ReadData
Parameters:
- array[1..X] labels
Returns:
Type: object
JSON Schema Description |
---|
{ "params": [ { "description": "See http://wiki.xbmc.org/index.php?title=InfoLabels for a list of possible info labels", "name": "labels", "type": "array", "minItems": 1, "items": { "type": "string" }, "required": true } ], "description": "Retrieve info labels about {{name}} and the system", "returns": { "additionalProperties": { "type": "string", "default": "" }, "description": "Object containing key-value pairs of the retrieved info labels", "type": "object" } } |
Global types
Addon
Addon.Content
Type: string
JSON Schema Description |
---|
{ "enums": [ "unknown", "video", "audio", "image", "executable" ], "id": "Addon.Content", "type": "string", "default": "unknown" } |
Addon.Details
Extends:
Properties:
- string addonid
- [ string disclaimer = "" ]
- [ string fanart = "" ]
- [ mixed broken = null ]
- [ string author = "" ]
- [ boolean enabled = False ]
- [ array extrainfo ]
- [ string thumbnail = "" ]
- [ string path = "" ]
- [ array dependencies ]
- Addon.Types type
- [ string description = "" ]
- [ string name = "" ]
- [ string version = "" ]
- [ string summary = "" ]
- [ integer rating = 0 ]
JSON Schema Description |
---|
{ "id": "Addon.Details", "properties": { "addonid": { "required": true, "type": "string" }, "disclaimer": { "type": "string", "default": "" }, "fanart": { "type": "string", "default": "" }, "broken": { "type": [ { "type": "boolean" }, { "type": "string" } ], "default": null }, "author": { "type": "string", "default": "" }, "enabled": { "type": "boolean", "default": false }, "extrainfo": { "items": { "properties": { "value": { "required": true, "type": "string" }, "key": { "required": true, "type": "string" } }, "type": "object" }, "type": "array" }, "thumbnail": { "type": "string", "default": "" }, "path": { "type": "string", "default": "" }, "dependencies": { "items": { "properties": { "addonid": { "required": true, "type": "string" }, "version": { "required": true, "type": "string" }, "optional": { "required": true, "type": "boolean" } }, "type": "object" }, "type": "array" }, "type": { "$ref": "Addon.Types", "required": true }, "description": { "type": "string", "default": "" }, "name": { "type": "string", "default": "" }, "version": { "type": "string", "default": "" }, "summary": { "type": "string", "default": "" }, "rating": { "type": "integer", "default": 0 } }, "extends": "Item.Details.Base" } |
Addon.Fields
Extends:
JSON Schema Description |
---|
{ "items": { "enums": [ "name", "version", "summary", "description", "path", "author", "thumbnail", "disclaimer", "fanart", "dependencies", "broken", "extrainfo", "rating", "enabled" ], "type": "string" }, "id": "Addon.Fields", "extends": "Item.Fields.Base" } |
Addon.Types
Type: string
JSON Schema Description |
---|
{ "enums": [ "unknown", "xbmc.metadata.scraper.albums", "xbmc.metadata.scraper.artists", "xbmc.metadata.scraper.movies", "xbmc.metadata.scraper.musicvideos", "xbmc.metadata.scraper.tvshows", "xbmc.ui.screensaver", "xbmc.player.musicviz", "xbmc.python.pluginsource", "xbmc.python.script", "xbmc.python.weather", "xbmc.python.subtitles", "xbmc.python.lyrics", "xbmc.gui.skin", "xbmc.gui.webinterface", "xbmc.addon.video", "xbmc.addon.audio", "xbmc.addon.image", "xbmc.addon.executable", "xbmc.service" ], "id": "Addon.Types", "type": "string", "default": "unknown" } |
Application
Application.Property.Name
Type: string
JSON Schema Description |
---|
{ "enums": [ "volume", "muted", "name", "version" ], "id": "Application.Property.Name", "type": "string", "default": "volume" } |
Application.Property.Value
Type: object
Properties:
- [ object version ]
Properties:
- integer minor
- string tag
- integer major
- [ mixed revision = null ]
- [ string name = "" ]
- [ integer volume = 0 ]
- [ boolean muted = False ]
JSON Schema Description |
---|
{ "id": "Application.Property.Value", "properties": { "version": { "properties": { "minor": { "minimum": 0, "required": true, "type": "integer" }, "tag": { "enums": [ "prealpha", "alpha", "beta", "releasecandidate", "stable" ], "required": true, "type": "string" }, "major": { "minimum": 0, "required": true, "type": "integer" }, "revision": { "type": [ { "type": "string" }, { "type": "integer" } ], "default": null } }, "type": "object" }, "name": { "minLength": 1, "type": "string", "default": "" }, "volume": { "minimum": 0, "type": "integer", "default": 0, "maximum": 100 }, "muted": { "type": "boolean", "default": false } }, "type": "object" } |
Array
Array.Integer
Type: array
JSON Schema Description |
---|
{ "items": { "type": "integer" }, "id": "Array.Integer", "type": "array" } |
Array.String
Type: array
JSON Schema Description |
---|
{ "items": { "minLength": 1, "type": "string" }, "id": "Array.String", "type": "array" } |
Audio
Audio.Details.Album
Extends:
Properties:
- [ Array.String theme ]
- [ string description = "" ]
- [ string type = "" ]
- [ Array.String style ]
- Library.Id albumid
- [ integer playcount = 0 ]
- [ string albumlabel = "" ]
- [ Array.String mood ]
JSON Schema Description |
---|
{ "id": "Audio.Details.Album", "properties": { "theme": { "$ref": "Array.String" }, "description": { "type": "string", "default": "" }, "type": { "type": "string", "default": "" }, "style": { "$ref": "Array.String" }, "albumid": { "$ref": "Library.Id", "required": true }, "playcount": { "type": "integer", "default": 0 }, "albumlabel": { "type": "string", "default": "" }, "mood": { "$ref": "Array.String" } }, "extends": "Audio.Details.Media" } |
Audio.Details.Artist
Extends:
Properties:
- [ string born = "" ]
- [ string formed = "" ]
- [ string died = "" ]
- [ Array.String style ]
- [ Array.String yearsactive ]
- [ Array.String mood ]
- [ string musicbrainzartistid = "" ]
- [ string disbanded = "" ]
- [ string description = "" ]
- string artist
- [ Array.String instrument ]
- Library.Id artistid
JSON Schema Description |
---|
{ "id": "Audio.Details.Artist", "properties": { "born": { "type": "string", "default": "" }, "formed": { "type": "string", "default": "" }, "died": { "type": "string", "default": "" }, "style": { "$ref": "Array.String" }, "yearsactive": { "$ref": "Array.String" }, "mood": { "$ref": "Array.String" }, "musicbrainzartistid": { "type": "string", "default": "" }, "disbanded": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "artist": { "required": true, "type": "string" }, "instrument": { "$ref": "Array.String" }, "artistid": { "$ref": "Library.Id", "required": true } }, "extends": "Audio.Details.Base" } |
Audio.Details.Base
Extends:
Properties:
- [ Array.String genre ]
JSON Schema Description |
---|
{ "id": "Audio.Details.Base", "properties": { "genre": { "$ref": "Array.String" } }, "extends": "Media.Details.Base" } |
Audio.Details.Media
Extends:
Properties:
- [ string displayartist = "" ]
- [ Array.String artist ]
- [ Array.Integer genreid ]
- [ string musicbrainzalbumartistid = "" ]
- [ integer year = 0 ]
- [ integer rating = 0 ]
- [ Array.Integer artistid ]
- [ string title = "" ]
- [ string musicbrainzalbumid = "" ]
JSON Schema Description |
---|
{ "id": "Audio.Details.Media", "properties": { "displayartist": { "type": "string", "default": "" }, "artist": { "$ref": "Array.String" }, "genreid": { "$ref": "Array.Integer" }, "musicbrainzalbumartistid": { "type": "string", "default": "" }, "year": { "type": "integer", "default": 0 }, "rating": { "type": "integer", "default": 0 }, "artistid": { "$ref": "Array.Integer" }, "title": { "type": "string", "default": "" }, "musicbrainzalbumid": { "type": "string", "default": "" } }, "extends": "Audio.Details.Base" } |
Audio.Details.Song
Extends:
Properties:
- [ string lyrics = "" ]
- Library.Id songid
- [ Array.Integer albumartistid ]
- [ integer disc = 0 ]
- [ string comment = "" ]
- [ integer playcount = 0 ]
- [ string album = "" ]
- [ string file = "" ]
- [ string lastplayed = "" ]
- [ Library.Id albumid = -1 ]
- [ string musicbrainzartistid = "" ]
- [ Array.String albumartist ]
- [ integer duration = 0 ]
- [ string musicbrainztrackid = "" ]
- [ integer track = 0 ]
JSON Schema Description |
---|
{ "id": "Audio.Details.Song", "properties": { "lyrics": { "type": "string", "default": "" }, "songid": { "$ref": "Library.Id", "required": true }, "albumartistid": { "$ref": "Array.Integer" }, "disc": { "type": "integer", "default": 0 }, "comment": { "type": "string", "default": "" }, "playcount": { "type": "integer", "default": 0 }, "album": { "type": "string", "default": "" }, "file": { "type": "string", "default": "" }, "lastplayed": { "type": "string", "default": "" }, "albumid": { "$ref": "Library.Id", "default": -1 }, "musicbrainzartistid": { "type": "string", "default": "" }, "albumartist": { "$ref": "Array.String" }, "duration": { "type": "integer", "default": 0 }, "musicbrainztrackid": { "type": "string", "default": "" }, "track": { "type": "integer", "default": 0 } }, "extends": "Audio.Details.Media" } |
Audio.Fields.Album
Extends:
JSON Schema Description |
---|
{ "items": { "enums": [ "title", "description", "artist", "genre", "theme", "mood", "style", "type", "albumlabel", "rating", "year", "musicbrainzalbumid", "musicbrainzalbumartistid", "fanart", "thumbnail", "playcount", "genreid", "artistid", "displayartist" ], "description": "Requesting the genreid and/or artistid field will result in increased response times", "type": "string" }, "id": "Audio.Fields.Album", "extends": "Item.Fields.Base" } |
Audio.Fields.Artist
Extends:
JSON Schema Description |
---|
{ "items": { "enums": [ "instrument", "style", "mood", "born", "formed", "description", "genre", "died", "disbanded", "yearsactive", "musicbrainzartistid", "fanart", "thumbnail" ], "type": "string" }, "id": "Audio.Fields.Artist", "extends": "Item.Fields.Base" } |
Audio.Fields.Song
Extends:
JSON Schema Description |
---|
{ "items": { "enums": [ "title", "artist", "albumartist", "genre", "year", "rating", "album", "track", "duration", "comment", "lyrics", "musicbrainztrackid", "musicbrainzartistid", "musicbrainzalbumid", "musicbrainzalbumartistid", "playcount", "fanart", "thumbnail", "file", "albumid", "lastplayed", "disc", "genreid", "artistid", "displayartist", "albumartistid" ], "description": "Requesting the genreid, artistid and/or albumartistid field will result in increased response times", "type": "string" }, "id": "Audio.Fields.Song", "extends": "Item.Fields.Base" } |
Configuration
Configuration
Type: object
Properties:
- Configuration.Notifications notifications
JSON Schema Description |
---|
{ "id": "Configuration", "properties": { "notifications": { "$ref": "Configuration.Notifications", "required": true } }, "required": true, "type": "object" } |
Configuration.Notifications
Type: object
Properties:
- boolean gui
- boolean other
- boolean input
- boolean videolibrary
- boolean audiolibrary
- boolean pvr
- boolean playlist
- boolean system
- boolean player
- boolean application
JSON Schema Description |
---|
{ "additionalProperties": false, "id": "Configuration.Notifications", "properties": { "gui": { "required": true, "type": "boolean" }, "other": { "required": true, "type": "boolean" }, "input": { "required": true, "type": "boolean" }, "videolibrary": { "required": true, "type": "boolean" }, "audiolibrary": { "required": true, "type": "boolean" }, "pvr": { "required": true, "type": "boolean" }, "playlist": { "required": true, "type": "boolean" }, "system": { "required": true, "type": "boolean" }, "player": { "required": true, "type": "boolean" }, "application": { "required": true, "type": "boolean" } }, "type": "object" } |
Files
Files.Media
Type: string
JSON Schema Description |
---|
{ "enums": [ "video", "music", "pictures", "files", "programs" ], "id": "Files.Media", "type": "string", "default": "video" } |
GUI
GUI.Property.Name
Type: string
JSON Schema Description |
---|
{ "enums": [ "currentwindow", "currentcontrol", "skin", "fullscreen" ], "id": "GUI.Property.Name", "type": "string", "default": "currentwindow" } |
GUI.Property.Value
Type: object
Properties:
- [ object currentwindow ]
Properties:
- string label
- integer id
- [ boolean fullscreen = False ]
- [ object skin ]
Properties:
- string id
- [ string name = "" ]
- [ object currentcontrol ]
Properties:
- string label
JSON Schema Description |
---|
{ "id": "GUI.Property.Value", "properties": { "currentwindow": { "properties": { "label": { "required": true, "type": "string" }, "id": { "required": true, "type": "integer" } }, "type": "object" }, "fullscreen": { "type": "boolean", "default": false }, "skin": { "properties": { "id": { "minLength": 1, "required": true, "type": "string" }, "name": { "type": "string", "default": "" } }, "type": "object" }, "currentcontrol": { "properties": { "label": { "required": true, "type": "string" } }, "type": "object" } }, "type": "object" } |
GUI.Window
Type: string
JSON Schema Description |
---|
{ "enums": [ "home", "programs", "pictures", "filemanager", "files", "settings", "music", "video", "videos", "tv", "pvr", "pvrguideinfo", "pvrrecordinginfo", "pvrtimersetting", "pvrgroupmanager", "pvrchannelmanager", "pvrguidesearch", "pvrchannelscan", "pvrupdateprogress", "pvrosdchannels", "pvrosdguide", "pvrosddirector", "pvrosdcutter", "pvrosdteletext", "systeminfo", "testpattern", "screencalibration", "guicalibration", "picturessettings", "programssettings", "weathersettings", "musicsettings", "systemsettings", "videossettings", "networksettings", "servicesettings", "appearancesettings", "pvrsettings", "tvsettings", "scripts", "videofiles", "videolibrary", "videoplaylist", "loginscreen", "profiles", "skinsettings", "addonbrowser", "yesnodialog", "progressdialog", "virtualkeyboard", "volumebar", "submenu", "favourites", "contextmenu", "infodialog", "numericinput", "gamepadinput", "shutdownmenu", "mutebug", "playercontrols", "seekbar", "musicosd", "addonsettings", "visualisationsettings", "visualisationpresetlist", "osdvideosettings", "osdaudiosettings", "videobookmarks", "filebrowser", "networksetup", "mediasource", "profilesettings", "locksettings", "contentsettings", "songinformation", "smartplaylisteditor", "smartplaylistrule", "busydialog", "pictureinfo", "accesspoints", "fullscreeninfo", "karaokeselector", "karaokelargeselector", "sliderdialog", "addoninformation", "musicplaylist", "musicfiles", "musiclibrary", "musicplaylisteditor", "teletext", "selectdialog", "musicinformation", "okdialog", "movieinformation", "textviewer", "fullscreenvideo", "fullscreenlivetv", "visualisation", "slideshow", "filestackingdialog", "karaoke", "weather", "screensaver", "videoosd", "videomenu", "videotimeseek", "musicoverlay", "videooverlay", "startwindow", "startup", "peripherals", "peripheralsettings", "extendedprogressdialog", "mediafilter" ], "id": "GUI.Window", "type": "string", "default": "home" } |
Global
Global.IncrementDecrement
Type: string
JSON Schema Description |
---|
{ "enums": [ "increment", "decrement" ], "id": "Global.IncrementDecrement", "type": "string", "default": "increment" } |
Global.String.NotEmpty
Type: string
JSON Schema Description |
---|
{ "id": "Global.String.NotEmpty", "minLength": 1, "type": "string", "default": "" } |
Global.Time
Type: object
Properties:
- integer hours
- integer milliseconds
- integer seconds
- integer minutes
JSON Schema Description |
---|
{ "additionalProperties": false, "id": "Global.Time", "properties": { "hours": { "minimum": 0, "required": true, "type": "integer", "maximum": 23 }, "milliseconds": { "minimum": 0, "required": true, "type": "integer", "maximum": 999 }, "seconds": { "minimum": 0, "required": true, "type": "integer", "maximum": 59 }, "minutes": { "minimum": 0, "required": true, "type": "integer", "maximum": 59 } }, "type": "object" } |
Global.Toggle
Type: mixed
JSON Schema Description |
---|
{ "id": "Global.Toggle", "type": [ { "type": "boolean" }, { "enums": [ "toggle" ], "type": "string" } ], "default": null } |
Input
Input.Action
Type: string
JSON Schema Description |
---|
{ "enums": [ "left", "right", "up", "down", "pageup", "pagedown", "select", "highlight", "parentdir", "parentfolder", "back", "previousmenu", "info", "pause", "stop", "skipnext", "skipprevious", "fullscreen", "aspectratio", "stepforward", "stepback", "bigstepforward", "bigstepback", "osd", "showsubtitles", "nextsubtitle", "codecinfo", "nextpicture", "previouspicture", "zoomout", "zoomin", "playlist", "queue", "zoomnormal", "zoomlevel1", "zoomlevel2", "zoomlevel3", "zoomlevel4", "zoomlevel5", "zoomlevel6", "zoomlevel7", "zoomlevel8", "zoomlevel9", "nextcalibration", "resetcalibration", "analogmove", "rotate", "rotateccw", "close", "subtitledelayminus", "subtitledelay", "subtitledelayplus", "audiodelayminus", "audiodelay", "audiodelayplus", "subtitleshiftup", "subtitleshiftdown", "subtitlealign", "audionextlanguage", "verticalshiftup", "verticalshiftdown", "nextresolution", "audiotoggledigital", "number0", "number1", "number2", "number3", "number4", "number5", "number6", "number7", "number8", "number9", "osdleft", "osdright", "osdup", "osddown", "osdselect", "osdvalueplus", "osdvalueminus", "smallstepback", "fastforward", "rewind", "play", "playpause", "delete", "copy", "move", "mplayerosd", "hidesubmenu", "screenshot", "rename", "togglewatched", "scanitem", "reloadkeymaps", "volumeup", "volumedown", "mute", "backspace", "scrollup", "scrolldown", "analogfastforward", "analogrewind", "moveitemup", "moveitemdown", "contextmenu", "shift", "symbols", "cursorleft", "cursorright", "showtime", "analogseekforward", "analogseekback", "showpreset", "presetlist", "nextpreset", "previouspreset", "lockpreset", "randompreset", "increasevisrating", "decreasevisrating", "showvideomenu", "enter", "increaserating", "decreaserating", "togglefullscreen", "nextscene", "previousscene", "nextletter", "prevletter", "jumpsms2", "jumpsms3", "jumpsms4", "jumpsms5", "jumpsms6", "jumpsms7", "jumpsms8", "jumpsms9", "filter", "filterclear", "filtersms2", "filtersms3", "filtersms4", "filtersms5", "filtersms6", "filtersms7", "filtersms8", "filtersms9", "firstpage", "lastpage", "guiprofile", "red", "green", "yellow", "blue", "increasepar", "decreasepar", "volampup", "volampdown", "channelup", "channeldown", "previouschannelgroup", "nextchannelgroup", "leftclick", "rightclick", "middleclick", "doubleclick", "wheelup", "wheeldown", "mousedrag", "mousemove", "noop" ], "id": "Input.Action", "type": "string", "default": "left" } |
Item
Item.Details.Base
Type: object
Properties:
- string label
JSON Schema Description |
---|
{ "id": "Item.Details.Base", "properties": { "label": { "required": true, "type": "string" } }, "type": "object" } |
Item.Fields.Base
Type: array
JSON Schema Description |
---|
{ "items": { "type": "string" }, "uniqueItems": true, "id": "Item.Fields.Base", "type": "array" } |
Library
Library.Details.Genre
Extends:
Properties:
- [ string thumbnail = "" ]
- [ string title = "" ]
- Library.Id genreid
JSON Schema Description |
---|
{ "id": "Library.Details.Genre", "properties": { "thumbnail": { "type": "string", "default": "" }, "title": { "type": "string", "default": "" }, "genreid": { "$ref": "Library.Id", "required": true } }, "extends": "Item.Details.Base" } |
Library.Fields.Genre
Extends:
JSON Schema Description |
---|
{ "items": { "enums": [ "title", "thumbnail" ], "type": "string" }, "id": "Library.Fields.Genre", "extends": "Item.Fields.Base" } |
Library.Id
Type: integer
JSON Schema Description |
---|
{ "minimum": 1, "id": "Library.Id", "type": "integer", "default": -1 } |
List
List.Amount
Type: integer
JSON Schema Description |
---|
{ "minimum": 0, "id": "List.Amount", "type": "integer", "default": -1 } |
List.Fields.All
Extends:
JSON Schema Description |
---|
{ "items": { "enums": [ "title", "artist", "albumartist", "genre", "year", "rating", "album", "track", "duration", "comment", "lyrics", "musicbrainztrackid", "musicbrainzartistid", "musicbrainzalbumid", "musicbrainzalbumartistid", "playcount", "fanart", "director", "trailer", "tagline", "plot", "plotoutline", "originaltitle", "lastplayed", "writer", "studio", "mpaa", "cast", "country", "imdbnumber", "premiered", "productioncode", "runtime", "set", "showlink", "streamdetails", "top250", "votes", "firstaired", "season", "episode", "showtitle", "thumbnail", "file", "resume", "artistid", "albumid", "tvshowid", "setid", "watchedepisodes", "disc", "tag", "art", "genreid", "displayartist", "albumartistid", "description", "theme", "mood", "style", "albumlabel", "sorttitle", "episodeguide", "uniqueid", "dateadded", "channel", "channeltype", "hidden", "locked", "channelnumber", "starttime", "endtime" ], "type": "string" }, "id": "List.Fields.All", "extends": "Item.Fields.Base" } |
List.Fields.Files
Extends:
JSON Schema Description |
---|
{ "items": { "enums": [ "title", "artist", "albumartist", "genre", "year", "rating", "album", "track", "duration", "comment", "lyrics", "musicbrainztrackid", "musicbrainzartistid", "musicbrainzalbumid", "musicbrainzalbumartistid", "playcount", "fanart", "director", "trailer", "tagline", "plot", "plotoutline", "originaltitle", "lastplayed", "writer", "studio", "mpaa", "cast", "country", "imdbnumber", "premiered", "productioncode", "runtime", "set", "showlink", "streamdetails", "top250", "votes", "firstaired", "season", "episode", "showtitle", "thumbnail", "file", "resume", "artistid", "albumid", "tvshowid", "setid", "watchedepisodes", "disc", "tag", "art", "genreid", "displayartist", "albumartistid", "description", "theme", "mood", "style", "albumlabel", "sorttitle", "episodeguide", "uniqueid", "dateadded", "size", "lastmodified", "mimetype" ], "type": "string" }, "id": "List.Fields.Files", "extends": "Item.Fields.Base" } |
List.Filter.Albums
Type: mixed
JSON Schema Description |
---|
{ "id": "List.Filter.Albums", "type": [ { "properties": { "and": { "minItems": 1, "items": { "$ref": "List.Filter.Albums" }, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "minItems": 1, "items": { "$ref": "List.Filter.Albums" }, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.Albums" } ] } |
List.Filter.Artists
Type: mixed
JSON Schema Description |
---|
{ "id": "List.Filter.Artists", "type": [ { "properties": { "and": { "minItems": 1, "items": { "$ref": "List.Filter.Artists" }, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "minItems": 1, "items": { "$ref": "List.Filter.Artists" }, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.Artists" } ] } |
List.Filter.Episodes
Type: mixed
JSON Schema Description |
---|
{ "id": "List.Filter.Episodes", "type": [ { "properties": { "and": { "minItems": 1, "items": { "$ref": "List.Filter.Episodes" }, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "minItems": 1, "items": { "$ref": "List.Filter.Episodes" }, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.Episodes" } ] } |
List.Filter.Fields.Albums
Type: string
JSON Schema Description |
---|
{ "enums": [ "genre", "album", "artist", "albumartist", "year", "review", "themes", "moods", "styles", "type", "label", "rating", "playcount", "playlist" ], "id": "List.Filter.Fields.Albums", "type": "string", "default": "genre" } |
List.Filter.Fields.Artists
Type: string
JSON Schema Description |
---|
{ "enums": [ "artist", "genre", "moods", "styles", "instruments", "biography", "born", "bandformed", "disbanded", "died", "playlist" ], "id": "List.Filter.Fields.Artists", "type": "string", "default": "artist" } |
List.Filter.Fields.Episodes
Type: string
JSON Schema Description |
---|
{ "enums": [ "title", "tvshow", "plot", "votes", "rating", "time", "writers", "airdate", "playcount", "lastplayed", "inprogress", "genre", "year", "director", "actor", "episode", "season", "filename", "path", "studio", "mpaarating", "dateadded", "videoresolution", "audiochannels", "videocodec", "audiocodec", "audiolanguage", "subtitlelanguage", "videoaspect", "playlist" ], "id": "List.Filter.Fields.Episodes", "type": "string", "default": "title" } |
List.Filter.Fields.Movies
Type: string
JSON Schema Description |
---|
{ "enums": [ "title", "plot", "plotoutline", "tagline", "votes", "rating", "time", "writers", "playcount", "lastplayed", "inprogress", "genre", "country", "year", "director", "actor", "mpaarating", "top250", "studio", "hastrailer", "filename", "path", "set", "tag", "dateadded", "videoresolution", "audiochannels", "videocodec", "audiocodec", "audiolanguage", "subtitlelanguage", "videoaspect", "playlist" ], "id": "List.Filter.Fields.Movies", "type": "string", "default": "title" } |
List.Filter.Fields.MusicVideos
Type: string
JSON Schema Description |
---|
{ "enums": [ "title", "genre", "album", "year", "artist", "filename", "path", "playcount", "lastplayed", "time", "director", "studio", "plot", "dateadded", "videoresolution", "audiochannels", "videocodec", "audiocodec", "audiolanguage", "subtitlelanguage", "videoaspect", "playlist" ], "id": "List.Filter.Fields.MusicVideos", "type": "string", "default": "title" } |
List.Filter.Fields.Songs
Type: string
JSON Schema Description |
---|
{ "enums": [ "genre", "album", "artist", "albumartist", "title", "year", "time", "tracknumber", "filename", "path", "playcount", "lastplayed", "rating", "comment", "dateadded", "playlist" ], "id": "List.Filter.Fields.Songs", "type": "string", "default": "genre" } |
List.Filter.Fields.TVShows
Type: string
JSON Schema Description |
---|
{ "enums": [ "title", "plot", "status", "votes", "rating", "year", "genre", "director", "actor", "numepisodes", "numwatched", "playcount", "path", "studio", "mpaarating", "dateadded", "lastplayed", "inprogress", "playlist" ], "id": "List.Filter.Fields.TVShows", "type": "string", "default": "title" } |
List.Filter.Movies
Type: mixed
JSON Schema Description |
---|
{ "id": "List.Filter.Movies", "type": [ { "properties": { "and": { "minItems": 1, "items": { "$ref": "List.Filter.Movies" }, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "minItems": 1, "items": { "$ref": "List.Filter.Movies" }, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.Movies" } ] } |
List.Filter.MusicVideos
Type: mixed
JSON Schema Description |
---|
{ "id": "List.Filter.MusicVideos", "type": [ { "properties": { "and": { "minItems": 1, "items": { "$ref": "List.Filter.MusicVideos" }, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "minItems": 1, "items": { "$ref": "List.Filter.MusicVideos" }, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.MusicVideos" } ] } |
List.Filter.Operators
Type: string
JSON Schema Description |
---|
{ "enums": [ "contains", "doesnotcontain", "is", "isnot", "startswith", "endswith", "greaterthan", "lessthan", "after", "before", "inthelast", "notinthelast", "true", "false", "between" ], "id": "List.Filter.Operators", "type": "string", "default": "contains" } |
List.Filter.Rule
Type: object
Properties:
- mixed value
- List.Filter.Operators operator
JSON Schema Description |
---|
{ "id": "List.Filter.Rule", "properties": { "value": { "required": true, "type": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "operator": { "$ref": "List.Filter.Operators", "required": true } }, "type": "object" } |
List.Filter.Rule.Albums
Extends:
Properties:
JSON Schema Description |
---|
{ "id": "List.Filter.Rule.Albums", "properties": { "field": { "$ref": "List.Filter.Fields.Albums", "required": true } }, "extends": "List.Filter.Rule" } |
List.Filter.Rule.Artists
Extends:
Properties:
JSON Schema Description |
---|
{ "id": "List.Filter.Rule.Artists", "properties": { "field": { "$ref": "List.Filter.Fields.Artists", "required": true } }, "extends": "List.Filter.Rule" } |
List.Filter.Rule.Episodes
Extends:
Properties:
JSON Schema Description |
---|
{ "id": "List.Filter.Rule.Episodes", "properties": { "field": { "$ref": "List.Filter.Fields.Episodes", "required": true } }, "extends": "List.Filter.Rule" } |
List.Filter.Rule.Movies
Extends:
Properties:
JSON Schema Description |
---|
{ "id": "List.Filter.Rule.Movies", "properties": { "field": { "$ref": "List.Filter.Fields.Movies", "required": true } }, "extends": "List.Filter.Rule" } |
List.Filter.Rule.MusicVideos
Extends:
Properties:
JSON Schema Description |
---|
{ "id": "List.Filter.Rule.MusicVideos", "properties": { "field": { "$ref": "List.Filter.Fields.MusicVideos", "required": true } }, "extends": "List.Filter.Rule" } |
List.Filter.Rule.Songs
Extends:
Properties:
- List.Filter.Fields.Songs field
JSON Schema Description |
---|
{ "id": "List.Filter.Rule.Songs", "properties": { "field": { "$ref": "List.Filter.Fields.Songs", "required": true } }, "extends": "List.Filter.Rule" } |
List.Filter.Rule.TVShows
Extends:
Properties:
JSON Schema Description |
---|
{ "id": "List.Filter.Rule.TVShows", "properties": { "field": { "$ref": "List.Filter.Fields.TVShows", "required": true } }, "extends": "List.Filter.Rule" } |
List.Filter.Songs
Type: mixed
JSON Schema Description |
---|
{ "id": "List.Filter.Songs", "type": [ { "properties": { "and": { "minItems": 1, "items": { "$ref": "List.Filter.Songs" }, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "minItems": 1, "items": { "$ref": "List.Filter.Songs" }, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.Songs" } ] } |
List.Filter.TVShows
Type: mixed
JSON Schema Description |
---|
{ "id": "List.Filter.TVShows", "type": [ { "properties": { "and": { "minItems": 1, "items": { "$ref": "List.Filter.TVShows" }, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "minItems": 1, "items": { "$ref": "List.Filter.TVShows" }, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.TVShows" } ] } |
List.Item.All
Extends:
Properties:
- [ PVR.Channel.Type channeltype = "tv" ]
- [ string channel = "" ]
- [ string starttime = "" ]
- [ string endtime = "" ]
- [ integer channelnumber = 0 ]
- [ boolean hidden = False ]
- [ boolean locked = False ]
JSON Schema Description |
---|
{ "id": "List.Item.All", "properties": { "channeltype": { "$ref": "PVR.Channel.Type", "default": "tv" }, "channel": { "type": "string", "default": "" }, "starttime": { "type": "string", "default": "" }, "endtime": { "type": "string", "default": "" }, "channelnumber": { "type": "integer", "default": 0 }, "hidden": { "type": "boolean", "default": false }, "locked": { "type": "boolean", "default": false } }, "extends": "List.Item.Base" } |
List.Item.Base
Extends:
Properties:
- [ string sorttitle = "" ]
- [ string productioncode = "" ]
- [ Video.Cast cast ]
- [ string votes = "" ]
- [ integer duration = 0 ]
- [ string trailer = "" ]
- [ Library.Id albumid = -1 ]
- [ string musicbrainzartistid = "" ]
- [ string mpaa = "" ]
- [ string albumlabel = "" ]
- [ string originaltitle = "" ]
- [ Array.String writer ]
- [ Array.Integer albumartistid ]
- [ string type = "unknown" ]
- [ integer episode = 0 ]
- [ string firstaired = "" ]
- [ string showtitle = "" ]
- [ Array.String country ]
- [ Array.String mood ]
- [ string set = "" ]
- [ string musicbrainztrackid = "" ]
- [ Array.String tag ]
- [ string lyrics = "" ]
- [ integer top250 = 0 ]
- [ string comment = "" ]
- [ string premiered = "" ]
- [ Array.String showlink ]
- [ Array.String style ]
- [ string album = "" ]
- [ Library.Id tvshowid = -1 ]
- [ integer season = 0 ]
- [ Array.String theme ]
- [ string description = "" ]
- [ Library.Id setid = -1 ]
- [ integer track = 0 ]
- [ string tagline = "" ]
- [ string plotoutline = "" ]
- [ integer watchedepisodes = 0 ]
- [ Library.Id id = -1 ]
- [ integer disc = 0 ]
- [ Array.String albumartist ]
- [ Array.String studio ]
- [ object uniqueid ]
- [ string episodeguide = "" ]
- [ string imdbnumber = "" ]
JSON Schema Description |
---|
{ "id": "List.Item.Base", "properties": { "sorttitle": { "type": "string", "default": "" }, "productioncode": { "type": "string", "default": "" }, "cast": { "$ref": "Video.Cast" }, "votes": { "type": "string", "default": "" }, "duration": { "type": "integer", "default": 0 }, "trailer": { "type": "string", "default": "" }, "albumid": { "$ref": "Library.Id", "default": -1 }, "musicbrainzartistid": { "type": "string", "default": "" }, "mpaa": { "type": "string", "default": "" }, "albumlabel": { "type": "string", "default": "" }, "originaltitle": { "type": "string", "default": "" }, "writer": { "$ref": "Array.String" }, "albumartistid": { "$ref": "Array.Integer" }, "type": { "enums": [ "unknown", "movie", "episode", "musicvideo", "song", "picture", "channel" ], "type": "string", "default": "unknown" }, "episode": { "type": "integer", "default": 0 }, "firstaired": { "type": "string", "default": "" }, "showtitle": { "type": "string", "default": "" }, "country": { "$ref": "Array.String" }, "mood": { "$ref": "Array.String" }, "set": { "type": "string", "default": "" }, "musicbrainztrackid": { "type": "string", "default": "" }, "tag": { "$ref": "Array.String" }, "lyrics": { "type": "string", "default": "" }, "top250": { "type": "integer", "default": 0 }, "comment": { "type": "string", "default": "" }, "premiered": { "type": "string", "default": "" }, "showlink": { "$ref": "Array.String" }, "style": { "$ref": "Array.String" }, "album": { "type": "string", "default": "" }, "tvshowid": { "$ref": "Library.Id", "default": -1 }, "season": { "type": "integer", "default": 0 }, "theme": { "$ref": "Array.String" }, "description": { "type": "string", "default": "" }, "setid": { "$ref": "Library.Id", "default": -1 }, "track": { "type": "integer", "default": 0 }, "tagline": { "type": "string", "default": "" }, "plotoutline": { "type": "string", "default": "" }, "watchedepisodes": { "type": "integer", "default": 0 }, "id": { "$ref": "Library.Id", "default": -1 }, "disc": { "type": "integer", "default": 0 }, "albumartist": { "$ref": "Array.String" }, "studio": { "$ref": "Array.String" }, "uniqueid": { "additionalProperties": { "minLength": 1, "type": "string", "default": "" }, "type": "object" }, "episodeguide": { "type": "string", "default": "" }, "imdbnumber": { "type": "string", "default": "" } }, "extends": [ "Video.Details.File", "Audio.Details.Media" ] } |
List.Item.File
Extends:
Properties:
- string filetype
- [ integer size = 0 ]
- [ string mimetype = "" ]
- string file
- [ string lastmodified = "" ]
JSON Schema Description |
---|
{ "id": "List.Item.File", "properties": { "filetype": { "enums": [ "file", "directory" ], "required": true, "type": "string" }, "size": { "description": "Size of the file in kB (1000 Byte)", "type": "integer", "default": 0 }, "mimetype": { "type": "string", "default": "" }, "file": { "required": true, "type": "string" }, "lastmodified": { "type": "string", "default": "" } }, "extends": "List.Item.Base" } |
List.Items.Sources
Type: array
JSON Schema Description |
---|
{ "items": { "properties": { "file": { "required": true, "type": "string" } }, "extends": "Item.Details.Base" }, "id": "List.Items.Sources", "type": "array" } |
List.Limits
Type: object
Properties:
- [ List.Amount end = -1 ]
- [ integer start = 0 ]
JSON Schema Description |
---|
{ "additionalProperties": false, "id": "List.Limits", "properties": { "end": { "$ref": "List.Amount", "description": "Index of the last item to return", "default": -1 }, "start": { "minimum": 0, "description": "Index of the first item to return", "type": "integer", "default": 0 } }, "type": "object" } |
List.LimitsReturned
Type: object
Properties:
- [ List.Amount end = -1 ]
- integer total
- [ integer start = 0 ]
JSON Schema Description |
---|
{ "additionalProperties": false, "id": "List.LimitsReturned", "properties": { "end": { "$ref": "List.Amount", "default": -1 }, "total": { "minimum": 0, "required": true, "type": "integer" }, "start": { "minimum": 0, "type": "integer", "default": 0 } }, "type": "object" } |
List.Sort
Type: object
Properties:
- [ string order = "ascending" ]
- [ boolean ignorearticle = False ]
- [ string method = "none" ]
JSON Schema Description |
---|
{ "id": "List.Sort", "properties": { "order": { "enums": [ "ascending", "descending" ], "type": "string", "default": "ascending" }, "ignorearticle": { "type": "boolean", "default": false }, "method": { "enums": [ "none", "label", "date", "size", "file", "path", "drivetype", "title", "track", "time", "artist", "album", "albumtype", "genre", "country", "year", "rating", "votes", "top250", "programcount", "playlist", "episode", "season", "totalepisodes", "watchedepisodes", "tvshowstatus", "tvshowtitle", "sorttitle", "productioncode", "mpaa", "studio", "dateadded", "lastplayed", "playcount", "listeners", "bitrate", "random" ], "type": "string", "default": "none" } }, "type": "object" } |
Media
Media.Artwork
Type: object
Properties:
- [ Global.String.NotEmpty banner = "" ]
- [ Global.String.NotEmpty poster = "" ]
- [ Global.String.NotEmpty fanart = "" ]
- [ Global.String.NotEmpty thumb = "" ]
JSON Schema Description |
---|
{ "additionalProperties": { "$ref": "Global.String.NotEmpty", "default": "" }, "id": "Media.Artwork", "properties": { "banner": { "$ref": "Global.String.NotEmpty", "default": "" }, "poster": { "$ref": "Global.String.NotEmpty", "default": "" }, "fanart": { "$ref": "Global.String.NotEmpty", "default": "" }, "thumb": { "$ref": "Global.String.NotEmpty", "default": "" } }, "type": "object" } |
Media.Details.Base
Extends:
Properties:
- [ string fanart = "" ]
- [ string thumbnail = "" ]
JSON Schema Description |
---|
{ "id": "Media.Details.Base", "properties": { "fanart": { "type": "string", "default": "" }, "thumbnail": { "type": "string", "default": "" } }, "extends": "Item.Details.Base" } |
Notifications
Notifications.Item
Type: mixed
JSON Schema Description |
---|
{ "id": "Notifications.Item", "type": [ { "description": "An unknown item does not have any additional information.", "properties": { "type": { "$ref": "Notifications.Item.Type", "required": true } }, "type": "object" }, { "description": "An item known to the database has an identification.", "properties": { "id": { "$ref": "Library.Id", "required": true }, "type": { "$ref": "Notifications.Item.Type", "required": true } }, "type": "object" }, { "description": "A movie item has a title and may have a release year.", "properties": { "title": { "required": true, "type": "string" }, "type": { "$ref": "Notifications.Item.Type", "required": true }, "year": { "type": "integer", "default": 0 } }, "type": "object" }, { "description": "A tv episode has a title and may have an episode number, season number and the title of the show it belongs to.", "properties": { "showtitle": { "type": "string", "default": "" }, "type": { "$ref": "Notifications.Item.Type", "required": true }, "title": { "required": true, "type": "string" }, "episode": { "type": "integer", "default": 0 }, "season": { "type": "integer", "default": 0 } }, "type": "object" }, { "description": "A music video has a title and may have an album and an artist.", "properties": { "album": { "type": "string", "default": "" }, "artist": { "type": "string", "default": "" }, "type": { "$ref": "Notifications.Item.Type", "required": true }, "title": { "required": true, "type": "string" } }, "type": "object" }, { "description": "A song has a title and may have an album, an artist and a track number.", "properties": { "album": { "type": "string", "default": "" }, "track": { "type": "integer", "default": 0 }, "artist": { "type": "string", "default": "" }, "type": { "$ref": "Notifications.Item.Type", "required": true }, "title": { "required": true, "type": "string" } }, "type": "object" }, { "description": "A picture has a file path.", "properties": { "file": { "required": true, "type": "string" }, "type": { "$ref": "Notifications.Item.Type", "required": true } }, "type": "object" }, { "description": "A PVR channel is either a radio or tv channel and has a title.", "properties": { "channeltype": { "$ref": "PVR.Channel.Type", "required": true }, "id": { "$ref": "Library.Id", "required": true }, "title": { "required": true, "type": "string" }, "type": { "$ref": "Notifications.Item.Type", "required": true } }, "type": "object" } ] } |
Notifications.Item.Type
Type: string
JSON Schema Description |
---|
{ "enums": [ "unknown", "movie", "episode", "musicvideo", "song", "picture", "channel" ], "id": "Notifications.Item.Type", "type": "string", "default": "unknown" } |
Optional
Optional.Boolean
Type: mixed
JSON Schema Description |
---|
{ "id": "Optional.Boolean", "type": [ { "type": "null" }, { "type": "boolean" } ], "default": null } |
Optional.Integer
Type: mixed
JSON Schema Description |
---|
{ "id": "Optional.Integer", "type": [ { "type": "null" }, { "type": "integer" } ], "default": null } |
Optional.Number
Type: mixed
JSON Schema Description |
---|
{ "id": "Optional.Number", "type": [ { "type": "null" }, { "type": "number" } ], "default": null } |
Optional.String
Type: mixed
JSON Schema Description |
---|
{ "id": "Optional.String", "type": [ { "type": "null" }, { "type": "string" } ], "default": null } |
PVR
PVR.Channel.Type
Type: string
JSON Schema Description |
---|
{ "enums": [ "tv", "radio" ], "id": "PVR.Channel.Type", "type": "string", "default": "tv" } |
PVR.ChannelGroup.Id
Type: mixed
JSON Schema Description |
---|
{ "id": "PVR.ChannelGroup.Id", "type": [ { "$ref": "Library.Id" }, { "enums": [ "alltv", "allradio" ], "type": "string" } ], "default": null } |
PVR.Details.Channel
Extends:
Properties:
- [ PVR.Channel.Type channeltype = "tv" ]
- [ string thumbnail = "" ]
- [ string channel = "" ]
- [ boolean hidden = False ]
- Library.Id channelid
- [ boolean locked = False ]
- [ string lastplayed = "" ]
JSON Schema Description |
---|
{ "id": "PVR.Details.Channel", "properties": { "channeltype": { "$ref": "PVR.Channel.Type", "default": "tv" }, "thumbnail": { "type": "string", "default": "" }, "channel": { "type": "string", "default": "" }, "hidden": { "type": "boolean", "default": false }, "channelid": { "$ref": "Library.Id", "required": true }, "locked": { "type": "boolean", "default": false }, "lastplayed": { "type": "string", "default": "" } }, "extends": "Item.Details.Base" } |
PVR.Details.ChannelGroup
Extends:
Properties:
- PVR.Channel.Type channeltype
- Library.Id channelgroupid
JSON Schema Description |
---|
{ "id": "PVR.Details.ChannelGroup", "properties": { "channeltype": { "$ref": "PVR.Channel.Type", "required": true }, "channelgroupid": { "$ref": "Library.Id", "required": true } }, "extends": "Item.Details.Base" } |
PVR.Details.ChannelGroup.Extended
Extends:
Properties:
- List.LimitsReturned limits
- [ PVR.Details.Channel[] channels ]
JSON Schema Description |
---|
{ "id": "PVR.Details.ChannelGroup.Extended", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "channels": { "items": { "$ref": "PVR.Details.Channel" }, "type": "array" } }, "extends": "PVR.Details.ChannelGroup" } |
PVR.Fields.Channel
Extends:
JSON Schema Description |
---|
{ "items": { "enums": [ "thumbnail", "channeltype", "hidden", "locked", "channel", "lastplayed" ], "type": "string" }, "id": "PVR.Fields.Channel", "extends": "Item.Fields.Base" } |
PVR.Property.Name
Type: string
JSON Schema Description |
---|
{ "enums": [ "available", "recording", "scanning" ], "id": "PVR.Property.Name", "type": "string", "default": "available" } |
PVR.Property.Value
Type: object
Properties:
- [ boolean scanning = False ]
- [ boolean recording = False ]
- [ boolean available = False ]
JSON Schema Description |
---|
{ "id": "PVR.Property.Value", "properties": { "scanning": { "type": "boolean", "default": false }, "recording": { "type": "boolean", "default": false }, "available": { "type": "boolean", "default": false } }, "type": "object" } |
Player
Player.Audio.Stream
Type: object
Properties:
- integer index
- string language
- string name
JSON Schema Description |
---|
{ "id": "Player.Audio.Stream", "properties": { "index": { "minimum": 0, "required": true, "type": "integer" }, "language": { "required": true, "type": "string" }, "name": { "required": true, "type": "string" } }, "type": "object" } |
Player.Audio.Stream.Extended
Extends:
Properties:
- integer channels
- string codec
- integer bitrate
JSON Schema Description |
---|
{ "id": "Player.Audio.Stream.Extended", "properties": { "channels": { "required": true, "type": "integer" }, "codec": { "required": true, "type": "string" }, "bitrate": { "required": true, "type": "integer" } }, "extends": "Player.Audio.Stream" } |
Player.Id
Type: integer
JSON Schema Description |
---|
{ "minimum": 0, "id": "Player.Id", "type": "integer", "default": -1, "maximum": 2 } |
Player.Notifications.Data
Type: object
Properties:
- Player.Notifications.Player player
- Notifications.Item item
JSON Schema Description |
---|
{ "id": "Player.Notifications.Data", "properties": { "player": { "$ref": "Player.Notifications.Player", "required": true }, "item": { "$ref": "Notifications.Item", "required": true } }, "type": "object" } |
Player.Notifications.Player
Type: object
Properties:
- [ integer speed = 0 ]
- Player.Id playerid
JSON Schema Description |
---|
{ "id": "Player.Notifications.Player", "properties": { "speed": { "type": "integer", "default": 0 }, "playerid": { "$ref": "Player.Id", "required": true } }, "type": "object" } |
Player.Notifications.Player.Seek
Extends:
Properties:
- [ Global.Time seekoffset ]
- [ Global.Time time ]
JSON Schema Description |
---|
{ "id": "Player.Notifications.Player.Seek", "properties": { "seekoffset": { "$ref": "Global.Time" }, "time": { "$ref": "Global.Time" } }, "extends": "Player.Notifications.Player" } |
Player.Position.Percentage
Type: number
JSON Schema Description |
---|
{ "minimum": 0, "id": "Player.Position.Percentage", "type": "number", "default": 0, "maximum": 100 } |
Player.Position.Time
Type: object
Properties:
- [ integer hours = 0 ]
- [ integer milliseconds = 0 ]
- [ integer seconds = 0 ]
- [ integer minutes = 0 ]
JSON Schema Description |
---|
{ "additionalProperties": false, "id": "Player.Position.Time", "properties": { "hours": { "minimum": 0, "type": "integer", "default": 0, "maximum": 23 }, "milliseconds": { "minimum": 0, "type": "integer", "default": 0, "maximum": 999 }, "seconds": { "minimum": 0, "type": "integer", "default": 0, "maximum": 59 }, "minutes": { "minimum": 0, "type": "integer", "default": 0, "maximum": 59 } }, "type": "object" } |
Player.Property.Name
Type: string
JSON Schema Description |
---|
{ "enums": [ "type", "partymode", "speed", "time", "percentage", "totaltime", "playlistid", "position", "repeat", "shuffled", "canseek", "canchangespeed", "canmove", "canzoom", "canrotate", "canshuffle", "canrepeat", "currentaudiostream", "audiostreams", "subtitleenabled", "currentsubtitle", "subtitles", "live" ], "id": "Player.Property.Name", "type": "string", "default": "type" } |
Player.Property.Value
Type: object
Properties:
- [ boolean canrepeat = False ]
- [ boolean canmove = False ]
- [ boolean canshuffle = False ]
- [ integer speed = 0 ]
- [ Player.Position.Percentage percentage = 0 ]
- [ Playlist.Id playlistid = -1 ]
- [ Player.Audio.Stream[] audiostreams ]
- [ Playlist.Position position = -1 ]
- [ Player.Repeat repeat = "off" ]
- [ Player.Subtitle currentsubtitle ]
- [ boolean canrotate = False ]
- [ boolean canzoom = False ]
- [ boolean canchangespeed = False ]
- [ Player.Type type = "video" ]
- [ boolean partymode = False ]
- [ Player.Subtitle[] subtitles ]
- [ boolean canseek = False ]
- [ Global.Time time ]
- [ Global.Time totaltime ]
- [ boolean shuffled = False ]
- [ Player.Audio.Stream.Extended currentaudiostream ]
- [ boolean live = False ]
- [ boolean subtitleenabled = False ]
JSON Schema Description |
---|
{ "id": "Player.Property.Value", "properties": { "canrepeat": { "type": "boolean", "default": false }, "canmove": { "type": "boolean", "default": false }, "canshuffle": { "type": "boolean", "default": false }, "speed": { "type": "integer", "default": 0 }, "percentage": { "$ref": "Player.Position.Percentage", "default": 0 }, "playlistid": { "$ref": "Playlist.Id", "default": -1 }, "audiostreams": { "items": { "$ref": "Player.Audio.Stream" }, "type": "array" }, "position": { "$ref": "Playlist.Position", "default": -1 }, "repeat": { "$ref": "Player.Repeat", "default": "off" }, "currentsubtitle": { "$ref": "Player.Subtitle" }, "canrotate": { "type": "boolean", "default": false }, "canzoom": { "type": "boolean", "default": false }, "canchangespeed": { "type": "boolean", "default": false }, "type": { "$ref": "Player.Type", "default": "video" }, "partymode": { "type": "boolean", "default": false }, "subtitles": { "items": { "$ref": "Player.Subtitle" }, "type": "array" }, "canseek": { "type": "boolean", "default": false }, "time": { "$ref": "Global.Time" }, "totaltime": { "$ref": "Global.Time" }, "shuffled": { "type": "boolean", "default": false }, "currentaudiostream": { "$ref": "Player.Audio.Stream.Extended" }, "live": { "type": "boolean", "default": false }, "subtitleenabled": { "type": "boolean", "default": false } }, "type": "object" } |
Player.Repeat
Type: string
JSON Schema Description |
---|
{ "enums": [ "off", "one", "all" ], "id": "Player.Repeat", "type": "string", "default": "off" } |
Player.Speed
Type: object
Properties:
- [ integer speed = 0 ]
JSON Schema Description |
---|
{ "id": "Player.Speed", "properties": { "speed": { "type": "integer", "default": 0 } }, "required": true, "type": "object" } |
Player.Subtitle
Type: object
Properties:
- integer index
- string language
- string name
JSON Schema Description |
---|
{ "id": "Player.Subtitle", "properties": { "index": { "minimum": 0, "required": true, "type": "integer" }, "language": { "required": true, "type": "string" }, "name": { "required": true, "type": "string" } }, "type": "object" } |
Player.Type
Type: string
JSON Schema Description |
---|
{ "enums": [ "video", "audio", "picture" ], "id": "Player.Type", "type": "string", "default": "video" } |
Playlist
Playlist.Id
Type: integer
JSON Schema Description |
---|
{ "minimum": 0, "id": "Playlist.Id", "type": "integer", "default": -1, "maximum": 2 } |
Playlist.Item
Type: mixed
JSON Schema Description |
---|
{ "id": "Playlist.Item", "type": [ { "additionalProperties": false, "properties": { "file": { "description": "Path to a file (not a directory) to be added to the playlist", "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "directory": { "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "movieid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "episodeid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "musicvideoid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "albumid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "songid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "description": "Identification of a genre from the AudioLibrary", "required": true } }, "type": "object" } ] } |
Playlist.Position
Type: integer
JSON Schema Description |
---|
{ "minimum": 0, "id": "Playlist.Position", "type": "integer", "default": -1 } |
Playlist.Property.Name
Type: string
JSON Schema Description |
---|
{ "enums": [ "type", "size" ], "id": "Playlist.Property.Name", "type": "string", "default": "type" } |
Playlist.Property.Value
Type: object
Properties:
- [ integer size = 0 ]
- [ Playlist.Type type = "unknown" ]
JSON Schema Description |
---|
{ "id": "Playlist.Property.Value", "properties": { "size": { "minimum": 0, "type": "integer", "default": 0 }, "type": { "$ref": "Playlist.Type", "default": "unknown" } }, "type": "object" } |
Playlist.Type
Type: string
JSON Schema Description |
---|
{ "enums": [ "unknown", "video", "audio", "picture", "mixed" ], "id": "Playlist.Type", "type": "string", "default": "unknown" } |
System
System.Property.Name
Type: string
JSON Schema Description |
---|
{ "enums": [ "canshutdown", "cansuspend", "canhibernate", "canreboot" ], "id": "System.Property.Name", "type": "string", "default": "canshutdown" } |
System.Property.Value
Type: object
Properties:
- [ boolean canshutdown = False ]
- [ boolean canhibernate = False ]
- [ boolean cansuspend = False ]
- [ boolean canreboot = False ]
JSON Schema Description |
---|
{ "id": "System.Property.Value", "properties": { "canshutdown": { "type": "boolean", "default": false }, "canhibernate": { "type": "boolean", "default": false }, "cansuspend": { "type": "boolean", "default": false }, "canreboot": { "type": "boolean", "default": false } }, "type": "object" } |
Video
Video.Cast
Type: array
JSON Schema Description |
---|
{ "items": { "additionalProperties": false, "properties": { "thumbnail": { "type": "string", "default": "" }, "name": { "required": true, "type": "string" }, "role": { "required": true, "type": "string" } }, "type": "object" }, "id": "Video.Cast", "type": "array" } |
Video.Details.Base
Extends:
Properties:
- [ Media.Artwork art ]
- [ integer playcount = 0 ]
JSON Schema Description |
---|
{ "id": "Video.Details.Base", "properties": { "art": { "$ref": "Media.Artwork" }, "playcount": { "type": "integer", "default": 0 } }, "extends": "Media.Details.Base" } |
Video.Details.Episode
Extends:
Properties:
- [ Video.Cast cast ]
- [ string productioncode = "" ]
- [ number rating = 0 ]
- [ string votes = "" ]
- [ integer episode = 0 ]
- [ string showtitle = "" ]
- Library.Id episodeid
- [ Library.Id tvshowid = -1 ]
- [ integer season = 0 ]
- [ string firstaired = "" ]
- [ object uniqueid ]
- [ Array.String writer ]
- [ string originaltitle = "" ]
JSON Schema Description |
---|
{ "id": "Video.Details.Episode", "properties": { "cast": { "$ref": "Video.Cast" }, "productioncode": { "type": "string", "default": "" }, "rating": { "type": "number", "default": 0 }, "votes": { "type": "string", "default": "" }, "episode": { "type": "integer", "default": 0 }, "showtitle": { "type": "string", "default": "" }, "episodeid": { "$ref": "Library.Id", "required": true }, "tvshowid": { "$ref": "Library.Id", "default": -1 }, "season": { "type": "integer", "default": 0 }, "firstaired": { "type": "string", "default": "" }, "uniqueid": { "additionalProperties": { "minLength": 1, "type": "string", "default": "" }, "type": "object" }, "writer": { "$ref": "Array.String" }, "originaltitle": { "type": "string", "default": "" } }, "extends": "Video.Details.File" } |
Video.Details.File
Extends:
Properties:
- [ Video.Streams streamdetails ]
- [ Array.String director ]
- [ Video.Resume resume ]
- [ integer runtime = 0 ]
JSON Schema Description |
---|
{ "id": "Video.Details.File", "properties": { "streamdetails": { "$ref": "Video.Streams" }, "director": { "$ref": "Array.String" }, "resume": { "$ref": "Video.Resume" }, "runtime": { "description": "Runtime in seconds", "type": "integer", "default": 0 } }, "extends": "Video.Details.Item" } |
Video.Details.Item
Extends:
Properties:
- [ string dateadded = "" ]
- [ string file = "" ]
- [ string lastplayed = "" ]
- [ string plot = "" ]
JSON Schema Description |
---|
{ "id": "Video.Details.Item", "properties": { "dateadded": { "type": "string", "default": "" }, "file": { "type": "string", "default": "" }, "lastplayed": { "type": "string", "default": "" }, "plot": { "type": "string", "default": "" } }, "extends": "Video.Details.Media" } |
Video.Details.Media
Extends:
Properties:
- [ string title = "" ]
JSON Schema Description |
---|
{ "id": "Video.Details.Media", "properties": { "title": { "type": "string", "default": "" } }, "extends": "Video.Details.Base" } |
Video.Details.Movie
Extends:
Properties:
- [ string plotoutline = "" ]
- [ string sorttitle = "" ]
- Library.Id movieid
- [ Video.Cast cast ]
- [ string votes = "" ]
- [ Array.String showlink ]
- [ integer top250 = 0 ]
- [ string trailer = "" ]
- [ integer year = 0 ]
- [ Array.String country ]
- [ Array.String studio ]
- [ string set = "" ]
- [ Array.String genre ]
- [ string mpaa = "" ]
- [ Library.Id setid = -1 ]
- [ number rating = 0 ]
- [ Array.String tag ]
- [ string tagline = "" ]
- [ Array.String writer ]
- [ string originaltitle = "" ]
- [ string imdbnumber = "" ]
JSON Schema Description |
---|
{ "id": "Video.Details.Movie", "properties": { "plotoutline": { "type": "string", "default": "" }, "sorttitle": { "type": "string", "default": "" }, "movieid": { "$ref": "Library.Id", "required": true }, "cast": { "$ref": "Video.Cast" }, "votes": { "type": "string", "default": "" }, "showlink": { "$ref": "Array.String" }, "top250": { "type": "integer", "default": 0 }, "trailer": { "type": "string", "default": "" }, "year": { "type": "integer", "default": 0 }, "country": { "$ref": "Array.String" }, "studio": { "$ref": "Array.String" }, "set": { "type": "string", "default": "" }, "genre": { "$ref": "Array.String" }, "mpaa": { "type": "string", "default": "" }, "setid": { "$ref": "Library.Id", "default": -1 }, "rating": { "type": "number", "default": 0 }, "tag": { "$ref": "Array.String" }, "tagline": { "type": "string", "default": "" }, "writer": { "$ref": "Array.String" }, "originaltitle": { "type": "string", "default": "" }, "imdbnumber": { "type": "string", "default": "" } }, "extends": "Video.Details.File" } |
Video.Details.MovieSet
Extends:
Properties:
- Library.Id setid
JSON Schema Description |
---|
{ "id": "Video.Details.MovieSet", "properties": { "setid": { "$ref": "Library.Id", "required": true } }, "extends": "Video.Details.Media" } |
Video.Details.MovieSet.Extended
Extends:
Properties:
- List.LimitsReturned limits
- [ Video.Details.Movie[] movies ]
JSON Schema Description |
---|
{ "id": "Video.Details.MovieSet.Extended", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "movies": { "items": { "$ref": "Video.Details.Movie" }, "type": "array" } }, "extends": "Video.Details.MovieSet" } |
Video.Details.MusicVideo
Extends:
Properties:
- [ Array.String genre ]
- [ Array.String artist ]
- Library.Id musicvideoid
- [ Array.String tag ]
- [ string album = "" ]
- [ integer track = 0 ]
- [ Array.String studio ]
- [ integer year = 0 ]
JSON Schema Description |
---|
{ "id": "Video.Details.MusicVideo", "properties": { "genre": { "$ref": "Array.String" }, "artist": { "$ref": "Array.String" }, "musicvideoid": { "$ref": "Library.Id", "required": true }, "tag": { "$ref": "Array.String" }, "album": { "type": "string", "default": "" }, "track": { "type": "integer", "default": 0 }, "studio": { "$ref": "Array.String" }, "year": { "type": "integer", "default": 0 } }, "extends": "Video.Details.File" } |
Video.Details.Season
Extends:
Properties:
- [ string showtitle = "" ]
- [ integer watchedepisodes = 0 ]
- [ Library.Id tvshowid = -1 ]
- [ integer episode = 0 ]
- integer season
JSON Schema Description |
---|
{ "id": "Video.Details.Season", "properties": { "showtitle": { "type": "string", "default": "" }, "watchedepisodes": { "type": "integer", "default": 0 }, "tvshowid": { "$ref": "Library.Id", "default": -1 }, "episode": { "type": "integer", "default": 0 }, "season": { "required": true, "type": "integer" } }, "extends": "Video.Details.Base" } |
Video.Details.TVShow
Extends:
Properties:
- [ string sorttitle = "" ]
- [ string mpaa = "" ]
- [ string premiered = "" ]
- [ integer year = 0 ]
- [ integer episode = 0 ]
- [ integer watchedepisodes = 0 ]
- [ string votes = "" ]
- [ number rating = 0 ]
- Library.Id tvshowid
- [ Array.String studio ]
- [ integer season = 0 ]
- [ Array.String genre ]
- [ Video.Cast cast ]
- [ string episodeguide = "" ]
- [ Array.String tag ]
- [ string originaltitle = "" ]
- [ string imdbnumber = "" ]
JSON Schema Description |
---|
{ "id": "Video.Details.TVShow", "properties": { "sorttitle": { "type": "string", "default": "" }, "mpaa": { "type": "string", "default": "" }, "premiered": { "type": "string", "default": "" }, "year": { "type": "integer", "default": 0 }, "episode": { "type": "integer", "default": 0 }, "watchedepisodes": { "type": "integer", "default": 0 }, "votes": { "type": "string", "default": "" }, "rating": { "type": "number", "default": 0 }, "tvshowid": { "$ref": "Library.Id", "required": true }, "studio": { "$ref": "Array.String" }, "season": { "type": "integer", "default": 0 }, "genre": { "$ref": "Array.String" }, "cast": { "$ref": "Video.Cast" }, "episodeguide": { "type": "string", "default": "" }, "tag": { "$ref": "Array.String" }, "originaltitle": { "type": "string", "default": "" }, "imdbnumber": { "type": "string", "default": "" } }, "extends": "Video.Details.Item" } |
Video.Fields.Episode
Extends:
JSON Schema Description |
---|
{ "items": { "enums": [ "title", "plot", "votes", "rating", "writer", "firstaired", "playcount", "runtime", "director", "productioncode", "season", "episode", "originaltitle", "showtitle", "cast", "streamdetails", "lastplayed", "fanart", "thumbnail", "file", "resume", "tvshowid", "dateadded", "uniqueid", "art" ], "description": "Requesting the cast field will result in increased response times", "type": "string" }, "id": "Video.Fields.Episode", "extends": "Item.Fields.Base" } |
Video.Fields.Movie
Extends:
JSON Schema Description |
---|
{ "items": { "enums": [ "title", "genre", "year", "rating", "director", "trailer", "tagline", "plot", "plotoutline", "originaltitle", "lastplayed", "playcount", "writer", "studio", "mpaa", "cast", "country", "imdbnumber", "runtime", "set", "showlink", "streamdetails", "top250", "votes", "fanart", "thumbnail", "file", "sorttitle", "resume", "setid", "dateadded", "tag", "art" ], "description": "Requesting the cast, showlink and/or tag field will result in increased response times", "type": "string" }, "id": "Video.Fields.Movie", "extends": "Item.Fields.Base" } |
Video.Fields.MovieSet
Extends:
JSON Schema Description |
---|
{ "items": { "enums": [ "title", "playcount", "fanart", "thumbnail", "art" ], "type": "string" }, "id": "Video.Fields.MovieSet", "extends": "Item.Fields.Base" } |
Video.Fields.MusicVideo
Extends:
JSON Schema Description |
---|
{ "items": { "enums": [ "title", "playcount", "runtime", "director", "studio", "year", "plot", "album", "artist", "genre", "track", "streamdetails", "lastplayed", "fanart", "thumbnail", "file", "resume", "dateadded", "tag", "art" ], "type": "string" }, "id": "Video.Fields.MusicVideo", "extends": "Item.Fields.Base" } |
Video.Fields.Season
Extends:
JSON Schema Description |
---|
{ "items": { "enums": [ "season", "showtitle", "playcount", "episode", "fanart", "thumbnail", "tvshowid", "watchedepisodes", "art" ], "type": "string" }, "id": "Video.Fields.Season", "extends": "Item.Fields.Base" } |
Video.Fields.TVShow
Extends:
JSON Schema Description |
---|
{ "items": { "enums": [ "title", "genre", "year", "rating", "plot", "studio", "mpaa", "cast", "playcount", "episode", "imdbnumber", "premiered", "votes", "lastplayed", "fanart", "thumbnail", "file", "originaltitle", "sorttitle", "episodeguide", "season", "watchedepisodes", "dateadded", "tag", "art" ], "description": "Requesting the cast field will result in increased response times", "type": "string" }, "id": "Video.Fields.TVShow", "extends": "Item.Fields.Base" } |
Video.Resume
Type: object
Properties:
- [ number position = 0 ]
- [ number total = 0 ]
JSON Schema Description |
---|
{ "additionalProperties": false, "id": "Video.Resume", "properties": { "position": { "minimum": 0, "type": "number", "default": 0 }, "total": { "minimum": 0, "type": "number", "default": 0 } }, "type": "object" } |
Video.Streams
Type: object
Properties:
- [ array[1..X] video ]
- [ array[1..X] audio ]
- [ array[1..X] subtitle ]
JSON Schema Description |
---|
{ "additionalProperties": false, "id": "Video.Streams", "properties": { "video": { "minItems": 1, "items": { "additionalProperties": false, "properties": { "height": { "type": "integer", "default": 0 }, "width": { "type": "integer", "default": 0 }, "aspect": { "type": "number", "default": 0 }, "codec": { "type": "string", "default": "" }, "duration": { "type": "integer", "default": 0 } }, "type": "object" }, "type": "array" }, "audio": { "minItems": 1, "items": { "additionalProperties": false, "properties": { "channels": { "type": "integer", "default": 0 }, "language": { "type": "string", "default": "" }, "codec": { "type": "string", "default": "" } }, "type": "object" }, "type": "array" }, "subtitle": { "minItems": 1, "items": { "additionalProperties": false, "properties": { "language": { "type": "string", "default": "" } }, "type": "object" }, "type": "array" } }, "type": "object" } |
Notifications
Application
Application.OnVolumeChanged
The volume of the application has changed.
Parameters:
- string sender
- object data
Properties:
- integer volume
- boolean muted
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "volume": { "minimum": 0, "required": true, "type": "integer", "maximum": 100 }, "muted": { "required": true, "type": "boolean" } }, "required": true, "type": "object" } ], "description": "The volume of the application has changed." } |
AudioLibrary
AudioLibrary.OnCleanFinished
The audio library has been cleaned.
Parameters:
- string sender
- null data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "description": "The audio library has been cleaned." } |
AudioLibrary.OnCleanStarted
An audio library clean operation has started.
Parameters:
- string sender
- null data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "description": "An audio library clean operation has started." } |
AudioLibrary.OnRemove
An audio item has been removed.
Parameters:
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "id": { "$ref": "Library.Id", "required": true }, "type": { "$ref": "Notifications.Library.Audio.Type", "required": true } }, "required": true, "type": "object" } ], "description": "An audio item has been removed." } |
AudioLibrary.OnScanFinished
Scanning the audio library has been finished.
Parameters:
- string sender
- null data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "description": "Scanning the audio library has been finished." } |
AudioLibrary.OnScanStarted
An audio library scan has started.
Parameters:
- string sender
- null data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "description": "An audio library scan has started." } |
AudioLibrary.OnUpdate
An audio item has been updated.
Parameters:
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "id": { "$ref": "Library.Id", "required": true }, "type": { "enum": [ "song" ], "id": "Notifications.Library.Audio.Type", "required": true, "type": "string" } }, "required": true, "type": "object" } ], "description": "An audio item has been updated." } |
Input
Input.OnInputFinished
The user has provided the requested input.
Parameters:
- string sender
- null data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "description": "The user has provided the requested input." } |
Input.OnInputRequested
The user is requested to provide some information.
Parameters:
- string sender
- object data
Properties:
- string value
- [ string title ]
- string type
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "value": { "required": true, "type": "string" }, "title": { "type": "string" }, "type": { "enum": [ "keyboard", "time", "date", "ip", "password", "numericpassword", "number", "seconds" ], "required": true, "type": "string" } }, "required": true, "type": "object" } ], "description": "The user is requested to provide some information." } |
Player
Player.OnPause
Playback of a media item has been paused. If there is no ID available extra information will be provided.
Parameters:
- string sender
- Player.Notifications.Data data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "$ref": "Player.Notifications.Data", "name": "data", "required": true } ], "description": "Playback of a media item has been paused. If there is no ID available extra information will be provided." } |
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.
Parameters:
- string sender
- Player.Notifications.Data data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "$ref": "Player.Notifications.Data", "name": "data", "required": true } ], "description": "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." } |
Player.OnPropertyChanged
A property of the playing items has changed.
Parameters:
- string sender
- object data
Properties:
- [ Player.Property.Value property ]
- Player.Notifications.Player player
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "property": { "$ref": "Player.Property.Value" }, "player": { "$ref": "Player.Notifications.Player", "required": true } }, "required": true, "type": "object" } ], "description": "A property of the playing items has changed." } |
Player.OnSeek
The playback position has been changed. If there is no ID available extra information will be provided.
Parameters:
- string sender
- object data
Properties:
- Player.Notifications.Player.Seek player
- [ Notifications.Item item ]
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "player": { "$ref": "Player.Notifications.Player.Seek", "required": true }, "item": { "$ref": "Notifications.Item" } }, "required": true, "type": "object" } ], "description": "The playback position has been changed. If there is no ID available extra information will be provided." } |
Player.OnSpeedChanged
Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.
Parameters:
- string sender
- Player.Notifications.Data data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "$ref": "Player.Notifications.Data", "name": "data", "required": true } ], "description": "Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided." } |
Player.OnStop
Playback of a media item has been stopped. If there is no ID available extra information will be provided.
Parameters:
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "end": { "description": "Whether the player has reached the end of the playable item(s) or not", "required": true, "type": "boolean" }, "item": { "$ref": "Notifications.Item" } }, "required": true, "type": "object" } ], "description": "Playback of a media item has been stopped. If there is no ID available extra information will be provided." } |
Playlist
Playlist.OnAdd
A playlist item has been added.
Parameters:
- string sender
- object data
Properties:
- [ Playlist.Position position ]
- [ Notifications.Item item ]
- Playlist.Id playlistid
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "position": { "$ref": "Playlist.Position" }, "item": { "$ref": "Notifications.Item" }, "playlistid": { "$ref": "Playlist.Id", "required": true } }, "required": true, "type": "object" } ], "description": "A playlist item has been added." } |
Playlist.OnClear
A playlist item has been cleared.
Parameters:
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "playlistid": { "$ref": "Playlist.Id", "required": true } }, "required": true, "type": "object" } ], "description": "A playlist item has been cleared." } |
Playlist.OnRemove
A playlist item has been removed.
Parameters:
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "position": { "$ref": "Playlist.Position" }, "playlistid": { "$ref": "Playlist.Id", "required": true } }, "required": true, "type": "object" } ], "description": "A playlist item has been removed." } |
System
System.OnLowBattery
The system is on low battery.
Parameters:
- string sender
- null data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "description": "The system is on low battery." } |
System.OnQuit
XBMC will be closed.
Parameters:
- string sender
- null data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "description": "XBMC will be closed." } |
System.OnRestart
The system will be restarted.
Parameters:
- string sender
- null data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "description": "The system will be restarted." } |
System.OnSleep
The system will be suspended.
Parameters:
- string sender
- null data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "description": "The system will be suspended." } |
System.OnWake
The system woke up from suspension.
Parameters:
- string sender
- null data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "description": "The system woke up from suspension." } |
VideoLibrary
VideoLibrary.OnCleanFinished
The video library has been cleaned.
Parameters:
- string sender
- null data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "description": "The video library has been cleaned." } |
VideoLibrary.OnCleanStarted
A video library clean operation has started.
Parameters:
- string sender
- null data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "description": "A video library clean operation has started." } |
VideoLibrary.OnRemove
A video item has been removed.
Parameters:
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "id": { "$ref": "Library.Id", "required": true }, "type": { "$ref": "Notifications.Library.Video.Type", "required": true } }, "required": true, "type": "object" } ], "description": "A video item has been removed." } |
VideoLibrary.OnScanFinished
Scanning the video library has been finished.
Parameters:
- string sender
- null data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "description": "Scanning the video library has been finished." } |
VideoLibrary.OnScanStarted
A video library scan has started.
Parameters:
- string sender
- null data
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "description": "A video library scan has started." } |
VideoLibrary.OnUpdate
A video item has been updated.
Parameters:
JSON Schema Description |
---|
{ "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "id": { "$ref": "Library.Id", "required": true }, "playcount": { "minimum": 0, "type": "integer", "default": -1 }, "type": { "enum": [ "movie", "tvshow", "episode", "musicvideo" ], "id": "Notifications.Library.Video.Type", "required": true, "type": "string" } }, "required": true, "type": "object" } ], "description": "A video item has been updated." } |