Archive:JSON-RPC API/v9

Development

JSON-RPC API

v9

{{JSON-RPC API nav}

Version 8 is a stable version of Kodi's JSON-RPC API and is published with the release of v17 (Krypton).

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 Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.

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 Kodi 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 Kodi JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:

Addons List, enable and execute addons Application Application information and control AudioLibrary Audio Library information Favourites Favourites GetFavourites and AddFavourite Files Shares information & filesystem listings GUI Window properties and activation Input Allows limited navigation within Kodi JSONRPC A variety of standard JSONRPC calls Player Manages all available players Playlist Playlist modification Profiles Support for Profiles operations to xbmc. PVR Live TV control Settings Allows manipulation of Kodi settings. System System controls and information Textures Supplies GetTextures and RemoveTexture. Textures are images. VideoLibrary Video Library information XBMC Dumping ground for very Kodi specific operations

Methods

Addons

Addons.ExecuteAddon

Executes the given addon with the given parameters (if possible)
Permissions:

• ExecuteAddon

Parameters:

1. string addonid
2. [ mixed: object|array|string params ]
3. [ boolean wait = false ]

Returns:

Type: string

JSON Schema Description

{ "description": "Executes the given addon with the given parameters (if possible)", "permission": "ExecuteAddon", "type": "method", "params": [ { "type": "string", "name": "addonid", "required": true }, { "default": "", "type": [ { "additionalProperties": { "default": "", "type": "string" }, "type": "object" }, { "items": { "type": "string" }, "type": "array" }, { "description": "URL path (must start with / or ?", "type": "string" } ], "name": "params" }, { "default": "false", "type": "boolean", "name": "wait" } ], "returns": { "type": "string" } }

Addons.GetAddonDetails

Gets the details of a specific addon
Permissions:

• ReadData

Parameters:

1. string addonid
2. [ Addon.Fields properties ]

Returns:

Type: object
Properties:

• Addon.Details addon
• List.LimitsReturned limits

JSON Schema Description
{ "description": "Gets the details of a specific addon", "permission": "ReadData", "type": "method", "params": [ { "type": "string", "name": "addonid", "required": true }, { "$ref": "Addon.Fields", "name": "properties" } ], "returns": { "type": "object", "properties": { "addon": { "$ref": "Addon.Details", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

Addons.GetAddons

Gets all available addons
Permissions:

• ReadData

Parameters:

1. [ Addon.Types type = "unknown" ]
2. [ Addon.Content content = "unknown" ] Content provided by the addon. Only considered for plugins and scripts.
3. [ mixed: boolean|string enabled = "all" ]
4. [ Addon.Fields properties ]
5. [ List.Limits limits ]
6. [ mixed: boolean|string installed = true ]

Returns:

Type: object
Properties:

• [ Addon.Details[] addons ]
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Gets all available addons", "permission": "ReadData", "type": "method", "params": [ { "default": "unknown", "$ref": "Addon.Types", "name": "type" }, { "default": "unknown", "description": "Content provided by the addon. Only considered for plugins and scripts.", "$ref": "Addon.Content", "name": "content" }, { "default": "all", "type": [ { "type": "boolean" }, { "enums": [ "all" ], "type": "string" } ], "name": "enabled" }, { "$ref": "Addon.Fields", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "default": "true", "type": [ { "type": "boolean" }, { "enums": [ "all" ], "type": "string" } ], "name": "installed" } ], "returns": { "type": "object", "properties": { "addons": { "items": { "$ref": "Addon.Details" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

Addons.SetAddonEnabled

Enables/Disables a specific addon
Permissions:

• ManageAddon

Parameters:

1. string addonid
2. Global.Toggle enabled

Returns:

Type: string

JSON Schema Description
{ "description": "Enables/Disables a specific addon", "permission": "ManageAddon", "type": "method", "params": [ { "type": "string", "name": "addonid", "required": true }, { "$ref": "Global.Toggle", "name": "enabled", "required": true } ], "returns": { "type": "string" } }

Application

Application.GetProperties

Retrieves the values of the given properties
Permissions:

• ReadData

Parameters:

1. Application.Property.Name[] properties

Returns:

Type: Application.Property.Value

JSON Schema Description
{ "description": "Retrieves the values of the given properties", "permission": "ReadData", "type": "method", "params": [ { "items": { "$ref": "Application.Property.Name" }, "type": "array", "name": "properties", "required": true } ], "returns": { "$ref": "Application.Property.Value" } }

Application.Quit

Quit application
Permissions:

• ControlPower

Returns:

Type: string

JSON Schema Description
{ "description": "Quit application", "permission": "ControlPower", "type": "method", "params": [], "returns": { "type": "string" } }

Application.SetMute

Toggle mute/unmute
Permissions:

• ControlPlayback

Parameters:

1. Global.Toggle mute

Returns:

Type: boolean

Description: Mute state

JSON Schema Description
{ "description": "Toggle mute/unmute", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Global.Toggle", "name": "mute", "required": true } ], "returns": { "type": "boolean", "description": "Mute state" } }

Application.SetVolume

Set the current volume
Permissions:

• ControlPlayback

Parameters:

1. mixed volume

Returns:

Type: integer

JSON Schema Description
{ "description": "Set the current volume", "permission": "ControlPlayback", "type": "method", "params": [ { "type": [ { "maximum": 100, "minimum": 0, "type": "integer" }, { "$ref": "Global.IncrementDecrement" } ], "name": "volume", "required": true } ], "returns": { "type": "integer" } }

AudioLibrary

AudioLibrary.Clean

Cleans the audio library from non-existent items
Permissions:

• RemoveData

Parameters:

1. [ boolean showdialogs = true ] Whether or not to show the progress bar or any other GUI dialog

Returns:

Type: string

JSON Schema Description
{ "description": "Cleans the audio library from non-existent items", "permission": "RemoveData", "type": "method", "params": [ { "default": "true", "description": "Whether or not to show the progress bar or any other GUI dialog", "type": "boolean", "name": "showdialogs" } ], "returns": { "type": "string" } }

AudioLibrary.Export

Exports all items from the audio library
Permissions:

• WriteFile

Parameters:

1. [ mixed: object|object options ]

Returns:

Type: string

JSON Schema Description

{ "description": "Exports all items from the audio library", "permission": "WriteFile", "type": "method", "params": [ { "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": { "images": { "default": false, "description": "Whether to export thumbnails and fanart images", "type": "boolean" }, "overwrite": { "default": false, "description": "Whether to overwrite existing exported files", "type": "boolean" } }, "type": "object" } ], "name": "options" } ], "returns": { "type": "string" } }

AudioLibrary.GetAlbumDetails

Retrieve details about a specific album
Permissions:

• ReadData

Parameters:

1. Library.Id albumid
2. [ Audio.Fields.Album properties ]

Returns:

Type: object
Properties:

• [ Audio.Details.Album albumdetails ]

JSON Schema Description
{ "description": "Retrieve details about a specific album", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "albumid", "required": true }, { "$ref": "Audio.Fields.Album", "name": "properties" } ], "returns": { "type": "object", "properties": { "albumdetails": { "$ref": "Audio.Details.Album" } } } }

AudioLibrary.GetAlbums

Retrieve all albums from specified artist (and role) or that has songs of the specified genre
Permissions:

• ReadData

Parameters:

1. [ Audio.Fields.Album properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]
4. [ mixed filter ]
5. [ boolean includesingles = false ]
6. [ boolean allroles = false ] Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.

Returns:

Type: object
Properties:

• [ Audio.Details.Album[] albums ]
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve all albums from specified artist (and role) or that has songs of the specified genre", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Audio.Fields.Album", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "type": [ { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "description": "Song genre. Filter for existance of songs with this genre", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "description": "Song genre. Filter for existance of songs with this genre", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true }, "roleid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true }, "role": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" }, "roleid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" }, "role": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "$ref": "List.Filter.Albums" } ], "name": "filter" }, { "default": "false", "type": "boolean", "name": "includesingles" }, { "default": "false", "description": "Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.", "type": "boolean", "name": "allroles" } ], "returns": { "type": "object", "properties": { "albums": { "items": { "$ref": "Audio.Details.Album" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

AudioLibrary.GetArtistDetails

Retrieve details about a specific artist
Permissions:

• ReadData

Parameters:

1. Library.Id artistid
2. [ Audio.Fields.Artist properties ]

Returns:

Type: object
Properties:

• [ Audio.Details.Artist artistdetails ]

JSON Schema Description
{ "description": "Retrieve details about a specific artist", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "artistid", "required": true }, { "$ref": "Audio.Fields.Artist", "name": "properties" } ], "returns": { "type": "object", "properties": { "artistdetails": { "$ref": "Audio.Details.Artist" } } } }

AudioLibrary.GetArtists

Retrieve all artists. For backward compatibility by default this implicity does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true
Permissions:

• ReadData

Parameters:

1. [ Optional.Boolean albumartistsonly ] Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used
2. [ Audio.Fields.Artist properties ]
3. [ List.Limits limits ]
4. [ List.Sort sort ]
5. [ mixed filter ]
6. [ boolean allroles = false ] Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.

Returns:

Type: object
Properties:

• [ Audio.Details.Artist[] artists ]
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve all artists. For backward compatibility by default this implicity does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true", "permission": "ReadData", "type": "method", "params": [ { "description": "Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used", "$ref": "Optional.Boolean", "name": "albumartistsonly" }, { "$ref": "Audio.Fields.Artist", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "type": [ { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "description": "Deprecated, use songgenreid. Filter for existance of songs with this genre", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "songgenreid": { "$ref": "Library.Id", "description": "Song genreid. Filter for existance of songs with this genre", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "roleid": { "$ref": "Library.Id", "required": true }, "songgenreid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "role": { "minLength": 1, "required": true, "type": "string" }, "songgenreid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "description": "Deprecated, use songgenre. Filter for existance of songs with this genre", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "songgenre": { "description": "Song genre. Filter for existance of songs with this genre", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "roleid": { "$ref": "Library.Id", "required": true }, "songgenre": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "role": { "minLength": 1, "required": true, "type": "string" }, "songgenre": { "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" }, { "additionalProperties": false, "properties": { "roleid": { "$ref": "Library.Id", "required": true }, "songid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "role": { "minLength": 1, "required": true, "type": "string" }, "songid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "roleid": { "$ref": "Library.Id", "description": "Role contributed by artist. Overriden by allroles parameter", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "role": { "description": "Role contributed by artist. Overriden by allroles parameter", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "$ref": "List.Filter.Artists" } ], "name": "filter" }, { "default": "false", "description": "Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.", "type": "boolean", "name": "allroles" } ], "returns": { "type": "object", "properties": { "artists": { "items": { "$ref": "Audio.Details.Artist" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

AudioLibrary.GetGenres

Retrieve all genres
Permissions:

• ReadData

Parameters:

1. [ Library.Fields.Genre properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]

Returns:

Type: object
Properties:

• Library.Details.Genre[] genres
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve all genres", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Library.Fields.Genre", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "genres": { "items": { "$ref": "Library.Details.Genre" }, "type": "array", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

AudioLibrary.GetProperties

Retrieves the values of the music library properties
Permissions:

• ReadData

Parameters:

1. Audio.Property.Name[] properties

Returns:

Type: Audio.Property.Value

JSON Schema Description
{ "description": "Retrieves the values of the music library properties", "permission": "ReadData", "type": "method", "params": [ { "items": { "$ref": "Audio.Property.Name" }, "type": "array", "name": "properties", "required": true } ], "returns": { "$ref": "Audio.Property.Value" } }

AudioLibrary.GetRecentlyAddedAlbums

Retrieve recently added albums
Permissions:

• ReadData

Parameters:

1. [ Audio.Fields.Album properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]

Returns:

Type: object
Properties:

• [ Audio.Details.Album[] albums ]
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve recently added albums", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Audio.Fields.Album", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "albums": { "items": { "$ref": "Audio.Details.Album" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

AudioLibrary.GetRecentlyAddedSongs

Retrieve recently added songs
Permissions:

• ReadData

Parameters:

1. [ List.Amount albumlimit = "-1" ] The amount of recently added albums from which to return the songs
2. [ Audio.Fields.Song properties ]
3. [ List.Limits limits ]
4. [ List.Sort sort ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Audio.Details.Song[] songs ]

JSON Schema Description

{ "description": "Retrieve recently added songs", "permission": "ReadData", "type": "method", "params": [ { "default": "-1", "description": "The amount of recently added albums from which to return the songs", "$ref": "List.Amount", "name": "albumlimit" }, { "$ref": "Audio.Fields.Song", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "songs": { "items": { "$ref": "Audio.Details.Song" }, "type": "array" } } } }

AudioLibrary.GetRecentlyPlayedAlbums

Retrieve recently played albums
Permissions:

• ReadData

Parameters:

1. [ Audio.Fields.Album properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]

Returns:

Type: object
Properties:

• [ Audio.Details.Album[] albums ]
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve recently played albums", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Audio.Fields.Album", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "albums": { "items": { "$ref": "Audio.Details.Album" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

AudioLibrary.GetRecentlyPlayedSongs

Retrieve recently played songs
Permissions:

• ReadData

Parameters:

1. [ Audio.Fields.Song properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Audio.Details.Song[] songs ]

JSON Schema Description

{ "description": "Retrieve recently played songs", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Audio.Fields.Song", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "songs": { "items": { "$ref": "Audio.Details.Song" }, "type": "array" } } } }

AudioLibrary.GetRoles

Retrieve all contributor roles
Permissions:

• ReadData

Parameters:

1. [ Audio.Fields.Role properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• Audio.Details.Role[] roles

JSON Schema Description

{ "description": "Retrieve all contributor roles", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Audio.Fields.Role", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "roles": { "items": { "$ref": "Audio.Details.Role" }, "type": "array", "required": true } } } }

AudioLibrary.GetSongDetails

Retrieve details about a specific song
Permissions:

• ReadData

Parameters:

1. Library.Id songid
2. [ Audio.Fields.Song properties ]

Returns:

Type: object
Properties:

• [ Audio.Details.Song songdetails ]

JSON Schema Description
{ "description": "Retrieve details about a specific song", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "songid", "required": true }, { "$ref": "Audio.Fields.Song", "name": "properties" } ], "returns": { "type": "object", "properties": { "songdetails": { "$ref": "Audio.Details.Song" } } } }

AudioLibrary.GetSongs

Retrieve all songs from specified album, artist or genre
Permissions:

• ReadData

Parameters:

1. [ Audio.Fields.Song properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]
4. [ mixed filter ]
5. [ boolean includesingles = true ]
6. [ boolean allroles = false ] Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Audio.Details.Song[] songs ]

JSON Schema Description

{ "description": "Retrieve all songs from specified album, artist or genre", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Audio.Fields.Song", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "type": [ { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "description": "Song genre. Filter for existance of songs with this genre", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "description": "Song genre. Filter for existance of songs with this genre", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true }, "roleid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true }, "role": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" }, "roleid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" }, "role": { "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" } ], "name": "filter" }, { "default": "true", "type": "boolean", "name": "includesingles" }, { "default": "false", "description": "Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.", "type": "boolean", "name": "allroles" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "songs": { "items": { "$ref": "Audio.Details.Song" }, "type": "array" } } } }

AudioLibrary.Scan

Scans the audio sources for new library items
Permissions:

• UpdateData

Parameters:

1. [ string directory ]
2. [ boolean showdialogs = true ] Whether or not to show the progress bar or any other GUI dialog

Returns:

Type: string

JSON Schema Description
{ "description": "Scans the audio sources for new library items", "permission": "UpdateData", "type": "method", "params": [ { "default": "", "type": "string", "name": "directory" }, { "default": "true", "description": "Whether or not to show the progress bar or any other GUI dialog", "type": "boolean", "name": "showdialogs" } ], "returns": { "type": "string" } }

AudioLibrary.SetAlbumDetails

Update the given album with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id albumid
2. [ Optional.String title ]
3. [ mixed artist ]
4. [ Optional.String description ]
5. [ mixed genre ]
6. [ mixed theme ]
7. [ mixed mood ]
8. [ mixed style ]
9. [ Optional.String type ]
10. [ Optional.String albumlabel ]
11. [ Optional.Number rating ]
12. [ Optional.Integer year ]
13. [ Optional.Integer userrating ]
14. [ Optional.Integer votes ]

Returns:

Type: string

JSON Schema Description

{ "description": "Update the given album with the given details", "permission": "UpdateData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "albumid", "required": true }, { "$ref": "Optional.String", "name": "title" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "artist" }, { "$ref": "Optional.String", "name": "description" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "genre" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "theme" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "mood" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "style" }, { "$ref": "Optional.String", "name": "type" }, { "$ref": "Optional.String", "name": "albumlabel" }, { "$ref": "Optional.Number", "name": "rating" }, { "$ref": "Optional.Integer", "name": "year" }, { "$ref": "Optional.Integer", "name": "userrating" }, { "$ref": "Optional.Integer", "name": "votes" } ], "returns": { "type": "string" } }

AudioLibrary.SetArtistDetails

Update the given artist with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id artistid
2. [ Optional.String artist ]
3. [ mixed instrument ]
4. [ mixed style ]
5. [ mixed mood ]
6. [ Optional.String born ]
7. [ Optional.String formed ]
8. [ Optional.String description ]
9. [ mixed genre ]
10. [ Optional.String died ]
11. [ Optional.String disbanded ]
12. [ mixed yearsactive ]

Returns:

Type: string

JSON Schema Description

{ "description": "Update the given artist with the given details", "permission": "UpdateData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "artistid", "required": true }, { "$ref": "Optional.String", "name": "artist" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "instrument" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "style" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "mood" }, { "$ref": "Optional.String", "name": "born" }, { "$ref": "Optional.String", "name": "formed" }, { "$ref": "Optional.String", "name": "description" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "genre" }, { "$ref": "Optional.String", "name": "died" }, { "$ref": "Optional.String", "name": "disbanded" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "yearsactive" } ], "returns": { "type": "string" } }

AudioLibrary.SetSongDetails

Update the given song with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id songid
2. [ Optional.String title ]
3. [ mixed artist ]
4. [ mixed albumartist ]
5. [ mixed genre ]
6. [ Optional.Integer year ]
7. [ Optional.Number rating ]
8. [ Optional.String album ]
9. [ Optional.Integer track ]
10. [ Optional.Integer disc ]
11. [ Optional.Integer duration ]
12. [ Optional.String comment ]
13. [ Optional.String musicbrainztrackid ]
14. [ Optional.String musicbrainzartistid ]
15. [ Optional.String musicbrainzalbumid ]
16. [ Optional.String musicbrainzalbumartistid ]
17. [ Optional.Integer playcount ]
18. [ Optional.String lastplayed ]
19. [ Optional.Integer userrating ]
20. [ Optional.Integer votes ]

Returns:

Type: string

JSON Schema Description

{ "description": "Update the given song with the given details", "permission": "UpdateData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "songid", "required": true }, { "$ref": "Optional.String", "name": "title" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "artist" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "albumartist" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "genre" }, { "$ref": "Optional.Integer", "name": "year" }, { "$ref": "Optional.Number", "name": "rating" }, { "$ref": "Optional.String", "name": "album" }, { "$ref": "Optional.Integer", "name": "track" }, { "$ref": "Optional.Integer", "name": "disc" }, { "$ref": "Optional.Integer", "name": "duration" }, { "$ref": "Optional.String", "name": "comment" }, { "$ref": "Optional.String", "name": "musicbrainztrackid" }, { "$ref": "Optional.String", "name": "musicbrainzartistid" }, { "$ref": "Optional.String", "name": "musicbrainzalbumid" }, { "$ref": "Optional.String", "name": "musicbrainzalbumartistid" }, { "$ref": "Optional.Integer", "name": "playcount" }, { "$ref": "Optional.String", "name": "lastplayed" }, { "$ref": "Optional.Integer", "name": "userrating" }, { "$ref": "Optional.Integer", "name": "votes" } ], "returns": { "type": "string" } }

Favourites

Favourites.AddFavourite

Add a favourite with the given details
Permissions:

• UpdateData

Parameters:

1. string title
2. Favourite.Type type
3. [ Optional.String path ] Required for media and script favourites types
4. [ Optional.String window ] Required for window favourite type
5. [ Optional.String windowparameter ]
6. [ Optional.String thumbnail ]

Returns:

Type: string

JSON Schema Description

{ "description": "Add a favourite with the given details", "permission": "UpdateData", "type": "method", "params": [ { "type": "string", "name": "title", "required": true }, { "$ref": "Favourite.Type", "name": "type", "required": true }, { "description": "Required for media and script favourites types", "$ref": "Optional.String", "name": "path" }, { "description": "Required for window favourite type", "$ref": "Optional.String", "name": "window" }, { "$ref": "Optional.String", "name": "windowparameter" }, { "$ref": "Optional.String", "name": "thumbnail" } ], "returns": { "type": "string" } }

Favourites.GetFavourites

Retrieve all favourites
Permissions:

• ReadData

Parameters:

1. [ mixed type ]
2. [ Favourite.Fields.Favourite properties ]

Returns:

Type: object
Properties:

• [ Favourite.Details.Favourite[] favourites ]
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve all favourites", "permission": "ReadData", "type": "method", "params": [ { "type": [ { "type": "null" }, { "$ref": "Favourite.Type" } ], "name": "type" }, { "$ref": "Favourite.Fields.Favourite", "name": "properties" } ], "returns": { "type": "object", "properties": { "favourites": { "items": { "$ref": "Favourite.Details.Favourite" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

Files

Files.GetDirectory

Get the directories and files in the given directory
Permissions:

• ReadData

Parameters:

1. string directory
2. [ Files.Media media = "files" ]
3. [ List.Fields.Files properties ]
4. [ List.Sort sort ]
5. [ List.Limits limits ] Limits are applied after getting the directory content thus retrieval is not faster when they are applied.

Returns:

Type: object
Properties:

• List.Item.File[] files
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Get the directories and files in the given directory", "permission": "ReadData", "type": "method", "params": [ { "type": "string", "name": "directory", "required": true }, { "default": "files", "$ref": "Files.Media", "name": "media" }, { "$ref": "List.Fields.Files", "name": "properties" }, { "$ref": "List.Sort", "name": "sort" }, { "description": "Limits are applied after getting the directory content thus retrieval is not faster when they are applied.", "$ref": "List.Limits", "name": "limits" } ], "returns": { "type": "object", "properties": { "files": { "items": { "$ref": "List.Item.File" }, "type": "array", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

Files.GetFileDetails

Get details for a specific file
Permissions:

• ReadData

Parameters:

1. string file Full path to the file
2. [ Files.Media media = "files" ]
3. [ List.Fields.Files properties ]

Returns:

Type: object
Properties:

• List.Item.File filedetails

JSON Schema Description

{ "description": "Get details for a specific file", "permission": "ReadData", "type": "method", "params": [ { "description": "Full path to the file", "type": "string", "name": "file", "required": true }, { "default": "files", "$ref": "Files.Media", "name": "media" }, { "$ref": "List.Fields.Files", "name": "properties" } ], "returns": { "type": "object", "properties": { "filedetails": { "$ref": "List.Item.File", "required": true } } } }

Files.GetSources

Get the sources of the media windows
Permissions:

• ReadData

Parameters:

1. Files.Media media
2. [ List.Limits limits ]
3. [ List.Sort sort ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• List.Items.Sources sources

JSON Schema Description

{ "description": "Get the sources of the media windows", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Files.Media", "name": "media", "required": true }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "sources": { "$ref": "List.Items.Sources", "required": true } } } }

Files.PrepareDownload

Provides a way to download a given file (e.g. providing an URL to the real file location)
Permissions:

• ReadData

Parameters:

1. string path

Returns:

Type: object
Properties:

• mixed Transport specific details on how/from where to download the given filedetails
• string Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocolmode
• string protocol

JSON Schema Description

{ "description": "Provides a way to download a given file (e.g. providing an URL to the real file location)", "permission": "ReadData", "type": "method", "params": [ { "type": "string", "name": "path", "required": true } ], "returns": { "type": "object", "properties": { "details": { "description": "Transport specific details on how/from where to download the given file", "type": "any", "required": true }, "mode": { "description": "Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol", "type": "string", "required": true }, "protocol": { "type": "string", "required": true } } } }

Files.SetFileDetails

Update the given specific file with the given details
Permissions:

• UpdateData

Parameters:

1. string file Full path to the file
2. Files.Media media File type to update correct database. Currently only "video" is supported.
3. [ Optional.Integer playcount ]
4. [ Optional.String lastplayed ] Setting a valid lastplayed without a playcount will force playcount to 1.
5. [ mixed resume ]

Returns:

Type: string

JSON Schema Description

{ "description": "Update the given specific file with the given details", "permission": "UpdateData", "type": "method", "params": [ { "description": "Full path to the file", "type": "string", "name": "file", "required": true }, { "description": "File type to update correct database. Currently only \"video\" is supported.", "$ref": "Files.Media", "name": "media", "required": true }, { "$ref": "Optional.Integer", "name": "playcount" }, { "description": "Setting a valid lastplayed without a playcount will force playcount to 1.", "$ref": "Optional.String", "name": "lastplayed" }, { "type": [ { "type": "null" }, { "$ref": "Video.Resume" } ], "name": "resume" } ], "returns": { "type": "string" } }

GUI

GUI.ActivateWindow

Activates the given window
Permissions:

• ControlGUI

Parameters:

1. GUI.Window window
2. [ string[] parameters ]

Returns:

Type: string

JSON Schema Description
{ "description": "Activates the given window", "permission": "ControlGUI", "type": "method", "params": [ { "$ref": "GUI.Window", "name": "window", "required": true }, { "items": { "type": "string" }, "type": "array", "name": "parameters" } ], "returns": { "type": "string" } }

GUI.GetProperties

Retrieves the values of the given properties
Permissions:

• ReadData

Parameters:

1. GUI.Property.Name[] properties

Returns:

Type: GUI.Property.Value

JSON Schema Description
{ "description": "Retrieves the values of the given properties", "permission": "ReadData", "type": "method", "params": [ { "items": { "$ref": "GUI.Property.Name" }, "type": "array", "name": "properties", "required": true } ], "returns": { "$ref": "GUI.Property.Value" } }

GUI.GetStereoscopicModes

Returns the supported stereoscopic modes of the GUI
Permissions:

• ReadData

Returns:

Type: object
Properties:

• [ GUI.Stereoscopy.Mode[] stereoscopicmodes ]

JSON Schema Description
{ "description": "Returns the supported stereoscopic modes of the GUI", "permission": "ReadData", "type": "method", "params": [], "returns": { "type": "object", "properties": { "stereoscopicmodes": { "items": { "$ref": "GUI.Stereoscopy.Mode" }, "type": "array" } } } }

GUI.SetFullscreen

Toggle fullscreen/GUI
Permissions:

• ControlGUI

Parameters:

1. Global.Toggle fullscreen

Returns:

Type: boolean

Description: Fullscreen state

JSON Schema Description
{ "description": "Toggle fullscreen/GUI", "permission": "ControlGUI", "type": "method", "params": [ { "$ref": "Global.Toggle", "name": "fullscreen", "required": true } ], "returns": { "type": "boolean", "description": "Fullscreen state" } }

GUI.SetStereoscopicMode

Sets the stereoscopic mode of the GUI to the given mode
Permissions:

• ControlGUI

Parameters:

1. string mode

Returns:

Type: string

JSON Schema Description
{ "description": "Sets the stereoscopic mode of the GUI to the given mode", "permission": "ControlGUI", "type": "method", "params": [ { "type": "string", "name": "mode", "required": true } ], "returns": { "type": "string" } }

GUI.ShowNotification

Shows a GUI notification
Permissions:

• ControlGUI

Parameters:

1. string title
2. string message
3. [ mixed: string|string image ]
4. [ integer displaytime = "5000" ] The time in milliseconds the notification will be visible

Returns:

Type: string

JSON Schema Description

{ "description": "Shows a GUI notification", "permission": "ControlGUI", "type": "method", "params": [ { "type": "string", "name": "title", "required": true }, { "type": "string", "name": "message", "required": true }, { "default": "", "type": [ { "enums": [ "info", "warning", "error" ], "type": "string" }, { "type": "string" } ], "name": "image" }, { "default": "5000", "description": "The time in milliseconds the notification will be visible", "type": "integer", "name": "displaytime" } ], "returns": { "type": "string" } }

Input

Input.Back

Goes back in GUI
Permissions:

• Navigate

Returns:

Type: string

JSON Schema Description
{ "description": "Goes back in GUI", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.ContextMenu

Shows the context menu
Permissions:

• Navigate

Returns:

Type: string

JSON Schema Description
{ "description": "Shows the context menu", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.Down

Navigate down in GUI
Permissions:

• Navigate

Returns:

Type: string

JSON Schema Description
{ "description": "Navigate down in GUI", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.ExecuteAction

Execute a specific action
Permissions:

• Navigate

Parameters:

1. Input.Action action

Returns:

Type: string

JSON Schema Description
{ "description": "Execute a specific action", "permission": "Navigate", "type": "method", "params": [ { "$ref": "Input.Action", "name": "action", "required": true } ], "returns": { "type": "string" } }

Input.Home

Goes to home window in GUI
Permissions:

• Navigate

Returns:

Type: string

JSON Schema Description
{ "description": "Goes to home window in GUI", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.Info

Shows the information dialog
Permissions:

• Navigate

Returns:

Type: string

JSON Schema Description
{ "description": "Shows the information dialog", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.Left

Navigate left in GUI
Permissions:

• Navigate

Returns:

Type: string

JSON Schema Description
{ "description": "Navigate left in GUI", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.Right

Navigate right in GUI
Permissions:

• Navigate

Returns:

Type: string

JSON Schema Description
{ "description": "Navigate right in GUI", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.Select

Select current item in GUI
Permissions:

• Navigate

Returns:

Type: string

JSON Schema Description
{ "description": "Select current item in GUI", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.SendText

Send a generic (unicode) text
Permissions:

• Navigate

Parameters:

1. string text Unicode text
2. [ boolean done = true ] Whether this is the whole input or not (closes an open input dialog if true).

Returns:

Type: string

JSON Schema Description
{ "description": "Send a generic (unicode) text", "permission": "Navigate", "type": "method", "params": [ { "description": "Unicode text", "type": "string", "name": "text", "required": true }, { "default": "true", "description": "Whether this is the whole input or not (closes an open input dialog if true).", "type": "boolean", "name": "done" } ], "returns": { "type": "string" } }

Input.ShowCodec

Show codec information of the playing item
Permissions:

• Navigate

Returns:

Type: string

JSON Schema Description
{ "description": "Show codec information of the playing item", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.ShowOSD

Show the on-screen display for the current player
Permissions:

• Navigate

Returns:

Type: string

JSON Schema Description
{ "description": "Show the on-screen display for the current player", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.ShowPlayerProcessInfo

Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...
Permissions:

• Navigate

Returns:

Type: string

JSON Schema Description
{ "description": "Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.Up

Navigate up in GUI
Permissions:

• Navigate

Returns:

Type: string

JSON Schema Description
{ "description": "Navigate up in GUI", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

JSONRPC

JSONRPC.Introspect

Enumerates all actions and descriptions
Permissions:

• ReadData

Parameters:

1. [ boolean getdescriptions = true ]
2. [ boolean getmetadata = false ]
3. [ boolean filterbytransport = true ]
4. [ mixed filter ]

Returns:

Type: object

JSON Schema Description

{ "description": "Enumerates all actions and descriptions", "permission": "ReadData", "type": "method", "params": [ { "default": "true", "type": "boolean", "name": "getdescriptions" }, { "default": "false", "type": "boolean", "name": "getmetadata" }, { "default": "true", "type": "boolean", "name": "filterbytransport" }, { "type": "object", "name": "filter" } ], "returns": { "type": "object", "additionalProperties": false } }

JSONRPC.NotifyAll

Notify all other connected clients
Permissions:

• ReadData

Parameters:

1. string sender
2. string message
3. [ mixed data ]

Returns:

Type: any

JSON Schema Description
{ "description": "Notify all other connected clients", "permission": "ReadData", "type": "method", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "string", "name": "message", "required": true }, { "type": "any", "name": "data" } ], "returns": { "type": "any" } }

JSONRPC.Permission

Retrieve the clients permissions
Permissions:

• ReadData

Returns:

Type: object
Properties:

• boolean controlgui
• boolean controlnotify
• boolean controlplayback
• boolean controlpower
• boolean controlpvr
• boolean controlsystem
• boolean executeaddon
• boolean manageaddon
• boolean navigate
• boolean readdata
• boolean removedata
• boolean updatedata
• boolean writefile

JSON Schema Description

{ "description": "Retrieve the clients permissions", "permission": "ReadData", "type": "method", "params": [], "returns": { "type": "object", "properties": { "controlgui": { "type": "boolean", "required": true }, "controlnotify": { "type": "boolean", "required": true }, "controlplayback": { "type": "boolean", "required": true }, "controlpower": { "type": "boolean", "required": true }, "controlpvr": { "type": "boolean", "required": true }, "controlsystem": { "type": "boolean", "required": true }, "executeaddon": { "type": "boolean", "required": true }, "manageaddon": { "type": "boolean", "required": true }, "navigate": { "type": "boolean", "required": true }, "readdata": { "type": "boolean", "required": true }, "removedata": { "type": "boolean", "required": true }, "updatedata": { "type": "boolean", "required": true }, "writefile": { "type": "boolean", "required": true } } } }

JSONRPC.Ping

Ping responder
Permissions:

• ReadData

Returns:

Type: string

JSON Schema Description
{ "description": "Ping responder", "permission": "ReadData", "type": "method", "params": [], "returns": { "type": "string" } }

JSONRPC.Version

Retrieve the JSON-RPC protocol version.
Permissions:

• ReadData

Returns:

Type: object
Properties:

• mixed version

JSON Schema Description
{ "description": "Retrieve the JSON-RPC protocol version.", "permission": "ReadData", "type": "method", "params": [], "returns": { "type": "object", "properties": { "version": { "type": "object", "required": true } } } }

Player

Player.GetActivePlayers

Returns all active players
Permissions:

• ReadData

Returns:

Type: array

JSON Schema Description
{ "description": "Returns all active players", "permission": "ReadData", "type": "method", "params": [], "returns": { "type": "array" } }

Player.GetItem

Retrieves the currently played item
Permissions:

• ReadData

Parameters:

1. Player.Id playerid
2. [ List.Fields.All properties ]

Returns:

Type: object
Properties:

• List.Item.All item

JSON Schema Description
{ "description": "Retrieves the currently played item", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "$ref": "List.Fields.All", "name": "properties" } ], "returns": { "type": "object", "properties": { "item": { "$ref": "List.Item.All", "required": true } } } }

Player.GetPlayers

Get a list of available players
Permissions:

• ReadData

Parameters:

1. [ string media = "all" ]

Returns:

Type: array

JSON Schema Description
{ "description": "Get a list of available players", "permission": "ReadData", "type": "method", "params": [ { "default": "all", "type": "string", "name": "media" } ], "returns": { "type": "array" } }

Player.GetProperties

Retrieves the values of the given properties
Permissions:

• ReadData

Parameters:

1. Player.Id playerid
2. Player.Property.Name[] properties

Returns:

Type: Player.Property.Value

JSON Schema Description
{ "description": "Retrieves the values of the given properties", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "items": { "$ref": "Player.Property.Name" }, "type": "array", "name": "properties", "required": true } ], "returns": { "$ref": "Player.Property.Value" } }

Player.GoTo

Go to previous/next/specific item in the playlist
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. mixed to

Returns:

Type: string

JSON Schema Description

{ "description": "Go to previous/next/specific item in the playlist", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "type": [ { "enums": [ "previous", "next" ], "type": "string" }, { "$ref": "Playlist.Position", "description": "position in playlist" } ], "name": "to", "required": true } ], "returns": { "type": "string" } }

Player.Move

If picture is zoomed move viewport left/right/up/down otherwise skip previous/next
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. string direction

Returns:

Type: string

JSON Schema Description
{ "description": "If picture is zoomed move viewport left/right/up/down otherwise skip previous/next", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "type": "string", "name": "direction", "required": true } ], "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:

1. [ mixed item ]
2. [ mixed options ]

Returns:

Type: string

JSON Schema Description

{ "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.", "permission": "ControlPlayback", "type": "method", "params": [ { "type": [ { "additionalProperties": false, "properties": { "playlistid": { "$ref": "Playlist.Id", "required": true }, "position": { "$ref": "Playlist.Position", "default": 0 } }, "type": "object" }, { "$ref": "Playlist.Item" }, { "additionalProperties": false, "properties": { "path": { "required": true, "type": "string" }, "random": { "default": true, "description": "Deprecated, use the shuffled property of the options parameter instead", "type": "boolean" }, "recursive": { "default": true, "type": "boolean" } }, "type": "object" }, { "additionalProperties": false, "properties": { "partymode": { "default": "", "type": [ { "enums": [ "music", "video" ], "type": "string" }, { "description": "Path to a smartplaylist (*.xsp) file", "minLength": 5, "type": "string" } ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "channelid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "recordingid": { "$ref": "Library.Id", "required": true } }, "type": "object" } ], "name": "item" }, { "type": "object", "name": "options" } ], "returns": { "type": "string" } }

Player.PlayPause

Pauses or unpause playback and returns the new state
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. [ Global.Toggle play = "toggle" ]

Returns:

Type: Player.Speed

JSON Schema Description
{ "description": "Pauses or unpause playback and returns the new state", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "default": "toggle", "$ref": "Global.Toggle", "name": "play" } ], "returns": { "$ref": "Player.Speed" } }

Player.Rotate

Rotates current picture
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. [ string value = "clockwise" ]

Returns:

Type: string

JSON Schema Description
{ "description": "Rotates current picture", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "default": "clockwise", "type": "string", "name": "value" } ], "returns": { "type": "string" } }

Player.Seek

Seek through the playing item
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. mixed value

Returns:

Type: object
Properties:

• [ Player.Position.Percentage = "0"percentage ]
• [ Global.Time time ]
• [ Global.Time totaltime ]

JSON Schema Description

{ "description": "Seek through the playing item", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "type": [ { "$ref": "Player.Position.Percentage", "description": "Percentage value to seek to" }, { "$ref": "Player.Position.Time", "description": "Time to seek to" }, { "description": "Seek by predefined jumps", "enums": [ "smallforward", "smallbackward", "bigforward", "bigbackward" ], "type": "string" }, { "additionalProperties": false, "properties": { "percentage": { "$ref": "Player.Position.Percentage", "description": "Percentage value to seek to", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "time": { "$ref": "Player.Position.Time", "description": "Time to seek to", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "step": { "description": "Seek by predefined jumps", "enums": [ "smallforward", "smallbackward", "bigforward", "bigbackward" ], "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "seconds": { "description": "Seek by the given number of seconds", "required": true, "type": "integer" } }, "type": "object" } ], "name": "value", "required": true } ], "returns": { "type": "object", "properties": { "percentage": { "default": "0", "$ref": "Player.Position.Percentage" }, "time": { "$ref": "Global.Time" }, "totaltime": { "$ref": "Global.Time" } } } }

Player.SetAudioStream

Set the audio stream played by the player
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. mixed: string|integer stream

Returns:

Type: string

JSON Schema Description

{ "description": "Set the audio stream played by the player", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "type": [ { "enums": [ "previous", "next" ], "type": "string" }, { "description": "Index of the audio stream to play", "minimum": 0, "type": "integer" } ], "name": "stream", "required": true } ], "returns": { "type": "string" } }

Player.SetPartymode

Turn partymode on or off
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. Global.Toggle partymode

Returns:

Type: string

JSON Schema Description
{ "description": "Turn partymode on or off", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "$ref": "Global.Toggle", "name": "partymode", "required": true } ], "returns": { "type": "string" } }

Player.SetRepeat

Set the repeat mode of the player
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. mixed repeat

Returns:

Type: string

JSON Schema Description
{ "description": "Set the repeat mode of the player", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "type": [ { "$ref": "Player.Repeat" }, { "enums": [ "cycle" ], "type": "string" } ], "name": "repeat", "required": true } ], "returns": { "type": "string" } }

Player.SetShuffle

Shuffle/Unshuffle items in the player
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. Global.Toggle shuffle

Returns:

Type: string

JSON Schema Description
{ "description": "Shuffle/Unshuffle items in the player", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "$ref": "Global.Toggle", "name": "shuffle", "required": true } ], "returns": { "type": "string" } }

Player.SetSpeed

Set the speed of the current playback
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. mixed speed

Returns:

Type: Player.Speed

JSON Schema Description

{ "description": "Set the speed of the current playback", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "type": [ { "enums": [ -32, -16, -8, -4, -2, -1, 0, 1, 2, 4, 8, 16, 32 ], "type": "integer" }, { "$ref": "Global.IncrementDecrement" } ], "name": "speed", "required": true } ], "returns": { "$ref": "Player.Speed" } }

Player.SetSubtitle

Set the subtitle displayed by the player
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. mixed: string|integer subtitle
3. [ boolean enable = false ] Whether to enable subtitles to be displayed after setting the new subtitle

Returns:

Type: string

JSON Schema Description

{ "description": "Set the subtitle displayed by the player", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "type": [ { "enums": [ "previous", "next", "off", "on" ], "type": "string" }, { "description": "Index of the subtitle to display", "minimum": 0, "type": "integer" } ], "name": "subtitle", "required": true }, { "default": "false", "description": "Whether to enable subtitles to be displayed after setting the new subtitle", "type": "boolean", "name": "enable" } ], "returns": { "type": "string" } }

Player.SetVideoStream

Set the video stream played by the player
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. mixed: string|integer stream

Returns:

Type: string

JSON Schema Description

{ "description": "Set the video stream played by the player", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "type": [ { "enums": [ "previous", "next" ], "type": "string" }, { "description": "Index of the video stream to play", "minimum": 0, "type": "integer" } ], "name": "stream", "required": true } ], "returns": { "type": "string" } }

Player.Stop

Stops playback
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid

Returns:

Type: string

JSON Schema Description
{ "description": "Stops playback", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true } ], "returns": { "type": "string" } }

Player.Zoom

Zoom current picture
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. mixed: string|integer zoom

Returns:

Type: string

JSON Schema Description
{ "description": "Zoom current picture", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "type": [ { "enums": [ "in", "out" ], "type": "string" }, { "description": "zoom level", "maximum": 10, "minimum": 1, "type": "integer" } ], "name": "zoom", "required": true } ], "returns": { "type": "string" } }

Playlist

Playlist.Add

Add item(s) to playlist
Permissions:

• ControlPlayback

Parameters:

1. Playlist.Id playlistid
2. mixed item

Returns:

Type: string

JSON Schema Description
{ "description": "Add item(s) to playlist", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "type": [ { "$ref": "Playlist.Item" }, { "items": { "$ref": "Playlist.Item" }, "type": "array" } ], "name": "item", "required": true } ], "returns": { "type": "string" } }

Playlist.Clear

Clear playlist
Permissions:

• ControlPlayback

Parameters:

1. Playlist.Id playlistid

Returns:

Type: string

JSON Schema Description
{ "description": "Clear playlist", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true } ], "returns": { "type": "string" } }

Playlist.GetItems

Get all items from playlist
Permissions:

• ReadData

Parameters:

1. Playlist.Id playlistid
2. [ List.Fields.All properties ]
3. [ List.Limits limits ]
4. [ List.Sort sort ]

Returns:

Type: object
Properties:

• List.Item.All[] items
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Get all items from playlist", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "$ref": "List.Fields.All", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "items": { "items": { "$ref": "List.Item.All" }, "type": "array", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

Playlist.GetPlaylists

Returns all existing playlists
Permissions:

• ReadData

Returns:

Type: array

JSON Schema Description
{ "description": "Returns all existing playlists", "permission": "ReadData", "type": "method", "params": [], "returns": { "type": "array" } }

Playlist.GetProperties

Retrieves the values of the given properties
Permissions:

• ReadData

Parameters:

1. Playlist.Id playlistid
2. Playlist.Property.Name[] properties

Returns:

Type: Playlist.Property.Value

JSON Schema Description
{ "description": "Retrieves the values of the given properties", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "items": { "$ref": "Playlist.Property.Name" }, "type": "array", "name": "properties", "required": true } ], "returns": { "$ref": "Playlist.Property.Value" } }

Playlist.Insert

Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).
Permissions:

• ControlPlayback

Parameters:

1. Playlist.Id playlistid
2. Playlist.Position position
3. mixed item

Returns:

Type: string

JSON Schema Description

{ "description": "Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "$ref": "Playlist.Position", "name": "position", "required": true }, { "type": [ { "$ref": "Playlist.Item" }, { "items": { "$ref": "Playlist.Item" }, "type": "array" } ], "name": "item", "required": true } ], "returns": { "type": "string" } }

Playlist.Remove

Remove item from playlist. Does not work for picture playlists (aka slideshows).
Permissions:

• ControlPlayback

Parameters:

1. Playlist.Id playlistid
2. Playlist.Position position

Returns:

Type: string

JSON Schema Description
{ "description": "Remove item from playlist. Does not work for picture playlists (aka slideshows).", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "$ref": "Playlist.Position", "name": "position", "required": true } ], "returns": { "type": "string" } }

