JSON-RPC API/v13

JSON-RPC Pages
	Main JSON-RPC Page
	- v8 (Krypton)
	- v10 (Leia)
	- v12 (Matrix)
	- v13 (Nexus)
	- v14 (Omega)
	Examples
	All JSON-RPC Pages

Development

JSON-RPC API

v13

Version 13 is the in development version of Kodi's JSON-RPC API and is published with the release of v20 (Nexus). This document has been updated to version 13.0.0. Recent changes are announced on the forum

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:

Namespace	Description
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.
PVR	Live TV control.
Player	Manages all available players.
Playlist	Playlist modification.
Profiles	Support for Profiles operations to Kodi.
Settings	Allows manipulation of Kodi settings.
System	System controls and information.
Textures	Supplies GetTextures and RemoveTexture. Textures are images.
VideoLibrary	Video Library information.
XBMC	Dumping ground for very Kodi specific operations.

Methods

Addons

Addons.ExecuteAddon

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

ExecuteAddon

Parameters:

string addonid
[mixed: object|array|string params = ""]
[boolean wait = False]

Returns:

Type: string

JSON Schema Description

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

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",
  "params": [
    {
      "name": "addonid",
      "required": true,
      "type": "string"
    },
    {
      "$ref": "Addon.Fields",
      "name": "properties"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "addon": {
        "$ref": "Addon.Details",
        "required": true
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    },
    "type": "object"
  },
  "type": "method"
}

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: boolean|string enabled = all]
[Addon.Fields properties]
[List.Limits limits]
[mixed: boolean|string installed = True]

Returns:

Type: object
Properties:

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

JSON Schema Description

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

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",
  "params": [
    {
      "name": "addonid",
      "required": true,
      "type": "string"
    },
    {
      "$ref": "Global.Toggle",
      "name": "enabled",
      "required": true
    }
  ],
  "permission": "ManageAddon",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

Application

Application.GetProperties

Retrieves the values of the given properties
Permissions:

ReadData

Parameters:

array[ Application.Property.Name ] properties

Returns:

Type: Application.Property.Value

JSON Schema Description

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

Application.Quit

Quit application
Permissions:

ControlPower

Returns:

Type: string

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

Application.SetMute

Toggle mute/unmute
Permissions:

ControlPlayback

Parameters:

Global.Toggle mute

Returns:

Type: boolean (Mute state)

JSON Schema Description

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

Application.SetVolume

Set the current volume
Permissions:

ControlPlayback

Parameters:

mixed: integer|Global.IncrementDecrement volume

Returns:

Type: integer

JSON Schema Description

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

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",
  "params": [
    {
      "default": true,
      "description": "Whether or not to show the progress bar or any other GUI dialog",
      "name": "showdialogs",
      "type": "boolean"
    }
  ],
  "permission": "RemoveData",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

AudioLibrary.Export

Exports all items from the audio library
Permissions:

WriteFile

Parameters:

[mixed: object|object options]

Returns:

Type: string

JSON Schema Description

{
  "description": "Exports all items from the audio library",
  "params": [
    {
      "name": "options",
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "path": {
              "description": "Path to the directory to where the data should be exported",
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "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"
        }
      ]
    }
  ],
  "permission": "WriteFile",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

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",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "albumid",
      "required": true
    },
    {
      "$ref": "Audio.Fields.Album",
      "name": "properties"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "albumdetails": {
        "$ref": "Audio.Details.Album"
      }
    },
    "type": "object"
  },
  "type": "method"
}

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: object|object|object|object|object|object|object|object|List.Filter.Albums 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:

[array[ 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",
  "params": [
    {
      "$ref": "Audio.Fields.Album",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    },
    {
      "name": "filter",
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "genreid": {
              "$ref": "Library.Id",
              "description": "Song genre. Filter for existence of songs with this genre",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "genre": {
              "description": "Song genre. Filter for existence 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"
        }
      ]
    },
    {
      "default": false,
      "name": "includesingles",
      "type": "boolean"
    },
    {
      "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.",
      "name": "allroles",
      "type": "boolean"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "albums": {
        "items": {
          "$ref": "Audio.Details.Album"
        },
        "type": "array"
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    },
    "type": "object"
  },
  "type": "method"
}

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",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "artistid",
      "required": true
    },
    {
      "$ref": "Audio.Fields.Artist",
      "name": "properties"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "artistdetails": {
        "$ref": "Audio.Details.Artist"
      }
    },
    "type": "object"
  },
  "type": "method"
}

AudioLibrary.GetArtists

Retrieve all artists. For backward compatibility by default this implicitly 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 = None] (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: object|object|object|object|object|object|object|object|object|object|object|object|object|object|object|List.Filter.Artists 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:

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

JSON Schema Description

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

AudioLibrary.GetAvailableArt

Retrieve all potential art URLs for a media item by art type
Permissions:

ReadData

Parameters:

mixed: object|object item
[string arttype = ""]

Returns:

Type: object
Properties:

array availableart

JSON Schema Description

{
  "description": "Retrieve all potential art URLs for a media item by art type",
  "params": [
    {
      "name": "item",
      "required": true,
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "albumid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "artistid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        }
      ]
    },
    {
      "default": "",
      "name": "arttype",
      "type": "string"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "availableart": {
        "items": {
          "properties": {
            "arttype": {
              "required": true,
              "type": "string"
            },
            "previewurl": {
              "default": "",
              "description": "URL to a preview thumbnail of the image",
              "type": "string"
            },
            "url": {
              "description": "URL to the original image",
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        "required": true,
        "type": "array"
      }
    },
    "type": "object"
  },
  "type": "method"
}

AudioLibrary.GetAvailableArtTypes

Retrieve a list of potential art types for a media item
Permissions:

ReadData

Parameters:

mixed: object|object item

Returns:

Type: object
Properties:

array availablearttypes

JSON Schema Description

{
  "description": "Retrieve a list of potential art types for a media item",
  "params": [
    {
      "name": "item",
      "required": true,
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "albumid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "artistid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        }
      ]
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "availablearttypes": {
        "items": {
          "type": "string"
        },
        "required": true,
        "type": "array"
      }
    },
    "type": "object"
  },
  "type": "method"
}

AudioLibrary.GetGenres

Retrieve all genres
Permissions:

ReadData

Parameters:

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

Returns:

Type: object
Properties:

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

JSON Schema Description

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

AudioLibrary.GetProperties

Retrieves the values of the music library properties
Permissions:

ReadData

Parameters:

array[ Audio.Property.Name ] properties

Returns:

Type: Audio.Property.Value

JSON Schema Description

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

AudioLibrary.GetRecentlyAddedAlbums

Retrieve recently added albums
Permissions:

ReadData

Parameters:

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

Returns:

Type: object
Properties:

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

JSON Schema Description

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

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
[array[ Audio.Details.Song ] songs]

JSON Schema Description

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

AudioLibrary.GetRecentlyPlayedAlbums

Retrieve recently played albums
Permissions:

ReadData

Parameters:

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

Returns:

Type: object
Properties:

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

JSON Schema Description

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

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
[array[ Audio.Details.Song ] songs]

JSON Schema Description

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

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
array[ Audio.Details.Role ] roles

JSON Schema Description

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

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",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "songid",
      "required": true
    },
    {
      "$ref": "Audio.Fields.Song",
      "name": "properties"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "songdetails": {
        "$ref": "Audio.Details.Song"
      }
    },
    "type": "object"
  },
  "type": "method"
}

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: object|object|object|object|object|object|object|object|object|object|List.Filter.Songs filter]
[boolean includesingles = True] (Only songs from albums are returned when false, but overridden when singlesonly parameter is 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.)
[boolean singlesonly = False] (Only singles are returned when true, and overrides includesingles parameter)

Returns:

Type: object
Properties:

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

JSON Schema Description

{
  "description": "Retrieve all songs from specified album, artist or genre",
  "params": [
    {
      "$ref": "Audio.Fields.Song",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    },
    {
      "name": "filter",
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "genreid": {
              "$ref": "Library.Id",
              "description": "Song genre. Filter for existence of songs with this genre",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "genre": {
              "description": "Song genre. Filter for existence 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"
        }
      ]
    },
    {
      "default": true,
      "description": "Only songs from albums are returned when false, but overridden when singlesonly parameter is true",
      "name": "includesingles",
      "type": "boolean"
    },
    {
      "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.",
      "name": "allroles",
      "type": "boolean"
    },
    {
      "default": false,
      "description": "Only singles are returned when true, and overrides includesingles parameter",
      "name": "singlesonly",
      "type": "boolean"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "songs": {
        "items": {
          "$ref": "Audio.Details.Song"
        },
        "type": "array"
      }
    },
    "type": "object"
  },
  "type": "method"
}

AudioLibrary.GetSources

Get all music sources, including unique ID
Permissions:

ReadData

Parameters:

[Library.Fields.Source properties]
[List.Limits limits]
[List.Sort sort]

Returns:

Type: object
Properties:

List.LimitsReturned limits
array[ Library.Details.Source ] sources

JSON Schema Description

{
  "description": "Get all music sources, including unique ID",
  "params": [
    {
      "$ref": "Library.Fields.Source",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "sources": {
        "items": {
          "$ref": "Library.Details.Source"
        },
        "required": true,
        "type": "array"
      }
    },
    "type": "object"
  },
  "type": "method"
}

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",
  "params": [
    {
      "default": "",
      "name": "directory",
      "type": "string"
    },
    {
      "default": true,
      "description": "Whether or not to show the progress bar or any other GUI dialog",
      "name": "showdialogs",
      "type": "boolean"
    }
  ],
  "permission": "UpdateData",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

AudioLibrary.SetAlbumDetails

Update the given album with the given details
Permissions:

UpdateData

Parameters:

Library.Id albumid
[Optional.String title = None]
[mixed: null|Array.String artist = None]
[Optional.String description = None]
[mixed: null|Array.String genre = None]
[mixed: null|Array.String theme = None]
[mixed: null|Array.String mood = None]
[mixed: null|Array.String style = None]
[Optional.String type = None]
[Optional.String albumlabel = None]
[Optional.Number rating = None]
[Optional.Integer year = None]
[Optional.Integer userrating = None]
[Optional.Integer votes = None]
[Optional.String musicbrainzalbumid = None]
[Optional.String musicbrainzreleasegroupid = None]
[Optional.String sortartist = None]
[Optional.String displayartist = None]
[mixed: null|Array.String musicbrainzalbumartistid = None]
[mixed: null|Media.Artwork.Set art = None]
[Optional.Boolean isboxset = None]
[Optional.String releasedate = None]
[Optional.String originaldate = None]

Returns:

Type: string

JSON Schema Description

{
  "description": "Update the given album with the given details",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "albumid",
      "required": true
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "title"
    },
    {
      "default": null,
      "name": "artist",
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ]
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "description"
    },
    {
      "default": null,
      "name": "genre",
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ]
    },
    {
      "default": null,
      "name": "theme",
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ]
    },
    {
      "default": null,
      "name": "mood",
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ]
    },
    {
      "default": null,
      "name": "style",
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ]
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "type"
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "albumlabel"
    },
    {
      "$ref": "Optional.Number",
      "default": null,
      "name": "rating"
    },
    {
      "$ref": "Optional.Integer",
      "default": null,
      "name": "year"
    },
    {
      "$ref": "Optional.Integer",
      "default": null,
      "name": "userrating"
    },
    {
      "$ref": "Optional.Integer",
      "default": null,
      "name": "votes"
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "musicbrainzalbumid"
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "musicbrainzreleasegroupid"
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "sortartist"
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "displayartist"
    },
    {
      "default": null,
      "name": "musicbrainzalbumartistid",
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ]
    },
    {
      "default": null,
      "name": "art",
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Media.Artwork.Set"
        }
      ]
    },
    {
      "$ref": "Optional.Boolean",
      "default": null,
      "name": "isboxset"
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "releasedate"
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "originaldate"
    }
  ],
  "permission": "UpdateData",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

AudioLibrary.SetArtistDetails

Update the given artist with the given details
Permissions:

UpdateData

Parameters:

Library.Id artistid
[Optional.String artist = None]
[mixed: null|Array.String instrument = None]
[mixed: null|Array.String style = None]
[mixed: null|Array.String mood = None]
[Optional.String born = None]
[Optional.String formed = None]
[Optional.String description = None]
[mixed: null|Array.String genre = None]
[Optional.String died = None]
[Optional.String disbanded = None]
[mixed: null|Array.String yearsactive = None]
[Optional.String musicbrainzartistid = None]
[Optional.String sortname = None]
[Optional.String type = None]
[Optional.String gender = None]
[Optional.String disambiguation = None]
[mixed: null|Media.Artwork.Set art = None]

Returns:

Type: string

JSON Schema Description

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

AudioLibrary.SetSongDetails

Update the given song with the given details
Permissions:

UpdateData

Parameters:

Library.Id songid
[Optional.String title = None]
[mixed: null|Array.String artist = None]
[mixed: null|Array.String genre = None]
[Optional.Integer year = None]
[Optional.Number rating = None]
[Optional.Integer track = None]
[Optional.Integer disc = None]
[Optional.Integer duration = None]
[Optional.String comment = None]
[Optional.String musicbrainztrackid = None]
[Optional.String musicbrainzartistid = None]
[Optional.Integer playcount = None]
[Optional.String lastplayed = None]
[Optional.Integer userrating = None]
[Optional.Integer votes = None]
[Optional.String displayartist = None]
[Optional.String sortartist = None]
[Optional.String mood = None]
[mixed: null|Media.Artwork.Set art = None]
[Optional.String disctitle = None]
[Optional.String releasedate = None]
[Optional.String originaldate = None]
[Optional.Integer bpm = None]

Returns:

Type: string

JSON Schema Description

{
  "description": "Update the given song with the given details",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "songid",
      "required": true
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "title"
    },
    {
      "default": null,
      "name": "artist",
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ]
    },
    {
      "default": null,
      "name": "genre",
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ]
    },
    {
      "$ref": "Optional.Integer",
      "default": null,
      "name": "year"
    },
    {
      "$ref": "Optional.Number",
      "default": null,
      "name": "rating"
    },
    {
      "$ref": "Optional.Integer",
      "default": null,
      "name": "track"
    },
    {
      "$ref": "Optional.Integer",
      "default": null,
      "name": "disc"
    },
    {
      "$ref": "Optional.Integer",
      "default": null,
      "name": "duration"
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "comment"
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "musicbrainztrackid"
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "musicbrainzartistid"
    },
    {
      "$ref": "Optional.Integer",
      "default": null,
      "name": "playcount"
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "lastplayed"
    },
    {
      "$ref": "Optional.Integer",
      "default": null,
      "name": "userrating"
    },
    {
      "$ref": "Optional.Integer",
      "default": null,
      "name": "votes"
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "displayartist"
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "sortartist"
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "mood"
    },
    {
      "default": null,
      "name": "art",
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Media.Artwork.Set"
        }
      ]
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "disctitle"
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "releasedate"
    },
    {
      "$ref": "Optional.String",
      "default": null,
      "name": "originaldate"
    },
    {
      "$ref": "Optional.Integer",
      "default": null,
      "name": "bpm"
    }
  ],
  "permission": "UpdateData",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

Favourites

Favourites.AddFavourite

Add a favourite with the given details
Permissions:

UpdateData

Parameters:

string title
Favourite.Type type
[Optional.String path = None] (Required for media, script and androidapp favourites types)
[Optional.String window = None] (Required for window favourite type)
[Optional.String windowparameter = None]
[Optional.String thumbnail = None]

Returns:

Type: string

JSON Schema Description

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

Favourites.GetFavourites

Retrieve all favourites
Permissions:

ReadData

Parameters:

[mixed: null|Favourite.Type type = None]
[Favourite.Fields.Favourite properties]

Returns:

Type: object
Properties:

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

JSON Schema Description

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

Files

Files.Download

Downloads the given file
Permissions:

ReadData

Parameters:

string path

Returns:

Type: any

JSON Schema Description
{ "description": "Downloads the given file", "params": [ { "name": "path", "required": true, "type": "string" } ], "permission": "ReadData", "returns": { "type": "any" }, "type": "method" }

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:

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

JSON Schema Description

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

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",
  "params": [
    {
      "description": "Full path to the file",
      "name": "file",
      "required": true,
      "type": "string"
    },
    {
      "$ref": "Files.Media",
      "default": "files",
      "name": "media"
    },
    {
      "$ref": "List.Fields.Files",
      "name": "properties"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "filedetails": {
        "$ref": "List.Item.File",
        "required": true
      }
    },
    "type": "object"
  },
  "type": "method"
}

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",
  "params": [
    {
      "$ref": "Files.Media",
      "name": "media",
      "required": true
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "sources": {
        "$ref": "List.Items.Sources",
        "required": true
      }
    },
    "type": "object"
  },
  "type": "method"
}

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:

any details (Transport specific details on how/from where to download the given file)
string mode (Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol)
string protocol

JSON Schema Description

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

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 = None]
[Optional.String lastplayed = None] (Setting a valid lastplayed without a playcount will force playcount to 1.)
[mixed: null|Video.Resume resume = None]

Returns:

Type: string

JSON Schema Description

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

GUI

GUI.ActivateWindow

Activates the given window
Permissions:

ControlGUI

Parameters:

GUI.Window window
[array[string] parameters]

Returns:

Type: string

JSON Schema Description

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

GUI.GetProperties

Retrieves the values of the given properties
Permissions:

ReadData

Parameters:

array[ GUI.Property.Name ] properties

Returns:

Type: GUI.Property.Value

JSON Schema Description

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

GUI.GetStereoscopicModes

Returns the supported stereoscopic modes of the GUI
Permissions:

ReadData

Returns:

Type: object
Properties:

[array[ GUI.Stereoscopy.Mode ] stereoscopicmodes]

JSON Schema Description

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

GUI.SetFullscreen

Toggle fullscreen/GUI
Permissions:

ControlGUI

Parameters:

Global.Toggle fullscreen

Returns:

Type: boolean (Fullscreen state)

JSON Schema Description

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

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",
  "params": [
    {
      "enums": [
        "toggle",
        "tomono",
        "next",
        "previous",
        "select",
        "off",
        "split_vertical",
        "split_horizontal",
        "row_interleaved",
        "hardware_based",
        "anaglyph_cyan_red",
        "anaglyph_green_magenta",
        "monoscopic"
      ],
      "name": "mode",
      "required": true,
      "type": "string"
    }
  ],
  "permission": "ControlGUI",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

