JSON-RPC API/v8
Development | JSON-RPC API | v8 |
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 used by Kodi skins 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:
- string addonid
- [ mixed params ]
- [ 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:
- string addonid
- [ 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:
- [ Addon.Types type = "unknown" ]
- [ Addon.Content content = "unknown" ] Content provided by the addon. Only considered for plugins and scripts.
- [ mixed enabled = "all" ]
- [ Addon.Fields properties ]
- [ List.Limits limits ]
- [ mixed 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:
- string addonid
- 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:
- Application.Property.Name[] properties
Returns:
Type: '
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
Parameters:
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:
- Global.Toggle mute
Returns:
Type: boolean
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:
- 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:
- [ 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:
- [ mixed 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:
- Library.Id albumid
- [ 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:
- [ Audio.Fields.Album properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
- [ mixed filter ]
- [ boolean includesingles = false ]
- [ 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:
- Library.Id artistid
- [ 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:
- [ 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
- [ Audio.Fields.Artist properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
- [ mixed filter ]
- [ 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:
- [ Library.Fields.Genre properties ]
- [ List.Limits limits ]
- [ 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:
- Audio.Property.Name[] properties
Returns:
Type: '
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:
- [ Audio.Fields.Album properties ]
- [ List.Limits limits ]
- [ 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:
- [ List.Amount albumlimit = "-1" ] The amount of recently added albums from which to return the songs
- [ Audio.Fields.Song properties ]
- [ List.Limits limits ]
- [ 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:
- [ Audio.Fields.Album properties ]
- [ List.Limits limits ]
- [ 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:
- [ Audio.Fields.Song properties ]
- [ List.Limits limits ]
- [ 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:
- [ Audio.Fields.Role properties ]
- [ List.Limits limits ]
- [ 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:
- Library.Id songid
- [ 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:
- [ Audio.Fields.Song properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
- [ mixed filter ]
- [ boolean includesingles = true ]
- [ 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:
- [ string directory ]
- [ 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:
- Library.Id albumid
- [ Optional.String title ]
- [ mixed artist ]
- [ Optional.String description ]
- [ mixed genre ]
- [ mixed theme ]
- [ mixed mood ]
- [ mixed style ]
- [ Optional.String type ]
- [ Optional.String albumlabel ]
- [ Optional.Number rating ]
- [ Optional.Integer year ]
- [ Optional.Integer userrating ]
- [ 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:
- Library.Id artistid
- [ Optional.String artist ]
- [ mixed instrument ]
- [ mixed style ]
- [ mixed mood ]
- [ Optional.String born ]
- [ Optional.String formed ]
- [ Optional.String description ]
- [ mixed genre ]
- [ Optional.String died ]
- [ Optional.String disbanded ]
- [ 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:
- Library.Id songid
- [ Optional.String title ]
- [ mixed artist ]
- [ mixed albumartist ]
- [ mixed genre ]
- [ Optional.Integer year ]
- [ Optional.Number rating ]
- [ Optional.String album ]
- [ Optional.Integer track ]
- [ Optional.Integer disc ]
- [ Optional.Integer duration ]
- [ Optional.String comment ]
- [ Optional.String musicbrainztrackid ]
- [ Optional.String musicbrainzartistid ]
- [ Optional.String musicbrainzalbumid ]
- [ Optional.String musicbrainzalbumartistid ]
- [ Optional.Integer playcount ]
- [ Optional.String lastplayed ]
- [ Optional.Integer userrating ]
- [ 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:
- string title
- Favourite.Type type
- [ Optional.String path ] Required for media and script favourites types
- [ Optional.String window ] Required for window favourite type
- [ Optional.String windowparameter ]
- [ 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:
- [ mixed type ]
- [ 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:
- string directory
- [ Files.Media media = "files" ]
- [ List.Fields.Files properties ]
- [ List.Sort sort ]
- [ 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:
- string file Full path to the file
- [ Files.Media media = "files" ]
- [ 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:
- Files.Media media
- [ List.Limits limits ]
- [ 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:
- 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:
- string file Full path to the file
- Files.Media media File type to update correct database. Currently only "video" is supported.
- [ Optional.Integer playcount ]
- [ Optional.String lastplayed ] Setting a valid lastplayed without a playcount will force playcount to 1.
- [ 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:
- GUI.Window window
- [ [[#|]][] 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": "array", "name": "parameters" } ], "returns": { "type": "string" } } |
GUI.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- GUI.Property.Name[] properties
Returns:
Type: '
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
Parameters:
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:
- Global.Toggle fullscreen
Returns:
Type: boolean
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:
- 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:
- string title
- string message
- [ mixed image ]
- [ 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
Parameters:
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
Parameters:
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
Parameters:
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:
- 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
Parameters:
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
Parameters:
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
Parameters:
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
Parameters:
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
Parameters:
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:
- string text Unicode text
- [ 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
Parameters:
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
Parameters:
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
Parameters:
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
Parameters:
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:
- [ boolean getdescriptions = true ]
- [ boolean getmetadata = false ]
- [ boolean filterbytransport = true ]
- [ 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:
- string sender
- string message
- [ 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
Parameters:
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
Parameters:
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
Parameters:
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
Parameters:
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:
- Player.Id playerid
- [ 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:
- [ 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:
- Player.Id playerid
- Player.Property.Name[] properties
Returns:
Type: '
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:
- Player.Id playerid
- 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:
- Player.Id playerid
- 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:
- [ mixed item ]
- [ 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:
- Player.Id playerid
- [ Global.Toggle play = "toggle" ]
Returns:
Type: '
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:
- Player.Id playerid
- [ 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:
- Player.Id playerid
- 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:
- Player.Id playerid
- mixed 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:
- Player.Id playerid
- 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:
- Player.Id playerid
- 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:
- Player.Id playerid
- 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:
- Player.Id playerid
- mixed speed
Returns:
Type: '
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:
- Player.Id playerid
- mixed subtitle
- [ 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:
- Player.Id playerid
- mixed 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:
- 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:
- Player.Id playerid
- mixed 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:
- Playlist.Id playlistid
- 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:
- 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:
- Playlist.Id playlistid
- [ List.Fields.All properties ]
- [ List.Limits limits ]
- [ 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
Parameters:
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:
- Playlist.Id playlistid
- Playlist.Property.Name[] properties
Returns:
Type: '
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:
- Playlist.Id playlistid
- Playlist.Position position
- 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:
- Playlist.Id playlistid
- 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:
- Playlist.Id playlistid
- Playlist.Position position1
- 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:
- [ Profiles.Fields.Profile properties ]
Returns:
Type: '
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:
- [ Profiles.Fields.Profile properties ]
- [ List.Limits limits ]
- [ 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:
- string profile Profile name
- [ boolean prompt = false ] Prompt for password
- [ 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:
- Library.Id broadcastid the broadcast id of the item to record
- [ 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:
- 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:
- Library.Id broadcastid
- [ 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:
- Library.Id channelid
- [ PVR.Fields.Broadcast properties ]
- [ 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:
- Library.Id channelid
- [ 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:
- PVR.ChannelGroup.Id channelgroupid
- [ 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:
- PVR.Channel.Type channeltype
- [ 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:
- PVR.ChannelGroup.Id channelgroupid
- [ PVR.Fields.Channel properties ]
- [ 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:
- PVR.Property.Name[] properties
Returns:
Type: '
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:
- Library.Id recordingid
- [ 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:
- [ PVR.Fields.Recording properties ]
- [ 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:
- Library.Id timerid
- [ 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:
- [ PVR.Fields.Timer properties ]
- [ 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:
- [ Global.Toggle record = "toggle" ]
- [ 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
Parameters:
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:
- Library.Id broadcastid the broadcast id of the item to toggle a onetime timer or time rule for
- [ 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:
- [ Setting.Level level = "standard" ]
- [ string section ]
- [ 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": {}, "name": "properties" } ], "returns": { "type": "object", "properties": { "categories": { "items": { "$ref": "Setting.Details.Category" }, "type": "array" } } } } |
Settings.GetSections
Retrieves all setting sections
Permissions:
- ReadData
Parameters:
- [ Setting.Level level = "standard" ]
- [ 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": {}, "name": "properties" } ], "returns": { "type": "object", "properties": { "sections": { "items": { "$ref": "Setting.Details.Section" }, "type": "array" } } } } |
Settings.GetSettings
Retrieves all settings
Permissions:
- ReadData
Parameters:
- [ Setting.Level level = "standard" ]
- [ mixed 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:
- 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:
- 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:
- string setting
- 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
Parameters:
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:
- System.Property.Name[] properties
Returns:
Type: '
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
Parameters:
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
Parameters:
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
Parameters:
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
Parameters:
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:
- [ Textures.Fields.Texture properties ]
- [ 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:
- 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:
- [ 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:
- [ mixed 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:
- Library.Id episodeid
- [ 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:
- [ Library.Id tvshowid = "-1" ]
- [ integer season = "-1" ]
- [ Video.Fields.Episode properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
- [ mixed filter ]
Returns:
Type: object
Properties:
- [ Video.Details.Episode[] episodes ]
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "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:
- string type
- [ Library.Fields.Genre properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- Library.Details.Genre[] genres
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "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:
- [ Video.Fields.TVShow properties ]
- [ List.Limits limits ]
- [ 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:
- Library.Id movieid
- [ 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:
- [ Video.Fields.Movie properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
- [ mixed filter ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Video.Details.Movie[] movies ]
JSON Schema Description |
---|
{ "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:
- Library.Id setid
- [ Video.Fields.MovieSet properties ]
- [ 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:
- [ Video.Fields.MovieSet properties ]
- [ List.Limits limits ]
- [ 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:
- Library.Id musicvideoid
- [ 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:
- [ Video.Fields.MusicVideo properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
- [ mixed filter ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Video.Details.MusicVideo[] musicvideos ]
JSON Schema Description |
---|
{ "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:
- [ Video.Fields.Episode properties ]
- [ List.Limits limits ]
- [ 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:
- [ Video.Fields.Movie properties ]
- [ List.Limits limits ]
- [ 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:
- [ Video.Fields.MusicVideo properties ]
- [ List.Limits limits ]
- [ 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:
- Library.Id seasonid
- [ 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:
- [ Library.Id tvshowid = "-1" ]
- [ Video.Fields.Season properties ]
- [ List.Limits limits ]
- [ 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:
- string type
- [ Library.Fields.Tag properties ]
- [ List.Limits limits ]
- [ 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:
- Library.Id tvshowid
- [ 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:
- [ Video.Fields.TVShow properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
- [ mixed filter ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Video.Details.TVShow[] tvshows ]
JSON Schema Description |
---|
{ "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:
- Library.Id episodeid
- [ boolean ignorenfo = false ] Whether or not to ignore a local NFO if present.
- [ 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:
- Library.Id movieid
- [ boolean ignorenfo = false ] Whether or not to ignore a local NFO if present.
- [ 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:
- Library.Id musicvideoid
- [ boolean ignorenfo = false ] Whether or not to ignore a local NFO if present.
- [ 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:
- Library.Id tvshowid
- [ boolean ignorenfo = false ] Whether or not to ignore a local NFO if present.
- [ boolean refreshepisodes = false ] Whether or not to refresh all episodes belonging to the TV show.
- [ 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:
- 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:
- 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:
- 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:
- 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:
- [ string directory ]
- [ 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:
- Library.Id episodeid
- [ Optional.String title ]
- [ Optional.Integer playcount ]
- [ Optional.Integer runtime ] Runtime in seconds
- [ mixed director ]
- [ Optional.String plot ]
- [ Optional.Number rating ]
- [ Optional.String votes ]
- [ Optional.String lastplayed ]
- [ mixed writer ]
- [ Optional.String firstaired ]
- [ Optional.String productioncode ]
- [ Optional.Integer season ]
- [ Optional.Integer episode ]
- [ Optional.String originaltitle ]
- [ Optional.String thumbnail ]
- [ Optional.String fanart ]
- [ mixed art ]
- [ mixed resume ]
- [ Optional.Integer userrating ]
- [ Video.Ratings.Set ratings ]
- [ Optional.String dateadded ]
- [ 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:
- Library.Id movieid
- [ Optional.String title ]
- [ Optional.Integer playcount ]
- [ Optional.Integer runtime ] Runtime in seconds
- [ mixed director ]
- [ mixed studio ]
- [ Optional.Integer year ] linked with premiered. Overridden by premiered parameter
- [ Optional.String plot ]
- [ mixed genre ]
- [ Optional.Number rating ]
- [ Optional.String mpaa ]
- [ Optional.String imdbnumber ]
- [ Optional.String votes ]
- [ Optional.String lastplayed ]
- [ Optional.String originaltitle ]
- [ Optional.String trailer ]
- [ Optional.String tagline ]
- [ Optional.String plotoutline ]
- [ mixed writer ]
- [ mixed country ]
- [ Optional.Integer top250 ]
- [ Optional.String sorttitle ]
- [ Optional.String set ]
- [ mixed showlink ]
- [ Optional.String thumbnail ]
- [ Optional.String fanart ]
- [ mixed tag ]
- [ mixed art ]
- [ mixed resume ]
- [ Optional.Integer userrating ]
- [ Video.Ratings.Set ratings ]
- [ Optional.String dateadded ]
- [ Optional.String premiered ] linked with year. Overriedes year
- [ 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:
- Library.Id setid
- [ Optional.String title ]
- [ 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:
- Library.Id musicvideoid
- [ Optional.String title ]
- [ Optional.Integer playcount ]
- [ Optional.Integer runtime ] Runtime in seconds
- [ mixed director ]
- [ mixed studio ]
- [ Optional.Integer year ] linked with premiered. Overridden by premiered parameter
- [ Optional.String plot ]
- [ Optional.String album ]
- [ mixed artist ]
- [ mixed genre ]
- [ Optional.Integer track ]
- [ Optional.String lastplayed ]
- [ Optional.String thumbnail ]
- [ Optional.String fanart ]
- [ mixed tag ]
- [ mixed art ]
- [ mixed resume ]
- [ Optional.Number rating ]
- [ Optional.Integer userrating ]
- [ Optional.String dateadded ]
- [ 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:
- Library.Id seasonid
- [ mixed art ]
- [ 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:
- Library.Id tvshowid
- [ Optional.String title ]
- [ Optional.Integer playcount ]
- [ mixed studio ]
- [ Optional.String plot ]
- [ mixed genre ]
- [ Optional.Number rating ]
- [ Optional.String mpaa ]
- [ Optional.String imdbnumber ]
- [ Optional.String premiered ]
- [ Optional.String votes ]
- [ Optional.String lastplayed ]
- [ Optional.String originaltitle ]
- [ Optional.String sorttitle ]
- [ Optional.String episodeguide ]
- [ Optional.String thumbnail ]
- [ Optional.String fanart ]
- [ mixed tag ]
- [ mixed art ]
- [ Optional.Integer userrating ]
- [ Video.Ratings.Set ratings ]
- [ Optional.String dateadded ]
- [ Optional.Integer runtime ] Runtime in seconds
- [ Optional.String status ]
- [ 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:
- [[#|]][] booleans
Returns:
Type: object
JSON Schema Description |
---|
{ "description": "Retrieve info booleans about Kodi and the system", "permission": "ReadData", "type": "method", "params": [ { "items": {}, "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:
- [[#|]][] labels See http://kodi.wiki/view/InfoLabels for a list of possible info labels
Returns:
Type: object
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": "array", "name": "labels", "required": true } ], "returns": { "type": "object", "description": "Object containing key-value pairs of the retrieved info labels", "additionalProperties": { "default": "", "type": "string" } } } |