Playlist.Swap

Swap items in the playlist. Does not work for picture playlists (aka slideshows).
Permissions:

• ControlPlayback

Parameters:

1. Playlist.Id playlistid
2. Playlist.Position position1
3. Playlist.Position position2

Returns:

Type: string

JSON Schema Description

{ "description": "Swap items in the playlist. Does not work for picture playlists (aka slideshows).", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "$ref": "Playlist.Position", "name": "position1", "required": true }, { "$ref": "Playlist.Position", "name": "position2", "required": true } ], "returns": { "type": "string" } }

Profiles

Profiles.GetCurrentProfile

Retrieve the current profile
Permissions:

• ReadData

Parameters:

1. [ Profiles.Fields.Profile properties ]

Returns:

Type: Profiles.Details.Profile

JSON Schema Description
{ "description": "Retrieve the current profile", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Profiles.Fields.Profile", "name": "properties" } ], "returns": { "$ref": "Profiles.Details.Profile" } }

Profiles.GetProfiles

Retrieve all profiles
Permissions:

• ReadData

Parameters:

1. [ Profiles.Fields.Profile properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• Profiles.Details.Profile[] profiles

JSON Schema Description

{ "description": "Retrieve all profiles", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Profiles.Fields.Profile", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "profiles": { "items": { "$ref": "Profiles.Details.Profile" }, "type": "array", "required": true } } } }

Profiles.LoadProfile

Load the specified profile
Permissions:

• Navigate

Parameters:

1. string profile Profile name
2. [ boolean prompt = false ] Prompt for password
3. [ Profiles.Password password ]

Returns:

Type: string

JSON Schema Description
{ "description": "Load the specified profile", "permission": "Navigate", "type": "method", "params": [ { "description": "Profile name", "type": "string", "name": "profile", "required": true }, { "default": "false", "description": "Prompt for password", "type": "boolean", "name": "prompt" }, { "$ref": "Profiles.Password", "name": "password" } ], "returns": { "type": "string" } }

PVR

PVR.AddTimer

Adds a timer to record the given show one times or a timer rule to record all showings of the given show
Permissions:

• ControlPVR

Parameters:

1. Library.Id broadcastid the broadcast id of the item to record
2. [ boolean timerrule = false ] controls whether to create a timer rule or a onetime timer

Returns:

Type: string

JSON Schema Description

{ "description": "Adds a timer to record the given show one times or a timer rule to record all showings of the given show", "permission": "ControlPVR", "type": "method", "params": [ { "description": "the broadcast id of the item to record", "$ref": "Library.Id", "name": "broadcastid", "required": true }, { "default": "false", "description": "controls whether to create a timer rule or a onetime timer", "type": "boolean", "name": "timerrule" } ], "returns": { "type": "string" } }

PVR.DeleteTimer

Deletes a onetime timer or a timer rule
Permissions:

• ControlPVR

Parameters:

1. Library.Id timerid the id of the onetime timer or timer rule to delete

Returns:

Type: string

JSON Schema Description
{ "description": "Deletes a onetime timer or a timer rule", "permission": "ControlPVR", "type": "method", "params": [ { "description": "the id of the onetime timer or timer rule to delete", "$ref": "Library.Id", "name": "timerid", "required": true } ], "returns": { "type": "string" } }

PVR.GetBroadcastDetails

Retrieves the details of a specific broadcast
Permissions:

• ReadData

Parameters:

1. Library.Id broadcastid
2. [ PVR.Fields.Broadcast properties ]

Returns:

Type: object
Properties:

• [ PVR.Details.Broadcast broadcastdetails ]

JSON Schema Description
{ "description": "Retrieves the details of a specific broadcast", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "broadcastid", "required": true }, { "$ref": "PVR.Fields.Broadcast", "name": "properties" } ], "returns": { "type": "object", "properties": { "broadcastdetails": { "$ref": "PVR.Details.Broadcast" } } } }

PVR.GetBroadcasts

Retrieves the program of a specific channel
Permissions:

• ReadData

Parameters:

1. Library.Id channelid
2. [ PVR.Fields.Broadcast properties ]
3. [ List.Limits limits ]

Returns:

Type: object
Properties:

• PVR.Details.Broadcast[] broadcasts
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieves the program of a specific channel", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "channelid", "required": true }, { "$ref": "PVR.Fields.Broadcast", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" } ], "returns": { "type": "object", "properties": { "broadcasts": { "items": { "$ref": "PVR.Details.Broadcast" }, "type": "array", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

PVR.GetChannelDetails

Retrieves the details of a specific channel
Permissions:

• ReadData

Parameters:

1. Library.Id channelid
2. [ PVR.Fields.Channel properties ]

Returns:

Type: object
Properties:

• [ PVR.Details.Channel channeldetails ]

JSON Schema Description
{ "description": "Retrieves the details of a specific channel", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "channelid", "required": true }, { "$ref": "PVR.Fields.Channel", "name": "properties" } ], "returns": { "type": "object", "properties": { "channeldetails": { "$ref": "PVR.Details.Channel" } } } }

PVR.GetChannelGroupDetails

Retrieves the details of a specific channel group
Permissions:

• ReadData

Parameters:

1. PVR.ChannelGroup.Id channelgroupid
2. [ mixed channels ]

Returns:

Type: object
Properties:

• [ PVR.Details.ChannelGroup.Extended channelgroupdetails ]

JSON Schema Description
{ "description": "Retrieves the details of a specific channel group", "permission": "ReadData", "type": "method", "params": [ { "$ref": "PVR.ChannelGroup.Id", "name": "channelgroupid", "required": true }, { "type": "object", "name": "channels" } ], "returns": { "type": "object", "properties": { "channelgroupdetails": { "$ref": "PVR.Details.ChannelGroup.Extended" } } } }

PVR.GetChannelGroups

Retrieves the channel groups for the specified type
Permissions:

• ReadData

Parameters:

1. PVR.Channel.Type channeltype
2. [ List.Limits limits ]

Returns:

Type: object
Properties:

• PVR.Details.ChannelGroup[] channelgroups
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieves the channel groups for the specified type", "permission": "ReadData", "type": "method", "params": [ { "$ref": "PVR.Channel.Type", "name": "channeltype", "required": true }, { "$ref": "List.Limits", "name": "limits" } ], "returns": { "type": "object", "properties": { "channelgroups": { "items": { "$ref": "PVR.Details.ChannelGroup" }, "type": "array", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

PVR.GetChannels

Retrieves the channel list
Permissions:

• ReadData

Parameters:

1. PVR.ChannelGroup.Id channelgroupid
2. [ PVR.Fields.Channel properties ]
3. [ List.Limits limits ]

Returns:

Type: object
Properties:

• PVR.Details.Channel[] channels
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieves the channel list", "permission": "ReadData", "type": "method", "params": [ { "$ref": "PVR.ChannelGroup.Id", "name": "channelgroupid", "required": true }, { "$ref": "PVR.Fields.Channel", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" } ], "returns": { "type": "object", "properties": { "channels": { "items": { "$ref": "PVR.Details.Channel" }, "type": "array", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

PVR.GetProperties

Retrieves the values of the given properties
Permissions:

• ReadData

Parameters:

1. PVR.Property.Name[] properties

Returns:

Type: PVR.Property.Value

JSON Schema Description
{ "description": "Retrieves the values of the given properties", "permission": "ReadData", "type": "method", "params": [ { "items": { "$ref": "PVR.Property.Name" }, "type": "array", "name": "properties", "required": true } ], "returns": { "$ref": "PVR.Property.Value" } }

PVR.GetRecordingDetails

Retrieves the details of a specific recording
Permissions:

• ReadData

Parameters:

1. Library.Id recordingid
2. [ PVR.Fields.Recording properties ]

Returns:

Type: object
Properties:

• [ PVR.Details.Recording recordingdetails ]

JSON Schema Description
{ "description": "Retrieves the details of a specific recording", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "recordingid", "required": true }, { "$ref": "PVR.Fields.Recording", "name": "properties" } ], "returns": { "type": "object", "properties": { "recordingdetails": { "$ref": "PVR.Details.Recording" } } } }

PVR.GetRecordings

Retrieves the recordings
Permissions:

• ReadData

Parameters:

1. [ PVR.Fields.Recording properties ]
2. [ List.Limits limits ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• PVR.Details.Recording[] recordings

JSON Schema Description

{ "description": "Retrieves the recordings", "permission": "ReadData", "type": "method", "params": [ { "$ref": "PVR.Fields.Recording", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "recordings": { "items": { "$ref": "PVR.Details.Recording" }, "type": "array", "required": true } } } }

PVR.GetTimerDetails

Retrieves the details of a specific timer
Permissions:

• ReadData

Parameters:

1. Library.Id timerid
2. [ PVR.Fields.Timer properties ]

Returns:

Type: object
Properties:

• [ PVR.Details.Timer timerdetails ]

JSON Schema Description
{ "description": "Retrieves the details of a specific timer", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "timerid", "required": true }, { "$ref": "PVR.Fields.Timer", "name": "properties" } ], "returns": { "type": "object", "properties": { "timerdetails": { "$ref": "PVR.Details.Timer" } } } }