GUI.ShowNotification

Shows a GUI notification
Permissions:

ControlGUI

Parameters:

string title
string message
[mixed: string|string image = ""]
[integer displaytime = 5000] (The time in milliseconds the notification will be visible)

Returns:

Type: string

JSON Schema Description

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

Input

Input.Back

Goes back in GUI
Permissions:

Navigate

Returns:

Type: string

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

Input.ButtonEvent

Send a button press event
Permissions:

Navigate

Parameters:

string button (Button name)
string keymap (Keymap name (KB, XG, R1, or R2))
[integer holdtime = 0] (Number of milliseconds to simulate button hold.)

Returns:

Type: string

JSON Schema Description

{
  "description": "Send a button press event",
  "params": [
    {
      "description": "Button name",
      "name": "button",
      "required": true,
      "type": "string"
    },
    {
      "description": "Keymap name (KB, XG, R1, or R2)",
      "enums": [
        "KB",
        "XG",
        "R1",
        "R2"
      ],
      "name": "keymap",
      "required": true,
      "type": "string"
    },
    {
      "default": 0,
      "description": "Number of milliseconds to simulate button hold.",
      "minimum": 0,
      "name": "holdtime",
      "type": "integer"
    }
  ],
  "permission": "Navigate",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

Input.ContextMenu

Shows the context menu
Permissions:

Navigate

Returns:

Type: string

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

Input.Down

Navigate down in GUI
Permissions:

Navigate

Returns:

Type: string

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

Input.ExecuteAction

Execute a specific action
Permissions:

Navigate

Parameters:

Input.Action action

Returns:

Type: string

JSON Schema Description

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

Input.Home

Goes to home window in GUI
Permissions:

Navigate

Returns:

Type: string

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

Input.Info

Shows the information dialog
Permissions:

Navigate

Returns:

Type: string

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

Input.Left

Navigate left in GUI
Permissions:

Navigate

Returns:

Type: string

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

Input.Right

Navigate right in GUI
Permissions:

Navigate

Returns:

Type: string

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

Input.Select

Select current item in GUI
Permissions:

Navigate

Returns:

Type: string

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

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",
  "params": [
    {
      "description": "Unicode text",
      "name": "text",
      "required": true,
      "type": "string"
    },
    {
      "default": true,
      "description": "Whether this is the whole input or not (closes an open input dialog if true).",
      "name": "done",
      "type": "boolean"
    }
  ],
  "permission": "Navigate",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

Input.ShowCodec

Show codec information of the playing item
Permissions:

Navigate

Returns:

Type: string

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

Input.ShowOSD

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

Navigate

Returns:

Type: string

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

Input.ShowPlayerProcessInfo

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

Navigate

Returns:

Type: string

JSON Schema Description

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

Input.Up

Navigate up in GUI
Permissions:

Navigate

Returns:

Type: string

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

JSONRPC

JSONRPC.GetConfiguration

Get client-specific configurations
Permissions:

ReadData

Returns:

Type: Configuration

JSON Schema Description
{ "description": "Get client-specific configurations", "params": [], "permission": "ReadData", "returns": { "$ref": "Configuration" }, "type": "method" }

JSONRPC.Introspect

Enumerates all actions and descriptions
Permissions:

ReadData

Parameters:

[boolean getdescriptions = True]
[boolean getmetadata = False]
[boolean filterbytransport = True]
[object filter]

Returns:

Type: object

JSON Schema Description

{
  "description": "Enumerates all actions and descriptions",
  "params": [
    {
      "default": true,
      "name": "getdescriptions",
      "type": "boolean"
    },
    {
      "default": false,
      "name": "getmetadata",
      "type": "boolean"
    },
    {
      "default": true,
      "name": "filterbytransport",
      "type": "boolean"
    },
    {
      "name": "filter",
      "properties": {
        "getreferences": {
          "default": true,
          "description": "Whether or not to print the schema for referenced types",
          "type": "boolean"
        },
        "id": {
          "description": "Name of a namespace, method or type",
          "required": true,
          "type": "string"
        },
        "type": {
          "description": "Type of the given name",
          "enums": [
            "method",
            "namespace",
            "type",
            "notification"
          ],
          "required": true,
          "type": "string"
        }
      },
      "type": "object"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "additionalProperties": false,
    "type": "object"
  },
  "type": "method"
}

JSONRPC.NotifyAll

Notify all other connected clients
Permissions:

ReadData

Parameters:

string sender
string message
[any data = None]

Returns:

Type: any

JSON Schema Description

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

JSONRPC.Permission

Retrieve the clients permissions
Permissions:

ReadData

Returns:

Type: object
Properties:

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

JSON Schema Description

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

JSONRPC.Ping

Ping responder
Permissions:

ReadData

Returns:

Type: string

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

JSONRPC.SetConfiguration

Change the client-specific configuration
Permissions:

ControlNotify

Parameters:

[object notifications]

Returns:

Type: Configuration

JSON Schema Description

{
  "description": "Change the client-specific configuration",
  "params": [
    {
      "name": "notifications",
      "properties": {
        "application": {
          "$ref": "Optional.Boolean",
          "default": null
        },
        "audiolibrary": {
          "$ref": "Optional.Boolean",
          "default": null
        },
        "gui": {
          "$ref": "Optional.Boolean",
          "default": null
        },
        "input": {
          "$ref": "Optional.Boolean",
          "default": null
        },
        "other": {
          "$ref": "Optional.Boolean",
          "default": null
        },
        "player": {
          "$ref": "Optional.Boolean",
          "default": null
        },
        "playlist": {
          "$ref": "Optional.Boolean",
          "default": null
        },
        "system": {
          "$ref": "Optional.Boolean",
          "default": null
        },
        "videolibrary": {
          "$ref": "Optional.Boolean",
          "default": null
        }
      },
      "type": "object"
    }
  ],
  "permission": "ControlNotify",
  "returns": {
    "$ref": "Configuration"
  },
  "type": "method"
}

JSONRPC.Version

Retrieve the JSON-RPC protocol version.
Permissions:

ReadData

Returns:

Type: object
Properties:

object version

JSON Schema Description

{
  "description": "Retrieve the JSON-RPC protocol version.",
  "params": [],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "version": {
        "properties": {
          "major": {
            "description": "Bumped on backwards incompatible changes to the API definition",
            "minimum": 0,
            "required": true,
            "type": "integer"
          },
          "minor": {
            "description": "Bumped on backwards compatible additions/changes to the API definition",
            "minimum": 0,
            "required": true,
            "type": "integer"
          },
          "patch": {
            "description": "Bumped on any changes to the internal implementation but not to the API definition",
            "minimum": 0,
            "required": true,
            "type": "integer"
          }
        },
        "required": true,
        "type": "object"
      }
    },
    "type": "object"
  },
  "type": "method"
}

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 or adds a reminder timer or reminder timer rule
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)
[boolean reminder = False] (controls whether to create a reminder timer or a recording 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 or adds a reminder timer or reminder timer rule",
  "params": [
    {
      "$ref": "Library.Id",
      "description": "the broadcast id of the item to record",
      "name": "broadcastid",
      "required": true
    },
    {
      "default": false,
      "description": "controls whether to create a timer rule or a onetime timer",
      "name": "timerrule",
      "type": "boolean"
    },
    {
      "default": false,
      "description": "controls whether to create a reminder timer or a recording timer",
      "name": "reminder",
      "type": "boolean"
    }
  ],
  "permission": "ControlPVR",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

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",
  "params": [
    {
      "$ref": "Library.Id",
      "description": "the id of the onetime timer or timer rule to delete",
      "name": "timerid",
      "required": true
    }
  ],
  "permission": "ControlPVR",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

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",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "broadcastid",
      "required": true
    },
    {
      "$ref": "PVR.Fields.Broadcast",
      "name": "properties"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "broadcastdetails": {
        "$ref": "PVR.Details.Broadcast"
      }
    },
    "type": "object"
  },
  "type": "method"
}

PVR.GetBroadcastIsPlayable

Retrieves whether or not a broadcast is playable
Permissions:

ReadData

Parameters:

Library.Id broadcastid (the id of the broadcast to to check for playability)

Returns:

Type: boolean

JSON Schema Description

{
  "description": "Retrieves whether or not a broadcast is playable",
  "params": [
    {
      "$ref": "Library.Id",
      "description": "the id of the broadcast to to check for playability",
      "name": "broadcastid",
      "required": true
    }
  ],
  "permission": "ReadData",
  "returns": {
    "type": "boolean"
  },
  "type": "method"
}

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:

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

JSON Schema Description

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

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",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "channelid",
      "required": true
    },
    {
      "$ref": "PVR.Fields.Channel",
      "name": "properties"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "channeldetails": {
        "$ref": "PVR.Details.Channel"
      }
    },
    "type": "object"
  },
  "type": "method"
}

PVR.GetChannelGroupDetails

Retrieves the details of a specific channel group
Permissions:

ReadData

Parameters:

PVR.ChannelGroup.Id channelgroupid
[object channels]

Returns:

Type: object
Properties:

[PVR.Details.ChannelGroup.Extended channelgroupdetails]

JSON Schema Description

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

PVR.GetChannelGroups

Retrieves the channel groups for the specified type
Permissions:

ReadData

Parameters:

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

Returns:

Type: object
Properties:

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

JSON Schema Description

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

PVR.GetChannels

Retrieves the channel list
Permissions:

ReadData

Parameters:

PVR.ChannelGroup.Id channelgroupid
[PVR.Fields.Channel properties]
[List.Limits limits]
[List.Sort sort]

Returns:

Type: object
Properties:

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

JSON Schema Description

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

PVR.GetClients

Retrieves the enabled PVR clients and their capabilities
Permissions:

ReadData

Parameters:

[List.Limits limits]

Returns:

Type: object
Properties:

array[ PVR.Details.Client ] clients
List.LimitsReturned limits

JSON Schema Description

{
  "description": "Retrieves the enabled PVR clients and their capabilities",
  "params": [
    {
      "$ref": "List.Limits",
      "name": "limits"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "clients": {
        "items": {
          "$ref": "PVR.Details.Client"
        },
        "required": true,
        "type": "array"
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    },
    "type": "object"
  },
  "type": "method"
}

PVR.GetProperties

Retrieves the values of the given properties
Permissions:

ReadData

Parameters:

array[ PVR.Property.Name ] properties

Returns:

Type: PVR.Property.Value

JSON Schema Description

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

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",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "recordingid",
      "required": true
    },
    {
      "$ref": "PVR.Fields.Recording",
      "name": "properties"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "recordingdetails": {
        "$ref": "PVR.Details.Recording"
      }
    },
    "type": "object"
  },
  "type": "method"
}

PVR.GetRecordings

Retrieves the recordings
Permissions:

ReadData

Parameters:

[PVR.Fields.Recording properties]
[List.Limits limits]
[List.Sort sort]

Returns:

Type: object
Properties:

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

JSON Schema Description

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

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",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "timerid",
      "required": true
    },
    {
      "$ref": "PVR.Fields.Timer",
      "name": "properties"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "timerdetails": {
        "$ref": "PVR.Details.Timer"
      }
    },
    "type": "object"
  },
  "type": "method"
}

PVR.GetTimers

Retrieves the timers
Permissions:

ReadData

Parameters:

[PVR.Fields.Timer properties]
[List.Limits limits]
[List.Sort sort]

Returns:

Type: object
Properties:

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

JSON Schema Description

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

PVR.Record

Toggle recording of a channel
Permissions:

ControlPVR

Parameters:

[Global.Toggle record = toggle]
[mixed: string|Library.Id channel = current]

Returns:

Type: string

JSON Schema Description

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

PVR.Scan

Starts a channel scan
Permissions:

ControlPVR

Parameters:

[Library.Id clientid = -1] (Specify a PVR client id to avoid UI dialog, optional in kodi 19, required in kodi 20)

Returns:

Type: string

JSON Schema Description

{
  "description": "Starts a channel scan",
  "params": [
    {
      "$ref": "Library.Id",
      "default": -1,
      "description": "Specify a PVR client id to avoid UI dialog, optional in kodi 19, required in kodi 20",
      "name": "clientid"
    }
  ],
  "permission": "ControlPVR",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

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",
  "params": [
    {
      "$ref": "Library.Id",
      "description": "the broadcast id of the item to toggle a onetime timer or time rule for",
      "name": "broadcastid",
      "required": true
    },
    {
      "default": false,
      "description": "controls whether to create / delete a timer rule or a onetime timer",
      "name": "timerrule",
      "type": "boolean"
    }
  ],
  "permission": "ControlPVR",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

Player

Player.AddSubtitle

Add subtitle to the player
Permissions:

ControlPlayback

Parameters:

Player.Id playerid
string subtitle (Local path or remote URL to the subtitle file to load)

Returns:

Type: string

JSON Schema Description

{
  "description": "Add subtitle to the player",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "description": "Local path or remote URL to the subtitle file to load",
      "name": "subtitle",
      "required": true,
      "type": "string"
    }
  ],
  "permission": "ControlPlayback",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

Player.GetAudioDelay

Get the audio delay for the current playback
Permissions:

ReadData

Returns:

Type: object
Properties:

[number offset] The offset value used in the current playback.

JSON Schema Description

{
  "description": "Returns the offset value used in the current playback",
  "params": [],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "offset": {
        "description": "The offset value used in the current playback.",
        "required": true,
        "type": "number"
      }
    },
    "type": "object",
  },
  "type": "method"
}

Player.GetActivePlayers

Returns all active players
Permissions:

ReadData

Returns:

Type: array

JSON Schema Description

{
  "description": "Returns all active players",
  "params": [],
  "permission": "ReadData",
  "returns": {
    "items": {
      "properties": {
        "playerid": {
          "$ref": "Player.Id",
          "required": true
        },
        "playertype": {
          "enums": [
            "internal",
            "external",
            "remote"
          ],
          "required": true,
          "type": "string"
        },
        "type": {
          "$ref": "Player.Type",
          "required": true
        }
      },
      "type": "object"
    },
    "type": "array",
    "uniqueItems": true
  },
  "type": "method"
}

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",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "$ref": "List.Fields.All",
      "name": "properties"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "item": {
        "$ref": "List.Item.All",
        "required": true
      }
    },
    "type": "object"
  },
  "type": "method"
}

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",
  "params": [
    {
      "default": "all",
      "enums": [
        "all",
        "video",
        "audio"
      ],
      "name": "media",
      "type": "string"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "items": {
      "properties": {
        "name": {
          "$ref": "Global.String.NotEmpty",
          "required": true
        },
        "playsaudio": {
          "required": true,
          "type": "boolean"
        },
        "playsvideo": {
          "required": true,
          "type": "boolean"
        },
        "type": {
          "enums": [
            "internal",
            "external",
            "remote"
          ],
          "required": true,
          "type": "string"
        }
      },
      "type": "object"
    },
    "type": "array",
    "uniqueItems": true
  },
  "type": "method"
}

Player.GetProperties

Retrieves the values of the given properties
Permissions:

ReadData

Parameters:

Player.Id playerid
array[ Player.Property.Name ] properties

Returns:

Type: Player.Property.Value

JSON Schema Description

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

Player.GetViewMode

Get view mode of video player
Permissions:

ReadData

Returns:

Type: object
Properties:

boolean nonlinearstretch
number pixelratio
number verticalshift
Player.ViewMode viewmode
number zoom

JSON Schema Description

{
  "description": "Get view mode of video player",
  "params": [],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "nonlinearstretch": {
        "required": true,
        "type": "boolean"
      },
      "pixelratio": {
        "required": true,
        "type": "number"
      },
      "verticalshift": {
        "required": true,
        "type": "number"
      },
      "viewmode": {
        "$ref": "Player.ViewMode",
        "required": true
      },
      "zoom": {
        "required": true,
        "type": "number"
      }
    },
    "type": "object"
  },
  "type": "method"
}

Player.GoTo

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

ControlPlayback

Parameters:

Player.Id playerid
mixed: string|Playlist.Position to

Returns:

Type: string

JSON Schema Description

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

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",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "enums": [
        "left",
        "right",
        "up",
        "down"
      ],
      "name": "direction",
      "required": true,
      "type": "string"
    }
  ],
  "permission": "ControlPlayback",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

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: object|Playlist.Item|object|object|object|object|object item]
[object 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.",
  "params": [
    {
      "name": "item",
      "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": {
            "broadcastid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "channelid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "recordingid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        }
      ]
    },
    {
      "additionalProperties": false,
      "name": "options",
      "properties": {
        "playername": {
          "default": null,
          "type": [
            {
              "type": "null"
            },
            {
              "enums": [
                "default"
              ],
              "type": "string"
            },
            {
              "description": "name of player",
              "minLength": 1,
              "type": "string"
            }
          ]
        },
        "repeat": {
          "default": null,
          "type": [
            {
              "type": "null"
            },
            {
              "$ref": "Player.Repeat"
            }
          ]
        },
        "resume": {
          "default": false,
          "type": [
            {
              "description": "Whether to resume from the resume point or not",
              "type": "boolean"
            },
            {
              "$ref": "Player.Position.Percentage",
              "description": "Percentage value to start from"
            },
            {
              "$ref": "Player.Position.Time",
              "description": "Time to start from"
            }
          ]
        },
        "shuffled": {
          "$ref": "Optional.Boolean",
          "default": null
        }
      },
      "type": "object"
    }
  ],
  "permission": "ControlPlayback",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

Player.PlayPause

Pauses or unpause playback and returns the new state
Permissions:

ControlPlayback

Parameters:

Player.Id playerid
[Global.Toggle play = toggle]

Returns:

Type: Player.Speed

JSON Schema Description

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

Player.Rotate

Rotates current picture
Permissions:

ControlPlayback

Parameters:

Player.Id playerid
[string value = clockwise]

Returns:

Type: string

JSON Schema Description

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

Player.Seek

Seek through the playing item
Permissions:

ControlPlayback

Parameters:

Player.Id playerid
mixed: object|object|object|object value

Returns:

Type: object
Properties:

[Player.Position.Percentage percentage]
[Global.Time time] (A duration.)
[Global.Time totaltime] (A duration.)

JSON Schema Description

{
  "description": "Seek through the playing item",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "name": "value",
      "required": true,
      "type": [
        {
          "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"
        }
      ]
    }
  ],
  "permission": "ControlPlayback",
  "returns": {
    "properties": {
      "percentage": {
        "$ref": "Player.Position.Percentage",
        "default": 0.0
      },
      "time": {
        "$ref": "Global.Time",
        "description": "A duration."
      },
      "totaltime": {
        "$ref": "Global.Time",
        "description": "A duration."
      }
    },
    "type": "object"
  },
  "type": "method"
}