PVR.GetTimers

Retrieves the timers
Permissions:

• ReadData

Parameters:

1. [ PVR.Fields.Timer properties ]
2. [ List.Limits limits ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• PVR.Details.Timer[] timers

JSON Schema Description

{ "description": "Retrieves the timers", "permission": "ReadData", "type": "method", "params": [ { "$ref": "PVR.Fields.Timer", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "timers": { "items": { "$ref": "PVR.Details.Timer" }, "type": "array", "required": true } } } }

PVR.Record

Toggle recording of a channel
Permissions:

• ControlPVR

Parameters:

1. [ Global.Toggle record = "toggle" ]
2. [ mixed channel = "current" ]

Returns:

Type: string

JSON Schema Description
{ "description": "Toggle recording of a channel", "permission": "ControlPVR", "type": "method", "params": [ { "default": "toggle", "$ref": "Global.Toggle", "name": "record" }, { "default": "current", "type": [ { "enums": [ "current" ], "type": "string" }, { "$ref": "Library.Id" } ], "name": "channel" } ], "returns": { "type": "string" } }

PVR.Scan

Starts a channel scan
Permissions:

• ControlPVR

Returns:

Type: string

JSON Schema Description
{ "description": "Starts a channel scan", "permission": "ControlPVR", "type": "method", "params": [], "returns": { "type": "string" } }

PVR.ToggleTimer

Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created
Permissions:

• ControlPVR

Parameters:

1. Library.Id broadcastid the broadcast id of the item to toggle a onetime timer or time rule for
2. [ boolean timerrule = false ] controls whether to create / delete a timer rule or a onetime timer

Returns:

Type: string

JSON Schema Description

{ "description": "Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created", "permission": "ControlPVR", "type": "method", "params": [ { "description": "the broadcast id of the item to toggle a onetime timer or time rule for", "$ref": "Library.Id", "name": "broadcastid", "required": true }, { "default": "false", "description": "controls whether to create / delete a timer rule or a onetime timer", "type": "boolean", "name": "timerrule" } ], "returns": { "type": "string" } }

Settings

Settings.GetCategories

Retrieves all setting categories
Permissions:

• ReadData

Parameters:

1. [ Setting.Level level = "standard" ]
2. [ string section ]
3. [ mixed properties ]

Returns:

Type: object
Properties:

• [ Setting.Details.Category[] categories ]

JSON Schema Description

{ "description": "Retrieves all setting categories", "permission": "ReadData", "type": "method", "params": [ { "default": "standard", "$ref": "Setting.Level", "name": "level" }, { "default": "", "type": "string", "name": "section" }, { "items": { "type": "string" }, "name": "properties" } ], "returns": { "type": "object", "properties": { "categories": { "items": { "$ref": "Setting.Details.Category" }, "type": "array" } } } }

Settings.GetSections

Retrieves all setting sections
Permissions:

• ReadData

Parameters:

1. [ Setting.Level level = "standard" ]
2. [ mixed properties ]

Returns:

Type: object
Properties:

• [ Setting.Details.Section[] sections ]

JSON Schema Description
{ "description": "Retrieves all setting sections", "permission": "ReadData", "type": "method", "params": [ { "default": "standard", "$ref": "Setting.Level", "name": "level" }, { "items": { "type": "string" }, "name": "properties" } ], "returns": { "type": "object", "properties": { "sections": { "items": { "$ref": "Setting.Details.Section" }, "type": "array" } } } }

Settings.GetSettings

Retrieves all settings
Permissions:

• ReadData

Parameters:

1. [ Setting.Level level = "standard" ]
2. [ mixed: object filter ]

Returns:

Type: object
Properties:

• [ Setting.Details.Setting[] settings ]

JSON Schema Description

{ "description": "Retrieves all settings", "permission": "ReadData", "type": "method", "params": [ { "default": "standard", "$ref": "Setting.Level", "name": "level" }, { "type": [ { "additionalProperties": false, "properties": { "category": { "minLength": 1, "required": true, "type": "string" }, "section": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" } ], "name": "filter" } ], "returns": { "type": "object", "properties": { "settings": { "items": { "$ref": "Setting.Details.Setting" }, "type": "array" } } } }

Settings.GetSettingValue

Retrieves the value of a setting
Permissions:

• ReadData

Parameters:

1. string setting

Returns:

Type: object
Properties:

• Setting.Value.Extended value

JSON Schema Description
{ "description": "Retrieves the value of a setting", "permission": "ReadData", "type": "method", "params": [ { "type": "string", "name": "setting", "required": true } ], "returns": { "type": "object", "properties": { "value": { "$ref": "Setting.Value.Extended", "required": true } } } }

Settings.ResetSettingValue

Resets the value of a setting
Permissions:

• ReadData

Parameters:

1. string setting

Returns:

Type: string

JSON Schema Description
{ "description": "Resets the value of a setting", "permission": "ReadData", "type": "method", "params": [ { "type": "string", "name": "setting", "required": true } ], "returns": { "type": "string" } }

Settings.SetSettingValue

Changes the value of a setting
Permissions:

• ReadData

Parameters:

1. string setting
2. Setting.Value.Extended value

Returns:

Type: boolean

JSON Schema Description
{ "description": "Changes the value of a setting", "permission": "ReadData", "type": "method", "params": [ { "type": "string", "name": "setting", "required": true }, { "$ref": "Setting.Value.Extended", "name": "value", "required": true } ], "returns": { "type": "boolean" } }

System

System.EjectOpticalDrive

Ejects or closes the optical disc drive (if available)
Permissions:

• ControlSystem

Returns:

Type: string

JSON Schema Description
{ "description": "Ejects or closes the optical disc drive (if available)", "permission": "ControlSystem", "type": "method", "params": [], "returns": { "type": "string" } }

System.GetProperties

Retrieves the values of the given properties
Permissions:

• ReadData

Parameters:

1. System.Property.Name[] properties

Returns:

Type: System.Property.Value

JSON Schema Description
{ "description": "Retrieves the values of the given properties", "permission": "ReadData", "type": "method", "params": [ { "items": { "$ref": "System.Property.Name" }, "type": "array", "name": "properties", "required": true } ], "returns": { "$ref": "System.Property.Value" } }

System.Hibernate

Puts the system running Kodi into hibernate mode
Permissions:

• ControlPower

Returns:

Type: string

JSON Schema Description
{ "description": "Puts the system running Kodi into hibernate mode", "permission": "ControlPower", "type": "method", "params": [], "returns": { "type": "string" } }

System.Reboot

Reboots the system running Kodi
Permissions:

• ControlPower

Returns:

Type: string

JSON Schema Description
{ "description": "Reboots the system running Kodi", "permission": "ControlPower", "type": "method", "params": [], "returns": { "type": "string" } }

System.Shutdown

Shuts the system running Kodi down
Permissions:

• ControlPower

Returns:

Type: string

JSON Schema Description
{ "description": "Shuts the system running Kodi down", "permission": "ControlPower", "type": "method", "params": [], "returns": { "type": "string" } }

System.Suspend

Suspends the system running Kodi
Permissions:

• ControlPower

Returns:

Type: string

JSON Schema Description
{ "description": "Suspends the system running Kodi", "permission": "ControlPower", "type": "method", "params": [], "returns": { "type": "string" } }

Textures

Textures.GetTextures

Retrieve all textures
Permissions:

• ReadData

Parameters:

1. [ Textures.Fields.Texture properties ]
2. [ List.Filter.Textures filter ]

Returns:

Type: object
Properties:

• Textures.Details.Texture[] textures

JSON Schema Description
{ "description": "Retrieve all textures", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Textures.Fields.Texture", "name": "properties" }, { "$ref": "List.Filter.Textures", "name": "filter" } ], "returns": { "type": "object", "properties": { "textures": { "items": { "$ref": "Textures.Details.Texture" }, "type": "array", "required": true } } } }

Textures.RemoveTexture

Remove the specified texture
Permissions:

• RemoveData

Parameters:

1. Library.Id textureid Texture database identifier

Returns:

Type: string

JSON Schema Description
{ "description": "Remove the specified texture", "permission": "RemoveData", "type": "method", "params": [ { "description": "Texture database identifier", "$ref": "Library.Id", "name": "textureid", "required": true } ], "returns": { "type": "string" } }

VideoLibrary

VideoLibrary.Clean

Cleans the video library from non-existent items
Permissions:

• RemoveData

Parameters:

1. [ boolean showdialogs = true ] Whether or not to show the progress bar or any other GUI dialog

Returns:

Type: string

JSON Schema Description
{ "description": "Cleans the video library from non-existent items", "permission": "RemoveData", "type": "method", "params": [ { "default": "true", "description": "Whether or not to show the progress bar or any other GUI dialog", "type": "boolean", "name": "showdialogs" } ], "returns": { "type": "string" } }

VideoLibrary.Export

Exports all items from the video library
Permissions:

• WriteFile

Parameters:

1. [ mixed: object|object options ]

Returns:

Type: string

JSON Schema Description

{ "description": "Exports all items from the video library", "permission": "WriteFile", "type": "method", "params": [ { "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": { "actorthumbs": { "default": false, "description": "Whether to export actor thumbnails", "type": "boolean" }, "images": { "default": false, "description": "Whether to export thumbnails and fanart images", "type": "boolean" }, "overwrite": { "default": false, "description": "Whether to overwrite existing exported files", "type": "boolean" } }, "type": "object" } ], "name": "options" } ], "returns": { "type": "string" } }

VideoLibrary.GetEpisodeDetails

Retrieve details about a specific tv show episode
Permissions:

• ReadData

Parameters:

1. Library.Id episodeid
2. [ Video.Fields.Episode properties ]

Returns:

Type: object
Properties:

• [ Video.Details.Episode episodedetails ]

JSON Schema Description
{ "description": "Retrieve details about a specific tv show episode", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "episodeid", "required": true }, { "$ref": "Video.Fields.Episode", "name": "properties" } ], "returns": { "type": "object", "properties": { "episodedetails": { "$ref": "Video.Details.Episode" } } } }

VideoLibrary.GetEpisodes

Retrieve all tv show episodes
Permissions:

• ReadData

Parameters:

1. [ Library.Id tvshowid = "-1" ]
2. [ integer season = "-1" ]
3. [ Video.Fields.Episode properties ]
4. [ List.Limits limits ]
5. [ List.Sort sort ]
6. [ mixed filter ]

Returns:

Type: object
Properties:

• [ Video.Details.Episode[] episodes ]
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve all tv show episodes", "permission": "ReadData", "type": "method", "params": [ { "default": "-1", "$ref": "Library.Id", "name": "tvshowid" }, { "default": "-1", "type": "integer", "name": "season" }, { "$ref": "Video.Fields.Episode", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "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" } ], "name": "filter" } ], "returns": { "type": "object", "properties": { "episodes": { "items": { "$ref": "Video.Details.Episode" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

VideoLibrary.GetGenres

Retrieve all genres
Permissions:

• ReadData

Parameters:

1. string type
2. [ Library.Fields.Genre properties ]
3. [ List.Limits limits ]
4. [ List.Sort sort ]

Returns:

Type: object
Properties:

• Library.Details.Genre[] genres
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve all genres", "permission": "ReadData", "type": "method", "params": [ { "type": "string", "name": "type", "required": true }, { "$ref": "Library.Fields.Genre", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "genres": { "items": { "$ref": "Library.Details.Genre" }, "type": "array", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

VideoLibrary.GetInProgressTVShows

Retrieve all in progress tvshows
Permissions:

• ReadData

Parameters:

1. [ Video.Fields.TVShow properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Video.Details.TVShow[] tvshows ]

JSON Schema Description

{ "description": "Retrieve all in progress tvshows", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Video.Fields.TVShow", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "tvshows": { "items": { "$ref": "Video.Details.TVShow" }, "type": "array" } } } }

VideoLibrary.GetMovieDetails

Retrieve details about a specific movie
Permissions:

• ReadData

Parameters:

1. Library.Id movieid
2. [ Video.Fields.Movie properties ]

Returns:

Type: object
Properties:

• [ Video.Details.Movie moviedetails ]

JSON Schema Description
{ "description": "Retrieve details about a specific movie", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "movieid", "required": true }, { "$ref": "Video.Fields.Movie", "name": "properties" } ], "returns": { "type": "object", "properties": { "moviedetails": { "$ref": "Video.Details.Movie" } } } }

VideoLibrary.GetMovies

Retrieve all movies
Permissions:

• ReadData

Parameters:

1. [ Video.Fields.Movie properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]
4. [ mixed filter ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Video.Details.Movie[] movies ]

JSON Schema Description

{ "description": "Retrieve all movies", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Video.Fields.Movie", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "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" } ], "name": "filter" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "movies": { "items": { "$ref": "Video.Details.Movie" }, "type": "array" } } } }

VideoLibrary.GetMovieSetDetails

Retrieve details about a specific movie set
Permissions:

• ReadData

Parameters:

1. Library.Id setid
2. [ Video.Fields.MovieSet properties ]
3. [ mixed movies ]

Returns:

Type: object
Properties:

• [ Video.Details.MovieSet.Extended setdetails ]

JSON Schema Description
{ "description": "Retrieve details about a specific movie set", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "setid", "required": true }, { "$ref": "Video.Fields.MovieSet", "name": "properties" }, { "type": "object", "name": "movies" } ], "returns": { "type": "object", "properties": { "setdetails": { "$ref": "Video.Details.MovieSet.Extended" } } } }

VideoLibrary.GetMovieSets

Retrieve all movie sets
Permissions:

• ReadData

Parameters:

1. [ Video.Fields.MovieSet properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Video.Details.MovieSet[] sets ]

JSON Schema Description

{ "description": "Retrieve all movie sets", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Video.Fields.MovieSet", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "sets": { "items": { "$ref": "Video.Details.MovieSet" }, "type": "array" } } } }

VideoLibrary.GetMusicVideoDetails

Retrieve details about a specific music video
Permissions:

• ReadData

Parameters:

1. Library.Id musicvideoid
2. [ Video.Fields.MusicVideo properties ]

Returns:

Type: object
Properties:

• [ Video.Details.MusicVideo musicvideodetails ]

JSON Schema Description
{ "description": "Retrieve details about a specific music video", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "musicvideoid", "required": true }, { "$ref": "Video.Fields.MusicVideo", "name": "properties" } ], "returns": { "type": "object", "properties": { "musicvideodetails": { "$ref": "Video.Details.MusicVideo" } } } }

VideoLibrary.GetMusicVideos

Retrieve all music videos
Permissions:

• ReadData

Parameters:

1. [ Video.Fields.MusicVideo properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]
4. [ mixed filter ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Video.Details.MusicVideo[] musicvideos ]

JSON Schema Description

{ "description": "Retrieve all music videos", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Video.Fields.MusicVideo", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "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" } ], "name": "filter" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "musicvideos": { "items": { "$ref": "Video.Details.MusicVideo" }, "type": "array" } } } }

VideoLibrary.GetRecentlyAddedEpisodes

Retrieve all recently added tv episodes
Permissions:

• ReadData

Parameters:

1. [ Video.Fields.Episode properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]

Returns:

Type: object
Properties:

• [ Video.Details.Episode[] episodes ]
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve all recently added tv episodes", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Video.Fields.Episode", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "episodes": { "items": { "$ref": "Video.Details.Episode" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

VideoLibrary.GetRecentlyAddedMovies

Retrieve all recently added movies
Permissions:

• ReadData

Parameters:

1. [ Video.Fields.Movie properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Video.Details.Movie[] movies ]

JSON Schema Description

{ "description": "Retrieve all recently added movies", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Video.Fields.Movie", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "movies": { "items": { "$ref": "Video.Details.Movie" }, "type": "array" } } } }

VideoLibrary.GetRecentlyAddedMusicVideos

Retrieve all recently added music videos
Permissions:

• ReadData

Parameters:

1. [ Video.Fields.MusicVideo properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Video.Details.MusicVideo[] musicvideos ]

JSON Schema Description

{ "description": "Retrieve all recently added music videos", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Video.Fields.MusicVideo", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "musicvideos": { "items": { "$ref": "Video.Details.MusicVideo" }, "type": "array" } } } }

VideoLibrary.GetSeasonDetails

Retrieve details about a specific tv show season
Permissions:

• ReadData

Parameters:

1. Library.Id seasonid
2. [ Video.Fields.Season properties ]

Returns:

Type: object
Properties:

• [ Video.Details.Season seasondetails ]

JSON Schema Description
{ "description": "Retrieve details about a specific tv show season", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "seasonid", "required": true }, { "$ref": "Video.Fields.Season", "name": "properties" } ], "returns": { "type": "object", "properties": { "seasondetails": { "$ref": "Video.Details.Season" } } } }

VideoLibrary.GetSeasons

Retrieve all tv seasons
Permissions:

• ReadData

Parameters:

1. [ Library.Id tvshowid = "-1" ]
2. [ Video.Fields.Season properties ]
3. [ List.Limits limits ]
4. [ List.Sort sort ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Video.Details.Season[] seasons ]

JSON Schema Description

{ "description": "Retrieve all tv seasons", "permission": "ReadData", "type": "method", "params": [ { "default": "-1", "$ref": "Library.Id", "name": "tvshowid" }, { "$ref": "Video.Fields.Season", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "seasons": { "items": { "$ref": "Video.Details.Season" }, "type": "array" } } } }

VideoLibrary.GetTags

Retrieve all tags
Permissions:

• ReadData

Parameters:

1. string type
2. [ Library.Fields.Tag properties ]
3. [ List.Limits limits ]
4. [ List.Sort sort ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• Library.Details.Tag[] tags

JSON Schema Description

{ "description": "Retrieve all tags", "permission": "ReadData", "type": "method", "params": [ { "type": "string", "name": "type", "required": true }, { "$ref": "Library.Fields.Tag", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "tags": { "items": { "$ref": "Library.Details.Tag" }, "type": "array", "required": true } } } }

VideoLibrary.GetTVShowDetails

Retrieve details about a specific tv show
Permissions:

• ReadData

Parameters:

1. Library.Id tvshowid
2. [ Video.Fields.TVShow properties ]

Returns:

Type: object
Properties:

• [ Video.Details.TVShow tvshowdetails ]

JSON Schema Description
{ "description": "Retrieve details about a specific tv show", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "tvshowid", "required": true }, { "$ref": "Video.Fields.TVShow", "name": "properties" } ], "returns": { "type": "object", "properties": { "tvshowdetails": { "$ref": "Video.Details.TVShow" } } } }

VideoLibrary.GetTVShows

Retrieve all tv shows
Permissions:

• ReadData

Parameters:

1. [ Video.Fields.TVShow properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]
4. [ mixed filter ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Video.Details.TVShow[] tvshows ]

JSON Schema Description

{ "description": "Retrieve all tv shows", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Video.Fields.TVShow", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "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" } ], "name": "filter" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "tvshows": { "items": { "$ref": "Video.Details.TVShow" }, "type": "array" } } } }

VideoLibrary.RefreshEpisode

Refresh the given episode in the library
Permissions:

• UpdateData

Parameters:

1. Library.Id episodeid
2. [ boolean ignorenfo = false ] Whether or not to ignore a local NFO if present.
3. [ string title ] Title to use for searching (instead of determining it from the item's filename/path).

Returns:

Type: string

JSON Schema Description

{ "description": "Refresh the given episode in the library", "permission": "UpdateData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "episodeid", "required": true }, { "default": "false", "description": "Whether or not to ignore a local NFO if present.", "type": "boolean", "name": "ignorenfo" }, { "default": "", "description": "Title to use for searching (instead of determining it from the item's filename/path).", "type": "string", "name": "title" } ], "returns": { "type": "string" } }

VideoLibrary.RefreshMovie

Refresh the given movie in the library
Permissions:

• UpdateData

Parameters:

1. Library.Id movieid
2. [ boolean ignorenfo = false ] Whether or not to ignore a local NFO if present.
3. [ string title ] Title to use for searching (instead of determining it from the item's filename/path).

Returns:

Type: string

JSON Schema Description

{ "description": "Refresh the given movie in the library", "permission": "UpdateData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "movieid", "required": true }, { "default": "false", "description": "Whether or not to ignore a local NFO if present.", "type": "boolean", "name": "ignorenfo" }, { "default": "", "description": "Title to use for searching (instead of determining it from the item's filename/path).", "type": "string", "name": "title" } ], "returns": { "type": "string" } }

VideoLibrary.RefreshMusicVideo

Refresh the given music video in the library
Permissions:

• UpdateData

Parameters:

1. Library.Id musicvideoid
2. [ boolean ignorenfo = false ] Whether or not to ignore a local NFO if present.
3. [ string title ] Title to use for searching (instead of determining it from the item's filename/path).

Returns:

Type: string

JSON Schema Description

{ "description": "Refresh the given music video in the library", "permission": "UpdateData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "musicvideoid", "required": true }, { "default": "false", "description": "Whether or not to ignore a local NFO if present.", "type": "boolean", "name": "ignorenfo" }, { "default": "", "description": "Title to use for searching (instead of determining it from the item's filename/path).", "type": "string", "name": "title" } ], "returns": { "type": "string" } }

VideoLibrary.RefreshTVShow

Refresh the given tv show in the library
Permissions:

• UpdateData

Parameters:

1. Library.Id tvshowid
2. [ boolean ignorenfo = false ] Whether or not to ignore a local NFO if present.
3. [ boolean refreshepisodes = false ] Whether or not to refresh all episodes belonging to the TV show.
4. [ string title ] Title to use for searching (instead of determining it from the item's filename/path).

Returns:

Type: string

JSON Schema Description

{ "description": "Refresh the given tv show in the library", "permission": "UpdateData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "tvshowid", "required": true }, { "default": "false", "description": "Whether or not to ignore a local NFO if present.", "type": "boolean", "name": "ignorenfo" }, { "default": "false", "description": "Whether or not to refresh all episodes belonging to the TV show.", "type": "boolean", "name": "refreshepisodes" }, { "default": "", "description": "Title to use for searching (instead of determining it from the item's filename/path).", "type": "string", "name": "title" } ], "returns": { "type": "string" } }

VideoLibrary.RemoveEpisode

Removes the given episode from the library
Permissions:

• RemoveData

Parameters:

1. Library.Id episodeid

Returns:

Type: string

JSON Schema Description
{ "description": "Removes the given episode from the library", "permission": "RemoveData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "episodeid", "required": true } ], "returns": { "type": "string" } }

VideoLibrary.RemoveMovie

Removes the given movie from the library
Permissions:

• RemoveData

Parameters:

1. Library.Id movieid

Returns:

Type: string

JSON Schema Description
{ "description": "Removes the given movie from the library", "permission": "RemoveData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "movieid", "required": true } ], "returns": { "type": "string" } }

VideoLibrary.RemoveMusicVideo

Removes the given music video from the library
Permissions:

• RemoveData

Parameters:

1. Library.Id musicvideoid

Returns:

Type: string

JSON Schema Description
{ "description": "Removes the given music video from the library", "permission": "RemoveData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "musicvideoid", "required": true } ], "returns": { "type": "string" } }

VideoLibrary.RemoveTVShow

Removes the given tv show from the library
Permissions:

• RemoveData

Parameters:

1. Library.Id tvshowid

Returns:

Type: string

JSON Schema Description
{ "description": "Removes the given tv show from the library", "permission": "RemoveData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "tvshowid", "required": true } ], "returns": { "type": "string" } }

VideoLibrary.Scan

Scans the video sources for new library items
Permissions:

• UpdateData

Parameters:

1. [ string directory ]
2. [ boolean showdialogs = true ] Whether or not to show the progress bar or any other GUI dialog

Returns:

Type: string

JSON Schema Description
{ "description": "Scans the video sources for new library items", "permission": "UpdateData", "type": "method", "params": [ { "default": "", "type": "string", "name": "directory" }, { "default": "true", "description": "Whether or not to show the progress bar or any other GUI dialog", "type": "boolean", "name": "showdialogs" } ], "returns": { "type": "string" } }

VideoLibrary.SetEpisodeDetails

Update the given episode with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id episodeid
2. [ Optional.String title ]
3. [ Optional.Integer playcount ]
4. [ Optional.Integer runtime ] Runtime in seconds
5. [ mixed director ]
6. [ Optional.String plot ]
7. [ Optional.Number rating ]
8. [ Optional.String votes ]
9. [ Optional.String lastplayed ]
10. [ mixed writer ]
11. [ Optional.String firstaired ]
12. [ Optional.String productioncode ]
13. [ Optional.Integer season ]
14. [ Optional.Integer episode ]
15. [ Optional.String originaltitle ]
16. [ Optional.String thumbnail ]
17. [ Optional.String fanart ]
18. [ mixed art ]
19. [ mixed resume ]
20. [ Optional.Integer userrating ]
21. [ Video.Ratings.Set ratings ]
22. [ Optional.String dateadded ]
23. [ mixed uniqueid ]

Returns:

Type: string

JSON Schema Description

{ "description": "Update the given episode with the given details", "permission": "UpdateData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "episodeid", "required": true }, { "$ref": "Optional.String", "name": "title" }, { "$ref": "Optional.Integer", "name": "playcount" }, { "description": "Runtime in seconds", "$ref": "Optional.Integer", "name": "runtime" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "director" }, { "$ref": "Optional.String", "name": "plot" }, { "$ref": "Optional.Number", "name": "rating" }, { "$ref": "Optional.String", "name": "votes" }, { "$ref": "Optional.String", "name": "lastplayed" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "writer" }, { "$ref": "Optional.String", "name": "firstaired" }, { "$ref": "Optional.String", "name": "productioncode" }, { "$ref": "Optional.Integer", "name": "season" }, { "$ref": "Optional.Integer", "name": "episode" }, { "$ref": "Optional.String", "name": "originaltitle" }, { "$ref": "Optional.String", "name": "thumbnail" }, { "$ref": "Optional.String", "name": "fanart" }, { "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ], "name": "art" }, { "type": [ { "type": "null" }, { "$ref": "Video.Resume" } ], "name": "resume" }, { "$ref": "Optional.Integer", "name": "userrating" }, { "$ref": "Video.Ratings.Set", "name": "ratings" }, { "$ref": "Optional.String", "name": "dateadded" }, { "type": [ { "type": "null" }, { "$ref": "Media.UniqueID.Set" } ], "name": "uniqueid" } ], "returns": { "type": "string" } }

VideoLibrary.SetMovieDetails

Update the given movie with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id movieid
2. [ Optional.String title ]
3. [ Optional.Integer playcount ]
4. [ Optional.Integer runtime ] Runtime in seconds
5. [ mixed director ]
6. [ mixed studio ]
7. [ Optional.Integer year ] linked with premiered. Overridden by premiered parameter
8. [ Optional.String plot ]
9. [ mixed genre ]
10. [ Optional.Number rating ]
11. [ Optional.String mpaa ]
12. [ Optional.String imdbnumber ]
13. [ Optional.String votes ]
14. [ Optional.String lastplayed ]
15. [ Optional.String originaltitle ]
16. [ Optional.String trailer ]
17. [ Optional.String tagline ]
18. [ Optional.String plotoutline ]
19. [ mixed writer ]
20. [ mixed country ]
21. [ Optional.Integer top250 ]
22. [ Optional.String sorttitle ]
23. [ Optional.String set ]
24. [ mixed showlink ]
25. [ Optional.String thumbnail ]
26. [ Optional.String fanart ]
27. [ mixed tag ]
28. [ mixed art ]
29. [ mixed resume ]
30. [ Optional.Integer userrating ]
31. [ Video.Ratings.Set ratings ]
32. [ Optional.String dateadded ]
33. [ Optional.String premiered ] linked with year. Overriedes year
34. [ mixed uniqueid ]

Returns:

Type: string

JSON Schema Description

{ "description": "Update the given movie with the given details", "permission": "UpdateData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "movieid", "required": true }, { "$ref": "Optional.String", "name": "title" }, { "$ref": "Optional.Integer", "name": "playcount" }, { "description": "Runtime in seconds", "$ref": "Optional.Integer", "name": "runtime" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "director" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "studio" }, { "description": "linked with premiered. Overridden by premiered parameter", "$ref": "Optional.Integer", "name": "year" }, { "$ref": "Optional.String", "name": "plot" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "genre" }, { "$ref": "Optional.Number", "name": "rating" }, { "$ref": "Optional.String", "name": "mpaa" }, { "$ref": "Optional.String", "name": "imdbnumber" }, { "$ref": "Optional.String", "name": "votes" }, { "$ref": "Optional.String", "name": "lastplayed" }, { "$ref": "Optional.String", "name": "originaltitle" }, { "$ref": "Optional.String", "name": "trailer" }, { "$ref": "Optional.String", "name": "tagline" }, { "$ref": "Optional.String", "name": "plotoutline" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "writer" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "country" }, { "$ref": "Optional.Integer", "name": "top250" }, { "$ref": "Optional.String", "name": "sorttitle" }, { "$ref": "Optional.String", "name": "set" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "showlink" }, { "$ref": "Optional.String", "name": "thumbnail" }, { "$ref": "Optional.String", "name": "fanart" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "tag" }, { "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ], "name": "art" }, { "type": [ { "type": "null" }, { "$ref": "Video.Resume" } ], "name": "resume" }, { "$ref": "Optional.Integer", "name": "userrating" }, { "$ref": "Video.Ratings.Set", "name": "ratings" }, { "$ref": "Optional.String", "name": "dateadded" }, { "description": "linked with year. Overriedes year", "$ref": "Optional.String", "name": "premiered" }, { "type": [ { "type": "null" }, { "$ref": "Media.UniqueID.Set" } ], "name": "uniqueid" } ], "returns": { "type": "string" } }

VideoLibrary.SetMovieSetDetails

Update the given movie set with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id setid
2. [ Optional.String title ]
3. [ mixed art ]

Returns:

Type: string

JSON Schema Description
{ "description": "Update the given movie set with the given details", "permission": "UpdateData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "setid", "required": true }, { "$ref": "Optional.String", "name": "title" }, { "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ], "name": "art" } ], "returns": { "type": "string" } }

VideoLibrary.SetMusicVideoDetails

Update the given music video with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id musicvideoid
2. [ Optional.String title ]
3. [ Optional.Integer playcount ]
4. [ Optional.Integer runtime ] Runtime in seconds
5. [ mixed director ]
6. [ mixed studio ]
7. [ Optional.Integer year ] linked with premiered. Overridden by premiered parameter
8. [ Optional.String plot ]
9. [ Optional.String album ]
10. [ mixed artist ]
11. [ mixed genre ]
12. [ Optional.Integer track ]
13. [ Optional.String lastplayed ]
14. [ Optional.String thumbnail ]
15. [ Optional.String fanart ]
16. [ mixed tag ]
17. [ mixed art ]
18. [ mixed resume ]
19. [ Optional.Number rating ]
20. [ Optional.Integer userrating ]
21. [ Optional.String dateadded ]
22. [ Optional.String premiered ] linked with year. Overriedes year

Returns:

Type: string

JSON Schema Description

{ "description": "Update the given music video with the given details", "permission": "UpdateData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "musicvideoid", "required": true }, { "$ref": "Optional.String", "name": "title" }, { "$ref": "Optional.Integer", "name": "playcount" }, { "description": "Runtime in seconds", "$ref": "Optional.Integer", "name": "runtime" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "director" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "studio" }, { "description": "linked with premiered. Overridden by premiered parameter", "$ref": "Optional.Integer", "name": "year" }, { "$ref": "Optional.String", "name": "plot" }, { "$ref": "Optional.String", "name": "album" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "artist" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "genre" }, { "$ref": "Optional.Integer", "name": "track" }, { "$ref": "Optional.String", "name": "lastplayed" }, { "$ref": "Optional.String", "name": "thumbnail" }, { "$ref": "Optional.String", "name": "fanart" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "tag" }, { "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ], "name": "art" }, { "type": [ { "type": "null" }, { "$ref": "Video.Resume" } ], "name": "resume" }, { "$ref": "Optional.Number", "name": "rating" }, { "$ref": "Optional.Integer", "name": "userrating" }, { "$ref": "Optional.String", "name": "dateadded" }, { "description": "linked with year. Overriedes year", "$ref": "Optional.String", "name": "premiered" } ], "returns": { "type": "string" } }

VideoLibrary.SetSeasonDetails

Update the given season with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id seasonid
2. [ mixed art ]
3. [ Optional.Integer userrating ]

Returns:

Type: string

JSON Schema Description
{ "description": "Update the given season with the given details", "permission": "UpdateData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "seasonid", "required": true }, { "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ], "name": "art" }, { "$ref": "Optional.Integer", "name": "userrating" } ], "returns": { "type": "string" } }

VideoLibrary.SetTVShowDetails

Update the given tvshow with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id tvshowid
2. [ Optional.String title ]
3. [ Optional.Integer playcount ]
4. [ mixed studio ]
5. [ Optional.String plot ]
6. [ mixed genre ]
7. [ Optional.Number rating ]
8. [ Optional.String mpaa ]
9. [ Optional.String imdbnumber ]
10. [ Optional.String premiered ]
11. [ Optional.String votes ]
12. [ Optional.String lastplayed ]
13. [ Optional.String originaltitle ]
14. [ Optional.String sorttitle ]
15. [ Optional.String episodeguide ]
16. [ Optional.String thumbnail ]
17. [ Optional.String fanart ]
18. [ mixed tag ]
19. [ mixed art ]
20. [ Optional.Integer userrating ]
21. [ Video.Ratings.Set ratings ]
22. [ Optional.String dateadded ]
23. [ Optional.Integer runtime ] Runtime in seconds
24. [ Optional.String status ]
25. [ mixed uniqueid ]

Returns:

Type: string

JSON Schema Description

{ "description": "Update the given tvshow with the given details", "permission": "UpdateData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "tvshowid", "required": true }, { "$ref": "Optional.String", "name": "title" }, { "$ref": "Optional.Integer", "name": "playcount" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "studio" }, { "$ref": "Optional.String", "name": "plot" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "genre" }, { "$ref": "Optional.Number", "name": "rating" }, { "$ref": "Optional.String", "name": "mpaa" }, { "$ref": "Optional.String", "name": "imdbnumber" }, { "$ref": "Optional.String", "name": "premiered" }, { "$ref": "Optional.String", "name": "votes" }, { "$ref": "Optional.String", "name": "lastplayed" }, { "$ref": "Optional.String", "name": "originaltitle" }, { "$ref": "Optional.String", "name": "sorttitle" }, { "$ref": "Optional.String", "name": "episodeguide" }, { "$ref": "Optional.String", "name": "thumbnail" }, { "$ref": "Optional.String", "name": "fanart" }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "tag" }, { "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ], "name": "art" }, { "$ref": "Optional.Integer", "name": "userrating" }, { "$ref": "Video.Ratings.Set", "name": "ratings" }, { "$ref": "Optional.String", "name": "dateadded" }, { "description": "Runtime in seconds", "$ref": "Optional.Integer", "name": "runtime" }, { "$ref": "Optional.String", "name": "status" }, { "type": [ { "type": "null" }, { "$ref": "Media.UniqueID.Set" } ], "name": "uniqueid" } ], "returns": { "type": "string" } }

XBMC

XBMC.GetInfoBooleans

Retrieve info booleans about Kodi and the system
Permissions:

• ReadData

Parameters:

1. string[] booleans

Returns:

Type: object

Description: Object containing key-value pairs of the retrieved info booleans

JSON Schema Description
{ "description": "Retrieve info booleans about Kodi and the system", "permission": "ReadData", "type": "method", "params": [ { "items": { "type": "string" }, "type": "array", "name": "booleans", "required": true } ], "returns": { "type": "object", "description": "Object containing key-value pairs of the retrieved info booleans", "additionalProperties": { "default": "", "type": "string" } } }

XBMC.GetInfoLabels

Retrieve info labels about Kodi and the system
Permissions:

• ReadData

Parameters:

1. string[] labels See http://kodi.wiki/view/InfoLabels for a list of possible info labels

Returns:

Type: object

Description: Object containing key-value pairs of the retrieved info labels

JSON Schema Description

{ "description": "Retrieve info labels about Kodi and the system", "permission": "ReadData", "type": "method", "params": [ { "description": "See http://kodi.wiki/view/InfoLabels for a list of possible info labels", "items": { "type": "string" }, "type": "array", "name": "labels", "required": true } ], "returns": { "type": "object", "description": "Object containing key-value pairs of the retrieved info labels", "additionalProperties": { "default": "", "type": "string" } } }

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:

• Item.Details.Base

Properties:

• string addonid
• [ string author ]
• [ mixed: boolean|string broken ]
• [ object dependencies ]
• [ string description ]
• [ string disclaimer ]
• [ boolean enabled = false ]
• [ object extrainfo ]
• [ string fanart ]
• [ boolean installed = false ]
• [ string name ]
• [ string path ]
• [ integer rating = "0" ]
• [ string summary ]
• [ string thumbnail ]
• Addon.Types type
• [ string version ]

JSON Schema Description

{ "extends": [ "Item.Details.Base" ], "id": "Addon.Details", "properties": { "addonid": { "type": "string", "name": "addonid", "required": true }, "author": { "default": "", "type": "string", "name": "author" }, "broken": { "type": [ { "type": "boolean" }, { "type": "string" } ], "name": "broken" }, "dependencies": { "items": { "properties": { "addonid": { "required": true, "type": "string" }, "optional": { "required": true, "type": "boolean" }, "version": { "required": true, "type": "string" } }, "type": "object" }, "type": "array", "name": "dependencies" }, "description": { "default": "", "type": "string", "name": "description" }, "disclaimer": { "default": "", "type": "string", "name": "disclaimer" }, "enabled": { "default": "false", "type": "boolean", "name": "enabled" }, "extrainfo": { "items": { "properties": { "key": { "required": true, "type": "string" }, "value": { "required": true, "type": "string" } }, "type": "object" }, "type": "array", "name": "extrainfo" }, "fanart": { "default": "", "type": "string", "name": "fanart" }, "installed": { "default": "false", "type": "boolean", "name": "installed" }, "name": { "default": "", "type": "string", "name": "name" }, "path": { "default": "", "type": "string", "name": "path" }, "rating": { "default": "0", "type": "integer", "name": "rating" }, "summary": { "default": "", "type": "string", "name": "summary" }, "thumbnail": { "default": "", "type": "string", "name": "thumbnail" }, "type": { "$ref": "Addon.Types", "name": "type", "required": true }, "version": { "default": "", "type": "string", "name": "version" } } }

Addon.Fields

Extends:

• Item.Fields.Base

JSON Schema Description
{ "extends": [ "Item.Fields.Base" ], "id": "Addon.Fields", "items": { "enums": [ "name", "version", "summary", "description", "path", "author", "thumbnail", "disclaimer", "fanart", "dependencies", "broken", "extrainfo", "rating", "enabled", "installed" ], "type": "string" } }

Addon.Types

Type: string

JSON Schema Description

{ "enums": [ "unknown", "xbmc.player.musicviz", "xbmc.gui.skin", "xbmc.pvrclient", "kodi.adsp", "kodi.inputstream", "kodi.peripheral", "xbmc.python.script", "xbmc.python.weather", "xbmc.subtitle.module", "xbmc.python.lyrics", "xbmc.metadata.scraper.albums", "xbmc.metadata.scraper.artists", "xbmc.metadata.scraper.movies", "xbmc.metadata.scraper.musicvideos", "xbmc.metadata.scraper.tvshows", "xbmc.ui.screensaver", "xbmc.python.pluginsource", "xbmc.addon.repository", "xbmc.webinterface", "xbmc.service", "xbmc.audioencoder", "kodi.context.item", "kodi.audiodecoder", "kodi.resource.images", "kodi.resource.language", "kodi.resource.uisounds", "xbmc.addon.video", "xbmc.addon.audio", "xbmc.addon.image", "xbmc.addon.executable", "xbmc.metadata.scraper.library", "xbmc.python.library", "xbmc.python.module", "kodi.game.controller" ], "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: mixed
Properties:

• [ boolean muted = false ]
• [ string name ]
• [ mixed version ]
• [ integer volume = "0" ]

JSON Schema Description
{ "id": "Application.Property.Value", "type": "object", "properties": { "muted": { "default": "false", "type": "boolean", "name": "muted" }, "name": { "default": "", "type": "string", "name": "name" }, "version": { "type": "object", "name": "version" }, "volume": { "default": "0", "type": "integer", "name": "volume" } } }

Array

Array.Integer

Type: mixed

JSON Schema Description
{ "id": "Array.Integer", "type": "array", "items": { "type": "integer" } }

Array.String

Type: mixed

JSON Schema Description
{ "id": "Array.String", "type": "array", "items": { "minLength": 1, "type": "string" } }

Audio

Audio.Album.ReleaseType

Type: string

JSON Schema Description
{ "enums": [ "album", "single" ], "id": "Audio.Album.ReleaseType", "type": "string", "default": "album" }

Audio.Artist.Roles

Type: mixed

JSON Schema Description
{ "id": "Audio.Artist.Roles", "type": "array", "items": { "additionalProperties": false, "description": "The various roles contributed by an artist to one or more songs", "properties": { "role": { "required": true, "type": "string" }, "roleid": { "$ref": "Library.Id", "required": true } }, "type": "object" } }

Audio.Contributors

Type: mixed

JSON Schema Description

{ "id": "Audio.Contributors", "type": "array", "items": { "additionalProperties": false, "description": "The artist and the role they contribute to a song", "properties": { "artistid": { "$ref": "Library.Id", "required": true }, "name": { "required": true, "type": "string" }, "role": { "required": true, "type": "string" }, "roleid": { "$ref": "Library.Id", "required": true } }, "type": "object" } }

Audio.Details.Album

Extends:

• Audio.Details.Media

Properties:

• Library.Id albumid
• [ string albumlabel ]
• [ boolean compilation = false ]
• [ string description ]
• [ Array.String mood ]
• [ integer playcount = "0" ]
• [ Audio.Album.ReleaseType releasetype = "album" ]
• [ Array.String style ]
• [ Array.String theme ]
• [ string type ]

JSON Schema Description

{ "extends": [ "Audio.Details.Media" ], "id": "Audio.Details.Album", "properties": { "albumid": { "$ref": "Library.Id", "name": "albumid", "required": true }, "albumlabel": { "default": "", "type": "string", "name": "albumlabel" }, "compilation": { "default": "false", "type": "boolean", "name": "compilation" }, "description": { "default": "", "type": "string", "name": "description" }, "mood": { "$ref": "Array.String", "name": "mood" }, "playcount": { "default": "0", "type": "integer", "name": "playcount" }, "releasetype": { "default": "album", "$ref": "Audio.Album.ReleaseType", "name": "releasetype" }, "style": { "$ref": "Array.String", "name": "style" }, "theme": { "$ref": "Array.String", "name": "theme" }, "type": { "default": "", "type": "string", "name": "type" } } }

Audio.Details.Artist

Extends:

• Audio.Details.Base

Properties:

• string artist
• Library.Id artistid
• [ string born ]
• [ boolean compilationartist = false ]
• [ string description ]
• [ string died ]
• [ string disbanded ]
• [ string formed ]
• [ Array.String instrument ]
• [ boolean isalbumartist = false ]
• [ Array.String mood ]
• [ string musicbrainzartistid ]
• [ Audio.Artist.Roles roles ]
• [ Audio.Details.Genres songgenres ]
• [ Array.String style ]
• [ Array.String yearsactive ]

JSON Schema Description

{ "extends": [ "Audio.Details.Base" ], "id": "Audio.Details.Artist", "properties": { "artist": { "type": "string", "name": "artist", "required": true }, "artistid": { "$ref": "Library.Id", "name": "artistid", "required": true }, "born": { "default": "", "type": "string", "name": "born" }, "compilationartist": { "default": "false", "type": "boolean", "name": "compilationartist" }, "description": { "default": "", "type": "string", "name": "description" }, "died": { "default": "", "type": "string", "name": "died" }, "disbanded": { "default": "", "type": "string", "name": "disbanded" }, "formed": { "default": "", "type": "string", "name": "formed" }, "instrument": { "$ref": "Array.String", "name": "instrument" }, "isalbumartist": { "default": "false", "type": "boolean", "name": "isalbumartist" }, "mood": { "$ref": "Array.String", "name": "mood" }, "musicbrainzartistid": { "default": "", "type": "string", "name": "musicbrainzartistid" }, "roles": { "$ref": "Audio.Artist.Roles", "name": "roles" }, "songgenres": { "$ref": "Audio.Details.Genres", "name": "songgenres" }, "style": { "$ref": "Array.String", "name": "style" }, "yearsactive": { "$ref": "Array.String", "name": "yearsactive" } } }

Audio.Details.Base

Extends:

• Media.Details.Base

Properties:

• [ string dateadded ]
• [ Array.String genre ]

JSON Schema Description
{ "extends": [ "Media.Details.Base" ], "id": "Audio.Details.Base", "properties": { "dateadded": { "default": "", "type": "string", "name": "dateadded" }, "genre": { "$ref": "Array.String", "name": "genre" } } }

Audio.Details.Genres

Type: mixed

JSON Schema Description
{ "id": "Audio.Details.Genres", "type": "array", "items": { "properties": { "genreid": { "$ref": "Library.Id", "required": true }, "title": { "default": "", "type": "string" } }, "type": "object" } }

Audio.Details.Media

Extends:

• Audio.Details.Base

Properties:

• [ Array.String artist ]
• [ Array.Integer artistid ]
• [ string displayartist ]
• [ Array.Integer genreid ]
• [ string musicbrainzalbumartistid ]
• [ string musicbrainzalbumid ]
• [ number rating = "0" ]
• [ string title ]
• [ integer userrating = "0" ]
• [ integer votes = "0" ]
• [ integer year = "0" ]

JSON Schema Description

{ "extends": [ "Audio.Details.Base" ], "id": "Audio.Details.Media", "properties": { "artist": { "$ref": "Array.String", "name": "artist" }, "artistid": { "$ref": "Array.Integer", "name": "artistid" }, "displayartist": { "default": "", "type": "string", "name": "displayartist" }, "genreid": { "$ref": "Array.Integer", "name": "genreid" }, "musicbrainzalbumartistid": { "default": "", "type": "string", "name": "musicbrainzalbumartistid" }, "musicbrainzalbumid": { "default": "", "type": "string", "name": "musicbrainzalbumid" }, "rating": { "default": "0", "type": "number", "name": "rating" }, "title": { "default": "", "type": "string", "name": "title" }, "userrating": { "default": "0", "type": "integer", "name": "userrating" }, "votes": { "default": "0", "type": "integer", "name": "votes" }, "year": { "default": "0", "type": "integer", "name": "year" } } }

Audio.Details.Role

Extends:

• Item.Details.Base

Properties:

• Library.Id roleid
• [ string title ]

JSON Schema Description
{ "extends": [ "Item.Details.Base" ], "id": "Audio.Details.Role", "properties": { "roleid": { "$ref": "Library.Id", "name": "roleid", "required": true }, "title": { "default": "", "type": "string", "name": "title" } } }

Audio.Details.Song

Extends:

• Audio.Details.Media

Properties:

• [ string album ]
• [ Array.String albumartist ]
• [ Array.Integer albumartistid ]
• [ Library.Id albumid = "-1" ]
• [ Audio.Album.ReleaseType albumreleasetype = "album" ]
• [ string comment ]
• [ Audio.Contributors contributors ]
• [ integer disc = "0" ]
• [ string displaycomposer ]
• [ string displayconductor ]
• [ string displaylyricist ]
• [ string displayorchestra ]
• [ integer duration = "0" ]
• [ string file ]
• [ string lastplayed ]
• [ string lyrics ]
• [ string mood ]
• [ string musicbrainzartistid ]
• [ string musicbrainztrackid ]
• [ integer playcount = "0" ]
• Library.Id songid
• [ integer track = "0" ]

JSON Schema Description

{ "extends": [ "Audio.Details.Media" ], "id": "Audio.Details.Song", "properties": { "album": { "default": "", "type": "string", "name": "album" }, "albumartist": { "$ref": "Array.String", "name": "albumartist" }, "albumartistid": { "$ref": "Array.Integer", "name": "albumartistid" }, "albumid": { "default": "-1", "$ref": "Library.Id", "name": "albumid" }, "albumreleasetype": { "default": "album", "$ref": "Audio.Album.ReleaseType", "name": "albumreleasetype" }, "comment": { "default": "", "type": "string", "name": "comment" }, "contributors": { "$ref": "Audio.Contributors", "name": "contributors" }, "disc": { "default": "0", "type": "integer", "name": "disc" }, "displaycomposer": { "default": "", "type": "string", "name": "displaycomposer" }, "displayconductor": { "default": "", "type": "string", "name": "displayconductor" }, "displaylyricist": { "default": "", "type": "string", "name": "displaylyricist" }, "displayorchestra": { "default": "", "type": "string", "name": "displayorchestra" }, "duration": { "default": "0", "type": "integer", "name": "duration" }, "file": { "default": "", "type": "string", "name": "file" }, "lastplayed": { "default": "", "type": "string", "name": "lastplayed" }, "lyrics": { "default": "", "type": "string", "name": "lyrics" }, "mood": { "default": "", "type": "string", "name": "mood" }, "musicbrainzartistid": { "default": "", "type": "string", "name": "musicbrainzartistid" }, "musicbrainztrackid": { "default": "", "type": "string", "name": "musicbrainztrackid" }, "playcount": { "default": "0", "type": "integer", "name": "playcount" }, "songid": { "$ref": "Library.Id", "name": "songid", "required": true }, "track": { "default": "0", "type": "integer", "name": "track" } } }

Audio.Fields.Album

Extends:

• Item.Fields.Base

JSON Schema Description

{ "extends": [ "Item.Fields.Base" ], "id": "Audio.Fields.Album", "items": { "description": "Requesting the genreid and/or artistid field will result in increased response times", "enums": [ "title", "description", "artist", "genre", "theme", "mood", "style", "type", "albumlabel", "rating", "votes", "userrating", "year", "musicbrainzalbumid", "musicbrainzalbumartistid", "fanart", "thumbnail", "playcount", "genreid", "artistid", "displayartist", "compilation", "releasetype", "dateadded" ], "type": "string" } }

Audio.Fields.Artist

Extends:

• Item.Fields.Base

JSON Schema Description

{ "extends": [ "Item.Fields.Base" ], "id": "Audio.Fields.Artist", "items": { "description": "Requesting the (song)genreid/genre, or roleid/role fields will result in increased response times", "enums": [ "instrument", "style", "mood", "born", "formed", "description", "genre", "died", "disbanded", "yearsactive", "musicbrainzartistid", "fanart", "thumbnail", "compilationartist", "dateadded", "roles", "songgenres", "isalbumartist" ], "type": "string" } }

Audio.Fields.Role

Extends:

• Item.Fields.Base

JSON Schema Description
{ "extends": [ "Item.Fields.Base" ], "id": "Audio.Fields.Role", "items": { "enums": [ "title" ], "type": "string" } }

Audio.Fields.Song

Extends:

• Item.Fields.Base

JSON Schema Description

{ "extends": [ "Item.Fields.Base" ], "id": "Audio.Fields.Song", "items": { "description": "Requesting the genreid, artistid and/or albumartistid field will result in increased response times", "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", "albumreleasetype", "dateadded", "votes", "userrating", "mood", "contributors", "displaycomposer", "displayconductor", "displayorchestra", "displaylyricist" ], "type": "string" } }

Audio.Property.Name

Type: string

JSON Schema Description
{ "enums": [ "missingartistid" ], "id": "Audio.Property.Name", "type": "string", "default": "missingartistid" }

Audio.Property.Value

Type: mixed
Properties:

• [ Library.Id missingartistid = "-1" ]

JSON Schema Description
{ "id": "Audio.Property.Value", "type": "object", "properties": { "missingartistid": { "default": "-1", "$ref": "Library.Id", "name": "missingartistid" } } }

Configuration

Configuration.Configuration

Type: mixed
Properties:

• Configuration.Notifications notifications

JSON Schema Description
{ "id": "Configuration", "type": "object", "properties": { "notifications": { "$ref": "Configuration.Notifications", "name": "notifications", "required": true } } }

Configuration.Notifications

Type: mixed
Properties:

• boolean application
• boolean audiolibrary
• boolean gui
• boolean input
• boolean other
• boolean player
• boolean playlist
• boolean pvr
• boolean system
• boolean videolibrary

JSON Schema Description

{ "id": "Configuration.Notifications", "type": "object", "properties": { "application": { "type": "boolean", "name": "application", "required": true }, "audiolibrary": { "type": "boolean", "name": "audiolibrary", "required": true }, "gui": { "type": "boolean", "name": "gui", "required": true }, "input": { "type": "boolean", "name": "input", "required": true }, "other": { "type": "boolean", "name": "other", "required": true }, "player": { "type": "boolean", "name": "player", "required": true }, "playlist": { "type": "boolean", "name": "playlist", "required": true }, "pvr": { "type": "boolean", "name": "pvr", "required": true }, "system": { "type": "boolean", "name": "system", "required": true }, "videolibrary": { "type": "boolean", "name": "videolibrary", "required": true } } }

Favourite

Favourite.Details.Favourite

Type: mixed
Properties:

• [ string path ]
• [ string thumbnail ]
• string title
• Favourite.Type type
• [ string window ]
• [ string windowparameter ]

JSON Schema Description

{ "id": "Favourite.Details.Favourite", "type": "object", "properties": { "path": { "default": "", "type": "string", "name": "path" }, "thumbnail": { "default": "", "type": "string", "name": "thumbnail" }, "title": { "type": "string", "name": "title", "required": true }, "type": { "$ref": "Favourite.Type", "name": "type", "required": true }, "window": { "default": "", "type": "string", "name": "window" }, "windowparameter": { "default": "", "type": "string", "name": "windowparameter" } } }

Favourite.Fields.Favourite

Extends:

• Item.Fields.Base

JSON Schema Description
{ "extends": [ "Item.Fields.Base" ], "id": "Favourite.Fields.Favourite", "items": { "enums": [ "window", "windowparameter", "thumbnail", "path" ], "type": "string" } }

Favourite.Type

Type: string

JSON Schema Description
{ "enums": [ "media", "window", "script", "unknown" ], "id": "Favourite.Type", "type": "string", "default": "media" }

Files

Files.Media

Type: string

JSON Schema Description
{ "enums": [ "video", "music", "pictures", "files", "programs" ], "id": "Files.Media", "type": "string", "default": "video" }

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", "type": "string", "default": "" }

Global.Time

Type: mixed
Properties:

• integer hours
• integer milliseconds
• integer minutes
• integer seconds

JSON Schema Description
{ "id": "Global.Time", "type": "object", "properties": { "hours": { "type": "integer", "name": "hours", "required": true }, "milliseconds": { "type": "integer", "name": "milliseconds", "required": true }, "minutes": { "type": "integer", "name": "minutes", "required": true }, "seconds": { "type": "integer", "name": "seconds", "required": true } } }

Global.Toggle

Type: mixed

JSON Schema Description
{ "id": "Global.Toggle", "type": [ { "type": "boolean" }, { "enums": [ "toggle" ], "type": "string" } ] }

Global.Weekday

Type: string

JSON Schema Description
{ "enums": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "id": "Global.Weekday", "type": "string", "default": "monday" }

GUI

GUI.Property.Name

Type: string

JSON Schema Description
{ "enums": [ "currentwindow", "currentcontrol", "skin", "fullscreen", "stereoscopicmode" ], "id": "GUI.Property.Name", "type": "string", "default": "currentwindow" }

GUI.Property.Value

Type: mixed
Properties:

• [ mixed currentcontrol ]
• [ mixed currentwindow ]
• [ boolean fullscreen = false ]
• [ mixed skin ]
• [ GUI.Stereoscopy.Mode stereoscopicmode ]

JSON Schema Description

{ "id": "GUI.Property.Value", "type": "object", "properties": { "currentcontrol": { "type": "object", "name": "currentcontrol" }, "currentwindow": { "type": "object", "name": "currentwindow" }, "fullscreen": { "default": "false", "type": "boolean", "name": "fullscreen" }, "skin": { "type": "object", "name": "skin" }, "stereoscopicmode": { "$ref": "GUI.Stereoscopy.Mode", "name": "stereoscopicmode" } } }

GUI.Stereoscopy.Mode

Type: mixed
Properties:

• string label
• string mode

JSON Schema Description
{ "id": "GUI.Stereoscopy.Mode", "type": "object", "properties": { "label": { "type": "string", "name": "label", "required": true }, "mode": { "type": "string", "name": "mode", "required": true } } }

GUI.Window

Type: string

JSON Schema Description

{ "enums": [ "home", "programs", "pictures", "filemanager", "settings", "music", "videos", "tvchannels", "tvrecordings", "tvguide", "tvtimers", "tvsearch", "radiochannels", "radiorecordings", "radioguide", "radiotimers", "radiosearch", "gamecontrollers", "pvrguideinfo", "pvrrecordinginfo", "pvrradiordsinfo", "pvrtimersetting", "pvrgroupmanager", "pvrchannelmanager", "pvrguidesearch", "pvrchannelscan", "pvrupdateprogress", "pvrosdchannels", "pvrosdguide", "pvrosdteletext", "systeminfo", "testpattern", "screencalibration", "systemsettings", "servicesettings", "pvrsettings", "playersettings", "mediasettings", "interfacesettings", "appearancesettings", "videoplaylist", "loginscreen", "profiles", "skinsettings", "addonbrowser", "yesnodialog", "progressdialog", "virtualkeyboard", "volumebar", "submenu", "favourites", "contextmenu", "notification", "numericinput", "gamepadinput", "shutdownmenu", "playercontrols", "playerprocessinfo", "seekbar", "musicosd", "addonsettings", "visualisationpresetlist", "osdcmssettings", "osdvideosettings", "osdaudiosettings", "audiodspmanager", "osdaudiodspsettings", "videobookmarks", "filebrowser", "networksetup", "mediasource", "profilesettings", "locksettings", "contentsettings", "songinformation", "smartplaylisteditor", "smartplaylistrule", "busydialog", "pictureinfo", "accesspoints", "fullscreeninfo", "sliderdialog", "addoninformation", "subtitlesearch", "musicplaylist", "musicplaylisteditor", "teletext", "selectdialog", "musicinformation", "okdialog", "movieinformation", "textviewer", "fullscreenvideo", "fullscreenlivetv", "fullscreenradio", "visualisation", "slideshow", "weather", "screensaver", "videoosd", "videomenu", "videotimeseek", "startwindow", "startup", "peripheralsettings", "extendedprogressdialog", "mediafilter", "addon", "eventlog", "tvtimerrules", "radiotimerrules" ], "id": "GUI.Window", "type": "string", "default": "home" }

Input

Input.Action

Type: string

JSON Schema Description

{ "enums": [ "left", "right", "up", "down", "pageup", "pagedown", "select", "highlight", "parentdir", "parentfolder", "back", "menu", "previousmenu", "info", "pause", "stop", "skipnext", "skipprevious", "fullscreen", "aspectratio", "stepforward", "stepback", "bigstepforward", "bigstepback", "chapterorbigstepforward", "chapterorbigstepback", "osd", "showsubtitles", "nextsubtitle", "cyclesubtitle", "playerdebug", "codecinfo", "playerprocessinfo", "nextpicture", "previouspicture", "zoomout", "zoomin", "playlist", "queue", "zoomnormal", "zoomlevel1", "zoomlevel2", "zoomlevel3", "zoomlevel4", "zoomlevel5", "zoomlevel6", "zoomlevel7", "zoomlevel8", "zoomlevel9", "nextcalibration", "resetcalibration", "analogmove", "analogmovex", "analogmovey", "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", "smallstepback", "fastforward", "rewind", "play", "playpause", "switchplayer", "delete", "copy", "move", "screenshot", "rename", "togglewatched", "scanitem", "reloadkeymaps", "volumeup", "volumedown", "mute", "backspace", "scrollup", "scrolldown", "analogfastforward", "analogrewind", "moveitemup", "moveitemdown", "contextmenu", "shift", "symbols", "cursorleft", "cursorright", "showtime", "analogseekforward", "analogseekback", "showpreset", "nextpreset", "previouspreset", "lockpreset", "randompreset", "increasevisrating", "decreasevisrating", "showvideomenu", "enter", "increaserating", "decreaserating", "setrating", "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", "volumeamplification", "createbookmark", "createepisodebookmark", "settingsreset", "settingslevelchange", "stereomode", "nextstereomode", "previousstereomode", "togglestereomode", "stereomodetomono", "channelup", "channeldown", "previouschannelgroup", "nextchannelgroup", "playpvr", "playpvrtv", "playpvrradio", "record", "togglecommskip", "showtimerrule", "leftclick", "rightclick", "middleclick", "doubleclick", "longclick", "wheelup", "wheeldown", "mousedrag", "mousemove", "tap", "longpress", "pangesture", "zoomgesture", "rotategesture", "swipeleft", "swiperight", "swipeup", "swipedown", "error", "noop" ], "id": "Input.Action", "type": "string", "default": "left" }

Item

Item.Details.Base

Type: mixed
Properties:

• string label

JSON Schema Description
{ "id": "Item.Details.Base", "type": "object", "properties": { "label": { "type": "string", "name": "label", "required": true } } }

Item.Fields.Base

Type: mixed

JSON Schema Description
{ "id": "Item.Fields.Base", "type": "array", "items": { "type": "string" } }

Library

Library.Details.Genre

Extends:

• Item.Details.Base

Properties:

• Library.Id genreid
• [ string thumbnail ]
• [ string title ]

JSON Schema Description
{ "extends": [ "Item.Details.Base" ], "id": "Library.Details.Genre", "properties": { "genreid": { "$ref": "Library.Id", "name": "genreid", "required": true }, "thumbnail": { "default": "", "type": "string", "name": "thumbnail" }, "title": { "default": "", "type": "string", "name": "title" } } }

Library.Details.Tag

Extends:

• Item.Details.Base

Properties:

• Library.Id tagid
• [ string title ]

JSON Schema Description
{ "extends": [ "Item.Details.Base" ], "id": "Library.Details.Tag", "properties": { "tagid": { "$ref": "Library.Id", "name": "tagid", "required": true }, "title": { "default": "", "type": "string", "name": "title" } } }

Library.Fields.Genre

Extends:

• Item.Fields.Base

JSON Schema Description
{ "extends": [ "Item.Fields.Base" ], "id": "Library.Fields.Genre", "items": { "enums": [ "title", "thumbnail" ], "type": "string" } }

Library.Fields.Tag

Extends:

• Item.Fields.Base

JSON Schema Description
{ "extends": [ "Item.Fields.Base" ], "id": "Library.Fields.Tag", "items": { "enums": [ "title" ], "type": "string" } }

Library.Id

Type: integer

JSON Schema Description
{ "id": "Library.Id", "type": "integer", "default": -1 }

List

List.Amount

Type: integer

JSON Schema Description
{ "id": "List.Amount", "type": "integer", "default": -1 }

List.Fields.All

Extends:

• Item.Fields.Base

JSON Schema Description

{ "extends": [ "Item.Fields.Base" ], "id": "List.Fields.All", "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", "specialsortseason", "specialsortepisode", "compilation", "releasetype", "albumreleasetype", "contributors", "displaycomposer", "displayconductor", "displayorchestra", "displaylyricist", "userrating" ], "type": "string" } }