Player.SetAudioDelay

Set the audio delay for the current playback
Permissions:

ControlPlayback

Parameters:

Player.Id playerid
mixed: number|Global.IncrementDecrement offset

Returns:

Type: object
Properties:

[number offset] The offset value used in the current playback.

JSON Schema Description

{
  "params": [
    {
      "name": "playerid",
      "$ref": "Player.Id",
      "required": true
    },
    {
      "name": "offset",
      "type": [
        {
          "type": "number",
          "description": "The value should be a multiple of 0.025 in a range of +/-10 (the default range can be overriden by advancedsettings.xml).",
          "required": true
        },
        {
          "$ref": "Global.IncrementDecrement",
          "required": true
        }
      ],
      "required": true
    }
  ],
  "permission": "ControlPlayback",
  "returns": {
    "type": "object",
    "properties": {
      "offset": {
        "type": "number",
        "description": "The offset value used in the current playback.",
        "required": true
      }
    }
  },
  "type": "method"
}

Player.SetAudioStream

Set the audio stream played by the player
Permissions:

ControlPlayback

Parameters:

Player.Id playerid
mixed: string|integer stream

Returns:

Type: string

JSON Schema Description

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

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",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "$ref": "Global.Toggle",
      "name": "partymode",
      "required": true
    }
  ],
  "permission": "ControlPlayback",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

Player.SetRepeat

Set the repeat mode of the player
Permissions:

ControlPlayback

Parameters:

Player.Id playerid
mixed: Player.Repeat|string repeat

Returns:

Type: string

JSON Schema Description

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

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",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "$ref": "Global.Toggle",
      "name": "shuffle",
      "required": true
    }
  ],
  "permission": "ControlPlayback",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

Player.SetSpeed

Set the speed of the current playback
Permissions:

ControlPlayback

Parameters:

Player.Id playerid
mixed: integer|Global.IncrementDecrement speed

Returns:

Type: Player.Speed

JSON Schema Description

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

Player.SetSubtitle

Set the subtitle displayed by the player
Permissions:

ControlPlayback

Parameters:

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

Player.SetVideoStream

Set the video stream played by the player
Permissions:

ControlPlayback

Parameters:

Player.Id playerid
mixed: string|integer stream

Returns:

Type: string

JSON Schema Description

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

Player.SetViewMode

Set view mode of video player
Permissions:

ControlPlayback

Parameters:

mixed: Player.CustomViewMode|Player.ViewMode viewmode

Returns:

Type: string

JSON Schema Description

{
  "description": "Set view mode of video player",
  "params": [
    {
      "name": "viewmode",
      "required": true,
      "type": [
        {
          "$ref": "Player.CustomViewMode",
          "description": "Custom view mode"
        },
        {
          "$ref": "Player.ViewMode"
        }
      ]
    }
  ],
  "permission": "ControlPlayback",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

Player.Stop

Stops playback
Permissions:

ControlPlayback

Parameters:

Player.Id playerid

Returns:

Type: string

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

Player.Zoom

Zoom current picture
Permissions:

ControlPlayback

Parameters:

Player.Id playerid
mixed: string|integer zoom

Returns:

Type: string

JSON Schema Description

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

Playlist

Playlist.Add

Add item(s) to playlist
Permissions:

ControlPlayback

Parameters:

Playlist.Id playlistid
mixed: Playlist.Item|array item

Returns:

Type: string

JSON Schema Description

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

Playlist.Clear

Clear playlist
Permissions:

ControlPlayback

Parameters:

Playlist.Id playlistid

Returns:

Type: string

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

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:

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

JSON Schema Description

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

Playlist.GetPlaylists

Returns all existing playlists
Permissions:

ReadData

Returns:

Type: array

JSON Schema Description

{
  "description": "Returns all existing playlists",
  "params": [],
  "permission": "ReadData",
  "returns": {
    "items": {
      "properties": {
        "playlistid": {
          "$ref": "Playlist.Id",
          "required": true
        },
        "type": {
          "$ref": "Playlist.Type",
          "required": true
        }
      },
      "type": "object"
    },
    "type": "array",
    "uniqueItems": true
  },
  "type": "method"
}

Playlist.GetProperties

Retrieves the values of the given properties
Permissions:

ReadData

Parameters:

Playlist.Id playlistid
array[ Playlist.Property.Name ] properties

Returns:

Type: Playlist.Property.Value

JSON Schema Description

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

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: Playlist.Item|array item

Returns:

Type: string

JSON Schema Description

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

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).",
  "params": [
    {
      "$ref": "Playlist.Id",
      "name": "playlistid",
      "required": true
    },
    {
      "$ref": "Playlist.Position",
      "name": "position",
      "required": true
    }
  ],
  "permission": "ControlPlayback",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

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).",
  "params": [
    {
      "$ref": "Playlist.Id",
      "name": "playlistid",
      "required": true
    },
    {
      "$ref": "Playlist.Position",
      "name": "position1",
      "required": true
    },
    {
      "$ref": "Playlist.Position",
      "name": "position2",
      "required": true
    }
  ],
  "permission": "ControlPlayback",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

Profiles

Profiles.GetCurrentProfile

Retrieve the current profile
Permissions:

ReadData

Parameters:

[Profiles.Fields.Profile properties]

Returns:

Type: Profiles.Details.Profile

JSON Schema Description

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

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
array[ Profiles.Details.Profile ] profiles

JSON Schema Description

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

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",
  "params": [
    {
      "description": "Profile name",
      "name": "profile",
      "required": true,
      "type": "string"
    },
    {
      "default": false,
      "description": "Prompt for password",
      "name": "prompt",
      "type": "boolean"
    },
    {
      "$ref": "Profiles.Password",
      "name": "password"
    }
  ],
  "permission": "Navigate",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

Settings

Settings.GetCategories

Retrieves all setting categories
Permissions:

ReadData

Parameters:

[Setting.Level level = standard]
[string section = ""]
[string properties]

Returns:

Type: object
Properties:

[array[ Setting.Details.Category ] categories]

JSON Schema Description

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

Settings.GetSections

Retrieves all setting sections
Permissions:

ReadData

Parameters:

[Setting.Level level = standard]
[Setting.Level properties]

Returns:

Type: object
Properties:

[array[ Setting.Details.Section ] sections]

JSON Schema Description

{
  "description": "Retrieves all setting sections",
  "params": [
    {
      "$ref": "Setting.Level",
      "default": "standard",
      "name": "level"
    },
    {
      "extends": "Item.Fields.Base",
      "items": {
        "enums": [
          "categories"
        ],
        "type": "string"
      },
      "name": "properties"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "sections": {
        "items": {
          "$ref": "Setting.Details.Section"
        },
        "type": "array"
      }
    },
    "type": "object"
  },
  "type": "method"
}

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",
  "params": [
    {
      "minLength": 1,
      "name": "setting",
      "required": true,
      "type": "string"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "value": {
        "$ref": "Setting.Value.Extended",
        "required": true
      }
    },
    "type": "object"
  },
  "type": "method"
}

Settings.GetSettings

Retrieves all settings
Permissions:

ReadData

Parameters:

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

Returns:

Type: object
Properties:

[array[ Setting.Details.Setting ] settings]

JSON Schema Description

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

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",
  "params": [
    {
      "minLength": 1,
      "name": "setting",
      "required": true,
      "type": "string"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

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",
  "params": [
    {
      "minLength": 1,
      "name": "setting",
      "required": true,
      "type": "string"
    },
    {
      "$ref": "Setting.Value.Extended",
      "name": "value",
      "required": true
    }
  ],
  "permission": "ReadData",
  "returns": {
    "type": "boolean"
  },
  "type": "method"
}

System

System.EjectOpticalDrive

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

ControlSystem

Returns:

Type: string

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

System.GetProperties

Retrieves the values of the given properties
Permissions:

ReadData

Parameters:

array[ System.Property.Name ] properties

Returns:

Type: System.Property.Value

JSON Schema Description

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

System.Hibernate

Puts the system running Kodi into hibernate mode
Permissions:

ControlPower

Returns:

Type: string

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

System.Reboot

Reboots the system running Kodi
Permissions:

ControlPower

Returns:

Type: string

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

System.Shutdown

Shuts the system running Kodi down
Permissions:

ControlPower

Returns:

Type: string

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

System.Suspend

Suspends the system running Kodi
Permissions:

ControlPower

Returns:

Type: string

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

Textures

Textures.GetTextures

Retrieve all textures
Permissions:

ReadData

Parameters:

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

Returns:

Type: object
Properties:

array[ Textures.Details.Texture ] textures

JSON Schema Description

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

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",
  "params": [
    {
      "$ref": "Library.Id",
      "description": "Texture database identifier",
      "name": "textureid",
      "required": true
    }
  ],
  "permission": "RemoveData",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

VideoLibrary

VideoLibrary.Clean

Cleans the video library for non-existent items
Permissions:

RemoveData

Parameters:

[boolean showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)
[string content = video] (Content type to clean for)
[string directory = ""] (Path to the directory to clean up; performs a global cleanup if not specified)

Returns:

Type: string

JSON Schema Description

{
  "description": "Cleans the video library for non-existent items",
  "params": [
    {
      "default": true,
      "description": "Whether or not to show the progress bar or any other GUI dialog",
      "name": "showdialogs",
      "type": "boolean"
    },
    {
      "default": "video",
      "description": "Content type to clean for",
      "enums": [
        "video",
        "movies",
        "tvshows",
        "musicvideos"
      ],
      "name": "content",
      "type": "string"
    },
    {
      "default": "",
      "description": "Path to the directory to clean up; performs a global cleanup if not specified",
      "name": "directory",
      "type": "string"
    }
  ],
  "permission": "RemoveData",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

VideoLibrary.Export

Exports all items from the video library
Permissions:

WriteFile

Parameters:

[mixed: object|object options]

Returns:

Type: string

JSON Schema Description

{
  "description": "Exports all items from the video library",
  "params": [
    {
      "name": "options",
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "path": {
              "description": "Path to the directory to where the data should be exported",
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "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"
        }
      ]
    }
  ],
  "permission": "WriteFile",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

VideoLibrary.GetAvailableArt

Retrieve all potential art URLs for a media item by art type
Permissions:

ReadData

Parameters:

mixed: object|object|object|object|object|object item
[string arttype = ""]

Returns:

Type: object
Properties:

array availableart

JSON Schema Description

{
  "description": "Retrieve all potential art URLs for a media item by art type",
  "params": [
    {
      "name": "item",
      "required": true,
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "episodeid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "tvshowid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "seasonid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "movieid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "setid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "musicvideoid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        }
      ]
    },
    {
      "default": "",
      "name": "arttype",
      "type": "string"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "availableart": {
        "items": {
          "properties": {
            "arttype": {
              "required": true,
              "type": "string"
            },
            "previewurl": {
              "default": "",
              "description": "URL to a preview thumbnail of the image",
              "type": "string"
            },
            "url": {
              "description": "URL to the original image",
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        "required": true,
        "type": "array"
      }
    },
    "type": "object"
  },
  "type": "method"
}

VideoLibrary.GetAvailableArtTypes

Retrieve a list of potential art types for a media item
Permissions:

ReadData

Parameters:

mixed: object|object|object|object|object|object item

Returns:

Type: object
Properties:

array availablearttypes

JSON Schema Description

{
  "description": "Retrieve a list of potential art types for a media item",
  "params": [
    {
      "name": "item",
      "required": true,
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "episodeid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "tvshowid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "seasonid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "movieid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "setid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "musicvideoid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        }
      ]
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "availablearttypes": {
        "items": {
          "type": "string"
        },
        "required": true,
        "type": "array"
      }
    },
    "type": "object"
  },
  "type": "method"
}

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",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "episodeid",
      "required": true
    },
    {
      "$ref": "Video.Fields.Episode",
      "name": "properties"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "episodedetails": {
        "$ref": "Video.Details.Episode"
      }
    },
    "type": "object"
  },
  "type": "method"
}

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: object|object|object|object|object|List.Filter.Episodes filter]

Returns:

Type: object
Properties:

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

JSON Schema Description

{
  "description": "Retrieve all tv show episodes",
  "params": [
    {
      "$ref": "Library.Id",
      "default": -1,
      "name": "tvshowid"
    },
    {
      "default": -1,
      "minimum": 0,
      "name": "season",
      "type": "integer"
    },
    {
      "$ref": "Video.Fields.Episode",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    },
    {
      "name": "filter",
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "genreid": {
              "$ref": "Library.Id",
              "description": "Requires tvshowid to be set",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "genre": {
              "description": "Requires tvshowid to be set",
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "year": {
              "minimum": 0,
              "required": true,
              "type": "integer"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "actor": {
              "description": "Requires tvshowid to be set",
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "director": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "$ref": "List.Filter.Episodes"
        }
      ]
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "episodes": {
        "items": {
          "$ref": "Video.Details.Episode"
        },
        "type": "array"
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    },
    "type": "object"
  },
  "type": "method"
}

VideoLibrary.GetGenres

Retrieve all genres
Permissions:

ReadData

Parameters:

string type
[Library.Fields.Genre properties]
[List.Limits limits]
[List.Sort sort]

Returns:

Type: object
Properties:

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

JSON Schema Description

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

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
[array[ Video.Details.TVShow ] tvshows]

JSON Schema Description

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

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",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "movieid",
      "required": true
    },
    {
      "$ref": "Video.Fields.Movie",
      "name": "properties"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "moviedetails": {
        "$ref": "Video.Details.Movie"
      }
    },
    "type": "object"
  },
  "type": "method"
}

VideoLibrary.GetMovieSetDetails

Retrieve details about a specific movie set
Permissions:

ReadData

Parameters:

Library.Id setid
[Video.Fields.MovieSet properties]
[object movies]

Returns:

Type: object
Properties:

[Video.Details.MovieSet.Extended setdetails]

JSON Schema Description

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

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
[array[ Video.Details.MovieSet ] sets]

JSON Schema Description

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

VideoLibrary.GetMovies

Retrieve all movies
Permissions:

ReadData

Parameters:

[Video.Fields.Movie properties]
[List.Limits limits]
[List.Sort sort]
[mixed: object|object|object|object|object|object|object|object|object|object|List.Filter.Movies filter]

Returns:

Type: object
Properties:

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

JSON Schema Description

{
  "description": "Retrieve all movies",
  "params": [
    {
      "$ref": "Video.Fields.Movie",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    },
    {
      "name": "filter",
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "genreid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "genre": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "year": {
              "minimum": 0,
              "required": true,
              "type": "integer"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "actor": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "director": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "studio": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "country": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "setid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "set": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "tag": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "$ref": "List.Filter.Movies"
        }
      ]
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "movies": {
        "items": {
          "$ref": "Video.Details.Movie"
        },
        "type": "array"
      }
    },
    "type": "object"
  },
  "type": "method"
}

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",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "musicvideoid",
      "required": true
    },
    {
      "$ref": "Video.Fields.MusicVideo",
      "name": "properties"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "musicvideodetails": {
        "$ref": "Video.Details.MusicVideo"
      }
    },
    "type": "object"
  },
  "type": "method"
}

VideoLibrary.GetMusicVideos

Retrieve all music videos
Permissions:

ReadData

Parameters:

[Video.Fields.MusicVideo properties]
[List.Limits limits]
[List.Sort sort]
[mixed: object|object|object|object|object|object|object|List.Filter.MusicVideos filter]

Returns:

Type: object
Properties:

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

JSON Schema Description

{
  "description": "Retrieve all music videos",
  "params": [
    {
      "$ref": "Video.Fields.MusicVideo",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    },
    {
      "name": "filter",
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "artist": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "genreid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "genre": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "year": {
              "minimum": 0,
              "required": true,
              "type": "integer"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "director": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "studio": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "tag": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "$ref": "List.Filter.MusicVideos"
        }
      ]
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "musicvideos": {
        "items": {
          "$ref": "Video.Details.MusicVideo"
        },
        "type": "array"
      }
    },
    "type": "object"
  },
  "type": "method"
}

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:

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

JSON Schema Description

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

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
[array[ Video.Details.Movie ] movies]

JSON Schema Description

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

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
[array[ Video.Details.MusicVideo ] musicvideos]

JSON Schema Description

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

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",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "seasonid",
      "required": true
    },
    {
      "$ref": "Video.Fields.Season",
      "name": "properties"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "seasondetails": {
        "$ref": "Video.Details.Season"
      }
    },
    "type": "object"
  },
  "type": "method"
}

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
[array[ Video.Details.Season ] seasons]

JSON Schema Description

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

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",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "tvshowid",
      "required": true
    },
    {
      "$ref": "Video.Fields.TVShow",
      "name": "properties"
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "tvshowdetails": {
        "$ref": "Video.Details.TVShow"
      }
    },
    "type": "object"
  },
  "type": "method"
}

VideoLibrary.GetTVShows

Retrieve all tv shows
Permissions:

ReadData

Parameters:

[Video.Fields.TVShow properties]
[List.Limits limits]
[List.Sort sort]
[mixed: object|object|object|object|object|object|List.Filter.TVShows filter]

Returns:

Type: object
Properties:

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

JSON Schema Description

{
  "description": "Retrieve all tv shows",
  "params": [
    {
      "$ref": "Video.Fields.TVShow",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    },
    {
      "name": "filter",
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "genreid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "genre": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "year": {
              "minimum": 0,
              "required": true,
              "type": "integer"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "actor": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "studio": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "tag": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "$ref": "List.Filter.TVShows"
        }
      ]
    }
  ],
  "permission": "ReadData",
  "returns": {
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "tvshows": {
        "items": {
          "$ref": "Video.Details.TVShow"
        },
        "type": "array"
      }
    },
    "type": "object"
  },
  "type": "method"
}

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
array[ Library.Details.Tag ] tags

JSON Schema Description

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

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

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

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

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

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",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "episodeid",
      "required": true
    }
  ],
  "permission": "RemoveData",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

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",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "movieid",
      "required": true
    }
  ],
  "permission": "RemoveData",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

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",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "musicvideoid",
      "required": true
    }
  ],
  "permission": "RemoveData",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

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",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "tvshowid",
      "required": true
    }
  ],
  "permission": "RemoveData",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

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",
  "params": [
    {
      "default": "",
      "name": "directory",
      "type": "string"
    },
    {
      "default": true,
      "description": "Whether or not to show the progress bar or any other GUI dialog",
      "name": "showdialogs",
      "type": "boolean"
    }
  ],
  "permission": "UpdateData",
  "returns": {
    "type": "string"
  },
  "type": "method"
}

VideoLibrary.SetEpisodeDetails

Update the given episode with the given details
Permissions:

UpdateData

Parameters:

Library.Id episodeid
[Optional.String title = None]
[Optional.Integer playcount = None]
[Optional.Integer runtime = None] (Runtime in seconds)
[mixed: null|Array.String director = None]
[Optional.String plot = None]
[Optional.Number rating = None]
[Optional.String votes = None]
[Optional.String lastplayed = None]
[mixed: null|Array.String writer = None]
[Optional.String firstaired = None]
[Optional.String productioncode = None]
[Optional.Integer season = None]
[Optional.Integer episode = None]
[Optional.String originaltitle = None]
[Optional.String thumbnail = None]
[Optional.String fanart = None]
[mixed: null|Media.Artwork.Set art = None]
[mixed: null|Video.Resume resume = None]
[Optional.Integer userrating = None]
[Video.Ratings.Set ratings]
[Optional.String dateadded = None]
[mixed: null|Media.UniqueID.Set uniqueid = None]

Returns:

Type: string

JSON Schema Description

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

VideoLibrary.SetMovieDetails

Update the given movie with the given details
Permissions:

UpdateData

Parameters:

Library.Id movieid
[Optional.String title = None]
[Optional.Integer playcount = None]
[Optional.Integer runtime = None] (Runtime in seconds)
[mixed: null|Array.String director = None]
[mixed: null|Array.String studio = None]
[Optional.Integer year = None] (linked with premiered. Overridden by premiered parameter)
[Optional.String plot = None]
[mixed: null|Array.String genre = None]
[Optional.Number rating = None]
[Optional.String mpaa = None]
[Optional.String imdbnumber = None]
[Optional.String votes = None]
[Optional.String lastplayed = None]
[Optional.String originaltitle = None]
[Optional.String trailer = None]
[Optional.String tagline = None]
[Optional.String plotoutline = None]
[mixed: null|Array.String writer = None]
[mixed: null|Array.String country = None]
[Optional.Integer top250 = None]
[Optional.String sorttitle = None]
[Optional.String set = None]
[mixed: null|Array.String showlink = None]
[Optional.String thumbnail = None]
[Optional.String fanart = None]
[mixed: null|Array.String tag = None]
[mixed: null|Media.Artwork.Set art = None]
[mixed: null|Video.Resume resume = None]
[Optional.Integer userrating = None]
[Video.Ratings.Set ratings]
[Optional.String dateadded = None]
[Optional.String premiered = None] (linked with year. Overrides year)
[mixed: null|Media.UniqueID.Set uniqueid = None]

Returns:

Type: string

JSON Schema Description

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

VideoLibrary.SetMovieSetDetails

Update the given movie set with the given details
Permissions:

UpdateData

Parameters:

Library.Id setid
[Optional.String title = None]
[mixed: null|Media.Artwork.Set art = None]
[Optional.String plot = None]

Returns:

Type: string

JSON Schema Description

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

VideoLibrary.SetMusicVideoDetails

Update the given music video with the given details
Permissions:

UpdateData

Parameters:

Library.Id musicvideoid
[Optional.String title = None]
[Optional.Integer playcount = None]
[Optional.Integer runtime = None] (Runtime in seconds)
[mixed: null|Array.String director = None]
[mixed: null|Array.String studio = None]
[Optional.Integer year = None] (linked with premiered. Overridden by premiered parameter)
[Optional.String plot = None]
[Optional.String album = None]
[mixed: null|Array.String artist = None]
[mixed: null|Array.String genre = None]
[Optional.Integer track = None]
[Optional.String lastplayed = None]
[Optional.String thumbnail = None]
[Optional.String fanart = None]
[mixed: null|Array.String tag = None]
[mixed: null|Media.Artwork.Set art = None]
[mixed: null|Video.Resume resume = None]
[Optional.Number rating = None]
[Optional.Integer userrating = None]
[Optional.String dateadded = None]
[Optional.String premiered = None] (linked with year. Overrides year)

Returns:

Type: string

JSON Schema Description

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

VideoLibrary.SetSeasonDetails

Update the given season with the given details
Permissions:

UpdateData

Parameters:

Library.Id seasonid
[mixed: null|Media.Artwork.Set art = None]
[Optional.Integer userrating = None]
[Optional.String title = None]

Returns:

Type: string

JSON Schema Description

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

VideoLibrary.SetTVShowDetails

Update the given tvshow with the given details
Permissions:

UpdateData

Parameters:

Library.Id tvshowid
[Optional.String title = None]
[Optional.Integer playcount = None]
[mixed: null|Array.String studio = None]
[Optional.String plot = None]
[mixed: null|Array.String genre = None]
[Optional.Number rating = None]
[Optional.String mpaa = None]
[Optional.String imdbnumber = None]
[Optional.String premiered = None]
[Optional.String votes = None]
[Optional.String lastplayed = None]
[Optional.String originaltitle = None]
[Optional.String sorttitle = None]
[Optional.String episodeguide = None]
[Optional.String thumbnail = None]
[Optional.String fanart = None]
[mixed: null|Array.String tag = None]
[mixed: null|Media.Artwork.Set art = None]
[Optional.Integer userrating = None]
[Video.Ratings.Set ratings]
[Optional.String dateadded = None]
[Optional.Integer runtime = None] (Runtime in seconds)
[Optional.String status = None] (Valid values: 'returning series', 'in production', 'planned', 'cancelled', 'ended')
[mixed: null|Media.UniqueID.Set uniqueid = None]

Returns:

Type: string

JSON Schema Description

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

XBMC

XBMC.GetInfoBooleans

Retrieve info booleans about Kodi and the system
Permissions:

ReadData

Parameters:

array[string] booleans

Returns:

Type: object (Object containing key-value pairs of the retrieved info booleans)

JSON Schema Description

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

XBMC.GetInfoLabels

Retrieve info labels about Kodi and the system
Permissions:

ReadData

Parameters:

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

Returns:

Type: object (Object containing key-value pairs of the retrieved info labels)

JSON Schema Description

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

Global Types

Addon

Addon.Content

Type: string

JSON Schema Description
{ "default": "unknown", "enums": [ "unknown", "video", "audio", "image", "executable" ], "id": "Addon.Content", "type": "string" }

Addon.Details

Extends:

Item.Details.Base

Properties:

string addonid
[string author]
[mixed: boolean|string broken]
[array dependencies]
[mixed: boolean|string deprecated]
[string description]
[string disclaimer]
[boolean enabled]
[array extrainfo]
[string fanart]
[boolean installed]
[string name]
[string path]
[integer rating]
[string summary]
[string thumbnail]
Addon.Types type
[string version]

JSON Schema Description

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

Addon.Fields

Extends:

Item.Fields.Base

JSON Schema Description

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

Addon.Types

Type: string

JSON Schema Description

{
  "default": "unknown",
  "enums": [
    "unknown",
    "xbmc.player.musicviz",
    "xbmc.gui.skin",
    "kodi.pvrclient",
    "kodi.inputstream",
    "kodi.gameclient",
    "kodi.peripheral",
    "xbmc.python.script",
    "xbmc.python.weather",
    "xbmc.subtitle.module",
    "xbmc.python.lyrics",
    "xbmc.metadata.scraper.albums",
    "xbmc.metadata.scraper.artists",
    "xbmc.metadata.scraper.movies",
    "xbmc.metadata.scraper.musicvideos",
    "xbmc.metadata.scraper.tvshows",
    "xbmc.ui.screensaver",
    "xbmc.python.pluginsource",
    "xbmc.addon.repository",
    "xbmc.webinterface",
    "xbmc.service",
    "kodi.audioencoder",
    "kodi.context.item",
    "kodi.audiodecoder",
    "kodi.resource.images",
    "kodi.resource.language",
    "kodi.resource.uisounds",
    "kodi.resource.games",
    "kodi.resource.font",
    "kodi.vfs",
    "kodi.imagedecoder",
    "xbmc.metadata.scraper.library",
    "xbmc.python.library",
    "xbmc.python.module",
    "kodi.game.controller",
    "",
    "xbmc.addon.video",
    "xbmc.addon.audio",
    "xbmc.addon.image",
    "xbmc.addon.executable",
    "kodi.addon.game"
  ],
  "id": "Addon.Types",
  "type": "string"
}

Application

Application.Property.Name

Type: string

JSON Schema Description
{ "default": "volume", "enums": [ "volume", "muted", "name", "version", "sorttokens", "language" ], "id": "Application.Property.Name", "type": "string" }

Application.Property.Value

Type: object
Properties:

[string language]
[boolean muted]
[string name]
[Array.String sorttokens]
[object version]
[integer volume]

JSON Schema Description

{
  "id": "Application.Property.Value",
  "properties": {
    "language": {
      "default": "",
      "description": "Current language code and region e.g. en_GB",
      "minLength": 1,
      "type": "string"
    },
    "muted": {
      "default": false,
      "type": "boolean"
    },
    "name": {
      "default": "",
      "minLength": 1,
      "type": "string"
    },
    "sorttokens": {
      "$ref": "Array.String",
      "description": "Articles ignored during sorting when ignorearticle is enabled."
    },
    "version": {
      "properties": {
        "major": {
          "minimum": 0,
          "required": true,
          "type": "integer"
        },
        "minor": {
          "minimum": 0,
          "required": true,
          "type": "integer"
        },
        "revision": {
          "default": null,
          "type": [
            {
              "type": "string"
            },
            {
              "type": "integer"
            }
          ]
        },
        "tag": {
          "enums": [
            "prealpha",
            "alpha",
            "beta",
            "releasecandidate",
            "stable"
          ],
          "required": true,
          "type": "string"
        },
        "tagversion": {
          "default": "",
          "type": "string"
        }
      },
      "type": "object"
    },
    "volume": {
      "default": 0,
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    }
  },
  "type": "object"
}

Array

Array.Integer

Type: array

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

Array.String

Type: array

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

Audio

Audio.Album.ReleaseType

Type: string

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

Audio.Artist.Roles

Type: array

JSON Schema Description

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

Audio.Contributors

Type: array

JSON Schema Description

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

Audio.Details.Album

Extends:

Audio.Details.Media

Properties:

[integer albumduration]
Library.Id albumid
[string albumlabel]
[string albumstatus]
[boolean compilation]
[string description]
[boolean isboxset]
[string lastplayed]
[Array.String mood]
[string musicbrainzalbumid]
[string musicbrainzreleasegroupid]
[integer playcount]
[Audio.Album.ReleaseType releasetype = album]
[Audio.Details.Genres songgenres]
[Array.Integer sourceid]
[Array.String style]
[Array.String theme]
[integer totaldiscs]
[string type]

JSON Schema Description

{
  "extends": "Audio.Details.Media",
  "id": "Audio.Details.Album",
  "properties": {
    "albumduration": {
      "default": 0,
      "type": "integer"
    },
    "albumid": {
      "$ref": "Library.Id",
      "required": true
    },
    "albumlabel": {
      "default": "",
      "type": "string"
    },
    "albumstatus": {
      "default": "",
      "type": "string"
    },
    "compilation": {
      "default": false,
      "type": "boolean"
    },
    "description": {
      "default": "",
      "type": "string"
    },
    "isboxset": {
      "default": false,
      "type": "boolean"
    },
    "lastplayed": {
      "default": "",
      "type": "string"
    },
    "mood": {
      "$ref": "Array.String"
    },
    "musicbrainzalbumid": {
      "default": "",
      "type": "string"
    },
    "musicbrainzreleasegroupid": {
      "default": "",
      "type": "string"
    },
    "playcount": {
      "default": 0,
      "type": "integer"
    },
    "releasetype": {
      "$ref": "Audio.Album.ReleaseType",
      "default": "album"
    },
    "songgenres": {
      "$ref": "Audio.Details.Genres"
    },
    "sourceid": {
      "$ref": "Array.Integer"
    },
    "style": {
      "$ref": "Array.String"
    },
    "theme": {
      "$ref": "Array.String"
    },
    "totaldiscs": {
      "default": 0,
      "type": "integer"
    },
    "type": {
      "default": "",
      "type": "string"
    }
  }
}

Audio.Details.Artist

Extends:

Audio.Details.Base

Properties:

string artist
Library.Id artistid
[string born]
[boolean compilationartist]
[string description]
[string died]
[string disambiguation]
[string disbanded]
[string formed]
[string gender]
[Array.String instrument]
[boolean isalbumartist]
[Array.String mood]
[Array.String musicbrainzartistid]
[Audio.Artist.Roles roles]
[Audio.Details.Genres songgenres]
[string sortname]
[Array.Integer sourceid]
[Array.String style]
[string type]
[Array.String yearsactive]

JSON Schema Description

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

Audio.Details.Base

Extends:

Media.Details.Base

Properties:

[Media.Artwork art]
[string dateadded]
[Array.String genre]

JSON Schema Description

{
  "extends": "Media.Details.Base",
  "id": "Audio.Details.Base",
  "properties": {
    "art": {
      "$ref": "Media.Artwork"
    },
    "dateadded": {
      "default": "",
      "type": "string"
    },
    "genre": {
      "$ref": "Array.String"
    }
  }
}

Audio.Details.Genres

Type: array

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

Audio.Details.Media

Extends:

Audio.Details.Base

Properties:

[Array.String artist]
[Array.Integer artistid]
[string displayartist]
[Array.String musicbrainzalbumartistid]
[string originaldate]
[number rating]
[string releasedate]
[string sortartist]
[string title]
[integer userrating]
[integer votes]
[integer year]

JSON Schema Description

{
  "extends": "Audio.Details.Base",
  "id": "Audio.Details.Media",
  "properties": {
    "artist": {
      "$ref": "Array.String"
    },
    "artistid": {
      "$ref": "Array.Integer"
    },
    "displayartist": {
      "default": "",
      "type": "string"
    },
    "musicbrainzalbumartistid": {
      "$ref": "Array.String"
    },
    "originaldate": {
      "default": "",
      "type": "string"
    },
    "rating": {
      "default": 0.0,
      "type": "number"
    },
    "releasedate": {
      "default": "",
      "type": "string"
    },
    "sortartist": {
      "default": "",
      "type": "string"
    },
    "title": {
      "default": "",
      "type": "string"
    },
    "userrating": {
      "default": 0,
      "type": "integer"
    },
    "votes": {
      "default": 0,
      "type": "integer"
    },
    "year": {
      "default": 0,
      "type": "integer"
    }
  }
}

Audio.Details.Role

Extends:

Item.Details.Base

Properties:

Library.Id roleid
[string title]

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

Audio.Details.Song

Extends:

Audio.Details.Media

Properties:

[string album]
[Array.String albumartist]
[Array.Integer albumartistid]
[Library.Id albumid = -1]
[Audio.Album.ReleaseType albumreleasetype = album]
[any bitrate]
[any bpm]
[any channels]
[string comment]
[Audio.Contributors contributors]
[integer disc]
[string disctitle]
[string displaycomposer]
[string displayconductor]
[string displaylyricist]
[string displayorchestra]
[integer duration]
[string file]
[Array.Integer genreid]
[string lastplayed]
[string lyrics]
[string mood]
[Array.String musicbrainzartistid]
[string musicbrainztrackid]
[integer playcount]
[any samplerate]
Library.Id songid
[Array.Integer sourceid]
[integer track]

JSON Schema Description

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

Audio.Fields.Album

Extends:

Item.Fields.Base

JSON Schema Description

{
  "extends": "Item.Fields.Base",
  "id": "Audio.Fields.Album",
  "items": {
    "description": "Requesting the songgenres, artistid and/or sourceid fields will result in increased response times",
    "enums": [
      "title",
      "description",
      "artist",
      "genre",
      "theme",
      "mood",
      "style",
      "type",
      "albumlabel",
      "rating",
      "votes",
      "userrating",
      "year",
      "musicbrainzalbumid",
      "musicbrainzalbumartistid",
      "fanart",
      "thumbnail",
      "playcount",
      "artistid",
      "displayartist",
      "compilation",
      "releasetype",
      "dateadded",
      "sortartist",
      "musicbrainzreleasegroupid",
      "songgenres",
      "art",
      "lastplayed",
      "sourceid",
      "isboxset",
      "totaldiscs",
      "releasedate",
      "originaldate",
      "albumstatus",
      "datemodified",
      "datenew",
      "albumduration"
    ],
    "type": "string"
  }
}

Audio.Fields.Artist

Extends:

Item.Fields.Base

JSON Schema Description

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

Audio.Fields.Role

Extends:

Item.Fields.Base

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

Audio.Fields.Song

Extends:

Item.Fields.Base

JSON Schema Description

{
  "extends": "Item.Fields.Base",
  "id": "Audio.Fields.Song",
  "items": {
    "description": "Requesting the genreid, artistid, albumartistid and/or sourceid fields will result in increased response times",
    "enums": [
      "title",
      "artist",
      "albumartist",
      "genre",
      "year",
      "rating",
      "album",
      "track",
      "duration",
      "comment",
      "lyrics",
      "musicbrainztrackid",
      "musicbrainzartistid",
      "musicbrainzalbumid",
      "musicbrainzalbumartistid",
      "playcount",
      "fanart",
      "thumbnail",
      "file",
      "albumid",
      "lastplayed",
      "disc",
      "genreid",
      "artistid",
      "displayartist",
      "albumartistid",
      "albumreleasetype",
      "dateadded",
      "votes",
      "userrating",
      "mood",
      "contributors",
      "displaycomposer",
      "displayconductor",
      "displayorchestra",
      "displaylyricist",
      "sortartist",
      "art",
      "sourceid",
      "disctitle",
      "releasedate",
      "originaldate",
      "bpm",
      "samplerate",
      "bitrate",
      "channels",
      "datemodified",
      "datenew"
    ],
    "type": "string"
  }
}

Audio.Property.Name

Type: string

JSON Schema Description

{
  "default": "missingartistid",
  "enums": [
    "missingartistid",
    "librarylastupdated",
    "librarylastcleaned",
    "artistlinksupdated",
    "songslastadded",
    "albumslastadded",
    "artistslastadded",
    "genreslastadded",
    "songsmodified",
    "albumsmodified",
    "artistsmodified"
  ],
  "id": "Audio.Property.Name",
  "type": "string"
}