List.Fields.Files

Extends:

• Item.Fields.Base

JSON Schema Description

{ "extends": [ "Item.Fields.Base" ], "id": "List.Fields.Files", "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", "specialsortseason", "specialsortepisode" ], "type": "string" } }

List.Filter.Albums

Type: mixed

JSON Schema Description
{ "id": "List.Filter.Albums", "type": [ { "properties": { "and": { "items": { "$ref": "List.Filter.Albums" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "items": { "$ref": "List.Filter.Albums" }, "minItems": 1, "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": { "items": { "$ref": "List.Filter.Artists" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "items": { "$ref": "List.Filter.Artists" }, "minItems": 1, "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": { "items": { "$ref": "List.Filter.Episodes" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "items": { "$ref": "List.Filter.Episodes" }, "minItems": 1, "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", "compilation", "type", "label", "rating", "userrating", "playcount", "lastplayed", "path", "playlist", "virtualfolder" ], "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", "role", "path", "playlist", "virtualfolder" ], "id": "List.Filter.Fields.Artists", "type": "string", "default": "artist" }

List.Filter.Fields.Episodes

Type: string

JSON Schema Description

{ "enums": [ "title", "tvshow", "plot", "votes", "rating", "userrating", "time", "writers", "airdate", "playcount", "lastplayed", "inprogress", "genre", "year", "director", "actor", "episode", "season", "filename", "path", "studio", "mpaarating", "dateadded", "tag", "videoresolution", "audiochannels", "audiocount", "subtitlecount", "videocodec", "audiocodec", "audiolanguage", "subtitlelanguage", "videoaspect", "playlist", "virtualfolder" ], "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", "userrating", "time", "writers", "playcount", "lastplayed", "inprogress", "genre", "country", "year", "director", "actor", "mpaarating", "top250", "studio", "hastrailer", "filename", "path", "set", "tag", "dateadded", "videoresolution", "audiochannels", "audiocount", "subtitlecount", "videocodec", "audiocodec", "audiolanguage", "subtitlelanguage", "videoaspect", "playlist", "virtualfolder" ], "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", "rating", "userrating", "time", "director", "studio", "plot", "tag", "dateadded", "videoresolution", "audiochannels", "audiocount", "subtitlecount", "videocodec", "audiocodec", "audiolanguage", "subtitlelanguage", "videoaspect", "playlist", "virtualfolder" ], "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", "userrating", "comment", "moods", "playlist", "virtualfolder" ], "id": "List.Filter.Fields.Songs", "type": "string", "default": "genre" }

List.Filter.Fields.Textures

Type: string

JSON Schema Description
{ "enums": [ "textureid", "url", "cachedurl", "lasthashcheck", "imagehash", "width", "height", "usecount", "lastused" ], "id": "List.Filter.Fields.Textures", "type": "string", "default": "textureid" }

List.Filter.Fields.TVShows

Type: string

JSON Schema Description
{ "enums": [ "title", "plot", "status", "votes", "rating", "userrating", "year", "genre", "director", "actor", "numepisodes", "numwatched", "playcount", "path", "studio", "mpaarating", "dateadded", "lastplayed", "inprogress", "tag", "playlist", "virtualfolder" ], "id": "List.Filter.Fields.TVShows", "type": "string", "default": "title" }

List.Filter.Movies

Type: mixed

JSON Schema Description
{ "id": "List.Filter.Movies", "type": [ { "properties": { "and": { "items": { "$ref": "List.Filter.Movies" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "items": { "$ref": "List.Filter.Movies" }, "minItems": 1, "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": { "items": { "$ref": "List.Filter.MusicVideos" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "items": { "$ref": "List.Filter.MusicVideos" }, "minItems": 1, "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: mixed
Properties:

• List.Filter.Operators operator
• mixed: string|array value

JSON Schema Description
{ "id": "List.Filter.Rule", "type": "object", "properties": { "operator": { "$ref": "List.Filter.Operators", "name": "operator", "required": true }, "value": { "type": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "name": "value", "required": true } } }

List.Filter.Rule.Albums

Extends:

• List.Filter.Rule

Properties:

• List.Filter.Fields.Albums field

JSON Schema Description
{ "extends": [ "List.Filter.Rule" ], "id": "List.Filter.Rule.Albums", "properties": { "field": { "$ref": "List.Filter.Fields.Albums", "name": "field", "required": true } } }

List.Filter.Rule.Artists

Extends:

• List.Filter.Rule

Properties:

• List.Filter.Fields.Artists field

JSON Schema Description
{ "extends": [ "List.Filter.Rule" ], "id": "List.Filter.Rule.Artists", "properties": { "field": { "$ref": "List.Filter.Fields.Artists", "name": "field", "required": true } } }

List.Filter.Rule.Episodes

Extends:

• List.Filter.Rule

Properties:

• List.Filter.Fields.Episodes field

JSON Schema Description
{ "extends": [ "List.Filter.Rule" ], "id": "List.Filter.Rule.Episodes", "properties": { "field": { "$ref": "List.Filter.Fields.Episodes", "name": "field", "required": true } } }

List.Filter.Rule.Movies

Extends:

• List.Filter.Rule

Properties:

• List.Filter.Fields.Movies field

JSON Schema Description
{ "extends": [ "List.Filter.Rule" ], "id": "List.Filter.Rule.Movies", "properties": { "field": { "$ref": "List.Filter.Fields.Movies", "name": "field", "required": true } } }

List.Filter.Rule.MusicVideos

Extends:

• List.Filter.Rule

Properties:

• List.Filter.Fields.MusicVideos field

JSON Schema Description
{ "extends": [ "List.Filter.Rule" ], "id": "List.Filter.Rule.MusicVideos", "properties": { "field": { "$ref": "List.Filter.Fields.MusicVideos", "name": "field", "required": true } } }

List.Filter.Rule.Songs

Extends:

• List.Filter.Rule

Properties:

• List.Filter.Fields.Songs field

JSON Schema Description
{ "extends": [ "List.Filter.Rule" ], "id": "List.Filter.Rule.Songs", "properties": { "field": { "$ref": "List.Filter.Fields.Songs", "name": "field", "required": true } } }

List.Filter.Rule.Textures

Extends:

• List.Filter.Rule

Properties:

• List.Filter.Fields.Textures field

JSON Schema Description
{ "extends": [ "List.Filter.Rule" ], "id": "List.Filter.Rule.Textures", "properties": { "field": { "$ref": "List.Filter.Fields.Textures", "name": "field", "required": true } } }

List.Filter.Rule.TVShows

Extends:

• List.Filter.Rule

Properties:

• List.Filter.Fields.TVShows field

JSON Schema Description
{ "extends": [ "List.Filter.Rule" ], "id": "List.Filter.Rule.TVShows", "properties": { "field": { "$ref": "List.Filter.Fields.TVShows", "name": "field", "required": true } } }

List.Filter.Songs

Type: mixed

JSON Schema Description
{ "id": "List.Filter.Songs", "type": [ { "properties": { "and": { "items": { "$ref": "List.Filter.Songs" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "items": { "$ref": "List.Filter.Songs" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.Songs" } ] }

List.Filter.Textures

Type: mixed

JSON Schema Description
{ "id": "List.Filter.Textures", "type": [ { "properties": { "and": { "items": { "$ref": "List.Filter.Textures" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "items": { "$ref": "List.Filter.Textures" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.Textures" } ] }

List.Filter.TVShows

Type: mixed

JSON Schema Description
{ "id": "List.Filter.TVShows", "type": [ { "properties": { "and": { "items": { "$ref": "List.Filter.TVShows" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "items": { "$ref": "List.Filter.TVShows" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.TVShows" } ] }

List.Item.All

Extends:

• List.Item.Base

Properties:

• [ string channel ]
• [ integer channelnumber = "0" ]
• [ PVR.Channel.Type channeltype = "tv" ]
• [ string endtime ]
• [ boolean hidden = false ]
• [ boolean locked = false ]
• [ string starttime ]

JSON Schema Description

{ "extends": [ "List.Item.Base" ], "id": "List.Item.All", "properties": { "channel": { "default": "", "type": "string", "name": "channel" }, "channelnumber": { "default": "0", "type": "integer", "name": "channelnumber" }, "channeltype": { "default": "tv", "$ref": "PVR.Channel.Type", "name": "channeltype" }, "endtime": { "default": "", "type": "string", "name": "endtime" }, "hidden": { "default": "false", "type": "boolean", "name": "hidden" }, "locked": { "default": "false", "type": "boolean", "name": "locked" }, "starttime": { "default": "", "type": "string", "name": "starttime" } } }

List.Item.Base

Extends:

• Video.Details.File
• Audio.Details.Media

Properties:

• [ string album ]
• [ Array.String albumartist ]
• [ Array.Integer albumartistid ]
• [ Library.Id albumid = "-1" ]
• [ string albumlabel ]
• [ Audio.Album.ReleaseType albumreleasetype = "album" ]
• [ Video.Cast cast ]
• [ string comment ]
• [ boolean compilation = false ]
• [ Audio.Contributors contributors ]
• [ Array.String country ]
• [ string description ]
• [ integer disc = "0" ]
• [ string displaycomposer ]
• [ string displayconductor ]
• [ string displaylyricist ]
• [ string displayorchestra ]
• [ integer duration = "0" ]
• [ integer episode = "0" ]
• [ string episodeguide ]
• [ string firstaired ]
• [ Library.Id id = "-1" ]
• [ string imdbnumber ]
• [ string lyrics ]
• [ Array.String mood ]
• [ string mpaa ]
• [ string musicbrainzartistid ]
• [ string musicbrainztrackid ]
• [ string originaltitle ]
• [ string plotoutline ]
• [ string premiered ]
• [ string productioncode ]
• [ Audio.Album.ReleaseType releasetype = "album" ]
• [ integer season = "0" ]
• [ string set ]
• [ Library.Id setid = "-1" ]
• [ Array.String showlink ]
• [ string showtitle ]
• [ string sorttitle ]
• [ integer specialsortepisode = "0" ]
• [ integer specialsortseason = "0" ]
• [ Array.String studio ]
• [ Array.String style ]
• [ Array.String tag ]
• [ string tagline ]
• [ Array.String theme ]
• [ integer top250 = "0" ]
• [ integer track = "0" ]
• [ string trailer ]
• [ Library.Id tvshowid = "-1" ]
• [ string type = "unknown" ]
• [ Media.UniqueID uniqueid ]
• [ string votes ]
• [ integer watchedepisodes = "0" ]
• [ Array.String writer ]

JSON Schema Description

{ "extends": [ "Video.Details.File", "Audio.Details.Media" ], "id": "List.Item.Base", "properties": { "album": { "default": "", "type": "string", "name": "album" }, "albumartist": { "$ref": "Array.String", "name": "albumartist" }, "albumartistid": { "$ref": "Array.Integer", "name": "albumartistid" }, "albumid": { "default": "-1", "$ref": "Library.Id", "name": "albumid" }, "albumlabel": { "default": "", "type": "string", "name": "albumlabel" }, "albumreleasetype": { "default": "album", "$ref": "Audio.Album.ReleaseType", "name": "albumreleasetype" }, "cast": { "$ref": "Video.Cast", "name": "cast" }, "comment": { "default": "", "type": "string", "name": "comment" }, "compilation": { "default": "false", "type": "boolean", "name": "compilation" }, "contributors": { "$ref": "Audio.Contributors", "name": "contributors" }, "country": { "$ref": "Array.String", "name": "country" }, "description": { "default": "", "type": "string", "name": "description" }, "disc": { "default": "0", "type": "integer", "name": "disc" }, "displaycomposer": { "default": "", "type": "string", "name": "displaycomposer" }, "displayconductor": { "default": "", "type": "string", "name": "displayconductor" }, "displaylyricist": { "default": "", "type": "string", "name": "displaylyricist" }, "displayorchestra": { "default": "", "type": "string", "name": "displayorchestra" }, "duration": { "default": "0", "type": "integer", "name": "duration" }, "episode": { "default": "0", "type": "integer", "name": "episode" }, "episodeguide": { "default": "", "type": "string", "name": "episodeguide" }, "firstaired": { "default": "", "type": "string", "name": "firstaired" }, "id": { "default": "-1", "$ref": "Library.Id", "name": "id" }, "imdbnumber": { "default": "", "type": "string", "name": "imdbnumber" }, "lyrics": { "default": "", "type": "string", "name": "lyrics" }, "mood": { "$ref": "Array.String", "name": "mood" }, "mpaa": { "default": "", "type": "string", "name": "mpaa" }, "musicbrainzartistid": { "default": "", "type": "string", "name": "musicbrainzartistid" }, "musicbrainztrackid": { "default": "", "type": "string", "name": "musicbrainztrackid" }, "originaltitle": { "default": "", "type": "string", "name": "originaltitle" }, "plotoutline": { "default": "", "type": "string", "name": "plotoutline" }, "premiered": { "default": "", "type": "string", "name": "premiered" }, "productioncode": { "default": "", "type": "string", "name": "productioncode" }, "releasetype": { "default": "album", "$ref": "Audio.Album.ReleaseType", "name": "releasetype" }, "season": { "default": "0", "type": "integer", "name": "season" }, "set": { "default": "", "type": "string", "name": "set" }, "setid": { "default": "-1", "$ref": "Library.Id", "name": "setid" }, "showlink": { "$ref": "Array.String", "name": "showlink" }, "showtitle": { "default": "", "type": "string", "name": "showtitle" }, "sorttitle": { "default": "", "type": "string", "name": "sorttitle" }, "specialsortepisode": { "default": "0", "type": "integer", "name": "specialsortepisode" }, "specialsortseason": { "default": "0", "type": "integer", "name": "specialsortseason" }, "studio": { "$ref": "Array.String", "name": "studio" }, "style": { "$ref": "Array.String", "name": "style" }, "tag": { "$ref": "Array.String", "name": "tag" }, "tagline": { "default": "", "type": "string", "name": "tagline" }, "theme": { "$ref": "Array.String", "name": "theme" }, "top250": { "default": "0", "type": "integer", "name": "top250" }, "track": { "default": "0", "type": "integer", "name": "track" }, "trailer": { "default": "", "type": "string", "name": "trailer" }, "tvshowid": { "default": "-1", "$ref": "Library.Id", "name": "tvshowid" }, "type": { "default": "unknown", "type": "string", "name": "type" }, "uniqueid": { "$ref": "Media.UniqueID", "name": "uniqueid" }, "votes": { "default": "", "type": "string", "name": "votes" }, "watchedepisodes": { "default": "0", "type": "integer", "name": "watchedepisodes" }, "writer": { "$ref": "Array.String", "name": "writer" } } }

List.Item.File

Extends:

• List.Item.Base

Properties:

• string file
• string filetype
• [ string lastmodified ]
• [ string mimetype ]
• [ integer size = "0" ] Size of the file in bytes

JSON Schema Description

{ "extends": [ "List.Item.Base" ], "id": "List.Item.File", "properties": { "file": { "type": "string", "name": "file", "required": true }, "filetype": { "type": "string", "name": "filetype", "required": true }, "lastmodified": { "default": "", "type": "string", "name": "lastmodified" }, "mimetype": { "default": "", "type": "string", "name": "mimetype" }, "size": { "default": "0", "description": "Size of the file in bytes", "type": "integer", "name": "size" } } }

List.Items.Sources

Type: mixed

JSON Schema Description
{ "id": "List.Items.Sources", "type": "array", "items": { "extends": "Item.Details.Base", "properties": { "file": { "required": true, "type": "string" } } } }

List.Limits

Type: mixed
Properties:

• [ List.Amount end = "-1" ] Index of the last item to return
• [ integer start = "0" ] Index of the first item to return

JSON Schema Description
{ "id": "List.Limits", "type": "object", "properties": { "end": { "default": "-1", "description": "Index of the last item to return", "$ref": "List.Amount", "name": "end" }, "start": { "default": "0", "description": "Index of the first item to return", "type": "integer", "name": "start" } } }

List.LimitsReturned

Type: mixed
Properties:

• [ List.Amount end = "-1" ]
• [ integer start = "0" ]
• integer total

JSON Schema Description
{ "id": "List.LimitsReturned", "type": "object", "properties": { "end": { "default": "-1", "$ref": "List.Amount", "name": "end" }, "start": { "default": "0", "type": "integer", "name": "start" }, "total": { "type": "integer", "name": "total", "required": true } } }

List.Sort

Type: mixed
Properties:

• [ boolean ignorearticle = false ]
• [ string method = "none" ]
• [ string order = "ascending" ]

JSON Schema Description
{ "id": "List.Sort", "type": "object", "properties": { "ignorearticle": { "default": "false", "type": "boolean", "name": "ignorearticle" }, "method": { "default": "none", "type": "string", "name": "method" }, "order": { "default": "ascending", "type": "string", "name": "order" } } }

Media

Media.Artwork

Type: mixed
Properties:

• [ Global.String.NotEmpty banner ]
• [ Global.String.NotEmpty fanart ]
• [ Global.String.NotEmpty poster ]
• [ Global.String.NotEmpty thumb ]

JSON Schema Description
{ "id": "Media.Artwork", "type": "object", "properties": { "banner": { "default": "", "$ref": "Global.String.NotEmpty", "name": "banner" }, "fanart": { "default": "", "$ref": "Global.String.NotEmpty", "name": "fanart" }, "poster": { "default": "", "$ref": "Global.String.NotEmpty", "name": "poster" }, "thumb": { "default": "", "$ref": "Global.String.NotEmpty", "name": "thumb" } } }

Media.Artwork.Set

Type: mixed
Properties:

• [ mixed banner ]
• [ mixed fanart ]
• [ mixed poster ]
• [ mixed thumb ]

JSON Schema Description

{ "id": "Media.Artwork.Set", "type": "object", "properties": { "banner": { "default": "", "type": [ { "type": "null" }, { "$ref": "Global.String.NotEmpty" } ], "name": "banner" }, "fanart": { "default": "", "type": [ { "type": "null" }, { "$ref": "Global.String.NotEmpty" } ], "name": "fanart" }, "poster": { "default": "", "type": [ { "type": "null" }, { "$ref": "Global.String.NotEmpty" } ], "name": "poster" }, "thumb": { "default": "", "type": [ { "type": "null" }, { "$ref": "Global.String.NotEmpty" } ], "name": "thumb" } } }

Media.Details.Base

Extends:

• Item.Details.Base

Properties:

• [ string fanart ]
• [ string thumbnail ]

JSON Schema Description
{ "extends": [ "Item.Details.Base" ], "id": "Media.Details.Base", "properties": { "fanart": { "default": "", "type": "string", "name": "fanart" }, "thumbnail": { "default": "", "type": "string", "name": "thumbnail" } } }

Media.UniqueID

Type: mixed

JSON Schema Description
{ "id": "Media.UniqueID", "type": "object" }

Media.UniqueID.Set

Type: mixed

JSON Schema Description
{ "id": "Media.UniqueID.Set", "type": "object" }

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": { "default": 0, "type": "integer" } }, "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": { "episode": { "default": 0, "type": "integer" }, "season": { "default": 0, "type": "integer" }, "showtitle": { "default": "", "type": "string" }, "title": { "required": true, "type": "string" }, "type": { "$ref": "Notifications.Item.Type", "required": true } }, "type": "object" }, { "description": "A music video has a title and may have an album and an artist.", "properties": { "album": { "default": "", "type": "string" }, "artist": { "default": "", "type": "string" }, "title": { "required": true, "type": "string" }, "type": { "$ref": "Notifications.Item.Type", "required": true } }, "type": "object" }, { "description": "A song has a title and may have an album, an artist and a track number.", "properties": { "album": { "default": "", "type": "string" }, "artist": { "default": "", "type": "string" }, "title": { "required": true, "type": "string" }, "track": { "default": 0, "type": "integer" }, "type": { "$ref": "Notifications.Item.Type", "required": true } }, "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" } ] }

Optional.Integer

Type: mixed

JSON Schema Description
{ "id": "Optional.Integer", "type": [ { "type": "null" }, { "type": "integer" } ] }

Optional.Number

Type: mixed

JSON Schema Description
{ "id": "Optional.Number", "type": [ { "type": "null" }, { "type": "number" } ] }

Optional.String

Type: mixed

JSON Schema Description
{ "id": "Optional.String", "type": [ { "type": "null" }, { "type": "string" } ] }

Player

Player.Audio.Stream

Type: mixed
Properties:

• integer bitrate
• integer channels
• string codec
• integer index
• string language
• string name

JSON Schema Description

{ "id": "Player.Audio.Stream", "type": "object", "properties": { "bitrate": { "type": "integer", "name": "bitrate", "required": true }, "channels": { "type": "integer", "name": "channels", "required": true }, "codec": { "type": "string", "name": "codec", "required": true }, "index": { "type": "integer", "name": "index", "required": true }, "language": { "type": "string", "name": "language", "required": true }, "name": { "type": "string", "name": "name", "required": true } } }

Player.Id

Type: integer

JSON Schema Description
{ "id": "Player.Id", "type": "integer", "default": -1 }

Player.Notifications.Data

Type: mixed
Properties:

• Notifications.Item item
• Player.Notifications.Player player

JSON Schema Description
{ "id": "Player.Notifications.Data", "type": "object", "properties": { "item": { "$ref": "Notifications.Item", "name": "item", "required": true }, "player": { "$ref": "Player.Notifications.Player", "name": "player", "required": true } } }

Player.Notifications.Player

Type: mixed
Properties:

• Player.Id playerid
• [ integer speed = "0" ]

JSON Schema Description
{ "id": "Player.Notifications.Player", "type": "object", "properties": { "playerid": { "$ref": "Player.Id", "name": "playerid", "required": true }, "speed": { "default": "0", "type": "integer", "name": "speed" } } }

Player.Notifications.Player.Seek

Extends:

• Player.Notifications.Player

Properties:

• [ Global.Time seekoffset ]
• [ Global.Time time ]

JSON Schema Description
{ "extends": [ "Player.Notifications.Player" ], "id": "Player.Notifications.Player.Seek", "properties": { "seekoffset": { "$ref": "Global.Time", "name": "seekoffset" }, "time": { "$ref": "Global.Time", "name": "time" } } }

Player.Position.Percentage

Type: number

JSON Schema Description
{ "id": "Player.Position.Percentage", "type": "number", "default": 0 }

Player.Position.Time

Type: mixed
Properties:

• [ integer hours = "0" ]
• [ integer milliseconds = "0" ]
• [ integer minutes = "0" ]
• [ integer seconds = "0" ]

JSON Schema Description
{ "id": "Player.Position.Time", "type": "object", "properties": { "hours": { "default": "0", "type": "integer", "name": "hours" }, "milliseconds": { "default": "0", "type": "integer", "name": "milliseconds" }, "minutes": { "default": "0", "type": "integer", "name": "minutes" }, "seconds": { "default": "0", "type": "integer", "name": "seconds" } } }

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", "currentvideostream", "videostreams" ], "id": "Player.Property.Name", "type": "string", "default": "type" }

Player.Property.Value

Type: mixed
Properties:

• [ Player.Audio.Stream[] audiostreams ]
• [ boolean canchangespeed = false ]
• [ boolean canmove = false ]
• [ boolean canrepeat = false ]
• [ boolean canrotate = false ]
• [ boolean canseek = false ]
• [ boolean canshuffle = false ]
• [ boolean canzoom = false ]
• [ Player.Audio.Stream currentaudiostream ]
• [ Player.Subtitle currentsubtitle ]
• [ Player.Video.Stream currentvideostream ]
• [ boolean live = false ]
• [ boolean partymode = false ]
• [ Player.Position.Percentage percentage = "0" ]
• [ Playlist.Id playlistid = "-1" ]
• [ Playlist.Position position = "-1" ]
• [ Player.Repeat repeat = "off" ]
• [ boolean shuffled = false ]
• [ integer speed = "0" ]
• [ boolean subtitleenabled = false ]
• [ Player.Subtitle[] subtitles ]
• [ Global.Time time ]
• [ Global.Time totaltime ]
• [ Player.Type type = "video" ]
• [ Player.Video.Stream[] videostreams ]

JSON Schema Description

{ "id": "Player.Property.Value", "type": "object", "properties": { "audiostreams": { "items": { "$ref": "Player.Audio.Stream" }, "type": "array", "name": "audiostreams" }, "canchangespeed": { "default": "false", "type": "boolean", "name": "canchangespeed" }, "canmove": { "default": "false", "type": "boolean", "name": "canmove" }, "canrepeat": { "default": "false", "type": "boolean", "name": "canrepeat" }, "canrotate": { "default": "false", "type": "boolean", "name": "canrotate" }, "canseek": { "default": "false", "type": "boolean", "name": "canseek" }, "canshuffle": { "default": "false", "type": "boolean", "name": "canshuffle" }, "canzoom": { "default": "false", "type": "boolean", "name": "canzoom" }, "currentaudiostream": { "$ref": "Player.Audio.Stream", "name": "currentaudiostream" }, "currentsubtitle": { "$ref": "Player.Subtitle", "name": "currentsubtitle" }, "currentvideostream": { "$ref": "Player.Video.Stream", "name": "currentvideostream" }, "live": { "default": "false", "type": "boolean", "name": "live" }, "partymode": { "default": "false", "type": "boolean", "name": "partymode" }, "percentage": { "default": "0", "$ref": "Player.Position.Percentage", "name": "percentage" }, "playlistid": { "default": "-1", "$ref": "Playlist.Id", "name": "playlistid" }, "position": { "default": "-1", "$ref": "Playlist.Position", "name": "position" }, "repeat": { "default": "off", "$ref": "Player.Repeat", "name": "repeat" }, "shuffled": { "default": "false", "type": "boolean", "name": "shuffled" }, "speed": { "default": "0", "type": "integer", "name": "speed" }, "subtitleenabled": { "default": "false", "type": "boolean", "name": "subtitleenabled" }, "subtitles": { "items": { "$ref": "Player.Subtitle" }, "type": "array", "name": "subtitles" }, "time": { "$ref": "Global.Time", "name": "time" }, "totaltime": { "$ref": "Global.Time", "name": "totaltime" }, "type": { "default": "video", "$ref": "Player.Type", "name": "type" }, "videostreams": { "items": { "$ref": "Player.Video.Stream" }, "type": "array", "name": "videostreams" } } }

Player.Repeat

Type: string

JSON Schema Description
{ "enums": [ "off", "one", "all" ], "id": "Player.Repeat", "type": "string", "default": "off" }

Player.Speed

Type: mixed
Properties:

• [ integer speed = "0" ]

JSON Schema Description
{ "id": "Player.Speed", "type": "object", "properties": { "speed": { "default": "0", "type": "integer", "name": "speed" } } }

Player.Subtitle

Type: mixed
Properties:

• integer index
• string language
• string name

JSON Schema Description
{ "id": "Player.Subtitle", "type": "object", "properties": { "index": { "type": "integer", "name": "index", "required": true }, "language": { "type": "string", "name": "language", "required": true }, "name": { "type": "string", "name": "name", "required": true } } }

Player.Type

Type: string

JSON Schema Description
{ "enums": [ "video", "audio", "picture" ], "id": "Player.Type", "type": "string", "default": "video" }

Player.Video.Stream

Type: mixed
Properties:

• string codec
• integer height
• integer index
• string language
• string name
• integer width

JSON Schema Description

{ "id": "Player.Video.Stream", "type": "object", "properties": { "codec": { "type": "string", "name": "codec", "required": true }, "height": { "type": "integer", "name": "height", "required": true }, "index": { "type": "integer", "name": "index", "required": true }, "language": { "type": "string", "name": "language", "required": true }, "name": { "type": "string", "name": "name", "required": true }, "width": { "type": "integer", "name": "width", "required": true } } }

Playlist

Playlist.Id

Type: integer

JSON Schema Description
{ "id": "Playlist.Id", "type": "integer", "default": -1 }

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" }, "media": { "$ref": "Files.Media", "default": "files" }, "recursive": { "default": false, "type": "boolean" } }, "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
{ "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: mixed
Properties:

• [ integer size = "0" ]
• [ Playlist.Type type = "unknown" ]

JSON Schema Description
{ "id": "Playlist.Property.Value", "type": "object", "properties": { "size": { "default": "0", "type": "integer", "name": "size" }, "type": { "default": "unknown", "$ref": "Playlist.Type", "name": "type" } } }

Playlist.Type

Type: string

JSON Schema Description
{ "enums": [ "unknown", "video", "audio", "picture", "mixed" ], "id": "Playlist.Type", "type": "string", "default": "unknown" }

Profiles

Profiles.Details.Profile

Extends:

• Item.Details.Base

Properties:

• [ integer lockmode = "0" ]
• [ string thumbnail ]

JSON Schema Description
{ "extends": [ "Item.Details.Base" ], "id": "Profiles.Details.Profile", "properties": { "lockmode": { "default": "0", "type": "integer", "name": "lockmode" }, "thumbnail": { "default": "", "type": "string", "name": "thumbnail" } } }

Profiles.Fields.Profile

Extends:

• Item.Fields.Base

JSON Schema Description
{ "extends": [ "Item.Fields.Base" ], "id": "Profiles.Fields.Profile", "items": { "enums": [ "thumbnail", "lockmode" ], "type": "string" } }

Profiles.Password

Type: mixed
Properties:

• [ string encryption = "md5" ] Password Encryption
• string value Password

JSON Schema Description
{ "id": "Profiles.Password", "type": "object", "properties": { "encryption": { "default": "md5", "description": "Password Encryption", "type": "string", "name": "encryption" }, "value": { "description": "Password", "type": "string", "name": "value", "required": true } } }

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" } ] }

PVR.Details.Broadcast

Extends:

• Item.Details.Base

Properties:

• Library.Id broadcastid
• [ string cast ]
• [ string director ]
• [ string endtime ]
• [ string episodename ]
• [ integer episodenum = "0" ]
• [ integer episodepart = "0" ]
• [ string firstaired ]
• [ string genre ]
• [ boolean hasrecording = false ]
• [ boolean hastimer = false ]
• [ boolean hastimerrule = false ]
• [ integer imdbnumber = "0" ]
• [ boolean isactive = false ]
• [ boolean isseries = false ]
• [ string originaltitle ]
• [ integer parentalrating = "0" ]
• [ string plot ]
• [ string plotoutline ]
• [ integer progress = "0" ]
• [ number progresspercentage = "0" ]
• [ integer rating = "0" ]
• [ string recording ]
• [ integer runtime = "0" ]
• [ string starttime ]
• [ string thumbnail ]
• [ string title ]
• [ boolean wasactive = false ]
• [ string writer ]
• [ integer year = "0" ]

JSON Schema Description

{ "extends": [ "Item.Details.Base" ], "id": "PVR.Details.Broadcast", "properties": { "broadcastid": { "$ref": "Library.Id", "name": "broadcastid", "required": true }, "cast": { "default": "", "type": "string", "name": "cast" }, "director": { "default": "", "type": "string", "name": "director" }, "endtime": { "default": "", "type": "string", "name": "endtime" }, "episodename": { "default": "", "type": "string", "name": "episodename" }, "episodenum": { "default": "0", "type": "integer", "name": "episodenum" }, "episodepart": { "default": "0", "type": "integer", "name": "episodepart" }, "firstaired": { "default": "", "type": "string", "name": "firstaired" }, "genre": { "default": "", "type": "string", "name": "genre" }, "hasrecording": { "default": "false", "type": "boolean", "name": "hasrecording" }, "hastimer": { "default": "false", "type": "boolean", "name": "hastimer" }, "hastimerrule": { "default": "false", "type": "boolean", "name": "hastimerrule" }, "imdbnumber": { "default": "0", "type": "integer", "name": "imdbnumber" }, "isactive": { "default": "false", "type": "boolean", "name": "isactive" }, "isseries": { "default": "false", "type": "boolean", "name": "isseries" }, "originaltitle": { "default": "", "type": "string", "name": "originaltitle" }, "parentalrating": { "default": "0", "type": "integer", "name": "parentalrating" }, "plot": { "default": "", "type": "string", "name": "plot" }, "plotoutline": { "default": "", "type": "string", "name": "plotoutline" }, "progress": { "default": "0", "type": "integer", "name": "progress" }, "progresspercentage": { "default": "0", "type": "number", "name": "progresspercentage" }, "rating": { "default": "0", "type": "integer", "name": "rating" }, "recording": { "default": "", "type": "string", "name": "recording" }, "runtime": { "default": "0", "type": "integer", "name": "runtime" }, "starttime": { "default": "", "type": "string", "name": "starttime" }, "thumbnail": { "default": "", "type": "string", "name": "thumbnail" }, "title": { "default": "", "type": "string", "name": "title" }, "wasactive": { "default": "false", "type": "boolean", "name": "wasactive" }, "writer": { "default": "", "type": "string", "name": "writer" }, "year": { "default": "0", "type": "integer", "name": "year" } } }

PVR.Details.Channel

Extends:

• Item.Details.Base

Properties:

• [ PVR.Details.Broadcast broadcastnext ]
• [ PVR.Details.Broadcast broadcastnow ]
• [ string channel ]
• Library.Id channelid
• [ integer channelnumber = "0" ]
• [ PVR.Channel.Type channeltype = "tv" ]
• [ boolean hidden = false ]
• [ string icon ]
• [ boolean isrecording = false ]
• [ string lastplayed ]
• [ boolean locked = false ]
• [ integer subchannelnumber = "0" ]
• [ string thumbnail ]
• integer uniqueid

JSON Schema Description

{ "extends": [ "Item.Details.Base" ], "id": "PVR.Details.Channel", "properties": { "broadcastnext": { "$ref": "PVR.Details.Broadcast", "name": "broadcastnext" }, "broadcastnow": { "$ref": "PVR.Details.Broadcast", "name": "broadcastnow" }, "channel": { "default": "", "type": "string", "name": "channel" }, "channelid": { "$ref": "Library.Id", "name": "channelid", "required": true }, "channelnumber": { "default": "0", "type": "integer", "name": "channelnumber" }, "channeltype": { "default": "tv", "$ref": "PVR.Channel.Type", "name": "channeltype" }, "hidden": { "default": "false", "type": "boolean", "name": "hidden" }, "icon": { "default": "", "type": "string", "name": "icon" }, "isrecording": { "default": "false", "type": "boolean", "name": "isrecording" }, "lastplayed": { "default": "", "type": "string", "name": "lastplayed" }, "locked": { "default": "false", "type": "boolean", "name": "locked" }, "subchannelnumber": { "default": "0", "type": "integer", "name": "subchannelnumber" }, "thumbnail": { "default": "", "type": "string", "name": "thumbnail" }, "uniqueid": { "type": "integer", "name": "uniqueid", "required": true } } }

PVR.Details.ChannelGroup

Extends:

• Item.Details.Base

Properties:

• Library.Id channelgroupid
• PVR.Channel.Type channeltype

JSON Schema Description
{ "extends": [ "Item.Details.Base" ], "id": "PVR.Details.ChannelGroup", "properties": { "channelgroupid": { "$ref": "Library.Id", "name": "channelgroupid", "required": true }, "channeltype": { "$ref": "PVR.Channel.Type", "name": "channeltype", "required": true } } }

PVR.Details.ChannelGroup.Extended

Extends:

• PVR.Details.ChannelGroup

Properties:

• [ PVR.Details.Channel[] channels ]
• List.LimitsReturned limits

JSON Schema Description
{ "extends": [ "PVR.Details.ChannelGroup" ], "id": "PVR.Details.ChannelGroup.Extended", "properties": { "channels": { "items": { "$ref": "PVR.Details.Channel" }, "type": "array", "name": "channels" }, "limits": { "$ref": "List.LimitsReturned", "name": "limits", "required": true } } }

PVR.Details.Recording

Extends:

• Item.Details.Base

Properties:

• [ Media.Artwork art ]
• [ string channel ]
• [ integer channeluid = "0" ]
• [ string directory ]
• [ string endtime ]
• [ integer epgeventid = "0" ]
• [ string file ]
• [ string genre ]
• [ string icon ]
• [ boolean isdeleted = false ]
• [ integer lifetime = "0" ]
• [ integer playcount = "0" ]
• [ string plot ]
• [ string plotoutline ]
• [ boolean radio = false ]
• Library.Id recordingid
• [ Video.Resume resume ]
• [ integer runtime = "0" ]
• [ string starttime ]
• [ string streamurl ]
• [ string title ]

JSON Schema Description

{ "extends": [ "Item.Details.Base" ], "id": "PVR.Details.Recording", "properties": { "art": { "$ref": "Media.Artwork", "name": "art" }, "channel": { "default": "", "type": "string", "name": "channel" }, "channeluid": { "default": "0", "type": "integer", "name": "channeluid" }, "directory": { "default": "", "type": "string", "name": "directory" }, "endtime": { "default": "", "type": "string", "name": "endtime" }, "epgeventid": { "default": "0", "type": "integer", "name": "epgeventid" }, "file": { "default": "", "type": "string", "name": "file" }, "genre": { "default": "", "type": "string", "name": "genre" }, "icon": { "default": "", "type": "string", "name": "icon" }, "isdeleted": { "default": "false", "type": "boolean", "name": "isdeleted" }, "lifetime": { "default": "0", "type": "integer", "name": "lifetime" }, "playcount": { "default": "0", "type": "integer", "name": "playcount" }, "plot": { "default": "", "type": "string", "name": "plot" }, "plotoutline": { "default": "", "type": "string", "name": "plotoutline" }, "radio": { "default": "false", "type": "boolean", "name": "radio" }, "recordingid": { "$ref": "Library.Id", "name": "recordingid", "required": true }, "resume": { "$ref": "Video.Resume", "name": "resume" }, "runtime": { "default": "0", "type": "integer", "name": "runtime" }, "starttime": { "default": "", "type": "string", "name": "starttime" }, "streamurl": { "default": "", "type": "string", "name": "streamurl" }, "title": { "default": "", "type": "string", "name": "title" } } }

PVR.Details.Timer

Extends:

• Item.Details.Base

Properties:

• [ Library.Id channelid = "-1" ]
• [ string directory ]
• [ boolean endanytime = false ]
• [ integer endmargin = "0" ]
• [ string endtime ]
• [ string epgsearchstring ]
• [ integer epguid = "0" ]
• [ string file ]
• [ string firstday ]
• [ boolean fulltextepgsearch = false ]
• [ boolean ismanual = false ]
• [ boolean isradio = false ]
• [ boolean isreadonly = false ]
• [ boolean istimerrule = false ]
• [ integer lifetime = "0" ]
• [ integer maxrecordings = "0" ]
• [ integer preventduplicateepisodes = "0" ]
• [ integer priority = "0" ]
• [ integer recordinggroup = "0" ]
• [ integer runtime = "0" ]
• [ boolean startanytime = false ]
• [ integer startmargin = "0" ]
• [ string starttime ]
• [ PVR.TimerState state = "unknown" ]
• [ string summary ]
• Library.Id timerid
• [ string title ]
• [ Global.Weekday[] weekdays ]

JSON Schema Description

{ "extends": [ "Item.Details.Base" ], "id": "PVR.Details.Timer", "properties": { "channelid": { "default": "-1", "$ref": "Library.Id", "name": "channelid" }, "directory": { "default": "", "type": "string", "name": "directory" }, "endanytime": { "default": "false", "type": "boolean", "name": "endanytime" }, "endmargin": { "default": "0", "type": "integer", "name": "endmargin" }, "endtime": { "default": "", "type": "string", "name": "endtime" }, "epgsearchstring": { "default": "", "type": "string", "name": "epgsearchstring" }, "epguid": { "default": "0", "type": "integer", "name": "epguid" }, "file": { "default": "", "type": "string", "name": "file" }, "firstday": { "default": "", "type": "string", "name": "firstday" }, "fulltextepgsearch": { "default": "false", "type": "boolean", "name": "fulltextepgsearch" }, "ismanual": { "default": "false", "type": "boolean", "name": "ismanual" }, "isradio": { "default": "false", "type": "boolean", "name": "isradio" }, "isreadonly": { "default": "false", "type": "boolean", "name": "isreadonly" }, "istimerrule": { "default": "false", "type": "boolean", "name": "istimerrule" }, "lifetime": { "default": "0", "type": "integer", "name": "lifetime" }, "maxrecordings": { "default": "0", "type": "integer", "name": "maxrecordings" }, "preventduplicateepisodes": { "default": "0", "type": "integer", "name": "preventduplicateepisodes" }, "priority": { "default": "0", "type": "integer", "name": "priority" }, "recordinggroup": { "default": "0", "type": "integer", "name": "recordinggroup" }, "runtime": { "default": "0", "type": "integer", "name": "runtime" }, "startanytime": { "default": "false", "type": "boolean", "name": "startanytime" }, "startmargin": { "default": "0", "type": "integer", "name": "startmargin" }, "starttime": { "default": "", "type": "string", "name": "starttime" }, "state": { "default": "unknown", "$ref": "PVR.TimerState", "name": "state" }, "summary": { "default": "", "type": "string", "name": "summary" }, "timerid": { "$ref": "Library.Id", "name": "timerid", "required": true }, "title": { "default": "", "type": "string", "name": "title" }, "weekdays": { "items": { "$ref": "Global.Weekday" }, "type": "array", "name": "weekdays" } } }

PVR.Fields.Broadcast

Extends:

• Item.Fields.Base

JSON Schema Description

{ "extends": [ "Item.Fields.Base" ], "id": "PVR.Fields.Broadcast", "items": { "enums": [ "title", "plot", "plotoutline", "starttime", "endtime", "runtime", "progress", "progresspercentage", "genre", "episodename", "episodenum", "episodepart", "firstaired", "hastimer", "isactive", "parentalrating", "wasactive", "thumbnail", "rating", "originaltitle", "cast", "director", "writer", "year", "imdbnumber", "hastimerrule", "hasrecording", "recording", "isseries" ], "type": "string" } }

PVR.Fields.Channel

Extends:

• Item.Fields.Base

JSON Schema Description
{ "extends": [ "Item.Fields.Base" ], "id": "PVR.Fields.Channel", "items": { "enums": [ "thumbnail", "channeltype", "hidden", "locked", "channel", "lastplayed", "broadcastnow", "broadcastnext", "uniqueid", "icon", "channelnumber", "subchannelnumber", "isrecording" ], "type": "string" } }

PVR.Fields.Recording

Extends:

• Item.Fields.Base

JSON Schema Description
{ "extends": [ "Item.Fields.Base" ], "id": "PVR.Fields.Recording", "items": { "enums": [ "title", "plot", "plotoutline", "genre", "playcount", "resume", "channel", "starttime", "endtime", "runtime", "lifetime", "icon", "art", "streamurl", "file", "directory", "radio", "isdeleted", "epgeventid", "channeluid" ], "type": "string" } }

PVR.Fields.Timer

Extends:

• Item.Fields.Base

JSON Schema Description

{ "extends": [ "Item.Fields.Base" ], "id": "PVR.Fields.Timer", "items": { "enums": [ "title", "summary", "channelid", "isradio", "istimerrule", "ismanual", "starttime", "endtime", "runtime", "lifetime", "firstday", "weekdays", "priority", "startmargin", "endmargin", "state", "file", "directory", "preventduplicateepisodes", "startanytime", "endanytime", "epgsearchstring", "fulltextepgsearch", "recordinggroup", "maxrecordings", "epguid", "isreadonly" ], "type": "string" } }

PVR.Property.Name

Type: string

JSON Schema Description
{ "enums": [ "available", "recording", "scanning" ], "id": "PVR.Property.Name", "type": "string", "default": "available" }

PVR.Property.Value

Type: mixed
Properties:

• [ boolean available = false ]
• [ boolean recording = false ]
• [ boolean scanning = false ]

JSON Schema Description
{ "id": "PVR.Property.Value", "type": "object", "properties": { "available": { "default": "false", "type": "boolean", "name": "available" }, "recording": { "default": "false", "type": "boolean", "name": "recording" }, "scanning": { "default": "false", "type": "boolean", "name": "scanning" } } }

PVR.TimerState

Type: string

JSON Schema Description
{ "enums": [ "unknown", "new", "scheduled", "recording", "completed", "aborted", "cancelled", "conflict_ok", "conflict_notok", "error", "disabled" ], "id": "PVR.TimerState", "type": "string", "default": "unknown" }

Setting

Setting.Details.Base

Type: mixed
Properties:

• [ string help ]
• string id
• string label

JSON Schema Description
{ "id": "Setting.Details.Base", "type": "object", "properties": { "help": { "default": "", "type": "string", "name": "help" }, "id": { "type": "string", "name": "id", "required": true }, "label": { "type": "string", "name": "label", "required": true } } }

Setting.Details.Category

Extends:

• Setting.Details.Base

Properties:

• [ Setting.Details.Group[] groups ]

JSON Schema Description
{ "extends": [ "Setting.Details.Base" ], "id": "Setting.Details.Category", "properties": { "groups": { "items": { "$ref": "Setting.Details.Group" }, "type": "array", "name": "groups" } } }

Setting.Details.Control

Type: mixed

JSON Schema Description
{ "id": "Setting.Details.Control", "type": [ { "$ref": "Setting.Details.ControlCheckmark" }, { "$ref": "Setting.Details.ControlSpinner" }, { "$ref": "Setting.Details.ControlEdit" }, { "$ref": "Setting.Details.ControlButton" }, { "$ref": "Setting.Details.ControlList" }, { "$ref": "Setting.Details.ControlSlider" }, { "$ref": "Setting.Details.ControlRange" } ] }

Setting.Details.ControlBase

Type: mixed
Properties:

• boolean delayed
• string format
• string type

JSON Schema Description
{ "id": "Setting.Details.ControlBase", "type": "object", "properties": { "delayed": { "type": "boolean", "name": "delayed", "required": true }, "format": { "type": "string", "name": "format", "required": true }, "type": { "type": "string", "name": "type", "required": true } } }

Setting.Details.ControlButton

Extends:

• Setting.Details.ControlHeading

Properties:

• string type

JSON Schema Description
{ "extends": [ "Setting.Details.ControlHeading" ], "id": "Setting.Details.ControlButton", "properties": { "type": { "type": "string", "name": "type", "required": true } } }

Setting.Details.ControlCheckmark

Extends:

• Setting.Details.ControlBase

Properties:

• string format
• string type

JSON Schema Description
{ "extends": [ "Setting.Details.ControlBase" ], "id": "Setting.Details.ControlCheckmark", "properties": { "format": { "type": "string", "name": "format", "required": true }, "type": { "type": "string", "name": "type", "required": true } } }

Setting.Details.ControlEdit

Extends:

• Setting.Details.ControlHeading

Properties:

• boolean hidden
• string type
• boolean verifynewvalue

JSON Schema Description
{ "extends": [ "Setting.Details.ControlHeading" ], "id": "Setting.Details.ControlEdit", "properties": { "hidden": { "type": "boolean", "name": "hidden", "required": true }, "type": { "type": "string", "name": "type", "required": true }, "verifynewvalue": { "type": "boolean", "name": "verifynewvalue", "required": true } } }

Setting.Details.ControlHeading

Extends:

• Setting.Details.ControlBase

Properties:

• [ string heading ]

JSON Schema Description
{ "extends": [ "Setting.Details.ControlBase" ], "id": "Setting.Details.ControlHeading", "properties": { "heading": { "default": "", "type": "string", "name": "heading" } } }

Setting.Details.ControlList

Extends:

• Setting.Details.ControlHeading

Properties:

• boolean multiselect
• string type

JSON Schema Description
{ "extends": [ "Setting.Details.ControlHeading" ], "id": "Setting.Details.ControlList", "properties": { "multiselect": { "type": "boolean", "name": "multiselect", "required": true }, "type": { "type": "string", "name": "type", "required": true } } }

Setting.Details.ControlRange

Extends:

• Setting.Details.ControlBase

Properties:

• string formatlabel
• string formatvalue
• string type

JSON Schema Description
{ "extends": [ "Setting.Details.ControlBase" ], "id": "Setting.Details.ControlRange", "properties": { "formatlabel": { "type": "string", "name": "formatlabel", "required": true }, "formatvalue": { "type": "string", "name": "formatvalue", "required": true }, "type": { "type": "string", "name": "type", "required": true } } }

Setting.Details.ControlSlider

Extends:

• Setting.Details.ControlHeading

Properties:

• string formatlabel
• boolean popup
• string type

JSON Schema Description
{ "extends": [ "Setting.Details.ControlHeading" ], "id": "Setting.Details.ControlSlider", "properties": { "formatlabel": { "type": "string", "name": "formatlabel", "required": true }, "popup": { "type": "boolean", "name": "popup", "required": true }, "type": { "type": "string", "name": "type", "required": true } } }

Setting.Details.ControlSpinner

Extends:

• Setting.Details.ControlBase

Properties:

• [ string formatlabel ]
• [ string minimumlabel ]
• string type

JSON Schema Description
{ "extends": [ "Setting.Details.ControlBase" ], "id": "Setting.Details.ControlSpinner", "properties": { "formatlabel": { "default": "", "type": "string", "name": "formatlabel" }, "minimumlabel": { "default": "", "type": "string", "name": "minimumlabel" }, "type": { "type": "string", "name": "type", "required": true } } }

Setting.Details.Group

Type: mixed
Properties:

• string id
• [ Setting.Details.Setting[] settings ]

JSON Schema Description
{ "id": "Setting.Details.Group", "type": "object", "properties": { "id": { "type": "string", "name": "id", "required": true }, "settings": { "items": { "$ref": "Setting.Details.Setting" }, "type": "array", "name": "settings" } } }

Setting.Details.Section

Extends:

• Setting.Details.Base

Properties:

• [ Setting.Details.Category[] categories ]

JSON Schema Description
{ "extends": [ "Setting.Details.Base" ], "id": "Setting.Details.Section", "properties": { "categories": { "items": { "$ref": "Setting.Details.Category" }, "type": "array", "name": "categories" } } }

Setting.Details.Setting

Type: mixed

JSON Schema Description
{ "id": "Setting.Details.Setting", "type": [ { "$ref": "Setting.Details.SettingBool" }, { "$ref": "Setting.Details.SettingInt" }, { "$ref": "Setting.Details.SettingNumber" }, { "$ref": "Setting.Details.SettingString" }, { "$ref": "Setting.Details.SettingAction" }, { "$ref": "Setting.Details.SettingList" }, { "$ref": "Setting.Details.SettingPath" }, { "$ref": "Setting.Details.SettingAddon" } ] }

Setting.Details.SettingAction

Extends:

• Setting.Details.SettingBase

JSON Schema Description
{ "extends": [ "Setting.Details.SettingBase" ], "id": "Setting.Details.SettingAction" }

Setting.Details.SettingAddon

Extends:

• Setting.Details.SettingString

Properties:

• Addon.Types addontype

JSON Schema Description
{ "extends": [ "Setting.Details.SettingString" ], "id": "Setting.Details.SettingAddon", "properties": { "addontype": { "$ref": "Addon.Types", "name": "addontype", "required": true } } }

Setting.Details.SettingBase

Extends:

• Setting.Details.Base

Properties:

• [ Setting.Details.Control control ]
• boolean enabled
• Setting.Level level
• [ string parent ]
• Setting.Type type

JSON Schema Description

{ "extends": [ "Setting.Details.Base" ], "id": "Setting.Details.SettingBase", "properties": { "control": { "$ref": "Setting.Details.Control", "name": "control" }, "enabled": { "type": "boolean", "name": "enabled", "required": true }, "level": { "$ref": "Setting.Level", "name": "level", "required": true }, "parent": { "default": "", "type": "string", "name": "parent" }, "type": { "$ref": "Setting.Type", "name": "type", "required": true } } }

Setting.Details.SettingBool

Extends:

• Setting.Details.SettingBase

Properties:

• boolean default
• boolean value

JSON Schema Description
{ "extends": [ "Setting.Details.SettingBase" ], "id": "Setting.Details.SettingBool", "properties": { "default": { "type": "boolean", "name": "default", "required": true }, "value": { "type": "boolean", "name": "value", "required": true } } }

Setting.Details.SettingInt

Extends:

• Setting.Details.SettingBase

Properties:

• integer default
• [ integer maximum = "0" ]
• [ integer minimum = "0" ]
• [ object options ]
• [ integer step = "0" ]
• integer value

JSON Schema Description

{ "extends": [ "Setting.Details.SettingBase" ], "id": "Setting.Details.SettingInt", "properties": { "default": { "type": "integer", "name": "default", "required": true }, "maximum": { "default": "0", "type": "integer", "name": "maximum" }, "minimum": { "default": "0", "type": "integer", "name": "minimum" }, "options": { "items": { "properties": { "label": { "required": true, "type": "string" }, "value": { "required": true, "type": "integer" } }, "type": "object" }, "type": "array", "name": "options" }, "step": { "default": "0", "type": "integer", "name": "step" }, "value": { "type": "integer", "name": "value", "required": true } } }

Setting.Details.SettingList

Extends:

• Setting.Details.SettingBase

Properties:

• Setting.Value.List default
• Setting.Details.Setting definition
• string delimiter
• Setting.Type elementtype
• [ integer maximumitems = "0" ]
• [ integer minimumitems = "0" ]
• Setting.Value.List value

JSON Schema Description

{ "extends": [ "Setting.Details.SettingBase" ], "id": "Setting.Details.SettingList", "properties": { "default": { "$ref": "Setting.Value.List", "name": "default", "required": true }, "definition": { "$ref": "Setting.Details.Setting", "name": "definition", "required": true }, "delimiter": { "type": "string", "name": "delimiter", "required": true }, "elementtype": { "$ref": "Setting.Type", "name": "elementtype", "required": true }, "maximumitems": { "default": "0", "type": "integer", "name": "maximumitems" }, "minimumitems": { "default": "0", "type": "integer", "name": "minimumitems" }, "value": { "$ref": "Setting.Value.List", "name": "value", "required": true } } }

Setting.Details.SettingNumber

Extends:

• Setting.Details.SettingBase

Properties:

• number default
• number maximum
• number minimum
• number step
• number value

JSON Schema Description

{ "extends": [ "Setting.Details.SettingBase" ], "id": "Setting.Details.SettingNumber", "properties": { "default": { "type": "number", "name": "default", "required": true }, "maximum": { "type": "number", "name": "maximum", "required": true }, "minimum": { "type": "number", "name": "minimum", "required": true }, "step": { "type": "number", "name": "step", "required": true }, "value": { "type": "number", "name": "value", "required": true } } }

Setting.Details.SettingPath

Extends:

• Setting.Details.SettingString

Properties:

• [ string[] sources ]
• boolean writable

JSON Schema Description
{ "extends": [ "Setting.Details.SettingString" ], "id": "Setting.Details.SettingPath", "properties": { "sources": { "items": { "type": "string" }, "type": "array", "name": "sources" }, "writable": { "type": "boolean", "name": "writable", "required": true } } }

Setting.Details.SettingString

Extends:

• Setting.Details.SettingBase

Properties:

• boolean allowempty
• string default
• [ object options ]
• string value

JSON Schema Description

{ "extends": [ "Setting.Details.SettingBase" ], "id": "Setting.Details.SettingString", "properties": { "allowempty": { "type": "boolean", "name": "allowempty", "required": true }, "default": { "type": "string", "name": "default", "required": true }, "options": { "items": { "properties": { "label": { "required": true, "type": "string" }, "value": { "required": true, "type": "string" } }, "type": "object" }, "type": "array", "name": "options" }, "value": { "type": "string", "name": "value", "required": true } } }

Setting.Level

Type: string

JSON Schema Description
{ "enums": [ "basic", "standard", "advanced", "expert" ], "id": "Setting.Level", "type": "string", "default": "basic" }

Setting.Type

Type: string

JSON Schema Description
{ "enums": [ "boolean", "integer", "number", "string", "action", "list", "path", "addon" ], "id": "Setting.Type", "type": "string", "default": "boolean" }

Setting.Value

Type: mixed

JSON Schema Description
{ "id": "Setting.Value", "type": [ { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }

Setting.Value.Extended

Type: mixed

JSON Schema Description
{ "id": "Setting.Value.Extended", "type": [ { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "string" }, { "$ref": "Setting.Value.List" } ] }

Setting.Value.List

Type: mixed

JSON Schema Description
{ "id": "Setting.Value.List", "type": "array", "items": { "$ref": "Setting.Value" } }

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: mixed
Properties:

• [ boolean canhibernate = false ]
• [ boolean canreboot = false ]
• [ boolean canshutdown = false ]
• [ boolean cansuspend = false ]

JSON Schema Description
{ "id": "System.Property.Value", "type": "object", "properties": { "canhibernate": { "default": "false", "type": "boolean", "name": "canhibernate" }, "canreboot": { "default": "false", "type": "boolean", "name": "canreboot" }, "canshutdown": { "default": "false", "type": "boolean", "name": "canshutdown" }, "cansuspend": { "default": "false", "type": "boolean", "name": "cansuspend" } } }

Textures

Textures.Details.Size

Type: mixed
Properties:

• [ integer height = "0" ] Height of texture
• [ string lastused ] Date of last use
• [ integer size = "0" ] Size of the texture (1 == largest)
• [ integer usecount = "0" ] Number of uses
• [ integer width = "0" ] Width of texture

JSON Schema Description

{ "id": "Textures.Details.Size", "type": "object", "properties": { "height": { "default": "0", "description": "Height of texture", "type": "integer", "name": "height" }, "lastused": { "default": "", "description": "Date of last use", "type": "string", "name": "lastused" }, "size": { "default": "0", "description": "Size of the texture (1 == largest)", "type": "integer", "name": "size" }, "usecount": { "default": "0", "description": "Number of uses", "type": "integer", "name": "usecount" }, "width": { "default": "0", "description": "Width of texture", "type": "integer", "name": "width" } } }

Textures.Details.Texture

Type: mixed
Properties:

• [ string cachedurl ] Cached URL on disk
• [ string imagehash ] Hash of image
• [ string lasthashcheck ] Last time source was checked for changes
• [ Textures.Details.Size[] sizes ]
• [ Library.Id textureid = "-1" ]
• [ string url ] Original source URL

JSON Schema Description

{ "id": "Textures.Details.Texture", "type": "object", "properties": { "cachedurl": { "default": "", "description": "Cached URL on disk", "type": "string", "name": "cachedurl" }, "imagehash": { "default": "", "description": "Hash of image", "type": "string", "name": "imagehash" }, "lasthashcheck": { "default": "", "description": "Last time source was checked for changes", "type": "string", "name": "lasthashcheck" }, "sizes": { "items": { "$ref": "Textures.Details.Size" }, "type": "array", "name": "sizes" }, "textureid": { "default": "-1", "$ref": "Library.Id", "name": "textureid" }, "url": { "default": "", "description": "Original source URL", "type": "string", "name": "url" } } }

Textures.Fields.Texture

Extends:

• Item.Fields.Base

JSON Schema Description
{ "extends": [ "Item.Fields.Base" ], "id": "Textures.Fields.Texture", "items": { "enums": [ "url", "cachedurl", "lasthashcheck", "imagehash", "sizes" ], "type": "string" } }

Video

Video.Cast

Type: mixed

JSON Schema Description
{ "id": "Video.Cast", "type": "array", "items": { "additionalProperties": false, "properties": { "name": { "required": true, "type": "string" }, "order": { "required": true, "type": "integer" }, "role": { "required": true, "type": "string" }, "thumbnail": { "default": "", "type": "string" } }, "type": "object" } }

Video.Details.Base

Extends:

• Media.Details.Base

Properties:

• [ Media.Artwork art ]
• [ integer playcount = "0" ]

JSON Schema Description
{ "extends": [ "Media.Details.Base" ], "id": "Video.Details.Base", "properties": { "art": { "$ref": "Media.Artwork", "name": "art" }, "playcount": { "default": "0", "type": "integer", "name": "playcount" } } }

Video.Details.Episode

Extends:

• Video.Details.File

Properties:

• [ Video.Cast cast ]
• [ integer episode = "0" ]
• Library.Id episodeid
• [ string firstaired ]
• [ string originaltitle ]
• [ string productioncode ]
• [ number rating = "0" ]
• [ mixed ratings ]
• [ integer season = "0" ]
• [ Library.Id seasonid = "-1" ]
• [ string showtitle ]
• [ integer specialsortepisode = "0" ]
• [ integer specialsortseason = "0" ]
• [ Library.Id tvshowid = "-1" ]
• [ Media.UniqueID uniqueid ]
• [ integer userrating = "0" ]
• [ string votes ]
• [ Array.String writer ]

JSON Schema Description

{ "extends": [ "Video.Details.File" ], "id": "Video.Details.Episode", "properties": { "cast": { "$ref": "Video.Cast", "name": "cast" }, "episode": { "default": "0", "type": "integer", "name": "episode" }, "episodeid": { "$ref": "Library.Id", "name": "episodeid", "required": true }, "firstaired": { "default": "", "type": "string", "name": "firstaired" }, "originaltitle": { "default": "", "type": "string", "name": "originaltitle" }, "productioncode": { "default": "", "type": "string", "name": "productioncode" }, "rating": { "default": "0", "type": "number", "name": "rating" }, "ratings": { "type": "any", "name": "ratings" }, "season": { "default": "0", "type": "integer", "name": "season" }, "seasonid": { "default": "-1", "$ref": "Library.Id", "name": "seasonid" }, "showtitle": { "default": "", "type": "string", "name": "showtitle" }, "specialsortepisode": { "default": "0", "type": "integer", "name": "specialsortepisode" }, "specialsortseason": { "default": "0", "type": "integer", "name": "specialsortseason" }, "tvshowid": { "default": "-1", "$ref": "Library.Id", "name": "tvshowid" }, "uniqueid": { "$ref": "Media.UniqueID", "name": "uniqueid" }, "userrating": { "default": "0", "type": "integer", "name": "userrating" }, "votes": { "default": "", "type": "string", "name": "votes" }, "writer": { "$ref": "Array.String", "name": "writer" } } }

Video.Details.File

Extends:

• Video.Details.Item

Properties:

• [ Array.String director ]
• [ Video.Resume resume ]
• [ integer runtime = "0" ] Runtime in seconds
• [ Video.Streams streamdetails ]

JSON Schema Description
{ "extends": [ "Video.Details.Item" ], "id": "Video.Details.File", "properties": { "director": { "$ref": "Array.String", "name": "director" }, "resume": { "$ref": "Video.Resume", "name": "resume" }, "runtime": { "default": "0", "description": "Runtime in seconds", "type": "integer", "name": "runtime" }, "streamdetails": { "$ref": "Video.Streams", "name": "streamdetails" } } }

Video.Details.Item

Extends:

• Video.Details.Media

Properties:

• [ string dateadded ]
• [ string file ]
• [ string lastplayed ]
• [ string plot ]

JSON Schema Description
{ "extends": [ "Video.Details.Media" ], "id": "Video.Details.Item", "properties": { "dateadded": { "default": "", "type": "string", "name": "dateadded" }, "file": { "default": "", "type": "string", "name": "file" }, "lastplayed": { "default": "", "type": "string", "name": "lastplayed" }, "plot": { "default": "", "type": "string", "name": "plot" } } }

Video.Details.Media

Extends:

• Video.Details.Base

Properties:

• [ string title ]

JSON Schema Description
{ "extends": [ "Video.Details.Base" ], "id": "Video.Details.Media", "properties": { "title": { "default": "", "type": "string", "name": "title" } } }

Video.Details.Movie

Extends:

• Video.Details.File

Properties:

• [ Video.Cast cast ]
• [ Array.String country ]
• [ Array.String genre ]
• [ string imdbnumber ]
• Library.Id movieid
• [ string mpaa ]
• [ string originaltitle ]
• [ string plotoutline ]
• [ string premiered ]
• [ number rating = "0" ]
• [ mixed ratings ]
• [ string set ]
• [ Library.Id setid = "-1" ]
• [ Array.String showlink ]
• [ string sorttitle ]
• [ Array.String studio ]
• [ Array.String tag ]
• [ string tagline ]
• [ integer top250 = "0" ]
• [ string trailer ]
• [ Media.UniqueID uniqueid ]
• [ integer userrating = "0" ]
• [ string votes ]
• [ Array.String writer ]
• [ integer year = "0" ]

JSON Schema Description

{ "extends": [ "Video.Details.File" ], "id": "Video.Details.Movie", "properties": { "cast": { "$ref": "Video.Cast", "name": "cast" }, "country": { "$ref": "Array.String", "name": "country" }, "genre": { "$ref": "Array.String", "name": "genre" }, "imdbnumber": { "default": "", "type": "string", "name": "imdbnumber" }, "movieid": { "$ref": "Library.Id", "name": "movieid", "required": true }, "mpaa": { "default": "", "type": "string", "name": "mpaa" }, "originaltitle": { "default": "", "type": "string", "name": "originaltitle" }, "plotoutline": { "default": "", "type": "string", "name": "plotoutline" }, "premiered": { "default": "", "type": "string", "name": "premiered" }, "rating": { "default": "0", "type": "number", "name": "rating" }, "ratings": { "type": "any", "name": "ratings" }, "set": { "default": "", "type": "string", "name": "set" }, "setid": { "default": "-1", "$ref": "Library.Id", "name": "setid" }, "showlink": { "$ref": "Array.String", "name": "showlink" }, "sorttitle": { "default": "", "type": "string", "name": "sorttitle" }, "studio": { "$ref": "Array.String", "name": "studio" }, "tag": { "$ref": "Array.String", "name": "tag" }, "tagline": { "default": "", "type": "string", "name": "tagline" }, "top250": { "default": "0", "type": "integer", "name": "top250" }, "trailer": { "default": "", "type": "string", "name": "trailer" }, "uniqueid": { "$ref": "Media.UniqueID", "name": "uniqueid" }, "userrating": { "default": "0", "type": "integer", "name": "userrating" }, "votes": { "default": "", "type": "string", "name": "votes" }, "writer": { "$ref": "Array.String", "name": "writer" }, "year": { "default": "0", "type": "integer", "name": "year" } } }

Video.Details.MovieSet

Extends:

• Video.Details.Media

Properties:

• [ string plot ]
• Library.Id setid

JSON Schema Description
{ "extends": [ "Video.Details.Media" ], "id": "Video.Details.MovieSet", "properties": { "plot": { "default": "", "type": "string", "name": "plot" }, "setid": { "$ref": "Library.Id", "name": "setid", "required": true } } }

Video.Details.MovieSet.Extended

Extends:

• Video.Details.MovieSet

Properties:

• List.LimitsReturned limits
• [ Video.Details.Movie[] movies ]

JSON Schema Description
{ "extends": [ "Video.Details.MovieSet" ], "id": "Video.Details.MovieSet.Extended", "properties": { "limits": { "$ref": "List.LimitsReturned", "name": "limits", "required": true }, "movies": { "items": { "$ref": "Video.Details.Movie" }, "type": "array", "name": "movies" } } }

Video.Details.MusicVideo

Extends:

• Video.Details.File

Properties:

• [ string album ]
• [ Array.String artist ]
• [ Array.String genre ]
• Library.Id musicvideoid
• [ string premiered ]
• [ number rating = "0" ]
• [ Array.String studio ]
• [ Array.String tag ]
• [ integer track = "0" ]
• [ integer userrating = "0" ]
• [ integer year = "0" ]

JSON Schema Description

{ "extends": [ "Video.Details.File" ], "id": "Video.Details.MusicVideo", "properties": { "album": { "default": "", "type": "string", "name": "album" }, "artist": { "$ref": "Array.String", "name": "artist" }, "genre": { "$ref": "Array.String", "name": "genre" }, "musicvideoid": { "$ref": "Library.Id", "name": "musicvideoid", "required": true }, "premiered": { "default": "", "type": "string", "name": "premiered" }, "rating": { "default": "0", "type": "number", "name": "rating" }, "studio": { "$ref": "Array.String", "name": "studio" }, "tag": { "$ref": "Array.String", "name": "tag" }, "track": { "default": "0", "type": "integer", "name": "track" }, "userrating": { "default": "0", "type": "integer", "name": "userrating" }, "year": { "default": "0", "type": "integer", "name": "year" } } }

Video.Details.Season

Extends:

• Video.Details.Base

Properties:

• [ integer episode = "0" ]
• integer season
• Library.Id seasonid
• [ string showtitle ]
• [ Library.Id tvshowid = "-1" ]
• [ integer userrating = "0" ]
• [ integer watchedepisodes = "0" ]

JSON Schema Description

{ "extends": [ "Video.Details.Base" ], "id": "Video.Details.Season", "properties": { "episode": { "default": "0", "type": "integer", "name": "episode" }, "season": { "type": "integer", "name": "season", "required": true }, "seasonid": { "$ref": "Library.Id", "name": "seasonid", "required": true }, "showtitle": { "default": "", "type": "string", "name": "showtitle" }, "tvshowid": { "default": "-1", "$ref": "Library.Id", "name": "tvshowid" }, "userrating": { "default": "0", "type": "integer", "name": "userrating" }, "watchedepisodes": { "default": "0", "type": "integer", "name": "watchedepisodes" } } }

Video.Details.TVShow

Extends:

• Video.Details.Item

Properties:

• [ Video.Cast cast ]
• [ integer episode = "0" ]
• [ string episodeguide ]
• [ Array.String genre ]
• [ string imdbnumber ]
• [ string mpaa ]
• [ string originaltitle ]
• [ string premiered ]
• [ number rating = "0" ]
• [ mixed ratings ]
• [ integer runtime = "0" ] Runtime in seconds
• [ integer season = "0" ]
• [ string sorttitle ]
• [ Array.String studio ]
• [ Array.String tag ]
• Library.Id tvshowid
• [ Media.UniqueID uniqueid ]
• [ integer userrating = "0" ]
• [ string votes ]
• [ integer watchedepisodes = "0" ]
• [ integer year = "0" ]

JSON Schema Description

{ "extends": [ "Video.Details.Item" ], "id": "Video.Details.TVShow", "properties": { "cast": { "$ref": "Video.Cast", "name": "cast" }, "episode": { "default": "0", "type": "integer", "name": "episode" }, "episodeguide": { "default": "", "type": "string", "name": "episodeguide" }, "genre": { "$ref": "Array.String", "name": "genre" }, "imdbnumber": { "default": "", "type": "string", "name": "imdbnumber" }, "mpaa": { "default": "", "type": "string", "name": "mpaa" }, "originaltitle": { "default": "", "type": "string", "name": "originaltitle" }, "premiered": { "default": "", "type": "string", "name": "premiered" }, "rating": { "default": "0", "type": "number", "name": "rating" }, "ratings": { "type": "any", "name": "ratings" }, "runtime": { "default": "0", "description": "Runtime in seconds", "type": "integer", "name": "runtime" }, "season": { "default": "0", "type": "integer", "name": "season" }, "sorttitle": { "default": "", "type": "string", "name": "sorttitle" }, "studio": { "$ref": "Array.String", "name": "studio" }, "tag": { "$ref": "Array.String", "name": "tag" }, "tvshowid": { "$ref": "Library.Id", "name": "tvshowid", "required": true }, "uniqueid": { "$ref": "Media.UniqueID", "name": "uniqueid" }, "userrating": { "default": "0", "type": "integer", "name": "userrating" }, "votes": { "default": "", "type": "string", "name": "votes" }, "watchedepisodes": { "default": "0", "type": "integer", "name": "watchedepisodes" }, "year": { "default": "0", "type": "integer", "name": "year" } } }

Video.Fields.Episode

Extends:

• Item.Fields.Base

JSON Schema Description

{ "extends": [ "Item.Fields.Base" ], "id": "Video.Fields.Episode", "items": { "description": "Requesting the cast, ratings, streamdetails, uniqueid and/or tag field will result in increased response times", "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", "specialsortseason", "specialsortepisode", "userrating", "seasonid", "ratings" ], "type": "string" } }

Video.Fields.Movie

Extends:

• Item.Fields.Base

JSON Schema Description

{ "extends": [ "Item.Fields.Base" ], "id": "Video.Fields.Movie", "items": { "description": "Requesting the cast, ratings, showlink, streamdetails, uniqueid and/or tag field will result in increased response times", "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", "userrating", "ratings", "premiered", "uniqueid" ], "type": "string" } }

Video.Fields.MovieSet

Extends:

• Item.Fields.Base

JSON Schema Description
{ "extends": [ "Item.Fields.Base" ], "id": "Video.Fields.MovieSet", "items": { "enums": [ "title", "playcount", "fanart", "thumbnail", "art", "plot" ], "type": "string" } }

Video.Fields.MusicVideo

Extends:

• Item.Fields.Base

JSON Schema Description

{ "extends": [ "Item.Fields.Base" ], "id": "Video.Fields.MusicVideo", "items": { "description": "Requesting the streamdetails and/or tag field will result in increased response times", "enums": [ "title", "playcount", "runtime", "director", "studio", "year", "plot", "album", "artist", "genre", "track", "streamdetails", "lastplayed", "fanart", "thumbnail", "file", "resume", "dateadded", "tag", "art", "rating", "userrating", "premiered" ], "type": "string" } }

Video.Fields.Season

Extends:

• Item.Fields.Base

JSON Schema Description
{ "extends": [ "Item.Fields.Base" ], "id": "Video.Fields.Season", "items": { "enums": [ "season", "showtitle", "playcount", "episode", "fanart", "thumbnail", "tvshowid", "watchedepisodes", "art", "userrating" ], "type": "string" } }

Video.Fields.TVShow

Extends:

• Item.Fields.Base

JSON Schema Description

{ "extends": [ "Item.Fields.Base" ], "id": "Video.Fields.TVShow", "items": { "description": "Requesting the cast, ratings, uniqueid and/or tag field will result in increased response times", "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", "userrating", "ratings", "runtime", "uniqueid" ], "type": "string" } }

Video.Rating

Type: mixed
Properties:

• [ boolean default = false ]
• number rating
• [ integer votes = "0" ]

JSON Schema Description
{ "id": "Video.Rating", "type": "object", "properties": { "default": { "default": "false", "type": "boolean", "name": "default" }, "rating": { "type": "number", "name": "rating", "required": true }, "votes": { "default": "0", "type": "integer", "name": "votes" } } }

Video.Ratings

Type: mixed

JSON Schema Description
{ "id": "Video.Ratings", "type": "object" }

Video.Ratings.Set

Type: mixed

JSON Schema Description
{ "id": "Video.Ratings.Set", "type": "object" }

Video.Resume

Type: mixed
Properties:

• [ number position = "0" ]
• [ number total = "0" ]

JSON Schema Description
{ "id": "Video.Resume", "type": "object", "properties": { "position": { "default": "0", "type": "number", "name": "position" }, "total": { "default": "0", "type": "number", "name": "total" } } }

Video.Streams

Type: mixed
Properties:

• [ object audio ]
• [ object subtitle ]
• [ object video ]

JSON Schema Description

{ "id": "Video.Streams", "type": "object", "properties": { "audio": { "items": { "properties": { "channels": { "default": 0, "type": "integer" }, "codec": { "default": "", "type": "string" }, "language": { "default": "", "type": "string" } }, "type": "object" }, "type": "array", "name": "audio" }, "subtitle": { "items": { "properties": { "language": { "default": "", "type": "string" } }, "type": "object" }, "type": "array", "name": "subtitle" }, "video": { "items": { "properties": { "aspect": { "default": 0, "type": "number" }, "codec": { "default": "", "type": "string" }, "duration": { "default": 0, "type": "integer" }, "height": { "default": 0, "type": "integer" }, "width": { "default": 0, "type": "integer" } }, "type": "object" }, "type": "array", "name": "video" } } }

Notifications

Application

Application.OnVolumeChanged

The volume of the application has changed. Parameters:

1. string sender
2. object data

Properties:

• boolean muted
• integer volume

JSON Schema Description
{ "description": "The volume of the application has changed.", "params": [ { "type": "string", "name": "sender", "required": true }, { "properties": { "muted": { "type": "boolean", "name": "muted", "required": true }, "volume": { "type": "integer", "name": "volume", "required": true } }, "type": "object", "name": "data", "required": true } ] }

AudioLibrary

AudioLibrary.OnCleanFinished

The audio library has been cleaned. Parameters:

1. string sender

JSON Schema Description
{ "description": "The audio library has been cleaned.", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "null", "name": "data", "required": true } ] }

AudioLibrary.OnCleanStarted

An audio library clean operation has started. Parameters:

1. string sender

JSON Schema Description
{ "description": "An audio library clean operation has started.", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "null", "name": "data", "required": true } ] }

AudioLibrary.OnExport

An audio library export has finished. Parameters:

1. string sender
2. object data

Properties:

• [ integer failcount = "0" ]
• [ string file ]

JSON Schema Description
{ "description": "An audio library export has finished.", "params": [ { "type": "string", "name": "sender", "required": true }, { "properties": { "failcount": { "default": "0", "type": "integer", "name": "failcount" }, "file": { "default": "", "type": "string", "name": "file" } }, "type": "object", "name": "data" } ] }

AudioLibrary.OnRemove

An audio item has been removed. Parameters:

1. string sender
2. object data

Properties:

• Library.Id id
• [ Optional.Boolean transaction ] True if the removal is being performed within a transaction.
• Notifications.Library.Audio.Type type

JSON Schema Description

{ "description": "An audio item has been removed.", "params": [ { "type": "string", "name": "sender", "required": true }, { "properties": { "id": { "$ref": "Library.Id", "name": "id", "required": true }, "transaction": { "description": "True if the removal is being performed within a transaction.", "$ref": "Optional.Boolean", "name": "transaction" }, "type": { "$ref": "Notifications.Library.Audio.Type", "name": "type", "required": true } }, "type": "object", "name": "data", "required": true } ] }

AudioLibrary.OnScanFinished

Scanning the audio library has been finished. Parameters:

1. string sender

JSON Schema Description
{ "description": "Scanning the audio library has been finished.", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "null", "name": "data", "required": true } ] }

AudioLibrary.OnScanStarted

An audio library scan has started. Parameters:

1. string sender

JSON Schema Description
{ "description": "An audio library scan has started.", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "null", "name": "data", "required": true } ] }

AudioLibrary.OnUpdate

An audio item has been updated. Parameters:

1. string sender
2. object data

Properties:

• Library.Id id
• [ Optional.Boolean transaction ] True if the update is being performed within a transaction.
• string type

JSON Schema Description

{ "description": "An audio item has been updated.", "params": [ { "type": "string", "name": "sender", "required": true }, { "properties": { "id": { "$ref": "Library.Id", "name": "id", "required": true }, "transaction": { "description": "True if the update is being performed within a transaction.", "$ref": "Optional.Boolean", "name": "transaction" }, "type": { "type": "string", "name": "type", "required": true } }, "type": "object", "name": "data", "required": true } ] }

GUI

GUI.OnDPMSActivated

Energy saving/DPMS has been activated. Parameters:

1. string sender

JSON Schema Description
{ "description": "Energy saving/DPMS has been activated.", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "null", "name": "data", "required": true } ] }

GUI.OnDPMSDeactivated

Energy saving/DPMS has been deactivated. Parameters:

1. string sender

JSON Schema Description
{ "description": "Energy saving/DPMS has been deactivated.", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "null", "name": "data", "required": true } ] }

GUI.OnScreensaverActivated

The screensaver has been activated. Parameters:

1. string sender

JSON Schema Description
{ "description": "The screensaver has been activated.", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "null", "name": "data", "required": true } ] }

GUI.OnScreensaverDeactivated

The screensaver has been deactivated. Parameters:

1. string sender
2. object data

Properties:

• boolean shuttingdown

JSON Schema Description
{ "description": "The screensaver has been deactivated.", "params": [ { "type": "string", "name": "sender", "required": true }, { "properties": { "shuttingdown": { "type": "boolean", "name": "shuttingdown", "required": true } }, "type": "object", "name": "data", "required": true } ] }

Input

Input.OnInputFinished

The user has provided the requested input. Parameters:

1. string sender

JSON Schema Description
{ "description": "The user has provided the requested input.", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "null", "name": "data", "required": true } ] }

Input.OnInputRequested

The user is requested to provide some information. Parameters:

1. string sender
2. object data

Properties:

• [ string title ]
• string type
• string value

JSON Schema Description
{ "description": "The user is requested to provide some information.", "params": [ { "type": "string", "name": "sender", "required": true }, { "properties": { "title": { "type": "string", "name": "title" }, "type": { "type": "string", "name": "type", "required": true }, "value": { "type": "string", "name": "value", "required": true } }, "type": "object", "name": "data", "required": true } ] }

Player

Player.OnPause

Playback of a media item has been paused. If there is no ID available extra information will be provided. Parameters:

1. string sender
2. ' data

JSON Schema Description
{ "description": "Playback of a media item has been paused. If there is no ID available extra information will be provided.", "params": [ { "type": "string", "name": "sender", "required": true }, { "$ref": "Player.Notifications.Data", "name": "data", "required": true } ] }

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:

1. string sender
2. ' data

JSON Schema Description
{ "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.", "params": [ { "type": "string", "name": "sender", "required": true }, { "$ref": "Player.Notifications.Data", "name": "data", "required": true } ] }

Player.OnPropertyChanged

A property of the playing items has changed. Parameters:

1. string sender
2. object data

Properties:

• Player.Notifications.Player player
• [ Player.Property.Value property ]

JSON Schema Description
{ "description": "A property of the playing items has changed.", "params": [ { "type": "string", "name": "sender", "required": true }, { "properties": { "player": { "$ref": "Player.Notifications.Player", "name": "player", "required": true }, "property": { "$ref": "Player.Property.Value", "name": "property" } }, "type": "object", "name": "data", "required": true } ] }

Player.OnSeek

The playback position has been changed. If there is no ID available extra information will be provided. Parameters:

1. string sender
2. object data

Properties:

• [ Notifications.Item item ]
• Player.Notifications.Player.Seek player

JSON Schema Description

{ "description": "The playback position has been changed. If there is no ID available extra information will be provided.", "params": [ { "type": "string", "name": "sender", "required": true }, { "properties": { "item": { "$ref": "Notifications.Item", "name": "item" }, "player": { "$ref": "Player.Notifications.Player.Seek", "name": "player", "required": true } }, "type": "object", "name": "data", "required": true } ] }

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:

1. string sender
2. ' data

JSON Schema Description
{ "description": "Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.", "params": [ { "type": "string", "name": "sender", "required": true }, { "$ref": "Player.Notifications.Data", "name": "data", "required": true } ] }

Player.OnStop

Playback of a media item has been stopped. If there is no ID available extra information will be provided. Parameters:

1. string sender
2. object data

Properties:

• boolean end Whether the player has reached the end of the playable item(s) or not
• [ Notifications.Item item ]

JSON Schema Description

{ "description": "Playback of a media item has been stopped. If there is no ID available extra information will be provided.", "params": [ { "type": "string", "name": "sender", "required": true }, { "properties": { "end": { "description": "Whether the player has reached the end of the playable item(s) or not", "type": "boolean", "name": "end", "required": true }, "item": { "$ref": "Notifications.Item", "name": "item" } }, "type": "object", "name": "data", "required": true } ] }

Playlist

Playlist.OnAdd

A playlist item has been added. Parameters:

1. string sender
2. object data

Properties:

• [ Notifications.Item item ]
• Playlist.Id playlistid
• [ Playlist.Position position ]

JSON Schema Description

{ "description": "A playlist item has been added.", "params": [ { "type": "string", "name": "sender", "required": true }, { "properties": { "item": { "$ref": "Notifications.Item", "name": "item" }, "playlistid": { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, "position": { "$ref": "Playlist.Position", "name": "position" } }, "type": "object", "name": "data", "required": true } ] }

Playlist.OnClear

A playlist item has been cleared. Parameters:

1. string sender
2. object data

Properties:

• Playlist.Id playlistid

JSON Schema Description
{ "description": "A playlist item has been cleared.", "params": [ { "type": "string", "name": "sender", "required": true }, { "properties": { "playlistid": { "$ref": "Playlist.Id", "name": "playlistid", "required": true } }, "type": "object", "name": "data", "required": true } ] }

Playlist.OnRemove

A playlist item has been removed. Parameters:

1. string sender
2. object data

Properties:

• Playlist.Id playlistid
• [ Playlist.Position position ]

JSON Schema Description
{ "description": "A playlist item has been removed.", "params": [ { "type": "string", "name": "sender", "required": true }, { "properties": { "playlistid": { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, "position": { "$ref": "Playlist.Position", "name": "position" } }, "type": "object", "name": "data", "required": true } ] }

System

System.OnLowBattery

The system is on low battery. Parameters:

1. string sender

JSON Schema Description
{ "description": "The system is on low battery.", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "null", "name": "data", "required": true } ] }

System.OnQuit

Kodi will be closed. Parameters:

1. string sender
2. object data

Properties:

• integer exitcode

JSON Schema Description
{ "description": "Kodi will be closed.", "params": [ { "type": "string", "name": "sender", "required": true }, { "properties": { "exitcode": { "type": "integer", "name": "exitcode", "required": true } }, "type": "object", "name": "data", "required": true } ] }

System.OnRestart

The system will be restarted. Parameters:

1. string sender

JSON Schema Description
{ "description": "The system will be restarted.", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "null", "name": "data", "required": true } ] }

System.OnSleep

The system will be suspended. Parameters:

1. string sender

JSON Schema Description
{ "description": "The system will be suspended.", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "null", "name": "data", "required": true } ] }

System.OnWake

The system woke up from suspension. Parameters:

1. string sender

JSON Schema Description
{ "description": "The system woke up from suspension.", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "null", "name": "data", "required": true } ] }

VideoLibrary

VideoLibrary.OnCleanFinished

The video library has been cleaned. Parameters:

1. string sender

JSON Schema Description
{ "description": "The video library has been cleaned.", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "null", "name": "data", "required": true } ] }

VideoLibrary.OnCleanStarted

A video library clean operation has started. Parameters:

1. string sender

JSON Schema Description
{ "description": "A video library clean operation has started.", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "null", "name": "data", "required": true } ] }

VideoLibrary.OnExport

A video library export has finished. Parameters:

1. string sender
2. object data

Properties:

• [ integer failcount = "0" ]
• [ string file ]
• [ string root ]

JSON Schema Description
{ "description": "A video library export has finished.", "params": [ { "type": "string", "name": "sender", "required": true }, { "properties": { "failcount": { "default": "0", "type": "integer", "name": "failcount" }, "file": { "default": "", "type": "string", "name": "file" }, "root": { "default": "", "type": "string", "name": "root" } }, "type": "object", "name": "data" } ] }

VideoLibrary.OnRemove

A video item has been removed. Parameters:

1. string sender
2. object data

Properties:

• Library.Id id
• [ Optional.Boolean transaction ] True if the removal is being performed within a transaction.
• Notifications.Library.Video.Type type

JSON Schema Description

{ "description": "A video item has been removed.", "params": [ { "type": "string", "name": "sender", "required": true }, { "properties": { "id": { "$ref": "Library.Id", "name": "id", "required": true }, "transaction": { "description": "True if the removal is being performed within a transaction.", "$ref": "Optional.Boolean", "name": "transaction" }, "type": { "$ref": "Notifications.Library.Video.Type", "name": "type", "required": true } }, "type": "object", "name": "data", "required": true } ] }

VideoLibrary.OnScanFinished

Scanning the video library has been finished. Parameters:

1. string sender

JSON Schema Description
{ "description": "Scanning the video library has been finished.", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "null", "name": "data", "required": true } ] }

VideoLibrary.OnScanStarted

A video library scan has started. Parameters:

1. string sender

JSON Schema Description
{ "description": "A video library scan has started.", "params": [ { "type": "string", "name": "sender", "required": true }, { "type": "null", "name": "data", "required": true } ] }

VideoLibrary.OnUpdate

A video item has been updated. Parameters:

1. string sender
2. object data

Properties:

• Library.Id id
• [ integer playcount = "-1" ]
• [ Optional.Boolean transaction ] True if the update is being performed within a transaction.
• string type

JSON Schema Description

{ "description": "A video item has been updated.", "params": [ { "type": "string", "name": "sender", "required": true }, { "properties": { "id": { "$ref": "Library.Id", "name": "id", "required": true }, "playcount": { "default": "-1", "type": "integer", "name": "playcount" }, "transaction": { "description": "True if the update is being performed within a transaction.", "$ref": "Optional.Boolean", "name": "transaction" }, "type": { "type": "string", "name": "type", "required": true } }, "type": "object", "name": "data", "required": true } ] }

See also

• JSON-RPC API
• JSON-RPC API v4 (Eden)
• JSON-RPC API v6 (Frodo - Jarvis)

External links

• JSON-RPC 2.0 specification
• A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)