Audio.Property.Value

Type: object
Properties:

[string albumslastadded]
[string albumsmodified]
[string artistlinksupdated]
[string artistslastadded]
[string artistsmodified]
[string genreslastadded]
[string librarylastcleaned]
[string librarylastupdated]
[Library.Id missingartistid = -1]
[string songslastadded]
[string songsmodified]

JSON Schema Description

{
  "id": "Audio.Property.Value",
  "properties": {
    "albumslastadded": {
      "default": "",
      "type": "string"
    },
    "albumsmodified": {
      "default": "",
      "type": "string"
    },
    "artistlinksupdated": {
      "default": "",
      "type": "string"
    },
    "artistslastadded": {
      "default": "",
      "type": "string"
    },
    "artistsmodified": {
      "default": "",
      "type": "string"
    },
    "genreslastadded": {
      "default": "",
      "type": "string"
    },
    "librarylastcleaned": {
      "default": "",
      "type": "string"
    },
    "librarylastupdated": {
      "default": "",
      "type": "string"
    },
    "missingartistid": {
      "$ref": "Library.Id",
      "default": -1
    },
    "songslastadded": {
      "default": "",
      "type": "string"
    },
    "songsmodified": {
      "default": "",
      "type": "string"
    }
  },
  "type": "object"
}

Configuration

Type: object
Properties:

Configuration.Notifications notifications

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

Configuration.Notifications

Type: object
Properties:

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

JSON Schema Description

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

Favourite

Favourite.Details.Favourite

Type: object
Properties:

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

JSON Schema Description

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

Favourite.Fields.Favourite

Extends:

Item.Fields.Base

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

Favourite.Type

Type: string

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

Files

Files.Media

Type: string

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

GUI

GUI.Property.Name

Type: string

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

GUI.Property.Value

Type: object
Properties:

[object currentcontrol]
[object currentwindow]
[boolean fullscreen]
[object skin]
[GUI.Stereoscopy.Mode stereoscopicmode]

JSON Schema Description

{
  "id": "GUI.Property.Value",
  "properties": {
    "currentcontrol": {
      "properties": {
        "label": {
          "required": true,
          "type": "string"
        }
      },
      "type": "object"
    },
    "currentwindow": {
      "properties": {
        "id": {
          "required": true,
          "type": "integer"
        },
        "label": {
          "required": true,
          "type": "string"
        }
      },
      "type": "object"
    },
    "fullscreen": {
      "default": false,
      "type": "boolean"
    },
    "skin": {
      "properties": {
        "id": {
          "minLength": 1,
          "required": true,
          "type": "string"
        },
        "name": {
          "default": "",
          "type": "string"
        }
      },
      "type": "object"
    },
    "stereoscopicmode": {
      "$ref": "GUI.Stereoscopy.Mode"
    }
  },
  "type": "object"
}

GUI.Stereoscopy.Mode

Type: object
Properties:

string label
string mode

JSON Schema Description

{
  "id": "GUI.Stereoscopy.Mode",
  "properties": {
    "label": {
      "required": true,
      "type": "string"
    },
    "mode": {
      "enums": [
        "off",
        "split_vertical",
        "split_horizontal",
        "row_interleaved",
        "hardware_based",
        "anaglyph_cyan_red",
        "anaglyph_green_magenta",
        "anaglyph_yellow_blue",
        "monoscopic"
      ],
      "required": true,
      "type": "string"
    }
  },
  "type": "object"
}

GUI.Window

Type: string

JSON Schema Description

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

Global

Global.IncrementDecrement

Type: string

JSON Schema Description
{ "default": "increment", "enums": [ "increment", "decrement" ], "id": "Global.IncrementDecrement", "type": "string" }

Global.String.NotEmpty

Type: string

JSON Schema Description
{ "default": "", "id": "Global.String.NotEmpty", "minLength": 1, "type": "string" }

Global.Time

Type: object
Properties:

integer hours
integer milliseconds
integer minutes
integer seconds

JSON Schema Description

{
  "additionalProperties": false,
  "description": "A duration.",
  "id": "Global.Time",
  "properties": {
    "hours": {
      "minimum": 0,
      "required": true,
      "type": "integer"
    },
    "milliseconds": {
      "maximum": 999,
      "minimum": 0,
      "required": true,
      "type": "integer"
    },
    "minutes": {
      "maximum": 59,
      "minimum": 0,
      "required": true,
      "type": "integer"
    },
    "seconds": {
      "maximum": 59,
      "minimum": 0,
      "required": true,
      "type": "integer"
    }
  },
  "type": "object"
}

Global.Toggle

Type: mixed

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

Global.Weekday

Type: string

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

Input

Input.Action

Type: string

JSON Schema Description

{
  "default": "analogfastforward",
  "enums": [
    "analogfastforward",
    "analogmove",
    "analogmovexleft",
    "analogmovexright",
    "analogmoveydown",
    "analogmoveyup",
    "analogrewind",
    "analogseekback",
    "analogseekforward",
    "aspectratio",
    "audiodelay",
    "audiodelayminus",
    "audiodelayplus",
    "audionextlanguage",
    "audiotoggledigital",
    "back",
    "backspace",
    "bigstepback",
    "bigstepforward",
    "blue",
    "browsesubtitle",
    "channeldown",
    "channelnumberseparator",
    "channelup",
    "chapterorbigstepback",
    "chapterorbigstepforward",
    "close",
    "codecinfo",
    "contextmenu",
    "copy",
    "createbookmark",
    "createepisodebookmark",
    "cursorleft",
    "cursorright",
    "cyclesubtitle",
    "cycletonemapmethod",
    "decreasepar",
    "decreaserating",
    "decreasevisrating",
    "delete",
    "doubleclick",
    "down",
    "enter",
    "error",
    "fastforward",
    "filter",
    "filterclear",
    "filtersms2",
    "filtersms3",
    "filtersms4",
    "filtersms5",
    "filtersms6",
    "filtersms7",
    "filtersms8",
    "filtersms9",
    "firstpage",
    "fullscreen",
    "green",
    "guiprofile",
    "hdrtoggle",
    "highlight",
    "increasepar",
    "increaserating",
    "increasevisrating",
    "info",
    "jumpsms2",
    "jumpsms3",
    "jumpsms4",
    "jumpsms5",
    "jumpsms6",
    "jumpsms7",
    "jumpsms8",
    "jumpsms9",
    "lastpage",
    "left",
    "leftclick",
    "lockpreset",
    "longclick",
    "longpress",
    "menu",
    "middleclick",
    "mousedrag",
    "mousedragend",
    "mousemove",
    "move",
    "moveitemdown",
    "moveitemup",
    "mute",
    "nextcalibration",
    "nextchannelgroup",
    "nextletter",
    "nextpicture",
    "nextpreset",
    "nextresolution",
    "nextscene",
    "nextstereomode",
    "nextsubtitle",
    "noop",
    "number0",
    "number1",
    "number2",
    "number3",
    "number4",
    "number5",
    "number6",
    "number7",
    "number8",
    "number9",
    "osd",
    "pagedown",
    "pageup",
    "pangesture",
    "parentdir",
    "parentfolder",
    "pause",
    "play",
    "playerdebug",
    "playerdebugvideo",
    "playerprocessinfo",
    "playerprogramselect",
    "playerresolutionselect",
    "playlist",
    "playnext",
    "playpause",
    "playpvr",
    "playpvrradio",
    "playpvrtv",
    "previouschannelgroup",
    "previousmenu",
    "previouspicture",
    "previouspreset",
    "previousscene",
    "previousstereomode",
    "prevletter",
    "queue",
    "randompreset",
    "record",
    "red",
    "reloadkeymaps",
    "rename",
    "resetcalibration",
    "rewind",
    "right",
    "rightclick",
    "rotate",
    "rotateccw",
    "rotategesture",
    "scanitem",
    "screenshot",
    "scrolldown",
    "scrollup",
    "select",
    "setrating",
    "settingslevelchange",
    "settingsreset",
    "shift",
    "showpreset",
    "showsubtitles",
    "showtime",
    "showtimerrule",
    "showvideomenu",
    "skipnext",
    "skipprevious",
    "smallstepback",
    "stepback",
    "stepforward",
    "stereomode",
    "stereomodetomono",
    "stop",
    "subtitlealign",
    "subtitledelay",
    "subtitledelayminus",
    "subtitledelayplus",
    "subtitleshiftdown",
    "subtitleshiftup",
    "swipedown",
    "swipeleft",
    "swiperight",
    "swipeup",
    "switchplayer",
    "symbols",
    "tap",
    "togglecommskip",
    "togglefont",
    "togglefullscreen",
    "togglestereomode",
    "togglewatched",
    "up",
    "verticalshiftdown",
    "verticalshiftup",
    "videonextstream",
    "voicerecognizer",
    "volampdown",
    "volampup",
    "volumeamplification",
    "volumedown",
    "volumeup",
    "wheeldown",
    "wheelup",
    "yellow",
    "zoomgesture",
    "zoomin",
    "zoomlevel1",
    "zoomlevel2",
    "zoomlevel3",
    "zoomlevel4",
    "zoomlevel5",
    "zoomlevel6",
    "zoomlevel7",
    "zoomlevel8",
    "zoomlevel9",
    "zoomnormal",
    "zoomout"
  ],
  "id": "Input.Action",
  "type": "string"
}

Item

Item.CustomProperties

Type: object

JSON Schema Description
{ "additionalProperties": { "$ref": "Global.String.NotEmpty", "default": "" }, "id": "Item.CustomProperties", "type": "object" }

Item.Details.Base

Type: object
Properties:

string label

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

Item.Fields.Base

Type: array

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

Library

Library.Details.Genre

Extends:

Item.Details.Base

Properties:

Library.Id genreid
[Array.Integer sourceid]
[string thumbnail]
[string title]

JSON Schema Description

{
  "extends": "Item.Details.Base",
  "id": "Library.Details.Genre",
  "properties": {
    "genreid": {
      "$ref": "Library.Id",
      "required": true
    },
    "sourceid": {
      "$ref": "Array.Integer",
      "description": "The ids of sources with songs of the genre"
    },
    "thumbnail": {
      "default": "",
      "type": "string"
    },
    "title": {
      "default": "",
      "type": "string"
    }
  }
}

Library.Details.Source

Extends:

Item.Details.Base

Properties:

string file
[Array.String paths]
Library.Id sourceid

JSON Schema Description

{
  "extends": "Item.Details.Base",
  "id": "Library.Details.Source",
  "properties": {
    "file": {
      "description": "The url encoded multipath string combining all paths of the source ",
      "required": true,
      "type": "string"
    },
    "paths": {
      "$ref": "Array.String",
      "description": "The individual paths of the media source"
    },
    "sourceid": {
      "$ref": "Library.Id",
      "required": true
    }
  }
}

Library.Details.Tag

Extends:

Item.Details.Base

Properties:

Library.Id tagid
[string title]

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

Library.Fields.Genre

Extends:

Item.Fields.Base

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

Library.Fields.Source

Extends:

Item.Fields.Base

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

Library.Fields.Tag

Extends:

Item.Fields.Base

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

Library.Id

Type: integer

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

List

List.Amount

Type: integer

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

List.Fields.All

Extends:

Item.Fields.Base

JSON Schema Description

{
  "extends": "Item.Fields.Base",
  "id": "List.Fields.All",
  "items": {
    "enums": [
      "title",
      "artist",
      "albumartist",
      "genre",
      "year",
      "rating",
      "album",
      "track",
      "duration",
      "comment",
      "lyrics",
      "musicbrainztrackid",
      "musicbrainzartistid",
      "musicbrainzalbumid",
      "musicbrainzalbumartistid",
      "playcount",
      "fanart",
      "director",
      "trailer",
      "tagline",
      "plot",
      "plotoutline",
      "originaltitle",
      "lastplayed",
      "writer",
      "studio",
      "mpaa",
      "cast",
      "country",
      "imdbnumber",
      "premiered",
      "productioncode",
      "runtime",
      "set",
      "showlink",
      "streamdetails",
      "top250",
      "votes",
      "firstaired",
      "season",
      "episode",
      "showtitle",
      "thumbnail",
      "file",
      "resume",
      "artistid",
      "albumid",
      "tvshowid",
      "setid",
      "watchedepisodes",
      "disc",
      "tag",
      "art",
      "genreid",
      "displayartist",
      "albumartistid",
      "description",
      "theme",
      "mood",
      "style",
      "albumlabel",
      "sorttitle",
      "episodeguide",
      "uniqueid",
      "dateadded",
      "channel",
      "channeltype",
      "hidden",
      "locked",
      "channelnumber",
      "subchannelnumber",
      "starttime",
      "endtime",
      "specialsortseason",
      "specialsortepisode",
      "compilation",
      "releasetype",
      "albumreleasetype",
      "contributors",
      "displaycomposer",
      "displayconductor",
      "displayorchestra",
      "displaylyricist",
      "userrating",
      "sortartist",
      "musicbrainzreleasegroupid",
      "mediapath",
      "dynpath",
      "isboxset",
      "totaldiscs",
      "disctitle",
      "releasedate",
      "originaldate",
      "bpm",
      "bitrate",
      "samplerate",
      "channels",
      "albumstatus",
      "datemodified",
      "datenew",
      "customproperties",
      "albumduration"
    ],
    "type": "string"
  }
}

List.Fields.Files

Extends:

Item.Fields.Base

JSON Schema Description

{
  "extends": "Item.Fields.Base",
  "id": "List.Fields.Files",
  "items": {
    "enums": [
      "title",
      "artist",
      "albumartist",
      "genre",
      "year",
      "rating",
      "album",
      "track",
      "duration",
      "comment",
      "lyrics",
      "musicbrainztrackid",
      "musicbrainzartistid",
      "musicbrainzalbumid",
      "musicbrainzalbumartistid",
      "playcount",
      "fanart",
      "director",
      "trailer",
      "tagline",
      "plot",
      "plotoutline",
      "originaltitle",
      "lastplayed",
      "writer",
      "studio",
      "mpaa",
      "cast",
      "country",
      "imdbnumber",
      "premiered",
      "productioncode",
      "runtime",
      "set",
      "showlink",
      "streamdetails",
      "top250",
      "votes",
      "firstaired",
      "season",
      "episode",
      "showtitle",
      "thumbnail",
      "file",
      "resume",
      "artistid",
      "albumid",
      "tvshowid",
      "setid",
      "watchedepisodes",
      "disc",
      "tag",
      "art",
      "genreid",
      "displayartist",
      "albumartistid",
      "description",
      "theme",
      "mood",
      "style",
      "albumlabel",
      "sorttitle",
      "episodeguide",
      "uniqueid",
      "dateadded",
      "size",
      "lastmodified",
      "mimetype",
      "specialsortseason",
      "specialsortepisode",
      "sortartist",
      "musicbrainzreleasegroupid",
      "isboxset",
      "totaldiscs",
      "disctitle",
      "releasedate",
      "originaldate",
      "bpm",
      "bitrate",
      "samplerate",
      "channels",
      "datemodified",
      "datenew",
      "customproperties",
      "albumduration"
    ],
    "type": "string"
  }
}

List.Filter.Albums

Type: mixed

JSON Schema Description

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

List.Filter.Artists

Type: mixed

JSON Schema Description

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

List.Filter.Episodes

Type: mixed

JSON Schema Description

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

List.Filter.Fields.Albums

Type: string

JSON Schema Description

{
  "default": "genre",
  "enums": [
    "genre",
    "source",
    "album",
    "disctitle",
    "totaldiscs",
    "isboxset",
    "artist",
    "albumartist",
    "year",
    "originalyear",
    "albumduration",
    "review",
    "themes",
    "moods",
    "styles",
    "compilation",
    "type",
    "label",
    "rating",
    "userrating",
    "playcount",
    "lastplayed",
    "path",
    "albumstatus",
    "dateadded",
    "datemodified",
    "datenew",
    "playlist",
    "virtualfolder"
  ],
  "id": "List.Filter.Fields.Albums",
  "type": "string"
}

List.Filter.Fields.Artists

Type: string

JSON Schema Description

{
  "default": "artist",
  "enums": [
    "artist",
    "source",
    "genre",
    "moods",
    "styles",
    "instruments",
    "biography",
    "artisttype",
    "gender",
    "disambiguation",
    "born",
    "bandformed",
    "disbanded",
    "died",
    "role",
    "path",
    "dateadded",
    "datemodified",
    "datenew",
    "playlist",
    "virtualfolder"
  ],
  "id": "List.Filter.Fields.Artists",
  "type": "string"
}

List.Filter.Fields.Episodes

Type: string

JSON Schema Description

{
  "default": "title",
  "enums": [
    "title",
    "tvshow",
    "originaltitle",
    "plot",
    "votes",
    "rating",
    "userrating",
    "time",
    "writers",
    "airdate",
    "playcount",
    "lastplayed",
    "inprogress",
    "genre",
    "year",
    "director",
    "actor",
    "episode",
    "season",
    "filename",
    "path",
    "studio",
    "mpaarating",
    "dateadded",
    "tag",
    "videoresolution",
    "audiochannels",
    "audiocount",
    "subtitlecount",
    "videocodec",
    "audiocodec",
    "audiolanguage",
    "subtitlelanguage",
    "videoaspect",
    "playlist",
    "virtualfolder"
  ],
  "id": "List.Filter.Fields.Episodes",
  "type": "string"
}

List.Filter.Fields.Movies

Type: string

JSON Schema Description

{
  "default": "title",
  "enums": [
    "title",
    "originaltitle",
    "plot",
    "plotoutline",
    "tagline",
    "votes",
    "rating",
    "userrating",
    "time",
    "writers",
    "playcount",
    "lastplayed",
    "inprogress",
    "genre",
    "country",
    "year",
    "director",
    "actor",
    "mpaarating",
    "top250",
    "studio",
    "hastrailer",
    "filename",
    "path",
    "set",
    "tag",
    "dateadded",
    "videoresolution",
    "audiochannels",
    "audiocount",
    "subtitlecount",
    "videocodec",
    "audiocodec",
    "audiolanguage",
    "subtitlelanguage",
    "videoaspect",
    "playlist",
    "virtualfolder"
  ],
  "id": "List.Filter.Fields.Movies",
  "type": "string"
}

List.Filter.Fields.MusicVideos

Type: string

JSON Schema Description

{
  "default": "title",
  "enums": [
    "title",
    "genre",
    "album",
    "year",
    "artist",
    "filename",
    "path",
    "playcount",
    "lastplayed",
    "rating",
    "userrating",
    "time",
    "director",
    "studio",
    "plot",
    "tag",
    "dateadded",
    "videoresolution",
    "audiochannels",
    "audiocount",
    "subtitlecount",
    "videocodec",
    "audiocodec",
    "audiolanguage",
    "subtitlelanguage",
    "videoaspect",
    "playlist",
    "virtualfolder"
  ],
  "id": "List.Filter.Fields.MusicVideos",
  "type": "string"
}

List.Filter.Fields.Songs

Type: string

JSON Schema Description

{
  "default": "genre",
  "enums": [
    "genre",
    "source",
    "album",
    "disctitle",
    "artist",
    "albumartist",
    "title",
    "year",
    "originalyear",
    "time",
    "tracknumber",
    "filename",
    "path",
    "playcount",
    "lastplayed",
    "rating",
    "userrating",
    "comment",
    "moods",
    "bpm",
    "samplerate",
    "bitrate",
    "channels",
    "dateadded",
    "datemodified",
    "datenew",
    "playlist",
    "virtualfolder"
  ],
  "id": "List.Filter.Fields.Songs",
  "type": "string"
}

List.Filter.Fields.TVShows

Type: string

JSON Schema Description

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

List.Filter.Fields.Textures

Type: string

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

List.Filter.Movies

Type: mixed

JSON Schema Description

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

List.Filter.MusicVideos

Type: mixed

JSON Schema Description

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

List.Filter.Operators

Type: string

JSON Schema Description

{
  "default": "contains",
  "enums": [
    "contains",
    "doesnotcontain",
    "is",
    "isnot",
    "startswith",
    "endswith",
    "greaterthan",
    "lessthan",
    "after",
    "before",
    "inthelast",
    "notinthelast",
    "true",
    "false",
    "between"
  ],
  "id": "List.Filter.Operators",
  "type": "string"
}

List.Filter.Rule

Type: object
Properties:

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

JSON Schema Description

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

List.Filter.Rule.Albums

Extends:

List.Filter.Rule

Properties:

List.Filter.Fields.Albums field

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

List.Filter.Rule.Artists

Extends:

List.Filter.Rule

Properties:

List.Filter.Fields.Artists field

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

List.Filter.Rule.Episodes

Extends:

List.Filter.Rule

Properties:

List.Filter.Fields.Episodes field

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

List.Filter.Rule.Movies

Extends:

List.Filter.Rule

Properties:

List.Filter.Fields.Movies field

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

List.Filter.Rule.MusicVideos

Extends:

List.Filter.Rule

Properties:

List.Filter.Fields.MusicVideos field

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

List.Filter.Rule.Songs

Extends:

List.Filter.Rule

Properties:

List.Filter.Fields.Songs field

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

List.Filter.Rule.TVShows

Extends:

List.Filter.Rule

Properties:

List.Filter.Fields.TVShows field

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

List.Filter.Rule.Textures

Extends:

List.Filter.Rule

Properties:

List.Filter.Fields.Textures field

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

List.Filter.Songs

Type: mixed

JSON Schema Description

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

List.Filter.TVShows

Type: mixed

JSON Schema Description

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

List.Filter.Textures

Type: mixed

JSON Schema Description

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

List.Item.All

Extends:

List.Item.Base

Properties:

[string channel]
[integer channelnumber]
[PVR.Channel.Type channeltype = tv]
[string endtime]
[boolean hidden]
[boolean locked]
[string starttime]
[integer subchannelnumber]

JSON Schema Description

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

List.Item.Base

Extends:

Video.Details.File
Audio.Details.Media

Properties:

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

JSON Schema Description

{
  "extends": [
    "Video.Details.File",
    "Audio.Details.Media"
  ],
  "id": "List.Item.Base",
  "properties": {
    "album": {
      "default": "",
      "type": "string"
    },
    "albumartist": {
      "$ref": "Array.String"
    },
    "albumartistid": {
      "$ref": "Array.Integer"
    },
    "albumid": {
      "$ref": "Library.Id",
      "default": -1
    },
    "albumlabel": {
      "default": "",
      "type": "string"
    },
    "albumreleasetype": {
      "$ref": "Audio.Album.ReleaseType",
      "default": "album"
    },
    "albumstatus": {
      "default": "",
      "type": "string"
    },
    "bitrate": {
      "default": 0,
      "type": "integer"
    },
    "bpm": {
      "default": 0,
      "type": "integer"
    },
    "cast": {
      "$ref": "Video.Cast"
    },
    "channels": {
      "default": 0,
      "type": "integer"
    },
    "comment": {
      "default": "",
      "type": "string"
    },
    "compilation": {
      "default": false,
      "type": "boolean"
    },
    "contributors": {
      "$ref": "Audio.Contributors"
    },
    "country": {
      "$ref": "Array.String"
    },
    "customproperties": {
      "$ref": "Item.CustomProperties"
    },
    "description": {
      "default": "",
      "type": "string"
    },
    "disc": {
      "default": 0,
      "type": "integer"
    },
    "disctitle": {
      "default": "",
      "type": "string"
    },
    "displaycomposer": {
      "default": "",
      "type": "string"
    },
    "displayconductor": {
      "default": "",
      "type": "string"
    },
    "displaylyricist": {
      "default": "",
      "type": "string"
    },
    "displayorchestra": {
      "default": "",
      "type": "string"
    },
    "duration": {
      "default": 0,
      "type": "integer"
    },
    "dynpath": {
      "default": "",
      "description": "An experimental property for debug purposes, often same as mediapath but when different gives the actual file playing that should also be in file property",
      "type": "string"
    },
    "episode": {
      "default": 0,
      "type": "integer"
    },
    "episodeguide": {
      "default": "",
      "type": "string"
    },
    "firstaired": {
      "default": "",
      "type": "string"
    },
    "id": {
      "$ref": "Library.Id",
      "default": -1
    },
    "imdbnumber": {
      "default": "",
      "type": "string"
    },
    "isboxset": {
      "default": false,
      "type": "boolean"
    },
    "lyrics": {
      "default": "",
      "type": "string"
    },
    "mediapath": {
      "default": "",
      "description": "Media source path that identifies the item",
      "type": "string"
    },
    "mood": {
      "$ref": "Array.String"
    },
    "mpaa": {
      "default": "",
      "type": "string"
    },
    "musicbrainzartistid": {
      "$ref": "Array.String"
    },
    "musicbrainztrackid": {
      "default": "",
      "type": "string"
    },
    "originaldate": {
      "default": "",
      "type": "string"
    },
    "originaltitle": {
      "default": "",
      "type": "string"
    },
    "plotoutline": {
      "default": "",
      "type": "string"
    },
    "premiered": {
      "default": "",
      "type": "string"
    },
    "productioncode": {
      "default": "",
      "type": "string"
    },
    "releasedate": {
      "default": "",
      "type": "string"
    },
    "releasetype": {
      "$ref": "Audio.Album.ReleaseType",
      "default": "album"
    },
    "samplerate": {
      "default": 0,
      "type": "integer"
    },
    "season": {
      "default": 0,
      "type": "integer"
    },
    "set": {
      "default": "",
      "type": "string"
    },
    "setid": {
      "$ref": "Library.Id",
      "default": -1
    },
    "showlink": {
      "$ref": "Array.String"
    },
    "showtitle": {
      "default": "",
      "type": "string"
    },
    "sorttitle": {
      "default": "",
      "type": "string"
    },
    "specialsortepisode": {
      "default": 0,
      "type": "integer"
    },
    "specialsortseason": {
      "default": 0,
      "type": "integer"
    },
    "studio": {
      "$ref": "Array.String"
    },
    "style": {
      "$ref": "Array.String"
    },
    "tag": {
      "$ref": "Array.String"
    },
    "tagline": {
      "default": "",
      "type": "string"
    },
    "theme": {
      "$ref": "Array.String"
    },
    "top250": {
      "default": 0,
      "type": "integer"
    },
    "totaldiscs": {
      "default": 0,
      "type": "integer"
    },
    "track": {
      "default": 0,
      "type": "integer"
    },
    "trailer": {
      "default": "",
      "type": "string"
    },
    "tvshowid": {
      "$ref": "Library.Id",
      "default": -1
    },
    "type": {
      "default": "unknown",
      "enums": [
        "unknown",
        "movie",
        "episode",
        "musicvideo",
        "song",
        "picture",
        "channel"
      ],
      "type": "string"
    },
    "uniqueid": {
      "$ref": "Media.UniqueID"
    },
    "votes": {
      "default": "",
      "type": "string"
    },
    "watchedepisodes": {
      "default": 0,
      "type": "integer"
    },
    "writer": {
      "$ref": "Array.String"
    }
  }
}

List.Item.File

Extends:

List.Item.Base

Properties:

string file
string filetype
[string lastmodified]
[string mimetype]
[integer size]

JSON Schema Description

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

List.Items.Sources

Type: array

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

List.Limits

Type: object
Properties:

[List.Amount end = -1]
[integer start]

JSON Schema Description

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

List.LimitsReturned

Type: object
Properties:

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

JSON Schema Description

{
  "additionalProperties": false,
  "id": "List.LimitsReturned",
  "properties": {
    "end": {
      "$ref": "List.Amount",
      "default": -1
    },
    "start": {
      "default": 0,
      "minimum": 0,
      "type": "integer"
    },
    "total": {
      "minimum": 0,
      "required": true,
      "type": "integer"
    }
  },
  "type": "object"
}

List.Sort

Type: object
Properties:

[boolean ignorearticle]
[string method = none]
[string order = ascending]
[boolean useartistsortname]

JSON Schema Description

{
  "id": "List.Sort",
  "properties": {
    "ignorearticle": {
      "default": false,
      "type": "boolean"
    },
    "method": {
      "default": "none",
      "enums": [
        "none",
        "label",
        "date",
        "size",
        "file",
        "path",
        "drivetype",
        "title",
        "track",
        "time",
        "artist",
        "album",
        "albumtype",
        "genre",
        "country",
        "year",
        "rating",
        "userrating",
        "votes",
        "top250",
        "programcount",
        "playlist",
        "episode",
        "season",
        "totalepisodes",
        "watchedepisodes",
        "tvshowstatus",
        "tvshowtitle",
        "sorttitle",
        "productioncode",
        "mpaa",
        "studio",
        "dateadded",
        "lastplayed",
        "playcount",
        "listeners",
        "bitrate",
        "random",
        "totaldiscs",
        "originaldate",
        "bpm"
      ],
      "type": "string"
    },
    "order": {
      "default": "ascending",
      "enums": [
        "ascending",
        "descending"
      ],
      "type": "string"
    },
    "useartistsortname": {
      "default": false,
      "type": "boolean"
    }
  },
  "type": "object"
}

Media

Media.Artwork

Type: object
Properties:

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

JSON Schema Description

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

Media.Artwork.Set

Type: object
Properties:

[mixed: null|Global.String.NotEmpty banner]
[mixed: null|Global.String.NotEmpty fanart]
[mixed: null|Global.String.NotEmpty poster]
[mixed: null|Global.String.NotEmpty thumb]

JSON Schema Description

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

Media.Details.Base

Extends:

Item.Details.Base

Properties:

[string fanart]
[string thumbnail]

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

Media.UniqueID

Type: object

JSON Schema Description
{ "additionalProperties": { "$ref": "Global.String.NotEmpty", "default": "" }, "id": "Media.UniqueID", "type": "object" }

Media.UniqueID.Set

Type: object

JSON Schema Description
{ "additionalProperties": { "default": null, "type": [ { "type": "null" }, { "$ref": "Global.String.NotEmpty" } ] }, "id": "Media.UniqueID.Set", "type": "object" }

Notifications

Notifications.Item

Type: mixed

JSON Schema Description

{
  "id": "Notifications.Item",
  "type": [
    {
      "description": "An unknown item does not have any additional information.",
      "properties": {
        "type": {
          "$ref": "Notifications.Item.Type",
          "required": true
        }
      },
      "type": "object"
    },
    {
      "description": "An item known to the database has an identification.",
      "properties": {
        "id": {
          "$ref": "Library.Id",
          "required": true
        },
        "type": {
          "$ref": "Notifications.Item.Type",
          "required": true
        }
      },
      "type": "object"
    },
    {
      "description": "A movie item has a title and may have a release year.",
      "properties": {
        "title": {
          "required": true,
          "type": "string"
        },
        "type": {
          "$ref": "Notifications.Item.Type",
          "required": true
        },
        "year": {
          "default": 0,
          "type": "integer"
        }
      },
      "type": "object"
    },
    {
      "description": "A tv episode has a title and may have an episode number, season number and the title of the show it belongs to.",
      "properties": {
        "episode": {
          "default": 0,
          "type": "integer"
        },
        "season": {
          "default": 0,
          "type": "integer"
        },
        "showtitle": {
          "default": "",
          "type": "string"
        },
        "title": {
          "required": true,
          "type": "string"
        },
        "type": {
          "$ref": "Notifications.Item.Type",
          "required": true
        }
      },
      "type": "object"
    },
    {
      "description": "A music video has a title and may have an album and an artist.",
      "properties": {
        "album": {
          "default": "",
          "type": "string"
        },
        "artist": {
          "default": "",
          "type": "string"
        },
        "title": {
          "required": true,
          "type": "string"
        },
        "type": {
          "$ref": "Notifications.Item.Type",
          "required": true
        }
      },
      "type": "object"
    },
    {
      "description": "A song has a title and may have an album, an artist and a track number.",
      "properties": {
        "album": {
          "default": "",
          "type": "string"
        },
        "artist": {
          "default": "",
          "type": "string"
        },
        "title": {
          "required": true,
          "type": "string"
        },
        "track": {
          "default": 0,
          "type": "integer"
        },
        "type": {
          "$ref": "Notifications.Item.Type",
          "required": true
        }
      },
      "type": "object"
    },
    {
      "description": "A picture has a file path.",
      "properties": {
        "file": {
          "required": true,
          "type": "string"
        },
        "type": {
          "$ref": "Notifications.Item.Type",
          "required": true
        }
      },
      "type": "object"
    },
    {
      "description": "A PVR channel is either a radio or tv channel and has a title.",
      "properties": {
        "channeltype": {
          "$ref": "PVR.Channel.Type",
          "required": true
        },
        "id": {
          "$ref": "Library.Id",
          "required": true
        },
        "title": {
          "required": true,
          "type": "string"
        },
        "type": {
          "$ref": "Notifications.Item.Type",
          "required": true
        }
      },
      "type": "object"
    }
  ]
}

Notifications.Item.Type

Type: string

JSON Schema Description
{ "default": "unknown", "enums": [ "unknown", "movie", "episode", "musicvideo", "song", "picture", "channel" ], "id": "Notifications.Item.Type", "type": "string" }

Optional

Optional.Boolean

Type: mixed

JSON Schema Description
{ "default": null, "id": "Optional.Boolean", "type": [ { "type": "null" }, { "type": "boolean" } ] }

Optional.Integer

Type: mixed

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

Optional.Number

Type: mixed

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

Optional.String

Type: mixed

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

PVR

PVR.Channel.Type

Type: string

JSON Schema Description
{ "default": "tv", "enums": [ "tv", "radio" ], "id": "PVR.Channel.Type", "type": "string" }

PVR.ChannelGroup.Id

Type: mixed

JSON Schema Description
{ "default": null, "id": "PVR.ChannelGroup.Id", "type": [ { "$ref": "Library.Id" }, { "enums": [ "alltv", "allradio" ], "type": "string" } ] }

PVR.Details.Broadcast

Extends:

Item.Details.Base

Properties:

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

JSON Schema Description

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

PVR.Details.Channel

Extends:

Item.Details.Base

Properties:

[PVR.Details.Broadcast broadcastnext]
[PVR.Details.Broadcast broadcastnow]
[string channel]
Library.Id channelid
[integer channelnumber]
[PVR.Channel.Type channeltype = tv]
[Library.Id clientid = -1]
[boolean hasarchive]
[boolean hidden]
[string icon]
[boolean isrecording]
[string lastplayed]
[boolean locked]
[integer subchannelnumber]
[string thumbnail]
integer uniqueid

JSON Schema Description

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

PVR.Details.ChannelGroup

Extends:

Item.Details.Base

Properties:

Library.Id channelgroupid
PVR.Channel.Type channeltype

JSON Schema Description

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

PVR.Details.ChannelGroup.Extended

Extends:

PVR.Details.ChannelGroup

Properties:

[array channels]
List.LimitsReturned limits

JSON Schema Description

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

PVR.Details.Client

Extends:

Item.Details.Base

Properties:

[string addonid]
Library.Id clientid
[boolean supportschannelgroups]
[boolean supportschannelscan]
[boolean supportsepg]
[boolean supportsradio]
[boolean supportsrecordings]
[boolean supportstimers]
[boolean supportstv]

JSON Schema Description

{
  "extends": "Item.Details.Base",
  "id": "PVR.Details.Client",
  "properties": {
    "addonid": {
      "default": "",
      "type": "string"
    },
    "clientid": {
      "$ref": "Library.Id",
      "required": true
    },
    "supportschannelgroups": {
      "default": false,
      "type": "boolean"
    },
    "supportschannelscan": {
      "default": false,
      "type": "boolean"
    },
    "supportsepg": {
      "default": false,
      "type": "boolean"
    },
    "supportsradio": {
      "default": false,
      "type": "boolean"
    },
    "supportsrecordings": {
      "default": false,
      "type": "boolean"
    },
    "supportstimers": {
      "default": false,
      "type": "boolean"
    },
    "supportstv": {
      "default": false,
      "type": "boolean"
    }
  }
}

PVR.Details.Recording

Extends:

Item.Details.Base

Properties:

[Media.Artwork art]
[string channel]
[integer channeluid]
[Library.Id clientid = -1]
[string directory]
[string endtime]
[integer epgeventid]
[integer episode]
[string file]
[string genre]
[string icon]
[boolean isdeleted]
[integer lifetime]
[integer playcount]
[string plot]
[string plotoutline]
[boolean radio]
Library.Id recordingid
[Video.Resume resume]
[integer runtime]
[integer season]
[string showtitle]
[string starttime]
[string streamurl]
[string title]

JSON Schema Description

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

PVR.Details.Timer

Extends:

Item.Details.Base

Properties:

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

JSON Schema Description

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

PVR.Fields.Broadcast

Extends:

Item.Fields.Base

JSON Schema Description

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

PVR.Fields.Channel

Extends:

Item.Fields.Base

JSON Schema Description

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

PVR.Fields.Client

Extends:

Item.Fields.Base

JSON Schema Description

{
  "extends": "Item.Fields.Base",
  "id": "PVR.Fields.Client",
  "items": {
    "enums": [
      "addonid",
      "supportstv",
      "supportsradio",
      "supportsepg",
      "supportsrecordings",
      "supportstimers",
      "supportschannelgroups",
      "supportschannelscan"
    ],
    "type": "string"
  }
}

PVR.Fields.Recording

Extends:

Item.Fields.Base

JSON Schema Description

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

PVR.Fields.Timer

Extends:

Item.Fields.Base

JSON Schema Description

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

PVR.Property.Name

Type: string

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

PVR.Property.Value

Type: object
Properties:

[boolean available]
[boolean recording]
[boolean scanning]

JSON Schema Description

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

PVR.TimerState

Type: string

JSON Schema Description

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

Player

Player.Audio.Stream

Type: object
Properties:

integer bitrate
integer channels
string codec
integer index
boolean isdefault
boolean isimpaired
boolean isoriginal
string language
string name
integer samplerate

JSON Schema Description

{
  "id": "Player.Audio.Stream",
  "properties": {
    "bitrate": {
      "required": true,
      "type": "integer"
    },
    "channels": {
      "required": true,
      "type": "integer"
    },
    "codec": {
      "required": true,
      "type": "string"
    },
    "index": {
      "minimum": 0,
      "required": true,
      "type": "integer"
    },
    "isdefault": {
      "required": true,
      "type": "boolean"
    },
    "isimpaired": {
      "required": true,
      "type": "boolean"
    },
    "isoriginal": {
      "required": true,
      "type": "boolean"
    },
    "language": {
      "required": true,
      "type": "string"
    },
    "name": {
      "required": true,
      "type": "string"
    },
    "samplerate": {
      "required": true,
      "type": "integer"
    }
  },
  "type": "object"
}

Player.CustomViewMode

Type: object
Properties:

[mixed: string|Optional.Boolean nonlinearstretch]
[mixed: string|Optional.Number pixelratio]
[mixed: string|Optional.Number verticalshift]
[mixed: string|Optional.Number zoom]

JSON Schema Description

{
  "id": "Player.CustomViewMode",
  "properties": {
    "nonlinearstretch": {
      "default": null,
      "type": [
        {
          "enums": [
            "increase",
            "decrease"
          ],
          "type": "string"
        },
        {
          "$ref": "Optional.Boolean",
          "description": "Flag to enable nonlinear stretch"
        }
      ]
    },
    "pixelratio": {
      "default": null,
      "type": [
        {
          "enums": [
            "increase",
            "decrease"
          ],
          "type": "string"
        },
        {
          "$ref": "Optional.Number",
          "description": "Pixel aspect ratio where 1.0 means square pixel"
        }
      ]
    },
    "verticalshift": {
      "default": null,
      "type": [
        {
          "enums": [
            "increase",
            "decrease"
          ],
          "type": "string"
        },
        {
          "$ref": "Optional.Number",
          "description": "Vertical shift 1.0 means shift to bottom"
        }
      ]
    },
    "zoom": {
      "default": null,
      "type": [
        {
          "enums": [
            "increase",
            "decrease"
          ],
          "type": "string"
        },
        {
          "$ref": "Optional.Number",
          "description": "Zoom where 1.0 means 100%"
        }
      ]
    }
  },
  "required": true,
  "type": "object"
}

Player.Id

Type: integer

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

Player.Notifications.Data

Type: object
Properties:

Notifications.Item item
Player.Notifications.Player player

JSON Schema Description

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

Player.Notifications.Player

Type: object
Properties:

Player.Id playerid
[integer speed]

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

Player.Notifications.Player.Seek

Extends:

Player.Notifications.Player

Properties:

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

JSON Schema Description

{
  "extends": "Player.Notifications.Player",
  "id": "Player.Notifications.Player.Seek",
  "properties": {
    "seekoffset": {
      "$ref": "Global.Time",
      "description": "A duration."
    },
    "time": {
      "$ref": "Global.Time",
      "description": "A duration."
    }
  }
}

Player.Position.Percentage

Type: number

JSON Schema Description
{ "default": 0.0, "id": "Player.Position.Percentage", "maximum": 100.0, "minimum": 0.0, "type": "number" }

Player.Position.Time

Type: object
Properties:

[integer hours]
[integer milliseconds]
[integer minutes]
[integer seconds]

JSON Schema Description

{
  "additionalProperties": false,
  "description": "A position in duration.",
  "id": "Player.Position.Time",
  "properties": {
    "hours": {
      "default": 0,
      "minimum": 0,
      "type": "integer"
    },
    "milliseconds": {
      "default": 0,
      "maximum": 999,
      "minimum": 0,
      "type": "integer"
    },
    "minutes": {
      "default": 0,
      "maximum": 59,
      "minimum": 0,
      "type": "integer"
    },
    "seconds": {
      "default": 0,
      "maximum": 59,
      "minimum": 0,
      "type": "integer"
    }
  },
  "type": "object"
}

Player.Property.Name

Type: string

JSON Schema Description

{
  "default": "type",
  "enums": [
    "type",
    "partymode",
    "speed",
    "time",
    "percentage",
    "totaltime",
    "playlistid",
    "position",
    "repeat",
    "shuffled",
    "canseek",
    "canchangespeed",
    "canmove",
    "canzoom",
    "canrotate",
    "canshuffle",
    "canrepeat",
    "currentaudiostream",
    "audiostreams",
    "subtitleenabled",
    "currentsubtitle",
    "subtitles",
    "live",
    "currentvideostream",
    "videostreams",
    "cachepercentage"
  ],
  "id": "Player.Property.Name",
  "type": "string"
}

Player.Property.Value

Type: object
Properties:

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

JSON Schema Description

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

Player.Repeat

Type: string

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

Player.Speed

Type: object
Properties:

[integer speed]

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

Player.Subtitle

Type: object
Properties:

integer index
boolean isdefault
boolean isforced
boolean isimpaired
string language
string name

JSON Schema Description

{
  "id": "Player.Subtitle",
  "properties": {
    "index": {
      "minimum": 0,
      "required": true,
      "type": "integer"
    },
    "isdefault": {
      "required": true,
      "type": "boolean"
    },
    "isforced": {
      "required": true,
      "type": "boolean"
    },
    "isimpaired": {
      "required": true,
      "type": "boolean"
    },
    "language": {
      "required": true,
      "type": "string"
    },
    "name": {
      "required": true,
      "type": "string"
    }
  },
  "type": "object"
}

Player.Type

Type: string

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

Player.Video.Stream

Type: object
Properties:

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

JSON Schema Description

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

Player.ViewMode

Type: string

JSON Schema Description

{
  "default": "normal",
  "enums": [
    "normal",
    "zoom",
    "stretch4x3",
    "widezoom",
    "stretch16x9",
    "original",
    "stretch16x9nonlin",
    "zoom120width",
    "zoom110width"
  ],
  "id": "Player.ViewMode",
  "type": "string"
}

Playlist

Playlist.Id

Type: integer

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

Playlist.Item

Type: mixed

JSON Schema Description

{
  "id": "Playlist.Item",
  "type": [
    {
      "additionalProperties": false,
      "properties": {
        "file": {
          "description": "Path to a file (not a directory) to be added to the playlist",
          "required": true,
          "type": "string"
        }
      },
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "directory": {
          "required": true,
          "type": "string"
        },
        "media": {
          "$ref": "Files.Media",
          "default": "files"
        },
        "recursive": {
          "default": false,
          "type": "boolean"
        }
      },
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "movieid": {
          "$ref": "Library.Id",
          "required": true
        }
      },
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "episodeid": {
          "$ref": "Library.Id",
          "required": true
        }
      },
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "musicvideoid": {
          "$ref": "Library.Id",
          "required": true
        }
      },
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "artistid": {
          "$ref": "Library.Id",
          "required": true
        }
      },
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "albumid": {
          "$ref": "Library.Id",
          "required": true
        }
      },
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "songid": {
          "$ref": "Library.Id",
          "required": true
        }
      },
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "genreid": {
          "$ref": "Library.Id",
          "description": "Identification of a genre from the AudioLibrary",
          "required": true
        }
      },
      "type": "object"
    }
  ]
}

Playlist.Position

Type: integer

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

Playlist.Property.Name

Type: string

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

Playlist.Property.Value

Type: object
Properties:

[integer size]
[Playlist.Type type = unknown]

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

Playlist.Type

Type: string

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

Profiles

Profiles.Details.Profile

Extends:

Item.Details.Base

Properties:

[integer lockmode]
[string thumbnail]

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

Profiles.Fields.Profile

Extends:

Item.Fields.Base

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

Profiles.Password

Type: object
Properties:

[string encryption = md5]
string value

JSON Schema Description

{
  "id": "Profiles.Password",
  "properties": {
    "encryption": {
      "default": "md5",
      "description": "Password Encryption",
      "enums": [
        "none",
        "md5"
      ],
      "type": "string"
    },
    "value": {
      "description": "Password",
      "required": true,
      "type": "string"
    }
  },
  "type": "object"
}

Setting

Setting.Details.Base

Type: object
Properties:

[string help]
string id
string label

JSON Schema Description

{
  "id": "Setting.Details.Base",
  "properties": {
    "help": {
      "default": "",
      "type": "string"
    },
    "id": {
      "minLength": 1,
      "required": true,
      "type": "string"
    },
    "label": {
      "required": true,
      "type": "string"
    }
  },
  "type": "object"
}

Setting.Details.Category

Extends:

Setting.Details.Base

Properties:

[array groups]

JSON Schema Description

{
  "additionalProperties": false,
  "extends": "Setting.Details.Base",
  "id": "Setting.Details.Category",
  "properties": {
    "groups": {
      "items": {
        "$ref": "Setting.Details.Group"
      },
      "minItems": 1,
      "type": "array",
      "uniqueItems": true
    }
  }
}

Setting.Details.Control

Type: mixed

JSON Schema Description

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

Setting.Details.ControlBase

Type: object
Properties:

boolean delayed
string format
string type

JSON Schema Description

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

Setting.Details.ControlButton

Extends:

Setting.Details.ControlHeading

Properties:

string type

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

Setting.Details.ControlCheckmark

Extends:

Setting.Details.ControlBase

Properties:

string format
string type

JSON Schema Description

{
  "extends": "Setting.Details.ControlBase",
  "id": "Setting.Details.ControlCheckmark",
  "properties": {
    "format": {
      "enums": [
        "boolean"
      ],
      "required": true,
      "type": "string"
    },
    "type": {
      "enums": [
        "toggle"
      ],
      "required": true,
      "type": "string"
    }
  }
}

Setting.Details.ControlEdit

Extends:

Setting.Details.ControlHeading

Properties:

boolean hidden
string type
boolean verifynewvalue

JSON Schema Description

{
  "extends": "Setting.Details.ControlHeading",
  "id": "Setting.Details.ControlEdit",
  "properties": {
    "hidden": {
      "required": true,
      "type": "boolean"
    },
    "type": {
      "enums": [
        "edit"
      ],
      "required": true,
      "type": "string"
    },
    "verifynewvalue": {
      "required": true,
      "type": "boolean"
    }
  }
}

Setting.Details.ControlHeading

Extends:

Setting.Details.ControlBase

Properties:

[string heading]

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

Setting.Details.ControlLabel

Extends:

Setting.Details.ControlBase

Properties:

string format
string type

JSON Schema Description

{
  "extends": "Setting.Details.ControlBase",
  "id": "Setting.Details.ControlLabel",
  "properties": {
    "format": {
      "enums": [
        "string"
      ],
      "required": true,
      "type": "string"
    },
    "type": {
      "enums": [
        "label"
      ],
      "required": true,
      "type": "string"
    }
  }
}

Setting.Details.ControlList

Extends:

Setting.Details.ControlHeading

Properties:

boolean multiselect
string type

JSON Schema Description

{
  "extends": "Setting.Details.ControlHeading",
  "id": "Setting.Details.ControlList",
  "properties": {
    "multiselect": {
      "required": true,
      "type": "boolean"
    },
    "type": {
      "enums": [
        "list"
      ],
      "required": true,
      "type": "string"
    }
  }
}

Setting.Details.ControlRange

Extends:

Setting.Details.ControlBase

Properties:

string formatlabel
string formatvalue
string type

JSON Schema Description

{
  "extends": "Setting.Details.ControlBase",
  "id": "Setting.Details.ControlRange",
  "properties": {
    "formatlabel": {
      "required": true,
      "type": "string"
    },
    "formatvalue": {
      "required": true,
      "type": "string"
    },
    "type": {
      "enums": [
        "range"
      ],
      "required": true,
      "type": "string"
    }
  }
}

Setting.Details.ControlSlider

Extends:

Setting.Details.ControlHeading

Properties:

string formatlabel
boolean popup
string type

JSON Schema Description

{
  "extends": "Setting.Details.ControlHeading",
  "id": "Setting.Details.ControlSlider",
  "properties": {
    "formatlabel": {
      "required": true,
      "type": "string"
    },
    "popup": {
      "required": true,
      "type": "boolean"
    },
    "type": {
      "enums": [
        "slider"
      ],
      "required": true,
      "type": "string"
    }
  }
}

Setting.Details.ControlSpinner

Extends:

Setting.Details.ControlBase

Properties:

[string formatlabel]
[string minimumlabel]
string type

JSON Schema Description

{
  "extends": "Setting.Details.ControlBase",
  "id": "Setting.Details.ControlSpinner",
  "properties": {
    "formatlabel": {
      "default": "",
      "type": "string"
    },
    "minimumlabel": {
      "default": "",
      "type": "string"
    },
    "type": {
      "enums": [
        "spinner"
      ],
      "required": true,
      "type": "string"
    }
  }
}

Setting.Details.Group

Type: object
Properties:

string id
[array settings]

JSON Schema Description

{
  "additionalProperties": false,
  "id": "Setting.Details.Group",
  "properties": {
    "id": {
      "minLength": 1,
      "required": true,
      "type": "string"
    },
    "settings": {
      "items": {
        "$ref": "Setting.Details.Setting"
      },
      "minItems": 1,
      "type": "array",
      "uniqueItems": true
    }
  },
  "type": "object"
}

Setting.Details.Section

Extends:

Setting.Details.Base

Properties:

[array categories]

JSON Schema Description

{
  "additionalProperties": false,
  "extends": "Setting.Details.Base",
  "id": "Setting.Details.Section",
  "properties": {
    "categories": {
      "items": {
        "$ref": "Setting.Details.Category"
      },
      "minItems": 1,
      "type": "array",
      "uniqueItems": true
    }
  }
}

Setting.Details.Setting

Type: mixed

JSON Schema Description

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

Setting.Details.SettingAction

Extends:

Setting.Details.SettingBase

Properties:

string data

JSON Schema Description
{ "additionalProperties": false, "extends": "Setting.Details.SettingBase", "id": "Setting.Details.SettingAction", "properties": { "data": { "required": true, "type": "string" } } }

Setting.Details.SettingAddon

Extends:

Setting.Details.SettingString

Properties:

Addon.Types addontype

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

Setting.Details.SettingBase

Extends:

Setting.Details.Base

Properties:

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

JSON Schema Description

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

Setting.Details.SettingBool

Extends:

Setting.Details.SettingBase

Properties:

boolean default
boolean value

JSON Schema Description

{
  "additionalProperties": false,
  "extends": "Setting.Details.SettingBase",
  "id": "Setting.Details.SettingBool",
  "properties": {
    "default": {
      "required": true,
      "type": "boolean"
    },
    "value": {
      "required": true,
      "type": "boolean"
    }
  }
}

Setting.Details.SettingDate

Extends:

Setting.Details.SettingString

JSON Schema Description
{ "additionalProperties": false, "extends": "Setting.Details.SettingString", "id": "Setting.Details.SettingDate" }

Setting.Details.SettingInt

Extends:

Setting.Details.SettingBase

Properties:

integer default
[integer maximum]
[integer minimum]
[array options]
[integer step]
integer value

JSON Schema Description

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

Setting.Details.SettingList

Extends:

Setting.Details.SettingBase

Properties:

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

JSON Schema Description

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

Setting.Details.SettingNumber

Extends:

Setting.Details.SettingBase

Properties:

number default
number maximum
number minimum
number step
number value

JSON Schema Description

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

Setting.Details.SettingPath

Extends:

Setting.Details.SettingString

Properties:

[array sources]
boolean writable

JSON Schema Description

{
  "additionalProperties": false,
  "extends": "Setting.Details.SettingString",
  "id": "Setting.Details.SettingPath",
  "properties": {
    "sources": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "writable": {
      "required": true,
      "type": "boolean"
    }
  }
}

Setting.Details.SettingString

Extends:

Setting.Details.SettingBase

Properties:

boolean allowempty
string default
[array options]
string value

JSON Schema Description

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

Setting.Details.SettingTime

Extends:

Setting.Details.SettingString

JSON Schema Description
{ "additionalProperties": false, "extends": "Setting.Details.SettingString", "id": "Setting.Details.SettingTime" }

Setting.Level

Type: string

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

Setting.Type

Type: string

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

Setting.Value

Type: mixed

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

Setting.Value.Extended

Type: mixed

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

Setting.Value.List

Type: array

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

System

System.Property.Name

Type: string

JSON Schema Description
{ "default": "canshutdown", "enums": [ "canshutdown", "cansuspend", "canhibernate", "canreboot" ], "id": "System.Property.Name", "type": "string" }

System.Property.Value

Type: object
Properties:

[boolean canhibernate]
[boolean canreboot]
[boolean canshutdown]
[boolean cansuspend]

JSON Schema Description

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

Textures

Textures.Details.Size

Type: object
Properties:

[integer height]
[string lastused]
[integer size]
[integer usecount]
[integer width]

JSON Schema Description

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

Textures.Details.Texture

Type: object
Properties:

[string cachedurl]
[string imagehash]
[string lasthashcheck]
[array sizes]
[Library.Id textureid = -1]
[string url]

JSON Schema Description

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

Textures.Fields.Texture

Extends:

Item.Fields.Base

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

Video

Video.Cast

Type: array

JSON Schema Description

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

Video.Details.Base

Extends:

Media.Details.Base

Properties:

[Media.Artwork art]
[integer playcount]

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

Video.Details.Episode

Extends:

Video.Details.File

Properties:

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

JSON Schema Description

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

Video.Details.File

Extends:

Video.Details.Item

Properties:

[Array.String director]
[Video.Resume resume]
[integer runtime]
[Video.Streams streamdetails]

JSON Schema Description

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

Video.Details.Item

Extends:

Video.Details.Media

Properties:

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

JSON Schema Description

{
  "extends": "Video.Details.Media",
  "id": "Video.Details.Item",
  "properties": {
    "dateadded": {
      "default": "",
      "type": "string"
    },
    "file": {
      "default": "",
      "type": "string"
    },
    "lastplayed": {
      "default": "",
      "type": "string"
    },
    "plot": {
      "default": "",
      "type": "string"
    }
  }
}

Video.Details.Media

Extends:

Video.Details.Base

Properties:

[string title]

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

Video.Details.Movie

Extends:

Video.Details.File

Properties:

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

JSON Schema Description

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

Video.Details.MovieSet

Extends:

Video.Details.Media

Properties:

[string plot]
Library.Id setid

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

Video.Details.MovieSet.Extended

Extends:

Video.Details.MovieSet

Properties:

List.LimitsReturned limits
[array movies]

JSON Schema Description

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

Video.Details.MusicVideo

Extends:

Video.Details.File

Properties:

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

JSON Schema Description

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

Video.Details.Season

Extends:

Video.Details.Base

Properties:

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

JSON Schema Description

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

Video.Details.TVShow

Extends:

Video.Details.Item

Properties:

[Video.Cast cast]
[integer episode]
[string episodeguide]
[Array.String genre]
[string imdbnumber]
[string mpaa]
[string originaltitle]
[string premiered]
[number rating]
[any ratings]
[integer runtime]
[integer season]
[string sorttitle]
[string status]
[Array.String studio]
[Array.String tag]
Library.Id tvshowid
[Media.UniqueID uniqueid]
[integer userrating]
[string votes]
[integer watchedepisodes]
[integer year]

JSON Schema Description

{
  "extends": "Video.Details.Item",
  "id": "Video.Details.TVShow",
  "properties": {
    "cast": {
      "$ref": "Video.Cast"
    },
    "episode": {
      "default": 0,
      "type": "integer"
    },
    "episodeguide": {
      "default": "",
      "type": "string"
    },
    "genre": {
      "$ref": "Array.String"
    },
    "imdbnumber": {
      "default": "",
      "type": "string"
    },
    "mpaa": {
      "default": "",
      "type": "string"
    },
    "originaltitle": {
      "default": "",
      "type": "string"
    },
    "premiered": {
      "default": "",
      "type": "string"
    },
    "rating": {
      "default": 0.0,
      "type": "number"
    },
    "ratings": {
      "default": null,
      "type": "any"
    },
    "runtime": {
      "default": 0,
      "description": "Runtime in seconds",
      "type": "integer"
    },
    "season": {
      "default": 0,
      "type": "integer"
    },
    "sorttitle": {
      "default": "",
      "type": "string"
    },
    "status": {
      "default": "",
      "description": "Returns 'returning series', 'in production', 'planned', 'cancelled' or 'ended'",
      "type": "string"
    },
    "studio": {
      "$ref": "Array.String"
    },
    "tag": {
      "$ref": "Array.String"
    },
    "tvshowid": {
      "$ref": "Library.Id",
      "required": true
    },
    "uniqueid": {
      "$ref": "Media.UniqueID"
    },
    "userrating": {
      "default": 0,
      "type": "integer"
    },
    "votes": {
      "default": "",
      "type": "string"
    },
    "watchedepisodes": {
      "default": 0,
      "type": "integer"
    },
    "year": {
      "default": 0,
      "type": "integer"
    }
  }
}

Video.Fields.Episode

Extends:

Item.Fields.Base

JSON Schema Description

{
  "extends": "Item.Fields.Base",
  "id": "Video.Fields.Episode",
  "items": {
    "description": "Requesting the cast, ratings, streamdetails, uniqueid and/or tag field will result in increased response times",
    "enums": [
      "title",
      "plot",
      "votes",
      "rating",
      "writer",
      "firstaired",
      "playcount",
      "runtime",
      "director",
      "productioncode",
      "season",
      "episode",
      "originaltitle",
      "showtitle",
      "cast",
      "streamdetails",
      "lastplayed",
      "fanart",
      "thumbnail",
      "file",
      "resume",
      "tvshowid",
      "dateadded",
      "uniqueid",
      "art",
      "specialsortseason",
      "specialsortepisode",
      "userrating",
      "seasonid",
      "ratings"
    ],
    "type": "string"
  }
}

Video.Fields.Movie

Extends:

Item.Fields.Base

JSON Schema Description

{
  "extends": "Item.Fields.Base",
  "id": "Video.Fields.Movie",
  "items": {
    "description": "Requesting the cast, ratings, showlink, streamdetails, uniqueid and/or tag field will result in increased response times",
    "enums": [
      "title",
      "genre",
      "year",
      "rating",
      "director",
      "trailer",
      "tagline",
      "plot",
      "plotoutline",
      "originaltitle",
      "lastplayed",
      "playcount",
      "writer",
      "studio",
      "mpaa",
      "cast",
      "country",
      "imdbnumber",
      "runtime",
      "set",
      "showlink",
      "streamdetails",
      "top250",
      "votes",
      "fanart",
      "thumbnail",
      "file",
      "sorttitle",
      "resume",
      "setid",
      "dateadded",
      "tag",
      "art",
      "userrating",
      "ratings",
      "premiered",
      "uniqueid"
    ],
    "type": "string"
  }
}

Video.Fields.MovieSet

Extends:

Item.Fields.Base

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

Video.Fields.MusicVideo

Extends:

Item.Fields.Base

JSON Schema Description

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

Video.Fields.Season

Extends:

Item.Fields.Base

JSON Schema Description

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

Video.Fields.TVShow

Extends:

Item.Fields.Base

JSON Schema Description

{
  "extends": "Item.Fields.Base",
  "id": "Video.Fields.TVShow",
  "items": {
    "description": "Requesting the cast, ratings, uniqueid and/or tag field will result in increased response times",
    "enums": [
      "title",
      "genre",
      "year",
      "rating",
      "plot",
      "studio",
      "mpaa",
      "cast",
      "playcount",
      "episode",
      "imdbnumber",
      "premiered",
      "votes",
      "lastplayed",
      "fanart",
      "thumbnail",
      "file",
      "originaltitle",
      "sorttitle",
      "episodeguide",
      "season",
      "watchedepisodes",
      "dateadded",
      "tag",
      "art",
      "userrating",
      "ratings",
      "runtime",
      "uniqueid"
    ],
    "type": "string"
  }
}

Video.Rating

Type: object
Properties:

[boolean default]
number rating
[integer votes]

JSON Schema Description

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

Video.Ratings

Type: object

JSON Schema Description
{ "additionalProperties": { "$ref": "Video.Rating" }, "id": "Video.Ratings", "type": "object" }

Video.Ratings.Set

Type: object

JSON Schema Description
{ "additionalProperties": { "default": null, "type": [ { "type": "null" }, { "$ref": "Video.Rating" } ] }, "id": "Video.Ratings.Set", "type": "object" }

Video.Resume

Type: object
Properties:

[number position]
[number total]

JSON Schema Description

{
  "additionalProperties": false,
  "id": "Video.Resume",
  "properties": {
    "position": {
      "default": 0.0,
      "minimum": 0.0,
      "type": "number"
    },
    "total": {
      "default": 0.0,
      "minimum": 0.0,
      "type": "number"
    }
  },
  "type": "object"
}

Video.Streams

Type: object
Properties:

[array audio]
[array subtitle]
[array video]

JSON Schema Description

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

Notifications

Application

Application.OnVolumeChanged

The volume of the application has changed.
Parameters:

string sender
object data:
- boolean muted
- integer volume

JSON Schema Description

{
  "description": "The volume of the application has changed.",
  "params": [
    {
      "name": "sender",
      "required": true,
      "type": "string"
    },
    {
      "name": "data",
      "properties": {
        "muted": {
          "required": true,
          "type": "boolean"
        },
        "volume": {
          "maximum": 100,
          "minimum": 0,
          "required": true,
          "type": "integer"
        }
      },
      "required": true,
      "type": "object"
    }
  ],
  "returns": null,
  "type": "notification"
}

AudioLibrary

AudioLibrary.OnCleanFinished

The audio library has been cleaned.
Parameters:

string sender
string data

JSON Schema Description

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

AudioLibrary.OnCleanStarted

An audio library clean operation has started.
Parameters:

string sender
string data

JSON Schema Description

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

AudioLibrary.OnExport

An audio library export has finished.
Parameters:

string sender
[object data]:
- [integer failcount = 0]
- [string file = ""]

JSON Schema Description

{
  "description": "An audio library export has finished.",
  "params": [
    {
      "name": "sender",
      "required": true,
      "type": "string"
    },
    {
      "name": "data",
      "properties": {
        "failcount": {
          "default": 0,
          "minimum": 0,
          "required": false,
          "type": "integer"
        },
        "file": {
          "default": "",
          "required": false,
          "type": "string"
        }
      },
      "required": false,
      "type": "object"
    }
  ],
  "returns": null,
  "type": "notification"
}

AudioLibrary.OnRemove

An audio item has been removed.
Parameters:

string sender
object data:
- Library.Id id
- Optional.Boolean transaction
- Notifications.Library.Audio.Type type

JSON Schema Description

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

AudioLibrary.OnScanFinished

Scanning the audio library has been finished.
Parameters:

string sender
string data

JSON Schema Description

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

AudioLibrary.OnScanStarted

An audio library scan has started.
Parameters:

string sender
string data

JSON Schema Description

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

AudioLibrary.OnUpdate

An audio item has been updated.
Parameters:

string sender
object data:
- Optional.Boolean added
- Library.Id id
- Optional.Boolean transaction
- string type

JSON Schema Description

{
  "description": "An audio item has been updated.",
  "params": [
    {
      "name": "sender",
      "required": true,
      "type": "string"
    },
    {
      "name": "data",
      "properties": {
        "added": {
          "$ref": "Optional.Boolean",
          "description": "True if the update is for a newly added item."
        },
        "id": {
          "$ref": "Library.Id",
          "required": true
        },
        "transaction": {
          "$ref": "Optional.Boolean",
          "description": "True if the update is being performed within a transaction."
        },
        "type": {
          "enum": [
            "song"
          ],
          "id": "Notifications.Library.Audio.Type",
          "required": true,
          "type": "string"
        }
      },
      "required": true,
      "type": "object"
    }
  ],
  "returns": null,
  "type": "notification"
}

GUI

GUI.OnDPMSActivated

Energy saving/DPMS has been activated.
Parameters:

string sender
string data

JSON Schema Description

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

GUI.OnDPMSDeactivated

Energy saving/DPMS has been deactivated.
Parameters:

string sender
string data

JSON Schema Description

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

GUI.OnScreensaverActivated

The screensaver has been activated.
Parameters:

string sender
string data

JSON Schema Description

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

GUI.OnScreensaverDeactivated

The screensaver has been deactivated.
Parameters:

string sender
object data:
- boolean shuttingdown

JSON Schema Description

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

Input

Input.OnInputFinished

The user has provided the requested input.
Parameters:

string sender
string data

JSON Schema Description

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

Input.OnInputRequested

The user is requested to provide some information.
Parameters:

string sender
object data:
- string title
- string type
- string value

JSON Schema Description

{
  "description": "The user is requested to provide some information.",
  "params": [
    {
      "name": "sender",
      "required": true,
      "type": "string"
    },
    {
      "name": "data",
      "properties": {
        "title": {
          "type": "string"
        },
        "type": {
          "enum": [
            "keyboard",
            "time",
            "date",
            "ip",
            "password",
            "numericpassword",
            "number",
            "seconds"
          ],
          "required": true,
          "type": "string"
        },
        "value": {
          "required": true,
          "type": "string"
        }
      },
      "required": true,
      "type": "object"
    }
  ],
  "returns": null,
  "type": "notification"
}

Player

Player.OnAVChange

Audio- or videostream has changed. If there is no ID available extra information will be provided.
Parameters:

string sender
Player.Notifications.Data data

JSON Schema Description

{
  "description": "Audio- or videostream has changed. If there is no ID available extra information will be provided.",
  "params": [
    {
      "name": "sender",
      "required": true,
      "type": "string"
    },
    {
      "$ref": "Player.Notifications.Data",
      "name": "data",
      "required": true
    }
  ],
  "returns": null,
  "type": "notification"
}

Player.OnAVStart

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

string sender
Player.Notifications.Data data

JSON Schema Description

{
  "description": "Playback of a media item has been started and first frame is available. If there is no ID available extra information will be provided.",
  "params": [
    {
      "name": "sender",
      "required": true,
      "type": "string"
    },
    {
      "$ref": "Player.Notifications.Data",
      "name": "data",
      "required": true
    }
  ],
  "returns": null,
  "type": "notification"
}

Player.OnPause

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

string sender
Player.Notifications.Data data

JSON Schema Description

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

Player.OnPlay

Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.
Parameters:

string sender
Player.Notifications.Data data

JSON Schema Description

{
  "description": "Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.",
  "params": [
    {
      "name": "sender",
      "required": true,
      "type": "string"
    },
    {
      "$ref": "Player.Notifications.Data",
      "name": "data",
      "required": true
    }
  ],
  "returns": null,
  "type": "notification"
}

Player.OnPropertyChanged

A property of the playing items has changed.
Parameters:

string sender
object data:
- Player.Notifications.Player player
- Player.Property.Value property

JSON Schema Description

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

Player.OnResume

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

string sender
Player.Notifications.Data data

JSON Schema Description

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

Player.OnSeek

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

string sender
object data:
- Notifications.Item item
- Player.Notifications.Player.Seek player

JSON Schema Description

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

Player.OnSpeedChanged

Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.
Parameters:

string sender
Player.Notifications.Data data

JSON Schema Description

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

Player.OnStop

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

string sender
object data:
- boolean end
- Notifications.Item item

JSON Schema Description

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

Playlist

Playlist.OnAdd

A playlist item has been added.
Parameters:

string sender
object data:
- Notifications.Item item
- Playlist.Id playlistid
- Playlist.Position position

JSON Schema Description

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

Playlist.OnClear

A playlist item has been cleared.
Parameters:

string sender
object data:
- Playlist.Id playlistid

JSON Schema Description

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

Playlist.OnRemove

A playlist item has been removed.
Parameters:

string sender
object data:
- Playlist.Id playlistid
- Playlist.Position position

JSON Schema Description

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

System

System.OnLowBattery

The system is on low battery.
Parameters:

string sender
string data

JSON Schema Description

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

System.OnQuit

Kodi will be closed.
Parameters:

string sender
object data:
- integer exitcode

JSON Schema Description

{
  "description": "Kodi will be closed.",
  "params": [
    {
      "name": "sender",
      "required": true,
      "type": "string"
    },
    {
      "name": "data",
      "properties": {
        "exitcode": {
          "minimum": 0,
          "required": true,
          "type": "integer"
        }
      },
      "required": true,
      "type": "object"
    }
  ],
  "returns": null,
  "type": "notification"
}

System.OnRestart

The system will be restarted.
Parameters:

string sender
string data

JSON Schema Description

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

System.OnSleep

The system will be suspended.
Parameters:

string sender
string data

JSON Schema Description

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

System.OnWake

The system woke up from suspension.
Parameters:

string sender
string data

JSON Schema Description

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

VideoLibrary

VideoLibrary.OnCleanFinished

The video library has been cleaned.
Parameters:

string sender
string data

JSON Schema Description

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

VideoLibrary.OnCleanStarted

A video library clean operation has started.
Parameters:

string sender
string data

JSON Schema Description

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

VideoLibrary.OnExport

A video library export has finished.
Parameters:

string sender
[object data]:
- [integer failcount = 0]
- [string file = ""]
- [string root = ""]

JSON Schema Description

{
  "description": "A video library export has finished.",
  "params": [
    {
      "name": "sender",
      "required": true,
      "type": "string"
    },
    {
      "name": "data",
      "properties": {
        "failcount": {
          "default": 0,
          "minimum": 0,
          "required": false,
          "type": "integer"
        },
        "file": {
          "default": "",
          "required": false,
          "type": "string"
        },
        "root": {
          "default": "",
          "required": false,
          "type": "string"
        }
      },
      "required": false,
      "type": "object"
    }
  ],
  "returns": null,
  "type": "notification"
}

VideoLibrary.OnRefresh

The video library has been refreshed and a home screen reload might be necessary.
Parameters:

string sender
string data

JSON Schema Description

{
  "description": "The video library has been refreshed and a home screen reload might be necessary.",
  "params": [
    {
      "name": "sender",
      "required": true,
      "type": "string"
    },
    {
      "name": "data",
      "required": true,
      "type": "null"
    }
  ],
  "returns": null,
  "type": "notification"
}

VideoLibrary.OnRemove

A video item has been removed.
Parameters:

string sender
object data:
- Library.Id id
- Optional.Boolean transaction
- Notifications.Library.Video.Type type

JSON Schema Description

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

VideoLibrary.OnScanFinished

Scanning the video library has been finished.
Parameters:

string sender
string data

JSON Schema Description

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

VideoLibrary.OnScanStarted

A video library scan has started.
Parameters:

string sender
string data

JSON Schema Description

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

VideoLibrary.OnUpdate

A video item has been updated.
Parameters:

string sender
object data:
- Optional.Boolean added
- Library.Id id
- integer playcount = -1
- Optional.Boolean transaction
- string type

JSON Schema Description

{
  "description": "A video item has been updated.",
  "params": [
    {
      "name": "sender",
      "required": true,
      "type": "string"
    },
    {
      "name": "data",
      "properties": {
        "added": {
          "$ref": "Optional.Boolean",
          "description": "True if the update is for a newly added item."
        },
        "id": {
          "$ref": "Library.Id",
          "required": true
        },
        "playcount": {
          "default": -1,
          "minimum": 0,
          "type": "integer"
        },
        "transaction": {
          "$ref": "Optional.Boolean",
          "description": "True if the update is being performed within a transaction."
        },
        "type": {
          "enum": [
            "movie",
            "tvshow",
            "episode",
            "musicvideo"
          ],
          "id": "Notifications.Library.Video.Type",
          "required": true,
          "type": "string"
        }
      },
      "required": true,
      "type": "object"
    }
  ],
  "returns": null,
  "type": "notification"
}

External links