Official Kodi Wiki - User contributions [en]

JSON-RPC API

2019-01-04T09:56:13Z

Ncarthy: /* API versions */

{{mininav|[[Development]]}}

{{JSON-RPC API nav}}
<br />

JSON-RPC is a HTTP- and/or raw TCP socket-based interface for communicating with Kodi. It replaces the deprecated [[HTTP API]], and offers a more secure and robust mechanism in the same format. It is based upon the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification].

Each method in the interface can have different security needs which means one client may be allowed to only control playback while another can only read and manipulate the library. In version 2 (first stable) and 4 all clients are granted full authority but will later be forced to ask for privileges and the user of Kodi will have to grant said client access. The design of JSON-RPC is that most methods should behave roughly the same and maintain consistency while hiding the mechanics of Kodi from the client creator.

In Kodi JSON-RPC can be accessed over a variety of transports and has been designed from the ground up to be flexible to allow control over new transports easily. Some of the transports have different limitations which will be enforced upon the interaction over that transport. As an example HTTP transports allow response and downloading of files while the raw TCP transport allows response and notifications (events and information Kodi sends to its clients). Depending on the client's needs it will choose one (or many) of the available transports.<br />

== Enabling JSON-RPC ==
Since the interface is available on many transports enabling it depends on the transport.
* Python: Always enabled
* HTTP: In System/Settings/Network/Services activate ''Allow control of Kodi via HTTP'' (see [[Webserver#Enabling the webserver|Enabling the webserver]])
* TCP: In System/Settings/Network/Services activate ''Allow programs on this system to control Kodi'' for localhost access only and ''Allow programs on other systems to control Kodi'' for access from other computers as well

Note: The [[EventServer]] is a different interface for sending remote keypresses to Kodi, and must be enabled separately, some programs may use both interfaces.

== Transports & Functionalities ==
=== Transports ===
==== Python ====
The ''Python'' transport can only be used by Kodi addons through the '''executeJSONRPC''' method provided by the '''xbmc''' python library. As it must be available to every addon in an Kodi installation it must not be enabled or disabled by the user.

==== HTTP ====
The ''HTTP'' transport can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol HTTP] protocol. Because this transport allows applications outside Kodi to control Kodi, it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user.

===== POST =====
Third-party applications can access Kodi's JSON-RPC API by sending JSON-RPC requests embedded in HTTP [http://en.wikipedia.org/wiki/POST_(HTTP) POST] requests to the following URL
<pre>http://<your-ip>:<your-port>/jsonrpc</pre>

Starting with Frodo nightly builds it is mandatory to set the HTTP header field '''Content-Type: application/json'''

===== GET =====
Third-party application can access Kodi's JSON-RPC API by sending JSON-RPC requests embedded in a HTTP GET parameter called ''request''. The JSON-RPC request must be URL encoded and sent to the following URL
<pre>http://<your-ip>:<your-port>/jsonrpc?request=<url-encoded-request></pre>

==== TCP ====
The ''TCP'' transport can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/Transmission_Control_Protocol TCP] protocol. Because this transport allows applications outside Kodi to control Kodi it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user. Once enabled, third-party applications can access Kodi's JSON-RPC API by opening a TCP [http://en.wikipedia.org/wiki/Internet_socket socket] on port 9090 (this port can be configured in the [[Advancedsettings.xml#<jsonrpc>|advanced settings]] file) and sending raw JSON-RPC requests over that socket. Please note that no delimiters are provided in between notifications and/or responses. As such, your client needs to be able to deal with this, eg. by counting and matching curly braces ({}).

==== WebSocket ====
The ''WebSocket'' transport has been added since Version 5 and can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/WebSocket Websocket] protocol. The supported versions are 8 (draft [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-10 hybi-10]) and 13 ([http://tools.ietf.org/html/rfc6455 RFC 6455]). Because this transport allows applications outside Kodi to control Kodi it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user. Once enabled, third-party applications can access Kodi's JSON-RPC API by sending a WebSocket protocol handshake to the following URI
<pre>ws://<your-ip>:<configured tcp port>/jsonrpc</pre>
It is important to send the handshake on the port of Kodi's TCP server (by default 9090, but this port can be configured in the [[Advancedsettings.xml#<jsonrpc>|advanced settings]] file). After having successfully finished the handshake third-party applications can send WebSocket protocl messages over that connection.

=== Functionalities ===
==== Response ====
The ''Response'' functionality is the only functionality that should be present in every transport available as it describes the functionality to respond to a JSON-RPC request with a valid JSON-RPC response (be it an error message or an actual response).

==== Notifications ====
The ''Notifications'' functionality includes both server-side (from the server to clients) and client-side (from clients to the server) notifications. A JSON-RPC notification is a valid JSON-RPC request with no ''id'' property. Following the JSON-RPC 2.0 specification any JSON-RPC request with no ''id'' must be considered as a notification and the receiver must not send a response upon a notification.

In the specific case of Kodi, server-side notifications are used to inform clients about certain events to relieve clients of the need to periodically poll for certain events. Furthermore there are two ways of client-side notifications. Using [[/#JSONRPC.NotifyAll|JSONRPC.NotifyAll]] it is possible to ask Kodi to relay the message in the JSON-RPC request to all other connected clients. The second way is to send JSON-RPC requests without an ''id'' property in case the client does not care about the response (e.g. the method [[/#Player.Stop|Player.Stop]] does not return any useful information to the client).

==== Direct file download ====
The ''Direct file download'' functionality is the ability to directly download files from Kodi by calling [[/#Files.Download|Files.Download]]. In this case the term ''direct'' means that the download happens within the JSON-RPC response of the [[/#Files.Download|Files.Download]] request.

==== Redirected file download ====
The ''Redirected file download'' functionality is the ability to indirectly download files from Kodi by calling [[/#Files.PrepareDownload|Files.PrepareDownload]] and using the data received in the response to download the file over a different protocol (like HTTP, FTP ...) or another socket. As the ''Redirected file download'' is very transport specific, it must be handled separately for every transport supporting it.

=== Comparison ===
The following table shows all the available transports and what functionalities they support
{| class="prettytable" style="margin-right: 0;"
!style="padding-left: 5px; padding-right: 10px;" colspan="2"|Transport
!style="padding-left: 10px; padding-right: 10px;"|Response
!style="padding-left: 10px; padding-right: 10px;"|Notifications
!style="padding-left: 10px; padding-right: 10px;"|Direct file<br />download
!style="padding-left: 10px; padding-right: 10px;"|Redirected file<br />download
|-
|style="padding-left: 5px;" colspan="2"|[[Python Development|Python]]
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;" colspan="2"|[http://en.wikipedia.org/wiki/Transmission_Control_Protocol TCP]
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right:5px;" rowspan="2"|[http://en.wikipedia.org/wiki/HTTP HTTP]
|style="padding-left: 5px; padding-right:5px;"|POST
|{{yes}}
|{{no}}
|{{no}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right:5px;"|GET<sup>1</sup>
|{{yes}}
|{{no}}
|{{no}}
|{{yes}}
|-
|style="padding-left: 5px;" colspan="2"|[http://en.wikipedia.org/wiki/WebSocket WebSocket]<sup>1</sup>
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|}
<sup>1</sup> Added in Version 5

== API versions ==
The JSON-RPC API exposed by Kodi is constantly extended to provide better and more functionality to third party applications. For that reason Kodi provides a version information through the '''JSONRPC.Version''' method. The rule is that odd version numbers describe an API state, that is not stable and under heavy development whereas even version numbers describe a stable API. Therefore the version number can be used by third-party clients to check if their application might not be fully compatible with the JSON-RPC API exposed by a user's Kodi installation.

Starting with XBMC v12 (Frodo) we started using a new versioning system (<major>.<minor>.<patch>) for the JSON-RPC API. Frodo stable is version 6.0.0 and from now on with every bugfix the <patch> part of the version is increased, with every feature addition to the API, the <minor> version is increased (and the <patch> version reset to 0) and with every backwards incompatible change, the <major> version is increased.

{| class="prettytable" style="margin-right: 0;"
!colspan="3"|Release
!colspan="6"|JSON-RPC 2.0 specification
!colspan="5"|Transports
|-
!style="padding-left: 5px; padding-right: 5px; width: 6em; text-align: left;"|API Version
!style="padding-left: 10px; padding-right: 10px; width: 5em;"|Version
!style="padding-left: 10px; padding-right: 10px; width: 4em;"|Name
!style="padding-left: 10px; padding-right: 10px;"|Method calls
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(server-side)
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(client-side)
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-name
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-position
!style="padding-left: 10px; padding-right: 10px;"|Batch requests

!style="padding-left: 10px; padding-right: 10px;"|Python
!style="padding-left: 10px; padding-right: 10px;"|TCP
!style="padding-left: 10px; padding-right: 10px;"|HTTP POST
!style="padding-left: 10px; padding-right: 10px;"|HTTP GET
!style="padding-left: 10px; padding-right: 10px;"|WebSocket
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v2|Version 2]]
|style="padding-left: 5px; padding-right: 5px;"|10.0
|style="padding-left: 5px; padding-right: 5px;"|Dharma
|{{yes}}
|{{yes}}
|{{no}}
|{{yes}}
|{{no}}
|{{no}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v3|Version 3]] / [[/v4|4]]
|style="padding-left: 5px; padding-right: 5px;"|pre-11 / 11.0
|style="padding-left: 5px; padding-right: 5px;"|Eden
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v5|Version 5]] / [[/v6|6]]
|style="padding-left: 5px; padding-right: 5px;"|pre-12 / 12.0
|style="padding-left: 5px; padding-right: 5px;"|Frodo
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.0
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.1
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.2
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.0
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.1
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.2
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.0
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.1
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.2
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|16.0
|style="padding-left: 5px; padding-right: 5px;"|Jarvis
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|16.1
|style="padding-left: 5px; padding-right: 5px;"|Jarvis
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v8|Version 8]]
|style="padding-left: 5px; padding-right: 5px;"|17.0
|style="padding-left: 5px; padding-right: 5px;"|Krypton
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-

|style="padding-left: 5px; padding-right: 5px;"|[[/v9|Version 9]]
|style="padding-left: 5px; padding-right: 5px;"|18.0
|style="padding-left: 5px; padding-right: 5px;"|Leia
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}<sup>1</sup>
|{{yes}}
|-
|}
<sup>1</sup>For information requests only, actions require POST

{| class="prettytable" style="margin-right: 0;"
!colspan="3"|Release
!|JSONRPC.Version
|-
!style="padding-left: 10px; padding-right: 10px;"|Date
!style="padding-left: 10px; padding-right: 10px;"|Version
!style="padding-left: 10px; padding-right: 10px;"|Codename
!style="padding-left: 10px; padding-right: 10px;"|["version"]
|-
|18 December 2010
|10.0
|Dharma
|2
|-
|10 March 2011
|10.1
|Dharma
|2
|-
| style="background:#eee;" |24 March 2012
| style="background:#eee;" |11.0
| style="background:#eee;" |Eden
| style="background:#eee;" |4
|-
|29 January 2013
|12.0
|Frodo
|{"major":6,"minor":0,"patch":0}
|-
|18 March 2013
|12.1
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
|03 May 2013
|12.2
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
|24 December 2013
|12.3
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
| style="background:#eee;" | 04 May 2014
| style="background:#eee;" | 13.0
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
| style="background:#eee;" | 05 June 2014
| style="background:#eee;" | 13.1
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
| style="background:#eee;" | 17 August 2014
| style="background:#eee;" | 13.2
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
|23 December 2014
|14.0
|Helix
|{"major":6,"minor":21,"patch":2}
|-
|30 January 2014
|14.1
|Helix
|{"major":6,"minor":21,"patch":2}
|-
|26 March 2014
|14.2
|Helix
|{"major":6,"minor":21,"patch":2}
|-
| style="background:#eee;" | 21 July 2015
| style="background:#eee;" | 15.0
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
| style="background:#eee;" | 16 August 2015
| style="background:#eee;" | 15.1
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
| style="background:#eee;" | 19 October 2015
| style="background:#eee;" | 15.2
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
|21 February 2016
|16.0
|Jarvis
|{"major":6,"minor":32,"patch":4}
|-
|24 April 2016
|16.1
|Jarvis
|{"major":6,"minor":32,"patch":5}
|-
| style="background:#eee;" | 5 February 2017
| style="background:#eee;" | 17.0
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 20 March 2017
| style="background:#eee;" | 17.1
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 23 May 2017
| style="background:#eee;" | 17.2
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 24 May 2017
| style="background:#eee;" | 17.3
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 22 August 2017
| style="background:#eee;" | 17.4
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 23 October 2017
| style="background:#eee;" | 17.5
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 14 November 2017
| style="background:#eee;" | 17.6
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
|}

== Documentation ==
Kodi's JSON-RPC API has been designed to be self-documented i.e. a call to [[/#JSONRPC.Introspect|JSONRPC.Introspect]] results in a JSON-RPC response containing a documentation for all the available methods and data types. While this documentation is very incomplete and partly wrong for [[/v2|version 2]] it is provided as a full [http://tools.ietf.org/html/draft-zyp-json-schema-03 JSON schema] starting with [[/v3|version 3]]. As the documentation retrieved in that way is always specific to the used version of Kodi, it is (especially for development versions) the best documentation available and should be preferred over the wiki documentation as the latter always documents the API of the latest development.

== Debugging ==
=== Output format ===
To be able to support easier debugging of (third-party) development using the JSON-RPC API, the JSON output generated by Kodi can be pretty-printed by setting
<syntaxhighlight lang="xml" enclose="div">
<jsonrpc>
<compactoutput>false</compactoutput>
</jsonrpc>
</syntaxhighlight>
in the [[Advancedsettings.xml#.3Cjsonrpc.3E|advancedsettings.xml]]. Default JSON output will be in compact format to minimize sent data (especially useful for mobile devices).

=== Direct interaction ===
To be able to test some methods of Kodi's JSON-RPC API, it can be of great help to be able to send a single hand-written JSON-RPC request to Kodi to see its effect and the generated response. Depending on the transport protocol used there are different possibilities to do that:

==== TCP ====
With a [http://en.wikipedia.org/wiki/Telnet telnet] connection (using [http://en.wikipedia.org/wiki/PuTTY PuTTY] on Windows or telnet on Linux) to port 9090 of the machine running Kodi it is possible to send and receive raw json data to/from Kodi. {{see also|SSH}}

==== HTTP ====
A simple way of manually sending HTTP requests containing a JSON-RPC request to Kodi is using the [http://chrome.google.com/extensions/detail/fhjcajmcbmldlhcimfajhfbgofnpcjmb Simple REST Client] extension for Google's Chrome/Chromium browser. It allows defining a URL and the HTTP request type ('''POST''' is what we need). The actual JSON-RPC request can be defined in the '''Data''' field and then sent to Kodi.

== See also ==
* [[/v2|JSON-RPC API v2 (Dharma)]]
* [[/v4|JSON-RPC API v4 (Eden)]]
* [[/v6|JSON-RPC API v6 (Frodo - Jarvis)]]
* [[/v8|JSON-RPC API v8 (Krypton)]]
* [[/v9|JSON-RPC API v9 (Leia)]]

== External links ==
* [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]
* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]

== Examples ==
These examples take their base from v4. Any that require a higher version will be marked.

[[JSON-RPC API/Examples]]

[[Category:Manual]]
[[Category:Development]]

JSON-RPC API

2019-01-04T09:55:25Z

Ncarthy: /* API versions */ Add note about use of GET in Leia

{{mininav|[[Development]]}}

{{JSON-RPC API nav}}
<br />

JSON-RPC is a HTTP- and/or raw TCP socket-based interface for communicating with Kodi. It replaces the deprecated [[HTTP API]], and offers a more secure and robust mechanism in the same format. It is based upon the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification].

Each method in the interface can have different security needs which means one client may be allowed to only control playback while another can only read and manipulate the library. In version 2 (first stable) and 4 all clients are granted full authority but will later be forced to ask for privileges and the user of Kodi will have to grant said client access. The design of JSON-RPC is that most methods should behave roughly the same and maintain consistency while hiding the mechanics of Kodi from the client creator.

In Kodi JSON-RPC can be accessed over a variety of transports and has been designed from the ground up to be flexible to allow control over new transports easily. Some of the transports have different limitations which will be enforced upon the interaction over that transport. As an example HTTP transports allow response and downloading of files while the raw TCP transport allows response and notifications (events and information Kodi sends to its clients). Depending on the client's needs it will choose one (or many) of the available transports.<br />

== Enabling JSON-RPC ==
Since the interface is available on many transports enabling it depends on the transport.
* Python: Always enabled
* HTTP: In System/Settings/Network/Services activate ''Allow control of Kodi via HTTP'' (see [[Webserver#Enabling the webserver|Enabling the webserver]])
* TCP: In System/Settings/Network/Services activate ''Allow programs on this system to control Kodi'' for localhost access only and ''Allow programs on other systems to control Kodi'' for access from other computers as well

Note: The [[EventServer]] is a different interface for sending remote keypresses to Kodi, and must be enabled separately, some programs may use both interfaces.

== Transports & Functionalities ==
=== Transports ===
==== Python ====
The ''Python'' transport can only be used by Kodi addons through the '''executeJSONRPC''' method provided by the '''xbmc''' python library. As it must be available to every addon in an Kodi installation it must not be enabled or disabled by the user.

==== HTTP ====
The ''HTTP'' transport can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol HTTP] protocol. Because this transport allows applications outside Kodi to control Kodi, it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user.

===== POST =====
Third-party applications can access Kodi's JSON-RPC API by sending JSON-RPC requests embedded in HTTP [http://en.wikipedia.org/wiki/POST_(HTTP) POST] requests to the following URL
<pre>http://<your-ip>:<your-port>/jsonrpc</pre>

Starting with Frodo nightly builds it is mandatory to set the HTTP header field '''Content-Type: application/json'''

===== GET =====
Third-party application can access Kodi's JSON-RPC API by sending JSON-RPC requests embedded in a HTTP GET parameter called ''request''. The JSON-RPC request must be URL encoded and sent to the following URL
<pre>http://<your-ip>:<your-port>/jsonrpc?request=<url-encoded-request></pre>

==== TCP ====
The ''TCP'' transport can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/Transmission_Control_Protocol TCP] protocol. Because this transport allows applications outside Kodi to control Kodi it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user. Once enabled, third-party applications can access Kodi's JSON-RPC API by opening a TCP [http://en.wikipedia.org/wiki/Internet_socket socket] on port 9090 (this port can be configured in the [[Advancedsettings.xml#<jsonrpc>|advanced settings]] file) and sending raw JSON-RPC requests over that socket. Please note that no delimiters are provided in between notifications and/or responses. As such, your client needs to be able to deal with this, eg. by counting and matching curly braces ({}).

==== WebSocket ====
The ''WebSocket'' transport has been added since Version 5 and can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/WebSocket Websocket] protocol. The supported versions are 8 (draft [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-10 hybi-10]) and 13 ([http://tools.ietf.org/html/rfc6455 RFC 6455]). Because this transport allows applications outside Kodi to control Kodi it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user. Once enabled, third-party applications can access Kodi's JSON-RPC API by sending a WebSocket protocol handshake to the following URI
<pre>ws://<your-ip>:<configured tcp port>/jsonrpc</pre>
It is important to send the handshake on the port of Kodi's TCP server (by default 9090, but this port can be configured in the [[Advancedsettings.xml#<jsonrpc>|advanced settings]] file). After having successfully finished the handshake third-party applications can send WebSocket protocl messages over that connection.

=== Functionalities ===
==== Response ====
The ''Response'' functionality is the only functionality that should be present in every transport available as it describes the functionality to respond to a JSON-RPC request with a valid JSON-RPC response (be it an error message or an actual response).

==== Notifications ====
The ''Notifications'' functionality includes both server-side (from the server to clients) and client-side (from clients to the server) notifications. A JSON-RPC notification is a valid JSON-RPC request with no ''id'' property. Following the JSON-RPC 2.0 specification any JSON-RPC request with no ''id'' must be considered as a notification and the receiver must not send a response upon a notification.

In the specific case of Kodi, server-side notifications are used to inform clients about certain events to relieve clients of the need to periodically poll for certain events. Furthermore there are two ways of client-side notifications. Using [[/#JSONRPC.NotifyAll|JSONRPC.NotifyAll]] it is possible to ask Kodi to relay the message in the JSON-RPC request to all other connected clients. The second way is to send JSON-RPC requests without an ''id'' property in case the client does not care about the response (e.g. the method [[/#Player.Stop|Player.Stop]] does not return any useful information to the client).

==== Direct file download ====
The ''Direct file download'' functionality is the ability to directly download files from Kodi by calling [[/#Files.Download|Files.Download]]. In this case the term ''direct'' means that the download happens within the JSON-RPC response of the [[/#Files.Download|Files.Download]] request.

==== Redirected file download ====
The ''Redirected file download'' functionality is the ability to indirectly download files from Kodi by calling [[/#Files.PrepareDownload|Files.PrepareDownload]] and using the data received in the response to download the file over a different protocol (like HTTP, FTP ...) or another socket. As the ''Redirected file download'' is very transport specific, it must be handled separately for every transport supporting it.

=== Comparison ===
The following table shows all the available transports and what functionalities they support
{| class="prettytable" style="margin-right: 0;"
!style="padding-left: 5px; padding-right: 10px;" colspan="2"|Transport
!style="padding-left: 10px; padding-right: 10px;"|Response
!style="padding-left: 10px; padding-right: 10px;"|Notifications
!style="padding-left: 10px; padding-right: 10px;"|Direct file<br />download
!style="padding-left: 10px; padding-right: 10px;"|Redirected file<br />download
|-
|style="padding-left: 5px;" colspan="2"|[[Python Development|Python]]
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;" colspan="2"|[http://en.wikipedia.org/wiki/Transmission_Control_Protocol TCP]
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right:5px;" rowspan="2"|[http://en.wikipedia.org/wiki/HTTP HTTP]
|style="padding-left: 5px; padding-right:5px;"|POST
|{{yes}}
|{{no}}
|{{no}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right:5px;"|GET<sup>1</sup>
|{{yes}}
|{{no}}
|{{no}}
|{{yes}}
|-
|style="padding-left: 5px;" colspan="2"|[http://en.wikipedia.org/wiki/WebSocket WebSocket]<sup>1</sup>
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|}
<sup>1</sup> Added in Version 5

== API versions ==
The JSON-RPC API exposed by Kodi is constantly extended to provide better and more functionality to third party applications. For that reason Kodi provides a version information through the '''JSONRPC.Version''' method. The rule is that odd version numbers describe an API state, that is not stable and under heavy development whereas even version numbers describe a stable API. Therefore the version number can be used by third-party clients to check if their application might not be fully compatible with the JSON-RPC API exposed by a user's Kodi installation.

Starting with XBMC v12 (Frodo) we started using a new versioning system (<major>.<minor>.<patch>) for the JSON-RPC API. Frodo stable is version 6.0.0 and from now on with every bugfix the <patch> part of the version is increased, with every feature addition to the API, the <minor> version is increased (and the <patch> version reset to 0) and with every backwards incompatible change, the <major> version is increased.

{| class="prettytable" style="margin-right: 0;"
!colspan="3"|Release
!colspan="6"|JSON-RPC 2.0 specification
!colspan="5"|Transports
|-
!style="padding-left: 5px; padding-right: 5px; width: 6em; text-align: left;"|API Version
!style="padding-left: 10px; padding-right: 10px; width: 5em;"|Version
!style="padding-left: 10px; padding-right: 10px; width: 4em;"|Name
!style="padding-left: 10px; padding-right: 10px;"|Method calls
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(server-side)
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(client-side)
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-name
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-position
!style="padding-left: 10px; padding-right: 10px;"|Batch requests

!style="padding-left: 10px; padding-right: 10px;"|Python
!style="padding-left: 10px; padding-right: 10px;"|TCP
!style="padding-left: 10px; padding-right: 10px;"|HTTP POST
!style="padding-left: 10px; padding-right: 10px;"|HTTP GET
!style="padding-left: 10px; padding-right: 10px;"|WebSocket
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v2|Version 2]]
|style="padding-left: 5px; padding-right: 5px;"|10.0
|style="padding-left: 5px; padding-right: 5px;"|Dharma
|{{yes}}
|{{yes}}
|{{no}}
|{{yes}}
|{{no}}
|{{no}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v3|Version 3]] / [[/v4|4]]
|style="padding-left: 5px; padding-right: 5px;"|pre-11 / 11.0
|style="padding-left: 5px; padding-right: 5px;"|Eden
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v5|Version 5]] / [[/v6|6]]
|style="padding-left: 5px; padding-right: 5px;"|pre-12 / 12.0
|style="padding-left: 5px; padding-right: 5px;"|Frodo
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.0
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.1
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.2
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.0
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.1
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.2
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.0
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.1
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.2
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|16.0
|style="padding-left: 5px; padding-right: 5px;"|Jarvis
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|16.1
|style="padding-left: 5px; padding-right: 5px;"|Jarvis
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v8|Version 8]]
|style="padding-left: 5px; padding-right: 5px;"|17.0
|style="padding-left: 5px; padding-right: 5px;"|Krypton
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-

|style="padding-left: 5px; padding-right: 5px;"|[[/v9|Version 9]]
|style="padding-left: 5px; padding-right: 5px;"|18.0
|style="padding-left: 5px; padding-right: 5px;"|Leia
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}<sup>1</sup>
|{{yes}}
|-
|}
<sup>For information requests only, actions require POST</sup>

{| class="prettytable" style="margin-right: 0;"
!colspan="3"|Release
!|JSONRPC.Version
|-
!style="padding-left: 10px; padding-right: 10px;"|Date
!style="padding-left: 10px; padding-right: 10px;"|Version
!style="padding-left: 10px; padding-right: 10px;"|Codename
!style="padding-left: 10px; padding-right: 10px;"|["version"]
|-
|18 December 2010
|10.0
|Dharma
|2
|-
|10 March 2011
|10.1
|Dharma
|2
|-
| style="background:#eee;" |24 March 2012
| style="background:#eee;" |11.0
| style="background:#eee;" |Eden
| style="background:#eee;" |4
|-
|29 January 2013
|12.0
|Frodo
|{"major":6,"minor":0,"patch":0}
|-
|18 March 2013
|12.1
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
|03 May 2013
|12.2
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
|24 December 2013
|12.3
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
| style="background:#eee;" | 04 May 2014
| style="background:#eee;" | 13.0
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
| style="background:#eee;" | 05 June 2014
| style="background:#eee;" | 13.1
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
| style="background:#eee;" | 17 August 2014
| style="background:#eee;" | 13.2
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
|23 December 2014
|14.0
|Helix
|{"major":6,"minor":21,"patch":2}
|-
|30 January 2014
|14.1
|Helix
|{"major":6,"minor":21,"patch":2}
|-
|26 March 2014
|14.2
|Helix
|{"major":6,"minor":21,"patch":2}
|-
| style="background:#eee;" | 21 July 2015
| style="background:#eee;" | 15.0
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
| style="background:#eee;" | 16 August 2015
| style="background:#eee;" | 15.1
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
| style="background:#eee;" | 19 October 2015
| style="background:#eee;" | 15.2
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
|21 February 2016
|16.0
|Jarvis
|{"major":6,"minor":32,"patch":4}
|-
|24 April 2016
|16.1
|Jarvis
|{"major":6,"minor":32,"patch":5}
|-
| style="background:#eee;" | 5 February 2017
| style="background:#eee;" | 17.0
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 20 March 2017
| style="background:#eee;" | 17.1
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 23 May 2017
| style="background:#eee;" | 17.2
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 24 May 2017
| style="background:#eee;" | 17.3
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 22 August 2017
| style="background:#eee;" | 17.4
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 23 October 2017
| style="background:#eee;" | 17.5
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 14 November 2017
| style="background:#eee;" | 17.6
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
|}

== Documentation ==
Kodi's JSON-RPC API has been designed to be self-documented i.e. a call to [[/#JSONRPC.Introspect|JSONRPC.Introspect]] results in a JSON-RPC response containing a documentation for all the available methods and data types. While this documentation is very incomplete and partly wrong for [[/v2|version 2]] it is provided as a full [http://tools.ietf.org/html/draft-zyp-json-schema-03 JSON schema] starting with [[/v3|version 3]]. As the documentation retrieved in that way is always specific to the used version of Kodi, it is (especially for development versions) the best documentation available and should be preferred over the wiki documentation as the latter always documents the API of the latest development.

== Debugging ==
=== Output format ===
To be able to support easier debugging of (third-party) development using the JSON-RPC API, the JSON output generated by Kodi can be pretty-printed by setting
<syntaxhighlight lang="xml" enclose="div">
<jsonrpc>
<compactoutput>false</compactoutput>
</jsonrpc>
</syntaxhighlight>
in the [[Advancedsettings.xml#.3Cjsonrpc.3E|advancedsettings.xml]]. Default JSON output will be in compact format to minimize sent data (especially useful for mobile devices).

=== Direct interaction ===
To be able to test some methods of Kodi's JSON-RPC API, it can be of great help to be able to send a single hand-written JSON-RPC request to Kodi to see its effect and the generated response. Depending on the transport protocol used there are different possibilities to do that:

==== TCP ====
With a [http://en.wikipedia.org/wiki/Telnet telnet] connection (using [http://en.wikipedia.org/wiki/PuTTY PuTTY] on Windows or telnet on Linux) to port 9090 of the machine running Kodi it is possible to send and receive raw json data to/from Kodi. {{see also|SSH}}

==== HTTP ====
A simple way of manually sending HTTP requests containing a JSON-RPC request to Kodi is using the [http://chrome.google.com/extensions/detail/fhjcajmcbmldlhcimfajhfbgofnpcjmb Simple REST Client] extension for Google's Chrome/Chromium browser. It allows defining a URL and the HTTP request type ('''POST''' is what we need). The actual JSON-RPC request can be defined in the '''Data''' field and then sent to Kodi.

== See also ==
* [[/v2|JSON-RPC API v2 (Dharma)]]
* [[/v4|JSON-RPC API v4 (Eden)]]
* [[/v6|JSON-RPC API v6 (Frodo - Jarvis)]]
* [[/v8|JSON-RPC API v8 (Krypton)]]
* [[/v9|JSON-RPC API v9 (Leia)]]

== External links ==
* [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]
* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]

== Examples ==
These examples take their base from v4. Any that require a higher version will be marked.

[[JSON-RPC API/Examples]]

[[Category:Manual]]
[[Category:Development]]

Archive:JSON-RPC API/v6

2017-02-20T19:40:32Z

Ncarthy: /* See also */ Add link to v8

{{mininav|[[Development]]|[[JSON-RPC API]]}}

Version 6 is a stable version of Kodi's JSON-RPC API and is published with the release of v12 (Frodo). It continues to be used for v13, v14, v15 and v16 (Jarvis). It comes with support for [http://en.wikipedia.org/wiki/WebSocket 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.

Some of the methods have been changed or removed, so v6 is not 100% backwards compatible with older versions. A rough and incomplete list of changes compared to version 4 can be found [[Frodo API Changes|here]]. A more complete and detailed list can be found in the [http://forum.kodi.tv/showthread.php?t=98551 forum].

{{TOC right}}
== JSON-RPC 2.0 compatibility ==
{| class="prettytable" style="margin-right: 0;"
!style="padding-left: 5px; width: 7em; text-align: left;"|Version
!style="padding-left: 10px; padding-right: 10px;"|Method calls
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(server-side)
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(client-side)
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-name
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-position
!style="padding-left: 10px; padding-right: 10px;"|Batch requests
|-
|style="padding-left: 5px;"|Version 6
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|}

== Documentation (JSON Schema) ==
=== Supported features of JSON Schema ===
<div style="float:left; margin-right:2em">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema
!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 type]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.2 properties]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.3 patternProperties]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.4 additionalProperties]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.5 items]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.6 additionalItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.7 required]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.8 dependencies]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.9 minimum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.10 maximum]
|{{yes}}
|-
|}
</div>

<div style="float:left; margin-right:2em">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema

!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03

|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.11 exclusiveMinimum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.12 exclusiveMaximum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.13 minItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.14 maxItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.15 uniqueItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.16 pattern]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.17 minLength]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.18 maxLength]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.19 enum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.20 default]
|{{yes}}
|-
|}
</div>

<div style="float:left;">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema

!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.21 title]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.22 description]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 format]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.24 divisibleBy]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.25 disallow]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.26 extends]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.27 id]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.28 $ref]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.29 $schema]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-6 Hyper Schema]
|{{no}}
|-
|}
</div>
<div style="clear:left;"></div>

== 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
{|
|
<syntaxhighlight lang="javascript" enclose="div">
{
"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" }
}
}
}
}
}
}
</syntaxhighlight>
|}

== Namespaces ==
The Kodi JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:
{|
|
<pre>
Addons List, enable and execute addons
Application Application information and control
AudioLibrary Audio Library information
Favourites Favourites GetFavourites and AddFavourite
Files Shares information & filesystem listings
GUI Window properties and activation
Input Allows limited navigation within Kodi
JSONRPC A variety of standard JSONRPC calls
Player Manages all available players
Playlist Playlist modification
Profiles Support for Profiles operations to xbmc.
PVR Live TV control
Settings Allows manipulation of Kodi settings.
System System controls and information
Textures with GetTextures and RemoveTexture
VideoLibrary Video Library information
XBMC Dumping ground for very Kodi specific operations
</pre>
|}

== Methods ==
=== Addons ===
==== Addons.ExecuteAddon ====
Executes the given addon with the given parameters (if possible)<br />
'''Permissions:'''
* ExecuteAddon
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid
# [ ''mixed'' params = null ]
# [ ''boolean'' wait = False ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "addonid",
"required": true,
"type": "string"
},
{
"name": "params",
"type": [
{
"additionalProperties": {
"type": "string",
"default": ""
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": null
},
{
"name": "wait",
"type": "boolean",
"default": false
}
],
"description": "Executes the given addon with the given parameters (if possible)",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Addons.GetAddonDetails ====
Gets the details of a specific addon<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid
# [ ''[[#Addon.Fields|Addon.Fields]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#Addon.Details|Addon.Details]]'' addon

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "addonid",
"required": true,
"type": "string"
},
{
"$ref": "Addon.Fields",
"name": "properties"
}
],
"description": "Gets the details of a specific addon",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"addon": {
"$ref": "Addon.Details",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Addons.GetAddons ====
Gets all available addons<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Addon.Types|Addon.Types]]'' type = "unknown" ]
# [ ''[[#Addon.Content|Addon.Content]]'' content = "unknown" ]
# [ ''mixed'' enabled = "all" ]
# [ ''[[#Addon.Fields|Addon.Fields]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Addon.Details|Addon.Details]]''[] addons ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Addon.Types",
"name": "type",
"default": "unknown"
},
{
"$ref": "Addon.Content",
"description": "Content provided by the addon. Only considered for plugins and scripts.",
"name": "content",
"default": "unknown"
},
{
"name": "enabled",
"type": [
{
"type": "boolean"
},
{
"enums": [
"all"
],
"type": "string"
}
],
"default": "all"
},
{
"$ref": "Addon.Fields",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"description": "Gets all available addons",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"addons": {
"items": {
"$ref": "Addon.Details"
},
"type": "array"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Addons.SetAddonEnabled ====
Enables/Disables a specific addon<br />
'''Permissions:'''
* ManageAddon
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid
# ''[[#Global.Toggle|Global.Toggle]]'' enabled
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "addonid",
"required": true,
"type": "string"
},
{
"$ref": "Global.Toggle",
"name": "enabled",
"required": true
}
],
"description": "Enables/Disables a specific addon",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Application ===
==== Application.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Application.Property.Name|Application.Property.Name]]''[] properties
</div>
'''Returns:''' ''[[#Application.Property.Value|Application.Property.Value]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"uniqueItems": true,
"items": {
"$ref": "Application.Property.Name"
},
"name": "properties",
"type": "array",
"required": true
}
],
"description": "Retrieves the values of the given properties",
"returns": {
"$ref": "Application.Property.Value"
}
}</syntaxhighlight>}}

==== Application.Quit ====
Quit application<br />
'''Permissions:'''
* ControlPower
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Quit application",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Application.SetMute ====
Toggle mute/unmute<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Global.Toggle|Global.Toggle]]'' mute
</div>
'''Returns:''' ''boolean''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Global.Toggle",
"name": "mute",
"required": true
}
],
"description": "Toggle mute/unmute",
"returns": {
"description": "Mute state",
"type": "boolean"
}
}</syntaxhighlight>}}

==== Application.SetVolume ====
Set the current volume<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed'' volume
</div>
'''Returns:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "volume",
"required": true,
"type": [
{
"minimum": 0,
"type": "integer",
"maximum": 100
},
{
"$ref": "Global.IncrementDecrement"
}
]
}
],
"description": "Set the current volume",
"returns": {
"type": "integer"
}
}</syntaxhighlight>}}

=== AudioLibrary ===
==== AudioLibrary.Clean ====
Cleans the audio library from non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Cleans the audio library from non-existent items",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.Export ====
Exports all items from the audio library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed'' options ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "options",
"type": [
{
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the directory to where the data should be exported",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"overwrite": {
"description": "Whether to overwrite existing exported files",
"type": "boolean",
"default": false
},
"images": {
"description": "Whether to export thumbnails and fanart images",
"type": "boolean",
"default": false
}
},
"type": "object"
}
]
}
],
"description": "Exports all items from the audio library",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetAlbumDetails ====
Retrieve details about a specific album<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' albumid
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]'' albumdetails ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
{
"$ref": "Audio.Fields.Album",
"name": "properties"
}
],
"description": "Retrieve details about a specific album",
"returns": {
"properties": {
"albumdetails": {
"$ref": "Audio.Details.Album"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetAlbums ====
Retrieve all albums from specified artist or genre<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Albums"
}
]
}
],
"description": "Retrieve all albums from specified artist or genre",
"returns": {
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetArtistDetails ====
Retrieve details about a specific artist<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' artistid
# [ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Artist|Audio.Details.Artist]]'' artistdetails ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
{
"$ref": "Audio.Fields.Artist",
"name": "properties"
}
],
"description": "Retrieve details about a specific artist",
"returns": {
"properties": {
"artistdetails": {
"$ref": "Audio.Details.Artist"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetArtists ====
Retrieve all artists<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Optional.Boolean|Optional.Boolean]]'' albumartistsonly = null ]
# [ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Audio.Details.Artist|Audio.Details.Artist]]''[] artists ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Optional.Boolean",
"description": "Whether or not to include artists only appearing in compilations. If the parameter is not passed or is passed as null the GUI setting will be used",
"name": "albumartistsonly",
"default": null
},
{
"$ref": "Audio.Fields.Artist",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"album": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"$ref": "List.Filter.Artists"
}
]
}
],
"description": "Retrieve all artists",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"artists": {
"items": {
"$ref": "Audio.Details.Artist"
},
"type": "array"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetGenres ====
Retrieve all genres<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Library.Details.Genre|Library.Details.Genre]]''[] genres
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Fields.Genre",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"description": "Retrieve all genres",
"returns": {
"properties": {
"genres": {
"items": {
"$ref": "Library.Details.Genre"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRecentlyAddedAlbums ====
Retrieve recently added albums<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"description": "Retrieve recently added albums",
"returns": {
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRecentlyAddedSongs ====
Retrieve recently added songs<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#List.Amount|List.Amount]]'' albumlimit = -1 ]
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "List.Amount",
"description": "The amount of recently added albums from which to return the songs",
"name": "albumlimit",
"default": -1
},
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"description": "Retrieve recently added songs",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRecentlyPlayedAlbums ====
Retrieve recently played albums<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"description": "Retrieve recently played albums",
"returns": {
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRecentlyPlayedSongs ====
Retrieve recently played songs<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"description": "Retrieve recently played songs",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetSongDetails ====
Retrieve details about a specific song<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' songid
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]'' songdetails ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "songid",
"required": true
},
{
"$ref": "Audio.Fields.Song",
"name": "properties"
}
],
"description": "Retrieve details about a specific song",
"returns": {
"properties": {
"songdetails": {
"$ref": "Audio.Details.Song"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetSongs ====
Retrieve all songs from specified album, artist or genre<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"album": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Songs"
}
]
}
],
"description": "Retrieve all songs from specified album, artist or genre",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== AudioLibrary.Scan ====
Scans the audio sources for new library items<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''string'' directory = "" ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "directory",
"type": "string",
"default": ""
}
],
"description": "Scans the audio sources for new library items",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.SetAlbumDetails ====
Update the given album with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' albumid
# [ ''[[#Optional.String|Optional.String]]'' title = null ]
# [ ''mixed'' artist = null ]
# [ ''[[#Optional.String|Optional.String]]'' description = null ]
# [ ''mixed'' genre = null ]
# [ ''mixed'' theme = null ]
# [ ''mixed'' mood = null ]
# [ ''mixed'' style = null ]
# [ ''[[#Optional.String|Optional.String]]'' type = null ]
# [ ''[[#Optional.String|Optional.String]]'' albumlabel = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' rating = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year = null ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title",
"default": null
},
{
"name": "artist",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"$ref": "Optional.String",
"name": "description",
"default": null
},
{
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"name": "theme",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"name": "mood",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"name": "style",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"$ref": "Optional.String",
"name": "type",
"default": null
},
{
"$ref": "Optional.String",
"name": "albumlabel",
"default": null
},
{
"$ref": "Optional.Integer",
"name": "rating",
"default": null
},
{
"$ref": "Optional.Integer",
"name": "year",
"default": null
}
],
"description": "Update the given album with the given details",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.SetArtistDetails ====
Update the given artist with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' artistid
# [ ''[[#Optional.String|Optional.String]]'' artist = null ]
# [ ''mixed'' instrument = null ]
# [ ''mixed'' style = null ]
# [ ''mixed'' mood = null ]
# [ ''[[#Optional.String|Optional.String]]'' born = null ]
# [ ''[[#Optional.String|Optional.String]]'' formed = null ]
# [ ''[[#Optional.String|Optional.String]]'' description = null ]
# [ ''mixed'' genre = null ]
# [ ''[[#Optional.String|Optional.String]]'' died = null ]
# [ ''[[#Optional.String|Optional.String]]'' disbanded = null ]
# [ ''mixed'' yearsactive = null ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
{
"$ref": "Optional.String",
"name": "artist",
"default": null
},
{
"name": "instrument",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"name": "style",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"name": "mood",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"$ref": "Optional.String",
"name": "born",
"default": null
},
{
"$ref": "Optional.String",
"name": "formed",
"default": null
},
{
"$ref": "Optional.String",
"name": "description",
"default": null
},
{
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"$ref": "Optional.String",
"name": "died",
"default": null
},
{
"$ref": "Optional.String",
"name": "disbanded",
"default": null
},
{
"name": "yearsactive",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
}
],
"description": "Update the given artist with the given details",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.SetSongDetails ====
Update the given song with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' songid
# [ ''[[#Optional.String|Optional.String]]'' title = null ]
# [ ''mixed'' artist = null ]
# [ ''mixed'' albumartist = null ]
# [ ''mixed'' genre = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' rating = null ]
# [ ''[[#Optional.String|Optional.String]]'' album = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' track = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' disc = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' duration = null ]
# [ ''[[#Optional.String|Optional.String]]'' comment = null ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainztrackid = null ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainzartistid = null ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainzalbumid = null ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainzalbumartistid = null ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "songid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title",
"default": null
},
{
"name": "artist",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"name": "albumartist",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"$ref": "Optional.Integer",
"name": "year",
"default": null
},
{
"$ref": "Optional.Integer",
"name": "rating",
"default": null
},
{
"$ref": "Optional.String",
"name": "album",
"default": null
},
{
"$ref": "Optional.Integer",
"name": "track",
"default": null
},
{
"$ref": "Optional.Integer",
"name": "disc",
"default": null
},
{
"$ref": "Optional.Integer",
"name": "duration",
"default": null
},
{
"$ref": "Optional.String",
"name": "comment",
"default": null
},
{
"$ref": "Optional.String",
"name": "musicbrainztrackid",
"default": null
},
{
"$ref": "Optional.String",
"name": "musicbrainzartistid",
"default": null
},
{
"$ref": "Optional.String",
"name": "musicbrainzalbumid",
"default": null
},
{
"$ref": "Optional.String",
"name": "musicbrainzalbumartistid",
"default": null
}
],
"description": "Update the given song with the given details",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Files ===
==== Files.Download ====
Downloads the given file<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' path
</div>
'''Returns:''' ''any''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "path",
"required": true,
"type": "string"
}
],
"description": "Downloads the given file",
"returns": {
"type": "any"
}
}</syntaxhighlight>}}

==== Files.GetDirectory ====
Get the directories and files in the given directory<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' directory
# [ ''[[#Files.Media|Files.Media]]'' media = "files" ]
# [ ''[[#List.Fields.Files|List.Fields.Files]]'' properties ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.Item.File|List.Item.File]]''[] files

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "directory",
"required": true,
"type": "string"
},
{
"$ref": "Files.Media",
"name": "media",
"default": "files"
},
{
"$ref": "List.Fields.Files",
"name": "properties"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"description": "Get the directories and files in the given directory",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"files": {
"items": {
"$ref": "List.Item.File"
},
"required": true,
"type": "array"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Files.GetFileDetails ====
Get details for a specific file<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file
# [ ''[[#Files.Media|Files.Media]]'' media = "files" ]
# [ ''[[#List.Fields.Files|List.Fields.Files]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.Item.File|List.Item.File]]'' filedetails

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"description": "Full path to the file",
"name": "file",
"type": "string",
"required": true
},
{
"$ref": "Files.Media",
"name": "media",
"default": "files"
},
{
"$ref": "List.Fields.Files",
"name": "properties"
}
],
"description": "Get details for a specific file",
"returns": {
"properties": {
"filedetails": {
"$ref": "List.Item.File",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Files.GetSources ====
Get the sources of the media windows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Files.Media|Files.Media]]'' media
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.Items.Sources|List.Items.Sources]]'' sources

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Files.Media",
"name": "media",
"required": true
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"description": "Get the sources of the media windows",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sources": {
"$ref": "List.Items.Sources",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Files.PrepareDownload ====
Provides a way to download a given file (e.g. providing an URL to the real file location)<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' path
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''string'' mode
* ''string'' protocol
* ''any'' details

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "path",
"required": true,
"type": "string"
}
],
"description": "Provides a way to download a given file (e.g. providing an URL to the real file location)",
"returns": {
"properties": {
"mode": {
"enums": [
"redirect",
"direct"
],
"description": "Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol",
"required": true,
"type": "string"
},
"protocol": {
"enums": [
"http"
],
"required": true,
"type": "string"
},
"details": {
"description": "Transport specific details on how/from where to download the given file",
"required": true,
"type": "any"
}
},
"type": "object"
}
}</syntaxhighlight>}}

=== GUI ===
==== GUI.ActivateWindow ====
Activates the given window<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#GUI.Window|GUI.Window]]'' window
# [ ''array''[1..X] parameters ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "GUI.Window",
"name": "window",
"required": true
},
{
"minItems": 1,
"items": {
"minLength": 1,
"type": "string"
},
"name": "parameters",
"type": "array"
}
],
"description": "Activates the given window",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== GUI.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#GUI.Property.Name|GUI.Property.Name]]''[] properties
</div>
'''Returns:''' ''[[#GUI.Property.Value|GUI.Property.Value]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"uniqueItems": true,
"items": {
"$ref": "GUI.Property.Name"
},
"name": "properties",
"type": "array",
"required": true
}
],
"description": "Retrieves the values of the given properties",
"returns": {
"$ref": "GUI.Property.Value"
}
}</syntaxhighlight>}}

==== GUI.SetFullscreen ====
Toggle fullscreen/GUI<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Global.Toggle|Global.Toggle]]'' fullscreen
</div>
'''Returns:''' ''boolean''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Global.Toggle",
"name": "fullscreen",
"required": true
}
],
"description": "Toggle fullscreen/GUI",
"returns": {
"description": "Fullscreen state",
"type": "boolean"
}
}</syntaxhighlight>}}

==== GUI.ShowNotification ====
Shows a GUI notification<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' title
# ''string'' message
# [ ''mixed'' image = "" ]
# [ ''integer'' displaytime = 5000 ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "title",
"required": true,
"type": "string"
},
{
"name": "message",
"required": true,
"type": "string"
},
{
"name": "image",
"type": [
{
"enums": [
"info",
"warning",
"error"
],
"type": "string"
},
{
"type": "string"
}
],
"default": ""
},
{
"minimum": 1500,
"description": "The time in milliseconds the notification will be visible",
"name": "displaytime",
"default": 5000,
"type": "integer"
}
],
"description": "Shows a GUI notification",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Input ===
==== Input.Back ====
Goes back in GUI<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Goes back in GUI",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ContextMenu ====
Shows the context menu<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Shows the context menu",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Down ====
Navigate down in GUI<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Navigate down in GUI",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ExecuteAction ====
Execute a specific action<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Input.Action|Input.Action]]'' action
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Input.Action",
"name": "action",
"required": true
}
],
"description": "Execute a specific action",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Home ====
Goes to home window in GUI<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Goes to home window in GUI",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Info ====
Shows the information dialog<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Shows the information dialog",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Left ====
Navigate left in GUI<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Navigate left in GUI",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Right ====
Navigate right in GUI<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Navigate right in GUI",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Select ====
Select current item in GUI<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Select current item in GUI",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.SendText ====
Send a generic (unicode) text<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' text
# [ ''boolean'' done = True ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"description": "Unicode text",
"name": "text",
"type": "string",
"required": true
},
{
"description": "Whether this is the whole input or not (closes an open input dialog if true).",
"name": "done",
"default": true,
"type": "boolean"
}
],
"description": "Send a generic (unicode) text",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ShowCodec ====
Show codec information of the playing item<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Show codec information of the playing item",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ShowOSD ====
Show the on-screen display for the current player<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Show the on-screen display for the current player",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Up ====
Navigate up in GUI<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Navigate up in GUI",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== JSONRPC ===
==== JSONRPC.GetConfiguration ====
Get client-specific configurations<br />
'''Permissions:'''
* ReadData
'''Parameters:''' None
<br />
'''Returns:''' ''[[#Configuration|Configuration]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Get client-specific configurations",
"returns": {
"$ref": "Configuration"
}
}</syntaxhighlight>}}

==== JSONRPC.Introspect ====
Enumerates all actions and descriptions<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''boolean'' getdescriptions = True ]
# [ ''boolean'' getmetadata = False ]
# [ ''boolean'' filterbytransport = True ]
# [ ''object'' filter ]<br />
'''Properties:'''
* [ ''boolean'' getreferences = True ]
* ''string'' id
* ''string'' type

</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "getdescriptions",
"type": "boolean",
"default": true
},
{
"name": "getmetadata",
"type": "boolean",
"default": false
},
{
"name": "filterbytransport",
"type": "boolean",
"default": true
},
{
"name": "filter",
"properties": {
"getreferences": {
"description": "Whether or not to print the schema for referenced types",
"type": "boolean",
"default": true
},
"id": {
"description": "Name of a namespace, method or type",
"required": true,
"type": "string"
},
"type": {
"enums": [
"method",
"namespace",
"type",
"notification"
],
"description": "Type of the given name",
"required": true,
"type": "string"
}
},
"type": "object"
}
],
"description": "Enumerates all actions and descriptions",
"returns": {
"additionalProperties": false,
"type": "object"
}
}</syntaxhighlight>}}

==== JSONRPC.NotifyAll ====
Notify all other connected clients<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' message
# [ ''any'' data = null ]
</div>
'''Returns:''' ''any''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "message",
"required": true,
"type": "string"
},
{
"name": "data",
"type": "any",
"default": null
}
],
"description": "Notify all other connected clients",
"returns": {
"type": "any"
}
}</syntaxhighlight>}}

==== JSONRPC.Permission ====
Retrieve the clients permissions<br />
'''Permissions:'''
* ReadData
'''Parameters:''' None
<br />
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''boolean'' readdata
* ''boolean'' writefile
* ''boolean'' controlpvr
* ''boolean'' controlsystem
* ''boolean'' removedata
* ''boolean'' controlplayback
* ''boolean'' navigate
* ''boolean'' controlpower
* ''boolean'' executeaddon
* ''boolean'' manageaddon
* ''boolean'' controlgui
* ''boolean'' controlnotify
* ''boolean'' updatedata

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Retrieve the clients permissions",
"returns": {
"properties": {
"readdata": {
"required": true,
"type": "boolean"
},
"writefile": {
"required": true,
"type": "boolean"
},
"controlpvr": {
"required": true,
"type": "boolean"
},
"controlsystem": {
"required": true,
"type": "boolean"
},
"removedata": {
"required": true,
"type": "boolean"
},
"controlplayback": {
"required": true,
"type": "boolean"
},
"navigate": {
"required": true,
"type": "boolean"
},
"controlpower": {
"required": true,
"type": "boolean"
},
"executeaddon": {
"required": true,
"type": "boolean"
},
"manageaddon": {
"required": true,
"type": "boolean"
},
"controlgui": {
"required": true,
"type": "boolean"
},
"controlnotify": {
"required": true,
"type": "boolean"
},
"updatedata": {
"required": true,
"type": "boolean"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== JSONRPC.Ping ====
Ping responder<br />
'''Permissions:'''
* ReadData
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Ping responder",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== JSONRPC.SetConfiguration ====
Change the client-specific configuration<br />
'''Permissions:'''
* ControlNotify
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''object'' notifications ]<br />
'''Properties:'''
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' gui = null ]
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' other = null ]
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' input = null ]
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' videolibrary = null ]
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' audiolibrary = null ]
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' playlist = null ]
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' system = null ]
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' player = null ]
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' application = null ]

</div>
'''Returns:''' ''[[#Configuration|Configuration]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "notifications",
"properties": {
"gui": {
"$ref": "Optional.Boolean",
"default": null
},
"other": {
"$ref": "Optional.Boolean",
"default": null
},
"input": {
"$ref": "Optional.Boolean",
"default": null
},
"videolibrary": {
"$ref": "Optional.Boolean",
"default": null
},
"audiolibrary": {
"$ref": "Optional.Boolean",
"default": null
},
"playlist": {
"$ref": "Optional.Boolean",
"default": null
},
"system": {
"$ref": "Optional.Boolean",
"default": null
},
"player": {
"$ref": "Optional.Boolean",
"default": null
},
"application": {
"$ref": "Optional.Boolean",
"default": null
}
},
"type": "object"
}
],
"description": "Change the client-specific configuration",
"returns": {
"$ref": "Configuration"
}
}</syntaxhighlight>}}

==== JSONRPC.Version ====
Retrieve the JSON-RPC protocol version.<br />
'''Permissions:'''
* ReadData
'''Parameters:''' None
<br />
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''integer'' minor
* ''integer'' patch
* ''integer'' major

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Retrieve the JSON-RPC protocol version.",
"returns": {
"properties": {
"minor": {
"minimum": 0,
"description": "Bumped on backwards compatible additions/changes to the API definition",
"required": true,
"type": "integer"
},
"patch": {
"minimum": 0,
"description": "Bumped on any changes to the internal implementation but not to the API definition",
"required": true,
"type": "integer"
},
"major": {
"minimum": 0,
"description": "Bumped on backwards incompatible changes to the API definition",
"required": true,
"type": "integer"
}
},
"type": "object"
}
}</syntaxhighlight>}}

=== PVR ===
==== PVR.GetChannelDetails ====
Retrieves the details of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid
# [ ''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.Channel|PVR.Details.Channel]]'' channeldetails ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
{
"$ref": "PVR.Fields.Channel",
"name": "properties"
}
],
"description": "Retrieves the details of a specific channel",
"returns": {
"properties": {
"channeldetails": {
"$ref": "PVR.Details.Channel"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== PVR.GetChannelGroupDetails ====
Retrieves the details of a specific channel group<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.ChannelGroup.Id|PVR.ChannelGroup.Id]]'' channelgroupid
# [ ''object'' channels ]<br />
'''Properties:'''
* [ ''[[#List.Limits|List.Limits]]'' limits ]
* [ ''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties ]

</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.ChannelGroup.Extended|PVR.Details.ChannelGroup.Extended]]'' channelgroupdetails ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "PVR.ChannelGroup.Id",
"name": "channelgroupid",
"required": true
},
{
"name": "channels",
"properties": {
"limits": {
"$ref": "List.Limits"
},
"properties": {
"$ref": "PVR.Fields.Channel"
}
},
"type": "object"
}
],
"description": "Retrieves the details of a specific channel group",
"returns": {
"properties": {
"channelgroupdetails": {
"$ref": "PVR.Details.ChannelGroup.Extended"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== PVR.GetChannelGroups ====
Retrieves the channel groups for the specified type<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]''[] channelgroups

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "PVR.Channel.Type",
"name": "channeltype",
"required": true
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"description": "Retrieves the channel groups for the specified type",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"channelgroups": {
"items": {
"$ref": "PVR.Details.ChannelGroup"
},
"required": true,
"type": "array"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== PVR.GetChannels ====
Retrieves the channel list<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.ChannelGroup.Id|PVR.ChannelGroup.Id]]'' channelgroupid
# [ ''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#PVR.Details.Channel|PVR.Details.Channel]]''[] channels

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "PVR.ChannelGroup.Id",
"name": "channelgroupid",
"required": true
},
{
"$ref": "PVR.Fields.Channel",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"description": "Retrieves the channel list",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"required": true,
"type": "array"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== PVR.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.Property.Name|PVR.Property.Name]]''[] properties
</div>
'''Returns:''' ''[[#PVR.Property.Value|PVR.Property.Value]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"uniqueItems": true,
"items": {
"$ref": "PVR.Property.Name"
},
"name": "properties",
"type": "array",
"required": true
}
],
"description": "Retrieves the values of the given properties",
"returns": {
"$ref": "PVR.Property.Value"
}
}</syntaxhighlight>}}

==== PVR.Record ====
Toggle recording of a channel<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Global.Toggle|Global.Toggle]]'' record = "toggle" ]
# [ ''mixed'' channel = "current" ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Global.Toggle",
"name": "record",
"default": "toggle"
},
{
"name": "channel",
"type": [
{
"enums": [
"current"
],
"type": "string"
},
{
"$ref": "Library.Id"
}
],
"default": "current"
}
],
"description": "Toggle recording of a channel",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Scan ====
Starts a channel scan<br />
'''Permissions:'''
* ControlPVR
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Starts a channel scan",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Player ===
==== Player.GetActivePlayers ====
Returns all active players<br />
'''Permissions:'''
* ReadData
'''Parameters:''' None
<br />
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Returns all active players",
"returns": {
"uniqueItems": true,
"items": {
"properties": {
"type": {
"$ref": "Player.Type",
"required": true
},
"playerid": {
"$ref": "Player.Id",
"required": true
}
},
"type": "object"
},
"type": "array"
}
}</syntaxhighlight>}}

==== Player.GetItem ====
Retrieves the currently played item<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# [ ''[[#List.Fields.All|List.Fields.All]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.Item.All|List.Item.All]]'' item

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "List.Fields.All",
"name": "properties"
}
],
"description": "Retrieves the currently played item",
"returns": {
"properties": {
"item": {
"$ref": "List.Item.All",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Player.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''[[#Player.Property.Name|Player.Property.Name]]''[] properties
</div>
'''Returns:''' ''[[#Player.Property.Value|Player.Property.Value]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"uniqueItems": true,
"items": {
"$ref": "Player.Property.Name"
},
"name": "properties",
"type": "array",
"required": true
}
],
"description": "Retrieves the values of the given properties",
"returns": {
"$ref": "Player.Property.Value"
}
}</syntaxhighlight>}}

==== Player.GoTo ====
Go to previous/next/specific item in the playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' to
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "to",
"required": true,
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"$ref": "Playlist.Position",
"description": "position in playlist"
}
]
}
],
"description": "Go to previous/next/specific item in the playlist",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Move ====
If picture is zoomed move viewport left/right/up/down otherwise skip previous/next<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''string'' direction
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"enums": [
"left",
"right",
"up",
"down"
],
"name": "direction",
"required": true,
"type": "string"
}
],
"description": "If picture is zoomed move viewport left/right/up/down otherwise skip previous/next",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== 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.<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed'' item ]
# [ ''object'' options ]<br />
'''Properties:'''
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' shuffled = null ]
* [ ''mixed'' repeat = null ]
* [ ''mixed'' resume = False ]

</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "item",
"type": [
{
"additionalProperties": false,
"properties": {
"position": {
"$ref": "Playlist.Position",
"default": 0
},
"playlistid": {
"$ref": "Playlist.Id",
"required": true
}
},
"type": "object"
},
{
"$ref": "Playlist.Item"
},
{
"additionalProperties": false,
"properties": {
"path": {
"required": true,
"type": "string"
},
"random": {
"description": "Deprecated, use the shuffled property of the options parameter instead",
"type": "boolean",
"default": true
},
"recursive": {
"type": "boolean",
"default": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"partymode": {
"type": [
{
"enums": [
"music",
"video"
],
"type": "string"
},
{
"description": "Path to a smartplaylist (*.xsp) file",
"minLength": 5,
"type": "string"
}
],
"default": ""
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"channelid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
},
{
"additionalProperties": false,
"name": "options",
"properties": {
"shuffled": {
"$ref": "Optional.Boolean",
"default": null
},
"repeat": {
"type": [
{
"type": "null"
},
{
"$ref": "Player.Repeat"
}
],
"default": null
},
"resume": {
"type": [
{
"description": "Whether to resume from the resume point or not",
"type": "boolean"
},
{
"$ref": "Player.Position.Percentage",
"description": "Percentage value to start from"
},
{
"$ref": "Player.Position.Time",
"description": "Time to start from"
}
],
"default": false
}
},
"type": "object"
}
],
"description": "Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.PlayPause ====
Pauses or unpause playback and returns the new state<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# [ ''[[#Global.Toggle|Global.Toggle]]'' play = "toggle" ]
</div>
'''Returns:''' ''[[#Player.Speed|Player.Speed]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "play",
"default": "toggle"
}
],
"description": "Pauses or unpause playback and returns the new state",
"returns": {
"$ref": "Player.Speed"
}
}</syntaxhighlight>}}

==== Player.Rotate ====
Rotates current picture<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# [ ''string'' value = "clockwise" ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"enums": [
"clockwise",
"counterclockwise"
],
"name": "value",
"type": "string",
"default": "clockwise"
}
],
"description": "Rotates current picture",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Seek ====
Seek through the playing item<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' value
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage = 0 ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
* [ ''[[#Global.Time|Global.Time]]'' totaltime ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "value",
"required": true,
"type": [
{
"$ref": "Player.Position.Percentage",
"description": "Percentage value to seek to"
},
{
"$ref": "Player.Position.Time",
"description": "Time to seek to"
},
{
"enums": [
"smallforward",
"smallbackward",
"bigforward",
"bigbackward"
],
"description": "Seek by predefined jumps",
"type": "string"
}
]
}
],
"description": "Seek through the playing item",
"returns": {
"properties": {
"percentage": {
"$ref": "Player.Position.Percentage",
"default": 0
},
"time": {
"$ref": "Global.Time"
},
"totaltime": {
"$ref": "Global.Time"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Player.SetAudioStream ====
Set the audio stream played by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' stream
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "stream",
"required": true,
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"minimum": 0,
"description": "Index of the audio stream to play",
"type": "integer"
}
]
}
],
"description": "Set the audio stream played by the player",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetPartymode ====
Turn partymode on or off<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''[[#Global.Toggle|Global.Toggle]]'' partymode
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "partymode",
"required": true
}
],
"description": "Turn partymode on or off",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetRepeat ====
Set the repeat mode of the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' repeat
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "repeat",
"required": true,
"type": [
{
"$ref": "Player.Repeat"
},
{
"enums": [
"cycle"
],
"type": "string"
}
]
}
],
"description": "Set the repeat mode of the player",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetShuffle ====
Shuffle/Unshuffle items in the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''[[#Global.Toggle|Global.Toggle]]'' shuffle
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "shuffle",
"required": true
}
],
"description": "Shuffle/Unshuffle items in the player",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetSpeed ====
Set the speed of the current playback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' speed
</div>
'''Returns:''' ''[[#Player.Speed|Player.Speed]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "speed",
"required": true,
"type": [
{
"enums": [
-32,
-16,
-8,
-4,
-2,
-1,
0,
1,
2,
4,
8,
16,
32
],
"type": "integer"
},
{
"$ref": "Global.IncrementDecrement"
}
]
}
],
"description": "Set the speed of the current playback",
"returns": {
"$ref": "Player.Speed"
}
}</syntaxhighlight>}}

==== Player.SetSubtitle ====
Set the subtitle displayed by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' subtitle
# [ ''boolean'' enable = False ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "subtitle",
"required": true,
"type": [
{
"enums": [
"previous",
"next",
"off",
"on"
],
"type": "string"
},
{
"minimum": 0,
"description": "Index of the subtitle to display",
"type": "integer"
}
]
},
{
"description": "Whether to enable subtitles to be displayed after setting the new subtitle",
"name": "enable",
"default": false,
"type": "boolean"
}
],
"description": "Set the subtitle displayed by the player",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Stop ====
Stops playback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
}
],
"description": "Stops playback",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Zoom ====
Zoom current picture<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' zoom
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "zoom",
"required": true,
"type": [
{
"enums": [
"in",
"out"
],
"type": "string"
},
{
"minimum": 1,
"description": "zoom level",
"type": "integer",
"maximum": 10
}
]
}
],
"description": "Zoom current picture",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Playlist ===
==== Playlist.Add ====
Add item(s) to playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Item|Playlist.Item]]'' item
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Item",
"name": "item",
"required": true
}
],
"description": "Add item(s) to playlist",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Playlist.Clear ====
Clear playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
}
],
"description": "Clear playlist",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Playlist.GetItems ====
Get all items from playlist<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# [ ''[[#List.Fields.All|List.Fields.All]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.Item.All|List.Item.All]]''[] items

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "List.Fields.All",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"description": "Get all items from playlist",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"items": {
"items": {
"$ref": "List.Item.All"
},
"required": true,
"type": "array"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Playlist.GetPlaylists ====
Returns all existing playlists. These are the active queue for 'music', 'mixed', and 'video', not the complete list of playlists in .kodi/userdata/playlists. Use the Files APIs to retrieve those. <br />
'''Permissions:'''
* ReadData
'''Parameters:''' None
<br />
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Returns all existing playlists",
"returns": {
"uniqueItems": true,
"items": {
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"type": {
"$ref": "Playlist.Type",
"required": true
}
},
"type": "object"
},
"type": "array"
}
}</syntaxhighlight>}}

==== Playlist.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Property.Name|Playlist.Property.Name]]''[] properties
</div>
'''Returns:''' ''[[#Playlist.Property.Value|Playlist.Property.Value]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"uniqueItems": true,
"items": {
"$ref": "Playlist.Property.Name"
},
"name": "properties",
"type": "array",
"required": true
}
],
"description": "Retrieves the values of the given properties",
"returns": {
"$ref": "Playlist.Property.Value"
}
}</syntaxhighlight>}}

==== Playlist.Insert ====
Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Position|Playlist.Position]]'' position
# ''[[#Playlist.Item|Playlist.Item]]'' item
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position",
"required": true
},
{
"$ref": "Playlist.Item",
"name": "item",
"required": true
}
],
"description": "Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Playlist.Remove ====
Remove item from playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Position|Playlist.Position]]'' position
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position",
"required": true
}
],
"description": "Remove item from playlist. Does not work for picture playlists (aka slideshows).",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Playlist.Swap ====
Swap items in the playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Position|Playlist.Position]]'' position1
# ''[[#Playlist.Position|Playlist.Position]]'' position2
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position1",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position2",
"required": true
}
],
"description": "Swap items in the playlist. Does not work for picture playlists (aka slideshows).",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== System ===
==== System.EjectOpticalDrive ====
Ejects or closes the optical disc drive (if available)<br />
'''Permissions:'''
* ControlSystem
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Ejects or closes the optical disc drive (if available)",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== System.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#System.Property.Name|System.Property.Name]]''[] properties
</div>
'''Returns:''' ''[[#System.Property.Value|System.Property.Value]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"uniqueItems": true,
"items": {
"$ref": "System.Property.Name"
},
"name": "properties",
"type": "array",
"required": true
}
],
"description": "Retrieves the values of the given properties",
"returns": {
"$ref": "System.Property.Value"
}
}</syntaxhighlight>}}

==== System.Hibernate ====
Puts the system running Kodi into hibernate mode<br />
'''Permissions:'''
* ControlPower
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Puts the system running Kodi into hibernate mode",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== System.Reboot ====
Reboots the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Reboots the system running Kodi",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== System.Shutdown ====
Shuts the system running Kodi down<br />
'''Permissions:'''
* ControlPower
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Shuts the system running Kodi down",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== System.Suspend ====
Suspends the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [],
"description": "Suspends the system running Kodi",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== VideoLibrary ===
==== VideoLibrary.Clean ====
Cleans the video library from non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''boolean'' showdialogs = True ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"description": "Whether to permit UI dialogs to be presented",
"name": "showdialogs",
"default": true,
"type": "boolean"
}
],
"description": "Cleans the video library from non-existent items",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.Export ====
Exports all items from the video library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed'' options ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "options",
"type": [
{
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the directory to where the data should be exported",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"overwrite": {
"description": "Whether to overwrite existing exported files",
"type": "boolean",
"default": false
},
"actorthumbs": {
"description": "Whether to export actor thumbnails",
"type": "boolean",
"default": false
},
"images": {
"description": "Whether to export thumbnails and fanart images",
"type": "boolean",
"default": false
}
},
"type": "object"
}
]
}
],
"description": "Exports all items from the video library",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetEpisodeDetails ====
Retrieve details about a specific tv show episode<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]'' episodedetails ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"$ref": "Video.Fields.Episode",
"name": "properties"
}
],
"description": "Retrieve details about a specific tv show episode",
"returns": {
"properties": {
"episodedetails": {
"$ref": "Video.Details.Episode"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetEpisodes ====
Retrieve all tv show episodes<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ]
# [ ''integer'' season = -1 ]
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]''[] episodes ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"default": -1
},
{
"minimum": 0,
"name": "season",
"type": "integer",
"default": -1
},
{
"$ref": "Video.Fields.Episode",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Requires tvshowid to be set",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Requires tvshowid to be set",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"description": "Requires tvshowid to be set",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Episodes"
}
]
}
],
"description": "Retrieve all tv show episodes",
"returns": {
"properties": {
"episodes": {
"items": {
"$ref": "Video.Details.Episode"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetGenres ====
Retrieve all genres<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' type
# [ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Library.Details.Genre|Library.Details.Genre]]''[] genres
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"enums": [
"movie",
"tvshow",
"musicvideo"
],
"name": "type",
"required": true,
"type": "string"
},
{
"$ref": "Library.Fields.Genre",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"description": "Retrieve all genres",
"returns": {
"properties": {
"genres": {
"items": {
"$ref": "Library.Details.Genre"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMovieDetails ====
Retrieve details about a specific movie<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]'' moviedetails ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"$ref": "Video.Fields.Movie",
"name": "properties"
}
],
"description": "Retrieve details about a specific movie",
"returns": {
"properties": {
"moviedetails": {
"$ref": "Video.Details.Movie"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMovieSetDetails ====
Retrieve details about a specific movie set<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' setid
# [ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties ]
# [ ''object'' movies ]<br />
'''Properties:'''
* [ ''[[#List.Limits|List.Limits]]'' limits ]
* [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
* [ ''[[#List.Sort|List.Sort]]'' sort ]

</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.MovieSet.Extended|Video.Details.MovieSet.Extended]]'' setdetails ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "setid",
"required": true
},
{
"$ref": "Video.Fields.MovieSet",
"name": "properties"
},
{
"name": "movies",
"properties": {
"limits": {
"$ref": "List.Limits"
},
"properties": {
"$ref": "Video.Fields.Movie"
},
"sort": {
"$ref": "List.Sort"
}
},
"type": "object"
}
],
"description": "Retrieve details about a specific movie set",
"returns": {
"properties": {
"setdetails": {
"$ref": "Video.Details.MovieSet.Extended"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMovieSets ====
Retrieve all movie sets<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''[] sets ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Video.Fields.MovieSet",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"description": "Retrieve all movie sets",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sets": {
"items": {
"$ref": "Video.Details.MovieSet"
},
"type": "array"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMovies ====
Retrieve all movies<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Video.Fields.Movie",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"country": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"set": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Movies"
}
]
}
],
"description": "Retrieve all movies",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMusicVideoDetails ====
Retrieve details about a specific music video<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]'' musicvideodetails ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
}
],
"description": "Retrieve details about a specific music video",
"returns": {
"properties": {
"musicvideodetails": {
"$ref": "Video.Details.MusicVideo"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMusicVideos ====
Retrieve all music videos<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]''[] musicvideos ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.MusicVideos"
}
]
}
],
"description": "Retrieve all music videos",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"musicvideos": {
"items": {
"$ref": "Video.Details.MusicVideo"
},
"type": "array"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetRecentlyAddedEpisodes ====
Retrieve all recently added tv episodes<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]''[] episodes ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Video.Fields.Episode",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"description": "Retrieve all recently added tv episodes",
"returns": {
"properties": {
"episodes": {
"items": {
"$ref": "Video.Details.Episode"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetRecentlyAddedMovies ====
Retrieve all recently added movies<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Video.Fields.Movie",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"description": "Retrieve all recently added movies",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetRecentlyAddedMusicVideos ====
Retrieve all recently added music videos<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]''[] musicvideos ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"description": "Retrieve all recently added music videos",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"musicvideos": {
"items": {
"$ref": "Video.Details.MusicVideo"
},
"type": "array"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetSeasons ====
Retrieve all tv seasons<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
# [ ''[[#Video.Fields.Season|Video.Fields.Season]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Season|Video.Details.Season]]''[] seasons ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Video.Fields.Season",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"description": "Retrieve all tv seasons",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"seasons": {
"items": {
"$ref": "Video.Details.Season"
},
"type": "array"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetTVShowDetails ====
Retrieve details about a specific tv show<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
# [ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.TVShow|Video.Details.TVShow]]'' tvshowdetails ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
}
],
"description": "Retrieve details about a specific tv show",
"returns": {
"properties": {
"tvshowdetails": {
"$ref": "Video.Details.TVShow"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetTVShows ====
Retrieve all tv shows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.TVShow|Video.Details.TVShow]]''[] tvshows ]

</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.TVShows"
}
]
}
],
"description": "Retrieve all tv shows",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tvshows": {
"items": {
"$ref": "Video.Details.TVShow"
},
"type": "array"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== VideoLibrary.RemoveEpisode ====
Removes the given episode from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
}
],
"description": "Removes the given episode from the library",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RemoveMovie ====
Removes the given movie from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
}
],
"description": "Removes the given movie from the library",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RemoveMusicVideo ====
Removes the given music video from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
}
],
"description": "Removes the given music video from the library",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RemoveTVShow ====
Removes the given tv show from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
}
],
"description": "Removes the given tv show from the library",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.Scan ====
Scans the video sources for new library items<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''string'' directory = "" ]
# [ ''boolean'' showdialogs = True ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "directory",
"type": "string",
"default": ""
},
{
"description": "Whether to permit UI dialogs to be presented",
"name": "showdialogs",
"default": true,
"type": "boolean"
}
],
"description": "Scans the video sources for new library items",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetEpisodeDetails ====
Update the given episode with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
# [ ''[[#Optional.String|Optional.String]]'' title = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime = null ]
# [ ''mixed'' director = null ]
# [ ''[[#Optional.String|Optional.String]]'' plot = null ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating = null ]
# [ ''[[#Optional.String|Optional.String]]'' votes = null ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed = null ]
# [ ''mixed'' writer = null ]
# [ ''[[#Optional.String|Optional.String]]'' firstaired = null ]
# [ ''[[#Optional.String|Optional.String]]'' productioncode = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' season = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' episode = null ]
# [ ''[[#Optional.String|Optional.String]]'' originaltitle = null ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail = null ]
# [ ''[[#Optional.String|Optional.String]]'' fanart = null ]
# [ ''mixed'' art = null ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title",
"default": null
},
{
"$ref": "Optional.Integer",
"name": "playcount",
"default": null
},
{
"$ref": "Optional.Integer",
"description": "Runtime in seconds",
"name": "runtime",
"default": null
},
{
"name": "director",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"$ref": "Optional.String",
"name": "plot",
"default": null
},
{
"$ref": "Optional.Number",
"name": "rating",
"default": null
},
{
"$ref": "Optional.String",
"name": "votes",
"default": null
},
{
"$ref": "Optional.String",
"name": "lastplayed",
"default": null
},
{
"name": "writer",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"$ref": "Optional.String",
"name": "firstaired",
"default": null
},
{
"$ref": "Optional.String",
"name": "productioncode",
"default": null
},
{
"$ref": "Optional.Integer",
"name": "season",
"default": null
},
{
"$ref": "Optional.Integer",
"name": "episode",
"default": null
},
{
"$ref": "Optional.String",
"name": "originaltitle",
"default": null
},
{
"$ref": "Optional.String",
"name": "thumbnail",
"default": null
},
{
"$ref": "Optional.String",
"name": "fanart",
"default": null
},
{
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork"
}
],
"default": null
}
],
"description": "Update the given episode with the given details",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetMovieDetails ====
Update the given movie with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
# [ ''[[#Optional.String|Optional.String]]'' title = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime = null ]
# [ ''mixed'' director = null ]
# [ ''mixed'' studio = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year = null ]
# [ ''[[#Optional.String|Optional.String]]'' plot = null ]
# [ ''mixed'' genre = null ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating = null ]
# [ ''[[#Optional.String|Optional.String]]'' mpaa = null ]
# [ ''[[#Optional.String|Optional.String]]'' imdbnumber = null ]
# [ ''[[#Optional.String|Optional.String]]'' votes = null ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed = null ]
# [ ''[[#Optional.String|Optional.String]]'' originaltitle = null ]
# [ ''[[#Optional.String|Optional.String]]'' trailer = null ]
# [ ''[[#Optional.String|Optional.String]]'' tagline = null ]
# [ ''[[#Optional.String|Optional.String]]'' plotoutline = null ]
# [ ''mixed'' writer = null ]
# [ ''mixed'' country = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' top250 = null ]
# [ ''[[#Optional.String|Optional.String]]'' sorttitle = null ]
# [ ''[[#Optional.String|Optional.String]]'' set = null ]
# [ ''mixed'' showlink = null ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail = null ]
# [ ''[[#Optional.String|Optional.String]]'' fanart = null ]
# [ ''mixed'' tag = null ]
# [ ''mixed'' art = null ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title",
"default": null
},
{
"$ref": "Optional.Integer",
"name": "playcount",
"default": null
},
{
"$ref": "Optional.Integer",
"description": "Runtime in seconds",
"name": "runtime",
"default": null
},
{
"name": "director",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"name": "studio",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"$ref": "Optional.Integer",
"name": "year",
"default": null
},
{
"$ref": "Optional.String",
"name": "plot",
"default": null
},
{
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"$ref": "Optional.Number",
"name": "rating",
"default": null
},
{
"$ref": "Optional.String",
"name": "mpaa",
"default": null
},
{
"$ref": "Optional.String",
"name": "imdbnumber",
"default": null
},
{
"$ref": "Optional.String",
"name": "votes",
"default": null
},
{
"$ref": "Optional.String",
"name": "lastplayed",
"default": null
},
{
"$ref": "Optional.String",
"name": "originaltitle",
"default": null
},
{
"$ref": "Optional.String",
"name": "trailer",
"default": null
},
{
"$ref": "Optional.String",
"name": "tagline",
"default": null
},
{
"$ref": "Optional.String",
"name": "plotoutline",
"default": null
},
{
"name": "writer",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"name": "country",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"$ref": "Optional.Integer",
"name": "top250",
"default": null
},
{
"$ref": "Optional.String",
"name": "sorttitle",
"default": null
},
{
"$ref": "Optional.String",
"name": "set",
"default": null
},
{
"name": "showlink",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"$ref": "Optional.String",
"name": "thumbnail",
"default": null
},
{
"$ref": "Optional.String",
"name": "fanart",
"default": null
},
{
"name": "tag",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork"
}
],
"default": null
}
],
"description": "Update the given movie with the given details",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetMusicVideoDetails ====
Update the given music video with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
# [ ''[[#Optional.String|Optional.String]]'' title = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime = null ]
# [ ''mixed'' director = null ]
# [ ''mixed'' studio = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year = null ]
# [ ''[[#Optional.String|Optional.String]]'' plot = null ]
# [ ''[[#Optional.String|Optional.String]]'' album = null ]
# [ ''mixed'' artist = null ]
# [ ''mixed'' genre = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' track = null ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed = null ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail = null ]
# [ ''[[#Optional.String|Optional.String]]'' fanart = null ]
# [ ''mixed'' tag = null ]
# [ ''mixed'' art = null ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title",
"default": null
},
{
"$ref": "Optional.Integer",
"name": "playcount",
"default": null
},
{
"$ref": "Optional.Integer",
"description": "Runtime in seconds",
"name": "runtime",
"default": null
},
{
"name": "director",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"name": "studio",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"$ref": "Optional.Integer",
"name": "year",
"default": null
},
{
"$ref": "Optional.String",
"name": "plot",
"default": null
},
{
"$ref": "Optional.String",
"name": "album",
"default": null
},
{
"name": "artist",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"$ref": "Optional.Integer",
"name": "track",
"default": null
},
{
"$ref": "Optional.String",
"name": "lastplayed",
"default": null
},
{
"$ref": "Optional.String",
"name": "thumbnail",
"default": null
},
{
"$ref": "Optional.String",
"name": "fanart",
"default": null
},
{
"name": "tag",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork"
}
],
"default": null
}
],
"description": "Update the given music video with the given details",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetTVShowDetails ====
Update the given tvshow with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
# [ ''[[#Optional.String|Optional.String]]'' title = null ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount = null ]
# [ ''mixed'' studio = null ]
# [ ''[[#Optional.String|Optional.String]]'' plot = null ]
# [ ''mixed'' genre = null ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating = null ]
# [ ''[[#Optional.String|Optional.String]]'' mpaa = null ]
# [ ''[[#Optional.String|Optional.String]]'' imdbnumber = null ]
# [ ''[[#Optional.String|Optional.String]]'' premiered = null ]
# [ ''[[#Optional.String|Optional.String]]'' votes = null ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed = null ]
# [ ''[[#Optional.String|Optional.String]]'' originaltitle = null ]
# [ ''[[#Optional.String|Optional.String]]'' sorttitle = null ]
# [ ''[[#Optional.String|Optional.String]]'' episodeguide = null ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail = null ]
# [ ''[[#Optional.String|Optional.String]]'' fanart = null ]
# [ ''mixed'' tag = null ]
# [ ''mixed'' art = null ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title",
"default": null
},
{
"$ref": "Optional.Integer",
"name": "playcount",
"default": null
},
{
"name": "studio",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"$ref": "Optional.String",
"name": "plot",
"default": null
},
{
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"$ref": "Optional.Number",
"name": "rating",
"default": null
},
{
"$ref": "Optional.String",
"name": "mpaa",
"default": null
},
{
"$ref": "Optional.String",
"name": "imdbnumber",
"default": null
},
{
"$ref": "Optional.String",
"name": "premiered",
"default": null
},
{
"$ref": "Optional.String",
"name": "votes",
"default": null
},
{
"$ref": "Optional.String",
"name": "lastplayed",
"default": null
},
{
"$ref": "Optional.String",
"name": "originaltitle",
"default": null
},
{
"$ref": "Optional.String",
"name": "sorttitle",
"default": null
},
{
"$ref": "Optional.String",
"name": "episodeguide",
"default": null
},
{
"$ref": "Optional.String",
"name": "thumbnail",
"default": null
},
{
"$ref": "Optional.String",
"name": "fanart",
"default": null
},
{
"name": "tag",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"default": null
},
{
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork"
}
],
"default": null
}
],
"description": "Update the given tvshow with the given details",
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Kodi ===
==== XBMC.GetInfoBooleans ====
Retrieve info booleans about Kodi and the system<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array''[1..X] booleans
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"minItems": 1,
"items": {
"type": "string"
},
"name": "booleans",
"type": "array",
"required": true
}
],
"description": "Retrieve info booleans about Kodi and the system",
"returns": {
"additionalProperties": {
"type": "string",
"default": ""
},
"description": "Object containing key-value pairs of the retrieved info booleans",
"type": "object"
}
}</syntaxhighlight>}}

==== XBMC.GetInfoLabels ====
Retrieve info labels about Kodi and the system<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array''[1..X] labels
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"description": "See http://kodi.wiki/index.php?title=InfoLabels for a list of possible info labels",
"name": "labels",
"type": "array",
"minItems": 1,
"items": {
"type": "string"
},
"required": true
}
],
"description": "Retrieve info labels about Kodi and the system",
"returns": {
"additionalProperties": {
"type": "string",
"default": ""
},
"description": "Object containing key-value pairs of the retrieved info labels",
"type": "object"
}
}</syntaxhighlight>}}

== Global Types ==
=== Addon ===
==== Addon.Content ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"unknown",
"video",
"audio",
"image",
"executable"
],
"id": "Addon.Content",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

==== Addon.Details ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' addonid
* [ ''string'' author ]
* [ ''mixed: boolean|string'' broken ]
* [ ''object'' dependencies ]
* [ ''string'' description ]
* [ ''string'' disclaimer ]
* [ ''boolean'' enabled = false ]
* [ ''object'' extrainfo ]
* [ ''string'' fanart ]
* [ ''boolean'' installed = false ]
* [ ''string'' name ]
* [ ''string'' path ]
* [ ''integer'' rating = "0" ]
* [ ''string'' summary ]
* [ ''string'' thumbnail ]
* ''[[#Addon.Types|Addon.Types]]'' type
* [ ''string'' version ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Addon.Details",
"properties": {
"addonid": {
"type": "string",
"name": "addonid",
"required": true
},
"author": {
"default": "",
"type": "string",
"name": "author"
},
"broken": {
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
],
"name": "broken"
},
"dependencies": {
"items": {
"properties": {
"addonid": {
"required": true,
"type": "string"
},
"optional": {
"required": true,
"type": "boolean"
},
"version": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "dependencies"
},
"description": {
"default": "",
"type": "string",
"name": "description"
},
"disclaimer": {
"default": "",
"type": "string",
"name": "disclaimer"
},
"enabled": {
"default": "false",
"type": "boolean",
"name": "enabled"
},
"extrainfo": {
"items": {
"properties": {
"key": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "extrainfo"
},
"fanart": {
"default": "",
"type": "string",
"name": "fanart"
},
"installed": {
"default": "false",
"type": "boolean",
"name": "installed"
},
"name": {
"default": "",
"type": "string",
"name": "name"
},
"path": {
"default": "",
"type": "string",
"name": "path"
},
"rating": {
"default": "0",
"type": "integer",
"name": "rating"
},
"summary": {
"default": "",
"type": "string",
"name": "summary"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"type": {
"$ref": "Addon.Types",
"name": "type",
"required": true
},
"version": {
"default": "",
"type": "string",
"name": "version"
}
}
}</syntaxhighlight>}}

==== Addon.Fields ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Addon.Fields",
"items": {
"enums": [
"name",
"version",
"summary",
"description",
"path",
"author",
"thumbnail",
"disclaimer",
"fanart",
"dependencies",
"broken",
"extrainfo",
"rating",
"enabled",
"installed"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Addon.Types ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"unknown",
"xbmc.player.musicviz",
"xbmc.gui.skin",
"xbmc.pvrclient",
"kodi.adsp",
"kodi.inputstream",
"kodi.peripheral",
"xbmc.python.script",
"xbmc.python.weather",
"xbmc.subtitle.module",
"xbmc.python.lyrics",
"xbmc.metadata.scraper.albums",
"xbmc.metadata.scraper.artists",
"xbmc.metadata.scraper.movies",
"xbmc.metadata.scraper.musicvideos",
"xbmc.metadata.scraper.tvshows",
"xbmc.ui.screensaver",
"xbmc.python.pluginsource",
"xbmc.addon.repository",
"xbmc.webinterface",
"xbmc.service",
"xbmc.audioencoder",
"kodi.context.item",
"kodi.audiodecoder",
"kodi.resource.images",
"kodi.resource.language",
"kodi.resource.uisounds",
"xbmc.addon.video",
"xbmc.addon.audio",
"xbmc.addon.image",
"xbmc.addon.executable",
"xbmc.metadata.scraper.library",
"xbmc.python.library",
"xbmc.python.module",
"kodi.game.controller"
],
"id": "Addon.Types",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

=== Application ===
==== Application.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"volume",
"muted",
"name",
"version"
],
"id": "Application.Property.Name",
"type": "string",
"default": "volume"
}</syntaxhighlight>}}

==== Application.Property.Value ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' muted = false ]
* [ ''string'' name ]
* [ ''mixed'' version ]
* [ ''integer'' volume = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Application.Property.Value",
"type": "object",
"properties": {
"muted": {
"default": "false",
"type": "boolean",
"name": "muted"
},
"name": {
"default": "",
"type": "string",
"name": "name"
},
"version": {
"type": "object",
"name": "version"
},
"volume": {
"default": "0",
"type": "integer",
"name": "volume"
}
}
}</syntaxhighlight>}}

=== Array ===
==== Array.Integer ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Array.Integer",
"type": "array",
"items": {
"type": "integer"
}
}</syntaxhighlight>}}

==== Array.String ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Array.String",
"type": "array",
"items": {
"minLength": 1,
"type": "string"
}
}</syntaxhighlight>}}

=== Audio ===
==== Audio.Album.ReleaseType ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"album",
"single"
],
"id": "Audio.Album.ReleaseType",
"type": "string",
"default": "album"
}</syntaxhighlight>}}

==== Audio.Artist.Roles ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Audio.Artist.Roles",
"type": "array",
"items": {
"additionalProperties": false,
"description": "The various roles contributed by an artist to one or more songs",
"properties": {
"role": {
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Audio.Contributors ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Audio.Contributors",
"type": "array",
"items": {
"additionalProperties": false,
"description": "The artist and the role they contribute to a song",
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"name": {
"required": true,
"type": "string"
},
"role": {
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Audio.Details.Album ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' albumid
* [ ''string'' albumlabel ]
* [ ''boolean'' compilation = false ]
* [ ''string'' description ]
* [ ''[[#Array.String|Array.String]]'' mood ]
* [ ''integer'' playcount = "0" ]
* [ ''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = "album" ]
* [ ''[[#Array.String|Array.String]]'' style ]
* [ ''[[#Array.String|Array.String]]'' theme ]
* [ ''string'' type ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Audio.Details.Media"
],
"id": "Audio.Details.Album",
"properties": {
"albumid": {
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
"albumlabel": {
"default": "",
"type": "string",
"name": "albumlabel"
},
"compilation": {
"default": "false",
"type": "boolean",
"name": "compilation"
},
"description": {
"default": "",
"type": "string",
"name": "description"
},
"mood": {
"$ref": "Array.String",
"name": "mood"
},
"playcount": {
"default": "0",
"type": "integer",
"name": "playcount"
},
"releasetype": {
"default": "album",
"$ref": "Audio.Album.ReleaseType",
"name": "releasetype"
},
"style": {
"$ref": "Array.String",
"name": "style"
},
"theme": {
"$ref": "Array.String",
"name": "theme"
},
"type": {
"default": "",
"type": "string",
"name": "type"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Artist ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' artist
* ''[[#Library.Id|Library.Id]]'' artistid
* [ ''string'' born ]
* [ ''boolean'' compilationartist = false ]
* [ ''string'' description ]
* [ ''string'' died ]
* [ ''string'' disbanded ]
* [ ''string'' formed ]
* [ ''[[#Array.String|Array.String]]'' instrument ]
* [ ''boolean'' isalbumartist = false ]
* [ ''[[#Array.String|Array.String]]'' mood ]
* [ ''string'' musicbrainzartistid ]
* [ ''[[#Audio.Artist.Roles|Audio.Artist.Roles]]'' roles ]
* [ ''[[#Audio.Details.Genres|Audio.Details.Genres]]'' songgenres ]
* [ ''[[#Array.String|Array.String]]'' style ]
* [ ''[[#Array.String|Array.String]]'' yearsactive ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Audio.Details.Base"
],
"id": "Audio.Details.Artist",
"properties": {
"artist": {
"type": "string",
"name": "artist",
"required": true
},
"artistid": {
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
"born": {
"default": "",
"type": "string",
"name": "born"
},
"compilationartist": {
"default": "false",
"type": "boolean",
"name": "compilationartist"
},
"description": {
"default": "",
"type": "string",
"name": "description"
},
"died": {
"default": "",
"type": "string",
"name": "died"
},
"disbanded": {
"default": "",
"type": "string",
"name": "disbanded"
},
"formed": {
"default": "",
"type": "string",
"name": "formed"
},
"instrument": {
"$ref": "Array.String",
"name": "instrument"
},
"isalbumartist": {
"default": "false",
"type": "boolean",
"name": "isalbumartist"
},
"mood": {
"$ref": "Array.String",
"name": "mood"
},
"musicbrainzartistid": {
"default": "",
"type": "string",
"name": "musicbrainzartistid"
},
"roles": {
"$ref": "Audio.Artist.Roles",
"name": "roles"
},
"songgenres": {
"$ref": "Audio.Details.Genres",
"name": "songgenres"
},
"style": {
"$ref": "Array.String",
"name": "style"
},
"yearsactive": {
"$ref": "Array.String",
"name": "yearsactive"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' dateadded ]
* [ ''[[#Array.String|Array.String]]'' genre ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Media.Details.Base"
],
"id": "Audio.Details.Base",
"properties": {
"dateadded": {
"default": "",
"type": "string",
"name": "dateadded"
},
"genre": {
"$ref": "Array.String",
"name": "genre"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Genres ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Audio.Details.Genres",
"type": "array",
"items": {
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Audio.Details.Media ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Array.String|Array.String]]'' artist ]
* [ ''[[#Array.Integer|Array.Integer]]'' artistid ]
* [ ''string'' displayartist ]
* [ ''[[#Array.Integer|Array.Integer]]'' genreid ]
* [ ''string'' musicbrainzalbumartistid ]
* [ ''string'' musicbrainzalbumid ]
* [ ''number'' rating = "0" ]
* [ ''string'' title ]
* [ ''integer'' userrating = "0" ]
* [ ''integer'' votes = "0" ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Audio.Details.Base"
],
"id": "Audio.Details.Media",
"properties": {
"artist": {
"$ref": "Array.String",
"name": "artist"
},
"artistid": {
"$ref": "Array.Integer",
"name": "artistid"
},
"displayartist": {
"default": "",
"type": "string",
"name": "displayartist"
},
"genreid": {
"$ref": "Array.Integer",
"name": "genreid"
},
"musicbrainzalbumartistid": {
"default": "",
"type": "string",
"name": "musicbrainzalbumartistid"
},
"musicbrainzalbumid": {
"default": "",
"type": "string",
"name": "musicbrainzalbumid"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"title": {
"default": "",
"type": "string",
"name": "title"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"votes": {
"default": "0",
"type": "integer",
"name": "votes"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Role ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' roleid
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Audio.Details.Role",
"properties": {
"roleid": {
"$ref": "Library.Id",
"name": "roleid",
"required": true
},
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Song ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' album ]
* [ ''[[#Array.String|Array.String]]'' albumartist ]
* [ ''[[#Array.Integer|Array.Integer]]'' albumartistid ]
* [ ''[[#Library.Id|Library.Id]]'' albumid = "-1" ]
* [ ''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' albumreleasetype = "album" ]
* [ ''string'' comment ]
* [ ''[[#Audio.Contributors|Audio.Contributors]]'' contributors ]
* [ ''integer'' disc = "0" ]
* [ ''string'' displaycomposer ]
* [ ''string'' displayconductor ]
* [ ''string'' displaylyricist ]
* [ ''string'' displayorchestra ]
* [ ''integer'' duration = "0" ]
* [ ''string'' file ]
* [ ''string'' lastplayed ]
* [ ''string'' lyrics ]
* [ ''string'' mood ]
* [ ''string'' musicbrainzartistid ]
* [ ''string'' musicbrainztrackid ]
* [ ''integer'' playcount = "0" ]
* ''[[#Library.Id|Library.Id]]'' songid
* [ ''integer'' track = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Audio.Details.Media"
],
"id": "Audio.Details.Song",
"properties": {
"album": {
"default": "",
"type": "string",
"name": "album"
},
"albumartist": {
"$ref": "Array.String",
"name": "albumartist"
},
"albumartistid": {
"$ref": "Array.Integer",
"name": "albumartistid"
},
"albumid": {
"default": "-1",
"$ref": "Library.Id",
"name": "albumid"
},
"albumreleasetype": {
"default": "album",
"$ref": "Audio.Album.ReleaseType",
"name": "albumreleasetype"
},
"comment": {
"default": "",
"type": "string",
"name": "comment"
},
"contributors": {
"$ref": "Audio.Contributors",
"name": "contributors"
},
"disc": {
"default": "0",
"type": "integer",
"name": "disc"
},
"displaycomposer": {
"default": "",
"type": "string",
"name": "displaycomposer"
},
"displayconductor": {
"default": "",
"type": "string",
"name": "displayconductor"
},
"displaylyricist": {
"default": "",
"type": "string",
"name": "displaylyricist"
},
"displayorchestra": {
"default": "",
"type": "string",
"name": "displayorchestra"
},
"duration": {
"default": "0",
"type": "integer",
"name": "duration"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"lastplayed": {
"default": "",
"type": "string",
"name": "lastplayed"
},
"lyrics": {
"default": "",
"type": "string",
"name": "lyrics"
},
"mood": {
"default": "",
"type": "string",
"name": "mood"
},
"musicbrainzartistid": {
"default": "",
"type": "string",
"name": "musicbrainzartistid"
},
"musicbrainztrackid": {
"default": "",
"type": "string",
"name": "musicbrainztrackid"
},
"playcount": {
"default": "0",
"type": "integer",
"name": "playcount"
},
"songid": {
"$ref": "Library.Id",
"name": "songid",
"required": true
},
"track": {
"default": "0",
"type": "integer",
"name": "track"
}
}
}</syntaxhighlight>}}

==== Audio.Fields.Album ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Audio.Fields.Album",
"items": {
"description": "Requesting the genreid and/or artistid field will result in increased response times",
"enums": [
"title",
"description",
"artist",
"genre",
"theme",
"mood",
"style",
"type",
"albumlabel",
"rating",
"votes",
"userrating",
"year",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"fanart",
"thumbnail",
"playcount",
"genreid",
"artistid",
"displayartist",
"compilation",
"releasetype",
"dateadded"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Audio.Fields.Artist ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Audio.Fields.Artist",
"items": {
"description": "Requesting the (song)genreid/genre, or roleid/role fields will result in increased response times",
"enums": [
"instrument",
"style",
"mood",
"born",
"formed",
"description",
"genre",
"died",
"disbanded",
"yearsactive",
"musicbrainzartistid",
"fanart",
"thumbnail",
"compilationartist",
"dateadded",
"roles",
"songgenres",
"isalbumartist"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Audio.Fields.Role ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Audio.Fields.Role",
"items": {
"enums": [
"title"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Audio.Fields.Song ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Audio.Fields.Song",
"items": {
"description": "Requesting the genreid, artistid and/or albumartistid field will result in increased response times",
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"thumbnail",
"file",
"albumid",
"lastplayed",
"disc",
"genreid",
"artistid",
"displayartist",
"albumartistid",
"albumreleasetype",
"dateadded",
"votes",
"userrating",
"mood",
"contributors",
"displaycomposer",
"displayconductor",
"displayorchestra",
"displaylyricist"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Audio.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"missingartistid"
],
"id": "Audio.Property.Name",
"type": "string",
"default": "missingartistid"
}</syntaxhighlight>}}

==== Audio.Property.Value ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Library.Id|Library.Id]]'' missingartistid = "-1" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Audio.Property.Value",
"type": "object",
"properties": {
"missingartistid": {
"default": "-1",
"$ref": "Library.Id",
"name": "missingartistid"
}
}
}</syntaxhighlight>}}

=== Configuration ===
==== Configuration.Configuration ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Configuration.Notifications|Configuration.Notifications]]'' notifications
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Configuration",
"type": "object",
"properties": {
"notifications": {
"$ref": "Configuration.Notifications",
"name": "notifications",
"required": true
}
}
}</syntaxhighlight>}}

==== Configuration.Notifications ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' application
* ''boolean'' audiolibrary
* ''boolean'' gui
* ''boolean'' input
* ''boolean'' other
* ''boolean'' player
* ''boolean'' playlist
* ''boolean'' pvr
* ''boolean'' system
* ''boolean'' videolibrary
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Configuration.Notifications",
"type": "object",
"properties": {
"application": {
"type": "boolean",
"name": "application",
"required": true
},
"audiolibrary": {
"type": "boolean",
"name": "audiolibrary",
"required": true
},
"gui": {
"type": "boolean",
"name": "gui",
"required": true
},
"input": {
"type": "boolean",
"name": "input",
"required": true
},
"other": {
"type": "boolean",
"name": "other",
"required": true
},
"player": {
"type": "boolean",
"name": "player",
"required": true
},
"playlist": {
"type": "boolean",
"name": "playlist",
"required": true
},
"pvr": {
"type": "boolean",
"name": "pvr",
"required": true
},
"system": {
"type": "boolean",
"name": "system",
"required": true
},
"videolibrary": {
"type": "boolean",
"name": "videolibrary",
"required": true
}
}
}</syntaxhighlight>}}

=== Favourite ===
==== Favourite.Details.Favourite ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' path ]
* [ ''string'' thumbnail ]
* ''string'' title
* ''[[#Favourite.Type|Favourite.Type]]'' type
* [ ''string'' window ]
* [ ''string'' windowparameter ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Favourite.Details.Favourite",
"type": "object",
"properties": {
"path": {
"default": "",
"type": "string",
"name": "path"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"title": {
"type": "string",
"name": "title",
"required": true
},
"type": {
"$ref": "Favourite.Type",
"name": "type",
"required": true
},
"window": {
"default": "",
"type": "string",
"name": "window"
},
"windowparameter": {
"default": "",
"type": "string",
"name": "windowparameter"
}
}
}</syntaxhighlight>}}

==== Favourite.Fields.Favourite ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Favourite.Fields.Favourite",
"items": {
"enums": [
"window",
"windowparameter",
"thumbnail",
"path"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Favourite.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"media",
"window",
"script",
"unknown"
],
"id": "Favourite.Type",
"type": "string",
"default": "media"
}</syntaxhighlight>}}

=== Files ===
==== Files.Media ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"video",
"music",
"pictures",
"files",
"programs"
],
"id": "Files.Media",
"type": "string",
"default": "video"
}</syntaxhighlight>}}

=== Global ===
==== Global.IncrementDecrement ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"increment",
"decrement"
],
"id": "Global.IncrementDecrement",
"type": "string",
"default": "increment"
}</syntaxhighlight>}}

==== Global.String.NotEmpty ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Global.String.NotEmpty",
"type": "string",
"default": ""
}</syntaxhighlight>}}

==== Global.Time ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' hours
* ''integer'' milliseconds
* ''integer'' minutes
* ''integer'' seconds
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Global.Time",
"type": "object",
"properties": {
"hours": {
"type": "integer",
"name": "hours",
"required": true
},
"milliseconds": {
"type": "integer",
"name": "milliseconds",
"required": true
},
"minutes": {
"type": "integer",
"name": "minutes",
"required": true
},
"seconds": {
"type": "integer",
"name": "seconds",
"required": true
}
}
}</syntaxhighlight>}}

==== Global.Toggle ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Global.Toggle",
"type": [
{
"type": "boolean"
},
{
"enums": [
"toggle"
],
"type": "string"
}
]
}</syntaxhighlight>}}

==== Global.Weekday ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"id": "Global.Weekday",
"type": "string",
"default": "monday"
}</syntaxhighlight>}}

=== GUI ===
==== GUI.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"currentwindow",
"currentcontrol",
"skin",
"fullscreen",
"stereoscopicmode"
],
"id": "GUI.Property.Name",
"type": "string",
"default": "currentwindow"
}</syntaxhighlight>}}

==== GUI.Property.Value ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''mixed'' currentcontrol ]
* [ ''mixed'' currentwindow ]
* [ ''boolean'' fullscreen = false ]
* [ ''mixed'' skin ]
* [ ''[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]'' stereoscopicmode ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "GUI.Property.Value",
"type": "object",
"properties": {
"currentcontrol": {
"type": "object",
"name": "currentcontrol"
},
"currentwindow": {
"type": "object",
"name": "currentwindow"
},
"fullscreen": {
"default": "false",
"type": "boolean",
"name": "fullscreen"
},
"skin": {
"type": "object",
"name": "skin"
},
"stereoscopicmode": {
"$ref": "GUI.Stereoscopy.Mode",
"name": "stereoscopicmode"
}
}
}</syntaxhighlight>}}

==== GUI.Stereoscopy.Mode ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' label
* ''string'' mode
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "GUI.Stereoscopy.Mode",
"type": "object",
"properties": {
"label": {
"type": "string",
"name": "label",
"required": true
},
"mode": {
"type": "string",
"name": "mode",
"required": true
}
}
}</syntaxhighlight>}}

==== GUI.Window ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"home",
"programs",
"pictures",
"filemanager",
"settings",
"music",
"videos",
"tvchannels",
"tvrecordings",
"tvguide",
"tvtimers",
"tvsearch",
"radiochannels",
"radiorecordings",
"radioguide",
"radiotimers",
"radiosearch",
"gamecontrollers",
"pvrguideinfo",
"pvrrecordinginfo",
"pvrradiordsinfo",
"pvrtimersetting",
"pvrgroupmanager",
"pvrchannelmanager",
"pvrguidesearch",
"pvrchannelscan",
"pvrupdateprogress",
"pvrosdchannels",
"pvrosdguide",
"pvrosdteletext",
"systeminfo",
"testpattern",
"screencalibration",
"systemsettings",
"servicesettings",
"pvrsettings",
"playersettings",
"mediasettings",
"interfacesettings",
"appearancesettings",
"videoplaylist",
"loginscreen",
"profiles",
"skinsettings",
"addonbrowser",
"yesnodialog",
"progressdialog",
"virtualkeyboard",
"volumebar",
"submenu",
"favourites",
"contextmenu",
"notification",
"numericinput",
"gamepadinput",
"shutdownmenu",
"playercontrols",
"playerprocessinfo",
"seekbar",
"musicosd",
"addonsettings",
"visualisationpresetlist",
"osdcmssettings",
"osdvideosettings",
"osdaudiosettings",
"audiodspmanager",
"osdaudiodspsettings",
"videobookmarks",
"filebrowser",
"networksetup",
"mediasource",
"profilesettings",
"locksettings",
"contentsettings",
"songinformation",
"smartplaylisteditor",
"smartplaylistrule",
"busydialog",
"pictureinfo",
"accesspoints",
"fullscreeninfo",
"sliderdialog",
"addoninformation",
"subtitlesearch",
"musicplaylist",
"musicplaylisteditor",
"teletext",
"selectdialog",
"musicinformation",
"okdialog",
"movieinformation",
"textviewer",
"fullscreenvideo",
"fullscreenlivetv",
"fullscreenradio",
"visualisation",
"slideshow",
"weather",
"screensaver",
"videoosd",
"videomenu",
"videotimeseek",
"startwindow",
"startup",
"peripheralsettings",
"extendedprogressdialog",
"mediafilter",
"addon",
"eventlog",
"tvtimerrules",
"radiotimerrules"
],
"id": "GUI.Window",
"type": "string",
"default": "home"
}</syntaxhighlight>}}

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

=== Item ===
==== Item.Details.Base ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' label
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Item.Details.Base",
"type": "object",
"properties": {
"label": {
"type": "string",
"name": "label",
"required": true
}
}
}</syntaxhighlight>}}

==== Item.Fields.Base ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Item.Fields.Base",
"type": "array",
"items": {
"type": "string"
}
}</syntaxhighlight>}}

=== Library ===
==== Library.Details.Genre ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' genreid
* [ ''string'' thumbnail ]
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Library.Details.Genre",
"properties": {
"genreid": {
"$ref": "Library.Id",
"name": "genreid",
"required": true
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== Library.Details.Tag ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' tagid
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Library.Details.Tag",
"properties": {
"tagid": {
"$ref": "Library.Id",
"name": "tagid",
"required": true
},
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== Library.Fields.Genre ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Library.Fields.Genre",
"items": {
"enums": [
"title",
"thumbnail"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Library.Fields.Tag ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Library.Fields.Tag",
"items": {
"enums": [
"title"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Library.Id ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Library.Id",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

=== List ===
==== List.Amount ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.Amount",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

==== List.Fields.All ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "List.Fields.All",
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"channel",
"channeltype",
"hidden",
"locked",
"channelnumber",
"starttime",
"endtime",
"specialsortseason",
"specialsortepisode",
"compilation",
"releasetype",
"albumreleasetype",
"contributors",
"displaycomposer",
"displayconductor",
"displayorchestra",
"displaylyricist",
"userrating"
],
"type": "string"
}
}</syntaxhighlight>}}

==== List.Fields.Files ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "List.Fields.Files",
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"size",
"lastmodified",
"mimetype",
"specialsortseason",
"specialsortepisode"
],
"type": "string"
}
}</syntaxhighlight>}}

==== List.Filter.Albums ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.Artists ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.Episodes ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.Fields.Albums ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"genre",
"album",
"artist",
"albumartist",
"year",
"review",
"themes",
"moods",
"styles",
"compilation",
"type",
"label",
"rating",
"userrating",
"playcount",
"lastplayed",
"path",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Albums",
"type": "string",
"default": "genre"
}</syntaxhighlight>}}

==== List.Filter.Fields.Artists ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"artist",
"genre",
"moods",
"styles",
"instruments",
"biography",
"born",
"bandformed",
"disbanded",
"died",
"role",
"path",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Artists",
"type": "string",
"default": "artist"
}</syntaxhighlight>}}

==== List.Filter.Fields.Episodes ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"title",
"tvshow",
"plot",
"votes",
"rating",
"userrating",
"time",
"writers",
"airdate",
"playcount",
"lastplayed",
"inprogress",
"genre",
"year",
"director",
"actor",
"episode",
"season",
"filename",
"path",
"studio",
"mpaarating",
"dateadded",
"tag",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Episodes",
"type": "string",
"default": "title"
}</syntaxhighlight>}}

==== List.Filter.Fields.Movies ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"title",
"plot",
"plotoutline",
"tagline",
"votes",
"rating",
"userrating",
"time",
"writers",
"playcount",
"lastplayed",
"inprogress",
"genre",
"country",
"year",
"director",
"actor",
"mpaarating",
"top250",
"studio",
"hastrailer",
"filename",
"path",
"set",
"tag",
"dateadded",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Movies",
"type": "string",
"default": "title"
}</syntaxhighlight>}}

==== List.Filter.Fields.MusicVideos ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"title",
"genre",
"album",
"year",
"artist",
"filename",
"path",
"playcount",
"lastplayed",
"rating",
"userrating",
"time",
"director",
"studio",
"plot",
"tag",
"dateadded",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.MusicVideos",
"type": "string",
"default": "title"
}</syntaxhighlight>}}

==== List.Filter.Fields.Songs ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"genre",
"album",
"artist",
"albumartist",
"title",
"year",
"time",
"tracknumber",
"filename",
"path",
"playcount",
"lastplayed",
"rating",
"userrating",
"comment",
"moods",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Songs",
"type": "string",
"default": "genre"
}</syntaxhighlight>}}

==== List.Filter.Fields.Textures ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"textureid",
"url",
"cachedurl",
"lasthashcheck",
"imagehash",
"width",
"height",
"usecount",
"lastused"
],
"id": "List.Filter.Fields.Textures",
"type": "string",
"default": "textureid"
}</syntaxhighlight>}}

==== List.Filter.Fields.TVShows ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"title",
"plot",
"status",
"votes",
"rating",
"userrating",
"year",
"genre",
"director",
"actor",
"numepisodes",
"numwatched",
"playcount",
"path",
"studio",
"mpaarating",
"dateadded",
"lastplayed",
"inprogress",
"tag",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.TVShows",
"type": "string",
"default": "title"
}</syntaxhighlight>}}

==== List.Filter.Movies ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.MusicVideos ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.Operators ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"contains",
"doesnotcontain",
"is",
"isnot",
"startswith",
"endswith",
"greaterthan",
"lessthan",
"after",
"before",
"inthelast",
"notinthelast",
"true",
"false",
"between"
],
"id": "List.Filter.Operators",
"type": "string",
"default": "contains"
}</syntaxhighlight>}}

==== List.Filter.Rule ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Operators|List.Filter.Operators]]'' operator
* ''mixed: string|array'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.Filter.Rule",
"type": "object",
"properties": {
"operator": {
"$ref": "List.Filter.Operators",
"name": "operator",
"required": true
},
"value": {
"type": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Albums ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Albums|List.Filter.Fields.Albums]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Albums",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Albums",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Artists ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Artists|List.Filter.Fields.Artists]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Artists",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Artists",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Episodes ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Episodes|List.Filter.Fields.Episodes]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Episodes",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Episodes",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Movies ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Movies|List.Filter.Fields.Movies]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Movies",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Movies",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.MusicVideos ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.MusicVideos|List.Filter.Fields.MusicVideos]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.MusicVideos",
"properties": {
"field": {
"$ref": "List.Filter.Fields.MusicVideos",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Songs ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Songs|List.Filter.Fields.Songs]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Songs",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Songs",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Textures ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Textures|List.Filter.Fields.Textures]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Textures",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Textures",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.TVShows ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.TVShows|List.Filter.Fields.TVShows]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.TVShows",
"properties": {
"field": {
"$ref": "List.Filter.Fields.TVShows",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Songs ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.Textures ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.TVShows ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Item.All ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' channel ]
* [ ''integer'' channelnumber = "0" ]
* [ ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = "tv" ]
* [ ''string'' endtime ]
* [ ''boolean'' hidden = false ]
* [ ''boolean'' locked = false ]
* [ ''string'' starttime ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Item.Base"
],
"id": "List.Item.All",
"properties": {
"channel": {
"default": "",
"type": "string",
"name": "channel"
},
"channelnumber": {
"default": "0",
"type": "integer",
"name": "channelnumber"
},
"channeltype": {
"default": "tv",
"$ref": "PVR.Channel.Type",
"name": "channeltype"
},
"endtime": {
"default": "",
"type": "string",
"name": "endtime"
},
"hidden": {
"default": "false",
"type": "boolean",
"name": "hidden"
},
"locked": {
"default": "false",
"type": "boolean",
"name": "locked"
},
"starttime": {
"default": "",
"type": "string",
"name": "starttime"
}
}
}</syntaxhighlight>}}

==== List.Item.Base ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' album ]
* [ ''[[#Array.String|Array.String]]'' albumartist ]
* [ ''[[#Array.Integer|Array.Integer]]'' albumartistid ]
* [ ''[[#Library.Id|Library.Id]]'' albumid = "-1" ]
* [ ''string'' albumlabel ]
* [ ''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' albumreleasetype = "album" ]
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''string'' comment ]
* [ ''boolean'' compilation = false ]
* [ ''[[#Audio.Contributors|Audio.Contributors]]'' contributors ]
* [ ''[[#Array.String|Array.String]]'' country ]
* [ ''string'' description ]
* [ ''integer'' disc = "0" ]
* [ ''string'' displaycomposer ]
* [ ''string'' displayconductor ]
* [ ''string'' displaylyricist ]
* [ ''string'' displayorchestra ]
* [ ''integer'' duration = "0" ]
* [ ''integer'' episode = "0" ]
* [ ''string'' episodeguide ]
* [ ''string'' firstaired ]
* [ ''[[#Library.Id|Library.Id]]'' id = "-1" ]
* [ ''string'' imdbnumber ]
* [ ''string'' lyrics ]
* [ ''[[#Array.String|Array.String]]'' mood ]
* [ ''string'' mpaa ]
* [ ''string'' musicbrainzartistid ]
* [ ''string'' musicbrainztrackid ]
* [ ''string'' originaltitle ]
* [ ''string'' plotoutline ]
* [ ''string'' premiered ]
* [ ''string'' productioncode ]
* [ ''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = "album" ]
* [ ''integer'' season = "0" ]
* [ ''string'' set ]
* [ ''[[#Library.Id|Library.Id]]'' setid = "-1" ]
* [ ''[[#Array.String|Array.String]]'' showlink ]
* [ ''string'' showtitle ]
* [ ''string'' sorttitle ]
* [ ''integer'' specialsortepisode = "0" ]
* [ ''integer'' specialsortseason = "0" ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''[[#Array.String|Array.String]]'' style ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* [ ''string'' tagline ]
* [ ''[[#Array.String|Array.String]]'' theme ]
* [ ''integer'' top250 = "0" ]
* [ ''integer'' track = "0" ]
* [ ''string'' trailer ]
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
* [ ''string'' type = "unknown" ]
* [ ''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid ]
* [ ''string'' votes ]
* [ ''integer'' watchedepisodes = "0" ]
* [ ''[[#Array.String|Array.String]]'' writer ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.File",
"Audio.Details.Media"
],
"id": "List.Item.Base",
"properties": {
"album": {
"default": "",
"type": "string",
"name": "album"
},
"albumartist": {
"$ref": "Array.String",
"name": "albumartist"
},
"albumartistid": {
"$ref": "Array.Integer",
"name": "albumartistid"
},
"albumid": {
"default": "-1",
"$ref": "Library.Id",
"name": "albumid"
},
"albumlabel": {
"default": "",
"type": "string",
"name": "albumlabel"
},
"albumreleasetype": {
"default": "album",
"$ref": "Audio.Album.ReleaseType",
"name": "albumreleasetype"
},
"cast": {
"$ref": "Video.Cast",
"name": "cast"
},
"comment": {
"default": "",
"type": "string",
"name": "comment"
},
"compilation": {
"default": "false",
"type": "boolean",
"name": "compilation"
},
"contributors": {
"$ref": "Audio.Contributors",
"name": "contributors"
},
"country": {
"$ref": "Array.String",
"name": "country"
},
"description": {
"default": "",
"type": "string",
"name": "description"
},
"disc": {
"default": "0",
"type": "integer",
"name": "disc"
},
"displaycomposer": {
"default": "",
"type": "string",
"name": "displaycomposer"
},
"displayconductor": {
"default": "",
"type": "string",
"name": "displayconductor"
},
"displaylyricist": {
"default": "",
"type": "string",
"name": "displaylyricist"
},
"displayorchestra": {
"default": "",
"type": "string",
"name": "displayorchestra"
},
"duration": {
"default": "0",
"type": "integer",
"name": "duration"
},
"episode": {
"default": "0",
"type": "integer",
"name": "episode"
},
"episodeguide": {
"default": "",
"type": "string",
"name": "episodeguide"
},
"firstaired": {
"default": "",
"type": "string",
"name": "firstaired"
},
"id": {
"default": "-1",
"$ref": "Library.Id",
"name": "id"
},
"imdbnumber": {
"default": "",
"type": "string",
"name": "imdbnumber"
},
"lyrics": {
"default": "",
"type": "string",
"name": "lyrics"
},
"mood": {
"$ref": "Array.String",
"name": "mood"
},
"mpaa": {
"default": "",
"type": "string",
"name": "mpaa"
},
"musicbrainzartistid": {
"default": "",
"type": "string",
"name": "musicbrainzartistid"
},
"musicbrainztrackid": {
"default": "",
"type": "string",
"name": "musicbrainztrackid"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"plotoutline": {
"default": "",
"type": "string",
"name": "plotoutline"
},
"premiered": {
"default": "",
"type": "string",
"name": "premiered"
},
"productioncode": {
"default": "",
"type": "string",
"name": "productioncode"
},
"releasetype": {
"default": "album",
"$ref": "Audio.Album.ReleaseType",
"name": "releasetype"
},
"season": {
"default": "0",
"type": "integer",
"name": "season"
},
"set": {
"default": "",
"type": "string",
"name": "set"
},
"setid": {
"default": "-1",
"$ref": "Library.Id",
"name": "setid"
},
"showlink": {
"$ref": "Array.String",
"name": "showlink"
},
"showtitle": {
"default": "",
"type": "string",
"name": "showtitle"
},
"sorttitle": {
"default": "",
"type": "string",
"name": "sorttitle"
},
"specialsortepisode": {
"default": "0",
"type": "integer",
"name": "specialsortepisode"
},
"specialsortseason": {
"default": "0",
"type": "integer",
"name": "specialsortseason"
},
"studio": {
"$ref": "Array.String",
"name": "studio"
},
"style": {
"$ref": "Array.String",
"name": "style"
},
"tag": {
"$ref": "Array.String",
"name": "tag"
},
"tagline": {
"default": "",
"type": "string",
"name": "tagline"
},
"theme": {
"$ref": "Array.String",
"name": "theme"
},
"top250": {
"default": "0",
"type": "integer",
"name": "top250"
},
"track": {
"default": "0",
"type": "integer",
"name": "track"
},
"trailer": {
"default": "",
"type": "string",
"name": "trailer"
},
"tvshowid": {
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
"type": {
"default": "unknown",
"type": "string",
"name": "type"
},
"uniqueid": {
"$ref": "Media.UniqueID",
"name": "uniqueid"
},
"votes": {
"default": "",
"type": "string",
"name": "votes"
},
"watchedepisodes": {
"default": "0",
"type": "integer",
"name": "watchedepisodes"
},
"writer": {
"$ref": "Array.String",
"name": "writer"
}
}
}</syntaxhighlight>}}

==== List.Item.File ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' file
* ''string'' filetype
* [ ''string'' lastmodified ]
* [ ''string'' mimetype ]
* [ ''integer'' size = "0" ] ''Size of the file in bytes''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Item.Base"
],
"id": "List.Item.File",
"properties": {
"file": {
"type": "string",
"name": "file",
"required": true
},
"filetype": {
"type": "string",
"name": "filetype",
"required": true
},
"lastmodified": {
"default": "",
"type": "string",
"name": "lastmodified"
},
"mimetype": {
"default": "",
"type": "string",
"name": "mimetype"
},
"size": {
"default": "0",
"description": "Size of the file in bytes",
"type": "integer",
"name": "size"
}
}
}</syntaxhighlight>}}

==== List.Items.Sources ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.Items.Sources",
"type": "array",
"items": {
"extends": "Item.Details.Base",
"properties": {
"file": {
"required": true,
"type": "string"
}
}
}
}</syntaxhighlight>}}

==== List.Limits ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#List.Amount|List.Amount]]'' end = "-1" ] ''Index of the last item to return''
* [ ''integer'' start = "0" ] ''Index of the first item to return''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.Limits",
"type": "object",
"properties": {
"end": {
"default": "-1",
"description": "Index of the last item to return",
"$ref": "List.Amount",
"name": "end"
},
"start": {
"default": "0",
"description": "Index of the first item to return",
"type": "integer",
"name": "start"
}
}
}</syntaxhighlight>}}

==== List.LimitsReturned ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#List.Amount|List.Amount]]'' end = "-1" ]
* [ ''integer'' start = "0" ]
* ''integer'' total
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.LimitsReturned",
"type": "object",
"properties": {
"end": {
"default": "-1",
"$ref": "List.Amount",
"name": "end"
},
"start": {
"default": "0",
"type": "integer",
"name": "start"
},
"total": {
"type": "integer",
"name": "total",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Sort ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' ignorearticle = false ]
* [ ''string'' method = "none" ]
* [ ''string'' order = "ascending" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.Sort",
"type": "object",
"properties": {
"ignorearticle": {
"default": "false",
"type": "boolean",
"name": "ignorearticle"
},
"method": {
"default": "none",
"type": "string",
"name": "method"
},
"order": {
"default": "ascending",
"type": "string",
"name": "order"
}
}
}</syntaxhighlight>}}

=== Media ===
==== Media.Artwork ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' banner ]
* [ ''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' fanart ]
* [ ''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' poster ]
* [ ''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' thumb ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Media.Artwork",
"type": "object",
"properties": {
"banner": {
"default": "",
"$ref": "Global.String.NotEmpty",
"name": "banner"
},
"fanart": {
"default": "",
"$ref": "Global.String.NotEmpty",
"name": "fanart"
},
"poster": {
"default": "",
"$ref": "Global.String.NotEmpty",
"name": "poster"
},
"thumb": {
"default": "",
"$ref": "Global.String.NotEmpty",
"name": "thumb"
}
}
}</syntaxhighlight>}}

==== Media.Artwork.Set ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''mixed'' banner ]
* [ ''mixed'' fanart ]
* [ ''mixed'' poster ]
* [ ''mixed'' thumb ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Media.Artwork.Set",
"type": "object",
"properties": {
"banner": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
],
"name": "banner"
},
"fanart": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
],
"name": "fanart"
},
"poster": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
],
"name": "poster"
},
"thumb": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
],
"name": "thumb"
}
}
}</syntaxhighlight>}}

==== Media.Details.Base ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' fanart ]
* [ ''string'' thumbnail ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Media.Details.Base",
"properties": {
"fanart": {
"default": "",
"type": "string",
"name": "fanart"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
}
}
}</syntaxhighlight>}}

==== Media.UniqueID ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Media.UniqueID",
"type": "object"
}</syntaxhighlight>}}

==== Media.UniqueID.Set ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Media.UniqueID.Set",
"type": "object"
}</syntaxhighlight>}}

=== Notifications ===
==== Notifications.Item ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== Notifications.Item.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"unknown",
"movie",
"episode",
"musicvideo",
"song",
"picture",
"channel"
],
"id": "Notifications.Item.Type",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

=== Optional ===
==== Optional.Boolean ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Optional.Boolean",
"type": [
{
"type": "null"
},
{
"type": "boolean"
}
]
}</syntaxhighlight>}}

==== Optional.Integer ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Optional.Integer",
"type": [
{
"type": "null"
},
{
"type": "integer"
}
]
}</syntaxhighlight>}}

==== Optional.Number ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Optional.Number",
"type": [
{
"type": "null"
},
{
"type": "number"
}
]
}</syntaxhighlight>}}

==== Optional.String ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Optional.String",
"type": [
{
"type": "null"
},
{
"type": "string"
}
]
}</syntaxhighlight>}}

=== Player ===
==== Player.Audio.Stream ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' bitrate
* ''integer'' channels
* ''string'' codec
* ''integer'' index
* ''string'' language
* ''string'' name
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Audio.Stream",
"type": "object",
"properties": {
"bitrate": {
"type": "integer",
"name": "bitrate",
"required": true
},
"channels": {
"type": "integer",
"name": "channels",
"required": true
},
"codec": {
"type": "string",
"name": "codec",
"required": true
},
"index": {
"type": "integer",
"name": "index",
"required": true
},
"language": {
"type": "string",
"name": "language",
"required": true
},
"name": {
"type": "string",
"name": "name",
"required": true
}
}
}</syntaxhighlight>}}

==== Player.Id ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Id",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

==== Player.Notifications.Data ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Notifications.Item|Notifications.Item]]'' item
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Notifications.Data",
"type": "object",
"properties": {
"item": {
"$ref": "Notifications.Item",
"name": "item",
"required": true
},
"player": {
"$ref": "Player.Notifications.Player",
"name": "player",
"required": true
}
}
}</syntaxhighlight>}}

==== Player.Notifications.Player ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Player.Id|Player.Id]]'' playerid
* [ ''integer'' speed = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Notifications.Player",
"type": "object",
"properties": {
"playerid": {
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
"speed": {
"default": "0",
"type": "integer",
"name": "speed"
}
}
}</syntaxhighlight>}}

==== Player.Notifications.Player.Seek ====
'''Extends:'''
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Global.Time|Global.Time]]'' seekoffset ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Player.Notifications.Player"
],
"id": "Player.Notifications.Player.Seek",
"properties": {
"seekoffset": {
"$ref": "Global.Time",
"name": "seekoffset"
},
"time": {
"$ref": "Global.Time",
"name": "time"
}
}
}</syntaxhighlight>}}

==== Player.Position.Percentage ====
'''Type:''' ''number''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Position.Percentage",
"type": "number",
"default": 0
}</syntaxhighlight>}}

==== Player.Position.Time ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' hours = "0" ]
* [ ''integer'' milliseconds = "0" ]
* [ ''integer'' minutes = "0" ]
* [ ''integer'' seconds = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Position.Time",
"type": "object",
"properties": {
"hours": {
"default": "0",
"type": "integer",
"name": "hours"
},
"milliseconds": {
"default": "0",
"type": "integer",
"name": "milliseconds"
},
"minutes": {
"default": "0",
"type": "integer",
"name": "minutes"
},
"seconds": {
"default": "0",
"type": "integer",
"name": "seconds"
}
}
}</syntaxhighlight>}}

==== Player.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"type",
"partymode",
"speed",
"time",
"percentage",
"totaltime",
"playlistid",
"position",
"repeat",
"shuffled",
"canseek",
"canchangespeed",
"canmove",
"canzoom",
"canrotate",
"canshuffle",
"canrepeat",
"currentaudiostream",
"audiostreams",
"subtitleenabled",
"currentsubtitle",
"subtitles",
"live",
"currentvideostream",
"videostreams"
],
"id": "Player.Property.Name",
"type": "string",
"default": "type"
}</syntaxhighlight>}}

==== Player.Property.Value ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Player.Audio.Stream|Player.Audio.Stream]]''[] audiostreams ]
* [ ''boolean'' canchangespeed = false ]
* [ ''boolean'' canmove = false ]
* [ ''boolean'' canrepeat = false ]
* [ ''boolean'' canrotate = false ]
* [ ''boolean'' canseek = false ]
* [ ''boolean'' canshuffle = false ]
* [ ''boolean'' canzoom = false ]
* [ ''[[#Player.Audio.Stream|Player.Audio.Stream]]'' currentaudiostream ]
* [ ''[[#Player.Subtitle|Player.Subtitle]]'' currentsubtitle ]
* [ ''[[#Player.Video.Stream|Player.Video.Stream]]'' currentvideostream ]
* [ ''boolean'' live = false ]
* [ ''boolean'' partymode = false ]
* [ ''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage = "0" ]
* [ ''[[#Playlist.Id|Playlist.Id]]'' playlistid = "-1" ]
* [ ''[[#Playlist.Position|Playlist.Position]]'' position = "-1" ]
* [ ''[[#Player.Repeat|Player.Repeat]]'' repeat = "off" ]
* [ ''boolean'' shuffled = false ]
* [ ''integer'' speed = "0" ]
* [ ''boolean'' subtitleenabled = false ]
* [ ''[[#Player.Subtitle|Player.Subtitle]]''[] subtitles ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
* [ ''[[#Global.Time|Global.Time]]'' totaltime ]
* [ ''[[#Player.Type|Player.Type]]'' type = "video" ]
* [ ''[[#Player.Video.Stream|Player.Video.Stream]]''[] videostreams ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Property.Value",
"type": "object",
"properties": {
"audiostreams": {
"items": {
"$ref": "Player.Audio.Stream"
},
"type": "array",
"name": "audiostreams"
},
"canchangespeed": {
"default": "false",
"type": "boolean",
"name": "canchangespeed"
},
"canmove": {
"default": "false",
"type": "boolean",
"name": "canmove"
},
"canrepeat": {
"default": "false",
"type": "boolean",
"name": "canrepeat"
},
"canrotate": {
"default": "false",
"type": "boolean",
"name": "canrotate"
},
"canseek": {
"default": "false",
"type": "boolean",
"name": "canseek"
},
"canshuffle": {
"default": "false",
"type": "boolean",
"name": "canshuffle"
},
"canzoom": {
"default": "false",
"type": "boolean",
"name": "canzoom"
},
"currentaudiostream": {
"$ref": "Player.Audio.Stream",
"name": "currentaudiostream"
},
"currentsubtitle": {
"$ref": "Player.Subtitle",
"name": "currentsubtitle"
},
"currentvideostream": {
"$ref": "Player.Video.Stream",
"name": "currentvideostream"
},
"live": {
"default": "false",
"type": "boolean",
"name": "live"
},
"partymode": {
"default": "false",
"type": "boolean",
"name": "partymode"
},
"percentage": {
"default": "0",
"$ref": "Player.Position.Percentage",
"name": "percentage"
},
"playlistid": {
"default": "-1",
"$ref": "Playlist.Id",
"name": "playlistid"
},
"position": {
"default": "-1",
"$ref": "Playlist.Position",
"name": "position"
},
"repeat": {
"default": "off",
"$ref": "Player.Repeat",
"name": "repeat"
},
"shuffled": {
"default": "false",
"type": "boolean",
"name": "shuffled"
},
"speed": {
"default": "0",
"type": "integer",
"name": "speed"
},
"subtitleenabled": {
"default": "false",
"type": "boolean",
"name": "subtitleenabled"
},
"subtitles": {
"items": {
"$ref": "Player.Subtitle"
},
"type": "array",
"name": "subtitles"
},
"time": {
"$ref": "Global.Time",
"name": "time"
},
"totaltime": {
"$ref": "Global.Time",
"name": "totaltime"
},
"type": {
"default": "video",
"$ref": "Player.Type",
"name": "type"
},
"videostreams": {
"items": {
"$ref": "Player.Video.Stream"
},
"type": "array",
"name": "videostreams"
}
}
}</syntaxhighlight>}}

==== Player.Repeat ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"off",
"one",
"all"
],
"id": "Player.Repeat",
"type": "string",
"default": "off"
}</syntaxhighlight>}}

==== Player.Speed ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' speed = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Speed",
"type": "object",
"properties": {
"speed": {
"default": "0",
"type": "integer",
"name": "speed"
}
}
}</syntaxhighlight>}}

==== Player.Subtitle ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' index
* ''string'' language
* ''string'' name
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Subtitle",
"type": "object",
"properties": {
"index": {
"type": "integer",
"name": "index",
"required": true
},
"language": {
"type": "string",
"name": "language",
"required": true
},
"name": {
"type": "string",
"name": "name",
"required": true
}
}
}</syntaxhighlight>}}

==== Player.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"video",
"audio",
"picture"
],
"id": "Player.Type",
"type": "string",
"default": "video"
}</syntaxhighlight>}}

==== Player.Video.Stream ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' codec
* ''integer'' height
* ''integer'' index
* ''string'' language
* ''string'' name
* ''integer'' width
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Video.Stream",
"type": "object",
"properties": {
"codec": {
"type": "string",
"name": "codec",
"required": true
},
"height": {
"type": "integer",
"name": "height",
"required": true
},
"index": {
"type": "integer",
"name": "index",
"required": true
},
"language": {
"type": "string",
"name": "language",
"required": true
},
"name": {
"type": "string",
"name": "name",
"required": true
},
"width": {
"type": "integer",
"name": "width",
"required": true
}
}
}</syntaxhighlight>}}

=== Playlist ===
==== Playlist.Id ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Playlist.Id",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

==== Playlist.Item ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== Playlist.Position ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Playlist.Position",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

==== Playlist.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"type",
"size"
],
"id": "Playlist.Property.Name",
"type": "string",
"default": "type"
}</syntaxhighlight>}}

==== Playlist.Property.Value ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' size = "0" ]
* [ ''[[#Playlist.Type|Playlist.Type]]'' type = "unknown" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Playlist.Property.Value",
"type": "object",
"properties": {
"size": {
"default": "0",
"type": "integer",
"name": "size"
},
"type": {
"default": "unknown",
"$ref": "Playlist.Type",
"name": "type"
}
}
}</syntaxhighlight>}}

==== Playlist.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"unknown",
"video",
"audio",
"picture",
"mixed"
],
"id": "Playlist.Type",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

=== Profiles ===
==== Profiles.Details.Profile ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' lockmode = "0" ]
* [ ''string'' thumbnail ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Profiles.Details.Profile",
"properties": {
"lockmode": {
"default": "0",
"type": "integer",
"name": "lockmode"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
}
}
}</syntaxhighlight>}}

==== Profiles.Fields.Profile ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Profiles.Fields.Profile",
"items": {
"enums": [
"thumbnail",
"lockmode"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Profiles.Password ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' encryption = "md5" ] ''Password Encryption''
* ''string'' value ''Password''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Profiles.Password",
"type": "object",
"properties": {
"encryption": {
"default": "md5",
"description": "Password Encryption",
"type": "string",
"name": "encryption"
},
"value": {
"description": "Password",
"type": "string",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

=== PVR ===
==== PVR.Channel.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"tv",
"radio"
],
"id": "PVR.Channel.Type",
"type": "string",
"default": "tv"
}</syntaxhighlight>}}

==== PVR.ChannelGroup.Id ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "PVR.ChannelGroup.Id",
"type": [
{
"$ref": "Library.Id"
},
{
"enums": [
"alltv",
"allradio"
],
"type": "string"
}
]
}</syntaxhighlight>}}

==== PVR.Details.Broadcast ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' broadcastid
* [ ''string'' cast ]
* [ ''string'' director ]
* [ ''string'' endtime ]
* [ ''string'' episodename ]
* [ ''integer'' episodenum = "0" ]
* [ ''integer'' episodepart = "0" ]
* [ ''string'' firstaired ]
* [ ''string'' genre ]
* [ ''boolean'' hasrecording = false ]
* [ ''boolean'' hastimer = false ]
* [ ''boolean'' hastimerrule = false ]
* [ ''integer'' imdbnumber = "0" ]
* [ ''boolean'' isactive = false ]
* [ ''boolean'' isseries = false ]
* [ ''string'' originaltitle ]
* [ ''integer'' parentalrating = "0" ]
* [ ''string'' plot ]
* [ ''string'' plotoutline ]
* [ ''integer'' progress = "0" ]
* [ ''number'' progresspercentage = "0" ]
* [ ''integer'' rating = "0" ]
* [ ''string'' recording ]
* [ ''integer'' runtime = "0" ]
* [ ''string'' starttime ]
* [ ''string'' thumbnail ]
* [ ''string'' title ]
* [ ''boolean'' wasactive = false ]
* [ ''string'' writer ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.Broadcast",
"properties": {
"broadcastid": {
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
"cast": {
"default": "",
"type": "string",
"name": "cast"
},
"director": {
"default": "",
"type": "string",
"name": "director"
},
"endtime": {
"default": "",
"type": "string",
"name": "endtime"
},
"episodename": {
"default": "",
"type": "string",
"name": "episodename"
},
"episodenum": {
"default": "0",
"type": "integer",
"name": "episodenum"
},
"episodepart": {
"default": "0",
"type": "integer",
"name": "episodepart"
},
"firstaired": {
"default": "",
"type": "string",
"name": "firstaired"
},
"genre": {
"default": "",
"type": "string",
"name": "genre"
},
"hasrecording": {
"default": "false",
"type": "boolean",
"name": "hasrecording"
},
"hastimer": {
"default": "false",
"type": "boolean",
"name": "hastimer"
},
"hastimerrule": {
"default": "false",
"type": "boolean",
"name": "hastimerrule"
},
"imdbnumber": {
"default": "0",
"type": "integer",
"name": "imdbnumber"
},
"isactive": {
"default": "false",
"type": "boolean",
"name": "isactive"
},
"isseries": {
"default": "false",
"type": "boolean",
"name": "isseries"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"parentalrating": {
"default": "0",
"type": "integer",
"name": "parentalrating"
},
"plot": {
"default": "",
"type": "string",
"name": "plot"
},
"plotoutline": {
"default": "",
"type": "string",
"name": "plotoutline"
},
"progress": {
"default": "0",
"type": "integer",
"name": "progress"
},
"progresspercentage": {
"default": "0",
"type": "number",
"name": "progresspercentage"
},
"rating": {
"default": "0",
"type": "integer",
"name": "rating"
},
"recording": {
"default": "",
"type": "string",
"name": "recording"
},
"runtime": {
"default": "0",
"type": "integer",
"name": "runtime"
},
"starttime": {
"default": "",
"type": "string",
"name": "starttime"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"title": {
"default": "",
"type": "string",
"name": "title"
},
"wasactive": {
"default": "false",
"type": "boolean",
"name": "wasactive"
},
"writer": {
"default": "",
"type": "string",
"name": "writer"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== PVR.Details.Channel ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastnext ]
* [ ''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastnow ]
* [ ''string'' channel ]
* ''[[#Library.Id|Library.Id]]'' channelid
* [ ''integer'' channelnumber = "0" ]
* [ ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = "tv" ]
* [ ''boolean'' hidden = false ]
* [ ''string'' icon ]
* [ ''boolean'' isrecording = false ]
* [ ''string'' lastplayed ]
* [ ''boolean'' locked = false ]
* [ ''integer'' subchannelnumber = "0" ]
* [ ''string'' thumbnail ]
* ''integer'' uniqueid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.Channel",
"properties": {
"broadcastnext": {
"$ref": "PVR.Details.Broadcast",
"name": "broadcastnext"
},
"broadcastnow": {
"$ref": "PVR.Details.Broadcast",
"name": "broadcastnow"
},
"channel": {
"default": "",
"type": "string",
"name": "channel"
},
"channelid": {
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
"channelnumber": {
"default": "0",
"type": "integer",
"name": "channelnumber"
},
"channeltype": {
"default": "tv",
"$ref": "PVR.Channel.Type",
"name": "channeltype"
},
"hidden": {
"default": "false",
"type": "boolean",
"name": "hidden"
},
"icon": {
"default": "",
"type": "string",
"name": "icon"
},
"isrecording": {
"default": "false",
"type": "boolean",
"name": "isrecording"
},
"lastplayed": {
"default": "",
"type": "string",
"name": "lastplayed"
},
"locked": {
"default": "false",
"type": "boolean",
"name": "locked"
},
"subchannelnumber": {
"default": "0",
"type": "integer",
"name": "subchannelnumber"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"uniqueid": {
"type": "integer",
"name": "uniqueid",
"required": true
}
}
}</syntaxhighlight>}}

==== PVR.Details.ChannelGroup ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' channelgroupid
* ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.ChannelGroup",
"properties": {
"channelgroupid": {
"$ref": "Library.Id",
"name": "channelgroupid",
"required": true
},
"channeltype": {
"$ref": "PVR.Channel.Type",
"name": "channeltype",
"required": true
}
}
}</syntaxhighlight>}}

==== PVR.Details.ChannelGroup.Extended ====
'''Extends:'''
* ''[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#PVR.Details.Channel|PVR.Details.Channel]]''[] channels ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"PVR.Details.ChannelGroup"
],
"id": "PVR.Details.ChannelGroup.Extended",
"properties": {
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"type": "array",
"name": "channels"
},
"limits": {
"$ref": "List.LimitsReturned",
"name": "limits",
"required": true
}
}
}</syntaxhighlight>}}

==== PVR.Details.Recording ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Media.Artwork|Media.Artwork]]'' art ]
* [ ''string'' channel ]
* [ ''integer'' channeluid = "0" ]
* [ ''string'' directory ]
* [ ''string'' endtime ]
* [ ''integer'' epgeventid = "0" ]
* [ ''string'' file ]
* [ ''string'' genre ]
* [ ''string'' icon ]
* [ ''boolean'' isdeleted = false ]
* [ ''integer'' lifetime = "0" ]
* [ ''integer'' playcount = "0" ]
* [ ''string'' plot ]
* [ ''string'' plotoutline ]
* [ ''boolean'' radio = false ]
* ''[[#Library.Id|Library.Id]]'' recordingid
* [ ''[[#Video.Resume|Video.Resume]]'' resume ]
* [ ''integer'' runtime = "0" ]
* [ ''string'' starttime ]
* [ ''string'' streamurl ]
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.Recording",
"properties": {
"art": {
"$ref": "Media.Artwork",
"name": "art"
},
"channel": {
"default": "",
"type": "string",
"name": "channel"
},
"channeluid": {
"default": "0",
"type": "integer",
"name": "channeluid"
},
"directory": {
"default": "",
"type": "string",
"name": "directory"
},
"endtime": {
"default": "",
"type": "string",
"name": "endtime"
},
"epgeventid": {
"default": "0",
"type": "integer",
"name": "epgeventid"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"genre": {
"default": "",
"type": "string",
"name": "genre"
},
"icon": {
"default": "",
"type": "string",
"name": "icon"
},
"isdeleted": {
"default": "false",
"type": "boolean",
"name": "isdeleted"
},
"lifetime": {
"default": "0",
"type": "integer",
"name": "lifetime"
},
"playcount": {
"default": "0",
"type": "integer",
"name": "playcount"
},
"plot": {
"default": "",
"type": "string",
"name": "plot"
},
"plotoutline": {
"default": "",
"type": "string",
"name": "plotoutline"
},
"radio": {
"default": "false",
"type": "boolean",
"name": "radio"
},
"recordingid": {
"$ref": "Library.Id",
"name": "recordingid",
"required": true
},
"resume": {
"$ref": "Video.Resume",
"name": "resume"
},
"runtime": {
"default": "0",
"type": "integer",
"name": "runtime"
},
"starttime": {
"default": "",
"type": "string",
"name": "starttime"
},
"streamurl": {
"default": "",
"type": "string",
"name": "streamurl"
},
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== PVR.Details.Timer ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Library.Id|Library.Id]]'' channelid = "-1" ]
* [ ''string'' directory ]
* [ ''boolean'' endanytime = false ]
* [ ''integer'' endmargin = "0" ]
* [ ''string'' endtime ]
* [ ''string'' epgsearchstring ]
* [ ''integer'' epguid = "0" ]
* [ ''string'' file ]
* [ ''string'' firstday ]
* [ ''boolean'' fulltextepgsearch = false ]
* [ ''boolean'' ismanual = false ]
* [ ''boolean'' isradio = false ]
* [ ''boolean'' isreadonly = false ]
* [ ''boolean'' istimerrule = false ]
* [ ''integer'' lifetime = "0" ]
* [ ''integer'' maxrecordings = "0" ]
* [ ''integer'' preventduplicateepisodes = "0" ]
* [ ''integer'' priority = "0" ]
* [ ''integer'' recordinggroup = "0" ]
* [ ''integer'' runtime = "0" ]
* [ ''boolean'' startanytime = false ]
* [ ''integer'' startmargin = "0" ]
* [ ''string'' starttime ]
* [ ''[[#PVR.TimerState|PVR.TimerState]]'' state = "unknown" ]
* [ ''string'' summary ]
* ''[[#Library.Id|Library.Id]]'' timerid
* [ ''string'' title ]
* [ ''[[#Global.Weekday|Global.Weekday]]''[] weekdays ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.Timer",
"properties": {
"channelid": {
"default": "-1",
"$ref": "Library.Id",
"name": "channelid"
},
"directory": {
"default": "",
"type": "string",
"name": "directory"
},
"endanytime": {
"default": "false",
"type": "boolean",
"name": "endanytime"
},
"endmargin": {
"default": "0",
"type": "integer",
"name": "endmargin"
},
"endtime": {
"default": "",
"type": "string",
"name": "endtime"
},
"epgsearchstring": {
"default": "",
"type": "string",
"name": "epgsearchstring"
},
"epguid": {
"default": "0",
"type": "integer",
"name": "epguid"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"firstday": {
"default": "",
"type": "string",
"name": "firstday"
},
"fulltextepgsearch": {
"default": "false",
"type": "boolean",
"name": "fulltextepgsearch"
},
"ismanual": {
"default": "false",
"type": "boolean",
"name": "ismanual"
},
"isradio": {
"default": "false",
"type": "boolean",
"name": "isradio"
},
"isreadonly": {
"default": "false",
"type": "boolean",
"name": "isreadonly"
},
"istimerrule": {
"default": "false",
"type": "boolean",
"name": "istimerrule"
},
"lifetime": {
"default": "0",
"type": "integer",
"name": "lifetime"
},
"maxrecordings": {
"default": "0",
"type": "integer",
"name": "maxrecordings"
},
"preventduplicateepisodes": {
"default": "0",
"type": "integer",
"name": "preventduplicateepisodes"
},
"priority": {
"default": "0",
"type": "integer",
"name": "priority"
},
"recordinggroup": {
"default": "0",
"type": "integer",
"name": "recordinggroup"
},
"runtime": {
"default": "0",
"type": "integer",
"name": "runtime"
},
"startanytime": {
"default": "false",
"type": "boolean",
"name": "startanytime"
},
"startmargin": {
"default": "0",
"type": "integer",
"name": "startmargin"
},
"starttime": {
"default": "",
"type": "string",
"name": "starttime"
},
"state": {
"default": "unknown",
"$ref": "PVR.TimerState",
"name": "state"
},
"summary": {
"default": "",
"type": "string",
"name": "summary"
},
"timerid": {
"$ref": "Library.Id",
"name": "timerid",
"required": true
},
"title": {
"default": "",
"type": "string",
"name": "title"
},
"weekdays": {
"items": {
"$ref": "Global.Weekday"
},
"type": "array",
"name": "weekdays"
}
}
}</syntaxhighlight>}}

==== PVR.Fields.Broadcast ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "PVR.Fields.Broadcast",
"items": {
"enums": [
"title",
"plot",
"plotoutline",
"starttime",
"endtime",
"runtime",
"progress",
"progresspercentage",
"genre",
"episodename",
"episodenum",
"episodepart",
"firstaired",
"hastimer",
"isactive",
"parentalrating",
"wasactive",
"thumbnail",
"rating",
"originaltitle",
"cast",
"director",
"writer",
"year",
"imdbnumber",
"hastimerrule",
"hasrecording",
"recording",
"isseries"
],
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Fields.Channel ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "PVR.Fields.Channel",
"items": {
"enums": [
"thumbnail",
"channeltype",
"hidden",
"locked",
"channel",
"lastplayed",
"broadcastnow",
"broadcastnext",
"uniqueid",
"icon",
"channelnumber",
"subchannelnumber",
"isrecording"
],
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Fields.Recording ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "PVR.Fields.Recording",
"items": {
"enums": [
"title",
"plot",
"plotoutline",
"genre",
"playcount",
"resume",
"channel",
"starttime",
"endtime",
"runtime",
"lifetime",
"icon",
"art",
"streamurl",
"file",
"directory",
"radio",
"isdeleted",
"epgeventid",
"channeluid"
],
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Fields.Timer ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "PVR.Fields.Timer",
"items": {
"enums": [
"title",
"summary",
"channelid",
"isradio",
"istimerrule",
"ismanual",
"starttime",
"endtime",
"runtime",
"lifetime",
"firstday",
"weekdays",
"priority",
"startmargin",
"endmargin",
"state",
"file",
"directory",
"preventduplicateepisodes",
"startanytime",
"endanytime",
"epgsearchstring",
"fulltextepgsearch",
"recordinggroup",
"maxrecordings",
"epguid",
"isreadonly"
],
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"available",
"recording",
"scanning"
],
"id": "PVR.Property.Name",
"type": "string",
"default": "available"
}</syntaxhighlight>}}

==== PVR.Property.Value ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' available = false ]
* [ ''boolean'' recording = false ]
* [ ''boolean'' scanning = false ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "PVR.Property.Value",
"type": "object",
"properties": {
"available": {
"default": "false",
"type": "boolean",
"name": "available"
},
"recording": {
"default": "false",
"type": "boolean",
"name": "recording"
},
"scanning": {
"default": "false",
"type": "boolean",
"name": "scanning"
}
}
}</syntaxhighlight>}}

==== PVR.TimerState ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"unknown",
"new",
"scheduled",
"recording",
"completed",
"aborted",
"cancelled",
"conflict_ok",
"conflict_notok",
"error",
"disabled"
],
"id": "PVR.TimerState",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

=== Setting ===
==== Setting.Details.Base ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' help ]
* ''string'' id
* ''string'' label
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Details.Base",
"type": "object",
"properties": {
"help": {
"default": "",
"type": "string",
"name": "help"
},
"id": {
"type": "string",
"name": "id",
"required": true
},
"label": {
"type": "string",
"name": "label",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.Category ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Setting.Details.Group|Setting.Details.Group]]''[] groups ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.Base"
],
"id": "Setting.Details.Category",
"properties": {
"groups": {
"items": {
"$ref": "Setting.Details.Group"
},
"type": "array",
"name": "groups"
}
}
}</syntaxhighlight>}}

==== Setting.Details.Control ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== Setting.Details.ControlBase ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' delayed
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Details.ControlBase",
"type": "object",
"properties": {
"delayed": {
"type": "boolean",
"name": "delayed",
"required": true
},
"format": {
"type": "string",
"name": "format",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlButton ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlHeading"
],
"id": "Setting.Details.ControlButton",
"properties": {
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlCheckmark ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlBase"
],
"id": "Setting.Details.ControlCheckmark",
"properties": {
"format": {
"type": "string",
"name": "format",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlEdit ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' hidden
* ''string'' type
* ''boolean'' verifynewvalue
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlHeading"
],
"id": "Setting.Details.ControlEdit",
"properties": {
"hidden": {
"type": "boolean",
"name": "hidden",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
},
"verifynewvalue": {
"type": "boolean",
"name": "verifynewvalue",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlHeading ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' heading ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlBase"
],
"id": "Setting.Details.ControlHeading",
"properties": {
"heading": {
"default": "",
"type": "string",
"name": "heading"
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlList ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' multiselect
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlHeading"
],
"id": "Setting.Details.ControlList",
"properties": {
"multiselect": {
"type": "boolean",
"name": "multiselect",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlRange ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' formatlabel
* ''string'' formatvalue
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlBase"
],
"id": "Setting.Details.ControlRange",
"properties": {
"formatlabel": {
"type": "string",
"name": "formatlabel",
"required": true
},
"formatvalue": {
"type": "string",
"name": "formatvalue",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlSlider ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' formatlabel
* ''boolean'' popup
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlHeading"
],
"id": "Setting.Details.ControlSlider",
"properties": {
"formatlabel": {
"type": "string",
"name": "formatlabel",
"required": true
},
"popup": {
"type": "boolean",
"name": "popup",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlSpinner ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' formatlabel ]
* [ ''string'' minimumlabel ]
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlBase"
],
"id": "Setting.Details.ControlSpinner",
"properties": {
"formatlabel": {
"default": "",
"type": "string",
"name": "formatlabel"
},
"minimumlabel": {
"default": "",
"type": "string",
"name": "minimumlabel"
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.Group ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' id
* [ ''[[#Setting.Details.Setting|Setting.Details.Setting]]''[] settings ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Details.Group",
"type": "object",
"properties": {
"id": {
"type": "string",
"name": "id",
"required": true
},
"settings": {
"items": {
"$ref": "Setting.Details.Setting"
},
"type": "array",
"name": "settings"
}
}
}</syntaxhighlight>}}

==== Setting.Details.Section ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Setting.Details.Category|Setting.Details.Category]]''[] categories ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.Base"
],
"id": "Setting.Details.Section",
"properties": {
"categories": {
"items": {
"$ref": "Setting.Details.Category"
},
"type": "array",
"name": "categories"
}
}
}</syntaxhighlight>}}

==== Setting.Details.Setting ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== Setting.Details.SettingAction ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingAction"
}</syntaxhighlight>}}

==== Setting.Details.SettingAddon ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Addon.Types|Addon.Types]]'' addontype
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingString"
],
"id": "Setting.Details.SettingAddon",
"properties": {
"addontype": {
"$ref": "Addon.Types",
"name": "addontype",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingBase ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Setting.Details.Control|Setting.Details.Control]]'' control ]
* ''boolean'' enabled
* ''[[#Setting.Level|Setting.Level]]'' level
* [ ''string'' parent ]
* ''[[#Setting.Type|Setting.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.Base"
],
"id": "Setting.Details.SettingBase",
"properties": {
"control": {
"$ref": "Setting.Details.Control",
"name": "control"
},
"enabled": {
"type": "boolean",
"name": "enabled",
"required": true
},
"level": {
"$ref": "Setting.Level",
"name": "level",
"required": true
},
"parent": {
"default": "",
"type": "string",
"name": "parent"
},
"type": {
"$ref": "Setting.Type",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingBool ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' default
* ''boolean'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingBool",
"properties": {
"default": {
"type": "boolean",
"name": "default",
"required": true
},
"value": {
"type": "boolean",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingInt ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' default
* [ ''integer'' maximum = "0" ]
* [ ''integer'' minimum = "0" ]
* [ ''object'' options ]
* [ ''integer'' step = "0" ]
* ''integer'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingInt",
"properties": {
"default": {
"type": "integer",
"name": "default",
"required": true
},
"maximum": {
"default": "0",
"type": "integer",
"name": "maximum"
},
"minimum": {
"default": "0",
"type": "integer",
"name": "minimum"
},
"options": {
"items": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "integer"
}
},
"type": "object"
},
"type": "array",
"name": "options"
},
"step": {
"default": "0",
"type": "integer",
"name": "step"
},
"value": {
"type": "integer",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingList ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Setting.Value.List|Setting.Value.List]]'' default
* ''[[#Setting.Details.Setting|Setting.Details.Setting]]'' definition
* ''string'' delimiter
* ''[[#Setting.Type|Setting.Type]]'' elementtype
* [ ''integer'' maximumitems = "0" ]
* [ ''integer'' minimumitems = "0" ]
* ''[[#Setting.Value.List|Setting.Value.List]]'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingList",
"properties": {
"default": {
"$ref": "Setting.Value.List",
"name": "default",
"required": true
},
"definition": {
"$ref": "Setting.Details.Setting",
"name": "definition",
"required": true
},
"delimiter": {
"type": "string",
"name": "delimiter",
"required": true
},
"elementtype": {
"$ref": "Setting.Type",
"name": "elementtype",
"required": true
},
"maximumitems": {
"default": "0",
"type": "integer",
"name": "maximumitems"
},
"minimumitems": {
"default": "0",
"type": "integer",
"name": "minimumitems"
},
"value": {
"$ref": "Setting.Value.List",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingNumber ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''number'' default
* ''number'' maximum
* ''number'' minimum
* ''number'' step
* ''number'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingNumber",
"properties": {
"default": {
"type": "number",
"name": "default",
"required": true
},
"maximum": {
"type": "number",
"name": "maximum",
"required": true
},
"minimum": {
"type": "number",
"name": "minimum",
"required": true
},
"step": {
"type": "number",
"name": "step",
"required": true
},
"value": {
"type": "number",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingPath ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string''[] sources ]
* ''boolean'' writable
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingString"
],
"id": "Setting.Details.SettingPath",
"properties": {
"sources": {
"items": {
"type": "string"
},
"type": "array",
"name": "sources"
},
"writable": {
"type": "boolean",
"name": "writable",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingString ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' allowempty
* ''string'' default
* [ ''object'' options ]
* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingString",
"properties": {
"allowempty": {
"type": "boolean",
"name": "allowempty",
"required": true
},
"default": {
"type": "string",
"name": "default",
"required": true
},
"options": {
"items": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "options"
},
"value": {
"type": "string",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Level ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"basic",
"standard",
"advanced",
"expert"
],
"id": "Setting.Level",
"type": "string",
"default": "basic"
}</syntaxhighlight>}}

==== Setting.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"boolean",
"integer",
"number",
"string",
"action",
"list",
"path",
"addon"
],
"id": "Setting.Type",
"type": "string",
"default": "boolean"
}</syntaxhighlight>}}

==== Setting.Value ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Value",
"type": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
}</syntaxhighlight>}}

==== Setting.Value.Extended ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Value.Extended",
"type": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"$ref": "Setting.Value.List"
}
]
}</syntaxhighlight>}}

==== Setting.Value.List ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Value.List",
"type": "array",
"items": {
"$ref": "Setting.Value"
}
}</syntaxhighlight>}}

=== System ===
==== System.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"canshutdown",
"cansuspend",
"canhibernate",
"canreboot"
],
"id": "System.Property.Name",
"type": "string",
"default": "canshutdown"
}</syntaxhighlight>}}

==== System.Property.Value ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' canhibernate = false ]
* [ ''boolean'' canreboot = false ]
* [ ''boolean'' canshutdown = false ]
* [ ''boolean'' cansuspend = false ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "System.Property.Value",
"type": "object",
"properties": {
"canhibernate": {
"default": "false",
"type": "boolean",
"name": "canhibernate"
},
"canreboot": {
"default": "false",
"type": "boolean",
"name": "canreboot"
},
"canshutdown": {
"default": "false",
"type": "boolean",
"name": "canshutdown"
},
"cansuspend": {
"default": "false",
"type": "boolean",
"name": "cansuspend"
}
}
}</syntaxhighlight>}}

=== Textures ===
==== Textures.Details.Size ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' height = "0" ] ''Height of texture''
* [ ''string'' lastused ] ''Date of last use''
* [ ''integer'' size = "0" ] ''Size of the texture (1 == largest)''
* [ ''integer'' usecount = "0" ] ''Number of uses''
* [ ''integer'' width = "0" ] ''Width of texture''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Textures.Details.Size",
"type": "object",
"properties": {
"height": {
"default": "0",
"description": "Height of texture",
"type": "integer",
"name": "height"
},
"lastused": {
"default": "",
"description": "Date of last use",
"type": "string",
"name": "lastused"
},
"size": {
"default": "0",
"description": "Size of the texture (1 == largest)",
"type": "integer",
"name": "size"
},
"usecount": {
"default": "0",
"description": "Number of uses",
"type": "integer",
"name": "usecount"
},
"width": {
"default": "0",
"description": "Width of texture",
"type": "integer",
"name": "width"
}
}
}</syntaxhighlight>}}

==== Textures.Details.Texture ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' cachedurl ] ''Cached URL on disk''
* [ ''string'' imagehash ] ''Hash of image''
* [ ''string'' lasthashcheck ] ''Last time source was checked for changes''
* [ ''[[#Textures.Details.Size|Textures.Details.Size]]''[] sizes ]
* [ ''[[#Library.Id|Library.Id]]'' textureid = "-1" ]
* [ ''string'' url ] ''Original source URL''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Textures.Details.Texture",
"type": "object",
"properties": {
"cachedurl": {
"default": "",
"description": "Cached URL on disk",
"type": "string",
"name": "cachedurl"
},
"imagehash": {
"default": "",
"description": "Hash of image",
"type": "string",
"name": "imagehash"
},
"lasthashcheck": {
"default": "",
"description": "Last time source was checked for changes",
"type": "string",
"name": "lasthashcheck"
},
"sizes": {
"items": {
"$ref": "Textures.Details.Size"
},
"type": "array",
"name": "sizes"
},
"textureid": {
"default": "-1",
"$ref": "Library.Id",
"name": "textureid"
},
"url": {
"default": "",
"description": "Original source URL",
"type": "string",
"name": "url"
}
}
}</syntaxhighlight>}}

==== Textures.Fields.Texture ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Textures.Fields.Texture",
"items": {
"enums": [
"url",
"cachedurl",
"lasthashcheck",
"imagehash",
"sizes"
],
"type": "string"
}
}</syntaxhighlight>}}

=== Video ===
==== Video.Cast ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Cast",
"type": "array",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"required": true,
"type": "string"
},
"order": {
"required": true,
"type": "integer"
},
"role": {
"required": true,
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Video.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Media.Artwork|Media.Artwork]]'' art ]
* [ ''integer'' playcount = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Media.Details.Base"
],
"id": "Video.Details.Base",
"properties": {
"art": {
"$ref": "Media.Artwork",
"name": "art"
},
"playcount": {
"default": "0",
"type": "integer",
"name": "playcount"
}
}
}</syntaxhighlight>}}

==== Video.Details.Episode ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''integer'' episode = "0" ]
* ''[[#Library.Id|Library.Id]]'' episodeid
* [ ''string'' firstaired ]
* [ ''string'' originaltitle ]
* [ ''string'' productioncode ]
* [ ''number'' rating = "0" ]
* [ ''mixed'' ratings ]
* [ ''integer'' season = "0" ]
* [ ''[[#Library.Id|Library.Id]]'' seasonid = "-1" ]
* [ ''string'' showtitle ]
* [ ''integer'' specialsortepisode = "0" ]
* [ ''integer'' specialsortseason = "0" ]
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
* [ ''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid ]
* [ ''integer'' userrating = "0" ]
* [ ''string'' votes ]
* [ ''[[#Array.String|Array.String]]'' writer ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.File"
],
"id": "Video.Details.Episode",
"properties": {
"cast": {
"$ref": "Video.Cast",
"name": "cast"
},
"episode": {
"default": "0",
"type": "integer",
"name": "episode"
},
"episodeid": {
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
"firstaired": {
"default": "",
"type": "string",
"name": "firstaired"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"productioncode": {
"default": "",
"type": "string",
"name": "productioncode"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"ratings": {
"type": "any",
"name": "ratings"
},
"season": {
"default": "0",
"type": "integer",
"name": "season"
},
"seasonid": {
"default": "-1",
"$ref": "Library.Id",
"name": "seasonid"
},
"showtitle": {
"default": "",
"type": "string",
"name": "showtitle"
},
"specialsortepisode": {
"default": "0",
"type": "integer",
"name": "specialsortepisode"
},
"specialsortseason": {
"default": "0",
"type": "integer",
"name": "specialsortseason"
},
"tvshowid": {
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
"uniqueid": {
"$ref": "Media.UniqueID",
"name": "uniqueid"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"votes": {
"default": "",
"type": "string",
"name": "votes"
},
"writer": {
"$ref": "Array.String",
"name": "writer"
}
}
}</syntaxhighlight>}}

==== Video.Details.File ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Array.String|Array.String]]'' director ]
* [ ''[[#Video.Resume|Video.Resume]]'' resume ]
* [ ''integer'' runtime = "0" ] ''Runtime in seconds''
* [ ''[[#Video.Streams|Video.Streams]]'' streamdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Item"
],
"id": "Video.Details.File",
"properties": {
"director": {
"$ref": "Array.String",
"name": "director"
},
"resume": {
"$ref": "Video.Resume",
"name": "resume"
},
"runtime": {
"default": "0",
"description": "Runtime in seconds",
"type": "integer",
"name": "runtime"
},
"streamdetails": {
"$ref": "Video.Streams",
"name": "streamdetails"
}
}
}</syntaxhighlight>}}

==== Video.Details.Item ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' dateadded ]
* [ ''string'' file ]
* [ ''string'' lastplayed ]
* [ ''string'' plot ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Media"
],
"id": "Video.Details.Item",
"properties": {
"dateadded": {
"default": "",
"type": "string",
"name": "dateadded"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"lastplayed": {
"default": "",
"type": "string",
"name": "lastplayed"
},
"plot": {
"default": "",
"type": "string",
"name": "plot"
}
}
}</syntaxhighlight>}}

==== Video.Details.Media ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Base"
],
"id": "Video.Details.Media",
"properties": {
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== Video.Details.Movie ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''[[#Array.String|Array.String]]'' country ]
* [ ''[[#Array.String|Array.String]]'' genre ]
* [ ''string'' imdbnumber ]
* ''[[#Library.Id|Library.Id]]'' movieid
* [ ''string'' mpaa ]
* [ ''string'' originaltitle ]
* [ ''string'' plotoutline ]
* [ ''string'' premiered ]
* [ ''number'' rating = "0" ]
* [ ''mixed'' ratings ]
* [ ''string'' set ]
* [ ''[[#Library.Id|Library.Id]]'' setid = "-1" ]
* [ ''[[#Array.String|Array.String]]'' showlink ]
* [ ''string'' sorttitle ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* [ ''string'' tagline ]
* [ ''integer'' top250 = "0" ]
* [ ''string'' trailer ]
* [ ''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid ]
* [ ''integer'' userrating = "0" ]
* [ ''string'' votes ]
* [ ''[[#Array.String|Array.String]]'' writer ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.File"
],
"id": "Video.Details.Movie",
"properties": {
"cast": {
"$ref": "Video.Cast",
"name": "cast"
},
"country": {
"$ref": "Array.String",
"name": "country"
},
"genre": {
"$ref": "Array.String",
"name": "genre"
},
"imdbnumber": {
"default": "",
"type": "string",
"name": "imdbnumber"
},
"movieid": {
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
"mpaa": {
"default": "",
"type": "string",
"name": "mpaa"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"plotoutline": {
"default": "",
"type": "string",
"name": "plotoutline"
},
"premiered": {
"default": "",
"type": "string",
"name": "premiered"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"ratings": {
"type": "any",
"name": "ratings"
},
"set": {
"default": "",
"type": "string",
"name": "set"
},
"setid": {
"default": "-1",
"$ref": "Library.Id",
"name": "setid"
},
"showlink": {
"$ref": "Array.String",
"name": "showlink"
},
"sorttitle": {
"default": "",
"type": "string",
"name": "sorttitle"
},
"studio": {
"$ref": "Array.String",
"name": "studio"
},
"tag": {
"$ref": "Array.String",
"name": "tag"
},
"tagline": {
"default": "",
"type": "string",
"name": "tagline"
},
"top250": {
"default": "0",
"type": "integer",
"name": "top250"
},
"trailer": {
"default": "",
"type": "string",
"name": "trailer"
},
"uniqueid": {
"$ref": "Media.UniqueID",
"name": "uniqueid"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"votes": {
"default": "",
"type": "string",
"name": "votes"
},
"writer": {
"$ref": "Array.String",
"name": "writer"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== Video.Details.MovieSet ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' plot ]
* ''[[#Library.Id|Library.Id]]'' setid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Media"
],
"id": "Video.Details.MovieSet",
"properties": {
"plot": {
"default": "",
"type": "string",
"name": "plot"
},
"setid": {
"$ref": "Library.Id",
"name": "setid",
"required": true
}
}
}</syntaxhighlight>}}

==== Video.Details.MovieSet.Extended ====
'''Extends:'''
* ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.MovieSet"
],
"id": "Video.Details.MovieSet.Extended",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"name": "limits",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array",
"name": "movies"
}
}
}</syntaxhighlight>}}

==== Video.Details.MusicVideo ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' album ]
* [ ''[[#Array.String|Array.String]]'' artist ]
* [ ''[[#Array.String|Array.String]]'' genre ]
* ''[[#Library.Id|Library.Id]]'' musicvideoid
* [ ''string'' premiered ]
* [ ''number'' rating = "0" ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* [ ''integer'' track = "0" ]
* [ ''integer'' userrating = "0" ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.File"
],
"id": "Video.Details.MusicVideo",
"properties": {
"album": {
"default": "",
"type": "string",
"name": "album"
},
"artist": {
"$ref": "Array.String",
"name": "artist"
},
"genre": {
"$ref": "Array.String",
"name": "genre"
},
"musicvideoid": {
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
"premiered": {
"default": "",
"type": "string",
"name": "premiered"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"studio": {
"$ref": "Array.String",
"name": "studio"
},
"tag": {
"$ref": "Array.String",
"name": "tag"
},
"track": {
"default": "0",
"type": "integer",
"name": "track"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== Video.Details.Season ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' episode = "0" ]
* ''integer'' season
* ''[[#Library.Id|Library.Id]]'' seasonid
* [ ''string'' showtitle ]
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
* [ ''integer'' userrating = "0" ]
* [ ''integer'' watchedepisodes = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Base"
],
"id": "Video.Details.Season",
"properties": {
"episode": {
"default": "0",
"type": "integer",
"name": "episode"
},
"season": {
"type": "integer",
"name": "season",
"required": true
},
"seasonid": {
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
"showtitle": {
"default": "",
"type": "string",
"name": "showtitle"
},
"tvshowid": {
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"watchedepisodes": {
"default": "0",
"type": "integer",
"name": "watchedepisodes"
}
}
}</syntaxhighlight>}}

==== Video.Details.TVShow ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''integer'' episode = "0" ]
* [ ''string'' episodeguide ]
* [ ''[[#Array.String|Array.String]]'' genre ]
* [ ''string'' imdbnumber ]
* [ ''string'' mpaa ]
* [ ''string'' originaltitle ]
* [ ''string'' premiered ]
* [ ''number'' rating = "0" ]
* [ ''mixed'' ratings ]
* [ ''integer'' runtime = "0" ] ''Runtime in seconds''
* [ ''integer'' season = "0" ]
* [ ''string'' sorttitle ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* ''[[#Library.Id|Library.Id]]'' tvshowid
* [ ''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid ]
* [ ''integer'' userrating = "0" ]
* [ ''string'' votes ]
* [ ''integer'' watchedepisodes = "0" ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Item"
],
"id": "Video.Details.TVShow",
"properties": {
"cast": {
"$ref": "Video.Cast",
"name": "cast"
},
"episode": {
"default": "0",
"type": "integer",
"name": "episode"
},
"episodeguide": {
"default": "",
"type": "string",
"name": "episodeguide"
},
"genre": {
"$ref": "Array.String",
"name": "genre"
},
"imdbnumber": {
"default": "",
"type": "string",
"name": "imdbnumber"
},
"mpaa": {
"default": "",
"type": "string",
"name": "mpaa"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"premiered": {
"default": "",
"type": "string",
"name": "premiered"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"ratings": {
"type": "any",
"name": "ratings"
},
"runtime": {
"default": "0",
"description": "Runtime in seconds",
"type": "integer",
"name": "runtime"
},
"season": {
"default": "0",
"type": "integer",
"name": "season"
},
"sorttitle": {
"default": "",
"type": "string",
"name": "sorttitle"
},
"studio": {
"$ref": "Array.String",
"name": "studio"
},
"tag": {
"$ref": "Array.String",
"name": "tag"
},
"tvshowid": {
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
"uniqueid": {
"$ref": "Media.UniqueID",
"name": "uniqueid"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"votes": {
"default": "",
"type": "string",
"name": "votes"
},
"watchedepisodes": {
"default": "0",
"type": "integer",
"name": "watchedepisodes"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== Video.Fields.Episode ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
}</syntaxhighlight>}}

==== Video.Fields.Movie ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
}</syntaxhighlight>}}

==== Video.Fields.MovieSet ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Video.Fields.MovieSet",
"items": {
"enums": [
"title",
"playcount",
"fanart",
"thumbnail",
"art",
"plot"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Video.Fields.MusicVideo ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
}</syntaxhighlight>}}

==== Video.Fields.Season ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Video.Fields.Season",
"items": {
"enums": [
"season",
"showtitle",
"playcount",
"episode",
"fanart",
"thumbnail",
"tvshowid",
"watchedepisodes",
"art",
"userrating"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Video.Fields.TVShow ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
}</syntaxhighlight>}}

==== Video.Rating ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' default = false ]
* ''number'' rating
* [ ''integer'' votes = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Rating",
"type": "object",
"properties": {
"default": {
"default": "false",
"type": "boolean",
"name": "default"
},
"rating": {
"type": "number",
"name": "rating",
"required": true
},
"votes": {
"default": "0",
"type": "integer",
"name": "votes"
}
}
}</syntaxhighlight>}}

==== Video.Ratings ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Ratings",
"type": "object"
}</syntaxhighlight>}}

==== Video.Ratings.Set ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Ratings.Set",
"type": "object"
}</syntaxhighlight>}}

==== Video.Resume ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''number'' position = "0" ]
* [ ''number'' total = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Resume",
"type": "object",
"properties": {
"position": {
"default": "0",
"type": "number",
"name": "position"
},
"total": {
"default": "0",
"type": "number",
"name": "total"
}
}
}</syntaxhighlight>}}

==== Video.Streams ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''object'' audio ]
* [ ''object'' subtitle ]
* [ ''object'' video ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Streams",
"type": "object",
"properties": {
"audio": {
"items": {
"properties": {
"channels": {
"default": 0,
"type": "integer"
},
"codec": {
"default": "",
"type": "string"
},
"language": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "audio"
},
"subtitle": {
"items": {
"properties": {
"language": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "subtitle"
},
"video": {
"items": {
"properties": {
"aspect": {
"default": 0,
"type": "number"
},
"codec": {
"default": "",
"type": "string"
},
"duration": {
"default": 0,
"type": "integer"
},
"height": {
"default": 0,
"type": "integer"
},
"width": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"type": "array",
"name": "video"
}
}
}</syntaxhighlight>}}

== Notifications ==
=== Application ===
==== Application.OnVolumeChanged ====
The volume of the application has changed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
* ''integer'' volume
* ''boolean'' muted

</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"volume": {
"minimum": 0,
"required": true,
"type": "integer",
"maximum": 100
},
"muted": {
"required": true,
"type": "boolean"
}
},
"required": true,
"type": "object"
}
],
"description": "The volume of the application has changed."
}</syntaxhighlight>}}

=== AudioLibrary ===
==== AudioLibrary.OnCleanFinished ====
The audio library has been cleaned.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''null'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"description": "The audio library has been cleaned."
}</syntaxhighlight>}}

==== AudioLibrary.OnCleanStarted ====
An audio library clean operation has started.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''null'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"description": "An audio library clean operation has started."
}</syntaxhighlight>}}

==== AudioLibrary.OnRemove ====
An audio item has been removed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' id
* ''[[#Notifications.Library.Audio.Type|Notifications.Library.Audio.Type]]'' type

</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"type": {
"$ref": "Notifications.Library.Audio.Type",
"required": true
}
},
"required": true,
"type": "object"
}
],
"description": "An audio item has been removed."
}</syntaxhighlight>}}

==== AudioLibrary.OnScanFinished ====
Scanning the audio library has been finished.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''null'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"description": "Scanning the audio library has been finished."
}</syntaxhighlight>}}

==== AudioLibrary.OnScanStarted ====
An audio library scan has started.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''null'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"description": "An audio library scan has started."
}</syntaxhighlight>}}

==== AudioLibrary.OnUpdate ====
An audio item has been updated.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' id
* ''string'' type

</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"type": {
"enum": [
"song"
],
"id": "Notifications.Library.Audio.Type",
"required": true,
"type": "string"
}
},
"required": true,
"type": "object"
}
],
"description": "An audio item has been updated."
}</syntaxhighlight>}}

=== Input ===
==== Input.OnInputFinished ====
The user has provided the requested input.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''null'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"description": "The user has provided the requested input."
}</syntaxhighlight>}}

==== Input.OnInputRequested ====
The user is requested to provide some information.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
* ''string'' value
* [ ''string'' title ]
* ''string'' type

</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"value": {
"required": true,
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"enum": [
"keyboard",
"time",
"date",
"ip",
"password",
"numericpassword",
"number",
"seconds"
],
"required": true,
"type": "string"
}
},
"required": true,
"type": "object"
}
],
"description": "The user is requested to provide some information."
}</syntaxhighlight>}}

=== Player ===
==== Player.OnPause ====
Playback of a media item has been paused. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"description": "Playback of a media item has been paused. If there is no ID available extra information will be provided."
}</syntaxhighlight>}}

==== 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.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"description": "Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided."
}</syntaxhighlight>}}

==== Player.OnPropertyChanged ====
A property of the playing items has changed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
* [ ''[[#Player.Property.Value|Player.Property.Value]]'' property ]
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player

</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"property": {
"$ref": "Player.Property.Value"
},
"player": {
"$ref": "Player.Notifications.Player",
"required": true
}
},
"required": true,
"type": "object"
}
],
"description": "A property of the playing items has changed."
}</syntaxhighlight>}}

==== Player.OnSeek ====
The playback position has been changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
* ''[[#Player.Notifications.Player.Seek|Player.Notifications.Player.Seek]]'' player
* [ ''[[#Notifications.Item|Notifications.Item]]'' item ]

</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"player": {
"$ref": "Player.Notifications.Player.Seek",
"required": true
},
"item": {
"$ref": "Notifications.Item"
}
},
"required": true,
"type": "object"
}
],
"description": "The playback position has been changed. If there is no ID available extra information will be provided."
}</syntaxhighlight>}}

==== Player.OnSpeedChanged ====
Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"description": "Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided."
}</syntaxhighlight>}}

==== Player.OnStop ====
Playback of a media item has been stopped. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
* ''boolean'' end
* [ ''[[#Notifications.Item|Notifications.Item]]'' item ]

</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"end": {
"description": "Whether the player has reached the end of the playable item(s) or not",
"required": true,
"type": "boolean"
},
"item": {
"$ref": "Notifications.Item"
}
},
"required": true,
"type": "object"
}
],
"description": "Playback of a media item has been stopped. If there is no ID available extra information will be provided."
}</syntaxhighlight>}}

=== Playlist ===
==== Playlist.OnAdd ====
A playlist item has been added.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
* [ ''[[#Playlist.Position|Playlist.Position]]'' position ]
* [ ''[[#Notifications.Item|Notifications.Item]]'' item ]
* ''[[#Playlist.Id|Playlist.Id]]'' playlistid

</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"position": {
"$ref": "Playlist.Position"
},
"item": {
"$ref": "Notifications.Item"
},
"playlistid": {
"$ref": "Playlist.Id",
"required": true
}
},
"required": true,
"type": "object"
}
],
"description": "A playlist item has been added."
}</syntaxhighlight>}}

==== Playlist.OnClear ====
A playlist item has been cleared.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
* ''[[#Playlist.Id|Playlist.Id]]'' playlistid

</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
}
},
"required": true,
"type": "object"
}
],
"description": "A playlist item has been cleared."
}</syntaxhighlight>}}

==== Playlist.OnRemove ====
A playlist item has been removed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
* [ ''[[#Playlist.Position|Playlist.Position]]'' position ]
* ''[[#Playlist.Id|Playlist.Id]]'' playlistid

</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"position": {
"$ref": "Playlist.Position"
},
"playlistid": {
"$ref": "Playlist.Id",
"required": true
}
},
"required": true,
"type": "object"
}
],
"description": "A playlist item has been removed."
}</syntaxhighlight>}}

=== System ===
==== System.OnLowBattery ====
The system is on low battery.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''null'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"description": "The system is on low battery."
}</syntaxhighlight>}}

==== System.OnQuit ====
Kodi will be closed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''null'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"description": "Kodi will be closed."
}</syntaxhighlight>}}

==== System.OnRestart ====
The system will be restarted.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''null'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"description": "The system will be restarted."
}</syntaxhighlight>}}

==== System.OnSleep ====
The system will be suspended.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''null'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"description": "The system will be suspended."
}</syntaxhighlight>}}

==== System.OnWake ====
The system woke up from suspension.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''null'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"description": "The system woke up from suspension."
}</syntaxhighlight>}}

=== VideoLibrary ===
==== VideoLibrary.OnCleanFinished ====
The video library has been cleaned.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''null'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"description": "The video library has been cleaned."
}</syntaxhighlight>}}

==== VideoLibrary.OnCleanStarted ====
A video library clean operation has started.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''null'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"description": "A video library clean operation has started."
}</syntaxhighlight>}}

==== VideoLibrary.OnRemove ====
A video item has been removed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' id
* ''[[#Notifications.Library.Video.Type|Notifications.Library.Video.Type]]'' type

</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"type": {
"$ref": "Notifications.Library.Video.Type",
"required": true
}
},
"required": true,
"type": "object"
}
],
"description": "A video item has been removed."
}</syntaxhighlight>}}

==== VideoLibrary.OnScanFinished ====
Scanning the video library has been finished.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''null'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"description": "Scanning the video library has been finished."
}</syntaxhighlight>}}

==== VideoLibrary.OnScanStarted ====
A video library scan has started.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''null'' data
</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"description": "A video library scan has started."
}</syntaxhighlight>}}

==== VideoLibrary.OnUpdate ====
A video item has been updated.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' id
* [ ''integer'' playcount = -1 ]
* ''string'' type

</div>

{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"playcount": {
"minimum": 0,
"type": "integer",
"default": -1
},
"type": {
"enum": [
"movie",
"tvshow",
"episode",
"musicvideo"
],
"id": "Notifications.Library.Video.Type",
"required": true,
"type": "string"
}
},
"required": true,
"type": "object"
}
],
"description": "A video item has been updated."
}</syntaxhighlight>}}

== See also ==
* [[JSON-RPC API]]
* [[JSON-RPC API/v4|JSON-RPC API v4 (Eden)]]
* [[JSON-RPC API/v8|JSON-RPC API v8 (Krypton)]]

== External links ==
* [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]
* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]

[[Category:Development]]

JSON-RPC API

2017-02-19T20:37:24Z

Ncarthy: /* API versions */ add v8

{{mininav|[[Development]]}}

{{JSON-RPC API nav}}
<br />

JSON-RPC is a HTTP- and/or raw TCP socket-based interface for communicating with Kodi. It replaces the deprecated [[HTTP API]], and offers a more secure and robust mechanism in the same format. It is based upon the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification].

Each method in the interface can have different security needs which means one client may be allowed to only control playback while another can only read and manipulate the library. In version 2 (first stable) and 4 all clients are granted full authority but will later be forced to ask for privileges and the user of Kodi will have to grant said client access. The design of JSON-RPC is that most methods should behave roughly the same and maintain consistency while hiding the mechanics of Kodi from the client creator.

In Kodi JSON-RPC can be accessed over a variety of transports and has been designed from the ground up to be flexible to allow control over new transports easily. Some of the transports have different limitations which will be enforced upon the interaction over that transport. As an example HTTP transports allow response and downloading of files while the raw TCP transport allows response and notifications (events and information Kodi sends to its clients). Depending on the client's needs it will choose one (or many) of the available transports.<br />

== Enabling JSON-RPC ==
Since the interface is available on many transports enabling it depends on the transport.
* Python: Always enabled
* HTTP: In System/Settings/Network/Services activate ''Allow control of Kodi via HTTP'' (see [[Webserver#Enabling the webserver|Enabling the webserver]])
* TCP: In System/Settings/Network/Services activate ''Allow programs on this system to control Kodi'' for localhost access only and ''Allow programs on other systems to control Kodi'' for access from other computers as well

Note: The [[EventServer]] is a different interface for sending remote keypresses to Kodi, and must be enabled separately, some programs may use both interfaces.

== Transports & Functionalities ==
=== Transports ===
==== Python ====
The ''Python'' transport can only be used by Kodi addons through the '''executeJSONRPC''' method provided by the '''xbmc''' python library. As it must be available to every addon in an Kodi installation it must not be enabled or disabled by the user.

==== HTTP ====
The ''HTTP'' transport can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol HTTP] protocol. Because this transport allows applications outside Kodi to control Kodi, it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user.

===== POST =====
Third-party applications can access Kodi's JSON-RPC API by sending JSON-RPC requests embedded in HTTP [http://en.wikipedia.org/wiki/POST_(HTTP) POST] requests to the following URL
<pre>http://<your-ip>:<your-port>/jsonrpc</pre>

Starting with Frodo nightly builds it is mandatory to set the HTTP header field '''Content-Type: application/json'''

===== GET =====
Third-party application can access Kodi's JSON-RPC API by sending JSON-RPC requests embedded in a HTTP GET parameter called ''request''. The JSON-RPC request must be URL encoded and sent to the following URL
<pre>http://<your-ip>:<your-port>/jsonrpc?request=<url-encoded-request></pre>

==== TCP ====
The ''TCP'' transport can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/Transmission_Control_Protocol TCP] protocol. Because this transport allows applications outside Kodi to control Kodi it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user. Once enabled, third-party applications can access Kodi's JSON-RPC API by opening a TCP [http://en.wikipedia.org/wiki/Internet_socket socket] on port 9090 (this port can be configured in the [[Advancedsettings.xml#<jsonrpc>|advanced settings]] file) and sending raw JSON-RPC requests over that socket. Please note that no delimiters are provided in between notifications and/or responses. As such, your client needs to be able to deal with this, eg. by counting and matching curly braces ({}).

==== WebSocket ====
The ''WebSocket'' transport has been added since Version 5 and can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/WebSocket Websocket] protocol. The supported versions are 8 (draft [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-10 hybi-10]) and 13 ([http://tools.ietf.org/html/rfc6455 RFC 6455]). Because this transport allows applications outside Kodi to control Kodi it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user. Once enabled, third-party applications can access Kodi's JSON-RPC API by sending a WebSocket protocol handshake to the following URI
<pre>ws://<your-ip>:<configured tcp port>/jsonrpc</pre>
It is important to send the handshake on the port of Kodi's TCP server (by default 9090, but this port can be configured in the [[Advancedsettings.xml#<jsonrpc>|advanced settings]] file). After having successfully finished the handshake third-party applications can send WebSocket protocl messages over that connection.

=== Functionalities ===
==== Response ====
The ''Response'' functionality is the only functionality that should be present in every transport available as it describes the functionality to respond to a JSON-RPC request with a valid JSON-RPC response (be it an error message or an actual response).

==== Notifications ====
The ''Notifications'' functionality includes both server-side (from the server to clients) and client-side (from clients to the server) notifications. A JSON-RPC notification is a valid JSON-RPC request with no ''id'' property. Following the JSON-RPC 2.0 specification any JSON-RPC request with no ''id'' must be considered as a notification and the receiver must not send a response upon a notification.

In the specific case of Kodi, server-side notifications are used to inform clients about certain events to relieve clients of the need to periodically poll for certain events. Furthermore there are two ways of client-side notifications. Using [[/#JSONRPC.NotifyAll|JSONRPC.NotifyAll]] it is possible to ask Kodi to relay the message in the JSON-RPC request to all other connected clients. The second way is to send JSON-RPC requests without an ''id'' property in case the client does not care about the response (e.g. the method [[/#Player.Stop|Player.Stop]] does not return any useful information to the client).

==== Direct file download ====
The ''Direct file download'' functionality is the ability to directly download files from Kodi by calling [[/#Files.Download|Files.Download]]. In this case the term ''direct'' means that the download happens within the JSON-RPC response of the [[/#Files.Download|Files.Download]] request.

==== Redirected file download ====
The ''Redirected file download'' functionality is the ability to indirectly download files from Kodi by calling [[/#Files.PrepareDownload|Files.PrepareDownload]] and using the data received in the response to download the file over a different protocol (like HTTP, FTP ...) or another socket. As the ''Redirected file download'' is very transport specific, it must be handled separately for every transport supporting it.

=== Comparison ===
The following table shows all the available transports and what functionalities they support
{| class="prettytable" style="margin-right: 0;"
!style="padding-left: 5px; padding-right: 10px;" colspan="2"|Transport
!style="padding-left: 10px; padding-right: 10px;"|Response
!style="padding-left: 10px; padding-right: 10px;"|Notifications
!style="padding-left: 10px; padding-right: 10px;"|Direct file<br />download
!style="padding-left: 10px; padding-right: 10px;"|Redirected file<br />download
|-
|style="padding-left: 5px;" colspan="2"|[[Python Development|Python]]
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;" colspan="2"|[http://en.wikipedia.org/wiki/Transmission_Control_Protocol TCP]
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right:5px;" rowspan="2"|[http://en.wikipedia.org/wiki/HTTP HTTP]
|style="padding-left: 5px; padding-right:5px;"|POST
|{{yes}}
|{{no}}
|{{no}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right:5px;"|GET<sup>1</sup>
|{{yes}}
|{{no}}
|{{no}}
|{{yes}}
|-
|style="padding-left: 5px;" colspan="2"|[http://en.wikipedia.org/wiki/WebSocket WebSocket]<sup>1</sup>
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|}
<sup>1</sup> Added in Version 5

== API versions ==
The JSON-RPC API exposed by Kodi is constantly extended to provide better and more functionality to third party applications. For that reason Kodi provides a version information through the '''JSONRPC.Version''' method. The rule is that odd version numbers describe an API state, that is not stable and under heavy development whereas even version numbers describe a stable API. Therefore the version number can be used by third-party clients to check if their application might not be fully compatible with the JSON-RPC API exposed by a user's Kodi installation.

Starting with XBMC v12 (Frodo) we started using a new versioning system (<major>.<minor>.<patch>) for the JSON-RPC API. Frodo stable is version 6.0.0 and from now on with every bugfix the <patch> part of the version is increased, with every feature addition to the API, the <minor> version is increased (and the <patch> version reset to 0) and with every backwards incompatible change, the <major> version is increased.

{| class="prettytable" style="margin-right: 0;"
!colspan="3"|Release
!colspan="6"|JSON-RPC 2.0 specification
!colspan="5"|Transports
|-
!style="padding-left: 5px; padding-right: 5px; width: 6em; text-align: left;"|API Version
!style="padding-left: 10px; padding-right: 10px; width: 5em;"|Version
!style="padding-left: 10px; padding-right: 10px; width: 4em;"|Name
!style="padding-left: 10px; padding-right: 10px;"|Method calls
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(server-side)
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(client-side)
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-name
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-position
!style="padding-left: 10px; padding-right: 10px;"|Batch requests

!style="padding-left: 10px; padding-right: 10px;"|Python
!style="padding-left: 10px; padding-right: 10px;"|TCP
!style="padding-left: 10px; padding-right: 10px;"|HTTP POST
!style="padding-left: 10px; padding-right: 10px;"|HTTP GET
!style="padding-left: 10px; padding-right: 10px;"|WebSocket
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v2|Version 2]]
|style="padding-left: 5px; padding-right: 5px;"|10.0
|style="padding-left: 5px; padding-right: 5px;"|Dharma
|{{yes}}
|{{yes}}
|{{no}}
|{{yes}}
|{{no}}
|{{no}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v3|Version 3]] / [[/v4|4]]
|style="padding-left: 5px; padding-right: 5px;"|pre-11 / 11.0
|style="padding-left: 5px; padding-right: 5px;"|Eden
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v5|Version 5]] / [[/v6|6]]
|style="padding-left: 5px; padding-right: 5px;"|pre-12 / 12.0
|style="padding-left: 5px; padding-right: 5px;"|Frodo
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.0
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.1
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.2
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.0
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.1
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.2
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.0
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.1
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.2
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|16.0
|style="padding-left: 5px; padding-right: 5px;"|Jarvis
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|16.1
|style="padding-left: 5px; padding-right: 5px;"|Jarvis
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v8|Version 8]]
|style="padding-left: 5px; padding-right: 5px;"|17.0
|style="padding-left: 5px; padding-right: 5px;"|Krypton
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|}

{| class="prettytable" style="margin-right: 0;"
!colspan="3"|Release
!|JSONRPC.Version
|-
!style="padding-left: 10px; padding-right: 10px;"|Date
!style="padding-left: 10px; padding-right: 10px;"|Version
!style="padding-left: 10px; padding-right: 10px;"|Codename
!style="padding-left: 10px; padding-right: 10px;"|["version"]
|-
|18 December 2010
|10.0
|Dharma
|2
|-
|10 March 2011
|10.1
|Dharma
|2
|-
| style="background:#eee;" |24 March 2012
| style="background:#eee;" |11.0
| style="background:#eee;" |Eden
| style="background:#eee;" |4
|-
|29 January 2013
|12.0
|Frodo
|{"major":6,"minor":0,"patch":0}
|-
|18 March 2013
|12.1
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
|03 May 2013
|12.2
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
|24 December 2013
|12.3
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
| style="background:#eee;" | 04 May 2014
| style="background:#eee;" | 13.0
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
| style="background:#eee;" | 05 June 2014
| style="background:#eee;" | 13.1
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
| style="background:#eee;" | 17 August 2014
| style="background:#eee;" | 13.2
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
|23 December 2014
|14.0
|Helix
|{"major":6,"minor":21,"patch":2}
|-
|30 January 2014
|14.1
|Helix
|{"major":6,"minor":21,"patch":2}
|-
|26 March 2014
|14.2
|Helix
|{"major":6,"minor":21,"patch":2}
|-
| style="background:#eee;" | 21 July 2015
| style="background:#eee;" | 15.0
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
| style="background:#eee;" | 16 August 2015
| style="background:#eee;" | 15.1
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
| style="background:#eee;" | 19 October 2015
| style="background:#eee;" | 15.2
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
|21 February 2016
|16.0
|Jarvis
|{"major":6,"minor":32,"patch":4}
|-
|24 April 2016
|16.1
|Jarvis
|{"major":6,"minor":32,"patch":5}
|-
| style="background:#eee;" | 5 February 2017
| style="background:#eee;" | 17.0
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
|}

== Documentation ==
Kodi's JSON-RPC API has been designed to be self-documented i.e. a call to [[/#JSONRPC.Introspect|JSONRPC.Introspect]] results in a JSON-RPC response containing a documentation for all the available methods and data types. While this documentation is very incomplete and partly wrong for [[/v2|version 2]] it is provided as a full [http://tools.ietf.org/html/draft-zyp-json-schema-03 JSON schema] starting with [[/v3|version 3]]. As the documentation retrieved in that way is always specific to the used version of Kodi, it is (especially for development versions) the best documentation available and should be preferred over the wiki documentation as the latter always documents the API of the latest development.

== Debugging ==
=== Output format ===
To be able to support easier debugging of (third-party) development using the JSON-RPC API, the JSON output generated by Kodi can be pretty-printed by setting
<syntaxhighlight lang="xml" enclose="div">
<jsonrpc>
<compactoutput>false</compactoutput>
</jsonrpc>
</syntaxhighlight>
in the [[Advancedsettings.xml#.3Cjsonrpc.3E|advancedsettings.xml]]. Default JSON output will be in compact format to minimize sent data (especially useful for mobile devices).

=== Direct interaction ===
To be able to test some methods of Kodi's JSON-RPC API, it can be of great help to be able to send a single hand-written JSON-RPC request to Kodi to see its effect and the generated response. Depending on the transport protocol used there are different possibilities to do that:

==== TCP ====
With a [http://en.wikipedia.org/wiki/Telnet telnet] connection (using [http://en.wikipedia.org/wiki/PuTTY PuTTY] on Windows or telnet on Linux) to port 9090 of the machine running Kodi it is possible to send and receive raw json data to/from Kodi. {{see also|SSH}}

==== HTTP ====
A simple way of manually sending HTTP requests containing a JSON-RPC request to Kodi is using the [http://chrome.google.com/extensions/detail/fhjcajmcbmldlhcimfajhfbgofnpcjmb Simple REST Client] extension for Google's Chrome/Chromium browser. It allows defining a URL and the HTTP request type ('''POST''' is what we need). The actual JSON-RPC request can be defined in the '''Data''' field and then sent to Kodi.

== See also ==
* [[/v2|JSON-RPC API v2 (Dharma)]]
* [[/v4|JSON-RPC API v4 (Eden)]]
* [[/v6|JSON-RPC API v6 (Frodo - Jarvis)]]
* [[/v8|JSON-RPC API v8 (Krypton)]]

== External links ==
* [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]
* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]

== Examples ==
These examples take their base from v4. Any that require a higher version will be marked.

[[JSON-RPC API/Examples]]

[[Category:Manual]]
[[Category:Development]]

JSON-RPC API

2017-02-19T20:36:01Z

Ncarthy: Correct v8 release date

{{mininav|[[Development]]}}

{{JSON-RPC API nav}}
<br />

JSON-RPC is a HTTP- and/or raw TCP socket-based interface for communicating with Kodi. It replaces the deprecated [[HTTP API]], and offers a more secure and robust mechanism in the same format. It is based upon the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification].

Each method in the interface can have different security needs which means one client may be allowed to only control playback while another can only read and manipulate the library. In version 2 (first stable) and 4 all clients are granted full authority but will later be forced to ask for privileges and the user of Kodi will have to grant said client access. The design of JSON-RPC is that most methods should behave roughly the same and maintain consistency while hiding the mechanics of Kodi from the client creator.

In Kodi JSON-RPC can be accessed over a variety of transports and has been designed from the ground up to be flexible to allow control over new transports easily. Some of the transports have different limitations which will be enforced upon the interaction over that transport. As an example HTTP transports allow response and downloading of files while the raw TCP transport allows response and notifications (events and information Kodi sends to its clients). Depending on the client's needs it will choose one (or many) of the available transports.<br />

== Enabling JSON-RPC ==
Since the interface is available on many transports enabling it depends on the transport.
* Python: Always enabled
* HTTP: In System/Settings/Network/Services activate ''Allow control of Kodi via HTTP'' (see [[Webserver#Enabling the webserver|Enabling the webserver]])
* TCP: In System/Settings/Network/Services activate ''Allow programs on this system to control Kodi'' for localhost access only and ''Allow programs on other systems to control Kodi'' for access from other computers as well

Note: The [[EventServer]] is a different interface for sending remote keypresses to Kodi, and must be enabled separately, some programs may use both interfaces.

== Transports & Functionalities ==
=== Transports ===
==== Python ====
The ''Python'' transport can only be used by Kodi addons through the '''executeJSONRPC''' method provided by the '''xbmc''' python library. As it must be available to every addon in an Kodi installation it must not be enabled or disabled by the user.

==== HTTP ====
The ''HTTP'' transport can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol HTTP] protocol. Because this transport allows applications outside Kodi to control Kodi, it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user.

===== POST =====
Third-party applications can access Kodi's JSON-RPC API by sending JSON-RPC requests embedded in HTTP [http://en.wikipedia.org/wiki/POST_(HTTP) POST] requests to the following URL
<pre>http://<your-ip>:<your-port>/jsonrpc</pre>

Starting with Frodo nightly builds it is mandatory to set the HTTP header field '''Content-Type: application/json'''

===== GET =====
Third-party application can access Kodi's JSON-RPC API by sending JSON-RPC requests embedded in a HTTP GET parameter called ''request''. The JSON-RPC request must be URL encoded and sent to the following URL
<pre>http://<your-ip>:<your-port>/jsonrpc?request=<url-encoded-request></pre>

==== TCP ====
The ''TCP'' transport can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/Transmission_Control_Protocol TCP] protocol. Because this transport allows applications outside Kodi to control Kodi it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user. Once enabled, third-party applications can access Kodi's JSON-RPC API by opening a TCP [http://en.wikipedia.org/wiki/Internet_socket socket] on port 9090 (this port can be configured in the [[Advancedsettings.xml#<jsonrpc>|advanced settings]] file) and sending raw JSON-RPC requests over that socket. Please note that no delimiters are provided in between notifications and/or responses. As such, your client needs to be able to deal with this, eg. by counting and matching curly braces ({}).

==== WebSocket ====
The ''WebSocket'' transport has been added since Version 5 and can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/WebSocket Websocket] protocol. The supported versions are 8 (draft [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-10 hybi-10]) and 13 ([http://tools.ietf.org/html/rfc6455 RFC 6455]). Because this transport allows applications outside Kodi to control Kodi it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user. Once enabled, third-party applications can access Kodi's JSON-RPC API by sending a WebSocket protocol handshake to the following URI
<pre>ws://<your-ip>:<configured tcp port>/jsonrpc</pre>
It is important to send the handshake on the port of Kodi's TCP server (by default 9090, but this port can be configured in the [[Advancedsettings.xml#<jsonrpc>|advanced settings]] file). After having successfully finished the handshake third-party applications can send WebSocket protocl messages over that connection.

=== Functionalities ===
==== Response ====
The ''Response'' functionality is the only functionality that should be present in every transport available as it describes the functionality to respond to a JSON-RPC request with a valid JSON-RPC response (be it an error message or an actual response).

==== Notifications ====
The ''Notifications'' functionality includes both server-side (from the server to clients) and client-side (from clients to the server) notifications. A JSON-RPC notification is a valid JSON-RPC request with no ''id'' property. Following the JSON-RPC 2.0 specification any JSON-RPC request with no ''id'' must be considered as a notification and the receiver must not send a response upon a notification.

In the specific case of Kodi, server-side notifications are used to inform clients about certain events to relieve clients of the need to periodically poll for certain events. Furthermore there are two ways of client-side notifications. Using [[/#JSONRPC.NotifyAll|JSONRPC.NotifyAll]] it is possible to ask Kodi to relay the message in the JSON-RPC request to all other connected clients. The second way is to send JSON-RPC requests without an ''id'' property in case the client does not care about the response (e.g. the method [[/#Player.Stop|Player.Stop]] does not return any useful information to the client).

==== Direct file download ====
The ''Direct file download'' functionality is the ability to directly download files from Kodi by calling [[/#Files.Download|Files.Download]]. In this case the term ''direct'' means that the download happens within the JSON-RPC response of the [[/#Files.Download|Files.Download]] request.

==== Redirected file download ====
The ''Redirected file download'' functionality is the ability to indirectly download files from Kodi by calling [[/#Files.PrepareDownload|Files.PrepareDownload]] and using the data received in the response to download the file over a different protocol (like HTTP, FTP ...) or another socket. As the ''Redirected file download'' is very transport specific, it must be handled separately for every transport supporting it.

=== Comparison ===
The following table shows all the available transports and what functionalities they support
{| class="prettytable" style="margin-right: 0;"
!style="padding-left: 5px; padding-right: 10px;" colspan="2"|Transport
!style="padding-left: 10px; padding-right: 10px;"|Response
!style="padding-left: 10px; padding-right: 10px;"|Notifications
!style="padding-left: 10px; padding-right: 10px;"|Direct file<br />download
!style="padding-left: 10px; padding-right: 10px;"|Redirected file<br />download
|-
|style="padding-left: 5px;" colspan="2"|[[Python Development|Python]]
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;" colspan="2"|[http://en.wikipedia.org/wiki/Transmission_Control_Protocol TCP]
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right:5px;" rowspan="2"|[http://en.wikipedia.org/wiki/HTTP HTTP]
|style="padding-left: 5px; padding-right:5px;"|POST
|{{yes}}
|{{no}}
|{{no}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right:5px;"|GET<sup>1</sup>
|{{yes}}
|{{no}}
|{{no}}
|{{yes}}
|-
|style="padding-left: 5px;" colspan="2"|[http://en.wikipedia.org/wiki/WebSocket WebSocket]<sup>1</sup>
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|}
<sup>1</sup> Added in Version 5

== API versions ==
The JSON-RPC API exposed by Kodi is constantly extended to provide better and more functionality to third party applications. For that reason Kodi provides a version information through the '''JSONRPC.Version''' method. The rule is that odd version numbers describe an API state, that is not stable and under heavy development whereas even version numbers describe a stable API. Therefore the version number can be used by third-party clients to check if their application might not be fully compatible with the JSON-RPC API exposed by a user's Kodi installation.

Starting with XBMC v12 (Frodo) we started using a new versioning system (<major>.<minor>.<patch>) for the JSON-RPC API. Frodo stable is version 6.0.0 and from now on with every bugfix the <patch> part of the version is increased, with every feature addition to the API, the <minor> version is increased (and the <patch> version reset to 0) and with every backwards incompatible change, the <major> version is increased.

{| class="prettytable" style="margin-right: 0;"
!colspan="3"|Release
!colspan="6"|JSON-RPC 2.0 specification
!colspan="5"|Transports
|-
!style="padding-left: 5px; padding-right: 5px; width: 6em; text-align: left;"|API Version
!style="padding-left: 10px; padding-right: 10px; width: 5em;"|Version
!style="padding-left: 10px; padding-right: 10px; width: 4em;"|Name
!style="padding-left: 10px; padding-right: 10px;"|Method calls
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(server-side)
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(client-side)
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-name
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-position
!style="padding-left: 10px; padding-right: 10px;"|Batch requests

!style="padding-left: 10px; padding-right: 10px;"|Python
!style="padding-left: 10px; padding-right: 10px;"|TCP
!style="padding-left: 10px; padding-right: 10px;"|HTTP POST
!style="padding-left: 10px; padding-right: 10px;"|HTTP GET
!style="padding-left: 10px; padding-right: 10px;"|WebSocket
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v2|Version 2]]
|style="padding-left: 5px; padding-right: 5px;"|10.0
|style="padding-left: 5px; padding-right: 5px;"|Dharma
|{{yes}}
|{{yes}}
|{{no}}
|{{yes}}
|{{no}}
|{{no}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v3|Version 3]] / [[/v4|4]]
|style="padding-left: 5px; padding-right: 5px;"|pre-11 / 11.0
|style="padding-left: 5px; padding-right: 5px;"|Eden
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v5|Version 5]] / [[/v6|6]]
|style="padding-left: 5px; padding-right: 5px;"|pre-12 / 12.0
|style="padding-left: 5px; padding-right: 5px;"|Frodo
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.0
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.1
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.2
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.0
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.1
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.2
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.0
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.1
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.2
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|16.0
|style="padding-left: 5px; padding-right: 5px;"|Jarvis
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|16.1
|style="padding-left: 5px; padding-right: 5px;"|Jarvis
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|}

{| class="prettytable" style="margin-right: 0;"
!colspan="3"|Release
!|JSONRPC.Version
|-
!style="padding-left: 10px; padding-right: 10px;"|Date
!style="padding-left: 10px; padding-right: 10px;"|Version
!style="padding-left: 10px; padding-right: 10px;"|Codename
!style="padding-left: 10px; padding-right: 10px;"|["version"]
|-
|18 December 2010
|10.0
|Dharma
|2
|-
|10 March 2011
|10.1
|Dharma
|2
|-
| style="background:#eee;" |24 March 2012
| style="background:#eee;" |11.0
| style="background:#eee;" |Eden
| style="background:#eee;" |4
|-
|29 January 2013
|12.0
|Frodo
|{"major":6,"minor":0,"patch":0}
|-
|18 March 2013
|12.1
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
|03 May 2013
|12.2
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
|24 December 2013
|12.3
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
| style="background:#eee;" | 04 May 2014
| style="background:#eee;" | 13.0
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
| style="background:#eee;" | 05 June 2014
| style="background:#eee;" | 13.1
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
| style="background:#eee;" | 17 August 2014
| style="background:#eee;" | 13.2
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
|23 December 2014
|14.0
|Helix
|{"major":6,"minor":21,"patch":2}
|-
|30 January 2014
|14.1
|Helix
|{"major":6,"minor":21,"patch":2}
|-
|26 March 2014
|14.2
|Helix
|{"major":6,"minor":21,"patch":2}
|-
| style="background:#eee;" | 21 July 2015
| style="background:#eee;" | 15.0
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
| style="background:#eee;" | 16 August 2015
| style="background:#eee;" | 15.1
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
| style="background:#eee;" | 19 October 2015
| style="background:#eee;" | 15.2
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
|21 February 2016
|16.0
|Jarvis
|{"major":6,"minor":32,"patch":4}
|-
|24 April 2016
|16.1
|Jarvis
|{"major":6,"minor":32,"patch":5}
|-
| style="background:#eee;" | 5 February 2017
| style="background:#eee;" | 17.0
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
|}

== Documentation ==
Kodi's JSON-RPC API has been designed to be self-documented i.e. a call to [[/#JSONRPC.Introspect|JSONRPC.Introspect]] results in a JSON-RPC response containing a documentation for all the available methods and data types. While this documentation is very incomplete and partly wrong for [[/v2|version 2]] it is provided as a full [http://tools.ietf.org/html/draft-zyp-json-schema-03 JSON schema] starting with [[/v3|version 3]]. As the documentation retrieved in that way is always specific to the used version of Kodi, it is (especially for development versions) the best documentation available and should be preferred over the wiki documentation as the latter always documents the API of the latest development.

== Debugging ==
=== Output format ===
To be able to support easier debugging of (third-party) development using the JSON-RPC API, the JSON output generated by Kodi can be pretty-printed by setting
<syntaxhighlight lang="xml" enclose="div">
<jsonrpc>
<compactoutput>false</compactoutput>
</jsonrpc>
</syntaxhighlight>
in the [[Advancedsettings.xml#.3Cjsonrpc.3E|advancedsettings.xml]]. Default JSON output will be in compact format to minimize sent data (especially useful for mobile devices).

=== Direct interaction ===
To be able to test some methods of Kodi's JSON-RPC API, it can be of great help to be able to send a single hand-written JSON-RPC request to Kodi to see its effect and the generated response. Depending on the transport protocol used there are different possibilities to do that:

==== TCP ====
With a [http://en.wikipedia.org/wiki/Telnet telnet] connection (using [http://en.wikipedia.org/wiki/PuTTY PuTTY] on Windows or telnet on Linux) to port 9090 of the machine running Kodi it is possible to send and receive raw json data to/from Kodi. {{see also|SSH}}

==== HTTP ====
A simple way of manually sending HTTP requests containing a JSON-RPC request to Kodi is using the [http://chrome.google.com/extensions/detail/fhjcajmcbmldlhcimfajhfbgofnpcjmb Simple REST Client] extension for Google's Chrome/Chromium browser. It allows defining a URL and the HTTP request type ('''POST''' is what we need). The actual JSON-RPC request can be defined in the '''Data''' field and then sent to Kodi.

== See also ==
* [[/v2|JSON-RPC API v2 (Dharma)]]
* [[/v4|JSON-RPC API v4 (Eden)]]
* [[/v6|JSON-RPC API v6 (Frodo - Jarvis)]]
* [[/v8|JSON-RPC API v8 (Krypton)]]

== External links ==
* [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]
* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]

== Examples ==
These examples take their base from v4. Any that require a higher version will be marked.

[[JSON-RPC API/Examples]]

[[Category:Manual]]
[[Category:Development]]

Template:JSON-RPC API nav

2017-02-19T20:34:44Z

Ncarthy: Add v8 link

{{Navigation
| nav name = JSON-RPC API
| link1 = JSON-RPC API
| link1 name = Overview
| link2 = JSON-RPC API/v2
| link2 name = v2 (Dharma)
| link3 = JSON-RPC API/v4
| link3 name = v4 (Eden)
| link4 = JSON-RPC API/v6
| link4 name = v6 (Frodo/Gotham/Helix/Isengard)
| link5 = JSON-RPC API/v8
| link5 name = v8 (Krypton)
}}<noinclude>[[Category:Navigation templates]]</noinclude>

JSON-RPC API

2017-02-19T20:19:58Z

Ncarthy:

{{mininav|[[Development]]}}

{{JSON-RPC API nav}}
<br />

JSON-RPC is a HTTP- and/or raw TCP socket-based interface for communicating with Kodi. It replaces the deprecated [[HTTP API]], and offers a more secure and robust mechanism in the same format. It is based upon the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification].

Each method in the interface can have different security needs which means one client may be allowed to only control playback while another can only read and manipulate the library. In version 2 (first stable) and 4 all clients are granted full authority but will later be forced to ask for privileges and the user of Kodi will have to grant said client access. The design of JSON-RPC is that most methods should behave roughly the same and maintain consistency while hiding the mechanics of Kodi from the client creator.

In Kodi JSON-RPC can be accessed over a variety of transports and has been designed from the ground up to be flexible to allow control over new transports easily. Some of the transports have different limitations which will be enforced upon the interaction over that transport. As an example HTTP transports allow response and downloading of files while the raw TCP transport allows response and notifications (events and information Kodi sends to its clients). Depending on the client's needs it will choose one (or many) of the available transports.<br />

== Enabling JSON-RPC ==
Since the interface is available on many transports enabling it depends on the transport.
* Python: Always enabled
* HTTP: In System/Settings/Network/Services activate ''Allow control of Kodi via HTTP'' (see [[Webserver#Enabling the webserver|Enabling the webserver]])
* TCP: In System/Settings/Network/Services activate ''Allow programs on this system to control Kodi'' for localhost access only and ''Allow programs on other systems to control Kodi'' for access from other computers as well

Note: The [[EventServer]] is a different interface for sending remote keypresses to Kodi, and must be enabled separately, some programs may use both interfaces.

== Transports & Functionalities ==
=== Transports ===
==== Python ====
The ''Python'' transport can only be used by Kodi addons through the '''executeJSONRPC''' method provided by the '''xbmc''' python library. As it must be available to every addon in an Kodi installation it must not be enabled or disabled by the user.

==== HTTP ====
The ''HTTP'' transport can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol HTTP] protocol. Because this transport allows applications outside Kodi to control Kodi, it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user.

===== POST =====
Third-party applications can access Kodi's JSON-RPC API by sending JSON-RPC requests embedded in HTTP [http://en.wikipedia.org/wiki/POST_(HTTP) POST] requests to the following URL
<pre>http://<your-ip>:<your-port>/jsonrpc</pre>

Starting with Frodo nightly builds it is mandatory to set the HTTP header field '''Content-Type: application/json'''

===== GET =====
Third-party application can access Kodi's JSON-RPC API by sending JSON-RPC requests embedded in a HTTP GET parameter called ''request''. The JSON-RPC request must be URL encoded and sent to the following URL
<pre>http://<your-ip>:<your-port>/jsonrpc?request=<url-encoded-request></pre>

==== TCP ====
The ''TCP'' transport can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/Transmission_Control_Protocol TCP] protocol. Because this transport allows applications outside Kodi to control Kodi it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user. Once enabled, third-party applications can access Kodi's JSON-RPC API by opening a TCP [http://en.wikipedia.org/wiki/Internet_socket socket] on port 9090 (this port can be configured in the [[Advancedsettings.xml#<jsonrpc>|advanced settings]] file) and sending raw JSON-RPC requests over that socket. Please note that no delimiters are provided in between notifications and/or responses. As such, your client needs to be able to deal with this, eg. by counting and matching curly braces ({}).

==== WebSocket ====
The ''WebSocket'' transport has been added since Version 5 and can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/WebSocket Websocket] protocol. The supported versions are 8 (draft [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-10 hybi-10]) and 13 ([http://tools.ietf.org/html/rfc6455 RFC 6455]). Because this transport allows applications outside Kodi to control Kodi it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user. Once enabled, third-party applications can access Kodi's JSON-RPC API by sending a WebSocket protocol handshake to the following URI
<pre>ws://<your-ip>:<configured tcp port>/jsonrpc</pre>
It is important to send the handshake on the port of Kodi's TCP server (by default 9090, but this port can be configured in the [[Advancedsettings.xml#<jsonrpc>|advanced settings]] file). After having successfully finished the handshake third-party applications can send WebSocket protocl messages over that connection.

=== Functionalities ===
==== Response ====
The ''Response'' functionality is the only functionality that should be present in every transport available as it describes the functionality to respond to a JSON-RPC request with a valid JSON-RPC response (be it an error message or an actual response).

==== Notifications ====
The ''Notifications'' functionality includes both server-side (from the server to clients) and client-side (from clients to the server) notifications. A JSON-RPC notification is a valid JSON-RPC request with no ''id'' property. Following the JSON-RPC 2.0 specification any JSON-RPC request with no ''id'' must be considered as a notification and the receiver must not send a response upon a notification.

In the specific case of Kodi, server-side notifications are used to inform clients about certain events to relieve clients of the need to periodically poll for certain events. Furthermore there are two ways of client-side notifications. Using [[/#JSONRPC.NotifyAll|JSONRPC.NotifyAll]] it is possible to ask Kodi to relay the message in the JSON-RPC request to all other connected clients. The second way is to send JSON-RPC requests without an ''id'' property in case the client does not care about the response (e.g. the method [[/#Player.Stop|Player.Stop]] does not return any useful information to the client).

==== Direct file download ====
The ''Direct file download'' functionality is the ability to directly download files from Kodi by calling [[/#Files.Download|Files.Download]]. In this case the term ''direct'' means that the download happens within the JSON-RPC response of the [[/#Files.Download|Files.Download]] request.

==== Redirected file download ====
The ''Redirected file download'' functionality is the ability to indirectly download files from Kodi by calling [[/#Files.PrepareDownload|Files.PrepareDownload]] and using the data received in the response to download the file over a different protocol (like HTTP, FTP ...) or another socket. As the ''Redirected file download'' is very transport specific, it must be handled separately for every transport supporting it.

=== Comparison ===
The following table shows all the available transports and what functionalities they support
{| class="prettytable" style="margin-right: 0;"
!style="padding-left: 5px; padding-right: 10px;" colspan="2"|Transport
!style="padding-left: 10px; padding-right: 10px;"|Response
!style="padding-left: 10px; padding-right: 10px;"|Notifications
!style="padding-left: 10px; padding-right: 10px;"|Direct file<br />download
!style="padding-left: 10px; padding-right: 10px;"|Redirected file<br />download
|-
|style="padding-left: 5px;" colspan="2"|[[Python Development|Python]]
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;" colspan="2"|[http://en.wikipedia.org/wiki/Transmission_Control_Protocol TCP]
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right:5px;" rowspan="2"|[http://en.wikipedia.org/wiki/HTTP HTTP]
|style="padding-left: 5px; padding-right:5px;"|POST
|{{yes}}
|{{no}}
|{{no}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right:5px;"|GET<sup>1</sup>
|{{yes}}
|{{no}}
|{{no}}
|{{yes}}
|-
|style="padding-left: 5px;" colspan="2"|[http://en.wikipedia.org/wiki/WebSocket WebSocket]<sup>1</sup>
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|}
<sup>1</sup> Added in Version 5

== API versions ==
The JSON-RPC API exposed by Kodi is constantly extended to provide better and more functionality to third party applications. For that reason Kodi provides a version information through the '''JSONRPC.Version''' method. The rule is that odd version numbers describe an API state, that is not stable and under heavy development whereas even version numbers describe a stable API. Therefore the version number can be used by third-party clients to check if their application might not be fully compatible with the JSON-RPC API exposed by a user's Kodi installation.

Starting with XBMC v12 (Frodo) we started using a new versioning system (<major>.<minor>.<patch>) for the JSON-RPC API. Frodo stable is version 6.0.0 and from now on with every bugfix the <patch> part of the version is increased, with every feature addition to the API, the <minor> version is increased (and the <patch> version reset to 0) and with every backwards incompatible change, the <major> version is increased.

{| class="prettytable" style="margin-right: 0;"
!colspan="3"|Release
!colspan="6"|JSON-RPC 2.0 specification
!colspan="5"|Transports
|-
!style="padding-left: 5px; padding-right: 5px; width: 6em; text-align: left;"|API Version
!style="padding-left: 10px; padding-right: 10px; width: 5em;"|Version
!style="padding-left: 10px; padding-right: 10px; width: 4em;"|Name
!style="padding-left: 10px; padding-right: 10px;"|Method calls
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(server-side)
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(client-side)
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-name
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-position
!style="padding-left: 10px; padding-right: 10px;"|Batch requests

!style="padding-left: 10px; padding-right: 10px;"|Python
!style="padding-left: 10px; padding-right: 10px;"|TCP
!style="padding-left: 10px; padding-right: 10px;"|HTTP POST
!style="padding-left: 10px; padding-right: 10px;"|HTTP GET
!style="padding-left: 10px; padding-right: 10px;"|WebSocket
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v2|Version 2]]
|style="padding-left: 5px; padding-right: 5px;"|10.0
|style="padding-left: 5px; padding-right: 5px;"|Dharma
|{{yes}}
|{{yes}}
|{{no}}
|{{yes}}
|{{no}}
|{{no}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v3|Version 3]] / [[/v4|4]]
|style="padding-left: 5px; padding-right: 5px;"|pre-11 / 11.0
|style="padding-left: 5px; padding-right: 5px;"|Eden
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v5|Version 5]] / [[/v6|6]]
|style="padding-left: 5px; padding-right: 5px;"|pre-12 / 12.0
|style="padding-left: 5px; padding-right: 5px;"|Frodo
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.0
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.1
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.2
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.0
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.1
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.2
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.0
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.1
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.2
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|16.0
|style="padding-left: 5px; padding-right: 5px;"|Jarvis
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|16.1
|style="padding-left: 5px; padding-right: 5px;"|Jarvis
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|}

{| class="prettytable" style="margin-right: 0;"
!colspan="3"|Release
!|JSONRPC.Version
|-
!style="padding-left: 10px; padding-right: 10px;"|Date
!style="padding-left: 10px; padding-right: 10px;"|Version
!style="padding-left: 10px; padding-right: 10px;"|Codename
!style="padding-left: 10px; padding-right: 10px;"|["version"]
|-
|18 December 2010
|10.0
|Dharma
|2
|-
|10 March 2011
|10.1
|Dharma
|2
|-
| style="background:#eee;" |24 March 2012
| style="background:#eee;" |11.0
| style="background:#eee;" |Eden
| style="background:#eee;" |4
|-
|29 January 2013
|12.0
|Frodo
|{"major":6,"minor":0,"patch":0}
|-
|18 March 2013
|12.1
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
|03 May 2013
|12.2
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
|24 December 2013
|12.3
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
| style="background:#eee;" | 04 May 2014
| style="background:#eee;" | 13.0
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
| style="background:#eee;" | 05 June 2014
| style="background:#eee;" | 13.1
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
| style="background:#eee;" | 17 August 2014
| style="background:#eee;" | 13.2
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
|23 December 2014
|14.0
|Helix
|{"major":6,"minor":21,"patch":2}
|-
|30 January 2014
|14.1
|Helix
|{"major":6,"minor":21,"patch":2}
|-
|26 March 2014
|14.2
|Helix
|{"major":6,"minor":21,"patch":2}
|-
| style="background:#eee;" | 21 July 2015
| style="background:#eee;" | 15.0
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
| style="background:#eee;" | 16 August 2015
| style="background:#eee;" | 15.1
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
| style="background:#eee;" | 19 October 2015
| style="background:#eee;" | 15.2
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
|21 February 2016
|16.0
|Jarvis
|{"major":6,"minor":32,"patch":4}
|-
|24 April 2016
|16.1
|Jarvis
|{"major":6,"minor":32,"patch":5}
|-
| style="background:#eee;" | ?? December 2016
| style="background:#eee;" | 17.0
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
|}

== Documentation ==
Kodi's JSON-RPC API has been designed to be self-documented i.e. a call to [[/#JSONRPC.Introspect|JSONRPC.Introspect]] results in a JSON-RPC response containing a documentation for all the available methods and data types. While this documentation is very incomplete and partly wrong for [[/v2|version 2]] it is provided as a full [http://tools.ietf.org/html/draft-zyp-json-schema-03 JSON schema] starting with [[/v3|version 3]]. As the documentation retrieved in that way is always specific to the used version of Kodi, it is (especially for development versions) the best documentation available and should be preferred over the wiki documentation as the latter always documents the API of the latest development.

== Debugging ==
=== Output format ===
To be able to support easier debugging of (third-party) development using the JSON-RPC API, the JSON output generated by Kodi can be pretty-printed by setting
<syntaxhighlight lang="xml" enclose="div">
<jsonrpc>
<compactoutput>false</compactoutput>
</jsonrpc>
</syntaxhighlight>
in the [[Advancedsettings.xml#.3Cjsonrpc.3E|advancedsettings.xml]]. Default JSON output will be in compact format to minimize sent data (especially useful for mobile devices).

=== Direct interaction ===
To be able to test some methods of Kodi's JSON-RPC API, it can be of great help to be able to send a single hand-written JSON-RPC request to Kodi to see its effect and the generated response. Depending on the transport protocol used there are different possibilities to do that:

==== TCP ====
With a [http://en.wikipedia.org/wiki/Telnet telnet] connection (using [http://en.wikipedia.org/wiki/PuTTY PuTTY] on Windows or telnet on Linux) to port 9090 of the machine running Kodi it is possible to send and receive raw json data to/from Kodi. {{see also|SSH}}

==== HTTP ====
A simple way of manually sending HTTP requests containing a JSON-RPC request to Kodi is using the [http://chrome.google.com/extensions/detail/fhjcajmcbmldlhcimfajhfbgofnpcjmb Simple REST Client] extension for Google's Chrome/Chromium browser. It allows defining a URL and the HTTP request type ('''POST''' is what we need). The actual JSON-RPC request can be defined in the '''Data''' field and then sent to Kodi.

== See also ==
* [[/v2|JSON-RPC API v2 (Dharma)]]
* [[/v4|JSON-RPC API v4 (Eden)]]
* [[/v6|JSON-RPC API v6 (Frodo - Jarvis)]]
* [[/v8|JSON-RPC API v8 (Krypton)]]

== External links ==
* [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]
* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]

== Examples ==
These examples take their base from v4. Any that require a higher version will be marked.

[[JSON-RPC API/Examples]]

[[Category:Manual]]
[[Category:Development]]

Talk:JSON-RPC API/v8

2017-02-19T20:18:26Z

Ncarthy:

I generated the wiki markup text on this page using a simple JSON Schema parser that I wrote specially for this. It's written in C# because that's the language I know best. The code is available here: https://github.com/ncarthy/kodi-introspect-csharp

[[User:Ncarthy|Ncarthy]] ([[User talk:Ncarthy|talk]]) 15:18, 19 February 2017 (EST)

Talk:JSON-RPC API/v8

2017-02-19T20:18:11Z

Ncarthy: Link to github project for markup text generation

I generated the wiki markup text on this page using a simple JSON Schema parser that I wrote specially for this. It's written in C# because that's the language I know best. The code is available here: https://github.com/ncarthy/kodi-introspect-csharp
[[User:Ncarthy|Ncarthy]] ([[User talk:Ncarthy|talk]]) 15:18, 19 February 2017 (EST)

JSON-RPC API/v8

2017-02-19T20:08:42Z

Ncarthy: /* Global Types */

{{mininav|[[Development]]|[[JSON-RPC API]]}}

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

It comes with support for [http://en.wikipedia.org/wiki/WebSocket 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.

{{TOC right}}
== JSON-RPC 2.0 compatibility ==
{| class="prettytable" style="margin-right: 0;"
!style="padding-left: 5px; width: 7em; text-align: left;"|Version
!style="padding-left: 10px; padding-right: 10px;"|Method calls
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(server-side)
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(client-side)
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-name
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-position
!style="padding-left: 10px; padding-right: 10px;"|Batch requests
|-
|style="padding-left: 5px;"|Version 6
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|}

== Documentation (JSON Schema) ==
=== Supported features of JSON Schema ===
<div style="float:left; margin-right:2em">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema
!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 type]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.2 properties]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.3 patternProperties]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.4 additionalProperties]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.5 items]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.6 additionalItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.7 required]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.8 dependencies]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.9 minimum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.10 maximum]
|{{yes}}
|-
|}
</div>

<div style="float:left; margin-right:2em">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema

!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03

|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.11 exclusiveMinimum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.12 exclusiveMaximum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.13 minItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.14 maxItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.15 uniqueItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.16 pattern]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.17 minLength]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.18 maxLength]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.19 enum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.20 default]
|{{yes}}
|-
|}
</div>

<div style="float:left;">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema

!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.21 title]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.22 description]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 format]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.24 divisibleBy]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.25 disallow]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.26 extends]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.27 id]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.28 $ref]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.29 $schema]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-6 Hyper Schema]
|{{no}}
|-
|}
</div>
<div style="clear:left;"></div>

== 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
{|
|
<syntaxhighlight lang="javascript" enclose="div">
{
"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" }
}
}
}
}
}
}
</syntaxhighlight>
|}

== Namespaces ==
The Kodi JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:
{|
|
<pre>
Addons List, enable and execute addons
Application Application information and control
AudioLibrary Audio Library information
Favourites Favourites GetFavourites and AddFavourite
Files Shares information & filesystem listings
GUI Window properties and activation
Input Allows limited navigation within Kodi
JSONRPC A variety of standard JSONRPC calls
Player Manages all available players
Playlist Playlist modification
Profiles Support for Profiles operations to xbmc.
PVR Live TV control
Settings Allows manipulation of Kodi settings.
System System controls and information
Textures Supplies GetTextures and RemoveTexture. Textures are images.
VideoLibrary Video Library information
XBMC Dumping ground for very Kodi specific operations
</pre>
|}

== Methods ==
=== Addons ===
==== Addons.ExecuteAddon ====
Executes the given addon with the given parameters (if possible)<br />
'''Permissions:'''
* ExecuteAddon
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid
# [ ''mixed: object|array|string'' params ]
# [ ''boolean'' wait = false ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Executes the given addon with the given parameters (if possible)",
"permission": "ExecuteAddon",
"type": "method",
"params": [
{
"type": "string",
"name": "addonid",
"required": true
},
{
"default": "",
"type": [
{
"additionalProperties": {
"default": "",
"type": "string"
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"description": "URL path (must start with / or ?",
"type": "string"
}
],
"name": "params"
},
{
"default": "false",
"type": "boolean",
"name": "wait"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Addons.GetAddonDetails ====
Gets the details of a specific addon<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid
# [ ''[[#Addon.Fields|Addon.Fields]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Addon.Details|Addon.Details]]'' addon
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Gets the details of a specific addon",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "addonid",
"required": true
},
{
"$ref": "Addon.Fields",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"addon": {
"$ref": "Addon.Details",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Addons.GetAddons ====
Gets all available addons<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Addon.Types|Addon.Types]]'' type = "unknown" ]
# [ ''[[#Addon.Content|Addon.Content]]'' content = "unknown" ] ''Content provided by the addon. Only considered for plugins and scripts.''
# [ ''mixed: boolean|string'' enabled = "all" ]
# [ ''[[#Addon.Fields|Addon.Fields]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''mixed: boolean|string'' installed = true ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Addon.Details|Addon.Details]]''[] addons ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Gets all available addons",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "unknown",
"$ref": "Addon.Types",
"name": "type"
},
{
"default": "unknown",
"description": "Content provided by the addon. Only considered for plugins and scripts.",
"$ref": "Addon.Content",
"name": "content"
},
{
"default": "all",
"type": [
{
"type": "boolean"
},
{
"enums": [
"all"
],
"type": "string"
}
],
"name": "enabled"
},
{
"$ref": "Addon.Fields",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"default": "true",
"type": [
{
"type": "boolean"
},
{
"enums": [
"all"
],
"type": "string"
}
],
"name": "installed"
}
],
"returns": {
"type": "object",
"properties": {
"addons": {
"items": {
"$ref": "Addon.Details"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Addons.SetAddonEnabled ====
Enables/Disables a specific addon<br />
'''Permissions:'''
* ManageAddon
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid
# ''[[#Global.Toggle|Global.Toggle]]'' enabled
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Enables/Disables a specific addon",
"permission": "ManageAddon",
"type": "method",
"params": [
{
"type": "string",
"name": "addonid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "enabled",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Application ===
==== Application.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Application.Property.Name|Application.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Application.Property.Value|Application.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"$ref": "Application.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "Application.Property.Value"
}
}</syntaxhighlight>}}

==== Application.Quit ====
Quit application<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Quit application",
"permission": "ControlPower",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Application.SetMute ====
Toggle mute/unmute<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Global.Toggle|Global.Toggle]]'' mute
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />

'''Description:''' ''Mute state''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Toggle mute/unmute",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Global.Toggle",
"name": "mute",
"required": true
}
],
"returns": {
"type": "boolean",
"description": "Mute state"
}
}</syntaxhighlight>}}

==== Application.SetVolume ====
Set the current volume<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed'' volume
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''integer''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Set the current volume",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"type": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"$ref": "Global.IncrementDecrement"
}
],
"name": "volume",
"required": true
}
],
"returns": {
"type": "integer"
}
}</syntaxhighlight>}}

=== AudioLibrary ===
==== AudioLibrary.Clean ====
Cleans the audio library from non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''boolean'' showdialogs = true ] ''Whether or not to show the progress bar or any other GUI dialog''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Cleans the audio library from non-existent items",
"permission": "RemoveData",
"type": "method",
"params": [
{
"default": "true",
"description": "Whether or not to show the progress bar or any other GUI dialog",
"type": "boolean",
"name": "showdialogs"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.Export ====
Exports all items from the audio library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed: object|object'' options ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Exports all items from the audio library",
"permission": "WriteFile",
"type": "method",
"params": [
{
"type": [
{
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the directory to where the data should be exported",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"images": {
"default": false,
"description": "Whether to export thumbnails and fanart images",
"type": "boolean"
},
"overwrite": {
"default": false,
"description": "Whether to overwrite existing exported files",
"type": "boolean"
}
},
"type": "object"
}
],
"name": "options"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetAlbumDetails ====
Retrieve details about a specific album<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' albumid
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]'' albumdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific album",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
{
"$ref": "Audio.Fields.Album",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"albumdetails": {
"$ref": "Audio.Details.Album"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetAlbums ====
Retrieve all albums from specified artist (and role) or that has songs of the specified genre<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
# [ ''boolean'' includesingles = false ]
# [ ''boolean'' allroles = false ] ''Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all albums from specified artist (and role) or that has songs of the specified genre",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Song genre. Filter for existance of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Song genre. Filter for existance of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Albums"
}
],
"name": "filter"
},
{
"default": "false",
"type": "boolean",
"name": "includesingles"
},
{
"default": "false",
"description": "Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.",
"type": "boolean",
"name": "allroles"
}
],
"returns": {
"type": "object",
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetArtistDetails ====
Retrieve details about a specific artist<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' artistid
# [ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Artist|Audio.Details.Artist]]'' artistdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific artist",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
{
"$ref": "Audio.Fields.Artist",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"artistdetails": {
"$ref": "Audio.Details.Artist"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetArtists ====
Retrieve all artists. For backward compatibility by default this implicity does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Optional.Boolean|Optional.Boolean]]'' albumartistsonly ] ''Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used''
# [ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
# [ ''boolean'' allroles = false ] ''Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Artist|Audio.Details.Artist]]''[] artists ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all artists. For backward compatibility by default this implicity does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true",
"permission": "ReadData",
"type": "method",
"params": [
{
"description": "Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used",
"$ref": "Optional.Boolean",
"name": "albumartistsonly"
},
{
"$ref": "Audio.Fields.Artist",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Deprecated, use songgenreid. Filter for existance of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songgenreid": {
"$ref": "Library.Id",
"description": "Song genreid. Filter for existance of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songgenreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songgenreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Deprecated, use songgenre. Filter for existance of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songgenre": {
"description": "Song genre. Filter for existance of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songgenre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songgenre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"album": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"description": "Role contributed by artist. Overriden by allroles parameter",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"description": "Role contributed by artist. Overriden by allroles parameter",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Artists"
}
],
"name": "filter"
},
{
"default": "false",
"description": "Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.",
"type": "boolean",
"name": "allroles"
}
],
"returns": {
"type": "object",
"properties": {
"artists": {
"items": {
"$ref": "Audio.Details.Artist"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetGenres ====
Retrieve all genres<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Library.Details.Genre|Library.Details.Genre]]''[] genres
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all genres",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Fields.Genre",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"genres": {
"items": {
"$ref": "Library.Details.Genre"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetProperties ====
Retrieves the values of the music library properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Audio.Property.Name|Audio.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Audio.Property.Value|Audio.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the values of the music library properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"$ref": "Audio.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "Audio.Property.Value"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRecentlyAddedAlbums ====
Retrieve recently added albums<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve recently added albums",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRecentlyAddedSongs ====
Retrieve recently added songs<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#List.Amount|List.Amount]]'' albumlimit = "-1" ] ''The amount of recently added albums from which to return the songs''
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve recently added songs",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "-1",
"description": "The amount of recently added albums from which to return the songs",
"$ref": "List.Amount",
"name": "albumlimit"
},
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRecentlyPlayedAlbums ====
Retrieve recently played albums<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve recently played albums",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRecentlyPlayedSongs ====
Retrieve recently played songs<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve recently played songs",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRoles ====
Retrieve all contributor roles<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Role|Audio.Fields.Role]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#Audio.Details.Role|Audio.Details.Role]]''[] roles
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all contributor roles",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Role",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"roles": {
"items": {
"$ref": "Audio.Details.Role"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetSongDetails ====
Retrieve details about a specific song<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' songid
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]'' songdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific song",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "songid",
"required": true
},
{
"$ref": "Audio.Fields.Song",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"songdetails": {
"$ref": "Audio.Details.Song"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetSongs ====
Retrieve all songs from specified album, artist or genre<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
# [ ''boolean'' includesingles = true ]
# [ ''boolean'' allroles = false ] ''Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all songs from specified album, artist or genre",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Song genre. Filter for existance of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Song genre. Filter for existance of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"album": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Songs"
}
],
"name": "filter"
},
{
"default": "true",
"type": "boolean",
"name": "includesingles"
},
{
"default": "false",
"description": "Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.",
"type": "boolean",
"name": "allroles"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.Scan ====
Scans the audio sources for new library items<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''string'' directory ]
# [ ''boolean'' showdialogs = true ] ''Whether or not to show the progress bar or any other GUI dialog''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Scans the audio sources for new library items",
"permission": "UpdateData",
"type": "method",
"params": [
{
"default": "",
"type": "string",
"name": "directory"
},
{
"default": "true",
"description": "Whether or not to show the progress bar or any other GUI dialog",
"type": "boolean",
"name": "showdialogs"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.SetAlbumDetails ====
Update the given album with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' albumid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''mixed'' artist ]
# [ ''[[#Optional.String|Optional.String]]'' description ]
# [ ''mixed'' genre ]
# [ ''mixed'' theme ]
# [ ''mixed'' mood ]
# [ ''mixed'' style ]
# [ ''[[#Optional.String|Optional.String]]'' type ]
# [ ''[[#Optional.String|Optional.String]]'' albumlabel ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' votes ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given album with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "artist"
},
{
"$ref": "Optional.String",
"name": "description"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "theme"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "mood"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "style"
},
{
"$ref": "Optional.String",
"name": "type"
},
{
"$ref": "Optional.String",
"name": "albumlabel"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.Integer",
"name": "year"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Optional.Integer",
"name": "votes"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.SetArtistDetails ====
Update the given artist with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' artistid
# [ ''[[#Optional.String|Optional.String]]'' artist ]
# [ ''mixed'' instrument ]
# [ ''mixed'' style ]
# [ ''mixed'' mood ]
# [ ''[[#Optional.String|Optional.String]]'' born ]
# [ ''[[#Optional.String|Optional.String]]'' formed ]
# [ ''[[#Optional.String|Optional.String]]'' description ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.String|Optional.String]]'' died ]
# [ ''[[#Optional.String|Optional.String]]'' disbanded ]
# [ ''mixed'' yearsactive ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given artist with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
{
"$ref": "Optional.String",
"name": "artist"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "instrument"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "style"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "mood"
},
{
"$ref": "Optional.String",
"name": "born"
},
{
"$ref": "Optional.String",
"name": "formed"
},
{
"$ref": "Optional.String",
"name": "description"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"$ref": "Optional.String",
"name": "died"
},
{
"$ref": "Optional.String",
"name": "disbanded"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "yearsactive"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.SetSongDetails ====
Update the given song with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' songid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''mixed'' artist ]
# [ ''mixed'' albumartist ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.String|Optional.String]]'' album ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' track ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' disc ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' duration ]
# [ ''[[#Optional.String|Optional.String]]'' comment ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainztrackid ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainzartistid ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainzalbumid ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainzalbumartistid ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' votes ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given song with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "songid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "artist"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "albumartist"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"$ref": "Optional.Integer",
"name": "year"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.String",
"name": "album"
},
{
"$ref": "Optional.Integer",
"name": "track"
},
{
"$ref": "Optional.Integer",
"name": "disc"
},
{
"$ref": "Optional.Integer",
"name": "duration"
},
{
"$ref": "Optional.String",
"name": "comment"
},
{
"$ref": "Optional.String",
"name": "musicbrainztrackid"
},
{
"$ref": "Optional.String",
"name": "musicbrainzartistid"
},
{
"$ref": "Optional.String",
"name": "musicbrainzalbumid"
},
{
"$ref": "Optional.String",
"name": "musicbrainzalbumartistid"
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Optional.Integer",
"name": "votes"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Favourites ===
==== Favourites.AddFavourite ====
Add a favourite with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' title
# ''[[#Favourite.Type|Favourite.Type]]'' type
# [ ''[[#Optional.String|Optional.String]]'' path ] ''Required for media and script favourites types''
# [ ''[[#Optional.String|Optional.String]]'' window ] ''Required for window favourite type''
# [ ''[[#Optional.String|Optional.String]]'' windowparameter ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Add a favourite with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"type": "string",
"name": "title",
"required": true
},
{
"$ref": "Favourite.Type",
"name": "type",
"required": true
},
{
"description": "Required for media and script favourites types",
"$ref": "Optional.String",
"name": "path"
},
{
"description": "Required for window favourite type",
"$ref": "Optional.String",
"name": "window"
},
{
"$ref": "Optional.String",
"name": "windowparameter"
},
{
"$ref": "Optional.String",
"name": "thumbnail"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Favourites.GetFavourites ====
Retrieve all favourites<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed'' type ]
# [ ''[[#Favourite.Fields.Favourite|Favourite.Fields.Favourite]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Favourite.Details.Favourite|Favourite.Details.Favourite]]''[] favourites ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all favourites",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": [
{
"type": "null"
},
{
"$ref": "Favourite.Type"
}
],
"name": "type"
},
{
"$ref": "Favourite.Fields.Favourite",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"favourites": {
"items": {
"$ref": "Favourite.Details.Favourite"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

=== Files ===
==== Files.GetDirectory ====
Get the directories and files in the given directory<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' directory
# [ ''[[#Files.Media|Files.Media]]'' media = "files" ]
# [ ''[[#List.Fields.Files|List.Fields.Files]]'' properties ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ] ''Limits are applied after getting the directory content thus retrieval is not faster when they are applied.''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.Item.File|List.Item.File]]''[] files
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Get the directories and files in the given directory",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "directory",
"required": true
},
{
"default": "files",
"$ref": "Files.Media",
"name": "media"
},
{
"$ref": "List.Fields.Files",
"name": "properties"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"description": "Limits are applied after getting the directory content thus retrieval is not faster when they are applied.",
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"files": {
"items": {
"$ref": "List.Item.File"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Files.GetFileDetails ====
Get details for a specific file<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file ''Full path to the file''
# [ ''[[#Files.Media|Files.Media]]'' media = "files" ]
# [ ''[[#List.Fields.Files|List.Fields.Files]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.Item.File|List.Item.File]]'' filedetails
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Get details for a specific file",
"permission": "ReadData",
"type": "method",
"params": [
{
"description": "Full path to the file",
"type": "string",
"name": "file",
"required": true
},
{
"default": "files",
"$ref": "Files.Media",
"name": "media"
},
{
"$ref": "List.Fields.Files",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"filedetails": {
"$ref": "List.Item.File",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Files.GetSources ====
Get the sources of the media windows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Files.Media|Files.Media]]'' media
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.Items.Sources|List.Items.Sources]]'' sources
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Get the sources of the media windows",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Files.Media",
"name": "media",
"required": true
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sources": {
"$ref": "List.Items.Sources",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Files.PrepareDownload ====
Provides a way to download a given file (e.g. providing an URL to the real file location)<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' path
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''mixed'' ''Transport specific details on how/from where to download the given file''details
* ''string'' ''Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol''mode
* ''string'' protocol
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Provides a way to download a given file (e.g. providing an URL to the real file location)",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "path",
"required": true
}
],
"returns": {
"type": "object",
"properties": {
"details": {
"description": "Transport specific details on how/from where to download the given file",
"type": "any",
"required": true
},
"mode": {
"description": "Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol",
"type": "string",
"required": true
},
"protocol": {
"type": "string",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Files.SetFileDetails ====
Update the given specific file with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file ''Full path to the file''
# ''[[#Files.Media|Files.Media]]'' media ''File type to update correct database. Currently only "video" is supported.''
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ] ''Setting a valid lastplayed without a playcount will force playcount to 1.''
# [ ''mixed'' resume ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given specific file with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"description": "Full path to the file",
"type": "string",
"name": "file",
"required": true
},
{
"description": "File type to update correct database. Currently only \"video\" is supported.",
"$ref": "Files.Media",
"name": "media",
"required": true
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"description": "Setting a valid lastplayed without a playcount will force playcount to 1.",
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
],
"name": "resume"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== GUI ===
==== GUI.ActivateWindow ====
Activates the given window<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#GUI.Window|GUI.Window]]'' window
# [ ''string''[] parameters ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Activates the given window",
"permission": "ControlGUI",
"type": "method",
"params": [
{
"$ref": "GUI.Window",
"name": "window",
"required": true
},
{
"items": {
"type": "string"
},
"type": "array",
"name": "parameters"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== GUI.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#GUI.Property.Name|GUI.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#GUI.Property.Value|GUI.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"$ref": "GUI.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "GUI.Property.Value"
}
}</syntaxhighlight>}}

==== GUI.GetStereoscopicModes ====
Returns the supported stereoscopic modes of the GUI<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]''[] stereoscopicmodes ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Returns the supported stereoscopic modes of the GUI",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "object",
"properties": {
"stereoscopicmodes": {
"items": {
"$ref": "GUI.Stereoscopy.Mode"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== GUI.SetFullscreen ====
Toggle fullscreen/GUI<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Global.Toggle|Global.Toggle]]'' fullscreen
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />

'''Description:''' ''Fullscreen state''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Toggle fullscreen/GUI",
"permission": "ControlGUI",
"type": "method",
"params": [
{
"$ref": "Global.Toggle",
"name": "fullscreen",
"required": true
}
],
"returns": {
"type": "boolean",
"description": "Fullscreen state"
}
}</syntaxhighlight>}}

==== GUI.SetStereoscopicMode ====
Sets the stereoscopic mode of the GUI to the given mode<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' mode
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Sets the stereoscopic mode of the GUI to the given mode",
"permission": "ControlGUI",
"type": "method",
"params": [
{
"type": "string",
"name": "mode",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== GUI.ShowNotification ====
Shows a GUI notification<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' title
# ''string'' message
# [ ''mixed: string|string'' image ]
# [ ''integer'' displaytime = "5000" ] ''The time in milliseconds the notification will be visible''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Shows a GUI notification",
"permission": "ControlGUI",
"type": "method",
"params": [
{
"type": "string",
"name": "title",
"required": true
},
{
"type": "string",
"name": "message",
"required": true
},
{
"default": "",
"type": [
{
"enums": [
"info",
"warning",
"error"
],
"type": "string"
},
{
"type": "string"
}
],
"name": "image"
},
{
"default": "5000",
"description": "The time in milliseconds the notification will be visible",
"type": "integer",
"name": "displaytime"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Input ===
==== Input.Back ====
Goes back in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Goes back in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ContextMenu ====
Shows the context menu<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Shows the context menu",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Down ====
Navigate down in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Navigate down in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ExecuteAction ====
Execute a specific action<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Input.Action|Input.Action]]'' action
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Execute a specific action",
"permission": "Navigate",
"type": "method",
"params": [
{
"$ref": "Input.Action",
"name": "action",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Home ====
Goes to home window in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Goes to home window in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Info ====
Shows the information dialog<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Shows the information dialog",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Left ====
Navigate left in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Navigate left in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Right ====
Navigate right in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Navigate right in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Select ====
Select current item in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Select current item in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.SendText ====
Send a generic (unicode) text<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' text ''Unicode text''
# [ ''boolean'' done = true ] ''Whether this is the whole input or not (closes an open input dialog if true).''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Send a generic (unicode) text",
"permission": "Navigate",
"type": "method",
"params": [
{
"description": "Unicode text",
"type": "string",
"name": "text",
"required": true
},
{
"default": "true",
"description": "Whether this is the whole input or not (closes an open input dialog if true).",
"type": "boolean",
"name": "done"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ShowCodec ====
Show codec information of the playing item<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Show codec information of the playing item",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ShowOSD ====
Show the on-screen display for the current player<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Show the on-screen display for the current player",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ShowPlayerProcessInfo ====
Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Up ====
Navigate up in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Navigate up in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== JSONRPC ===
==== JSONRPC.Introspect ====
Enumerates all actions and descriptions<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''boolean'' getdescriptions = true ]
# [ ''boolean'' getmetadata = false ]
# [ ''boolean'' filterbytransport = true ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Enumerates all actions and descriptions",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "true",
"type": "boolean",
"name": "getdescriptions"
},
{
"default": "false",
"type": "boolean",
"name": "getmetadata"
},
{
"default": "true",
"type": "boolean",
"name": "filterbytransport"
},
{
"type": "object",
"name": "filter"
}
],
"returns": {
"type": "object",
"additionalProperties": false
}
}</syntaxhighlight>}}

==== JSONRPC.NotifyAll ====
Notify all other connected clients<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' message
# [ ''mixed'' data ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''any''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Notify all other connected clients",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "string",
"name": "message",
"required": true
},
{
"type": "any",
"name": "data"
}
],
"returns": {
"type": "any"
}
}</syntaxhighlight>}}

==== JSONRPC.Permission ====
Retrieve the clients permissions<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''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
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve the clients permissions",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "object",
"properties": {
"controlgui": {
"type": "boolean",
"required": true
},
"controlnotify": {
"type": "boolean",
"required": true
},
"controlplayback": {
"type": "boolean",
"required": true
},
"controlpower": {
"type": "boolean",
"required": true
},
"controlpvr": {
"type": "boolean",
"required": true
},
"controlsystem": {
"type": "boolean",
"required": true
},
"executeaddon": {
"type": "boolean",
"required": true
},
"manageaddon": {
"type": "boolean",
"required": true
},
"navigate": {
"type": "boolean",
"required": true
},
"readdata": {
"type": "boolean",
"required": true
},
"removedata": {
"type": "boolean",
"required": true
},
"updatedata": {
"type": "boolean",
"required": true
},
"writefile": {
"type": "boolean",
"required": true
}
}
}
}</syntaxhighlight>}}

==== JSONRPC.Ping ====
Ping responder<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Ping responder",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== JSONRPC.Version ====
Retrieve the JSON-RPC protocol version.<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''mixed'' version
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve the JSON-RPC protocol version.",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "object",
"properties": {
"version": {
"type": "object",
"required": true
}
}
}
}</syntaxhighlight>}}

=== Player ===
==== Player.GetActivePlayers ====
Returns all active players<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Returns all active players",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "array"
}
}</syntaxhighlight>}}

==== Player.GetItem ====
Retrieves the currently played item<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# [ ''[[#List.Fields.All|List.Fields.All]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.Item.All|List.Item.All]]'' item
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the currently played item",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "List.Fields.All",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"item": {
"$ref": "List.Item.All",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Player.GetPlayers ====
Get a list of available players<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''string'' media = "all" ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Get a list of available players",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "all",
"type": "string",
"name": "media"
}
],
"returns": {
"type": "array"
}
}</syntaxhighlight>}}

==== Player.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''[[#Player.Property.Name|Player.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Property.Value|Player.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"items": {
"$ref": "Player.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "Player.Property.Value"
}
}</syntaxhighlight>}}

==== Player.GoTo ====
Go to previous/next/specific item in the playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' to
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Go to previous/next/specific item in the playlist",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"$ref": "Playlist.Position",
"description": "position in playlist"
}
],
"name": "to",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Move ====
If picture is zoomed move viewport left/right/up/down otherwise skip previous/next<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''string'' direction
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "If picture is zoomed move viewport left/right/up/down otherwise skip previous/next",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": "string",
"name": "direction",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== 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.<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed'' item ]
# [ ''mixed'' options ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"type": [
{
"additionalProperties": false,
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"position": {
"$ref": "Playlist.Position",
"default": 0
}
},
"type": "object"
},
{
"$ref": "Playlist.Item"
},
{
"additionalProperties": false,
"properties": {
"path": {
"required": true,
"type": "string"
},
"random": {
"default": true,
"description": "Deprecated, use the shuffled property of the options parameter instead",
"type": "boolean"
},
"recursive": {
"default": true,
"type": "boolean"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"partymode": {
"default": "",
"type": [
{
"enums": [
"music",
"video"
],
"type": "string"
},
{
"description": "Path to a smartplaylist (*.xsp) file",
"minLength": 5,
"type": "string"
}
]
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"channelid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"recordingid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
],
"name": "item"
},
{
"type": "object",
"name": "options"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.PlayPause ====
Pauses or unpause playback and returns the new state<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# [ ''[[#Global.Toggle|Global.Toggle]]'' play = "toggle" ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Pauses or unpause playback and returns the new state",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"default": "toggle",
"$ref": "Global.Toggle",
"name": "play"
}
],
"returns": {
"$ref": "Player.Speed"
}
}</syntaxhighlight>}}

==== Player.Rotate ====
Rotates current picture<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# [ ''string'' value = "clockwise" ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Rotates current picture",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"default": "clockwise",
"type": "string",
"name": "value"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Seek ====
Seek through the playing item<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' value
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Player.Position.Percentage|Player.Position.Percentage]]'' = "0"percentage ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
* [ ''[[#Global.Time|Global.Time]]'' totaltime ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Seek through the playing item",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"$ref": "Player.Position.Percentage",
"description": "Percentage value to seek to"
},
{
"$ref": "Player.Position.Time",
"description": "Time to seek to"
},
{
"description": "Seek by predefined jumps",
"enums": [
"smallforward",
"smallbackward",
"bigforward",
"bigbackward"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"percentage": {
"$ref": "Player.Position.Percentage",
"description": "Percentage value to seek to",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"time": {
"$ref": "Player.Position.Time",
"description": "Time to seek to",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"step": {
"description": "Seek by predefined jumps",
"enums": [
"smallforward",
"smallbackward",
"bigforward",
"bigbackward"
],
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"seconds": {
"description": "Seek by the given number of seconds",
"required": true,
"type": "integer"
}
},
"type": "object"
}
],
"name": "value",
"required": true
}
],
"returns": {
"type": "object",
"properties": {
"percentage": {
"default": "0",
"$ref": "Player.Position.Percentage"
},
"time": {
"$ref": "Global.Time"
},
"totaltime": {
"$ref": "Global.Time"
}
}
}
}</syntaxhighlight>}}

==== Player.SetAudioStream ====
Set the audio stream played by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed: string|integer'' stream
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Set the audio stream played by the player",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"description": "Index of the audio stream to play",
"minimum": 0,
"type": "integer"
}
],
"name": "stream",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetPartymode ====
Turn partymode on or off<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''[[#Global.Toggle|Global.Toggle]]'' partymode
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Turn partymode on or off",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "partymode",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetRepeat ====
Set the repeat mode of the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' repeat
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Set the repeat mode of the player",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"$ref": "Player.Repeat"
},
{
"enums": [
"cycle"
],
"type": "string"
}
],
"name": "repeat",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetShuffle ====
Shuffle/Unshuffle items in the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''[[#Global.Toggle|Global.Toggle]]'' shuffle
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Shuffle/Unshuffle items in the player",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "shuffle",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetSpeed ====
Set the speed of the current playback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' speed
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Set the speed of the current playback",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
-32,
-16,
-8,
-4,
-2,
-1,
0,
1,
2,
4,
8,
16,
32
],
"type": "integer"
},
{
"$ref": "Global.IncrementDecrement"
}
],
"name": "speed",
"required": true
}
],
"returns": {
"$ref": "Player.Speed"
}
}</syntaxhighlight>}}

==== Player.SetSubtitle ====
Set the subtitle displayed by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed: string|integer'' subtitle
# [ ''boolean'' enable = false ] ''Whether to enable subtitles to be displayed after setting the new subtitle''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Set the subtitle displayed by the player",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
"previous",
"next",
"off",
"on"
],
"type": "string"
},
{
"description": "Index of the subtitle to display",
"minimum": 0,
"type": "integer"
}
],
"name": "subtitle",
"required": true
},
{
"default": "false",
"description": "Whether to enable subtitles to be displayed after setting the new subtitle",
"type": "boolean",
"name": "enable"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetVideoStream ====
Set the video stream played by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed: string|integer'' stream
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Set the video stream played by the player",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"description": "Index of the video stream to play",
"minimum": 0,
"type": "integer"
}
],
"name": "stream",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Stop ====
Stops playback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Stops playback",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Zoom ====
Zoom current picture<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed: string|integer'' zoom
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Zoom current picture",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
"in",
"out"
],
"type": "string"
},
{
"description": "zoom level",
"maximum": 10,
"minimum": 1,
"type": "integer"
}
],
"name": "zoom",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Playlist ===
==== Playlist.Add ====
Add item(s) to playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''mixed'' item
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Add item(s) to playlist",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"type": [
{
"$ref": "Playlist.Item"
},
{
"items": {
"$ref": "Playlist.Item"
},
"type": "array"
}
],
"name": "item",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Playlist.Clear ====
Clear playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Clear playlist",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Playlist.GetItems ====
Get all items from playlist<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# [ ''[[#List.Fields.All|List.Fields.All]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.Item.All|List.Item.All]]''[] items
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Get all items from playlist",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "List.Fields.All",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"items": {
"items": {
"$ref": "List.Item.All"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Playlist.GetPlaylists ====
Returns all existing playlists<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Returns all existing playlists",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "array"
}
}</syntaxhighlight>}}

==== Playlist.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Property.Name|Playlist.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Playlist.Property.Value|Playlist.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"items": {
"$ref": "Playlist.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "Playlist.Property.Value"
}
}</syntaxhighlight>}}

==== Playlist.Insert ====
Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Position|Playlist.Position]]'' position
# ''mixed'' item
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position",
"required": true
},
{
"type": [
{
"$ref": "Playlist.Item"
},
{
"items": {
"$ref": "Playlist.Item"
},
"type": "array"
}
],
"name": "item",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Playlist.Remove ====
Remove item from playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Position|Playlist.Position]]'' position
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Remove item from playlist. Does not work for picture playlists (aka slideshows).",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Playlist.Swap ====
Swap items in the playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Position|Playlist.Position]]'' position1
# ''[[#Playlist.Position|Playlist.Position]]'' position2
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Swap items in the playlist. Does not work for picture playlists (aka slideshows).",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position1",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position2",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Profiles ===
==== Profiles.GetCurrentProfile ====
Retrieve the current profile<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Profiles.Fields.Profile|Profiles.Fields.Profile]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Profiles.Details.Profile|Profiles.Details.Profile]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve the current profile",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Profiles.Fields.Profile",
"name": "properties"
}
],
"returns": {
"$ref": "Profiles.Details.Profile"
}
}</syntaxhighlight>}}

==== Profiles.GetProfiles ====
Retrieve all profiles<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Profiles.Fields.Profile|Profiles.Fields.Profile]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#Profiles.Details.Profile|Profiles.Details.Profile]]''[] profiles
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all profiles",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Profiles.Fields.Profile",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"profiles": {
"items": {
"$ref": "Profiles.Details.Profile"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Profiles.LoadProfile ====
Load the specified profile<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' profile ''Profile name''
# [ ''boolean'' prompt = false ] ''Prompt for password''
# [ ''[[#Profiles.Password|Profiles.Password]]'' password ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Load the specified profile",
"permission": "Navigate",
"type": "method",
"params": [
{
"description": "Profile name",
"type": "string",
"name": "profile",
"required": true
},
{
"default": "false",
"description": "Prompt for password",
"type": "boolean",
"name": "prompt"
},
{
"$ref": "Profiles.Password",
"name": "password"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== 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<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|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''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Adds a timer to record the given show one times or a timer rule to record all showings of the given show",
"permission": "ControlPVR",
"type": "method",
"params": [
{
"description": "the broadcast id of the item to record",
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
{
"default": "false",
"description": "controls whether to create a timer rule or a onetime timer",
"type": "boolean",
"name": "timerrule"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.DeleteTimer ====
Deletes a onetime timer or a timer rule<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' timerid ''the id of the onetime timer or timer rule to delete''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Deletes a onetime timer or a timer rule",
"permission": "ControlPVR",
"type": "method",
"params": [
{
"description": "the id of the onetime timer or timer rule to delete",
"$ref": "Library.Id",
"name": "timerid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.GetBroadcastDetails ====
Retrieves the details of a specific broadcast<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid
# [ ''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the details of a specific broadcast",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
{
"$ref": "PVR.Fields.Broadcast",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"broadcastdetails": {
"$ref": "PVR.Details.Broadcast"
}
}
}
}</syntaxhighlight>}}

==== PVR.GetBroadcasts ====
Retrieves the program of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid
# [ ''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]''[] broadcasts
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the program of a specific channel",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
{
"$ref": "PVR.Fields.Broadcast",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"broadcasts": {
"items": {
"$ref": "PVR.Details.Broadcast"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== PVR.GetChannelDetails ====
Retrieves the details of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid
# [ ''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.Channel|PVR.Details.Channel]]'' channeldetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the details of a specific channel",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
{
"$ref": "PVR.Fields.Channel",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"channeldetails": {
"$ref": "PVR.Details.Channel"
}
}
}
}</syntaxhighlight>}}

==== PVR.GetChannelGroupDetails ====
Retrieves the details of a specific channel group<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.ChannelGroup.Id|PVR.ChannelGroup.Id]]'' channelgroupid
# [ ''mixed'' channels ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.ChannelGroup.Extended|PVR.Details.ChannelGroup.Extended]]'' channelgroupdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the details of a specific channel group",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "PVR.ChannelGroup.Id",
"name": "channelgroupid",
"required": true
},
{
"type": "object",
"name": "channels"
}
],
"returns": {
"type": "object",
"properties": {
"channelgroupdetails": {
"$ref": "PVR.Details.ChannelGroup.Extended"
}
}
}
}</syntaxhighlight>}}

==== PVR.GetChannelGroups ====
Retrieves the channel groups for the specified type<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]''[] channelgroups
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the channel groups for the specified type",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "PVR.Channel.Type",
"name": "channeltype",
"required": true
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"channelgroups": {
"items": {
"$ref": "PVR.Details.ChannelGroup"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== PVR.GetChannels ====
Retrieves the channel list<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.ChannelGroup.Id|PVR.ChannelGroup.Id]]'' channelgroupid
# [ ''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#PVR.Details.Channel|PVR.Details.Channel]]''[] channels
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the channel list",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "PVR.ChannelGroup.Id",
"name": "channelgroupid",
"required": true
},
{
"$ref": "PVR.Fields.Channel",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== PVR.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.Property.Name|PVR.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#PVR.Property.Value|PVR.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"$ref": "PVR.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "PVR.Property.Value"
}
}</syntaxhighlight>}}

==== PVR.GetRecordingDetails ====
Retrieves the details of a specific recording<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' recordingid
# [ ''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.Recording|PVR.Details.Recording]]'' recordingdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the details of a specific recording",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "recordingid",
"required": true
},
{
"$ref": "PVR.Fields.Recording",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"recordingdetails": {
"$ref": "PVR.Details.Recording"
}
}
}
}</syntaxhighlight>}}

==== PVR.GetRecordings ====
Retrieves the recordings<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#PVR.Details.Recording|PVR.Details.Recording]]''[] recordings
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the recordings",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "PVR.Fields.Recording",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"recordings": {
"items": {
"$ref": "PVR.Details.Recording"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== PVR.GetTimerDetails ====
Retrieves the details of a specific timer<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' timerid
# [ ''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.Timer|PVR.Details.Timer]]'' timerdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the details of a specific timer",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "timerid",
"required": true
},
{
"$ref": "PVR.Fields.Timer",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"timerdetails": {
"$ref": "PVR.Details.Timer"
}
}
}
}</syntaxhighlight>}}

==== PVR.GetTimers ====
Retrieves the timers<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#PVR.Details.Timer|PVR.Details.Timer]]''[] timers
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the timers",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "PVR.Fields.Timer",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"timers": {
"items": {
"$ref": "PVR.Details.Timer"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== PVR.Record ====
Toggle recording of a channel<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Global.Toggle|Global.Toggle]]'' record = "toggle" ]
# [ ''mixed'' channel = "current" ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Toggle recording of a channel",
"permission": "ControlPVR",
"type": "method",
"params": [
{
"default": "toggle",
"$ref": "Global.Toggle",
"name": "record"
},
{
"default": "current",
"type": [
{
"enums": [
"current"
],
"type": "string"
},
{
"$ref": "Library.Id"
}
],
"name": "channel"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Scan ====
Starts a channel scan<br />
'''Permissions:'''
* ControlPVR
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Starts a channel scan",
"permission": "ControlPVR",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== 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<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|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''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created",
"permission": "ControlPVR",
"type": "method",
"params": [
{
"description": "the broadcast id of the item to toggle a onetime timer or time rule for",
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
{
"default": "false",
"description": "controls whether to create / delete a timer rule or a onetime timer",
"type": "boolean",
"name": "timerrule"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Settings ===
==== Settings.GetCategories ====
Retrieves all setting categories<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Setting.Level|Setting.Level]]'' level = "standard" ]
# [ ''string'' section ]
# [ ''mixed'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Setting.Details.Category|Setting.Details.Category]]''[] categories ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves all setting categories",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "standard",
"$ref": "Setting.Level",
"name": "level"
},
{
"default": "",
"type": "string",
"name": "section"
},
{
"items": {
"type": "string"
},
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"categories": {
"items": {
"$ref": "Setting.Details.Category"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== Settings.GetSections ====
Retrieves all setting sections<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Setting.Level|Setting.Level]]'' level = "standard" ]
# [ ''mixed'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Setting.Details.Section|Setting.Details.Section]]''[] sections ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves all setting sections",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "standard",
"$ref": "Setting.Level",
"name": "level"
},
{
"items": {
"type": "string"
},
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"sections": {
"items": {
"$ref": "Setting.Details.Section"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== Settings.GetSettings ====
Retrieves all settings<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Setting.Level|Setting.Level]]'' level = "standard" ]
# [ ''mixed: object'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Setting.Details.Setting|Setting.Details.Setting]]''[] settings ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves all settings",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "standard",
"$ref": "Setting.Level",
"name": "level"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"category": {
"minLength": 1,
"required": true,
"type": "string"
},
"section": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
}
],
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"settings": {
"items": {
"$ref": "Setting.Details.Setting"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== Settings.GetSettingValue ====
Retrieves the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the value of a setting",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "setting",
"required": true
}
],
"returns": {
"type": "object",
"properties": {
"value": {
"$ref": "Setting.Value.Extended",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Settings.ResetSettingValue ====
Resets the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Resets the value of a setting",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "setting",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Settings.SetSettingValue ====
Changes the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting
# ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Changes the value of a setting",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "setting",
"required": true
},
{
"$ref": "Setting.Value.Extended",
"name": "value",
"required": true
}
],
"returns": {
"type": "boolean"
}
}</syntaxhighlight>}}

=== System ===
==== System.EjectOpticalDrive ====
Ejects or closes the optical disc drive (if available)<br />
'''Permissions:'''
* ControlSystem
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Ejects or closes the optical disc drive (if available)",
"permission": "ControlSystem",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== System.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#System.Property.Name|System.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#System.Property.Value|System.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"$ref": "System.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "System.Property.Value"
}
}</syntaxhighlight>}}

==== System.Hibernate ====
Puts the system running Kodi into hibernate mode<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Puts the system running Kodi into hibernate mode",
"permission": "ControlPower",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== System.Reboot ====
Reboots the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Reboots the system running Kodi",
"permission": "ControlPower",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== System.Shutdown ====
Shuts the system running Kodi down<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Shuts the system running Kodi down",
"permission": "ControlPower",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== System.Suspend ====
Suspends the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Suspends the system running Kodi",
"permission": "ControlPower",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Textures ===
==== Textures.GetTextures ====
Retrieve all textures<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Textures.Fields.Texture|Textures.Fields.Texture]]'' properties ]
# [ ''[[#List.Filter.Textures|List.Filter.Textures]]'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Textures.Details.Texture|Textures.Details.Texture]]''[] textures
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all textures",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Textures.Fields.Texture",
"name": "properties"
},
{
"$ref": "List.Filter.Textures",
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"textures": {
"items": {
"$ref": "Textures.Details.Texture"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Textures.RemoveTexture ====
Remove the specified texture<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' textureid ''Texture database identifier''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Remove the specified texture",
"permission": "RemoveData",
"type": "method",
"params": [
{
"description": "Texture database identifier",
"$ref": "Library.Id",
"name": "textureid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== VideoLibrary ===
==== VideoLibrary.Clean ====
Cleans the video library from non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''boolean'' showdialogs = true ] ''Whether or not to show the progress bar or any other GUI dialog''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Cleans the video library from non-existent items",
"permission": "RemoveData",
"type": "method",
"params": [
{
"default": "true",
"description": "Whether or not to show the progress bar or any other GUI dialog",
"type": "boolean",
"name": "showdialogs"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.Export ====
Exports all items from the video library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed: object|object'' options ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Exports all items from the video library",
"permission": "WriteFile",
"type": "method",
"params": [
{
"type": [
{
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the directory to where the data should be exported",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actorthumbs": {
"default": false,
"description": "Whether to export actor thumbnails",
"type": "boolean"
},
"images": {
"default": false,
"description": "Whether to export thumbnails and fanart images",
"type": "boolean"
},
"overwrite": {
"default": false,
"description": "Whether to overwrite existing exported files",
"type": "boolean"
}
},
"type": "object"
}
],
"name": "options"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetEpisodeDetails ====
Retrieve details about a specific tv show episode<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]'' episodedetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific tv show episode",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"$ref": "Video.Fields.Episode",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"episodedetails": {
"$ref": "Video.Details.Episode"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetEpisodes ====
Retrieve all tv show episodes<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
# [ ''integer'' season = "-1" ]
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]''[] episodes ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all tv show episodes",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
{
"default": "-1",
"type": "integer",
"name": "season"
},
{
"$ref": "Video.Fields.Episode",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Requires tvshowid to be set",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Requires tvshowid to be set",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"description": "Requires tvshowid to be set",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Episodes"
}
],
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"episodes": {
"items": {
"$ref": "Video.Details.Episode"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetGenres ====
Retrieve all genres<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' type
# [ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Library.Details.Genre|Library.Details.Genre]]''[] genres
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all genres",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "type",
"required": true
},
{
"$ref": "Library.Fields.Genre",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"genres": {
"items": {
"$ref": "Library.Details.Genre"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetInProgressTVShows ====
Retrieve all in progress tvshows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.TVShow|Video.Details.TVShow]]''[] tvshows ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all in progress tvshows",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tvshows": {
"items": {
"$ref": "Video.Details.TVShow"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMovieDetails ====
Retrieve details about a specific movie<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]'' moviedetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific movie",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"$ref": "Video.Fields.Movie",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"moviedetails": {
"$ref": "Video.Details.Movie"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMovies ====
Retrieve all movies<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all movies",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.Movie",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"country": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"set": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Movies"
}
],
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMovieSetDetails ====
Retrieve details about a specific movie set<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' setid
# [ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties ]
# [ ''mixed'' movies ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.MovieSet.Extended|Video.Details.MovieSet.Extended]]'' setdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific movie set",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "setid",
"required": true
},
{
"$ref": "Video.Fields.MovieSet",
"name": "properties"
},
{
"type": "object",
"name": "movies"
}
],
"returns": {
"type": "object",
"properties": {
"setdetails": {
"$ref": "Video.Details.MovieSet.Extended"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMovieSets ====
Retrieve all movie sets<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''[] sets ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all movie sets",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.MovieSet",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sets": {
"items": {
"$ref": "Video.Details.MovieSet"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMusicVideoDetails ====
Retrieve details about a specific music video<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]'' musicvideodetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific music video",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"musicvideodetails": {
"$ref": "Video.Details.MusicVideo"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMusicVideos ====
Retrieve all music videos<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]''[] musicvideos ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all music videos",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.MusicVideos"
}
],
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"musicvideos": {
"items": {
"$ref": "Video.Details.MusicVideo"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetRecentlyAddedEpisodes ====
Retrieve all recently added tv episodes<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]''[] episodes ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all recently added tv episodes",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.Episode",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"episodes": {
"items": {
"$ref": "Video.Details.Episode"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetRecentlyAddedMovies ====
Retrieve all recently added movies<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all recently added movies",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.Movie",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetRecentlyAddedMusicVideos ====
Retrieve all recently added music videos<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]''[] musicvideos ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all recently added music videos",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"musicvideos": {
"items": {
"$ref": "Video.Details.MusicVideo"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetSeasonDetails ====
Retrieve details about a specific tv show season<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' seasonid
# [ ''[[#Video.Fields.Season|Video.Fields.Season]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Season|Video.Details.Season]]'' seasondetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific tv show season",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
{
"$ref": "Video.Fields.Season",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"seasondetails": {
"$ref": "Video.Details.Season"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetSeasons ====
Retrieve all tv seasons<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
# [ ''[[#Video.Fields.Season|Video.Fields.Season]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Season|Video.Details.Season]]''[] seasons ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all tv seasons",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
{
"$ref": "Video.Fields.Season",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"seasons": {
"items": {
"$ref": "Video.Details.Season"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetTags ====
Retrieve all tags<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' type
# [ ''[[#Library.Fields.Tag|Library.Fields.Tag]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#Library.Details.Tag|Library.Details.Tag]]''[] tags
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all tags",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "type",
"required": true
},
{
"$ref": "Library.Fields.Tag",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tags": {
"items": {
"$ref": "Library.Details.Tag"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetTVShowDetails ====
Retrieve details about a specific tv show<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
# [ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.TVShow|Video.Details.TVShow]]'' tvshowdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific tv show",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"tvshowdetails": {
"$ref": "Video.Details.TVShow"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetTVShows ====
Retrieve all tv shows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.TVShow|Video.Details.TVShow]]''[] tvshows ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all tv shows",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.TVShows"
}
],
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tvshows": {
"items": {
"$ref": "Video.Details.TVShow"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.RefreshEpisode ====
Refresh the given episode in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|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).''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Refresh the given episode in the library",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"default": "false",
"description": "Whether or not to ignore a local NFO if present.",
"type": "boolean",
"name": "ignorenfo"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"type": "string",
"name": "title"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RefreshMovie ====
Refresh the given movie in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|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).''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Refresh the given movie in the library",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"default": "false",
"description": "Whether or not to ignore a local NFO if present.",
"type": "boolean",
"name": "ignorenfo"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"type": "string",
"name": "title"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RefreshMusicVideo ====
Refresh the given music video in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|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).''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Refresh the given music video in the library",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"default": "false",
"description": "Whether or not to ignore a local NFO if present.",
"type": "boolean",
"name": "ignorenfo"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"type": "string",
"name": "title"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RefreshTVShow ====
Refresh the given tv show in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|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).''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Refresh the given tv show in the library",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"default": "false",
"description": "Whether or not to ignore a local NFO if present.",
"type": "boolean",
"name": "ignorenfo"
},
{
"default": "false",
"description": "Whether or not to refresh all episodes belonging to the TV show.",
"type": "boolean",
"name": "refreshepisodes"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"type": "string",
"name": "title"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RemoveEpisode ====
Removes the given episode from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Removes the given episode from the library",
"permission": "RemoveData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RemoveMovie ====
Removes the given movie from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Removes the given movie from the library",
"permission": "RemoveData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RemoveMusicVideo ====
Removes the given music video from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Removes the given music video from the library",
"permission": "RemoveData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RemoveTVShow ====
Removes the given tv show from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Removes the given tv show from the library",
"permission": "RemoveData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.Scan ====
Scans the video sources for new library items<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''string'' directory ]
# [ ''boolean'' showdialogs = true ] ''Whether or not to show the progress bar or any other GUI dialog''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Scans the video sources for new library items",
"permission": "UpdateData",
"type": "method",
"params": [
{
"default": "",
"type": "string",
"name": "directory"
},
{
"default": "true",
"description": "Whether or not to show the progress bar or any other GUI dialog",
"type": "boolean",
"name": "showdialogs"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetEpisodeDetails ====
Update the given episode with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime ] ''Runtime in seconds''
# [ ''mixed'' director ]
# [ ''[[#Optional.String|Optional.String]]'' plot ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.String|Optional.String]]'' votes ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''mixed'' writer ]
# [ ''[[#Optional.String|Optional.String]]'' firstaired ]
# [ ''[[#Optional.String|Optional.String]]'' productioncode ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' season ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' episode ]
# [ ''[[#Optional.String|Optional.String]]'' originaltitle ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
# [ ''[[#Optional.String|Optional.String]]'' fanart ]
# [ ''mixed'' art ]
# [ ''mixed'' resume ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings ]
# [ ''[[#Optional.String|Optional.String]]'' dateadded ]
# [ ''mixed'' uniqueid ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given episode with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"description": "Runtime in seconds",
"$ref": "Optional.Integer",
"name": "runtime"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "director"
},
{
"$ref": "Optional.String",
"name": "plot"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.String",
"name": "votes"
},
{
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "writer"
},
{
"$ref": "Optional.String",
"name": "firstaired"
},
{
"$ref": "Optional.String",
"name": "productioncode"
},
{
"$ref": "Optional.Integer",
"name": "season"
},
{
"$ref": "Optional.Integer",
"name": "episode"
},
{
"$ref": "Optional.String",
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"name": "fanart"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
],
"name": "resume"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"name": "dateadded"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
],
"name": "uniqueid"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetMovieDetails ====
Update the given movie with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime ] ''Runtime in seconds''
# [ ''mixed'' director ]
# [ ''mixed'' studio ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year ] ''linked with premiered. Overridden by premiered parameter''
# [ ''[[#Optional.String|Optional.String]]'' plot ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.String|Optional.String]]'' mpaa ]
# [ ''[[#Optional.String|Optional.String]]'' imdbnumber ]
# [ ''[[#Optional.String|Optional.String]]'' votes ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''[[#Optional.String|Optional.String]]'' originaltitle ]
# [ ''[[#Optional.String|Optional.String]]'' trailer ]
# [ ''[[#Optional.String|Optional.String]]'' tagline ]
# [ ''[[#Optional.String|Optional.String]]'' plotoutline ]
# [ ''mixed'' writer ]
# [ ''mixed'' country ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' top250 ]
# [ ''[[#Optional.String|Optional.String]]'' sorttitle ]
# [ ''[[#Optional.String|Optional.String]]'' set ]
# [ ''mixed'' showlink ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
# [ ''[[#Optional.String|Optional.String]]'' fanart ]
# [ ''mixed'' tag ]
# [ ''mixed'' art ]
# [ ''mixed'' resume ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings ]
# [ ''[[#Optional.String|Optional.String]]'' dateadded ]
# [ ''[[#Optional.String|Optional.String]]'' premiered ] ''linked with year. Overriedes year''
# [ ''mixed'' uniqueid ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given movie with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"description": "Runtime in seconds",
"$ref": "Optional.Integer",
"name": "runtime"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "director"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "studio"
},
{
"description": "linked with premiered. Overridden by premiered parameter",
"$ref": "Optional.Integer",
"name": "year"
},
{
"$ref": "Optional.String",
"name": "plot"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.String",
"name": "mpaa"
},
{
"$ref": "Optional.String",
"name": "imdbnumber"
},
{
"$ref": "Optional.String",
"name": "votes"
},
{
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"name": "trailer"
},
{
"$ref": "Optional.String",
"name": "tagline"
},
{
"$ref": "Optional.String",
"name": "plotoutline"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "writer"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "country"
},
{
"$ref": "Optional.Integer",
"name": "top250"
},
{
"$ref": "Optional.String",
"name": "sorttitle"
},
{
"$ref": "Optional.String",
"name": "set"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "showlink"
},
{
"$ref": "Optional.String",
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"name": "fanart"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "tag"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
],
"name": "resume"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"name": "dateadded"
},
{
"description": "linked with year. Overriedes year",
"$ref": "Optional.String",
"name": "premiered"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
],
"name": "uniqueid"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetMovieSetDetails ====
Update the given movie set with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' setid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''mixed'' art ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given movie set with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "setid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetMusicVideoDetails ====
Update the given music video with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime ] ''Runtime in seconds''
# [ ''mixed'' director ]
# [ ''mixed'' studio ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year ] ''linked with premiered. Overridden by premiered parameter''
# [ ''[[#Optional.String|Optional.String]]'' plot ]
# [ ''[[#Optional.String|Optional.String]]'' album ]
# [ ''mixed'' artist ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' track ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
# [ ''[[#Optional.String|Optional.String]]'' fanart ]
# [ ''mixed'' tag ]
# [ ''mixed'' art ]
# [ ''mixed'' resume ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Optional.String|Optional.String]]'' dateadded ]
# [ ''[[#Optional.String|Optional.String]]'' premiered ] ''linked with year. Overriedes year''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given music video with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"description": "Runtime in seconds",
"$ref": "Optional.Integer",
"name": "runtime"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "director"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "studio"
},
{
"description": "linked with premiered. Overridden by premiered parameter",
"$ref": "Optional.Integer",
"name": "year"
},
{
"$ref": "Optional.String",
"name": "plot"
},
{
"$ref": "Optional.String",
"name": "album"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "artist"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"$ref": "Optional.Integer",
"name": "track"
},
{
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"name": "fanart"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "tag"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
],
"name": "resume"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Optional.String",
"name": "dateadded"
},
{
"description": "linked with year. Overriedes year",
"$ref": "Optional.String",
"name": "premiered"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetSeasonDetails ====
Update the given season with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' seasonid
# [ ''mixed'' art ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given season with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetTVShowDetails ====
Update the given tvshow with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''mixed'' studio ]
# [ ''[[#Optional.String|Optional.String]]'' plot ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.String|Optional.String]]'' mpaa ]
# [ ''[[#Optional.String|Optional.String]]'' imdbnumber ]
# [ ''[[#Optional.String|Optional.String]]'' premiered ]
# [ ''[[#Optional.String|Optional.String]]'' votes ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''[[#Optional.String|Optional.String]]'' originaltitle ]
# [ ''[[#Optional.String|Optional.String]]'' sorttitle ]
# [ ''[[#Optional.String|Optional.String]]'' episodeguide ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
# [ ''[[#Optional.String|Optional.String]]'' fanart ]
# [ ''mixed'' tag ]
# [ ''mixed'' art ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings ]
# [ ''[[#Optional.String|Optional.String]]'' dateadded ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime ] ''Runtime in seconds''
# [ ''[[#Optional.String|Optional.String]]'' status ]
# [ ''mixed'' uniqueid ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given tvshow with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "studio"
},
{
"$ref": "Optional.String",
"name": "plot"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.String",
"name": "mpaa"
},
{
"$ref": "Optional.String",
"name": "imdbnumber"
},
{
"$ref": "Optional.String",
"name": "premiered"
},
{
"$ref": "Optional.String",
"name": "votes"
},
{
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"name": "sorttitle"
},
{
"$ref": "Optional.String",
"name": "episodeguide"
},
{
"$ref": "Optional.String",
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"name": "fanart"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "tag"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"name": "dateadded"
},
{
"description": "Runtime in seconds",
"$ref": "Optional.Integer",
"name": "runtime"
},
{
"$ref": "Optional.String",
"name": "status"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
],
"name": "uniqueid"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== XBMC ===
==== XBMC.GetInfoBooleans ====
Retrieve info booleans about Kodi and the system<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string''[] booleans
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />

'''Description:''' ''Object containing key-value pairs of the retrieved info booleans''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve info booleans about Kodi and the system",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"type": "string"
},
"type": "array",
"name": "booleans",
"required": true
}
],
"returns": {
"type": "object",
"description": "Object containing key-value pairs of the retrieved info booleans",
"additionalProperties": {
"default": "",
"type": "string"
}
}
}</syntaxhighlight>}}

==== XBMC.GetInfoLabels ====
Retrieve info labels about Kodi and the system<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string''[] labels ''See http://kodi.wiki/view/InfoLabels for a list of possible info labels''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />

'''Description:''' ''Object containing key-value pairs of the retrieved info labels''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve info labels about Kodi and the system",
"permission": "ReadData",
"type": "method",
"params": [
{
"description": "See http://kodi.wiki/view/InfoLabels for a list of possible info labels",
"items": {
"type": "string"
},
"type": "array",
"name": "labels",
"required": true
}
],
"returns": {
"type": "object",
"description": "Object containing key-value pairs of the retrieved info labels",
"additionalProperties": {
"default": "",
"type": "string"
}
}
}</syntaxhighlight>}}

== Global Types ==
=== Addon ===
==== Addon.Content ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"unknown",
"video",
"audio",
"image",
"executable"
],
"id": "Addon.Content",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

==== Addon.Details ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' addonid
* [ ''string'' author ]
* [ ''mixed: boolean|string'' broken ]
* [ ''object'' dependencies ]
* [ ''string'' description ]
* [ ''string'' disclaimer ]
* [ ''boolean'' enabled = false ]
* [ ''object'' extrainfo ]
* [ ''string'' fanart ]
* [ ''boolean'' installed = false ]
* [ ''string'' name ]
* [ ''string'' path ]
* [ ''integer'' rating = "0" ]
* [ ''string'' summary ]
* [ ''string'' thumbnail ]
* ''[[#Addon.Types|Addon.Types]]'' type
* [ ''string'' version ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Addon.Details",
"properties": {
"addonid": {
"type": "string",
"name": "addonid",
"required": true
},
"author": {
"default": "",
"type": "string",
"name": "author"
},
"broken": {
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
],
"name": "broken"
},
"dependencies": {
"items": {
"properties": {
"addonid": {
"required": true,
"type": "string"
},
"optional": {
"required": true,
"type": "boolean"
},
"version": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "dependencies"
},
"description": {
"default": "",
"type": "string",
"name": "description"
},
"disclaimer": {
"default": "",
"type": "string",
"name": "disclaimer"
},
"enabled": {
"default": "false",
"type": "boolean",
"name": "enabled"
},
"extrainfo": {
"items": {
"properties": {
"key": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "extrainfo"
},
"fanart": {
"default": "",
"type": "string",
"name": "fanart"
},
"installed": {
"default": "false",
"type": "boolean",
"name": "installed"
},
"name": {
"default": "",
"type": "string",
"name": "name"
},
"path": {
"default": "",
"type": "string",
"name": "path"
},
"rating": {
"default": "0",
"type": "integer",
"name": "rating"
},
"summary": {
"default": "",
"type": "string",
"name": "summary"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"type": {
"$ref": "Addon.Types",
"name": "type",
"required": true
},
"version": {
"default": "",
"type": "string",
"name": "version"
}
}
}</syntaxhighlight>}}

==== Addon.Fields ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Addon.Fields",
"items": {
"enums": [
"name",
"version",
"summary",
"description",
"path",
"author",
"thumbnail",
"disclaimer",
"fanart",
"dependencies",
"broken",
"extrainfo",
"rating",
"enabled",
"installed"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Addon.Types ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"unknown",
"xbmc.player.musicviz",
"xbmc.gui.skin",
"xbmc.pvrclient",
"kodi.adsp",
"kodi.inputstream",
"kodi.peripheral",
"xbmc.python.script",
"xbmc.python.weather",
"xbmc.subtitle.module",
"xbmc.python.lyrics",
"xbmc.metadata.scraper.albums",
"xbmc.metadata.scraper.artists",
"xbmc.metadata.scraper.movies",
"xbmc.metadata.scraper.musicvideos",
"xbmc.metadata.scraper.tvshows",
"xbmc.ui.screensaver",
"xbmc.python.pluginsource",
"xbmc.addon.repository",
"xbmc.webinterface",
"xbmc.service",
"xbmc.audioencoder",
"kodi.context.item",
"kodi.audiodecoder",
"kodi.resource.images",
"kodi.resource.language",
"kodi.resource.uisounds",
"xbmc.addon.video",
"xbmc.addon.audio",
"xbmc.addon.image",
"xbmc.addon.executable",
"xbmc.metadata.scraper.library",
"xbmc.python.library",
"xbmc.python.module",
"kodi.game.controller"
],
"id": "Addon.Types",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

=== Application ===
==== Application.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"volume",
"muted",
"name",
"version"
],
"id": "Application.Property.Name",
"type": "string",
"default": "volume"
}</syntaxhighlight>}}

==== Application.Property.Value ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' muted = false ]
* [ ''string'' name ]
* [ ''mixed'' version ]
* [ ''integer'' volume = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Application.Property.Value",
"type": "object",
"properties": {
"muted": {
"default": "false",
"type": "boolean",
"name": "muted"
},
"name": {
"default": "",
"type": "string",
"name": "name"
},
"version": {
"type": "object",
"name": "version"
},
"volume": {
"default": "0",
"type": "integer",
"name": "volume"
}
}
}</syntaxhighlight>}}

=== Array ===
==== Array.Integer ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Array.Integer",
"type": "array",
"items": {
"type": "integer"
}
}</syntaxhighlight>}}

==== Array.String ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Array.String",
"type": "array",
"items": {
"minLength": 1,
"type": "string"
}
}</syntaxhighlight>}}

=== Audio ===
==== Audio.Album.ReleaseType ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"album",
"single"
],
"id": "Audio.Album.ReleaseType",
"type": "string",
"default": "album"
}</syntaxhighlight>}}

==== Audio.Artist.Roles ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Audio.Artist.Roles",
"type": "array",
"items": {
"additionalProperties": false,
"description": "The various roles contributed by an artist to one or more songs",
"properties": {
"role": {
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Audio.Contributors ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Audio.Contributors",
"type": "array",
"items": {
"additionalProperties": false,
"description": "The artist and the role they contribute to a song",
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"name": {
"required": true,
"type": "string"
},
"role": {
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Audio.Details.Album ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' albumid
* [ ''string'' albumlabel ]
* [ ''boolean'' compilation = false ]
* [ ''string'' description ]
* [ ''[[#Array.String|Array.String]]'' mood ]
* [ ''integer'' playcount = "0" ]
* [ ''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = "album" ]
* [ ''[[#Array.String|Array.String]]'' style ]
* [ ''[[#Array.String|Array.String]]'' theme ]
* [ ''string'' type ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Audio.Details.Media"
],
"id": "Audio.Details.Album",
"properties": {
"albumid": {
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
"albumlabel": {
"default": "",
"type": "string",
"name": "albumlabel"
},
"compilation": {
"default": "false",
"type": "boolean",
"name": "compilation"
},
"description": {
"default": "",
"type": "string",
"name": "description"
},
"mood": {
"$ref": "Array.String",
"name": "mood"
},
"playcount": {
"default": "0",
"type": "integer",
"name": "playcount"
},
"releasetype": {
"default": "album",
"$ref": "Audio.Album.ReleaseType",
"name": "releasetype"
},
"style": {
"$ref": "Array.String",
"name": "style"
},
"theme": {
"$ref": "Array.String",
"name": "theme"
},
"type": {
"default": "",
"type": "string",
"name": "type"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Artist ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' artist
* ''[[#Library.Id|Library.Id]]'' artistid
* [ ''string'' born ]
* [ ''boolean'' compilationartist = false ]
* [ ''string'' description ]
* [ ''string'' died ]
* [ ''string'' disbanded ]
* [ ''string'' formed ]
* [ ''[[#Array.String|Array.String]]'' instrument ]
* [ ''boolean'' isalbumartist = false ]
* [ ''[[#Array.String|Array.String]]'' mood ]
* [ ''string'' musicbrainzartistid ]
* [ ''[[#Audio.Artist.Roles|Audio.Artist.Roles]]'' roles ]
* [ ''[[#Audio.Details.Genres|Audio.Details.Genres]]'' songgenres ]
* [ ''[[#Array.String|Array.String]]'' style ]
* [ ''[[#Array.String|Array.String]]'' yearsactive ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Audio.Details.Base"
],
"id": "Audio.Details.Artist",
"properties": {
"artist": {
"type": "string",
"name": "artist",
"required": true
},
"artistid": {
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
"born": {
"default": "",
"type": "string",
"name": "born"
},
"compilationartist": {
"default": "false",
"type": "boolean",
"name": "compilationartist"
},
"description": {
"default": "",
"type": "string",
"name": "description"
},
"died": {
"default": "",
"type": "string",
"name": "died"
},
"disbanded": {
"default": "",
"type": "string",
"name": "disbanded"
},
"formed": {
"default": "",
"type": "string",
"name": "formed"
},
"instrument": {
"$ref": "Array.String",
"name": "instrument"
},
"isalbumartist": {
"default": "false",
"type": "boolean",
"name": "isalbumartist"
},
"mood": {
"$ref": "Array.String",
"name": "mood"
},
"musicbrainzartistid": {
"default": "",
"type": "string",
"name": "musicbrainzartistid"
},
"roles": {
"$ref": "Audio.Artist.Roles",
"name": "roles"
},
"songgenres": {
"$ref": "Audio.Details.Genres",
"name": "songgenres"
},
"style": {
"$ref": "Array.String",
"name": "style"
},
"yearsactive": {
"$ref": "Array.String",
"name": "yearsactive"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' dateadded ]
* [ ''[[#Array.String|Array.String]]'' genre ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Media.Details.Base"
],
"id": "Audio.Details.Base",
"properties": {
"dateadded": {
"default": "",
"type": "string",
"name": "dateadded"
},
"genre": {
"$ref": "Array.String",
"name": "genre"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Genres ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Audio.Details.Genres",
"type": "array",
"items": {
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Audio.Details.Media ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Array.String|Array.String]]'' artist ]
* [ ''[[#Array.Integer|Array.Integer]]'' artistid ]
* [ ''string'' displayartist ]
* [ ''[[#Array.Integer|Array.Integer]]'' genreid ]
* [ ''string'' musicbrainzalbumartistid ]
* [ ''string'' musicbrainzalbumid ]
* [ ''number'' rating = "0" ]
* [ ''string'' title ]
* [ ''integer'' userrating = "0" ]
* [ ''integer'' votes = "0" ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Audio.Details.Base"
],
"id": "Audio.Details.Media",
"properties": {
"artist": {
"$ref": "Array.String",
"name": "artist"
},
"artistid": {
"$ref": "Array.Integer",
"name": "artistid"
},
"displayartist": {
"default": "",
"type": "string",
"name": "displayartist"
},
"genreid": {
"$ref": "Array.Integer",
"name": "genreid"
},
"musicbrainzalbumartistid": {
"default": "",
"type": "string",
"name": "musicbrainzalbumartistid"
},
"musicbrainzalbumid": {
"default": "",
"type": "string",
"name": "musicbrainzalbumid"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"title": {
"default": "",
"type": "string",
"name": "title"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"votes": {
"default": "0",
"type": "integer",
"name": "votes"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Role ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' roleid
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Audio.Details.Role",
"properties": {
"roleid": {
"$ref": "Library.Id",
"name": "roleid",
"required": true
},
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Song ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' album ]
* [ ''[[#Array.String|Array.String]]'' albumartist ]
* [ ''[[#Array.Integer|Array.Integer]]'' albumartistid ]
* [ ''[[#Library.Id|Library.Id]]'' albumid = "-1" ]
* [ ''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' albumreleasetype = "album" ]
* [ ''string'' comment ]
* [ ''[[#Audio.Contributors|Audio.Contributors]]'' contributors ]
* [ ''integer'' disc = "0" ]
* [ ''string'' displaycomposer ]
* [ ''string'' displayconductor ]
* [ ''string'' displaylyricist ]
* [ ''string'' displayorchestra ]
* [ ''integer'' duration = "0" ]
* [ ''string'' file ]
* [ ''string'' lastplayed ]
* [ ''string'' lyrics ]
* [ ''string'' mood ]
* [ ''string'' musicbrainzartistid ]
* [ ''string'' musicbrainztrackid ]
* [ ''integer'' playcount = "0" ]
* ''[[#Library.Id|Library.Id]]'' songid
* [ ''integer'' track = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Audio.Details.Media"
],
"id": "Audio.Details.Song",
"properties": {
"album": {
"default": "",
"type": "string",
"name": "album"
},
"albumartist": {
"$ref": "Array.String",
"name": "albumartist"
},
"albumartistid": {
"$ref": "Array.Integer",
"name": "albumartistid"
},
"albumid": {
"default": "-1",
"$ref": "Library.Id",
"name": "albumid"
},
"albumreleasetype": {
"default": "album",
"$ref": "Audio.Album.ReleaseType",
"name": "albumreleasetype"
},
"comment": {
"default": "",
"type": "string",
"name": "comment"
},
"contributors": {
"$ref": "Audio.Contributors",
"name": "contributors"
},
"disc": {
"default": "0",
"type": "integer",
"name": "disc"
},
"displaycomposer": {
"default": "",
"type": "string",
"name": "displaycomposer"
},
"displayconductor": {
"default": "",
"type": "string",
"name": "displayconductor"
},
"displaylyricist": {
"default": "",
"type": "string",
"name": "displaylyricist"
},
"displayorchestra": {
"default": "",
"type": "string",
"name": "displayorchestra"
},
"duration": {
"default": "0",
"type": "integer",
"name": "duration"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"lastplayed": {
"default": "",
"type": "string",
"name": "lastplayed"
},
"lyrics": {
"default": "",
"type": "string",
"name": "lyrics"
},
"mood": {
"default": "",
"type": "string",
"name": "mood"
},
"musicbrainzartistid": {
"default": "",
"type": "string",
"name": "musicbrainzartistid"
},
"musicbrainztrackid": {
"default": "",
"type": "string",
"name": "musicbrainztrackid"
},
"playcount": {
"default": "0",
"type": "integer",
"name": "playcount"
},
"songid": {
"$ref": "Library.Id",
"name": "songid",
"required": true
},
"track": {
"default": "0",
"type": "integer",
"name": "track"
}
}
}</syntaxhighlight>}}

==== Audio.Fields.Album ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Audio.Fields.Album",
"items": {
"description": "Requesting the genreid and/or artistid field will result in increased response times",
"enums": [
"title",
"description",
"artist",
"genre",
"theme",
"mood",
"style",
"type",
"albumlabel",
"rating",
"votes",
"userrating",
"year",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"fanart",
"thumbnail",
"playcount",
"genreid",
"artistid",
"displayartist",
"compilation",
"releasetype",
"dateadded"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Audio.Fields.Artist ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Audio.Fields.Artist",
"items": {
"description": "Requesting the (song)genreid/genre, or roleid/role fields will result in increased response times",
"enums": [
"instrument",
"style",
"mood",
"born",
"formed",
"description",
"genre",
"died",
"disbanded",
"yearsactive",
"musicbrainzartistid",
"fanart",
"thumbnail",
"compilationartist",
"dateadded",
"roles",
"songgenres",
"isalbumartist"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Audio.Fields.Role ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Audio.Fields.Role",
"items": {
"enums": [
"title"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Audio.Fields.Song ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Audio.Fields.Song",
"items": {
"description": "Requesting the genreid, artistid and/or albumartistid field will result in increased response times",
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"thumbnail",
"file",
"albumid",
"lastplayed",
"disc",
"genreid",
"artistid",
"displayartist",
"albumartistid",
"albumreleasetype",
"dateadded",
"votes",
"userrating",
"mood",
"contributors",
"displaycomposer",
"displayconductor",
"displayorchestra",
"displaylyricist"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Audio.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"missingartistid"
],
"id": "Audio.Property.Name",
"type": "string",
"default": "missingartistid"
}</syntaxhighlight>}}

==== Audio.Property.Value ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Library.Id|Library.Id]]'' missingartistid = "-1" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Audio.Property.Value",
"type": "object",
"properties": {
"missingartistid": {
"default": "-1",
"$ref": "Library.Id",
"name": "missingartistid"
}
}
}</syntaxhighlight>}}

=== Configuration ===
==== Configuration.Configuration ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Configuration.Notifications|Configuration.Notifications]]'' notifications
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Configuration",
"type": "object",
"properties": {
"notifications": {
"$ref": "Configuration.Notifications",
"name": "notifications",
"required": true
}
}
}</syntaxhighlight>}}

==== Configuration.Notifications ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' application
* ''boolean'' audiolibrary
* ''boolean'' gui
* ''boolean'' input
* ''boolean'' other
* ''boolean'' player
* ''boolean'' playlist
* ''boolean'' pvr
* ''boolean'' system
* ''boolean'' videolibrary
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Configuration.Notifications",
"type": "object",
"properties": {
"application": {
"type": "boolean",
"name": "application",
"required": true
},
"audiolibrary": {
"type": "boolean",
"name": "audiolibrary",
"required": true
},
"gui": {
"type": "boolean",
"name": "gui",
"required": true
},
"input": {
"type": "boolean",
"name": "input",
"required": true
},
"other": {
"type": "boolean",
"name": "other",
"required": true
},
"player": {
"type": "boolean",
"name": "player",
"required": true
},
"playlist": {
"type": "boolean",
"name": "playlist",
"required": true
},
"pvr": {
"type": "boolean",
"name": "pvr",
"required": true
},
"system": {
"type": "boolean",
"name": "system",
"required": true
},
"videolibrary": {
"type": "boolean",
"name": "videolibrary",
"required": true
}
}
}</syntaxhighlight>}}

=== Favourite ===
==== Favourite.Details.Favourite ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' path ]
* [ ''string'' thumbnail ]
* ''string'' title
* ''[[#Favourite.Type|Favourite.Type]]'' type
* [ ''string'' window ]
* [ ''string'' windowparameter ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Favourite.Details.Favourite",
"type": "object",
"properties": {
"path": {
"default": "",
"type": "string",
"name": "path"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"title": {
"type": "string",
"name": "title",
"required": true
},
"type": {
"$ref": "Favourite.Type",
"name": "type",
"required": true
},
"window": {
"default": "",
"type": "string",
"name": "window"
},
"windowparameter": {
"default": "",
"type": "string",
"name": "windowparameter"
}
}
}</syntaxhighlight>}}

==== Favourite.Fields.Favourite ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Favourite.Fields.Favourite",
"items": {
"enums": [
"window",
"windowparameter",
"thumbnail",
"path"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Favourite.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"media",
"window",
"script",
"unknown"
],
"id": "Favourite.Type",
"type": "string",
"default": "media"
}</syntaxhighlight>}}

=== Files ===
==== Files.Media ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"video",
"music",
"pictures",
"files",
"programs"
],
"id": "Files.Media",
"type": "string",
"default": "video"
}</syntaxhighlight>}}

=== Global ===
==== Global.IncrementDecrement ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"increment",
"decrement"
],
"id": "Global.IncrementDecrement",
"type": "string",
"default": "increment"
}</syntaxhighlight>}}

==== Global.String.NotEmpty ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Global.String.NotEmpty",
"type": "string",
"default": ""
}</syntaxhighlight>}}

==== Global.Time ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' hours
* ''integer'' milliseconds
* ''integer'' minutes
* ''integer'' seconds
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Global.Time",
"type": "object",
"properties": {
"hours": {
"type": "integer",
"name": "hours",
"required": true
},
"milliseconds": {
"type": "integer",
"name": "milliseconds",
"required": true
},
"minutes": {
"type": "integer",
"name": "minutes",
"required": true
},
"seconds": {
"type": "integer",
"name": "seconds",
"required": true
}
}
}</syntaxhighlight>}}

==== Global.Toggle ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Global.Toggle",
"type": [
{
"type": "boolean"
},
{
"enums": [
"toggle"
],
"type": "string"
}
]
}</syntaxhighlight>}}

==== Global.Weekday ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"id": "Global.Weekday",
"type": "string",
"default": "monday"
}</syntaxhighlight>}}

=== GUI ===
==== GUI.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"currentwindow",
"currentcontrol",
"skin",
"fullscreen",
"stereoscopicmode"
],
"id": "GUI.Property.Name",
"type": "string",
"default": "currentwindow"
}</syntaxhighlight>}}

==== GUI.Property.Value ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''mixed'' currentcontrol ]
* [ ''mixed'' currentwindow ]
* [ ''boolean'' fullscreen = false ]
* [ ''mixed'' skin ]
* [ ''[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]'' stereoscopicmode ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "GUI.Property.Value",
"type": "object",
"properties": {
"currentcontrol": {
"type": "object",
"name": "currentcontrol"
},
"currentwindow": {
"type": "object",
"name": "currentwindow"
},
"fullscreen": {
"default": "false",
"type": "boolean",
"name": "fullscreen"
},
"skin": {
"type": "object",
"name": "skin"
},
"stereoscopicmode": {
"$ref": "GUI.Stereoscopy.Mode",
"name": "stereoscopicmode"
}
}
}</syntaxhighlight>}}

==== GUI.Stereoscopy.Mode ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' label
* ''string'' mode
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "GUI.Stereoscopy.Mode",
"type": "object",
"properties": {
"label": {
"type": "string",
"name": "label",
"required": true
},
"mode": {
"type": "string",
"name": "mode",
"required": true
}
}
}</syntaxhighlight>}}

==== GUI.Window ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"home",
"programs",
"pictures",
"filemanager",
"settings",
"music",
"videos",
"tvchannels",
"tvrecordings",
"tvguide",
"tvtimers",
"tvsearch",
"radiochannels",
"radiorecordings",
"radioguide",
"radiotimers",
"radiosearch",
"gamecontrollers",
"pvrguideinfo",
"pvrrecordinginfo",
"pvrradiordsinfo",
"pvrtimersetting",
"pvrgroupmanager",
"pvrchannelmanager",
"pvrguidesearch",
"pvrchannelscan",
"pvrupdateprogress",
"pvrosdchannels",
"pvrosdguide",
"pvrosdteletext",
"systeminfo",
"testpattern",
"screencalibration",
"systemsettings",
"servicesettings",
"pvrsettings",
"playersettings",
"mediasettings",
"interfacesettings",
"appearancesettings",
"videoplaylist",
"loginscreen",
"profiles",
"skinsettings",
"addonbrowser",
"yesnodialog",
"progressdialog",
"virtualkeyboard",
"volumebar",
"submenu",
"favourites",
"contextmenu",
"notification",
"numericinput",
"gamepadinput",
"shutdownmenu",
"playercontrols",
"playerprocessinfo",
"seekbar",
"musicosd",
"addonsettings",
"visualisationpresetlist",
"osdcmssettings",
"osdvideosettings",
"osdaudiosettings",
"audiodspmanager",
"osdaudiodspsettings",
"videobookmarks",
"filebrowser",
"networksetup",
"mediasource",
"profilesettings",
"locksettings",
"contentsettings",
"songinformation",
"smartplaylisteditor",
"smartplaylistrule",
"busydialog",
"pictureinfo",
"accesspoints",
"fullscreeninfo",
"sliderdialog",
"addoninformation",
"subtitlesearch",
"musicplaylist",
"musicplaylisteditor",
"teletext",
"selectdialog",
"musicinformation",
"okdialog",
"movieinformation",
"textviewer",
"fullscreenvideo",
"fullscreenlivetv",
"fullscreenradio",
"visualisation",
"slideshow",
"weather",
"screensaver",
"videoosd",
"videomenu",
"videotimeseek",
"startwindow",
"startup",
"peripheralsettings",
"extendedprogressdialog",
"mediafilter",
"addon",
"eventlog",
"tvtimerrules",
"radiotimerrules"
],
"id": "GUI.Window",
"type": "string",
"default": "home"
}</syntaxhighlight>}}

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

=== Item ===
==== Item.Details.Base ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' label
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Item.Details.Base",
"type": "object",
"properties": {
"label": {
"type": "string",
"name": "label",
"required": true
}
}
}</syntaxhighlight>}}

==== Item.Fields.Base ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Item.Fields.Base",
"type": "array",
"items": {
"type": "string"
}
}</syntaxhighlight>}}

=== Library ===
==== Library.Details.Genre ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' genreid
* [ ''string'' thumbnail ]
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Library.Details.Genre",
"properties": {
"genreid": {
"$ref": "Library.Id",
"name": "genreid",
"required": true
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== Library.Details.Tag ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' tagid
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Library.Details.Tag",
"properties": {
"tagid": {
"$ref": "Library.Id",
"name": "tagid",
"required": true
},
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== Library.Fields.Genre ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Library.Fields.Genre",
"items": {
"enums": [
"title",
"thumbnail"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Library.Fields.Tag ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Library.Fields.Tag",
"items": {
"enums": [
"title"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Library.Id ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Library.Id",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

=== List ===
==== List.Amount ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.Amount",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

==== List.Fields.All ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "List.Fields.All",
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"channel",
"channeltype",
"hidden",
"locked",
"channelnumber",
"starttime",
"endtime",
"specialsortseason",
"specialsortepisode",
"compilation",
"releasetype",
"albumreleasetype",
"contributors",
"displaycomposer",
"displayconductor",
"displayorchestra",
"displaylyricist",
"userrating"
],
"type": "string"
}
}</syntaxhighlight>}}

==== List.Fields.Files ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "List.Fields.Files",
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"size",
"lastmodified",
"mimetype",
"specialsortseason",
"specialsortepisode"
],
"type": "string"
}
}</syntaxhighlight>}}

==== List.Filter.Albums ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.Artists ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.Episodes ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.Fields.Albums ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"genre",
"album",
"artist",
"albumartist",
"year",
"review",
"themes",
"moods",
"styles",
"compilation",
"type",
"label",
"rating",
"userrating",
"playcount",
"lastplayed",
"path",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Albums",
"type": "string",
"default": "genre"
}</syntaxhighlight>}}

==== List.Filter.Fields.Artists ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"artist",
"genre",
"moods",
"styles",
"instruments",
"biography",
"born",
"bandformed",
"disbanded",
"died",
"role",
"path",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Artists",
"type": "string",
"default": "artist"
}</syntaxhighlight>}}

==== List.Filter.Fields.Episodes ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"title",
"tvshow",
"plot",
"votes",
"rating",
"userrating",
"time",
"writers",
"airdate",
"playcount",
"lastplayed",
"inprogress",
"genre",
"year",
"director",
"actor",
"episode",
"season",
"filename",
"path",
"studio",
"mpaarating",
"dateadded",
"tag",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Episodes",
"type": "string",
"default": "title"
}</syntaxhighlight>}}

==== List.Filter.Fields.Movies ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"title",
"plot",
"plotoutline",
"tagline",
"votes",
"rating",
"userrating",
"time",
"writers",
"playcount",
"lastplayed",
"inprogress",
"genre",
"country",
"year",
"director",
"actor",
"mpaarating",
"top250",
"studio",
"hastrailer",
"filename",
"path",
"set",
"tag",
"dateadded",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Movies",
"type": "string",
"default": "title"
}</syntaxhighlight>}}

==== List.Filter.Fields.MusicVideos ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"title",
"genre",
"album",
"year",
"artist",
"filename",
"path",
"playcount",
"lastplayed",
"rating",
"userrating",
"time",
"director",
"studio",
"plot",
"tag",
"dateadded",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.MusicVideos",
"type": "string",
"default": "title"
}</syntaxhighlight>}}

==== List.Filter.Fields.Songs ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"genre",
"album",
"artist",
"albumartist",
"title",
"year",
"time",
"tracknumber",
"filename",
"path",
"playcount",
"lastplayed",
"rating",
"userrating",
"comment",
"moods",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Songs",
"type": "string",
"default": "genre"
}</syntaxhighlight>}}

==== List.Filter.Fields.Textures ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"textureid",
"url",
"cachedurl",
"lasthashcheck",
"imagehash",
"width",
"height",
"usecount",
"lastused"
],
"id": "List.Filter.Fields.Textures",
"type": "string",
"default": "textureid"
}</syntaxhighlight>}}

==== List.Filter.Fields.TVShows ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"title",
"plot",
"status",
"votes",
"rating",
"userrating",
"year",
"genre",
"director",
"actor",
"numepisodes",
"numwatched",
"playcount",
"path",
"studio",
"mpaarating",
"dateadded",
"lastplayed",
"inprogress",
"tag",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.TVShows",
"type": "string",
"default": "title"
}</syntaxhighlight>}}

==== List.Filter.Movies ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.MusicVideos ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.Operators ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"contains",
"doesnotcontain",
"is",
"isnot",
"startswith",
"endswith",
"greaterthan",
"lessthan",
"after",
"before",
"inthelast",
"notinthelast",
"true",
"false",
"between"
],
"id": "List.Filter.Operators",
"type": "string",
"default": "contains"
}</syntaxhighlight>}}

==== List.Filter.Rule ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Operators|List.Filter.Operators]]'' operator
* ''mixed: string|array'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.Filter.Rule",
"type": "object",
"properties": {
"operator": {
"$ref": "List.Filter.Operators",
"name": "operator",
"required": true
},
"value": {
"type": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Albums ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Albums|List.Filter.Fields.Albums]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Albums",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Albums",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Artists ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Artists|List.Filter.Fields.Artists]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Artists",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Artists",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Episodes ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Episodes|List.Filter.Fields.Episodes]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Episodes",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Episodes",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Movies ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Movies|List.Filter.Fields.Movies]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Movies",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Movies",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.MusicVideos ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.MusicVideos|List.Filter.Fields.MusicVideos]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.MusicVideos",
"properties": {
"field": {
"$ref": "List.Filter.Fields.MusicVideos",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Songs ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Songs|List.Filter.Fields.Songs]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Songs",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Songs",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Textures ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Textures|List.Filter.Fields.Textures]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Textures",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Textures",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.TVShows ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.TVShows|List.Filter.Fields.TVShows]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.TVShows",
"properties": {
"field": {
"$ref": "List.Filter.Fields.TVShows",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Songs ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.Textures ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.TVShows ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Item.All ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' channel ]
* [ ''integer'' channelnumber = "0" ]
* [ ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = "tv" ]
* [ ''string'' endtime ]
* [ ''boolean'' hidden = false ]
* [ ''boolean'' locked = false ]
* [ ''string'' starttime ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Item.Base"
],
"id": "List.Item.All",
"properties": {
"channel": {
"default": "",
"type": "string",
"name": "channel"
},
"channelnumber": {
"default": "0",
"type": "integer",
"name": "channelnumber"
},
"channeltype": {
"default": "tv",
"$ref": "PVR.Channel.Type",
"name": "channeltype"
},
"endtime": {
"default": "",
"type": "string",
"name": "endtime"
},
"hidden": {
"default": "false",
"type": "boolean",
"name": "hidden"
},
"locked": {
"default": "false",
"type": "boolean",
"name": "locked"
},
"starttime": {
"default": "",
"type": "string",
"name": "starttime"
}
}
}</syntaxhighlight>}}

==== List.Item.Base ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' album ]
* [ ''[[#Array.String|Array.String]]'' albumartist ]
* [ ''[[#Array.Integer|Array.Integer]]'' albumartistid ]
* [ ''[[#Library.Id|Library.Id]]'' albumid = "-1" ]
* [ ''string'' albumlabel ]
* [ ''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' albumreleasetype = "album" ]
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''string'' comment ]
* [ ''boolean'' compilation = false ]
* [ ''[[#Audio.Contributors|Audio.Contributors]]'' contributors ]
* [ ''[[#Array.String|Array.String]]'' country ]
* [ ''string'' description ]
* [ ''integer'' disc = "0" ]
* [ ''string'' displaycomposer ]
* [ ''string'' displayconductor ]
* [ ''string'' displaylyricist ]
* [ ''string'' displayorchestra ]
* [ ''integer'' duration = "0" ]
* [ ''integer'' episode = "0" ]
* [ ''string'' episodeguide ]
* [ ''string'' firstaired ]
* [ ''[[#Library.Id|Library.Id]]'' id = "-1" ]
* [ ''string'' imdbnumber ]
* [ ''string'' lyrics ]
* [ ''[[#Array.String|Array.String]]'' mood ]
* [ ''string'' mpaa ]
* [ ''string'' musicbrainzartistid ]
* [ ''string'' musicbrainztrackid ]
* [ ''string'' originaltitle ]
* [ ''string'' plotoutline ]
* [ ''string'' premiered ]
* [ ''string'' productioncode ]
* [ ''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = "album" ]
* [ ''integer'' season = "0" ]
* [ ''string'' set ]
* [ ''[[#Library.Id|Library.Id]]'' setid = "-1" ]
* [ ''[[#Array.String|Array.String]]'' showlink ]
* [ ''string'' showtitle ]
* [ ''string'' sorttitle ]
* [ ''integer'' specialsortepisode = "0" ]
* [ ''integer'' specialsortseason = "0" ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''[[#Array.String|Array.String]]'' style ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* [ ''string'' tagline ]
* [ ''[[#Array.String|Array.String]]'' theme ]
* [ ''integer'' top250 = "0" ]
* [ ''integer'' track = "0" ]
* [ ''string'' trailer ]
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
* [ ''string'' type = "unknown" ]
* [ ''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid ]
* [ ''string'' votes ]
* [ ''integer'' watchedepisodes = "0" ]
* [ ''[[#Array.String|Array.String]]'' writer ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.File",
"Audio.Details.Media"
],
"id": "List.Item.Base",
"properties": {
"album": {
"default": "",
"type": "string",
"name": "album"
},
"albumartist": {
"$ref": "Array.String",
"name": "albumartist"
},
"albumartistid": {
"$ref": "Array.Integer",
"name": "albumartistid"
},
"albumid": {
"default": "-1",
"$ref": "Library.Id",
"name": "albumid"
},
"albumlabel": {
"default": "",
"type": "string",
"name": "albumlabel"
},
"albumreleasetype": {
"default": "album",
"$ref": "Audio.Album.ReleaseType",
"name": "albumreleasetype"
},
"cast": {
"$ref": "Video.Cast",
"name": "cast"
},
"comment": {
"default": "",
"type": "string",
"name": "comment"
},
"compilation": {
"default": "false",
"type": "boolean",
"name": "compilation"
},
"contributors": {
"$ref": "Audio.Contributors",
"name": "contributors"
},
"country": {
"$ref": "Array.String",
"name": "country"
},
"description": {
"default": "",
"type": "string",
"name": "description"
},
"disc": {
"default": "0",
"type": "integer",
"name": "disc"
},
"displaycomposer": {
"default": "",
"type": "string",
"name": "displaycomposer"
},
"displayconductor": {
"default": "",
"type": "string",
"name": "displayconductor"
},
"displaylyricist": {
"default": "",
"type": "string",
"name": "displaylyricist"
},
"displayorchestra": {
"default": "",
"type": "string",
"name": "displayorchestra"
},
"duration": {
"default": "0",
"type": "integer",
"name": "duration"
},
"episode": {
"default": "0",
"type": "integer",
"name": "episode"
},
"episodeguide": {
"default": "",
"type": "string",
"name": "episodeguide"
},
"firstaired": {
"default": "",
"type": "string",
"name": "firstaired"
},
"id": {
"default": "-1",
"$ref": "Library.Id",
"name": "id"
},
"imdbnumber": {
"default": "",
"type": "string",
"name": "imdbnumber"
},
"lyrics": {
"default": "",
"type": "string",
"name": "lyrics"
},
"mood": {
"$ref": "Array.String",
"name": "mood"
},
"mpaa": {
"default": "",
"type": "string",
"name": "mpaa"
},
"musicbrainzartistid": {
"default": "",
"type": "string",
"name": "musicbrainzartistid"
},
"musicbrainztrackid": {
"default": "",
"type": "string",
"name": "musicbrainztrackid"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"plotoutline": {
"default": "",
"type": "string",
"name": "plotoutline"
},
"premiered": {
"default": "",
"type": "string",
"name": "premiered"
},
"productioncode": {
"default": "",
"type": "string",
"name": "productioncode"
},
"releasetype": {
"default": "album",
"$ref": "Audio.Album.ReleaseType",
"name": "releasetype"
},
"season": {
"default": "0",
"type": "integer",
"name": "season"
},
"set": {
"default": "",
"type": "string",
"name": "set"
},
"setid": {
"default": "-1",
"$ref": "Library.Id",
"name": "setid"
},
"showlink": {
"$ref": "Array.String",
"name": "showlink"
},
"showtitle": {
"default": "",
"type": "string",
"name": "showtitle"
},
"sorttitle": {
"default": "",
"type": "string",
"name": "sorttitle"
},
"specialsortepisode": {
"default": "0",
"type": "integer",
"name": "specialsortepisode"
},
"specialsortseason": {
"default": "0",
"type": "integer",
"name": "specialsortseason"
},
"studio": {
"$ref": "Array.String",
"name": "studio"
},
"style": {
"$ref": "Array.String",
"name": "style"
},
"tag": {
"$ref": "Array.String",
"name": "tag"
},
"tagline": {
"default": "",
"type": "string",
"name": "tagline"
},
"theme": {
"$ref": "Array.String",
"name": "theme"
},
"top250": {
"default": "0",
"type": "integer",
"name": "top250"
},
"track": {
"default": "0",
"type": "integer",
"name": "track"
},
"trailer": {
"default": "",
"type": "string",
"name": "trailer"
},
"tvshowid": {
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
"type": {
"default": "unknown",
"type": "string",
"name": "type"
},
"uniqueid": {
"$ref": "Media.UniqueID",
"name": "uniqueid"
},
"votes": {
"default": "",
"type": "string",
"name": "votes"
},
"watchedepisodes": {
"default": "0",
"type": "integer",
"name": "watchedepisodes"
},
"writer": {
"$ref": "Array.String",
"name": "writer"
}
}
}</syntaxhighlight>}}

==== List.Item.File ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' file
* ''string'' filetype
* [ ''string'' lastmodified ]
* [ ''string'' mimetype ]
* [ ''integer'' size = "0" ] ''Size of the file in bytes''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Item.Base"
],
"id": "List.Item.File",
"properties": {
"file": {
"type": "string",
"name": "file",
"required": true
},
"filetype": {
"type": "string",
"name": "filetype",
"required": true
},
"lastmodified": {
"default": "",
"type": "string",
"name": "lastmodified"
},
"mimetype": {
"default": "",
"type": "string",
"name": "mimetype"
},
"size": {
"default": "0",
"description": "Size of the file in bytes",
"type": "integer",
"name": "size"
}
}
}</syntaxhighlight>}}

==== List.Items.Sources ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.Items.Sources",
"type": "array",
"items": {
"extends": "Item.Details.Base",
"properties": {
"file": {
"required": true,
"type": "string"
}
}
}
}</syntaxhighlight>}}

==== List.Limits ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#List.Amount|List.Amount]]'' end = "-1" ] ''Index of the last item to return''
* [ ''integer'' start = "0" ] ''Index of the first item to return''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.Limits",
"type": "object",
"properties": {
"end": {
"default": "-1",
"description": "Index of the last item to return",
"$ref": "List.Amount",
"name": "end"
},
"start": {
"default": "0",
"description": "Index of the first item to return",
"type": "integer",
"name": "start"
}
}
}</syntaxhighlight>}}

==== List.LimitsReturned ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#List.Amount|List.Amount]]'' end = "-1" ]
* [ ''integer'' start = "0" ]
* ''integer'' total
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.LimitsReturned",
"type": "object",
"properties": {
"end": {
"default": "-1",
"$ref": "List.Amount",
"name": "end"
},
"start": {
"default": "0",
"type": "integer",
"name": "start"
},
"total": {
"type": "integer",
"name": "total",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Sort ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' ignorearticle = false ]
* [ ''string'' method = "none" ]
* [ ''string'' order = "ascending" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.Sort",
"type": "object",
"properties": {
"ignorearticle": {
"default": "false",
"type": "boolean",
"name": "ignorearticle"
},
"method": {
"default": "none",
"type": "string",
"name": "method"
},
"order": {
"default": "ascending",
"type": "string",
"name": "order"
}
}
}</syntaxhighlight>}}

=== Media ===
==== Media.Artwork ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' banner ]
* [ ''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' fanart ]
* [ ''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' poster ]
* [ ''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' thumb ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Media.Artwork",
"type": "object",
"properties": {
"banner": {
"default": "",
"$ref": "Global.String.NotEmpty",
"name": "banner"
},
"fanart": {
"default": "",
"$ref": "Global.String.NotEmpty",
"name": "fanart"
},
"poster": {
"default": "",
"$ref": "Global.String.NotEmpty",
"name": "poster"
},
"thumb": {
"default": "",
"$ref": "Global.String.NotEmpty",
"name": "thumb"
}
}
}</syntaxhighlight>}}

==== Media.Artwork.Set ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''mixed'' banner ]
* [ ''mixed'' fanart ]
* [ ''mixed'' poster ]
* [ ''mixed'' thumb ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Media.Artwork.Set",
"type": "object",
"properties": {
"banner": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
],
"name": "banner"
},
"fanart": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
],
"name": "fanart"
},
"poster": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
],
"name": "poster"
},
"thumb": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
],
"name": "thumb"
}
}
}</syntaxhighlight>}}

==== Media.Details.Base ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' fanart ]
* [ ''string'' thumbnail ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Media.Details.Base",
"properties": {
"fanart": {
"default": "",
"type": "string",
"name": "fanart"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
}
}
}</syntaxhighlight>}}

==== Media.UniqueID ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Media.UniqueID",
"type": "object"
}</syntaxhighlight>}}

==== Media.UniqueID.Set ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Media.UniqueID.Set",
"type": "object"
}</syntaxhighlight>}}

=== Notifications ===
==== Notifications.Item ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== Notifications.Item.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"unknown",
"movie",
"episode",
"musicvideo",
"song",
"picture",
"channel"
],
"id": "Notifications.Item.Type",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

=== Optional ===
==== Optional.Boolean ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Optional.Boolean",
"type": [
{
"type": "null"
},
{
"type": "boolean"
}
]
}</syntaxhighlight>}}

==== Optional.Integer ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Optional.Integer",
"type": [
{
"type": "null"
},
{
"type": "integer"
}
]
}</syntaxhighlight>}}

==== Optional.Number ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Optional.Number",
"type": [
{
"type": "null"
},
{
"type": "number"
}
]
}</syntaxhighlight>}}

==== Optional.String ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Optional.String",
"type": [
{
"type": "null"
},
{
"type": "string"
}
]
}</syntaxhighlight>}}

=== Player ===
==== Player.Audio.Stream ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' bitrate
* ''integer'' channels
* ''string'' codec
* ''integer'' index
* ''string'' language
* ''string'' name
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Audio.Stream",
"type": "object",
"properties": {
"bitrate": {
"type": "integer",
"name": "bitrate",
"required": true
},
"channels": {
"type": "integer",
"name": "channels",
"required": true
},
"codec": {
"type": "string",
"name": "codec",
"required": true
},
"index": {
"type": "integer",
"name": "index",
"required": true
},
"language": {
"type": "string",
"name": "language",
"required": true
},
"name": {
"type": "string",
"name": "name",
"required": true
}
}
}</syntaxhighlight>}}

==== Player.Id ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Id",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

==== Player.Notifications.Data ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Notifications.Item|Notifications.Item]]'' item
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Notifications.Data",
"type": "object",
"properties": {
"item": {
"$ref": "Notifications.Item",
"name": "item",
"required": true
},
"player": {
"$ref": "Player.Notifications.Player",
"name": "player",
"required": true
}
}
}</syntaxhighlight>}}

==== Player.Notifications.Player ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Player.Id|Player.Id]]'' playerid
* [ ''integer'' speed = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Notifications.Player",
"type": "object",
"properties": {
"playerid": {
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
"speed": {
"default": "0",
"type": "integer",
"name": "speed"
}
}
}</syntaxhighlight>}}

==== Player.Notifications.Player.Seek ====
'''Extends:'''
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Global.Time|Global.Time]]'' seekoffset ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Player.Notifications.Player"
],
"id": "Player.Notifications.Player.Seek",
"properties": {
"seekoffset": {
"$ref": "Global.Time",
"name": "seekoffset"
},
"time": {
"$ref": "Global.Time",
"name": "time"
}
}
}</syntaxhighlight>}}

==== Player.Position.Percentage ====
'''Type:''' ''number''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Position.Percentage",
"type": "number",
"default": 0
}</syntaxhighlight>}}

==== Player.Position.Time ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' hours = "0" ]
* [ ''integer'' milliseconds = "0" ]
* [ ''integer'' minutes = "0" ]
* [ ''integer'' seconds = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Position.Time",
"type": "object",
"properties": {
"hours": {
"default": "0",
"type": "integer",
"name": "hours"
},
"milliseconds": {
"default": "0",
"type": "integer",
"name": "milliseconds"
},
"minutes": {
"default": "0",
"type": "integer",
"name": "minutes"
},
"seconds": {
"default": "0",
"type": "integer",
"name": "seconds"
}
}
}</syntaxhighlight>}}

==== Player.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"type",
"partymode",
"speed",
"time",
"percentage",
"totaltime",
"playlistid",
"position",
"repeat",
"shuffled",
"canseek",
"canchangespeed",
"canmove",
"canzoom",
"canrotate",
"canshuffle",
"canrepeat",
"currentaudiostream",
"audiostreams",
"subtitleenabled",
"currentsubtitle",
"subtitles",
"live",
"currentvideostream",
"videostreams"
],
"id": "Player.Property.Name",
"type": "string",
"default": "type"
}</syntaxhighlight>}}

==== Player.Property.Value ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Player.Audio.Stream|Player.Audio.Stream]]''[] audiostreams ]
* [ ''boolean'' canchangespeed = false ]
* [ ''boolean'' canmove = false ]
* [ ''boolean'' canrepeat = false ]
* [ ''boolean'' canrotate = false ]
* [ ''boolean'' canseek = false ]
* [ ''boolean'' canshuffle = false ]
* [ ''boolean'' canzoom = false ]
* [ ''[[#Player.Audio.Stream|Player.Audio.Stream]]'' currentaudiostream ]
* [ ''[[#Player.Subtitle|Player.Subtitle]]'' currentsubtitle ]
* [ ''[[#Player.Video.Stream|Player.Video.Stream]]'' currentvideostream ]
* [ ''boolean'' live = false ]
* [ ''boolean'' partymode = false ]
* [ ''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage = "0" ]
* [ ''[[#Playlist.Id|Playlist.Id]]'' playlistid = "-1" ]
* [ ''[[#Playlist.Position|Playlist.Position]]'' position = "-1" ]
* [ ''[[#Player.Repeat|Player.Repeat]]'' repeat = "off" ]
* [ ''boolean'' shuffled = false ]
* [ ''integer'' speed = "0" ]
* [ ''boolean'' subtitleenabled = false ]
* [ ''[[#Player.Subtitle|Player.Subtitle]]''[] subtitles ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
* [ ''[[#Global.Time|Global.Time]]'' totaltime ]
* [ ''[[#Player.Type|Player.Type]]'' type = "video" ]
* [ ''[[#Player.Video.Stream|Player.Video.Stream]]''[] videostreams ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Property.Value",
"type": "object",
"properties": {
"audiostreams": {
"items": {
"$ref": "Player.Audio.Stream"
},
"type": "array",
"name": "audiostreams"
},
"canchangespeed": {
"default": "false",
"type": "boolean",
"name": "canchangespeed"
},
"canmove": {
"default": "false",
"type": "boolean",
"name": "canmove"
},
"canrepeat": {
"default": "false",
"type": "boolean",
"name": "canrepeat"
},
"canrotate": {
"default": "false",
"type": "boolean",
"name": "canrotate"
},
"canseek": {
"default": "false",
"type": "boolean",
"name": "canseek"
},
"canshuffle": {
"default": "false",
"type": "boolean",
"name": "canshuffle"
},
"canzoom": {
"default": "false",
"type": "boolean",
"name": "canzoom"
},
"currentaudiostream": {
"$ref": "Player.Audio.Stream",
"name": "currentaudiostream"
},
"currentsubtitle": {
"$ref": "Player.Subtitle",
"name": "currentsubtitle"
},
"currentvideostream": {
"$ref": "Player.Video.Stream",
"name": "currentvideostream"
},
"live": {
"default": "false",
"type": "boolean",
"name": "live"
},
"partymode": {
"default": "false",
"type": "boolean",
"name": "partymode"
},
"percentage": {
"default": "0",
"$ref": "Player.Position.Percentage",
"name": "percentage"
},
"playlistid": {
"default": "-1",
"$ref": "Playlist.Id",
"name": "playlistid"
},
"position": {
"default": "-1",
"$ref": "Playlist.Position",
"name": "position"
},
"repeat": {
"default": "off",
"$ref": "Player.Repeat",
"name": "repeat"
},
"shuffled": {
"default": "false",
"type": "boolean",
"name": "shuffled"
},
"speed": {
"default": "0",
"type": "integer",
"name": "speed"
},
"subtitleenabled": {
"default": "false",
"type": "boolean",
"name": "subtitleenabled"
},
"subtitles": {
"items": {
"$ref": "Player.Subtitle"
},
"type": "array",
"name": "subtitles"
},
"time": {
"$ref": "Global.Time",
"name": "time"
},
"totaltime": {
"$ref": "Global.Time",
"name": "totaltime"
},
"type": {
"default": "video",
"$ref": "Player.Type",
"name": "type"
},
"videostreams": {
"items": {
"$ref": "Player.Video.Stream"
},
"type": "array",
"name": "videostreams"
}
}
}</syntaxhighlight>}}

==== Player.Repeat ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"off",
"one",
"all"
],
"id": "Player.Repeat",
"type": "string",
"default": "off"
}</syntaxhighlight>}}

==== Player.Speed ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' speed = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Speed",
"type": "object",
"properties": {
"speed": {
"default": "0",
"type": "integer",
"name": "speed"
}
}
}</syntaxhighlight>}}

==== Player.Subtitle ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' index
* ''string'' language
* ''string'' name
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Subtitle",
"type": "object",
"properties": {
"index": {
"type": "integer",
"name": "index",
"required": true
},
"language": {
"type": "string",
"name": "language",
"required": true
},
"name": {
"type": "string",
"name": "name",
"required": true
}
}
}</syntaxhighlight>}}

==== Player.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"video",
"audio",
"picture"
],
"id": "Player.Type",
"type": "string",
"default": "video"
}</syntaxhighlight>}}

==== Player.Video.Stream ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' codec
* ''integer'' height
* ''integer'' index
* ''string'' language
* ''string'' name
* ''integer'' width
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Video.Stream",
"type": "object",
"properties": {
"codec": {
"type": "string",
"name": "codec",
"required": true
},
"height": {
"type": "integer",
"name": "height",
"required": true
},
"index": {
"type": "integer",
"name": "index",
"required": true
},
"language": {
"type": "string",
"name": "language",
"required": true
},
"name": {
"type": "string",
"name": "name",
"required": true
},
"width": {
"type": "integer",
"name": "width",
"required": true
}
}
}</syntaxhighlight>}}

=== Playlist ===
==== Playlist.Id ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Playlist.Id",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

==== Playlist.Item ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== Playlist.Position ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Playlist.Position",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

==== Playlist.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"type",
"size"
],
"id": "Playlist.Property.Name",
"type": "string",
"default": "type"
}</syntaxhighlight>}}

==== Playlist.Property.Value ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' size = "0" ]
* [ ''[[#Playlist.Type|Playlist.Type]]'' type = "unknown" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Playlist.Property.Value",
"type": "object",
"properties": {
"size": {
"default": "0",
"type": "integer",
"name": "size"
},
"type": {
"default": "unknown",
"$ref": "Playlist.Type",
"name": "type"
}
}
}</syntaxhighlight>}}

==== Playlist.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"unknown",
"video",
"audio",
"picture",
"mixed"
],
"id": "Playlist.Type",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

=== Profiles ===
==== Profiles.Details.Profile ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' lockmode = "0" ]
* [ ''string'' thumbnail ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Profiles.Details.Profile",
"properties": {
"lockmode": {
"default": "0",
"type": "integer",
"name": "lockmode"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
}
}
}</syntaxhighlight>}}

==== Profiles.Fields.Profile ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Profiles.Fields.Profile",
"items": {
"enums": [
"thumbnail",
"lockmode"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Profiles.Password ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' encryption = "md5" ] ''Password Encryption''
* ''string'' value ''Password''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Profiles.Password",
"type": "object",
"properties": {
"encryption": {
"default": "md5",
"description": "Password Encryption",
"type": "string",
"name": "encryption"
},
"value": {
"description": "Password",
"type": "string",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

=== PVR ===
==== PVR.Channel.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"tv",
"radio"
],
"id": "PVR.Channel.Type",
"type": "string",
"default": "tv"
}</syntaxhighlight>}}

==== PVR.ChannelGroup.Id ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "PVR.ChannelGroup.Id",
"type": [
{
"$ref": "Library.Id"
},
{
"enums": [
"alltv",
"allradio"
],
"type": "string"
}
]
}</syntaxhighlight>}}

==== PVR.Details.Broadcast ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' broadcastid
* [ ''string'' cast ]
* [ ''string'' director ]
* [ ''string'' endtime ]
* [ ''string'' episodename ]
* [ ''integer'' episodenum = "0" ]
* [ ''integer'' episodepart = "0" ]
* [ ''string'' firstaired ]
* [ ''string'' genre ]
* [ ''boolean'' hasrecording = false ]
* [ ''boolean'' hastimer = false ]
* [ ''boolean'' hastimerrule = false ]
* [ ''integer'' imdbnumber = "0" ]
* [ ''boolean'' isactive = false ]
* [ ''boolean'' isseries = false ]
* [ ''string'' originaltitle ]
* [ ''integer'' parentalrating = "0" ]
* [ ''string'' plot ]
* [ ''string'' plotoutline ]
* [ ''integer'' progress = "0" ]
* [ ''number'' progresspercentage = "0" ]
* [ ''integer'' rating = "0" ]
* [ ''string'' recording ]
* [ ''integer'' runtime = "0" ]
* [ ''string'' starttime ]
* [ ''string'' thumbnail ]
* [ ''string'' title ]
* [ ''boolean'' wasactive = false ]
* [ ''string'' writer ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.Broadcast",
"properties": {
"broadcastid": {
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
"cast": {
"default": "",
"type": "string",
"name": "cast"
},
"director": {
"default": "",
"type": "string",
"name": "director"
},
"endtime": {
"default": "",
"type": "string",
"name": "endtime"
},
"episodename": {
"default": "",
"type": "string",
"name": "episodename"
},
"episodenum": {
"default": "0",
"type": "integer",
"name": "episodenum"
},
"episodepart": {
"default": "0",
"type": "integer",
"name": "episodepart"
},
"firstaired": {
"default": "",
"type": "string",
"name": "firstaired"
},
"genre": {
"default": "",
"type": "string",
"name": "genre"
},
"hasrecording": {
"default": "false",
"type": "boolean",
"name": "hasrecording"
},
"hastimer": {
"default": "false",
"type": "boolean",
"name": "hastimer"
},
"hastimerrule": {
"default": "false",
"type": "boolean",
"name": "hastimerrule"
},
"imdbnumber": {
"default": "0",
"type": "integer",
"name": "imdbnumber"
},
"isactive": {
"default": "false",
"type": "boolean",
"name": "isactive"
},
"isseries": {
"default": "false",
"type": "boolean",
"name": "isseries"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"parentalrating": {
"default": "0",
"type": "integer",
"name": "parentalrating"
},
"plot": {
"default": "",
"type": "string",
"name": "plot"
},
"plotoutline": {
"default": "",
"type": "string",
"name": "plotoutline"
},
"progress": {
"default": "0",
"type": "integer",
"name": "progress"
},
"progresspercentage": {
"default": "0",
"type": "number",
"name": "progresspercentage"
},
"rating": {
"default": "0",
"type": "integer",
"name": "rating"
},
"recording": {
"default": "",
"type": "string",
"name": "recording"
},
"runtime": {
"default": "0",
"type": "integer",
"name": "runtime"
},
"starttime": {
"default": "",
"type": "string",
"name": "starttime"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"title": {
"default": "",
"type": "string",
"name": "title"
},
"wasactive": {
"default": "false",
"type": "boolean",
"name": "wasactive"
},
"writer": {
"default": "",
"type": "string",
"name": "writer"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== PVR.Details.Channel ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastnext ]
* [ ''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastnow ]
* [ ''string'' channel ]
* ''[[#Library.Id|Library.Id]]'' channelid
* [ ''integer'' channelnumber = "0" ]
* [ ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = "tv" ]
* [ ''boolean'' hidden = false ]
* [ ''string'' icon ]
* [ ''boolean'' isrecording = false ]
* [ ''string'' lastplayed ]
* [ ''boolean'' locked = false ]
* [ ''integer'' subchannelnumber = "0" ]
* [ ''string'' thumbnail ]
* ''integer'' uniqueid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.Channel",
"properties": {
"broadcastnext": {
"$ref": "PVR.Details.Broadcast",
"name": "broadcastnext"
},
"broadcastnow": {
"$ref": "PVR.Details.Broadcast",
"name": "broadcastnow"
},
"channel": {
"default": "",
"type": "string",
"name": "channel"
},
"channelid": {
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
"channelnumber": {
"default": "0",
"type": "integer",
"name": "channelnumber"
},
"channeltype": {
"default": "tv",
"$ref": "PVR.Channel.Type",
"name": "channeltype"
},
"hidden": {
"default": "false",
"type": "boolean",
"name": "hidden"
},
"icon": {
"default": "",
"type": "string",
"name": "icon"
},
"isrecording": {
"default": "false",
"type": "boolean",
"name": "isrecording"
},
"lastplayed": {
"default": "",
"type": "string",
"name": "lastplayed"
},
"locked": {
"default": "false",
"type": "boolean",
"name": "locked"
},
"subchannelnumber": {
"default": "0",
"type": "integer",
"name": "subchannelnumber"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"uniqueid": {
"type": "integer",
"name": "uniqueid",
"required": true
}
}
}</syntaxhighlight>}}

==== PVR.Details.ChannelGroup ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' channelgroupid
* ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.ChannelGroup",
"properties": {
"channelgroupid": {
"$ref": "Library.Id",
"name": "channelgroupid",
"required": true
},
"channeltype": {
"$ref": "PVR.Channel.Type",
"name": "channeltype",
"required": true
}
}
}</syntaxhighlight>}}

==== PVR.Details.ChannelGroup.Extended ====
'''Extends:'''
* ''[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#PVR.Details.Channel|PVR.Details.Channel]]''[] channels ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"PVR.Details.ChannelGroup"
],
"id": "PVR.Details.ChannelGroup.Extended",
"properties": {
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"type": "array",
"name": "channels"
},
"limits": {
"$ref": "List.LimitsReturned",
"name": "limits",
"required": true
}
}
}</syntaxhighlight>}}

==== PVR.Details.Recording ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Media.Artwork|Media.Artwork]]'' art ]
* [ ''string'' channel ]
* [ ''integer'' channeluid = "0" ]
* [ ''string'' directory ]
* [ ''string'' endtime ]
* [ ''integer'' epgeventid = "0" ]
* [ ''string'' file ]
* [ ''string'' genre ]
* [ ''string'' icon ]
* [ ''boolean'' isdeleted = false ]
* [ ''integer'' lifetime = "0" ]
* [ ''integer'' playcount = "0" ]
* [ ''string'' plot ]
* [ ''string'' plotoutline ]
* [ ''boolean'' radio = false ]
* ''[[#Library.Id|Library.Id]]'' recordingid
* [ ''[[#Video.Resume|Video.Resume]]'' resume ]
* [ ''integer'' runtime = "0" ]
* [ ''string'' starttime ]
* [ ''string'' streamurl ]
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.Recording",
"properties": {
"art": {
"$ref": "Media.Artwork",
"name": "art"
},
"channel": {
"default": "",
"type": "string",
"name": "channel"
},
"channeluid": {
"default": "0",
"type": "integer",
"name": "channeluid"
},
"directory": {
"default": "",
"type": "string",
"name": "directory"
},
"endtime": {
"default": "",
"type": "string",
"name": "endtime"
},
"epgeventid": {
"default": "0",
"type": "integer",
"name": "epgeventid"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"genre": {
"default": "",
"type": "string",
"name": "genre"
},
"icon": {
"default": "",
"type": "string",
"name": "icon"
},
"isdeleted": {
"default": "false",
"type": "boolean",
"name": "isdeleted"
},
"lifetime": {
"default": "0",
"type": "integer",
"name": "lifetime"
},
"playcount": {
"default": "0",
"type": "integer",
"name": "playcount"
},
"plot": {
"default": "",
"type": "string",
"name": "plot"
},
"plotoutline": {
"default": "",
"type": "string",
"name": "plotoutline"
},
"radio": {
"default": "false",
"type": "boolean",
"name": "radio"
},
"recordingid": {
"$ref": "Library.Id",
"name": "recordingid",
"required": true
},
"resume": {
"$ref": "Video.Resume",
"name": "resume"
},
"runtime": {
"default": "0",
"type": "integer",
"name": "runtime"
},
"starttime": {
"default": "",
"type": "string",
"name": "starttime"
},
"streamurl": {
"default": "",
"type": "string",
"name": "streamurl"
},
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== PVR.Details.Timer ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Library.Id|Library.Id]]'' channelid = "-1" ]
* [ ''string'' directory ]
* [ ''boolean'' endanytime = false ]
* [ ''integer'' endmargin = "0" ]
* [ ''string'' endtime ]
* [ ''string'' epgsearchstring ]
* [ ''integer'' epguid = "0" ]
* [ ''string'' file ]
* [ ''string'' firstday ]
* [ ''boolean'' fulltextepgsearch = false ]
* [ ''boolean'' ismanual = false ]
* [ ''boolean'' isradio = false ]
* [ ''boolean'' isreadonly = false ]
* [ ''boolean'' istimerrule = false ]
* [ ''integer'' lifetime = "0" ]
* [ ''integer'' maxrecordings = "0" ]
* [ ''integer'' preventduplicateepisodes = "0" ]
* [ ''integer'' priority = "0" ]
* [ ''integer'' recordinggroup = "0" ]
* [ ''integer'' runtime = "0" ]
* [ ''boolean'' startanytime = false ]
* [ ''integer'' startmargin = "0" ]
* [ ''string'' starttime ]
* [ ''[[#PVR.TimerState|PVR.TimerState]]'' state = "unknown" ]
* [ ''string'' summary ]
* ''[[#Library.Id|Library.Id]]'' timerid
* [ ''string'' title ]
* [ ''[[#Global.Weekday|Global.Weekday]]''[] weekdays ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.Timer",
"properties": {
"channelid": {
"default": "-1",
"$ref": "Library.Id",
"name": "channelid"
},
"directory": {
"default": "",
"type": "string",
"name": "directory"
},
"endanytime": {
"default": "false",
"type": "boolean",
"name": "endanytime"
},
"endmargin": {
"default": "0",
"type": "integer",
"name": "endmargin"
},
"endtime": {
"default": "",
"type": "string",
"name": "endtime"
},
"epgsearchstring": {
"default": "",
"type": "string",
"name": "epgsearchstring"
},
"epguid": {
"default": "0",
"type": "integer",
"name": "epguid"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"firstday": {
"default": "",
"type": "string",
"name": "firstday"
},
"fulltextepgsearch": {
"default": "false",
"type": "boolean",
"name": "fulltextepgsearch"
},
"ismanual": {
"default": "false",
"type": "boolean",
"name": "ismanual"
},
"isradio": {
"default": "false",
"type": "boolean",
"name": "isradio"
},
"isreadonly": {
"default": "false",
"type": "boolean",
"name": "isreadonly"
},
"istimerrule": {
"default": "false",
"type": "boolean",
"name": "istimerrule"
},
"lifetime": {
"default": "0",
"type": "integer",
"name": "lifetime"
},
"maxrecordings": {
"default": "0",
"type": "integer",
"name": "maxrecordings"
},
"preventduplicateepisodes": {
"default": "0",
"type": "integer",
"name": "preventduplicateepisodes"
},
"priority": {
"default": "0",
"type": "integer",
"name": "priority"
},
"recordinggroup": {
"default": "0",
"type": "integer",
"name": "recordinggroup"
},
"runtime": {
"default": "0",
"type": "integer",
"name": "runtime"
},
"startanytime": {
"default": "false",
"type": "boolean",
"name": "startanytime"
},
"startmargin": {
"default": "0",
"type": "integer",
"name": "startmargin"
},
"starttime": {
"default": "",
"type": "string",
"name": "starttime"
},
"state": {
"default": "unknown",
"$ref": "PVR.TimerState",
"name": "state"
},
"summary": {
"default": "",
"type": "string",
"name": "summary"
},
"timerid": {
"$ref": "Library.Id",
"name": "timerid",
"required": true
},
"title": {
"default": "",
"type": "string",
"name": "title"
},
"weekdays": {
"items": {
"$ref": "Global.Weekday"
},
"type": "array",
"name": "weekdays"
}
}
}</syntaxhighlight>}}

==== PVR.Fields.Broadcast ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "PVR.Fields.Broadcast",
"items": {
"enums": [
"title",
"plot",
"plotoutline",
"starttime",
"endtime",
"runtime",
"progress",
"progresspercentage",
"genre",
"episodename",
"episodenum",
"episodepart",
"firstaired",
"hastimer",
"isactive",
"parentalrating",
"wasactive",
"thumbnail",
"rating",
"originaltitle",
"cast",
"director",
"writer",
"year",
"imdbnumber",
"hastimerrule",
"hasrecording",
"recording",
"isseries"
],
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Fields.Channel ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "PVR.Fields.Channel",
"items": {
"enums": [
"thumbnail",
"channeltype",
"hidden",
"locked",
"channel",
"lastplayed",
"broadcastnow",
"broadcastnext",
"uniqueid",
"icon",
"channelnumber",
"subchannelnumber",
"isrecording"
],
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Fields.Recording ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "PVR.Fields.Recording",
"items": {
"enums": [
"title",
"plot",
"plotoutline",
"genre",
"playcount",
"resume",
"channel",
"starttime",
"endtime",
"runtime",
"lifetime",
"icon",
"art",
"streamurl",
"file",
"directory",
"radio",
"isdeleted",
"epgeventid",
"channeluid"
],
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Fields.Timer ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "PVR.Fields.Timer",
"items": {
"enums": [
"title",
"summary",
"channelid",
"isradio",
"istimerrule",
"ismanual",
"starttime",
"endtime",
"runtime",
"lifetime",
"firstday",
"weekdays",
"priority",
"startmargin",
"endmargin",
"state",
"file",
"directory",
"preventduplicateepisodes",
"startanytime",
"endanytime",
"epgsearchstring",
"fulltextepgsearch",
"recordinggroup",
"maxrecordings",
"epguid",
"isreadonly"
],
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"available",
"recording",
"scanning"
],
"id": "PVR.Property.Name",
"type": "string",
"default": "available"
}</syntaxhighlight>}}

==== PVR.Property.Value ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' available = false ]
* [ ''boolean'' recording = false ]
* [ ''boolean'' scanning = false ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "PVR.Property.Value",
"type": "object",
"properties": {
"available": {
"default": "false",
"type": "boolean",
"name": "available"
},
"recording": {
"default": "false",
"type": "boolean",
"name": "recording"
},
"scanning": {
"default": "false",
"type": "boolean",
"name": "scanning"
}
}
}</syntaxhighlight>}}

==== PVR.TimerState ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"unknown",
"new",
"scheduled",
"recording",
"completed",
"aborted",
"cancelled",
"conflict_ok",
"conflict_notok",
"error",
"disabled"
],
"id": "PVR.TimerState",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

=== Setting ===
==== Setting.Details.Base ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' help ]
* ''string'' id
* ''string'' label
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Details.Base",
"type": "object",
"properties": {
"help": {
"default": "",
"type": "string",
"name": "help"
},
"id": {
"type": "string",
"name": "id",
"required": true
},
"label": {
"type": "string",
"name": "label",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.Category ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Setting.Details.Group|Setting.Details.Group]]''[] groups ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.Base"
],
"id": "Setting.Details.Category",
"properties": {
"groups": {
"items": {
"$ref": "Setting.Details.Group"
},
"type": "array",
"name": "groups"
}
}
}</syntaxhighlight>}}

==== Setting.Details.Control ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== Setting.Details.ControlBase ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' delayed
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Details.ControlBase",
"type": "object",
"properties": {
"delayed": {
"type": "boolean",
"name": "delayed",
"required": true
},
"format": {
"type": "string",
"name": "format",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlButton ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlHeading"
],
"id": "Setting.Details.ControlButton",
"properties": {
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlCheckmark ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlBase"
],
"id": "Setting.Details.ControlCheckmark",
"properties": {
"format": {
"type": "string",
"name": "format",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlEdit ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' hidden
* ''string'' type
* ''boolean'' verifynewvalue
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlHeading"
],
"id": "Setting.Details.ControlEdit",
"properties": {
"hidden": {
"type": "boolean",
"name": "hidden",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
},
"verifynewvalue": {
"type": "boolean",
"name": "verifynewvalue",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlHeading ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' heading ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlBase"
],
"id": "Setting.Details.ControlHeading",
"properties": {
"heading": {
"default": "",
"type": "string",
"name": "heading"
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlList ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' multiselect
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlHeading"
],
"id": "Setting.Details.ControlList",
"properties": {
"multiselect": {
"type": "boolean",
"name": "multiselect",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlRange ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' formatlabel
* ''string'' formatvalue
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlBase"
],
"id": "Setting.Details.ControlRange",
"properties": {
"formatlabel": {
"type": "string",
"name": "formatlabel",
"required": true
},
"formatvalue": {
"type": "string",
"name": "formatvalue",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlSlider ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' formatlabel
* ''boolean'' popup
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlHeading"
],
"id": "Setting.Details.ControlSlider",
"properties": {
"formatlabel": {
"type": "string",
"name": "formatlabel",
"required": true
},
"popup": {
"type": "boolean",
"name": "popup",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlSpinner ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' formatlabel ]
* [ ''string'' minimumlabel ]
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlBase"
],
"id": "Setting.Details.ControlSpinner",
"properties": {
"formatlabel": {
"default": "",
"type": "string",
"name": "formatlabel"
},
"minimumlabel": {
"default": "",
"type": "string",
"name": "minimumlabel"
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.Group ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' id
* [ ''[[#Setting.Details.Setting|Setting.Details.Setting]]''[] settings ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Details.Group",
"type": "object",
"properties": {
"id": {
"type": "string",
"name": "id",
"required": true
},
"settings": {
"items": {
"$ref": "Setting.Details.Setting"
},
"type": "array",
"name": "settings"
}
}
}</syntaxhighlight>}}

==== Setting.Details.Section ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Setting.Details.Category|Setting.Details.Category]]''[] categories ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.Base"
],
"id": "Setting.Details.Section",
"properties": {
"categories": {
"items": {
"$ref": "Setting.Details.Category"
},
"type": "array",
"name": "categories"
}
}
}</syntaxhighlight>}}

==== Setting.Details.Setting ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== Setting.Details.SettingAction ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingAction"
}</syntaxhighlight>}}

==== Setting.Details.SettingAddon ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Addon.Types|Addon.Types]]'' addontype
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingString"
],
"id": "Setting.Details.SettingAddon",
"properties": {
"addontype": {
"$ref": "Addon.Types",
"name": "addontype",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingBase ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Setting.Details.Control|Setting.Details.Control]]'' control ]
* ''boolean'' enabled
* ''[[#Setting.Level|Setting.Level]]'' level
* [ ''string'' parent ]
* ''[[#Setting.Type|Setting.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.Base"
],
"id": "Setting.Details.SettingBase",
"properties": {
"control": {
"$ref": "Setting.Details.Control",
"name": "control"
},
"enabled": {
"type": "boolean",
"name": "enabled",
"required": true
},
"level": {
"$ref": "Setting.Level",
"name": "level",
"required": true
},
"parent": {
"default": "",
"type": "string",
"name": "parent"
},
"type": {
"$ref": "Setting.Type",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingBool ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' default
* ''boolean'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingBool",
"properties": {
"default": {
"type": "boolean",
"name": "default",
"required": true
},
"value": {
"type": "boolean",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingInt ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' default
* [ ''integer'' maximum = "0" ]
* [ ''integer'' minimum = "0" ]
* [ ''object'' options ]
* [ ''integer'' step = "0" ]
* ''integer'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingInt",
"properties": {
"default": {
"type": "integer",
"name": "default",
"required": true
},
"maximum": {
"default": "0",
"type": "integer",
"name": "maximum"
},
"minimum": {
"default": "0",
"type": "integer",
"name": "minimum"
},
"options": {
"items": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "integer"
}
},
"type": "object"
},
"type": "array",
"name": "options"
},
"step": {
"default": "0",
"type": "integer",
"name": "step"
},
"value": {
"type": "integer",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingList ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Setting.Value.List|Setting.Value.List]]'' default
* ''[[#Setting.Details.Setting|Setting.Details.Setting]]'' definition
* ''string'' delimiter
* ''[[#Setting.Type|Setting.Type]]'' elementtype
* [ ''integer'' maximumitems = "0" ]
* [ ''integer'' minimumitems = "0" ]
* ''[[#Setting.Value.List|Setting.Value.List]]'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingList",
"properties": {
"default": {
"$ref": "Setting.Value.List",
"name": "default",
"required": true
},
"definition": {
"$ref": "Setting.Details.Setting",
"name": "definition",
"required": true
},
"delimiter": {
"type": "string",
"name": "delimiter",
"required": true
},
"elementtype": {
"$ref": "Setting.Type",
"name": "elementtype",
"required": true
},
"maximumitems": {
"default": "0",
"type": "integer",
"name": "maximumitems"
},
"minimumitems": {
"default": "0",
"type": "integer",
"name": "minimumitems"
},
"value": {
"$ref": "Setting.Value.List",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingNumber ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''number'' default
* ''number'' maximum
* ''number'' minimum
* ''number'' step
* ''number'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingNumber",
"properties": {
"default": {
"type": "number",
"name": "default",
"required": true
},
"maximum": {
"type": "number",
"name": "maximum",
"required": true
},
"minimum": {
"type": "number",
"name": "minimum",
"required": true
},
"step": {
"type": "number",
"name": "step",
"required": true
},
"value": {
"type": "number",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingPath ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string''[] sources ]
* ''boolean'' writable
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingString"
],
"id": "Setting.Details.SettingPath",
"properties": {
"sources": {
"items": {
"type": "string"
},
"type": "array",
"name": "sources"
},
"writable": {
"type": "boolean",
"name": "writable",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingString ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' allowempty
* ''string'' default
* [ ''object'' options ]
* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingString",
"properties": {
"allowempty": {
"type": "boolean",
"name": "allowempty",
"required": true
},
"default": {
"type": "string",
"name": "default",
"required": true
},
"options": {
"items": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "options"
},
"value": {
"type": "string",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Level ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"basic",
"standard",
"advanced",
"expert"
],
"id": "Setting.Level",
"type": "string",
"default": "basic"
}</syntaxhighlight>}}

==== Setting.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"boolean",
"integer",
"number",
"string",
"action",
"list",
"path",
"addon"
],
"id": "Setting.Type",
"type": "string",
"default": "boolean"
}</syntaxhighlight>}}

==== Setting.Value ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Value",
"type": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
}</syntaxhighlight>}}

==== Setting.Value.Extended ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Value.Extended",
"type": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"$ref": "Setting.Value.List"
}
]
}</syntaxhighlight>}}

==== Setting.Value.List ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Value.List",
"type": "array",
"items": {
"$ref": "Setting.Value"
}
}</syntaxhighlight>}}

=== System ===
==== System.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"canshutdown",
"cansuspend",
"canhibernate",
"canreboot"
],
"id": "System.Property.Name",
"type": "string",
"default": "canshutdown"
}</syntaxhighlight>}}

==== System.Property.Value ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' canhibernate = false ]
* [ ''boolean'' canreboot = false ]
* [ ''boolean'' canshutdown = false ]
* [ ''boolean'' cansuspend = false ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "System.Property.Value",
"type": "object",
"properties": {
"canhibernate": {
"default": "false",
"type": "boolean",
"name": "canhibernate"
},
"canreboot": {
"default": "false",
"type": "boolean",
"name": "canreboot"
},
"canshutdown": {
"default": "false",
"type": "boolean",
"name": "canshutdown"
},
"cansuspend": {
"default": "false",
"type": "boolean",
"name": "cansuspend"
}
}
}</syntaxhighlight>}}

=== Textures ===
==== Textures.Details.Size ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' height = "0" ] ''Height of texture''
* [ ''string'' lastused ] ''Date of last use''
* [ ''integer'' size = "0" ] ''Size of the texture (1 == largest)''
* [ ''integer'' usecount = "0" ] ''Number of uses''
* [ ''integer'' width = "0" ] ''Width of texture''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Textures.Details.Size",
"type": "object",
"properties": {
"height": {
"default": "0",
"description": "Height of texture",
"type": "integer",
"name": "height"
},
"lastused": {
"default": "",
"description": "Date of last use",
"type": "string",
"name": "lastused"
},
"size": {
"default": "0",
"description": "Size of the texture (1 == largest)",
"type": "integer",
"name": "size"
},
"usecount": {
"default": "0",
"description": "Number of uses",
"type": "integer",
"name": "usecount"
},
"width": {
"default": "0",
"description": "Width of texture",
"type": "integer",
"name": "width"
}
}
}</syntaxhighlight>}}

==== Textures.Details.Texture ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' cachedurl ] ''Cached URL on disk''
* [ ''string'' imagehash ] ''Hash of image''
* [ ''string'' lasthashcheck ] ''Last time source was checked for changes''
* [ ''[[#Textures.Details.Size|Textures.Details.Size]]''[] sizes ]
* [ ''[[#Library.Id|Library.Id]]'' textureid = "-1" ]
* [ ''string'' url ] ''Original source URL''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Textures.Details.Texture",
"type": "object",
"properties": {
"cachedurl": {
"default": "",
"description": "Cached URL on disk",
"type": "string",
"name": "cachedurl"
},
"imagehash": {
"default": "",
"description": "Hash of image",
"type": "string",
"name": "imagehash"
},
"lasthashcheck": {
"default": "",
"description": "Last time source was checked for changes",
"type": "string",
"name": "lasthashcheck"
},
"sizes": {
"items": {
"$ref": "Textures.Details.Size"
},
"type": "array",
"name": "sizes"
},
"textureid": {
"default": "-1",
"$ref": "Library.Id",
"name": "textureid"
},
"url": {
"default": "",
"description": "Original source URL",
"type": "string",
"name": "url"
}
}
}</syntaxhighlight>}}

==== Textures.Fields.Texture ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Textures.Fields.Texture",
"items": {
"enums": [
"url",
"cachedurl",
"lasthashcheck",
"imagehash",
"sizes"
],
"type": "string"
}
}</syntaxhighlight>}}

=== Video ===
==== Video.Cast ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Cast",
"type": "array",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"required": true,
"type": "string"
},
"order": {
"required": true,
"type": "integer"
},
"role": {
"required": true,
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Video.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Media.Artwork|Media.Artwork]]'' art ]
* [ ''integer'' playcount = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Media.Details.Base"
],
"id": "Video.Details.Base",
"properties": {
"art": {
"$ref": "Media.Artwork",
"name": "art"
},
"playcount": {
"default": "0",
"type": "integer",
"name": "playcount"
}
}
}</syntaxhighlight>}}

==== Video.Details.Episode ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''integer'' episode = "0" ]
* ''[[#Library.Id|Library.Id]]'' episodeid
* [ ''string'' firstaired ]
* [ ''string'' originaltitle ]
* [ ''string'' productioncode ]
* [ ''number'' rating = "0" ]
* [ ''mixed'' ratings ]
* [ ''integer'' season = "0" ]
* [ ''[[#Library.Id|Library.Id]]'' seasonid = "-1" ]
* [ ''string'' showtitle ]
* [ ''integer'' specialsortepisode = "0" ]
* [ ''integer'' specialsortseason = "0" ]
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
* [ ''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid ]
* [ ''integer'' userrating = "0" ]
* [ ''string'' votes ]
* [ ''[[#Array.String|Array.String]]'' writer ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.File"
],
"id": "Video.Details.Episode",
"properties": {
"cast": {
"$ref": "Video.Cast",
"name": "cast"
},
"episode": {
"default": "0",
"type": "integer",
"name": "episode"
},
"episodeid": {
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
"firstaired": {
"default": "",
"type": "string",
"name": "firstaired"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"productioncode": {
"default": "",
"type": "string",
"name": "productioncode"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"ratings": {
"type": "any",
"name": "ratings"
},
"season": {
"default": "0",
"type": "integer",
"name": "season"
},
"seasonid": {
"default": "-1",
"$ref": "Library.Id",
"name": "seasonid"
},
"showtitle": {
"default": "",
"type": "string",
"name": "showtitle"
},
"specialsortepisode": {
"default": "0",
"type": "integer",
"name": "specialsortepisode"
},
"specialsortseason": {
"default": "0",
"type": "integer",
"name": "specialsortseason"
},
"tvshowid": {
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
"uniqueid": {
"$ref": "Media.UniqueID",
"name": "uniqueid"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"votes": {
"default": "",
"type": "string",
"name": "votes"
},
"writer": {
"$ref": "Array.String",
"name": "writer"
}
}
}</syntaxhighlight>}}

==== Video.Details.File ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Array.String|Array.String]]'' director ]
* [ ''[[#Video.Resume|Video.Resume]]'' resume ]
* [ ''integer'' runtime = "0" ] ''Runtime in seconds''
* [ ''[[#Video.Streams|Video.Streams]]'' streamdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Item"
],
"id": "Video.Details.File",
"properties": {
"director": {
"$ref": "Array.String",
"name": "director"
},
"resume": {
"$ref": "Video.Resume",
"name": "resume"
},
"runtime": {
"default": "0",
"description": "Runtime in seconds",
"type": "integer",
"name": "runtime"
},
"streamdetails": {
"$ref": "Video.Streams",
"name": "streamdetails"
}
}
}</syntaxhighlight>}}

==== Video.Details.Item ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' dateadded ]
* [ ''string'' file ]
* [ ''string'' lastplayed ]
* [ ''string'' plot ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Media"
],
"id": "Video.Details.Item",
"properties": {
"dateadded": {
"default": "",
"type": "string",
"name": "dateadded"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"lastplayed": {
"default": "",
"type": "string",
"name": "lastplayed"
},
"plot": {
"default": "",
"type": "string",
"name": "plot"
}
}
}</syntaxhighlight>}}

==== Video.Details.Media ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Base"
],
"id": "Video.Details.Media",
"properties": {
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== Video.Details.Movie ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''[[#Array.String|Array.String]]'' country ]
* [ ''[[#Array.String|Array.String]]'' genre ]
* [ ''string'' imdbnumber ]
* ''[[#Library.Id|Library.Id]]'' movieid
* [ ''string'' mpaa ]
* [ ''string'' originaltitle ]
* [ ''string'' plotoutline ]
* [ ''string'' premiered ]
* [ ''number'' rating = "0" ]
* [ ''mixed'' ratings ]
* [ ''string'' set ]
* [ ''[[#Library.Id|Library.Id]]'' setid = "-1" ]
* [ ''[[#Array.String|Array.String]]'' showlink ]
* [ ''string'' sorttitle ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* [ ''string'' tagline ]
* [ ''integer'' top250 = "0" ]
* [ ''string'' trailer ]
* [ ''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid ]
* [ ''integer'' userrating = "0" ]
* [ ''string'' votes ]
* [ ''[[#Array.String|Array.String]]'' writer ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.File"
],
"id": "Video.Details.Movie",
"properties": {
"cast": {
"$ref": "Video.Cast",
"name": "cast"
},
"country": {
"$ref": "Array.String",
"name": "country"
},
"genre": {
"$ref": "Array.String",
"name": "genre"
},
"imdbnumber": {
"default": "",
"type": "string",
"name": "imdbnumber"
},
"movieid": {
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
"mpaa": {
"default": "",
"type": "string",
"name": "mpaa"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"plotoutline": {
"default": "",
"type": "string",
"name": "plotoutline"
},
"premiered": {
"default": "",
"type": "string",
"name": "premiered"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"ratings": {
"type": "any",
"name": "ratings"
},
"set": {
"default": "",
"type": "string",
"name": "set"
},
"setid": {
"default": "-1",
"$ref": "Library.Id",
"name": "setid"
},
"showlink": {
"$ref": "Array.String",
"name": "showlink"
},
"sorttitle": {
"default": "",
"type": "string",
"name": "sorttitle"
},
"studio": {
"$ref": "Array.String",
"name": "studio"
},
"tag": {
"$ref": "Array.String",
"name": "tag"
},
"tagline": {
"default": "",
"type": "string",
"name": "tagline"
},
"top250": {
"default": "0",
"type": "integer",
"name": "top250"
},
"trailer": {
"default": "",
"type": "string",
"name": "trailer"
},
"uniqueid": {
"$ref": "Media.UniqueID",
"name": "uniqueid"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"votes": {
"default": "",
"type": "string",
"name": "votes"
},
"writer": {
"$ref": "Array.String",
"name": "writer"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== Video.Details.MovieSet ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' plot ]
* ''[[#Library.Id|Library.Id]]'' setid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Media"
],
"id": "Video.Details.MovieSet",
"properties": {
"plot": {
"default": "",
"type": "string",
"name": "plot"
},
"setid": {
"$ref": "Library.Id",
"name": "setid",
"required": true
}
}
}</syntaxhighlight>}}

==== Video.Details.MovieSet.Extended ====
'''Extends:'''
* ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.MovieSet"
],
"id": "Video.Details.MovieSet.Extended",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"name": "limits",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array",
"name": "movies"
}
}
}</syntaxhighlight>}}

==== Video.Details.MusicVideo ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' album ]
* [ ''[[#Array.String|Array.String]]'' artist ]
* [ ''[[#Array.String|Array.String]]'' genre ]
* ''[[#Library.Id|Library.Id]]'' musicvideoid
* [ ''string'' premiered ]
* [ ''number'' rating = "0" ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* [ ''integer'' track = "0" ]
* [ ''integer'' userrating = "0" ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.File"
],
"id": "Video.Details.MusicVideo",
"properties": {
"album": {
"default": "",
"type": "string",
"name": "album"
},
"artist": {
"$ref": "Array.String",
"name": "artist"
},
"genre": {
"$ref": "Array.String",
"name": "genre"
},
"musicvideoid": {
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
"premiered": {
"default": "",
"type": "string",
"name": "premiered"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"studio": {
"$ref": "Array.String",
"name": "studio"
},
"tag": {
"$ref": "Array.String",
"name": "tag"
},
"track": {
"default": "0",
"type": "integer",
"name": "track"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== Video.Details.Season ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' episode = "0" ]
* ''integer'' season
* ''[[#Library.Id|Library.Id]]'' seasonid
* [ ''string'' showtitle ]
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
* [ ''integer'' userrating = "0" ]
* [ ''integer'' watchedepisodes = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Base"
],
"id": "Video.Details.Season",
"properties": {
"episode": {
"default": "0",
"type": "integer",
"name": "episode"
},
"season": {
"type": "integer",
"name": "season",
"required": true
},
"seasonid": {
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
"showtitle": {
"default": "",
"type": "string",
"name": "showtitle"
},
"tvshowid": {
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"watchedepisodes": {
"default": "0",
"type": "integer",
"name": "watchedepisodes"
}
}
}</syntaxhighlight>}}

==== Video.Details.TVShow ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''integer'' episode = "0" ]
* [ ''string'' episodeguide ]
* [ ''[[#Array.String|Array.String]]'' genre ]
* [ ''string'' imdbnumber ]
* [ ''string'' mpaa ]
* [ ''string'' originaltitle ]
* [ ''string'' premiered ]
* [ ''number'' rating = "0" ]
* [ ''mixed'' ratings ]
* [ ''integer'' runtime = "0" ] ''Runtime in seconds''
* [ ''integer'' season = "0" ]
* [ ''string'' sorttitle ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* ''[[#Library.Id|Library.Id]]'' tvshowid
* [ ''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid ]
* [ ''integer'' userrating = "0" ]
* [ ''string'' votes ]
* [ ''integer'' watchedepisodes = "0" ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Item"
],
"id": "Video.Details.TVShow",
"properties": {
"cast": {
"$ref": "Video.Cast",
"name": "cast"
},
"episode": {
"default": "0",
"type": "integer",
"name": "episode"
},
"episodeguide": {
"default": "",
"type": "string",
"name": "episodeguide"
},
"genre": {
"$ref": "Array.String",
"name": "genre"
},
"imdbnumber": {
"default": "",
"type": "string",
"name": "imdbnumber"
},
"mpaa": {
"default": "",
"type": "string",
"name": "mpaa"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"premiered": {
"default": "",
"type": "string",
"name": "premiered"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"ratings": {
"type": "any",
"name": "ratings"
},
"runtime": {
"default": "0",
"description": "Runtime in seconds",
"type": "integer",
"name": "runtime"
},
"season": {
"default": "0",
"type": "integer",
"name": "season"
},
"sorttitle": {
"default": "",
"type": "string",
"name": "sorttitle"
},
"studio": {
"$ref": "Array.String",
"name": "studio"
},
"tag": {
"$ref": "Array.String",
"name": "tag"
},
"tvshowid": {
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
"uniqueid": {
"$ref": "Media.UniqueID",
"name": "uniqueid"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"votes": {
"default": "",
"type": "string",
"name": "votes"
},
"watchedepisodes": {
"default": "0",
"type": "integer",
"name": "watchedepisodes"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== Video.Fields.Episode ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
}</syntaxhighlight>}}

==== Video.Fields.Movie ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
}</syntaxhighlight>}}

==== Video.Fields.MovieSet ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Video.Fields.MovieSet",
"items": {
"enums": [
"title",
"playcount",
"fanart",
"thumbnail",
"art",
"plot"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Video.Fields.MusicVideo ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
}</syntaxhighlight>}}

==== Video.Fields.Season ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Video.Fields.Season",
"items": {
"enums": [
"season",
"showtitle",
"playcount",
"episode",
"fanart",
"thumbnail",
"tvshowid",
"watchedepisodes",
"art",
"userrating"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Video.Fields.TVShow ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
}</syntaxhighlight>}}

==== Video.Rating ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' default = false ]
* ''number'' rating
* [ ''integer'' votes = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Rating",
"type": "object",
"properties": {
"default": {
"default": "false",
"type": "boolean",
"name": "default"
},
"rating": {
"type": "number",
"name": "rating",
"required": true
},
"votes": {
"default": "0",
"type": "integer",
"name": "votes"
}
}
}</syntaxhighlight>}}

==== Video.Ratings ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Ratings",
"type": "object"
}</syntaxhighlight>}}

==== Video.Ratings.Set ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Ratings.Set",
"type": "object"
}</syntaxhighlight>}}

==== Video.Resume ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''number'' position = "0" ]
* [ ''number'' total = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Resume",
"type": "object",
"properties": {
"position": {
"default": "0",
"type": "number",
"name": "position"
},
"total": {
"default": "0",
"type": "number",
"name": "total"
}
}
}</syntaxhighlight>}}

==== Video.Streams ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''object'' audio ]
* [ ''object'' subtitle ]
* [ ''object'' video ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Streams",
"type": "object",
"properties": {
"audio": {
"items": {
"properties": {
"channels": {
"default": 0,
"type": "integer"
},
"codec": {
"default": "",
"type": "string"
},
"language": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "audio"
},
"subtitle": {
"items": {
"properties": {
"language": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "subtitle"
},
"video": {
"items": {
"properties": {
"aspect": {
"default": 0,
"type": "number"
},
"codec": {
"default": "",
"type": "string"
},
"duration": {
"default": 0,
"type": "integer"
},
"height": {
"default": 0,
"type": "integer"
},
"width": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"type": "array",
"name": "video"
}
}
}</syntaxhighlight>}}

== Notifications ==
=== Application ===
==== Application.OnVolumeChanged ====
The volume of the application has changed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''boolean'' muted
* ''integer'' volume
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The volume of the application has changed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"muted": {
"type": "boolean",
"name": "muted",
"required": true
},
"volume": {
"type": "integer",
"name": "volume",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== AudioLibrary ===
==== AudioLibrary.OnCleanFinished ====
The audio library has been cleaned.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The audio library has been cleaned.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnCleanStarted ====
An audio library clean operation has started.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "An audio library clean operation has started.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnExport ====
An audio library export has finished.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* [ ''integer'' failcount = "0" ]
* [ ''string'' file ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "An audio library export has finished.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"failcount": {
"default": "0",
"type": "integer",
"name": "failcount"
},
"file": {
"default": "",
"type": "string",
"name": "file"
}
},
"type": "object",
"name": "data"
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnRemove ====
An audio item has been removed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' id
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' transaction ] ''True if the removal is being performed within a transaction.''
* ''[[#Notifications.Library.Audio.Type|Notifications.Library.Audio.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "An audio item has been removed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"id": {
"$ref": "Library.Id",
"name": "id",
"required": true
},
"transaction": {
"description": "True if the removal is being performed within a transaction.",
"$ref": "Optional.Boolean",
"name": "transaction"
},
"type": {
"$ref": "Notifications.Library.Audio.Type",
"name": "type",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnScanFinished ====
Scanning the audio library has been finished.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Scanning the audio library has been finished.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnScanStarted ====
An audio library scan has started.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "An audio library scan has started.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnUpdate ====
An audio item has been updated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' id
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' transaction ] ''True if the update is being performed within a transaction.''
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "An audio item has been updated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"id": {
"$ref": "Library.Id",
"name": "id",
"required": true
},
"transaction": {
"description": "True if the update is being performed within a transaction.",
"$ref": "Optional.Boolean",
"name": "transaction"
},
"type": {
"type": "string",
"name": "type",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== GUI ===
==== GUI.OnDPMSActivated ====
Energy saving/DPMS has been activated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Energy saving/DPMS has been activated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== GUI.OnDPMSDeactivated ====
Energy saving/DPMS has been deactivated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Energy saving/DPMS has been deactivated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== GUI.OnScreensaverActivated ====
The screensaver has been activated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The screensaver has been activated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== GUI.OnScreensaverDeactivated ====
The screensaver has been deactivated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''boolean'' shuttingdown
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The screensaver has been deactivated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"shuttingdown": {
"type": "boolean",
"name": "shuttingdown",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== Input ===
==== Input.OnInputFinished ====
The user has provided the requested input.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The user has provided the requested input.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Input.OnInputRequested ====
The user is requested to provide some information.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* [ ''string'' title ]
* ''string'' type
* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The user is requested to provide some information.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"title": {
"type": "string",
"name": "title"
},
"type": {
"type": "string",
"name": "type",
"required": true
},
"value": {
"type": "string",
"name": "value",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== Player ===
==== Player.OnPause ====
Playback of a media item has been paused. If there is no ID available extra information will be provided.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# '''' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Playback of a media item has been paused. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== 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:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# '''' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Player.OnPropertyChanged ====
A property of the playing items has changed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
* [ ''[[#Player.Property.Value|Player.Property.Value]]'' property ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A property of the playing items has changed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"player": {
"$ref": "Player.Notifications.Player",
"name": "player",
"required": true
},
"property": {
"$ref": "Player.Property.Value",
"name": "property"
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Player.OnSeek ====
The playback position has been changed. If there is no ID available extra information will be provided.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* [ ''[[#Notifications.Item|Notifications.Item]]'' item ]
* ''[[#Player.Notifications.Player.Seek|Player.Notifications.Player.Seek]]'' player
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The playback position has been changed. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"item": {
"$ref": "Notifications.Item",
"name": "item"
},
"player": {
"$ref": "Player.Notifications.Player.Seek",
"name": "player",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== 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:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# '''' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Player.OnStop ====
Playback of a media item has been stopped. If there is no ID available extra information will be provided.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''boolean'' end ''Whether the player has reached the end of the playable item(s) or not''
* [ ''[[#Notifications.Item|Notifications.Item]]'' item ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Playback of a media item has been stopped. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"end": {
"description": "Whether the player has reached the end of the playable item(s) or not",
"type": "boolean",
"name": "end",
"required": true
},
"item": {
"$ref": "Notifications.Item",
"name": "item"
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== Playlist ===
==== Playlist.OnAdd ====
A playlist item has been added.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* [ ''[[#Notifications.Item|Notifications.Item]]'' item ]
* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
* [ ''[[#Playlist.Position|Playlist.Position]]'' position ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A playlist item has been added.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"item": {
"$ref": "Notifications.Item",
"name": "item"
},
"playlistid": {
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
"position": {
"$ref": "Playlist.Position",
"name": "position"
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Playlist.OnClear ====
A playlist item has been cleared.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A playlist item has been cleared.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Playlist.OnRemove ====
A playlist item has been removed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
* [ ''[[#Playlist.Position|Playlist.Position]]'' position ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A playlist item has been removed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
"position": {
"$ref": "Playlist.Position",
"name": "position"
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== System ===
==== System.OnLowBattery ====
The system is on low battery.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The system is on low battery.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== System.OnQuit ====
Kodi will be closed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''integer'' exitcode
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Kodi will be closed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"exitcode": {
"type": "integer",
"name": "exitcode",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== System.OnRestart ====
The system will be restarted.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The system will be restarted.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== System.OnSleep ====
The system will be suspended.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The system will be suspended.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== System.OnWake ====
The system woke up from suspension.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The system woke up from suspension.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== VideoLibrary ===
==== VideoLibrary.OnCleanFinished ====
The video library has been cleaned.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The video library has been cleaned.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnCleanStarted ====
A video library clean operation has started.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A video library clean operation has started.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnExport ====
A video library export has finished.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* [ ''integer'' failcount = "0" ]
* [ ''string'' file ]
* [ ''string'' root ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A video library export has finished.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"failcount": {
"default": "0",
"type": "integer",
"name": "failcount"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"root": {
"default": "",
"type": "string",
"name": "root"
}
},
"type": "object",
"name": "data"
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnRemove ====
A video item has been removed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' id
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' transaction ] ''True if the removal is being performed within a transaction.''
* ''[[#Notifications.Library.Video.Type|Notifications.Library.Video.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A video item has been removed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"id": {
"$ref": "Library.Id",
"name": "id",
"required": true
},
"transaction": {
"description": "True if the removal is being performed within a transaction.",
"$ref": "Optional.Boolean",
"name": "transaction"
},
"type": {
"$ref": "Notifications.Library.Video.Type",
"name": "type",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnScanFinished ====
Scanning the video library has been finished.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Scanning the video library has been finished.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnScanStarted ====
A video library scan has started.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A video library scan has started.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnUpdate ====
A video item has been updated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' id
* [ ''integer'' playcount = "-1" ]
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' transaction ] ''True if the update is being performed within a transaction.''
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A video item has been updated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"id": {
"$ref": "Library.Id",
"name": "id",
"required": true
},
"playcount": {
"default": "-1",
"type": "integer",
"name": "playcount"
},
"transaction": {
"description": "True if the update is being performed within a transaction.",
"$ref": "Optional.Boolean",
"name": "transaction"
},
"type": {
"type": "string",
"name": "type",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

== See also ==
* [[JSON-RPC API]]
* [[JSON-RPC API/v4|JSON-RPC API v4 (Eden)]]
* [[JSON-RPC API/v6|JSON-RPC API v6 (Frodo - Jarvis)]]

== External links ==
* [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]
* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]

[[Category:Development]]

JSON-RPC API/v8

2017-02-19T20:05:45Z

Ncarthy: /* Favourite.Details.Favourite */

{{mininav|[[Development]]|[[JSON-RPC API]]}}

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

It comes with support for [http://en.wikipedia.org/wiki/WebSocket 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.

{{TOC right}}
== JSON-RPC 2.0 compatibility ==
{| class="prettytable" style="margin-right: 0;"
!style="padding-left: 5px; width: 7em; text-align: left;"|Version
!style="padding-left: 10px; padding-right: 10px;"|Method calls
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(server-side)
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(client-side)
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-name
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-position
!style="padding-left: 10px; padding-right: 10px;"|Batch requests
|-
|style="padding-left: 5px;"|Version 6
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|}

== Documentation (JSON Schema) ==
=== Supported features of JSON Schema ===
<div style="float:left; margin-right:2em">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema
!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 type]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.2 properties]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.3 patternProperties]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.4 additionalProperties]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.5 items]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.6 additionalItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.7 required]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.8 dependencies]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.9 minimum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.10 maximum]
|{{yes}}
|-
|}
</div>

<div style="float:left; margin-right:2em">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema

!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03

|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.11 exclusiveMinimum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.12 exclusiveMaximum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.13 minItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.14 maxItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.15 uniqueItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.16 pattern]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.17 minLength]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.18 maxLength]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.19 enum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.20 default]
|{{yes}}
|-
|}
</div>

<div style="float:left;">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema

!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.21 title]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.22 description]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 format]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.24 divisibleBy]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.25 disallow]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.26 extends]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.27 id]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.28 $ref]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.29 $schema]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-6 Hyper Schema]
|{{no}}
|-
|}
</div>
<div style="clear:left;"></div>

== 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
{|
|
<syntaxhighlight lang="javascript" enclose="div">
{
"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" }
}
}
}
}
}
}
</syntaxhighlight>
|}

== Namespaces ==
The Kodi JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:
{|
|
<pre>
Addons List, enable and execute addons
Application Application information and control
AudioLibrary Audio Library information
Favourites Favourites GetFavourites and AddFavourite
Files Shares information & filesystem listings
GUI Window properties and activation
Input Allows limited navigation within Kodi
JSONRPC A variety of standard JSONRPC calls
Player Manages all available players
Playlist Playlist modification
Profiles Support for Profiles operations to xbmc.
PVR Live TV control
Settings Allows manipulation of Kodi settings.
System System controls and information
Textures Supplies GetTextures and RemoveTexture. Textures are images.
VideoLibrary Video Library information
XBMC Dumping ground for very Kodi specific operations
</pre>
|}

== Methods ==
=== Addons ===
==== Addons.ExecuteAddon ====
Executes the given addon with the given parameters (if possible)<br />
'''Permissions:'''
* ExecuteAddon
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid
# [ ''mixed: object|array|string'' params ]
# [ ''boolean'' wait = false ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Executes the given addon with the given parameters (if possible)",
"permission": "ExecuteAddon",
"type": "method",
"params": [
{
"type": "string",
"name": "addonid",
"required": true
},
{
"default": "",
"type": [
{
"additionalProperties": {
"default": "",
"type": "string"
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"description": "URL path (must start with / or ?",
"type": "string"
}
],
"name": "params"
},
{
"default": "false",
"type": "boolean",
"name": "wait"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Addons.GetAddonDetails ====
Gets the details of a specific addon<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid
# [ ''[[#Addon.Fields|Addon.Fields]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Addon.Details|Addon.Details]]'' addon
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Gets the details of a specific addon",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "addonid",
"required": true
},
{
"$ref": "Addon.Fields",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"addon": {
"$ref": "Addon.Details",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Addons.GetAddons ====
Gets all available addons<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Addon.Types|Addon.Types]]'' type = "unknown" ]
# [ ''[[#Addon.Content|Addon.Content]]'' content = "unknown" ] ''Content provided by the addon. Only considered for plugins and scripts.''
# [ ''mixed: boolean|string'' enabled = "all" ]
# [ ''[[#Addon.Fields|Addon.Fields]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''mixed: boolean|string'' installed = true ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Addon.Details|Addon.Details]]''[] addons ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Gets all available addons",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "unknown",
"$ref": "Addon.Types",
"name": "type"
},
{
"default": "unknown",
"description": "Content provided by the addon. Only considered for plugins and scripts.",
"$ref": "Addon.Content",
"name": "content"
},
{
"default": "all",
"type": [
{
"type": "boolean"
},
{
"enums": [
"all"
],
"type": "string"
}
],
"name": "enabled"
},
{
"$ref": "Addon.Fields",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"default": "true",
"type": [
{
"type": "boolean"
},
{
"enums": [
"all"
],
"type": "string"
}
],
"name": "installed"
}
],
"returns": {
"type": "object",
"properties": {
"addons": {
"items": {
"$ref": "Addon.Details"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Addons.SetAddonEnabled ====
Enables/Disables a specific addon<br />
'''Permissions:'''
* ManageAddon
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid
# ''[[#Global.Toggle|Global.Toggle]]'' enabled
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Enables/Disables a specific addon",
"permission": "ManageAddon",
"type": "method",
"params": [
{
"type": "string",
"name": "addonid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "enabled",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Application ===
==== Application.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Application.Property.Name|Application.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Application.Property.Value|Application.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"$ref": "Application.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "Application.Property.Value"
}
}</syntaxhighlight>}}

==== Application.Quit ====
Quit application<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Quit application",
"permission": "ControlPower",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Application.SetMute ====
Toggle mute/unmute<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Global.Toggle|Global.Toggle]]'' mute
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />

'''Description:''' ''Mute state''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Toggle mute/unmute",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Global.Toggle",
"name": "mute",
"required": true
}
],
"returns": {
"type": "boolean",
"description": "Mute state"
}
}</syntaxhighlight>}}

==== Application.SetVolume ====
Set the current volume<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed'' volume
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''integer''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Set the current volume",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"type": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"$ref": "Global.IncrementDecrement"
}
],
"name": "volume",
"required": true
}
],
"returns": {
"type": "integer"
}
}</syntaxhighlight>}}

=== AudioLibrary ===
==== AudioLibrary.Clean ====
Cleans the audio library from non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''boolean'' showdialogs = true ] ''Whether or not to show the progress bar or any other GUI dialog''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Cleans the audio library from non-existent items",
"permission": "RemoveData",
"type": "method",
"params": [
{
"default": "true",
"description": "Whether or not to show the progress bar or any other GUI dialog",
"type": "boolean",
"name": "showdialogs"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.Export ====
Exports all items from the audio library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed: object|object'' options ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Exports all items from the audio library",
"permission": "WriteFile",
"type": "method",
"params": [
{
"type": [
{
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the directory to where the data should be exported",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"images": {
"default": false,
"description": "Whether to export thumbnails and fanart images",
"type": "boolean"
},
"overwrite": {
"default": false,
"description": "Whether to overwrite existing exported files",
"type": "boolean"
}
},
"type": "object"
}
],
"name": "options"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetAlbumDetails ====
Retrieve details about a specific album<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' albumid
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]'' albumdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific album",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
{
"$ref": "Audio.Fields.Album",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"albumdetails": {
"$ref": "Audio.Details.Album"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetAlbums ====
Retrieve all albums from specified artist (and role) or that has songs of the specified genre<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
# [ ''boolean'' includesingles = false ]
# [ ''boolean'' allroles = false ] ''Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all albums from specified artist (and role) or that has songs of the specified genre",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Song genre. Filter for existance of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Song genre. Filter for existance of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Albums"
}
],
"name": "filter"
},
{
"default": "false",
"type": "boolean",
"name": "includesingles"
},
{
"default": "false",
"description": "Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.",
"type": "boolean",
"name": "allroles"
}
],
"returns": {
"type": "object",
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetArtistDetails ====
Retrieve details about a specific artist<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' artistid
# [ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Artist|Audio.Details.Artist]]'' artistdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific artist",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
{
"$ref": "Audio.Fields.Artist",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"artistdetails": {
"$ref": "Audio.Details.Artist"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetArtists ====
Retrieve all artists. For backward compatibility by default this implicity does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Optional.Boolean|Optional.Boolean]]'' albumartistsonly ] ''Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used''
# [ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
# [ ''boolean'' allroles = false ] ''Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Artist|Audio.Details.Artist]]''[] artists ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all artists. For backward compatibility by default this implicity does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true",
"permission": "ReadData",
"type": "method",
"params": [
{
"description": "Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used",
"$ref": "Optional.Boolean",
"name": "albumartistsonly"
},
{
"$ref": "Audio.Fields.Artist",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Deprecated, use songgenreid. Filter for existance of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songgenreid": {
"$ref": "Library.Id",
"description": "Song genreid. Filter for existance of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songgenreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songgenreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Deprecated, use songgenre. Filter for existance of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songgenre": {
"description": "Song genre. Filter for existance of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songgenre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songgenre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"album": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"description": "Role contributed by artist. Overriden by allroles parameter",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"description": "Role contributed by artist. Overriden by allroles parameter",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Artists"
}
],
"name": "filter"
},
{
"default": "false",
"description": "Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.",
"type": "boolean",
"name": "allroles"
}
],
"returns": {
"type": "object",
"properties": {
"artists": {
"items": {
"$ref": "Audio.Details.Artist"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetGenres ====
Retrieve all genres<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Library.Details.Genre|Library.Details.Genre]]''[] genres
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all genres",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Fields.Genre",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"genres": {
"items": {
"$ref": "Library.Details.Genre"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetProperties ====
Retrieves the values of the music library properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Audio.Property.Name|Audio.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Audio.Property.Value|Audio.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the values of the music library properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"$ref": "Audio.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "Audio.Property.Value"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRecentlyAddedAlbums ====
Retrieve recently added albums<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve recently added albums",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRecentlyAddedSongs ====
Retrieve recently added songs<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#List.Amount|List.Amount]]'' albumlimit = "-1" ] ''The amount of recently added albums from which to return the songs''
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve recently added songs",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "-1",
"description": "The amount of recently added albums from which to return the songs",
"$ref": "List.Amount",
"name": "albumlimit"
},
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRecentlyPlayedAlbums ====
Retrieve recently played albums<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve recently played albums",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRecentlyPlayedSongs ====
Retrieve recently played songs<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve recently played songs",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRoles ====
Retrieve all contributor roles<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Role|Audio.Fields.Role]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#Audio.Details.Role|Audio.Details.Role]]''[] roles
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all contributor roles",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Role",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"roles": {
"items": {
"$ref": "Audio.Details.Role"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetSongDetails ====
Retrieve details about a specific song<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' songid
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]'' songdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific song",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "songid",
"required": true
},
{
"$ref": "Audio.Fields.Song",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"songdetails": {
"$ref": "Audio.Details.Song"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetSongs ====
Retrieve all songs from specified album, artist or genre<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
# [ ''boolean'' includesingles = true ]
# [ ''boolean'' allroles = false ] ''Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all songs from specified album, artist or genre",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Song genre. Filter for existance of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Song genre. Filter for existance of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"album": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Songs"
}
],
"name": "filter"
},
{
"default": "true",
"type": "boolean",
"name": "includesingles"
},
{
"default": "false",
"description": "Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.",
"type": "boolean",
"name": "allroles"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.Scan ====
Scans the audio sources for new library items<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''string'' directory ]
# [ ''boolean'' showdialogs = true ] ''Whether or not to show the progress bar or any other GUI dialog''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Scans the audio sources for new library items",
"permission": "UpdateData",
"type": "method",
"params": [
{
"default": "",
"type": "string",
"name": "directory"
},
{
"default": "true",
"description": "Whether or not to show the progress bar or any other GUI dialog",
"type": "boolean",
"name": "showdialogs"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.SetAlbumDetails ====
Update the given album with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' albumid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''mixed'' artist ]
# [ ''[[#Optional.String|Optional.String]]'' description ]
# [ ''mixed'' genre ]
# [ ''mixed'' theme ]
# [ ''mixed'' mood ]
# [ ''mixed'' style ]
# [ ''[[#Optional.String|Optional.String]]'' type ]
# [ ''[[#Optional.String|Optional.String]]'' albumlabel ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' votes ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given album with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "artist"
},
{
"$ref": "Optional.String",
"name": "description"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "theme"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "mood"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "style"
},
{
"$ref": "Optional.String",
"name": "type"
},
{
"$ref": "Optional.String",
"name": "albumlabel"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.Integer",
"name": "year"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Optional.Integer",
"name": "votes"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.SetArtistDetails ====
Update the given artist with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' artistid
# [ ''[[#Optional.String|Optional.String]]'' artist ]
# [ ''mixed'' instrument ]
# [ ''mixed'' style ]
# [ ''mixed'' mood ]
# [ ''[[#Optional.String|Optional.String]]'' born ]
# [ ''[[#Optional.String|Optional.String]]'' formed ]
# [ ''[[#Optional.String|Optional.String]]'' description ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.String|Optional.String]]'' died ]
# [ ''[[#Optional.String|Optional.String]]'' disbanded ]
# [ ''mixed'' yearsactive ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given artist with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
{
"$ref": "Optional.String",
"name": "artist"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "instrument"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "style"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "mood"
},
{
"$ref": "Optional.String",
"name": "born"
},
{
"$ref": "Optional.String",
"name": "formed"
},
{
"$ref": "Optional.String",
"name": "description"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"$ref": "Optional.String",
"name": "died"
},
{
"$ref": "Optional.String",
"name": "disbanded"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "yearsactive"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.SetSongDetails ====
Update the given song with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' songid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''mixed'' artist ]
# [ ''mixed'' albumartist ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.String|Optional.String]]'' album ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' track ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' disc ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' duration ]
# [ ''[[#Optional.String|Optional.String]]'' comment ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainztrackid ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainzartistid ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainzalbumid ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainzalbumartistid ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' votes ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given song with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "songid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "artist"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "albumartist"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"$ref": "Optional.Integer",
"name": "year"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.String",
"name": "album"
},
{
"$ref": "Optional.Integer",
"name": "track"
},
{
"$ref": "Optional.Integer",
"name": "disc"
},
{
"$ref": "Optional.Integer",
"name": "duration"
},
{
"$ref": "Optional.String",
"name": "comment"
},
{
"$ref": "Optional.String",
"name": "musicbrainztrackid"
},
{
"$ref": "Optional.String",
"name": "musicbrainzartistid"
},
{
"$ref": "Optional.String",
"name": "musicbrainzalbumid"
},
{
"$ref": "Optional.String",
"name": "musicbrainzalbumartistid"
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Optional.Integer",
"name": "votes"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Favourites ===
==== Favourites.AddFavourite ====
Add a favourite with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' title
# ''[[#Favourite.Type|Favourite.Type]]'' type
# [ ''[[#Optional.String|Optional.String]]'' path ] ''Required for media and script favourites types''
# [ ''[[#Optional.String|Optional.String]]'' window ] ''Required for window favourite type''
# [ ''[[#Optional.String|Optional.String]]'' windowparameter ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Add a favourite with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"type": "string",
"name": "title",
"required": true
},
{
"$ref": "Favourite.Type",
"name": "type",
"required": true
},
{
"description": "Required for media and script favourites types",
"$ref": "Optional.String",
"name": "path"
},
{
"description": "Required for window favourite type",
"$ref": "Optional.String",
"name": "window"
},
{
"$ref": "Optional.String",
"name": "windowparameter"
},
{
"$ref": "Optional.String",
"name": "thumbnail"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Favourites.GetFavourites ====
Retrieve all favourites<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed'' type ]
# [ ''[[#Favourite.Fields.Favourite|Favourite.Fields.Favourite]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Favourite.Details.Favourite|Favourite.Details.Favourite]]''[] favourites ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all favourites",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": [
{
"type": "null"
},
{
"$ref": "Favourite.Type"
}
],
"name": "type"
},
{
"$ref": "Favourite.Fields.Favourite",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"favourites": {
"items": {
"$ref": "Favourite.Details.Favourite"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

=== Files ===
==== Files.GetDirectory ====
Get the directories and files in the given directory<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' directory
# [ ''[[#Files.Media|Files.Media]]'' media = "files" ]
# [ ''[[#List.Fields.Files|List.Fields.Files]]'' properties ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ] ''Limits are applied after getting the directory content thus retrieval is not faster when they are applied.''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.Item.File|List.Item.File]]''[] files
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Get the directories and files in the given directory",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "directory",
"required": true
},
{
"default": "files",
"$ref": "Files.Media",
"name": "media"
},
{
"$ref": "List.Fields.Files",
"name": "properties"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"description": "Limits are applied after getting the directory content thus retrieval is not faster when they are applied.",
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"files": {
"items": {
"$ref": "List.Item.File"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Files.GetFileDetails ====
Get details for a specific file<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file ''Full path to the file''
# [ ''[[#Files.Media|Files.Media]]'' media = "files" ]
# [ ''[[#List.Fields.Files|List.Fields.Files]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.Item.File|List.Item.File]]'' filedetails
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Get details for a specific file",
"permission": "ReadData",
"type": "method",
"params": [
{
"description": "Full path to the file",
"type": "string",
"name": "file",
"required": true
},
{
"default": "files",
"$ref": "Files.Media",
"name": "media"
},
{
"$ref": "List.Fields.Files",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"filedetails": {
"$ref": "List.Item.File",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Files.GetSources ====
Get the sources of the media windows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Files.Media|Files.Media]]'' media
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.Items.Sources|List.Items.Sources]]'' sources
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Get the sources of the media windows",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Files.Media",
"name": "media",
"required": true
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sources": {
"$ref": "List.Items.Sources",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Files.PrepareDownload ====
Provides a way to download a given file (e.g. providing an URL to the real file location)<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' path
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''mixed'' ''Transport specific details on how/from where to download the given file''details
* ''string'' ''Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol''mode
* ''string'' protocol
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Provides a way to download a given file (e.g. providing an URL to the real file location)",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "path",
"required": true
}
],
"returns": {
"type": "object",
"properties": {
"details": {
"description": "Transport specific details on how/from where to download the given file",
"type": "any",
"required": true
},
"mode": {
"description": "Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol",
"type": "string",
"required": true
},
"protocol": {
"type": "string",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Files.SetFileDetails ====
Update the given specific file with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file ''Full path to the file''
# ''[[#Files.Media|Files.Media]]'' media ''File type to update correct database. Currently only "video" is supported.''
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ] ''Setting a valid lastplayed without a playcount will force playcount to 1.''
# [ ''mixed'' resume ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given specific file with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"description": "Full path to the file",
"type": "string",
"name": "file",
"required": true
},
{
"description": "File type to update correct database. Currently only \"video\" is supported.",
"$ref": "Files.Media",
"name": "media",
"required": true
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"description": "Setting a valid lastplayed without a playcount will force playcount to 1.",
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
],
"name": "resume"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== GUI ===
==== GUI.ActivateWindow ====
Activates the given window<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#GUI.Window|GUI.Window]]'' window
# [ ''string''[] parameters ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Activates the given window",
"permission": "ControlGUI",
"type": "method",
"params": [
{
"$ref": "GUI.Window",
"name": "window",
"required": true
},
{
"items": {
"type": "string"
},
"type": "array",
"name": "parameters"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== GUI.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#GUI.Property.Name|GUI.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#GUI.Property.Value|GUI.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"$ref": "GUI.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "GUI.Property.Value"
}
}</syntaxhighlight>}}

==== GUI.GetStereoscopicModes ====
Returns the supported stereoscopic modes of the GUI<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]''[] stereoscopicmodes ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Returns the supported stereoscopic modes of the GUI",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "object",
"properties": {
"stereoscopicmodes": {
"items": {
"$ref": "GUI.Stereoscopy.Mode"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== GUI.SetFullscreen ====
Toggle fullscreen/GUI<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Global.Toggle|Global.Toggle]]'' fullscreen
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />

'''Description:''' ''Fullscreen state''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Toggle fullscreen/GUI",
"permission": "ControlGUI",
"type": "method",
"params": [
{
"$ref": "Global.Toggle",
"name": "fullscreen",
"required": true
}
],
"returns": {
"type": "boolean",
"description": "Fullscreen state"
}
}</syntaxhighlight>}}

==== GUI.SetStereoscopicMode ====
Sets the stereoscopic mode of the GUI to the given mode<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' mode
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Sets the stereoscopic mode of the GUI to the given mode",
"permission": "ControlGUI",
"type": "method",
"params": [
{
"type": "string",
"name": "mode",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== GUI.ShowNotification ====
Shows a GUI notification<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' title
# ''string'' message
# [ ''mixed: string|string'' image ]
# [ ''integer'' displaytime = "5000" ] ''The time in milliseconds the notification will be visible''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Shows a GUI notification",
"permission": "ControlGUI",
"type": "method",
"params": [
{
"type": "string",
"name": "title",
"required": true
},
{
"type": "string",
"name": "message",
"required": true
},
{
"default": "",
"type": [
{
"enums": [
"info",
"warning",
"error"
],
"type": "string"
},
{
"type": "string"
}
],
"name": "image"
},
{
"default": "5000",
"description": "The time in milliseconds the notification will be visible",
"type": "integer",
"name": "displaytime"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Input ===
==== Input.Back ====
Goes back in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Goes back in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ContextMenu ====
Shows the context menu<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Shows the context menu",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Down ====
Navigate down in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Navigate down in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ExecuteAction ====
Execute a specific action<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Input.Action|Input.Action]]'' action
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Execute a specific action",
"permission": "Navigate",
"type": "method",
"params": [
{
"$ref": "Input.Action",
"name": "action",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Home ====
Goes to home window in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Goes to home window in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Info ====
Shows the information dialog<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Shows the information dialog",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Left ====
Navigate left in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Navigate left in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Right ====
Navigate right in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Navigate right in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Select ====
Select current item in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Select current item in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.SendText ====
Send a generic (unicode) text<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' text ''Unicode text''
# [ ''boolean'' done = true ] ''Whether this is the whole input or not (closes an open input dialog if true).''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Send a generic (unicode) text",
"permission": "Navigate",
"type": "method",
"params": [
{
"description": "Unicode text",
"type": "string",
"name": "text",
"required": true
},
{
"default": "true",
"description": "Whether this is the whole input or not (closes an open input dialog if true).",
"type": "boolean",
"name": "done"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ShowCodec ====
Show codec information of the playing item<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Show codec information of the playing item",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ShowOSD ====
Show the on-screen display for the current player<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Show the on-screen display for the current player",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ShowPlayerProcessInfo ====
Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Up ====
Navigate up in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Navigate up in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== JSONRPC ===
==== JSONRPC.Introspect ====
Enumerates all actions and descriptions<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''boolean'' getdescriptions = true ]
# [ ''boolean'' getmetadata = false ]
# [ ''boolean'' filterbytransport = true ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Enumerates all actions and descriptions",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "true",
"type": "boolean",
"name": "getdescriptions"
},
{
"default": "false",
"type": "boolean",
"name": "getmetadata"
},
{
"default": "true",
"type": "boolean",
"name": "filterbytransport"
},
{
"type": "object",
"name": "filter"
}
],
"returns": {
"type": "object",
"additionalProperties": false
}
}</syntaxhighlight>}}

==== JSONRPC.NotifyAll ====
Notify all other connected clients<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' message
# [ ''mixed'' data ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''any''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Notify all other connected clients",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "string",
"name": "message",
"required": true
},
{
"type": "any",
"name": "data"
}
],
"returns": {
"type": "any"
}
}</syntaxhighlight>}}

==== JSONRPC.Permission ====
Retrieve the clients permissions<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''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
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve the clients permissions",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "object",
"properties": {
"controlgui": {
"type": "boolean",
"required": true
},
"controlnotify": {
"type": "boolean",
"required": true
},
"controlplayback": {
"type": "boolean",
"required": true
},
"controlpower": {
"type": "boolean",
"required": true
},
"controlpvr": {
"type": "boolean",
"required": true
},
"controlsystem": {
"type": "boolean",
"required": true
},
"executeaddon": {
"type": "boolean",
"required": true
},
"manageaddon": {
"type": "boolean",
"required": true
},
"navigate": {
"type": "boolean",
"required": true
},
"readdata": {
"type": "boolean",
"required": true
},
"removedata": {
"type": "boolean",
"required": true
},
"updatedata": {
"type": "boolean",
"required": true
},
"writefile": {
"type": "boolean",
"required": true
}
}
}
}</syntaxhighlight>}}

==== JSONRPC.Ping ====
Ping responder<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Ping responder",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== JSONRPC.Version ====
Retrieve the JSON-RPC protocol version.<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''mixed'' version
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve the JSON-RPC protocol version.",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "object",
"properties": {
"version": {
"type": "object",
"required": true
}
}
}
}</syntaxhighlight>}}

=== Player ===
==== Player.GetActivePlayers ====
Returns all active players<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Returns all active players",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "array"
}
}</syntaxhighlight>}}

==== Player.GetItem ====
Retrieves the currently played item<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# [ ''[[#List.Fields.All|List.Fields.All]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.Item.All|List.Item.All]]'' item
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the currently played item",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "List.Fields.All",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"item": {
"$ref": "List.Item.All",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Player.GetPlayers ====
Get a list of available players<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''string'' media = "all" ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Get a list of available players",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "all",
"type": "string",
"name": "media"
}
],
"returns": {
"type": "array"
}
}</syntaxhighlight>}}

==== Player.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''[[#Player.Property.Name|Player.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Property.Value|Player.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"items": {
"$ref": "Player.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "Player.Property.Value"
}
}</syntaxhighlight>}}

==== Player.GoTo ====
Go to previous/next/specific item in the playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' to
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Go to previous/next/specific item in the playlist",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"$ref": "Playlist.Position",
"description": "position in playlist"
}
],
"name": "to",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Move ====
If picture is zoomed move viewport left/right/up/down otherwise skip previous/next<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''string'' direction
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "If picture is zoomed move viewport left/right/up/down otherwise skip previous/next",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": "string",
"name": "direction",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== 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.<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed'' item ]
# [ ''mixed'' options ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"type": [
{
"additionalProperties": false,
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"position": {
"$ref": "Playlist.Position",
"default": 0
}
},
"type": "object"
},
{
"$ref": "Playlist.Item"
},
{
"additionalProperties": false,
"properties": {
"path": {
"required": true,
"type": "string"
},
"random": {
"default": true,
"description": "Deprecated, use the shuffled property of the options parameter instead",
"type": "boolean"
},
"recursive": {
"default": true,
"type": "boolean"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"partymode": {
"default": "",
"type": [
{
"enums": [
"music",
"video"
],
"type": "string"
},
{
"description": "Path to a smartplaylist (*.xsp) file",
"minLength": 5,
"type": "string"
}
]
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"channelid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"recordingid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
],
"name": "item"
},
{
"type": "object",
"name": "options"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.PlayPause ====
Pauses or unpause playback and returns the new state<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# [ ''[[#Global.Toggle|Global.Toggle]]'' play = "toggle" ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Pauses or unpause playback and returns the new state",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"default": "toggle",
"$ref": "Global.Toggle",
"name": "play"
}
],
"returns": {
"$ref": "Player.Speed"
}
}</syntaxhighlight>}}

==== Player.Rotate ====
Rotates current picture<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# [ ''string'' value = "clockwise" ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Rotates current picture",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"default": "clockwise",
"type": "string",
"name": "value"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Seek ====
Seek through the playing item<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' value
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Player.Position.Percentage|Player.Position.Percentage]]'' = "0"percentage ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
* [ ''[[#Global.Time|Global.Time]]'' totaltime ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Seek through the playing item",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"$ref": "Player.Position.Percentage",
"description": "Percentage value to seek to"
},
{
"$ref": "Player.Position.Time",
"description": "Time to seek to"
},
{
"description": "Seek by predefined jumps",
"enums": [
"smallforward",
"smallbackward",
"bigforward",
"bigbackward"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"percentage": {
"$ref": "Player.Position.Percentage",
"description": "Percentage value to seek to",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"time": {
"$ref": "Player.Position.Time",
"description": "Time to seek to",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"step": {
"description": "Seek by predefined jumps",
"enums": [
"smallforward",
"smallbackward",
"bigforward",
"bigbackward"
],
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"seconds": {
"description": "Seek by the given number of seconds",
"required": true,
"type": "integer"
}
},
"type": "object"
}
],
"name": "value",
"required": true
}
],
"returns": {
"type": "object",
"properties": {
"percentage": {
"default": "0",
"$ref": "Player.Position.Percentage"
},
"time": {
"$ref": "Global.Time"
},
"totaltime": {
"$ref": "Global.Time"
}
}
}
}</syntaxhighlight>}}

==== Player.SetAudioStream ====
Set the audio stream played by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed: string|integer'' stream
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Set the audio stream played by the player",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"description": "Index of the audio stream to play",
"minimum": 0,
"type": "integer"
}
],
"name": "stream",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetPartymode ====
Turn partymode on or off<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''[[#Global.Toggle|Global.Toggle]]'' partymode
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Turn partymode on or off",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "partymode",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetRepeat ====
Set the repeat mode of the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' repeat
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Set the repeat mode of the player",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"$ref": "Player.Repeat"
},
{
"enums": [
"cycle"
],
"type": "string"
}
],
"name": "repeat",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetShuffle ====
Shuffle/Unshuffle items in the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''[[#Global.Toggle|Global.Toggle]]'' shuffle
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Shuffle/Unshuffle items in the player",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "shuffle",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetSpeed ====
Set the speed of the current playback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' speed
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Set the speed of the current playback",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
-32,
-16,
-8,
-4,
-2,
-1,
0,
1,
2,
4,
8,
16,
32
],
"type": "integer"
},
{
"$ref": "Global.IncrementDecrement"
}
],
"name": "speed",
"required": true
}
],
"returns": {
"$ref": "Player.Speed"
}
}</syntaxhighlight>}}

==== Player.SetSubtitle ====
Set the subtitle displayed by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed: string|integer'' subtitle
# [ ''boolean'' enable = false ] ''Whether to enable subtitles to be displayed after setting the new subtitle''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Set the subtitle displayed by the player",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
"previous",
"next",
"off",
"on"
],
"type": "string"
},
{
"description": "Index of the subtitle to display",
"minimum": 0,
"type": "integer"
}
],
"name": "subtitle",
"required": true
},
{
"default": "false",
"description": "Whether to enable subtitles to be displayed after setting the new subtitle",
"type": "boolean",
"name": "enable"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetVideoStream ====
Set the video stream played by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed: string|integer'' stream
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Set the video stream played by the player",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"description": "Index of the video stream to play",
"minimum": 0,
"type": "integer"
}
],
"name": "stream",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Stop ====
Stops playback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Stops playback",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Zoom ====
Zoom current picture<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed: string|integer'' zoom
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Zoom current picture",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
"in",
"out"
],
"type": "string"
},
{
"description": "zoom level",
"maximum": 10,
"minimum": 1,
"type": "integer"
}
],
"name": "zoom",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Playlist ===
==== Playlist.Add ====
Add item(s) to playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''mixed'' item
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Add item(s) to playlist",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"type": [
{
"$ref": "Playlist.Item"
},
{
"items": {
"$ref": "Playlist.Item"
},
"type": "array"
}
],
"name": "item",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Playlist.Clear ====
Clear playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Clear playlist",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Playlist.GetItems ====
Get all items from playlist<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# [ ''[[#List.Fields.All|List.Fields.All]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.Item.All|List.Item.All]]''[] items
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Get all items from playlist",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "List.Fields.All",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"items": {
"items": {
"$ref": "List.Item.All"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Playlist.GetPlaylists ====
Returns all existing playlists<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Returns all existing playlists",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "array"
}
}</syntaxhighlight>}}

==== Playlist.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Property.Name|Playlist.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Playlist.Property.Value|Playlist.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"items": {
"$ref": "Playlist.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "Playlist.Property.Value"
}
}</syntaxhighlight>}}

==== Playlist.Insert ====
Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Position|Playlist.Position]]'' position
# ''mixed'' item
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position",
"required": true
},
{
"type": [
{
"$ref": "Playlist.Item"
},
{
"items": {
"$ref": "Playlist.Item"
},
"type": "array"
}
],
"name": "item",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Playlist.Remove ====
Remove item from playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Position|Playlist.Position]]'' position
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Remove item from playlist. Does not work for picture playlists (aka slideshows).",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Playlist.Swap ====
Swap items in the playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Position|Playlist.Position]]'' position1
# ''[[#Playlist.Position|Playlist.Position]]'' position2
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Swap items in the playlist. Does not work for picture playlists (aka slideshows).",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position1",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position2",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Profiles ===
==== Profiles.GetCurrentProfile ====
Retrieve the current profile<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Profiles.Fields.Profile|Profiles.Fields.Profile]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Profiles.Details.Profile|Profiles.Details.Profile]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve the current profile",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Profiles.Fields.Profile",
"name": "properties"
}
],
"returns": {
"$ref": "Profiles.Details.Profile"
}
}</syntaxhighlight>}}

==== Profiles.GetProfiles ====
Retrieve all profiles<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Profiles.Fields.Profile|Profiles.Fields.Profile]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#Profiles.Details.Profile|Profiles.Details.Profile]]''[] profiles
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all profiles",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Profiles.Fields.Profile",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"profiles": {
"items": {
"$ref": "Profiles.Details.Profile"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Profiles.LoadProfile ====
Load the specified profile<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' profile ''Profile name''
# [ ''boolean'' prompt = false ] ''Prompt for password''
# [ ''[[#Profiles.Password|Profiles.Password]]'' password ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Load the specified profile",
"permission": "Navigate",
"type": "method",
"params": [
{
"description": "Profile name",
"type": "string",
"name": "profile",
"required": true
},
{
"default": "false",
"description": "Prompt for password",
"type": "boolean",
"name": "prompt"
},
{
"$ref": "Profiles.Password",
"name": "password"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== 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<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|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''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Adds a timer to record the given show one times or a timer rule to record all showings of the given show",
"permission": "ControlPVR",
"type": "method",
"params": [
{
"description": "the broadcast id of the item to record",
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
{
"default": "false",
"description": "controls whether to create a timer rule or a onetime timer",
"type": "boolean",
"name": "timerrule"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.DeleteTimer ====
Deletes a onetime timer or a timer rule<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' timerid ''the id of the onetime timer or timer rule to delete''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Deletes a onetime timer or a timer rule",
"permission": "ControlPVR",
"type": "method",
"params": [
{
"description": "the id of the onetime timer or timer rule to delete",
"$ref": "Library.Id",
"name": "timerid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.GetBroadcastDetails ====
Retrieves the details of a specific broadcast<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid
# [ ''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the details of a specific broadcast",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
{
"$ref": "PVR.Fields.Broadcast",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"broadcastdetails": {
"$ref": "PVR.Details.Broadcast"
}
}
}
}</syntaxhighlight>}}

==== PVR.GetBroadcasts ====
Retrieves the program of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid
# [ ''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]''[] broadcasts
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the program of a specific channel",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
{
"$ref": "PVR.Fields.Broadcast",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"broadcasts": {
"items": {
"$ref": "PVR.Details.Broadcast"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== PVR.GetChannelDetails ====
Retrieves the details of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid
# [ ''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.Channel|PVR.Details.Channel]]'' channeldetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the details of a specific channel",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
{
"$ref": "PVR.Fields.Channel",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"channeldetails": {
"$ref": "PVR.Details.Channel"
}
}
}
}</syntaxhighlight>}}

==== PVR.GetChannelGroupDetails ====
Retrieves the details of a specific channel group<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.ChannelGroup.Id|PVR.ChannelGroup.Id]]'' channelgroupid
# [ ''mixed'' channels ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.ChannelGroup.Extended|PVR.Details.ChannelGroup.Extended]]'' channelgroupdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the details of a specific channel group",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "PVR.ChannelGroup.Id",
"name": "channelgroupid",
"required": true
},
{
"type": "object",
"name": "channels"
}
],
"returns": {
"type": "object",
"properties": {
"channelgroupdetails": {
"$ref": "PVR.Details.ChannelGroup.Extended"
}
}
}
}</syntaxhighlight>}}

==== PVR.GetChannelGroups ====
Retrieves the channel groups for the specified type<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]''[] channelgroups
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the channel groups for the specified type",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "PVR.Channel.Type",
"name": "channeltype",
"required": true
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"channelgroups": {
"items": {
"$ref": "PVR.Details.ChannelGroup"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== PVR.GetChannels ====
Retrieves the channel list<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.ChannelGroup.Id|PVR.ChannelGroup.Id]]'' channelgroupid
# [ ''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#PVR.Details.Channel|PVR.Details.Channel]]''[] channels
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the channel list",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "PVR.ChannelGroup.Id",
"name": "channelgroupid",
"required": true
},
{
"$ref": "PVR.Fields.Channel",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== PVR.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.Property.Name|PVR.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#PVR.Property.Value|PVR.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"$ref": "PVR.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "PVR.Property.Value"
}
}</syntaxhighlight>}}

==== PVR.GetRecordingDetails ====
Retrieves the details of a specific recording<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' recordingid
# [ ''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.Recording|PVR.Details.Recording]]'' recordingdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the details of a specific recording",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "recordingid",
"required": true
},
{
"$ref": "PVR.Fields.Recording",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"recordingdetails": {
"$ref": "PVR.Details.Recording"
}
}
}
}</syntaxhighlight>}}

==== PVR.GetRecordings ====
Retrieves the recordings<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#PVR.Details.Recording|PVR.Details.Recording]]''[] recordings
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the recordings",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "PVR.Fields.Recording",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"recordings": {
"items": {
"$ref": "PVR.Details.Recording"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== PVR.GetTimerDetails ====
Retrieves the details of a specific timer<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' timerid
# [ ''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.Timer|PVR.Details.Timer]]'' timerdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the details of a specific timer",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "timerid",
"required": true
},
{
"$ref": "PVR.Fields.Timer",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"timerdetails": {
"$ref": "PVR.Details.Timer"
}
}
}
}</syntaxhighlight>}}

==== PVR.GetTimers ====
Retrieves the timers<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#PVR.Details.Timer|PVR.Details.Timer]]''[] timers
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the timers",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "PVR.Fields.Timer",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"timers": {
"items": {
"$ref": "PVR.Details.Timer"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== PVR.Record ====
Toggle recording of a channel<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Global.Toggle|Global.Toggle]]'' record = "toggle" ]
# [ ''mixed'' channel = "current" ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Toggle recording of a channel",
"permission": "ControlPVR",
"type": "method",
"params": [
{
"default": "toggle",
"$ref": "Global.Toggle",
"name": "record"
},
{
"default": "current",
"type": [
{
"enums": [
"current"
],
"type": "string"
},
{
"$ref": "Library.Id"
}
],
"name": "channel"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Scan ====
Starts a channel scan<br />
'''Permissions:'''
* ControlPVR
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Starts a channel scan",
"permission": "ControlPVR",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== 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<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|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''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created",
"permission": "ControlPVR",
"type": "method",
"params": [
{
"description": "the broadcast id of the item to toggle a onetime timer or time rule for",
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
{
"default": "false",
"description": "controls whether to create / delete a timer rule or a onetime timer",
"type": "boolean",
"name": "timerrule"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Settings ===
==== Settings.GetCategories ====
Retrieves all setting categories<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Setting.Level|Setting.Level]]'' level = "standard" ]
# [ ''string'' section ]
# [ ''mixed'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Setting.Details.Category|Setting.Details.Category]]''[] categories ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves all setting categories",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "standard",
"$ref": "Setting.Level",
"name": "level"
},
{
"default": "",
"type": "string",
"name": "section"
},
{
"items": {
"type": "string"
},
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"categories": {
"items": {
"$ref": "Setting.Details.Category"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== Settings.GetSections ====
Retrieves all setting sections<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Setting.Level|Setting.Level]]'' level = "standard" ]
# [ ''mixed'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Setting.Details.Section|Setting.Details.Section]]''[] sections ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves all setting sections",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "standard",
"$ref": "Setting.Level",
"name": "level"
},
{
"items": {
"type": "string"
},
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"sections": {
"items": {
"$ref": "Setting.Details.Section"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== Settings.GetSettings ====
Retrieves all settings<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Setting.Level|Setting.Level]]'' level = "standard" ]
# [ ''mixed: object'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Setting.Details.Setting|Setting.Details.Setting]]''[] settings ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves all settings",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "standard",
"$ref": "Setting.Level",
"name": "level"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"category": {
"minLength": 1,
"required": true,
"type": "string"
},
"section": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
}
],
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"settings": {
"items": {
"$ref": "Setting.Details.Setting"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== Settings.GetSettingValue ====
Retrieves the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the value of a setting",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "setting",
"required": true
}
],
"returns": {
"type": "object",
"properties": {
"value": {
"$ref": "Setting.Value.Extended",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Settings.ResetSettingValue ====
Resets the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Resets the value of a setting",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "setting",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Settings.SetSettingValue ====
Changes the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting
# ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Changes the value of a setting",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "setting",
"required": true
},
{
"$ref": "Setting.Value.Extended",
"name": "value",
"required": true
}
],
"returns": {
"type": "boolean"
}
}</syntaxhighlight>}}

=== System ===
==== System.EjectOpticalDrive ====
Ejects or closes the optical disc drive (if available)<br />
'''Permissions:'''
* ControlSystem
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Ejects or closes the optical disc drive (if available)",
"permission": "ControlSystem",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== System.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#System.Property.Name|System.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#System.Property.Value|System.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"$ref": "System.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "System.Property.Value"
}
}</syntaxhighlight>}}

==== System.Hibernate ====
Puts the system running Kodi into hibernate mode<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Puts the system running Kodi into hibernate mode",
"permission": "ControlPower",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== System.Reboot ====
Reboots the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Reboots the system running Kodi",
"permission": "ControlPower",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== System.Shutdown ====
Shuts the system running Kodi down<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Shuts the system running Kodi down",
"permission": "ControlPower",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== System.Suspend ====
Suspends the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Suspends the system running Kodi",
"permission": "ControlPower",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Textures ===
==== Textures.GetTextures ====
Retrieve all textures<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Textures.Fields.Texture|Textures.Fields.Texture]]'' properties ]
# [ ''[[#List.Filter.Textures|List.Filter.Textures]]'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Textures.Details.Texture|Textures.Details.Texture]]''[] textures
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all textures",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Textures.Fields.Texture",
"name": "properties"
},
{
"$ref": "List.Filter.Textures",
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"textures": {
"items": {
"$ref": "Textures.Details.Texture"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Textures.RemoveTexture ====
Remove the specified texture<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' textureid ''Texture database identifier''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Remove the specified texture",
"permission": "RemoveData",
"type": "method",
"params": [
{
"description": "Texture database identifier",
"$ref": "Library.Id",
"name": "textureid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== VideoLibrary ===
==== VideoLibrary.Clean ====
Cleans the video library from non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''boolean'' showdialogs = true ] ''Whether or not to show the progress bar or any other GUI dialog''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Cleans the video library from non-existent items",
"permission": "RemoveData",
"type": "method",
"params": [
{
"default": "true",
"description": "Whether or not to show the progress bar or any other GUI dialog",
"type": "boolean",
"name": "showdialogs"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.Export ====
Exports all items from the video library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed: object|object'' options ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Exports all items from the video library",
"permission": "WriteFile",
"type": "method",
"params": [
{
"type": [
{
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the directory to where the data should be exported",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actorthumbs": {
"default": false,
"description": "Whether to export actor thumbnails",
"type": "boolean"
},
"images": {
"default": false,
"description": "Whether to export thumbnails and fanart images",
"type": "boolean"
},
"overwrite": {
"default": false,
"description": "Whether to overwrite existing exported files",
"type": "boolean"
}
},
"type": "object"
}
],
"name": "options"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetEpisodeDetails ====
Retrieve details about a specific tv show episode<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]'' episodedetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific tv show episode",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"$ref": "Video.Fields.Episode",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"episodedetails": {
"$ref": "Video.Details.Episode"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetEpisodes ====
Retrieve all tv show episodes<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
# [ ''integer'' season = "-1" ]
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]''[] episodes ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all tv show episodes",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
{
"default": "-1",
"type": "integer",
"name": "season"
},
{
"$ref": "Video.Fields.Episode",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Requires tvshowid to be set",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Requires tvshowid to be set",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"description": "Requires tvshowid to be set",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Episodes"
}
],
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"episodes": {
"items": {
"$ref": "Video.Details.Episode"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetGenres ====
Retrieve all genres<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' type
# [ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Library.Details.Genre|Library.Details.Genre]]''[] genres
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all genres",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "type",
"required": true
},
{
"$ref": "Library.Fields.Genre",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"genres": {
"items": {
"$ref": "Library.Details.Genre"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetInProgressTVShows ====
Retrieve all in progress tvshows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.TVShow|Video.Details.TVShow]]''[] tvshows ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all in progress tvshows",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tvshows": {
"items": {
"$ref": "Video.Details.TVShow"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMovieDetails ====
Retrieve details about a specific movie<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]'' moviedetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific movie",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"$ref": "Video.Fields.Movie",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"moviedetails": {
"$ref": "Video.Details.Movie"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMovies ====
Retrieve all movies<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all movies",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.Movie",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"country": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"set": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Movies"
}
],
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMovieSetDetails ====
Retrieve details about a specific movie set<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' setid
# [ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties ]
# [ ''mixed'' movies ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.MovieSet.Extended|Video.Details.MovieSet.Extended]]'' setdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific movie set",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "setid",
"required": true
},
{
"$ref": "Video.Fields.MovieSet",
"name": "properties"
},
{
"type": "object",
"name": "movies"
}
],
"returns": {
"type": "object",
"properties": {
"setdetails": {
"$ref": "Video.Details.MovieSet.Extended"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMovieSets ====
Retrieve all movie sets<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''[] sets ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all movie sets",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.MovieSet",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sets": {
"items": {
"$ref": "Video.Details.MovieSet"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMusicVideoDetails ====
Retrieve details about a specific music video<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]'' musicvideodetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific music video",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"musicvideodetails": {
"$ref": "Video.Details.MusicVideo"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMusicVideos ====
Retrieve all music videos<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]''[] musicvideos ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all music videos",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.MusicVideos"
}
],
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"musicvideos": {
"items": {
"$ref": "Video.Details.MusicVideo"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetRecentlyAddedEpisodes ====
Retrieve all recently added tv episodes<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]''[] episodes ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all recently added tv episodes",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.Episode",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"episodes": {
"items": {
"$ref": "Video.Details.Episode"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetRecentlyAddedMovies ====
Retrieve all recently added movies<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all recently added movies",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.Movie",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetRecentlyAddedMusicVideos ====
Retrieve all recently added music videos<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]''[] musicvideos ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all recently added music videos",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"musicvideos": {
"items": {
"$ref": "Video.Details.MusicVideo"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetSeasonDetails ====
Retrieve details about a specific tv show season<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' seasonid
# [ ''[[#Video.Fields.Season|Video.Fields.Season]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Season|Video.Details.Season]]'' seasondetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific tv show season",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
{
"$ref": "Video.Fields.Season",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"seasondetails": {
"$ref": "Video.Details.Season"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetSeasons ====
Retrieve all tv seasons<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
# [ ''[[#Video.Fields.Season|Video.Fields.Season]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Season|Video.Details.Season]]''[] seasons ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all tv seasons",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
{
"$ref": "Video.Fields.Season",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"seasons": {
"items": {
"$ref": "Video.Details.Season"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetTags ====
Retrieve all tags<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' type
# [ ''[[#Library.Fields.Tag|Library.Fields.Tag]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#Library.Details.Tag|Library.Details.Tag]]''[] tags
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all tags",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "type",
"required": true
},
{
"$ref": "Library.Fields.Tag",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tags": {
"items": {
"$ref": "Library.Details.Tag"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetTVShowDetails ====
Retrieve details about a specific tv show<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
# [ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.TVShow|Video.Details.TVShow]]'' tvshowdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve details about a specific tv show",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"tvshowdetails": {
"$ref": "Video.Details.TVShow"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetTVShows ====
Retrieve all tv shows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.TVShow|Video.Details.TVShow]]''[] tvshows ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve all tv shows",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.TVShows"
}
],
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tvshows": {
"items": {
"$ref": "Video.Details.TVShow"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.RefreshEpisode ====
Refresh the given episode in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|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).''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Refresh the given episode in the library",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"default": "false",
"description": "Whether or not to ignore a local NFO if present.",
"type": "boolean",
"name": "ignorenfo"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"type": "string",
"name": "title"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RefreshMovie ====
Refresh the given movie in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|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).''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Refresh the given movie in the library",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"default": "false",
"description": "Whether or not to ignore a local NFO if present.",
"type": "boolean",
"name": "ignorenfo"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"type": "string",
"name": "title"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RefreshMusicVideo ====
Refresh the given music video in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|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).''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Refresh the given music video in the library",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"default": "false",
"description": "Whether or not to ignore a local NFO if present.",
"type": "boolean",
"name": "ignorenfo"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"type": "string",
"name": "title"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RefreshTVShow ====
Refresh the given tv show in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|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).''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Refresh the given tv show in the library",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"default": "false",
"description": "Whether or not to ignore a local NFO if present.",
"type": "boolean",
"name": "ignorenfo"
},
{
"default": "false",
"description": "Whether or not to refresh all episodes belonging to the TV show.",
"type": "boolean",
"name": "refreshepisodes"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"type": "string",
"name": "title"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RemoveEpisode ====
Removes the given episode from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Removes the given episode from the library",
"permission": "RemoveData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RemoveMovie ====
Removes the given movie from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Removes the given movie from the library",
"permission": "RemoveData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RemoveMusicVideo ====
Removes the given music video from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Removes the given music video from the library",
"permission": "RemoveData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RemoveTVShow ====
Removes the given tv show from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Removes the given tv show from the library",
"permission": "RemoveData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.Scan ====
Scans the video sources for new library items<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''string'' directory ]
# [ ''boolean'' showdialogs = true ] ''Whether or not to show the progress bar or any other GUI dialog''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Scans the video sources for new library items",
"permission": "UpdateData",
"type": "method",
"params": [
{
"default": "",
"type": "string",
"name": "directory"
},
{
"default": "true",
"description": "Whether or not to show the progress bar or any other GUI dialog",
"type": "boolean",
"name": "showdialogs"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetEpisodeDetails ====
Update the given episode with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime ] ''Runtime in seconds''
# [ ''mixed'' director ]
# [ ''[[#Optional.String|Optional.String]]'' plot ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.String|Optional.String]]'' votes ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''mixed'' writer ]
# [ ''[[#Optional.String|Optional.String]]'' firstaired ]
# [ ''[[#Optional.String|Optional.String]]'' productioncode ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' season ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' episode ]
# [ ''[[#Optional.String|Optional.String]]'' originaltitle ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
# [ ''[[#Optional.String|Optional.String]]'' fanart ]
# [ ''mixed'' art ]
# [ ''mixed'' resume ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings ]
# [ ''[[#Optional.String|Optional.String]]'' dateadded ]
# [ ''mixed'' uniqueid ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given episode with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"description": "Runtime in seconds",
"$ref": "Optional.Integer",
"name": "runtime"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "director"
},
{
"$ref": "Optional.String",
"name": "plot"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.String",
"name": "votes"
},
{
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "writer"
},
{
"$ref": "Optional.String",
"name": "firstaired"
},
{
"$ref": "Optional.String",
"name": "productioncode"
},
{
"$ref": "Optional.Integer",
"name": "season"
},
{
"$ref": "Optional.Integer",
"name": "episode"
},
{
"$ref": "Optional.String",
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"name": "fanart"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
],
"name": "resume"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"name": "dateadded"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
],
"name": "uniqueid"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetMovieDetails ====
Update the given movie with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime ] ''Runtime in seconds''
# [ ''mixed'' director ]
# [ ''mixed'' studio ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year ] ''linked with premiered. Overridden by premiered parameter''
# [ ''[[#Optional.String|Optional.String]]'' plot ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.String|Optional.String]]'' mpaa ]
# [ ''[[#Optional.String|Optional.String]]'' imdbnumber ]
# [ ''[[#Optional.String|Optional.String]]'' votes ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''[[#Optional.String|Optional.String]]'' originaltitle ]
# [ ''[[#Optional.String|Optional.String]]'' trailer ]
# [ ''[[#Optional.String|Optional.String]]'' tagline ]
# [ ''[[#Optional.String|Optional.String]]'' plotoutline ]
# [ ''mixed'' writer ]
# [ ''mixed'' country ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' top250 ]
# [ ''[[#Optional.String|Optional.String]]'' sorttitle ]
# [ ''[[#Optional.String|Optional.String]]'' set ]
# [ ''mixed'' showlink ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
# [ ''[[#Optional.String|Optional.String]]'' fanart ]
# [ ''mixed'' tag ]
# [ ''mixed'' art ]
# [ ''mixed'' resume ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings ]
# [ ''[[#Optional.String|Optional.String]]'' dateadded ]
# [ ''[[#Optional.String|Optional.String]]'' premiered ] ''linked with year. Overriedes year''
# [ ''mixed'' uniqueid ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given movie with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"description": "Runtime in seconds",
"$ref": "Optional.Integer",
"name": "runtime"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "director"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "studio"
},
{
"description": "linked with premiered. Overridden by premiered parameter",
"$ref": "Optional.Integer",
"name": "year"
},
{
"$ref": "Optional.String",
"name": "plot"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.String",
"name": "mpaa"
},
{
"$ref": "Optional.String",
"name": "imdbnumber"
},
{
"$ref": "Optional.String",
"name": "votes"
},
{
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"name": "trailer"
},
{
"$ref": "Optional.String",
"name": "tagline"
},
{
"$ref": "Optional.String",
"name": "plotoutline"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "writer"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "country"
},
{
"$ref": "Optional.Integer",
"name": "top250"
},
{
"$ref": "Optional.String",
"name": "sorttitle"
},
{
"$ref": "Optional.String",
"name": "set"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "showlink"
},
{
"$ref": "Optional.String",
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"name": "fanart"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "tag"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
],
"name": "resume"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"name": "dateadded"
},
{
"description": "linked with year. Overriedes year",
"$ref": "Optional.String",
"name": "premiered"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
],
"name": "uniqueid"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetMovieSetDetails ====
Update the given movie set with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' setid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''mixed'' art ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given movie set with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "setid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetMusicVideoDetails ====
Update the given music video with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime ] ''Runtime in seconds''
# [ ''mixed'' director ]
# [ ''mixed'' studio ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year ] ''linked with premiered. Overridden by premiered parameter''
# [ ''[[#Optional.String|Optional.String]]'' plot ]
# [ ''[[#Optional.String|Optional.String]]'' album ]
# [ ''mixed'' artist ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' track ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
# [ ''[[#Optional.String|Optional.String]]'' fanart ]
# [ ''mixed'' tag ]
# [ ''mixed'' art ]
# [ ''mixed'' resume ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Optional.String|Optional.String]]'' dateadded ]
# [ ''[[#Optional.String|Optional.String]]'' premiered ] ''linked with year. Overriedes year''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given music video with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"description": "Runtime in seconds",
"$ref": "Optional.Integer",
"name": "runtime"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "director"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "studio"
},
{
"description": "linked with premiered. Overridden by premiered parameter",
"$ref": "Optional.Integer",
"name": "year"
},
{
"$ref": "Optional.String",
"name": "plot"
},
{
"$ref": "Optional.String",
"name": "album"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "artist"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"$ref": "Optional.Integer",
"name": "track"
},
{
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"name": "fanart"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "tag"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
],
"name": "resume"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Optional.String",
"name": "dateadded"
},
{
"description": "linked with year. Overriedes year",
"$ref": "Optional.String",
"name": "premiered"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetSeasonDetails ====
Update the given season with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' seasonid
# [ ''mixed'' art ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given season with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetTVShowDetails ====
Update the given tvshow with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''mixed'' studio ]
# [ ''[[#Optional.String|Optional.String]]'' plot ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.String|Optional.String]]'' mpaa ]
# [ ''[[#Optional.String|Optional.String]]'' imdbnumber ]
# [ ''[[#Optional.String|Optional.String]]'' premiered ]
# [ ''[[#Optional.String|Optional.String]]'' votes ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''[[#Optional.String|Optional.String]]'' originaltitle ]
# [ ''[[#Optional.String|Optional.String]]'' sorttitle ]
# [ ''[[#Optional.String|Optional.String]]'' episodeguide ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
# [ ''[[#Optional.String|Optional.String]]'' fanart ]
# [ ''mixed'' tag ]
# [ ''mixed'' art ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings ]
# [ ''[[#Optional.String|Optional.String]]'' dateadded ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime ] ''Runtime in seconds''
# [ ''[[#Optional.String|Optional.String]]'' status ]
# [ ''mixed'' uniqueid ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Update the given tvshow with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "studio"
},
{
"$ref": "Optional.String",
"name": "plot"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.String",
"name": "mpaa"
},
{
"$ref": "Optional.String",
"name": "imdbnumber"
},
{
"$ref": "Optional.String",
"name": "premiered"
},
{
"$ref": "Optional.String",
"name": "votes"
},
{
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"name": "sorttitle"
},
{
"$ref": "Optional.String",
"name": "episodeguide"
},
{
"$ref": "Optional.String",
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"name": "fanart"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "tag"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"name": "dateadded"
},
{
"description": "Runtime in seconds",
"$ref": "Optional.Integer",
"name": "runtime"
},
{
"$ref": "Optional.String",
"name": "status"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
],
"name": "uniqueid"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== XBMC ===
==== XBMC.GetInfoBooleans ====
Retrieve info booleans about Kodi and the system<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string''[] booleans
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />

'''Description:''' ''Object containing key-value pairs of the retrieved info booleans''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve info booleans about Kodi and the system",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"type": "string"
},
"type": "array",
"name": "booleans",
"required": true
}
],
"returns": {
"type": "object",
"description": "Object containing key-value pairs of the retrieved info booleans",
"additionalProperties": {
"default": "",
"type": "string"
}
}
}</syntaxhighlight>}}

==== XBMC.GetInfoLabels ====
Retrieve info labels about Kodi and the system<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string''[] labels ''See http://kodi.wiki/view/InfoLabels for a list of possible info labels''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />

'''Description:''' ''Object containing key-value pairs of the retrieved info labels''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Retrieve info labels about Kodi and the system",
"permission": "ReadData",
"type": "method",
"params": [
{
"description": "See http://kodi.wiki/view/InfoLabels for a list of possible info labels",
"items": {
"type": "string"
},
"type": "array",
"name": "labels",
"required": true
}
],
"returns": {
"type": "object",
"description": "Object containing key-value pairs of the retrieved info labels",
"additionalProperties": {
"default": "",
"type": "string"
}
}
}</syntaxhighlight>}}

== Global Types ==
=== Addon ===
==== Addon.Content ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"unknown",
"video",
"audio",
"image",
"executable"
],
"id": "Addon.Content",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

==== Addon.Details ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' addonid
* [ ''string'' author ]
* [ ''mixed: boolean|string'' broken ]
* [ ''object'' dependencies ]
* [ ''string'' description ]
* [ ''string'' disclaimer ]
* [ ''boolean'' enabled = false ]
* [ ''object'' extrainfo ]
* [ ''string'' fanart ]
* [ ''boolean'' installed = false ]
* [ ''string'' name ]
* [ ''string'' path ]
* [ ''integer'' rating = "0" ]
* [ ''string'' summary ]
* [ ''string'' thumbnail ]
* ''[[#Addon.Types|Addon.Types]]'' type
* [ ''string'' version ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Addon.Details",
"properties": {
"addonid": {
"type": "string",
"name": "addonid",
"required": true
},
"author": {
"default": "",
"type": "string",
"name": "author"
},
"broken": {
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
],
"name": "broken"
},
"dependencies": {
"items": {
"properties": {
"addonid": {
"required": true,
"type": "string"
},
"optional": {
"required": true,
"type": "boolean"
},
"version": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "dependencies"
},
"description": {
"default": "",
"type": "string",
"name": "description"
},
"disclaimer": {
"default": "",
"type": "string",
"name": "disclaimer"
},
"enabled": {
"default": "false",
"type": "boolean",
"name": "enabled"
},
"extrainfo": {
"items": {
"properties": {
"key": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "extrainfo"
},
"fanart": {
"default": "",
"type": "string",
"name": "fanart"
},
"installed": {
"default": "false",
"type": "boolean",
"name": "installed"
},
"name": {
"default": "",
"type": "string",
"name": "name"
},
"path": {
"default": "",
"type": "string",
"name": "path"
},
"rating": {
"default": "0",
"type": "integer",
"name": "rating"
},
"summary": {
"default": "",
"type": "string",
"name": "summary"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"type": {
"$ref": "Addon.Types",
"name": "type",
"required": true
},
"version": {
"default": "",
"type": "string",
"name": "version"
}
}
}</syntaxhighlight>}}

==== Addon.Fields ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Addon.Fields",
"items": {
"enums": [
"name",
"version",
"summary",
"description",
"path",
"author",
"thumbnail",
"disclaimer",
"fanart",
"dependencies",
"broken",
"extrainfo",
"rating",
"enabled",
"installed"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Addon.Types ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"unknown",
"xbmc.player.musicviz",
"xbmc.gui.skin",
"xbmc.pvrclient",
"kodi.adsp",
"kodi.inputstream",
"kodi.peripheral",
"xbmc.python.script",
"xbmc.python.weather",
"xbmc.subtitle.module",
"xbmc.python.lyrics",
"xbmc.metadata.scraper.albums",
"xbmc.metadata.scraper.artists",
"xbmc.metadata.scraper.movies",
"xbmc.metadata.scraper.musicvideos",
"xbmc.metadata.scraper.tvshows",
"xbmc.ui.screensaver",
"xbmc.python.pluginsource",
"xbmc.addon.repository",
"xbmc.webinterface",
"xbmc.service",
"xbmc.audioencoder",
"kodi.context.item",
"kodi.audiodecoder",
"kodi.resource.images",
"kodi.resource.language",
"kodi.resource.uisounds",
"xbmc.addon.video",
"xbmc.addon.audio",
"xbmc.addon.image",
"xbmc.addon.executable",
"xbmc.metadata.scraper.library",
"xbmc.python.library",
"xbmc.python.module",
"kodi.game.controller"
],
"id": "Addon.Types",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

=== Application ===
==== Application.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"volume",
"muted",
"name",
"version"
],
"id": "Application.Property.Name",
"type": "string",
"default": "volume"
}</syntaxhighlight>}}

==== Application.Property.Value ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' muted = false ]
* [ ''string'' name ]
* [ ''mixed'' version ]
* [ ''integer'' volume = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Application.Property.Value",
"type": "object",
"properties": {
"muted": {
"default": "false",
"type": "boolean",
"name": "muted"
},
"name": {
"default": "",
"type": "string",
"name": "name"
},
"version": {
"type": "object",
"name": "version"
},
"volume": {
"default": "0",
"type": "integer",
"name": "volume"
}
}
}</syntaxhighlight>}}

=== Array ===
==== Array.Integer ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Array.Integer",
"type": "array",
"items": {
"type": "integer"
}
}</syntaxhighlight>}}

==== Array.String ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Array.String",
"type": "array",
"items": {
"minLength": 1,
"type": "string"
}
}</syntaxhighlight>}}

=== Audio ===
==== Audio.Album.ReleaseType ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"album",
"single"
],
"id": "Audio.Album.ReleaseType",
"type": "string",
"default": "album"
}</syntaxhighlight>}}

==== Audio.Artist.Roles ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Audio.Artist.Roles",
"type": "array",
"items": {
"additionalProperties": false,
"description": "The various roles contributed by an artist to one or more songs",
"properties": {
"role": {
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Audio.Contributors ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Audio.Contributors",
"type": "array",
"items": {
"additionalProperties": false,
"description": "The artist and the role they contribute to a song",
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"name": {
"required": true,
"type": "string"
},
"role": {
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Audio.Details.Album ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' albumid
* [ ''string'' albumlabel ]
* [ ''boolean'' compilation = false ]
* [ ''string'' description ]
* [ ''[[#Array.String|Array.String]]'' mood ]
* [ ''integer'' playcount = "0" ]
* [ ''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = "album" ]
* [ ''[[#Array.String|Array.String]]'' style ]
* [ ''[[#Array.String|Array.String]]'' theme ]
* [ ''string'' type ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Audio.Details.Media"
],
"id": "Audio.Details.Album",
"properties": {
"albumid": {
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
"albumlabel": {
"default": "",
"type": "string",
"name": "albumlabel"
},
"compilation": {
"default": "false",
"type": "boolean",
"name": "compilation"
},
"description": {
"default": "",
"type": "string",
"name": "description"
},
"mood": {
"$ref": "Array.String",
"name": "mood"
},
"playcount": {
"default": "0",
"type": "integer",
"name": "playcount"
},
"releasetype": {
"default": "album",
"$ref": "Audio.Album.ReleaseType",
"name": "releasetype"
},
"style": {
"$ref": "Array.String",
"name": "style"
},
"theme": {
"$ref": "Array.String",
"name": "theme"
},
"type": {
"default": "",
"type": "string",
"name": "type"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Artist ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' artist
* ''[[#Library.Id|Library.Id]]'' artistid
* [ ''string'' born ]
* [ ''boolean'' compilationartist = false ]
* [ ''string'' description ]
* [ ''string'' died ]
* [ ''string'' disbanded ]
* [ ''string'' formed ]
* [ ''[[#Array.String|Array.String]]'' instrument ]
* [ ''boolean'' isalbumartist = false ]
* [ ''[[#Array.String|Array.String]]'' mood ]
* [ ''string'' musicbrainzartistid ]
* [ ''[[#Audio.Artist.Roles|Audio.Artist.Roles]]'' roles ]
* [ ''[[#Audio.Details.Genres|Audio.Details.Genres]]'' songgenres ]
* [ ''[[#Array.String|Array.String]]'' style ]
* [ ''[[#Array.String|Array.String]]'' yearsactive ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Audio.Details.Base"
],
"id": "Audio.Details.Artist",
"properties": {
"artist": {
"type": "string",
"name": "artist",
"required": true
},
"artistid": {
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
"born": {
"default": "",
"type": "string",
"name": "born"
},
"compilationartist": {
"default": "false",
"type": "boolean",
"name": "compilationartist"
},
"description": {
"default": "",
"type": "string",
"name": "description"
},
"died": {
"default": "",
"type": "string",
"name": "died"
},
"disbanded": {
"default": "",
"type": "string",
"name": "disbanded"
},
"formed": {
"default": "",
"type": "string",
"name": "formed"
},
"instrument": {
"$ref": "Array.String",
"name": "instrument"
},
"isalbumartist": {
"default": "false",
"type": "boolean",
"name": "isalbumartist"
},
"mood": {
"$ref": "Array.String",
"name": "mood"
},
"musicbrainzartistid": {
"default": "",
"type": "string",
"name": "musicbrainzartistid"
},
"roles": {
"$ref": "Audio.Artist.Roles",
"name": "roles"
},
"songgenres": {
"$ref": "Audio.Details.Genres",
"name": "songgenres"
},
"style": {
"$ref": "Array.String",
"name": "style"
},
"yearsactive": {
"$ref": "Array.String",
"name": "yearsactive"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' dateadded ]
* [ ''[[#Array.String|Array.String]]'' genre ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Media.Details.Base"
],
"id": "Audio.Details.Base",
"properties": {
"dateadded": {
"default": "",
"type": "string",
"name": "dateadded"
},
"genre": {
"$ref": "Array.String",
"name": "genre"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Genres ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Audio.Details.Genres",
"type": "array",
"items": {
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Audio.Details.Media ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Array.String|Array.String]]'' artist ]
* [ ''[[#Array.Integer|Array.Integer]]'' artistid ]
* [ ''string'' displayartist ]
* [ ''[[#Array.Integer|Array.Integer]]'' genreid ]
* [ ''string'' musicbrainzalbumartistid ]
* [ ''string'' musicbrainzalbumid ]
* [ ''number'' rating = "0" ]
* [ ''string'' title ]
* [ ''integer'' userrating = "0" ]
* [ ''integer'' votes = "0" ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Audio.Details.Base"
],
"id": "Audio.Details.Media",
"properties": {
"artist": {
"$ref": "Array.String",
"name": "artist"
},
"artistid": {
"$ref": "Array.Integer",
"name": "artistid"
},
"displayartist": {
"default": "",
"type": "string",
"name": "displayartist"
},
"genreid": {
"$ref": "Array.Integer",
"name": "genreid"
},
"musicbrainzalbumartistid": {
"default": "",
"type": "string",
"name": "musicbrainzalbumartistid"
},
"musicbrainzalbumid": {
"default": "",
"type": "string",
"name": "musicbrainzalbumid"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"title": {
"default": "",
"type": "string",
"name": "title"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"votes": {
"default": "0",
"type": "integer",
"name": "votes"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Role ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' roleid
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Audio.Details.Role",
"properties": {
"roleid": {
"$ref": "Library.Id",
"name": "roleid",
"required": true
},
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Song ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' album ]
* [ ''[[#Array.String|Array.String]]'' albumartist ]
* [ ''[[#Array.Integer|Array.Integer]]'' albumartistid ]
* [ ''[[#Library.Id|Library.Id]]'' albumid = "-1" ]
* [ ''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' albumreleasetype = "album" ]
* [ ''string'' comment ]
* [ ''[[#Audio.Contributors|Audio.Contributors]]'' contributors ]
* [ ''integer'' disc = "0" ]
* [ ''string'' displaycomposer ]
* [ ''string'' displayconductor ]
* [ ''string'' displaylyricist ]
* [ ''string'' displayorchestra ]
* [ ''integer'' duration = "0" ]
* [ ''string'' file ]
* [ ''string'' lastplayed ]
* [ ''string'' lyrics ]
* [ ''string'' mood ]
* [ ''string'' musicbrainzartistid ]
* [ ''string'' musicbrainztrackid ]
* [ ''integer'' playcount = "0" ]
* ''[[#Library.Id|Library.Id]]'' songid
* [ ''integer'' track = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Audio.Details.Media"
],
"id": "Audio.Details.Song",
"properties": {
"album": {
"default": "",
"type": "string",
"name": "album"
},
"albumartist": {
"$ref": "Array.String",
"name": "albumartist"
},
"albumartistid": {
"$ref": "Array.Integer",
"name": "albumartistid"
},
"albumid": {
"default": "-1",
"$ref": "Library.Id",
"name": "albumid"
},
"albumreleasetype": {
"default": "album",
"$ref": "Audio.Album.ReleaseType",
"name": "albumreleasetype"
},
"comment": {
"default": "",
"type": "string",
"name": "comment"
},
"contributors": {
"$ref": "Audio.Contributors",
"name": "contributors"
},
"disc": {
"default": "0",
"type": "integer",
"name": "disc"
},
"displaycomposer": {
"default": "",
"type": "string",
"name": "displaycomposer"
},
"displayconductor": {
"default": "",
"type": "string",
"name": "displayconductor"
},
"displaylyricist": {
"default": "",
"type": "string",
"name": "displaylyricist"
},
"displayorchestra": {
"default": "",
"type": "string",
"name": "displayorchestra"
},
"duration": {
"default": "0",
"type": "integer",
"name": "duration"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"lastplayed": {
"default": "",
"type": "string",
"name": "lastplayed"
},
"lyrics": {
"default": "",
"type": "string",
"name": "lyrics"
},
"mood": {
"default": "",
"type": "string",
"name": "mood"
},
"musicbrainzartistid": {
"default": "",
"type": "string",
"name": "musicbrainzartistid"
},
"musicbrainztrackid": {
"default": "",
"type": "string",
"name": "musicbrainztrackid"
},
"playcount": {
"default": "0",
"type": "integer",
"name": "playcount"
},
"songid": {
"$ref": "Library.Id",
"name": "songid",
"required": true
},
"track": {
"default": "0",
"type": "integer",
"name": "track"
}
}
}</syntaxhighlight>}}

==== Audio.Fields.Album ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Audio.Fields.Album",
"items": {
"description": "Requesting the genreid and/or artistid field will result in increased response times",
"enums": [
"title",
"description",
"artist",
"genre",
"theme",
"mood",
"style",
"type",
"albumlabel",
"rating",
"votes",
"userrating",
"year",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"fanart",
"thumbnail",
"playcount",
"genreid",
"artistid",
"displayartist",
"compilation",
"releasetype",
"dateadded"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Audio.Fields.Artist ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Audio.Fields.Artist",
"items": {
"description": "Requesting the (song)genreid/genre, or roleid/role fields will result in increased response times",
"enums": [
"instrument",
"style",
"mood",
"born",
"formed",
"description",
"genre",
"died",
"disbanded",
"yearsactive",
"musicbrainzartistid",
"fanart",
"thumbnail",
"compilationartist",
"dateadded",
"roles",
"songgenres",
"isalbumartist"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Audio.Fields.Role ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Audio.Fields.Role",
"items": {
"enums": [
"title"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Audio.Fields.Song ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Audio.Fields.Song",
"items": {
"description": "Requesting the genreid, artistid and/or albumartistid field will result in increased response times",
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"thumbnail",
"file",
"albumid",
"lastplayed",
"disc",
"genreid",
"artistid",
"displayartist",
"albumartistid",
"albumreleasetype",
"dateadded",
"votes",
"userrating",
"mood",
"contributors",
"displaycomposer",
"displayconductor",
"displayorchestra",
"displaylyricist"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Audio.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"missingartistid"
],
"id": "Audio.Property.Name",
"type": "string",
"default": "missingartistid"
}</syntaxhighlight>}}

==== Audio.Property.Value ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Library.Id|Library.Id]]'' missingartistid = "-1" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Audio.Property.Value",
"type": "object",
"properties": {
"missingartistid": {
"default": "-1",
"$ref": "Library.Id",
"name": "missingartistid"
}
}
}</syntaxhighlight>}}

=== Configuration ===
==== Configuration.Configuration ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Configuration.Notifications|Configuration.Notifications]]'' notifications
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Configuration",
"type": "object",
"properties": {
"notifications": {
"$ref": "Configuration.Notifications",
"name": "notifications",
"required": true
}
}
}</syntaxhighlight>}}

==== Configuration.Notifications ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' application
* ''boolean'' audiolibrary
* ''boolean'' gui
* ''boolean'' input
* ''boolean'' other
* ''boolean'' player
* ''boolean'' playlist
* ''boolean'' pvr
* ''boolean'' system
* ''boolean'' videolibrary
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Configuration.Notifications",
"type": "object",
"properties": {
"application": {
"type": "boolean",
"name": "application",
"required": true
},
"audiolibrary": {
"type": "boolean",
"name": "audiolibrary",
"required": true
},
"gui": {
"type": "boolean",
"name": "gui",
"required": true
},
"input": {
"type": "boolean",
"name": "input",
"required": true
},
"other": {
"type": "boolean",
"name": "other",
"required": true
},
"player": {
"type": "boolean",
"name": "player",
"required": true
},
"playlist": {
"type": "boolean",
"name": "playlist",
"required": true
},
"pvr": {
"type": "boolean",
"name": "pvr",
"required": true
},
"system": {
"type": "boolean",
"name": "system",
"required": true
},
"videolibrary": {
"type": "boolean",
"name": "videolibrary",
"required": true
}
}
}</syntaxhighlight>}}

=== Favourite ===
==== Favourite.Details.Favourite ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' path ]
* [ ''string'' thumbnail ]
* ''string'' title
* ''[[#Favourite.Type|Favourite.Type]]'' type
* [ ''string'' window ]
* [ ''string'' windowparameter ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Favourite.Details.Favourite",
"type": "object",
"properties": {
"path": {
"default": "",
"type": "string",
"name": "path"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"title": {
"type": "string",
"name": "title",
"required": true
},
"type": {
"$ref": "Favourite.Type",
"name": "type",
"required": true
},
"window": {
"default": "",
"type": "string",
"name": "window"
},
"windowparameter": {
"default": "",
"type": "string",
"name": "windowparameter"
}
}
}</syntaxhighlight>}}

==== Favourite.Fields.Favourite ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Favourite.Fields.Favourite",
"items": {
"enums": [
"window",
"windowparameter",
"thumbnail",
"path"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Favourite.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"media",
"window",
"script",
"unknown"
],
"id": "Favourite.Type",
"type": "string",
"default": "media"
}</syntaxhighlight>}}

=== Files ===
==== Files.Media ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"video",
"music",
"pictures",
"files",
"programs"
],
"id": "Files.Media",
"type": "string",
"default": "video"
}</syntaxhighlight>}}

=== Global ===
==== Global.IncrementDecrement ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"increment",
"decrement"
],
"id": "Global.IncrementDecrement",
"type": "string",
"default": "increment"
}</syntaxhighlight>}}

==== Global.String.NotEmpty ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Global.String.NotEmpty",
"type": "string",
"default": ""
}</syntaxhighlight>}}

==== Global.Time ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' hours
* ''integer'' milliseconds
* ''integer'' minutes
* ''integer'' seconds
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Global.Time",
"type": "object",
"properties": {
"hours": {
"type": "integer",
"name": "hours",
"required": true
},
"milliseconds": {
"type": "integer",
"name": "milliseconds",
"required": true
},
"minutes": {
"type": "integer",
"name": "minutes",
"required": true
},
"seconds": {
"type": "integer",
"name": "seconds",
"required": true
}
}
}</syntaxhighlight>}}

==== Global.Toggle ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Global.Toggle",
"type": [
{
"type": "boolean"
},
{
"enums": [
"toggle"
],
"type": "string"
}
]
}</syntaxhighlight>}}

==== Global.Weekday ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"id": "Global.Weekday",
"type": "string",
"default": "monday"
}</syntaxhighlight>}}

=== GUI ===
==== GUI.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"currentwindow",
"currentcontrol",
"skin",
"fullscreen",
"stereoscopicmode"
],
"id": "GUI.Property.Name",
"type": "string",
"default": "currentwindow"
}</syntaxhighlight>}}

==== GUI.Property.Value ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''mixed'' currentcontrol ]
* [ ''mixed'' currentwindow ]
* [ ''boolean'' fullscreen = false ]
* [ ''mixed'' skin ]
* [ ''[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]'' stereoscopicmode ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "GUI.Property.Value",
"type": "object",
"properties": {
"currentcontrol": {
"type": "object",
"name": "currentcontrol"
},
"currentwindow": {
"type": "object",
"name": "currentwindow"
},
"fullscreen": {
"default": "false",
"type": "boolean",
"name": "fullscreen"
},
"skin": {
"type": "object",
"name": "skin"
},
"stereoscopicmode": {
"$ref": "GUI.Stereoscopy.Mode",
"name": "stereoscopicmode"
}
}
}</syntaxhighlight>}}

==== GUI.Stereoscopy.Mode ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' label
* ''string'' mode
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "GUI.Stereoscopy.Mode",
"type": "object",
"properties": {
"label": {
"type": "string",
"name": "label",
"required": true
},
"mode": {
"type": "string",
"name": "mode",
"required": true
}
}
}</syntaxhighlight>}}

==== GUI.Window ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"home",
"programs",
"pictures",
"filemanager",
"settings",
"music",
"videos",
"tvchannels",
"tvrecordings",
"tvguide",
"tvtimers",
"tvsearch",
"radiochannels",
"radiorecordings",
"radioguide",
"radiotimers",
"radiosearch",
"gamecontrollers",
"pvrguideinfo",
"pvrrecordinginfo",
"pvrradiordsinfo",
"pvrtimersetting",
"pvrgroupmanager",
"pvrchannelmanager",
"pvrguidesearch",
"pvrchannelscan",
"pvrupdateprogress",
"pvrosdchannels",
"pvrosdguide",
"pvrosdteletext",
"systeminfo",
"testpattern",
"screencalibration",
"systemsettings",
"servicesettings",
"pvrsettings",
"playersettings",
"mediasettings",
"interfacesettings",
"appearancesettings",
"videoplaylist",
"loginscreen",
"profiles",
"skinsettings",
"addonbrowser",
"yesnodialog",
"progressdialog",
"virtualkeyboard",
"volumebar",
"submenu",
"favourites",
"contextmenu",
"notification",
"numericinput",
"gamepadinput",
"shutdownmenu",
"playercontrols",
"playerprocessinfo",
"seekbar",
"musicosd",
"addonsettings",
"visualisationpresetlist",
"osdcmssettings",
"osdvideosettings",
"osdaudiosettings",
"audiodspmanager",
"osdaudiodspsettings",
"videobookmarks",
"filebrowser",
"networksetup",
"mediasource",
"profilesettings",
"locksettings",
"contentsettings",
"songinformation",
"smartplaylisteditor",
"smartplaylistrule",
"busydialog",
"pictureinfo",
"accesspoints",
"fullscreeninfo",
"sliderdialog",
"addoninformation",
"subtitlesearch",
"musicplaylist",
"musicplaylisteditor",
"teletext",
"selectdialog",
"musicinformation",
"okdialog",
"movieinformation",
"textviewer",
"fullscreenvideo",
"fullscreenlivetv",
"fullscreenradio",
"visualisation",
"slideshow",
"weather",
"screensaver",
"videoosd",
"videomenu",
"videotimeseek",
"startwindow",
"startup",
"peripheralsettings",
"extendedprogressdialog",
"mediafilter",
"addon",
"eventlog",
"tvtimerrules",
"radiotimerrules"
],
"id": "GUI.Window",
"type": "string",
"default": "home"
}</syntaxhighlight>}}

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

=== Item ===
==== Item.Details.Base ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' label
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Item.Details.Base",
"type": "object",
"properties": {
"label": {
"type": "string",
"name": "label",
"required": true
}
}
}</syntaxhighlight>}}

==== Item.Fields.Base ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Item.Fields.Base",
"type": "array",
"items": {
"type": "string"
}
}</syntaxhighlight>}}

=== Library ===
==== Library.Details.Genre ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' genreid
* [ ''string'' thumbnail ]
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Library.Details.Genre",
"properties": {
"genreid": {
"$ref": "Library.Id",
"name": "genreid",
"required": true
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== Library.Details.Tag ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' tagid
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Library.Details.Tag",
"properties": {
"tagid": {
"$ref": "Library.Id",
"name": "tagid",
"required": true
},
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== Library.Fields.Genre ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Library.Fields.Genre",
"items": {
"enums": [
"title",
"thumbnail"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Library.Fields.Tag ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Library.Fields.Tag",
"items": {
"enums": [
"title"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Library.Id ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Library.Id",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

=== List ===
==== List.Amount ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.Amount",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

==== List.Fields.All ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "List.Fields.All",
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"channel",
"channeltype",
"hidden",
"locked",
"channelnumber",
"starttime",
"endtime",
"specialsortseason",
"specialsortepisode",
"compilation",
"releasetype",
"albumreleasetype",
"contributors",
"displaycomposer",
"displayconductor",
"displayorchestra",
"displaylyricist",
"userrating"
],
"type": "string"
}
}</syntaxhighlight>}}

==== List.Fields.Files ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "List.Fields.Files",
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"size",
"lastmodified",
"mimetype",
"specialsortseason",
"specialsortepisode"
],
"type": "string"
}
}</syntaxhighlight>}}

==== List.Filter.Albums ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.Artists ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.Episodes ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.Fields.Albums ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"genre",
"album",
"artist",
"albumartist",
"year",
"review",
"themes",
"moods",
"styles",
"compilation",
"type",
"label",
"rating",
"userrating",
"playcount",
"lastplayed",
"path",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Albums",
"type": "string",
"default": "genre"
}</syntaxhighlight>}}

==== List.Filter.Fields.Artists ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"artist",
"genre",
"moods",
"styles",
"instruments",
"biography",
"born",
"bandformed",
"disbanded",
"died",
"role",
"path",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Artists",
"type": "string",
"default": "artist"
}</syntaxhighlight>}}

==== List.Filter.Fields.Episodes ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"title",
"tvshow",
"plot",
"votes",
"rating",
"userrating",
"time",
"writers",
"airdate",
"playcount",
"lastplayed",
"inprogress",
"genre",
"year",
"director",
"actor",
"episode",
"season",
"filename",
"path",
"studio",
"mpaarating",
"dateadded",
"tag",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Episodes",
"type": "string",
"default": "title"
}</syntaxhighlight>}}

==== List.Filter.Fields.Movies ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"title",
"plot",
"plotoutline",
"tagline",
"votes",
"rating",
"userrating",
"time",
"writers",
"playcount",
"lastplayed",
"inprogress",
"genre",
"country",
"year",
"director",
"actor",
"mpaarating",
"top250",
"studio",
"hastrailer",
"filename",
"path",
"set",
"tag",
"dateadded",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Movies",
"type": "string",
"default": "title"
}</syntaxhighlight>}}

==== List.Filter.Fields.MusicVideos ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"title",
"genre",
"album",
"year",
"artist",
"filename",
"path",
"playcount",
"lastplayed",
"rating",
"userrating",
"time",
"director",
"studio",
"plot",
"tag",
"dateadded",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.MusicVideos",
"type": "string",
"default": "title"
}</syntaxhighlight>}}

==== List.Filter.Fields.Songs ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"genre",
"album",
"artist",
"albumartist",
"title",
"year",
"time",
"tracknumber",
"filename",
"path",
"playcount",
"lastplayed",
"rating",
"userrating",
"comment",
"moods",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Songs",
"type": "string",
"default": "genre"
}</syntaxhighlight>}}

==== List.Filter.Fields.Textures ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"textureid",
"url",
"cachedurl",
"lasthashcheck",
"imagehash",
"width",
"height",
"usecount",
"lastused"
],
"id": "List.Filter.Fields.Textures",
"type": "string",
"default": "textureid"
}</syntaxhighlight>}}

==== List.Filter.Fields.TVShows ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"title",
"plot",
"status",
"votes",
"rating",
"userrating",
"year",
"genre",
"director",
"actor",
"numepisodes",
"numwatched",
"playcount",
"path",
"studio",
"mpaarating",
"dateadded",
"lastplayed",
"inprogress",
"tag",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.TVShows",
"type": "string",
"default": "title"
}</syntaxhighlight>}}

==== List.Filter.Movies ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.MusicVideos ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.Operators ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"contains",
"doesnotcontain",
"is",
"isnot",
"startswith",
"endswith",
"greaterthan",
"lessthan",
"after",
"before",
"inthelast",
"notinthelast",
"true",
"false",
"between"
],
"id": "List.Filter.Operators",
"type": "string",
"default": "contains"
}</syntaxhighlight>}}

==== List.Filter.Rule ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Operators|List.Filter.Operators]]'' operator
* ''mixed: string|array'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.Filter.Rule",
"type": "object",
"properties": {
"operator": {
"$ref": "List.Filter.Operators",
"name": "operator",
"required": true
},
"value": {
"type": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Albums ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Albums|List.Filter.Fields.Albums]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Albums",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Albums",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Artists ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Artists|List.Filter.Fields.Artists]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Artists",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Artists",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Episodes ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Episodes|List.Filter.Fields.Episodes]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Episodes",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Episodes",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Movies ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Movies|List.Filter.Fields.Movies]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Movies",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Movies",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.MusicVideos ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.MusicVideos|List.Filter.Fields.MusicVideos]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.MusicVideos",
"properties": {
"field": {
"$ref": "List.Filter.Fields.MusicVideos",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Songs ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Songs|List.Filter.Fields.Songs]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Songs",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Songs",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Textures ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Textures|List.Filter.Fields.Textures]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Textures",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Textures",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.TVShows ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.TVShows|List.Filter.Fields.TVShows]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.TVShows",
"properties": {
"field": {
"$ref": "List.Filter.Fields.TVShows",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Songs ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.Textures ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Filter.TVShows ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== List.Item.All ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' channel ]
* [ ''integer'' channelnumber = "0" ]
* [ ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = "tv" ]
* [ ''string'' endtime ]
* [ ''boolean'' hidden = false ]
* [ ''boolean'' locked = false ]
* [ ''string'' starttime ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Item.Base"
],
"id": "List.Item.All",
"properties": {
"channel": {
"default": "",
"type": "string",
"name": "channel"
},
"channelnumber": {
"default": "0",
"type": "integer",
"name": "channelnumber"
},
"channeltype": {
"default": "tv",
"$ref": "PVR.Channel.Type",
"name": "channeltype"
},
"endtime": {
"default": "",
"type": "string",
"name": "endtime"
},
"hidden": {
"default": "false",
"type": "boolean",
"name": "hidden"
},
"locked": {
"default": "false",
"type": "boolean",
"name": "locked"
},
"starttime": {
"default": "",
"type": "string",
"name": "starttime"
}
}
}</syntaxhighlight>}}

==== List.Item.Base ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' album ]
* [ ''[[#Array.String|Array.String]]'' albumartist ]
* [ ''[[#Array.Integer|Array.Integer]]'' albumartistid ]
* [ ''[[#Library.Id|Library.Id]]'' albumid = "-1" ]
* [ ''string'' albumlabel ]
* [ ''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' albumreleasetype = "album" ]
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''string'' comment ]
* [ ''boolean'' compilation = false ]
* [ ''[[#Audio.Contributors|Audio.Contributors]]'' contributors ]
* [ ''[[#Array.String|Array.String]]'' country ]
* [ ''string'' description ]
* [ ''integer'' disc = "0" ]
* [ ''string'' displaycomposer ]
* [ ''string'' displayconductor ]
* [ ''string'' displaylyricist ]
* [ ''string'' displayorchestra ]
* [ ''integer'' duration = "0" ]
* [ ''integer'' episode = "0" ]
* [ ''string'' episodeguide ]
* [ ''string'' firstaired ]
* [ ''[[#Library.Id|Library.Id]]'' id = "-1" ]
* [ ''string'' imdbnumber ]
* [ ''string'' lyrics ]
* [ ''[[#Array.String|Array.String]]'' mood ]
* [ ''string'' mpaa ]
* [ ''string'' musicbrainzartistid ]
* [ ''string'' musicbrainztrackid ]
* [ ''string'' originaltitle ]
* [ ''string'' plotoutline ]
* [ ''string'' premiered ]
* [ ''string'' productioncode ]
* [ ''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = "album" ]
* [ ''integer'' season = "0" ]
* [ ''string'' set ]
* [ ''[[#Library.Id|Library.Id]]'' setid = "-1" ]
* [ ''[[#Array.String|Array.String]]'' showlink ]
* [ ''string'' showtitle ]
* [ ''string'' sorttitle ]
* [ ''integer'' specialsortepisode = "0" ]
* [ ''integer'' specialsortseason = "0" ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''[[#Array.String|Array.String]]'' style ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* [ ''string'' tagline ]
* [ ''[[#Array.String|Array.String]]'' theme ]
* [ ''integer'' top250 = "0" ]
* [ ''integer'' track = "0" ]
* [ ''string'' trailer ]
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
* [ ''string'' type = "unknown" ]
* [ ''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid ]
* [ ''string'' votes ]
* [ ''integer'' watchedepisodes = "0" ]
* [ ''[[#Array.String|Array.String]]'' writer ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.File",
"Audio.Details.Media"
],
"id": "List.Item.Base",
"properties": {
"album": {
"default": "",
"type": "string",
"name": "album"
},
"albumartist": {
"$ref": "Array.String",
"name": "albumartist"
},
"albumartistid": {
"$ref": "Array.Integer",
"name": "albumartistid"
},
"albumid": {
"default": "-1",
"$ref": "Library.Id",
"name": "albumid"
},
"albumlabel": {
"default": "",
"type": "string",
"name": "albumlabel"
},
"albumreleasetype": {
"default": "album",
"$ref": "Audio.Album.ReleaseType",
"name": "albumreleasetype"
},
"cast": {
"$ref": "Video.Cast",
"name": "cast"
},
"comment": {
"default": "",
"type": "string",
"name": "comment"
},
"compilation": {
"default": "false",
"type": "boolean",
"name": "compilation"
},
"contributors": {
"$ref": "Audio.Contributors",
"name": "contributors"
},
"country": {
"$ref": "Array.String",
"name": "country"
},
"description": {
"default": "",
"type": "string",
"name": "description"
},
"disc": {
"default": "0",
"type": "integer",
"name": "disc"
},
"displaycomposer": {
"default": "",
"type": "string",
"name": "displaycomposer"
},
"displayconductor": {
"default": "",
"type": "string",
"name": "displayconductor"
},
"displaylyricist": {
"default": "",
"type": "string",
"name": "displaylyricist"
},
"displayorchestra": {
"default": "",
"type": "string",
"name": "displayorchestra"
},
"duration": {
"default": "0",
"type": "integer",
"name": "duration"
},
"episode": {
"default": "0",
"type": "integer",
"name": "episode"
},
"episodeguide": {
"default": "",
"type": "string",
"name": "episodeguide"
},
"firstaired": {
"default": "",
"type": "string",
"name": "firstaired"
},
"id": {
"default": "-1",
"$ref": "Library.Id",
"name": "id"
},
"imdbnumber": {
"default": "",
"type": "string",
"name": "imdbnumber"
},
"lyrics": {
"default": "",
"type": "string",
"name": "lyrics"
},
"mood": {
"$ref": "Array.String",
"name": "mood"
},
"mpaa": {
"default": "",
"type": "string",
"name": "mpaa"
},
"musicbrainzartistid": {
"default": "",
"type": "string",
"name": "musicbrainzartistid"
},
"musicbrainztrackid": {
"default": "",
"type": "string",
"name": "musicbrainztrackid"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"plotoutline": {
"default": "",
"type": "string",
"name": "plotoutline"
},
"premiered": {
"default": "",
"type": "string",
"name": "premiered"
},
"productioncode": {
"default": "",
"type": "string",
"name": "productioncode"
},
"releasetype": {
"default": "album",
"$ref": "Audio.Album.ReleaseType",
"name": "releasetype"
},
"season": {
"default": "0",
"type": "integer",
"name": "season"
},
"set": {
"default": "",
"type": "string",
"name": "set"
},
"setid": {
"default": "-1",
"$ref": "Library.Id",
"name": "setid"
},
"showlink": {
"$ref": "Array.String",
"name": "showlink"
},
"showtitle": {
"default": "",
"type": "string",
"name": "showtitle"
},
"sorttitle": {
"default": "",
"type": "string",
"name": "sorttitle"
},
"specialsortepisode": {
"default": "0",
"type": "integer",
"name": "specialsortepisode"
},
"specialsortseason": {
"default": "0",
"type": "integer",
"name": "specialsortseason"
},
"studio": {
"$ref": "Array.String",
"name": "studio"
},
"style": {
"$ref": "Array.String",
"name": "style"
},
"tag": {
"$ref": "Array.String",
"name": "tag"
},
"tagline": {
"default": "",
"type": "string",
"name": "tagline"
},
"theme": {
"$ref": "Array.String",
"name": "theme"
},
"top250": {
"default": "0",
"type": "integer",
"name": "top250"
},
"track": {
"default": "0",
"type": "integer",
"name": "track"
},
"trailer": {
"default": "",
"type": "string",
"name": "trailer"
},
"tvshowid": {
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
"type": {
"default": "unknown",
"type": "string",
"name": "type"
},
"uniqueid": {
"$ref": "Media.UniqueID",
"name": "uniqueid"
},
"votes": {
"default": "",
"type": "string",
"name": "votes"
},
"watchedepisodes": {
"default": "0",
"type": "integer",
"name": "watchedepisodes"
},
"writer": {
"$ref": "Array.String",
"name": "writer"
}
}
}</syntaxhighlight>}}

==== List.Item.File ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' file
* ''string'' filetype
* [ ''string'' lastmodified ]
* [ ''string'' mimetype ]
* [ ''integer'' size = "0" ] ''Size of the file in bytes''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"List.Item.Base"
],
"id": "List.Item.File",
"properties": {
"file": {
"type": "string",
"name": "file",
"required": true
},
"filetype": {
"type": "string",
"name": "filetype",
"required": true
},
"lastmodified": {
"default": "",
"type": "string",
"name": "lastmodified"
},
"mimetype": {
"default": "",
"type": "string",
"name": "mimetype"
},
"size": {
"default": "0",
"description": "Size of the file in bytes",
"type": "integer",
"name": "size"
}
}
}</syntaxhighlight>}}

==== List.Items.Sources ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.Items.Sources",
"type": "array",
"items": {
"extends": "Item.Details.Base",
"properties": {
"file": {
"required": true,
"type": "string"
}
}
}
}</syntaxhighlight>}}

==== List.Limits ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#List.Amount|List.Amount]]'' end = "-1" ] ''Index of the last item to return''
* [ ''integer'' start = "0" ] ''Index of the first item to return''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.Limits",
"type": "object",
"properties": {
"end": {
"default": "-1",
"description": "Index of the last item to return",
"$ref": "List.Amount",
"name": "end"
},
"start": {
"default": "0",
"description": "Index of the first item to return",
"type": "integer",
"name": "start"
}
}
}</syntaxhighlight>}}

==== List.LimitsReturned ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#List.Amount|List.Amount]]'' end = "-1" ]
* [ ''integer'' start = "0" ]
* ''integer'' total
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.LimitsReturned",
"type": "object",
"properties": {
"end": {
"default": "-1",
"$ref": "List.Amount",
"name": "end"
},
"start": {
"default": "0",
"type": "integer",
"name": "start"
},
"total": {
"type": "integer",
"name": "total",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Sort ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' ignorearticle = false ]
* [ ''string'' method = "none" ]
* [ ''string'' order = "ascending" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "List.Sort",
"type": "object",
"properties": {
"ignorearticle": {
"default": "false",
"type": "boolean",
"name": "ignorearticle"
},
"method": {
"default": "none",
"type": "string",
"name": "method"
},
"order": {
"default": "ascending",
"type": "string",
"name": "order"
}
}
}</syntaxhighlight>}}

=== Media ===
==== Media.Artwork ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' banner ]
* [ ''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' fanart ]
* [ ''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' poster ]
* [ ''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' thumb ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Media.Artwork",
"type": "object",
"properties": {
"banner": {
"default": "",
"$ref": "Global.String.NotEmpty",
"name": "banner"
},
"fanart": {
"default": "",
"$ref": "Global.String.NotEmpty",
"name": "fanart"
},
"poster": {
"default": "",
"$ref": "Global.String.NotEmpty",
"name": "poster"
},
"thumb": {
"default": "",
"$ref": "Global.String.NotEmpty",
"name": "thumb"
}
}
}</syntaxhighlight>}}

==== Media.Artwork.Set ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''mixed'' banner ]
* [ ''mixed'' fanart ]
* [ ''mixed'' poster ]
* [ ''mixed'' thumb ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Media.Artwork.Set",
"type": "object",
"properties": {
"banner": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
],
"name": "banner"
},
"fanart": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
],
"name": "fanart"
},
"poster": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
],
"name": "poster"
},
"thumb": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
],
"name": "thumb"
}
}
}</syntaxhighlight>}}

==== Media.Details.Base ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' fanart ]
* [ ''string'' thumbnail ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Media.Details.Base",
"properties": {
"fanart": {
"default": "",
"type": "string",
"name": "fanart"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
}
}
}</syntaxhighlight>}}

==== Media.UniqueID ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Media.UniqueID",
"type": "object"
}</syntaxhighlight>}}

==== Media.UniqueID.Set ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Media.UniqueID.Set",
"type": "object"
}</syntaxhighlight>}}

=== Notifications ===
==== Notifications.Item ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== Notifications.Item.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"unknown",
"movie",
"episode",
"musicvideo",
"song",
"picture",
"channel"
],
"id": "Notifications.Item.Type",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

=== Optional ===
==== Optional.Boolean ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Optional.Boolean",
"type": [
{
"type": "null"
},
{
"type": "boolean"
}
]
}</syntaxhighlight>}}

==== Optional.Integer ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Optional.Integer",
"type": [
{
"type": "null"
},
{
"type": "integer"
}
]
}</syntaxhighlight>}}

==== Optional.Number ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Optional.Number",
"type": [
{
"type": "null"
},
{
"type": "number"
}
]
}</syntaxhighlight>}}

==== Optional.String ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Optional.String",
"type": [
{
"type": "null"
},
{
"type": "string"
}
]
}</syntaxhighlight>}}

=== Player ===
==== Player.Audio.Stream ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' bitrate
* ''integer'' channels
* ''string'' codec
* ''integer'' index
* ''string'' language
* ''string'' name
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Audio.Stream",
"type": "object",
"properties": {
"bitrate": {
"type": "integer",
"name": "bitrate",
"required": true
},
"channels": {
"type": "integer",
"name": "channels",
"required": true
},
"codec": {
"type": "string",
"name": "codec",
"required": true
},
"index": {
"type": "integer",
"name": "index",
"required": true
},
"language": {
"type": "string",
"name": "language",
"required": true
},
"name": {
"type": "string",
"name": "name",
"required": true
}
}
}</syntaxhighlight>}}

==== Player.Id ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Id",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

==== Player.Notifications.Data ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Notifications.Item|Notifications.Item]]'' item
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Notifications.Data",
"type": "object",
"properties": {
"item": {
"$ref": "Notifications.Item",
"name": "item",
"required": true
},
"player": {
"$ref": "Player.Notifications.Player",
"name": "player",
"required": true
}
}
}</syntaxhighlight>}}

==== Player.Notifications.Player ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Player.Id|Player.Id]]'' playerid
* [ ''integer'' speed = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Notifications.Player",
"type": "object",
"properties": {
"playerid": {
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
"speed": {
"default": "0",
"type": "integer",
"name": "speed"
}
}
}</syntaxhighlight>}}

==== Player.Notifications.Player.Seek ====
'''Extends:'''
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Global.Time|Global.Time]]'' seekoffset ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Player.Notifications.Player"
],
"id": "Player.Notifications.Player.Seek",
"properties": {
"seekoffset": {
"$ref": "Global.Time",
"name": "seekoffset"
},
"time": {
"$ref": "Global.Time",
"name": "time"
}
}
}</syntaxhighlight>}}

==== Player.Position.Percentage ====
'''Type:''' ''number''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Position.Percentage",
"type": "number",
"default": 0
}</syntaxhighlight>}}

==== Player.Position.Time ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' hours = "0" ]
* [ ''integer'' milliseconds = "0" ]
* [ ''integer'' minutes = "0" ]
* [ ''integer'' seconds = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Position.Time",
"type": "object",
"properties": {
"hours": {
"default": "0",
"type": "integer",
"name": "hours"
},
"milliseconds": {
"default": "0",
"type": "integer",
"name": "milliseconds"
},
"minutes": {
"default": "0",
"type": "integer",
"name": "minutes"
},
"seconds": {
"default": "0",
"type": "integer",
"name": "seconds"
}
}
}</syntaxhighlight>}}

==== Player.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"type",
"partymode",
"speed",
"time",
"percentage",
"totaltime",
"playlistid",
"position",
"repeat",
"shuffled",
"canseek",
"canchangespeed",
"canmove",
"canzoom",
"canrotate",
"canshuffle",
"canrepeat",
"currentaudiostream",
"audiostreams",
"subtitleenabled",
"currentsubtitle",
"subtitles",
"live",
"currentvideostream",
"videostreams"
],
"id": "Player.Property.Name",
"type": "string",
"default": "type"
}</syntaxhighlight>}}

==== Player.Property.Value ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Player.Audio.Stream|Player.Audio.Stream]]''[] audiostreams ]
* [ ''boolean'' canchangespeed = false ]
* [ ''boolean'' canmove = false ]
* [ ''boolean'' canrepeat = false ]
* [ ''boolean'' canrotate = false ]
* [ ''boolean'' canseek = false ]
* [ ''boolean'' canshuffle = false ]
* [ ''boolean'' canzoom = false ]
* [ ''[[#Player.Audio.Stream|Player.Audio.Stream]]'' currentaudiostream ]
* [ ''[[#Player.Subtitle|Player.Subtitle]]'' currentsubtitle ]
* [ ''[[#Player.Video.Stream|Player.Video.Stream]]'' currentvideostream ]
* [ ''boolean'' live = false ]
* [ ''boolean'' partymode = false ]
* [ ''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage = "0" ]
* [ ''[[#Playlist.Id|Playlist.Id]]'' playlistid = "-1" ]
* [ ''[[#Playlist.Position|Playlist.Position]]'' position = "-1" ]
* [ ''[[#Player.Repeat|Player.Repeat]]'' repeat = "off" ]
* [ ''boolean'' shuffled = false ]
* [ ''integer'' speed = "0" ]
* [ ''boolean'' subtitleenabled = false ]
* [ ''[[#Player.Subtitle|Player.Subtitle]]''[] subtitles ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
* [ ''[[#Global.Time|Global.Time]]'' totaltime ]
* [ ''[[#Player.Type|Player.Type]]'' type = "video" ]
* [ ''[[#Player.Video.Stream|Player.Video.Stream]]''[] videostreams ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Property.Value",
"type": "object",
"properties": {
"audiostreams": {
"items": {
"$ref": "Player.Audio.Stream"
},
"type": "array",
"name": "audiostreams"
},
"canchangespeed": {
"default": "false",
"type": "boolean",
"name": "canchangespeed"
},
"canmove": {
"default": "false",
"type": "boolean",
"name": "canmove"
},
"canrepeat": {
"default": "false",
"type": "boolean",
"name": "canrepeat"
},
"canrotate": {
"default": "false",
"type": "boolean",
"name": "canrotate"
},
"canseek": {
"default": "false",
"type": "boolean",
"name": "canseek"
},
"canshuffle": {
"default": "false",
"type": "boolean",
"name": "canshuffle"
},
"canzoom": {
"default": "false",
"type": "boolean",
"name": "canzoom"
},
"currentaudiostream": {
"$ref": "Player.Audio.Stream",
"name": "currentaudiostream"
},
"currentsubtitle": {
"$ref": "Player.Subtitle",
"name": "currentsubtitle"
},
"currentvideostream": {
"$ref": "Player.Video.Stream",
"name": "currentvideostream"
},
"live": {
"default": "false",
"type": "boolean",
"name": "live"
},
"partymode": {
"default": "false",
"type": "boolean",
"name": "partymode"
},
"percentage": {
"default": "0",
"$ref": "Player.Position.Percentage",
"name": "percentage"
},
"playlistid": {
"default": "-1",
"$ref": "Playlist.Id",
"name": "playlistid"
},
"position": {
"default": "-1",
"$ref": "Playlist.Position",
"name": "position"
},
"repeat": {
"default": "off",
"$ref": "Player.Repeat",
"name": "repeat"
},
"shuffled": {
"default": "false",
"type": "boolean",
"name": "shuffled"
},
"speed": {
"default": "0",
"type": "integer",
"name": "speed"
},
"subtitleenabled": {
"default": "false",
"type": "boolean",
"name": "subtitleenabled"
},
"subtitles": {
"items": {
"$ref": "Player.Subtitle"
},
"type": "array",
"name": "subtitles"
},
"time": {
"$ref": "Global.Time",
"name": "time"
},
"totaltime": {
"$ref": "Global.Time",
"name": "totaltime"
},
"type": {
"default": "video",
"$ref": "Player.Type",
"name": "type"
},
"videostreams": {
"items": {
"$ref": "Player.Video.Stream"
},
"type": "array",
"name": "videostreams"
}
}
}</syntaxhighlight>}}

==== Player.Repeat ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"off",
"one",
"all"
],
"id": "Player.Repeat",
"type": "string",
"default": "off"
}</syntaxhighlight>}}

==== Player.Speed ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' speed = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Speed",
"type": "object",
"properties": {
"speed": {
"default": "0",
"type": "integer",
"name": "speed"
}
}
}</syntaxhighlight>}}

==== Player.Subtitle ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' index
* ''string'' language
* ''string'' name
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Subtitle",
"type": "object",
"properties": {
"index": {
"type": "integer",
"name": "index",
"required": true
},
"language": {
"type": "string",
"name": "language",
"required": true
},
"name": {
"type": "string",
"name": "name",
"required": true
}
}
}</syntaxhighlight>}}

==== Player.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"video",
"audio",
"picture"
],
"id": "Player.Type",
"type": "string",
"default": "video"
}</syntaxhighlight>}}

==== Player.Video.Stream ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' codec
* ''integer'' height
* ''integer'' index
* ''string'' language
* ''string'' name
* ''integer'' width
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Player.Video.Stream",
"type": "object",
"properties": {
"codec": {
"type": "string",
"name": "codec",
"required": true
},
"height": {
"type": "integer",
"name": "height",
"required": true
},
"index": {
"type": "integer",
"name": "index",
"required": true
},
"language": {
"type": "string",
"name": "language",
"required": true
},
"name": {
"type": "string",
"name": "name",
"required": true
},
"width": {
"type": "integer",
"name": "width",
"required": true
}
}
}</syntaxhighlight>}}

=== Playlist ===
==== Playlist.Id ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Playlist.Id",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

==== Playlist.Item ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== Playlist.Position ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Playlist.Position",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

==== Playlist.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"type",
"size"
],
"id": "Playlist.Property.Name",
"type": "string",
"default": "type"
}</syntaxhighlight>}}

==== Playlist.Property.Value ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' size = "0" ]
* [ ''[[#Playlist.Type|Playlist.Type]]'' type = "unknown" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Playlist.Property.Value",
"type": "object",
"properties": {
"size": {
"default": "0",
"type": "integer",
"name": "size"
},
"type": {
"default": "unknown",
"$ref": "Playlist.Type",
"name": "type"
}
}
}</syntaxhighlight>}}

==== Playlist.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"unknown",
"video",
"audio",
"picture",
"mixed"
],
"id": "Playlist.Type",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

=== Profiles ===
==== Profiles.Details.Profile ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' lockmode = "0" ]
* [ ''string'' thumbnail ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Profiles.Details.Profile",
"properties": {
"lockmode": {
"default": "0",
"type": "integer",
"name": "lockmode"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
}
}
}</syntaxhighlight>}}

==== Profiles.Fields.Profile ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Profiles.Fields.Profile",
"items": {
"enums": [
"thumbnail",
"lockmode"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Profiles.Password ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' encryption = "md5" ] ''Password Encryption''
* ''string'' value ''Password''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Profiles.Password",
"type": "object",
"properties": {
"encryption": {
"default": "md5",
"description": "Password Encryption",
"type": "string",
"name": "encryption"
},
"value": {
"description": "Password",
"type": "string",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

=== PVR ===
==== PVR.Channel.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"tv",
"radio"
],
"id": "PVR.Channel.Type",
"type": "string",
"default": "tv"
}</syntaxhighlight>}}

==== PVR.ChannelGroup.Id ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "PVR.ChannelGroup.Id",
"type": [
{
"$ref": "Library.Id"
},
{
"enums": [
"alltv",
"allradio"
],
"type": "string"
}
]
}</syntaxhighlight>}}

==== PVR.Details.Broadcast ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' broadcastid
* [ ''string'' cast ]
* [ ''string'' director ]
* [ ''string'' endtime ]
* [ ''string'' episodename ]
* [ ''integer'' episodenum = "0" ]
* [ ''integer'' episodepart = "0" ]
* [ ''string'' firstaired ]
* [ ''string'' genre ]
* [ ''boolean'' hasrecording = false ]
* [ ''boolean'' hastimer = false ]
* [ ''boolean'' hastimerrule = false ]
* [ ''integer'' imdbnumber = "0" ]
* [ ''boolean'' isactive = false ]
* [ ''boolean'' isseries = false ]
* [ ''string'' originaltitle ]
* [ ''integer'' parentalrating = "0" ]
* [ ''string'' plot ]
* [ ''string'' plotoutline ]
* [ ''integer'' progress = "0" ]
* [ ''number'' progresspercentage = "0" ]
* [ ''integer'' rating = "0" ]
* [ ''string'' recording ]
* [ ''integer'' runtime = "0" ]
* [ ''string'' starttime ]
* [ ''string'' thumbnail ]
* [ ''string'' title ]
* [ ''boolean'' wasactive = false ]
* [ ''string'' writer ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.Broadcast",
"properties": {
"broadcastid": {
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
"cast": {
"default": "",
"type": "string",
"name": "cast"
},
"director": {
"default": "",
"type": "string",
"name": "director"
},
"endtime": {
"default": "",
"type": "string",
"name": "endtime"
},
"episodename": {
"default": "",
"type": "string",
"name": "episodename"
},
"episodenum": {
"default": "0",
"type": "integer",
"name": "episodenum"
},
"episodepart": {
"default": "0",
"type": "integer",
"name": "episodepart"
},
"firstaired": {
"default": "",
"type": "string",
"name": "firstaired"
},
"genre": {
"default": "",
"type": "string",
"name": "genre"
},
"hasrecording": {
"default": "false",
"type": "boolean",
"name": "hasrecording"
},
"hastimer": {
"default": "false",
"type": "boolean",
"name": "hastimer"
},
"hastimerrule": {
"default": "false",
"type": "boolean",
"name": "hastimerrule"
},
"imdbnumber": {
"default": "0",
"type": "integer",
"name": "imdbnumber"
},
"isactive": {
"default": "false",
"type": "boolean",
"name": "isactive"
},
"isseries": {
"default": "false",
"type": "boolean",
"name": "isseries"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"parentalrating": {
"default": "0",
"type": "integer",
"name": "parentalrating"
},
"plot": {
"default": "",
"type": "string",
"name": "plot"
},
"plotoutline": {
"default": "",
"type": "string",
"name": "plotoutline"
},
"progress": {
"default": "0",
"type": "integer",
"name": "progress"
},
"progresspercentage": {
"default": "0",
"type": "number",
"name": "progresspercentage"
},
"rating": {
"default": "0",
"type": "integer",
"name": "rating"
},
"recording": {
"default": "",
"type": "string",
"name": "recording"
},
"runtime": {
"default": "0",
"type": "integer",
"name": "runtime"
},
"starttime": {
"default": "",
"type": "string",
"name": "starttime"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"title": {
"default": "",
"type": "string",
"name": "title"
},
"wasactive": {
"default": "false",
"type": "boolean",
"name": "wasactive"
},
"writer": {
"default": "",
"type": "string",
"name": "writer"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== PVR.Details.Channel ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastnext ]
* [ ''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastnow ]
* [ ''string'' channel ]
* ''[[#Library.Id|Library.Id]]'' channelid
* [ ''integer'' channelnumber = "0" ]
* [ ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = "tv" ]
* [ ''boolean'' hidden = false ]
* [ ''string'' icon ]
* [ ''boolean'' isrecording = false ]
* [ ''string'' lastplayed ]
* [ ''boolean'' locked = false ]
* [ ''integer'' subchannelnumber = "0" ]
* [ ''string'' thumbnail ]
* ''integer'' uniqueid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.Channel",
"properties": {
"broadcastnext": {
"$ref": "PVR.Details.Broadcast",
"name": "broadcastnext"
},
"broadcastnow": {
"$ref": "PVR.Details.Broadcast",
"name": "broadcastnow"
},
"channel": {
"default": "",
"type": "string",
"name": "channel"
},
"channelid": {
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
"channelnumber": {
"default": "0",
"type": "integer",
"name": "channelnumber"
},
"channeltype": {
"default": "tv",
"$ref": "PVR.Channel.Type",
"name": "channeltype"
},
"hidden": {
"default": "false",
"type": "boolean",
"name": "hidden"
},
"icon": {
"default": "",
"type": "string",
"name": "icon"
},
"isrecording": {
"default": "false",
"type": "boolean",
"name": "isrecording"
},
"lastplayed": {
"default": "",
"type": "string",
"name": "lastplayed"
},
"locked": {
"default": "false",
"type": "boolean",
"name": "locked"
},
"subchannelnumber": {
"default": "0",
"type": "integer",
"name": "subchannelnumber"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"uniqueid": {
"type": "integer",
"name": "uniqueid",
"required": true
}
}
}</syntaxhighlight>}}

==== PVR.Details.ChannelGroup ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' channelgroupid
* ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.ChannelGroup",
"properties": {
"channelgroupid": {
"$ref": "Library.Id",
"name": "channelgroupid",
"required": true
},
"channeltype": {
"$ref": "PVR.Channel.Type",
"name": "channeltype",
"required": true
}
}
}</syntaxhighlight>}}

==== PVR.Details.ChannelGroup.Extended ====
'''Extends:'''
* ''[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#PVR.Details.Channel|PVR.Details.Channel]]''[] channels ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"PVR.Details.ChannelGroup"
],
"id": "PVR.Details.ChannelGroup.Extended",
"properties": {
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"type": "array",
"name": "channels"
},
"limits": {
"$ref": "List.LimitsReturned",
"name": "limits",
"required": true
}
}
}</syntaxhighlight>}}

==== PVR.Details.Recording ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Media.Artwork|Media.Artwork]]'' art ]
* [ ''string'' channel ]
* [ ''integer'' channeluid = "0" ]
* [ ''string'' directory ]
* [ ''string'' endtime ]
* [ ''integer'' epgeventid = "0" ]
* [ ''string'' file ]
* [ ''string'' genre ]
* [ ''string'' icon ]
* [ ''boolean'' isdeleted = false ]
* [ ''integer'' lifetime = "0" ]
* [ ''integer'' playcount = "0" ]
* [ ''string'' plot ]
* [ ''string'' plotoutline ]
* [ ''boolean'' radio = false ]
* ''[[#Library.Id|Library.Id]]'' recordingid
* [ ''[[#Video.Resume|Video.Resume]]'' resume ]
* [ ''integer'' runtime = "0" ]
* [ ''string'' starttime ]
* [ ''string'' streamurl ]
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.Recording",
"properties": {
"art": {
"$ref": "Media.Artwork",
"name": "art"
},
"channel": {
"default": "",
"type": "string",
"name": "channel"
},
"channeluid": {
"default": "0",
"type": "integer",
"name": "channeluid"
},
"directory": {
"default": "",
"type": "string",
"name": "directory"
},
"endtime": {
"default": "",
"type": "string",
"name": "endtime"
},
"epgeventid": {
"default": "0",
"type": "integer",
"name": "epgeventid"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"genre": {
"default": "",
"type": "string",
"name": "genre"
},
"icon": {
"default": "",
"type": "string",
"name": "icon"
},
"isdeleted": {
"default": "false",
"type": "boolean",
"name": "isdeleted"
},
"lifetime": {
"default": "0",
"type": "integer",
"name": "lifetime"
},
"playcount": {
"default": "0",
"type": "integer",
"name": "playcount"
},
"plot": {
"default": "",
"type": "string",
"name": "plot"
},
"plotoutline": {
"default": "",
"type": "string",
"name": "plotoutline"
},
"radio": {
"default": "false",
"type": "boolean",
"name": "radio"
},
"recordingid": {
"$ref": "Library.Id",
"name": "recordingid",
"required": true
},
"resume": {
"$ref": "Video.Resume",
"name": "resume"
},
"runtime": {
"default": "0",
"type": "integer",
"name": "runtime"
},
"starttime": {
"default": "",
"type": "string",
"name": "starttime"
},
"streamurl": {
"default": "",
"type": "string",
"name": "streamurl"
},
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== PVR.Details.Timer ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Library.Id|Library.Id]]'' channelid = "-1" ]
* [ ''string'' directory ]
* [ ''boolean'' endanytime = false ]
* [ ''integer'' endmargin = "0" ]
* [ ''string'' endtime ]
* [ ''string'' epgsearchstring ]
* [ ''integer'' epguid = "0" ]
* [ ''string'' file ]
* [ ''string'' firstday ]
* [ ''boolean'' fulltextepgsearch = false ]
* [ ''boolean'' ismanual = false ]
* [ ''boolean'' isradio = false ]
* [ ''boolean'' isreadonly = false ]
* [ ''boolean'' istimerrule = false ]
* [ ''integer'' lifetime = "0" ]
* [ ''integer'' maxrecordings = "0" ]
* [ ''integer'' preventduplicateepisodes = "0" ]
* [ ''integer'' priority = "0" ]
* [ ''integer'' recordinggroup = "0" ]
* [ ''integer'' runtime = "0" ]
* [ ''boolean'' startanytime = false ]
* [ ''integer'' startmargin = "0" ]
* [ ''string'' starttime ]
* [ ''[[#PVR.TimerState|PVR.TimerState]]'' state = "unknown" ]
* [ ''string'' summary ]
* ''[[#Library.Id|Library.Id]]'' timerid
* [ ''string'' title ]
* [ ''[[#Global.Weekday|Global.Weekday]]''[] weekdays ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.Timer",
"properties": {
"channelid": {
"default": "-1",
"$ref": "Library.Id",
"name": "channelid"
},
"directory": {
"default": "",
"type": "string",
"name": "directory"
},
"endanytime": {
"default": "false",
"type": "boolean",
"name": "endanytime"
},
"endmargin": {
"default": "0",
"type": "integer",
"name": "endmargin"
},
"endtime": {
"default": "",
"type": "string",
"name": "endtime"
},
"epgsearchstring": {
"default": "",
"type": "string",
"name": "epgsearchstring"
},
"epguid": {
"default": "0",
"type": "integer",
"name": "epguid"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"firstday": {
"default": "",
"type": "string",
"name": "firstday"
},
"fulltextepgsearch": {
"default": "false",
"type": "boolean",
"name": "fulltextepgsearch"
},
"ismanual": {
"default": "false",
"type": "boolean",
"name": "ismanual"
},
"isradio": {
"default": "false",
"type": "boolean",
"name": "isradio"
},
"isreadonly": {
"default": "false",
"type": "boolean",
"name": "isreadonly"
},
"istimerrule": {
"default": "false",
"type": "boolean",
"name": "istimerrule"
},
"lifetime": {
"default": "0",
"type": "integer",
"name": "lifetime"
},
"maxrecordings": {
"default": "0",
"type": "integer",
"name": "maxrecordings"
},
"preventduplicateepisodes": {
"default": "0",
"type": "integer",
"name": "preventduplicateepisodes"
},
"priority": {
"default": "0",
"type": "integer",
"name": "priority"
},
"recordinggroup": {
"default": "0",
"type": "integer",
"name": "recordinggroup"
},
"runtime": {
"default": "0",
"type": "integer",
"name": "runtime"
},
"startanytime": {
"default": "false",
"type": "boolean",
"name": "startanytime"
},
"startmargin": {
"default": "0",
"type": "integer",
"name": "startmargin"
},
"starttime": {
"default": "",
"type": "string",
"name": "starttime"
},
"state": {
"default": "unknown",
"$ref": "PVR.TimerState",
"name": "state"
},
"summary": {
"default": "",
"type": "string",
"name": "summary"
},
"timerid": {
"$ref": "Library.Id",
"name": "timerid",
"required": true
},
"title": {
"default": "",
"type": "string",
"name": "title"
},
"weekdays": {
"items": {
"$ref": "Global.Weekday"
},
"type": "array",
"name": "weekdays"
}
}
}</syntaxhighlight>}}

==== PVR.Fields.Broadcast ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "PVR.Fields.Broadcast",
"items": {
"enums": [
"title",
"plot",
"plotoutline",
"starttime",
"endtime",
"runtime",
"progress",
"progresspercentage",
"genre",
"episodename",
"episodenum",
"episodepart",
"firstaired",
"hastimer",
"isactive",
"parentalrating",
"wasactive",
"thumbnail",
"rating",
"originaltitle",
"cast",
"director",
"writer",
"year",
"imdbnumber",
"hastimerrule",
"hasrecording",
"recording",
"isseries"
],
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Fields.Channel ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "PVR.Fields.Channel",
"items": {
"enums": [
"thumbnail",
"channeltype",
"hidden",
"locked",
"channel",
"lastplayed",
"broadcastnow",
"broadcastnext",
"uniqueid",
"icon",
"channelnumber",
"subchannelnumber",
"isrecording"
],
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Fields.Recording ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "PVR.Fields.Recording",
"items": {
"enums": [
"title",
"plot",
"plotoutline",
"genre",
"playcount",
"resume",
"channel",
"starttime",
"endtime",
"runtime",
"lifetime",
"icon",
"art",
"streamurl",
"file",
"directory",
"radio",
"isdeleted",
"epgeventid",
"channeluid"
],
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Fields.Timer ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "PVR.Fields.Timer",
"items": {
"enums": [
"title",
"summary",
"channelid",
"isradio",
"istimerrule",
"ismanual",
"starttime",
"endtime",
"runtime",
"lifetime",
"firstday",
"weekdays",
"priority",
"startmargin",
"endmargin",
"state",
"file",
"directory",
"preventduplicateepisodes",
"startanytime",
"endanytime",
"epgsearchstring",
"fulltextepgsearch",
"recordinggroup",
"maxrecordings",
"epguid",
"isreadonly"
],
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"available",
"recording",
"scanning"
],
"id": "PVR.Property.Name",
"type": "string",
"default": "available"
}</syntaxhighlight>}}

==== PVR.Property.Value ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' available = false ]
* [ ''boolean'' recording = false ]
* [ ''boolean'' scanning = false ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "PVR.Property.Value",
"type": "object",
"properties": {
"available": {
"default": "false",
"type": "boolean",
"name": "available"
},
"recording": {
"default": "false",
"type": "boolean",
"name": "recording"
},
"scanning": {
"default": "false",
"type": "boolean",
"name": "scanning"
}
}
}</syntaxhighlight>}}

==== PVR.TimerState ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"unknown",
"new",
"scheduled",
"recording",
"completed",
"aborted",
"cancelled",
"conflict_ok",
"conflict_notok",
"error",
"disabled"
],
"id": "PVR.TimerState",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

=== Setting ===
==== Setting.Details.Base ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' help ]
* ''string'' id
* ''string'' label
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Details.Base",
"type": "object",
"properties": {
"help": {
"default": "",
"type": "string",
"name": "help"
},
"id": {
"type": "string",
"name": "id",
"required": true
},
"label": {
"type": "string",
"name": "label",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.Category ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Setting.Details.Group|Setting.Details.Group]]''[] groups ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.Base"
],
"id": "Setting.Details.Category",
"properties": {
"groups": {
"items": {
"$ref": "Setting.Details.Group"
},
"type": "array",
"name": "groups"
}
}
}</syntaxhighlight>}}

==== Setting.Details.Control ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== Setting.Details.ControlBase ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' delayed
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Details.ControlBase",
"type": "object",
"properties": {
"delayed": {
"type": "boolean",
"name": "delayed",
"required": true
},
"format": {
"type": "string",
"name": "format",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlButton ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlHeading"
],
"id": "Setting.Details.ControlButton",
"properties": {
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlCheckmark ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlBase"
],
"id": "Setting.Details.ControlCheckmark",
"properties": {
"format": {
"type": "string",
"name": "format",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlEdit ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' hidden
* ''string'' type
* ''boolean'' verifynewvalue
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlHeading"
],
"id": "Setting.Details.ControlEdit",
"properties": {
"hidden": {
"type": "boolean",
"name": "hidden",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
},
"verifynewvalue": {
"type": "boolean",
"name": "verifynewvalue",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlHeading ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' heading ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlBase"
],
"id": "Setting.Details.ControlHeading",
"properties": {
"heading": {
"default": "",
"type": "string",
"name": "heading"
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlList ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' multiselect
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlHeading"
],
"id": "Setting.Details.ControlList",
"properties": {
"multiselect": {
"type": "boolean",
"name": "multiselect",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlRange ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' formatlabel
* ''string'' formatvalue
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlBase"
],
"id": "Setting.Details.ControlRange",
"properties": {
"formatlabel": {
"type": "string",
"name": "formatlabel",
"required": true
},
"formatvalue": {
"type": "string",
"name": "formatvalue",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlSlider ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' formatlabel
* ''boolean'' popup
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlHeading"
],
"id": "Setting.Details.ControlSlider",
"properties": {
"formatlabel": {
"type": "string",
"name": "formatlabel",
"required": true
},
"popup": {
"type": "boolean",
"name": "popup",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlSpinner ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' formatlabel ]
* [ ''string'' minimumlabel ]
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.ControlBase"
],
"id": "Setting.Details.ControlSpinner",
"properties": {
"formatlabel": {
"default": "",
"type": "string",
"name": "formatlabel"
},
"minimumlabel": {
"default": "",
"type": "string",
"name": "minimumlabel"
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.Group ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' id
* [ ''[[#Setting.Details.Setting|Setting.Details.Setting]]''[] settings ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Details.Group",
"type": "object",
"properties": {
"id": {
"type": "string",
"name": "id",
"required": true
},
"settings": {
"items": {
"$ref": "Setting.Details.Setting"
},
"type": "array",
"name": "settings"
}
}
}</syntaxhighlight>}}

==== Setting.Details.Section ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Setting.Details.Category|Setting.Details.Category]]''[] categories ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.Base"
],
"id": "Setting.Details.Section",
"properties": {
"categories": {
"items": {
"$ref": "Setting.Details.Category"
},
"type": "array",
"name": "categories"
}
}
}</syntaxhighlight>}}

==== Setting.Details.Setting ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
]
}</syntaxhighlight>}}

==== Setting.Details.SettingAction ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingAction"
}</syntaxhighlight>}}

==== Setting.Details.SettingAddon ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Addon.Types|Addon.Types]]'' addontype
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingString"
],
"id": "Setting.Details.SettingAddon",
"properties": {
"addontype": {
"$ref": "Addon.Types",
"name": "addontype",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingBase ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Setting.Details.Control|Setting.Details.Control]]'' control ]
* ''boolean'' enabled
* ''[[#Setting.Level|Setting.Level]]'' level
* [ ''string'' parent ]
* ''[[#Setting.Type|Setting.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.Base"
],
"id": "Setting.Details.SettingBase",
"properties": {
"control": {
"$ref": "Setting.Details.Control",
"name": "control"
},
"enabled": {
"type": "boolean",
"name": "enabled",
"required": true
},
"level": {
"$ref": "Setting.Level",
"name": "level",
"required": true
},
"parent": {
"default": "",
"type": "string",
"name": "parent"
},
"type": {
"$ref": "Setting.Type",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingBool ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' default
* ''boolean'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingBool",
"properties": {
"default": {
"type": "boolean",
"name": "default",
"required": true
},
"value": {
"type": "boolean",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingInt ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' default
* [ ''integer'' maximum = "0" ]
* [ ''integer'' minimum = "0" ]
* [ ''object'' options ]
* [ ''integer'' step = "0" ]
* ''integer'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingInt",
"properties": {
"default": {
"type": "integer",
"name": "default",
"required": true
},
"maximum": {
"default": "0",
"type": "integer",
"name": "maximum"
},
"minimum": {
"default": "0",
"type": "integer",
"name": "minimum"
},
"options": {
"items": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "integer"
}
},
"type": "object"
},
"type": "array",
"name": "options"
},
"step": {
"default": "0",
"type": "integer",
"name": "step"
},
"value": {
"type": "integer",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingList ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Setting.Value.List|Setting.Value.List]]'' default
* ''[[#Setting.Details.Setting|Setting.Details.Setting]]'' definition
* ''string'' delimiter
* ''[[#Setting.Type|Setting.Type]]'' elementtype
* [ ''integer'' maximumitems = "0" ]
* [ ''integer'' minimumitems = "0" ]
* ''[[#Setting.Value.List|Setting.Value.List]]'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingList",
"properties": {
"default": {
"$ref": "Setting.Value.List",
"name": "default",
"required": true
},
"definition": {
"$ref": "Setting.Details.Setting",
"name": "definition",
"required": true
},
"delimiter": {
"type": "string",
"name": "delimiter",
"required": true
},
"elementtype": {
"$ref": "Setting.Type",
"name": "elementtype",
"required": true
},
"maximumitems": {
"default": "0",
"type": "integer",
"name": "maximumitems"
},
"minimumitems": {
"default": "0",
"type": "integer",
"name": "minimumitems"
},
"value": {
"$ref": "Setting.Value.List",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingNumber ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''number'' default
* ''number'' maximum
* ''number'' minimum
* ''number'' step
* ''number'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingNumber",
"properties": {
"default": {
"type": "number",
"name": "default",
"required": true
},
"maximum": {
"type": "number",
"name": "maximum",
"required": true
},
"minimum": {
"type": "number",
"name": "minimum",
"required": true
},
"step": {
"type": "number",
"name": "step",
"required": true
},
"value": {
"type": "number",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingPath ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string''[] sources ]
* ''boolean'' writable
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingString"
],
"id": "Setting.Details.SettingPath",
"properties": {
"sources": {
"items": {
"type": "string"
},
"type": "array",
"name": "sources"
},
"writable": {
"type": "boolean",
"name": "writable",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingString ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' allowempty
* ''string'' default
* [ ''object'' options ]
* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingString",
"properties": {
"allowempty": {
"type": "boolean",
"name": "allowempty",
"required": true
},
"default": {
"type": "string",
"name": "default",
"required": true
},
"options": {
"items": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "options"
},
"value": {
"type": "string",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Level ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"basic",
"standard",
"advanced",
"expert"
],
"id": "Setting.Level",
"type": "string",
"default": "basic"
}</syntaxhighlight>}}

==== Setting.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"boolean",
"integer",
"number",
"string",
"action",
"list",
"path",
"addon"
],
"id": "Setting.Type",
"type": "string",
"default": "boolean"
}</syntaxhighlight>}}

==== Setting.Value ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Value",
"type": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
}</syntaxhighlight>}}

==== Setting.Value.Extended ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Value.Extended",
"type": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"$ref": "Setting.Value.List"
}
]
}</syntaxhighlight>}}

==== Setting.Value.List ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Setting.Value.List",
"type": "array",
"items": {
"$ref": "Setting.Value"
}
}</syntaxhighlight>}}

=== System ===
==== System.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"enums": [
"canshutdown",
"cansuspend",
"canhibernate",
"canreboot"
],
"id": "System.Property.Name",
"type": "string",
"default": "canshutdown"
}</syntaxhighlight>}}

==== System.Property.Value ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' canhibernate = false ]
* [ ''boolean'' canreboot = false ]
* [ ''boolean'' canshutdown = false ]
* [ ''boolean'' cansuspend = false ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "System.Property.Value",
"type": "object",
"properties": {
"canhibernate": {
"default": "false",
"type": "boolean",
"name": "canhibernate"
},
"canreboot": {
"default": "false",
"type": "boolean",
"name": "canreboot"
},
"canshutdown": {
"default": "false",
"type": "boolean",
"name": "canshutdown"
},
"cansuspend": {
"default": "false",
"type": "boolean",
"name": "cansuspend"
}
}
}</syntaxhighlight>}}

=== Textures ===
==== Textures.Details.Size ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' height = "0" ] ''Height of texture''
* [ ''string'' lastused ] ''Date of last use''
* [ ''integer'' size = "0" ] ''Size of the texture (1 == largest)''
* [ ''integer'' usecount = "0" ] ''Number of uses''
* [ ''integer'' width = "0" ] ''Width of texture''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Textures.Details.Size",
"type": "object",
"properties": {
"height": {
"default": "0",
"description": "Height of texture",
"type": "integer",
"name": "height"
},
"lastused": {
"default": "",
"description": "Date of last use",
"type": "string",
"name": "lastused"
},
"size": {
"default": "0",
"description": "Size of the texture (1 == largest)",
"type": "integer",
"name": "size"
},
"usecount": {
"default": "0",
"description": "Number of uses",
"type": "integer",
"name": "usecount"
},
"width": {
"default": "0",
"description": "Width of texture",
"type": "integer",
"name": "width"
}
}
}</syntaxhighlight>}}

==== Textures.Details.Texture ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' cachedurl ] ''Cached URL on disk''
* [ ''string'' imagehash ] ''Hash of image''
* [ ''string'' lasthashcheck ] ''Last time source was checked for changes''
* [ ''[[#Textures.Details.Size|Textures.Details.Size]]''[] sizes ]
* [ ''[[#Library.Id|Library.Id]]'' textureid = "-1" ]
* [ ''string'' url ] ''Original source URL''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Textures.Details.Texture",
"type": "object",
"properties": {
"cachedurl": {
"default": "",
"description": "Cached URL on disk",
"type": "string",
"name": "cachedurl"
},
"imagehash": {
"default": "",
"description": "Hash of image",
"type": "string",
"name": "imagehash"
},
"lasthashcheck": {
"default": "",
"description": "Last time source was checked for changes",
"type": "string",
"name": "lasthashcheck"
},
"sizes": {
"items": {
"$ref": "Textures.Details.Size"
},
"type": "array",
"name": "sizes"
},
"textureid": {
"default": "-1",
"$ref": "Library.Id",
"name": "textureid"
},
"url": {
"default": "",
"description": "Original source URL",
"type": "string",
"name": "url"
}
}
}</syntaxhighlight>}}

==== Textures.Fields.Texture ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Textures.Fields.Texture",
"items": {
"enums": [
"url",
"cachedurl",
"lasthashcheck",
"imagehash",
"sizes"
],
"type": "string"
}
}</syntaxhighlight>}}

=== Video ===
==== Video.Cast ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Cast",
"type": "array",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"required": true,
"type": "string"
},
"order": {
"required": true,
"type": "integer"
},
"role": {
"required": true,
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Video.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Media.Artwork|Media.Artwork]]'' art ]
* [ ''integer'' playcount = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Media.Details.Base"
],
"id": "Video.Details.Base",
"properties": {
"art": {
"$ref": "Media.Artwork",
"name": "art"
},
"playcount": {
"default": "0",
"type": "integer",
"name": "playcount"
}
}
}</syntaxhighlight>}}

==== Video.Details.Episode ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''integer'' episode = "0" ]
* ''[[#Library.Id|Library.Id]]'' episodeid
* [ ''string'' firstaired ]
* [ ''string'' originaltitle ]
* [ ''string'' productioncode ]
* [ ''number'' rating = "0" ]
* [ ''mixed'' ratings ]
* [ ''integer'' season = "0" ]
* [ ''[[#Library.Id|Library.Id]]'' seasonid = "-1" ]
* [ ''string'' showtitle ]
* [ ''integer'' specialsortepisode = "0" ]
* [ ''integer'' specialsortseason = "0" ]
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
* [ ''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid ]
* [ ''integer'' userrating = "0" ]
* [ ''string'' votes ]
* [ ''[[#Array.String|Array.String]]'' writer ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.File"
],
"id": "Video.Details.Episode",
"properties": {
"cast": {
"$ref": "Video.Cast",
"name": "cast"
},
"episode": {
"default": "0",
"type": "integer",
"name": "episode"
},
"episodeid": {
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
"firstaired": {
"default": "",
"type": "string",
"name": "firstaired"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"productioncode": {
"default": "",
"type": "string",
"name": "productioncode"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"ratings": {
"type": "any",
"name": "ratings"
},
"season": {
"default": "0",
"type": "integer",
"name": "season"
},
"seasonid": {
"default": "-1",
"$ref": "Library.Id",
"name": "seasonid"
},
"showtitle": {
"default": "",
"type": "string",
"name": "showtitle"
},
"specialsortepisode": {
"default": "0",
"type": "integer",
"name": "specialsortepisode"
},
"specialsortseason": {
"default": "0",
"type": "integer",
"name": "specialsortseason"
},
"tvshowid": {
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
"uniqueid": {
"$ref": "Media.UniqueID",
"name": "uniqueid"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"votes": {
"default": "",
"type": "string",
"name": "votes"
},
"writer": {
"$ref": "Array.String",
"name": "writer"
}
}
}</syntaxhighlight>}}

==== Video.Details.File ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Array.String|Array.String]]'' director ]
* [ ''[[#Video.Resume|Video.Resume]]'' resume ]
* [ ''integer'' runtime = "0" ] ''Runtime in seconds''
* [ ''[[#Video.Streams|Video.Streams]]'' streamdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Item"
],
"id": "Video.Details.File",
"properties": {
"director": {
"$ref": "Array.String",
"name": "director"
},
"resume": {
"$ref": "Video.Resume",
"name": "resume"
},
"runtime": {
"default": "0",
"description": "Runtime in seconds",
"type": "integer",
"name": "runtime"
},
"streamdetails": {
"$ref": "Video.Streams",
"name": "streamdetails"
}
}
}</syntaxhighlight>}}

==== Video.Details.Item ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' dateadded ]
* [ ''string'' file ]
* [ ''string'' lastplayed ]
* [ ''string'' plot ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Media"
],
"id": "Video.Details.Item",
"properties": {
"dateadded": {
"default": "",
"type": "string",
"name": "dateadded"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"lastplayed": {
"default": "",
"type": "string",
"name": "lastplayed"
},
"plot": {
"default": "",
"type": "string",
"name": "plot"
}
}
}</syntaxhighlight>}}

==== Video.Details.Media ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Base"
],
"id": "Video.Details.Media",
"properties": {
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== Video.Details.Movie ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''[[#Array.String|Array.String]]'' country ]
* [ ''[[#Array.String|Array.String]]'' genre ]
* [ ''string'' imdbnumber ]
* ''[[#Library.Id|Library.Id]]'' movieid
* [ ''string'' mpaa ]
* [ ''string'' originaltitle ]
* [ ''string'' plotoutline ]
* [ ''string'' premiered ]
* [ ''number'' rating = "0" ]
* [ ''mixed'' ratings ]
* [ ''string'' set ]
* [ ''[[#Library.Id|Library.Id]]'' setid = "-1" ]
* [ ''[[#Array.String|Array.String]]'' showlink ]
* [ ''string'' sorttitle ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* [ ''string'' tagline ]
* [ ''integer'' top250 = "0" ]
* [ ''string'' trailer ]
* [ ''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid ]
* [ ''integer'' userrating = "0" ]
* [ ''string'' votes ]
* [ ''[[#Array.String|Array.String]]'' writer ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.File"
],
"id": "Video.Details.Movie",
"properties": {
"cast": {
"$ref": "Video.Cast",
"name": "cast"
},
"country": {
"$ref": "Array.String",
"name": "country"
},
"genre": {
"$ref": "Array.String",
"name": "genre"
},
"imdbnumber": {
"default": "",
"type": "string",
"name": "imdbnumber"
},
"movieid": {
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
"mpaa": {
"default": "",
"type": "string",
"name": "mpaa"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"plotoutline": {
"default": "",
"type": "string",
"name": "plotoutline"
},
"premiered": {
"default": "",
"type": "string",
"name": "premiered"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"ratings": {
"type": "any",
"name": "ratings"
},
"set": {
"default": "",
"type": "string",
"name": "set"
},
"setid": {
"default": "-1",
"$ref": "Library.Id",
"name": "setid"
},
"showlink": {
"$ref": "Array.String",
"name": "showlink"
},
"sorttitle": {
"default": "",
"type": "string",
"name": "sorttitle"
},
"studio": {
"$ref": "Array.String",
"name": "studio"
},
"tag": {
"$ref": "Array.String",
"name": "tag"
},
"tagline": {
"default": "",
"type": "string",
"name": "tagline"
},
"top250": {
"default": "0",
"type": "integer",
"name": "top250"
},
"trailer": {
"default": "",
"type": "string",
"name": "trailer"
},
"uniqueid": {
"$ref": "Media.UniqueID",
"name": "uniqueid"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"votes": {
"default": "",
"type": "string",
"name": "votes"
},
"writer": {
"$ref": "Array.String",
"name": "writer"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== Video.Details.MovieSet ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' plot ]
* ''[[#Library.Id|Library.Id]]'' setid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Media"
],
"id": "Video.Details.MovieSet",
"properties": {
"plot": {
"default": "",
"type": "string",
"name": "plot"
},
"setid": {
"$ref": "Library.Id",
"name": "setid",
"required": true
}
}
}</syntaxhighlight>}}

==== Video.Details.MovieSet.Extended ====
'''Extends:'''
* ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.MovieSet"
],
"id": "Video.Details.MovieSet.Extended",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"name": "limits",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array",
"name": "movies"
}
}
}</syntaxhighlight>}}

==== Video.Details.MusicVideo ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' album ]
* [ ''[[#Array.String|Array.String]]'' artist ]
* [ ''[[#Array.String|Array.String]]'' genre ]
* ''[[#Library.Id|Library.Id]]'' musicvideoid
* [ ''string'' premiered ]
* [ ''number'' rating = "0" ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* [ ''integer'' track = "0" ]
* [ ''integer'' userrating = "0" ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.File"
],
"id": "Video.Details.MusicVideo",
"properties": {
"album": {
"default": "",
"type": "string",
"name": "album"
},
"artist": {
"$ref": "Array.String",
"name": "artist"
},
"genre": {
"$ref": "Array.String",
"name": "genre"
},
"musicvideoid": {
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
"premiered": {
"default": "",
"type": "string",
"name": "premiered"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"studio": {
"$ref": "Array.String",
"name": "studio"
},
"tag": {
"$ref": "Array.String",
"name": "tag"
},
"track": {
"default": "0",
"type": "integer",
"name": "track"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== Video.Details.Season ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' episode = "0" ]
* ''integer'' season
* ''[[#Library.Id|Library.Id]]'' seasonid
* [ ''string'' showtitle ]
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
* [ ''integer'' userrating = "0" ]
* [ ''integer'' watchedepisodes = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Base"
],
"id": "Video.Details.Season",
"properties": {
"episode": {
"default": "0",
"type": "integer",
"name": "episode"
},
"season": {
"type": "integer",
"name": "season",
"required": true
},
"seasonid": {
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
"showtitle": {
"default": "",
"type": "string",
"name": "showtitle"
},
"tvshowid": {
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"watchedepisodes": {
"default": "0",
"type": "integer",
"name": "watchedepisodes"
}
}
}</syntaxhighlight>}}

==== Video.Details.TVShow ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''integer'' episode = "0" ]
* [ ''string'' episodeguide ]
* [ ''[[#Array.String|Array.String]]'' genre ]
* [ ''string'' imdbnumber ]
* [ ''string'' mpaa ]
* [ ''string'' originaltitle ]
* [ ''string'' premiered ]
* [ ''number'' rating = "0" ]
* [ ''mixed'' ratings ]
* [ ''integer'' runtime = "0" ] ''Runtime in seconds''
* [ ''integer'' season = "0" ]
* [ ''string'' sorttitle ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* ''[[#Library.Id|Library.Id]]'' tvshowid
* [ ''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid ]
* [ ''integer'' userrating = "0" ]
* [ ''string'' votes ]
* [ ''integer'' watchedepisodes = "0" ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Video.Details.Item"
],
"id": "Video.Details.TVShow",
"properties": {
"cast": {
"$ref": "Video.Cast",
"name": "cast"
},
"episode": {
"default": "0",
"type": "integer",
"name": "episode"
},
"episodeguide": {
"default": "",
"type": "string",
"name": "episodeguide"
},
"genre": {
"$ref": "Array.String",
"name": "genre"
},
"imdbnumber": {
"default": "",
"type": "string",
"name": "imdbnumber"
},
"mpaa": {
"default": "",
"type": "string",
"name": "mpaa"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"premiered": {
"default": "",
"type": "string",
"name": "premiered"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"ratings": {
"type": "any",
"name": "ratings"
},
"runtime": {
"default": "0",
"description": "Runtime in seconds",
"type": "integer",
"name": "runtime"
},
"season": {
"default": "0",
"type": "integer",
"name": "season"
},
"sorttitle": {
"default": "",
"type": "string",
"name": "sorttitle"
},
"studio": {
"$ref": "Array.String",
"name": "studio"
},
"tag": {
"$ref": "Array.String",
"name": "tag"
},
"tvshowid": {
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
"uniqueid": {
"$ref": "Media.UniqueID",
"name": "uniqueid"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"votes": {
"default": "",
"type": "string",
"name": "votes"
},
"watchedepisodes": {
"default": "0",
"type": "integer",
"name": "watchedepisodes"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== Video.Fields.Episode ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
}</syntaxhighlight>}}

==== Video.Fields.Movie ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
}</syntaxhighlight>}}

==== Video.Fields.MovieSet ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Video.Fields.MovieSet",
"items": {
"enums": [
"title",
"playcount",
"fanart",
"thumbnail",
"art",
"plot"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Video.Fields.MusicVideo ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
}</syntaxhighlight>}}

==== Video.Fields.Season ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Video.Fields.Season",
"items": {
"enums": [
"season",
"showtitle",
"playcount",
"episode",
"fanart",
"thumbnail",
"tvshowid",
"watchedepisodes",
"art",
"userrating"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Video.Fields.TVShow ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"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"
}
}</syntaxhighlight>}}

==== Video.Rating ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' default = false ]
* ''number'' rating
* [ ''integer'' votes = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Rating",
"type": "object",
"properties": {
"default": {
"default": "false",
"type": "boolean",
"name": "default"
},
"rating": {
"type": "number",
"name": "rating",
"required": true
},
"votes": {
"default": "0",
"type": "integer",
"name": "votes"
}
}
}</syntaxhighlight>}}

==== Video.Ratings ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Ratings",
"type": "object"
}</syntaxhighlight>}}

==== Video.Ratings.Set ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Ratings.Set",
"type": "object"
}</syntaxhighlight>}}

==== Video.Resume ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''number'' position = "0" ]
* [ ''number'' total = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Resume",
"type": "object",
"properties": {
"position": {
"default": "0",
"type": "number",
"name": "position"
},
"total": {
"default": "0",
"type": "number",
"name": "total"
}
}
}</syntaxhighlight>}}

==== Video.Streams ====
'''Type:''' ''mixed''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''object'' audio ]
* [ ''object'' subtitle ]
* [ ''object'' video ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Video.Streams",
"type": "object",
"properties": {
"audio": {
"items": {
"properties": {
"channels": {
"default": 0,
"type": "integer"
},
"codec": {
"default": "",
"type": "string"
},
"language": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "audio"
},
"subtitle": {
"items": {
"properties": {
"language": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "subtitle"
},
"video": {
"items": {
"properties": {
"aspect": {
"default": 0,
"type": "number"
},
"codec": {
"default": "",
"type": "string"
},
"duration": {
"default": 0,
"type": "integer"
},
"height": {
"default": 0,
"type": "integer"
},
"width": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"type": "array",
"name": "video"
}
}
}</syntaxhighlight>}}

== Notifications ==
=== Application ===
==== Application.OnVolumeChanged ====
The volume of the application has changed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''boolean'' muted
* ''integer'' volume
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The volume of the application has changed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"muted": {
"type": "boolean",
"name": "muted",
"required": true
},
"volume": {
"type": "integer",
"name": "volume",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== AudioLibrary ===
==== AudioLibrary.OnCleanFinished ====
The audio library has been cleaned.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The audio library has been cleaned.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnCleanStarted ====
An audio library clean operation has started.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "An audio library clean operation has started.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnExport ====
An audio library export has finished.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* [ ''integer'' failcount = "0" ]
* [ ''string'' file ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "An audio library export has finished.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"failcount": {
"default": "0",
"type": "integer",
"name": "failcount"
},
"file": {
"default": "",
"type": "string",
"name": "file"
}
},
"type": "object",
"name": "data"
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnRemove ====
An audio item has been removed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' id
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' transaction ] ''True if the removal is being performed within a transaction.''
* ''[[#Notifications.Library.Audio.Type|Notifications.Library.Audio.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "An audio item has been removed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"id": {
"$ref": "Library.Id",
"name": "id",
"required": true
},
"transaction": {
"description": "True if the removal is being performed within a transaction.",
"$ref": "Optional.Boolean",
"name": "transaction"
},
"type": {
"$ref": "Notifications.Library.Audio.Type",
"name": "type",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnScanFinished ====
Scanning the audio library has been finished.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Scanning the audio library has been finished.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnScanStarted ====
An audio library scan has started.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "An audio library scan has started.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnUpdate ====
An audio item has been updated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' id
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' transaction ] ''True if the update is being performed within a transaction.''
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "An audio item has been updated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"id": {
"$ref": "Library.Id",
"name": "id",
"required": true
},
"transaction": {
"description": "True if the update is being performed within a transaction.",
"$ref": "Optional.Boolean",
"name": "transaction"
},
"type": {
"type": "string",
"name": "type",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== GUI ===
==== GUI.OnDPMSActivated ====
Energy saving/DPMS has been activated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Energy saving/DPMS has been activated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== GUI.OnDPMSDeactivated ====
Energy saving/DPMS has been deactivated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Energy saving/DPMS has been deactivated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== GUI.OnScreensaverActivated ====
The screensaver has been activated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The screensaver has been activated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== GUI.OnScreensaverDeactivated ====
The screensaver has been deactivated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''boolean'' shuttingdown
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The screensaver has been deactivated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"shuttingdown": {
"type": "boolean",
"name": "shuttingdown",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== Input ===
==== Input.OnInputFinished ====
The user has provided the requested input.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The user has provided the requested input.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Input.OnInputRequested ====
The user is requested to provide some information.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* [ ''string'' title ]
* ''string'' type
* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The user is requested to provide some information.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"title": {
"type": "string",
"name": "title"
},
"type": {
"type": "string",
"name": "type",
"required": true
},
"value": {
"type": "string",
"name": "value",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== Player ===
==== Player.OnPause ====
Playback of a media item has been paused. If there is no ID available extra information will be provided.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# '''' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Playback of a media item has been paused. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== 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:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# '''' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Player.OnPropertyChanged ====
A property of the playing items has changed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
* [ ''[[#Player.Property.Value|Player.Property.Value]]'' property ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A property of the playing items has changed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"player": {
"$ref": "Player.Notifications.Player",
"name": "player",
"required": true
},
"property": {
"$ref": "Player.Property.Value",
"name": "property"
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Player.OnSeek ====
The playback position has been changed. If there is no ID available extra information will be provided.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* [ ''[[#Notifications.Item|Notifications.Item]]'' item ]
* ''[[#Player.Notifications.Player.Seek|Player.Notifications.Player.Seek]]'' player
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The playback position has been changed. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"item": {
"$ref": "Notifications.Item",
"name": "item"
},
"player": {
"$ref": "Player.Notifications.Player.Seek",
"name": "player",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== 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:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# '''' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Player.OnStop ====
Playback of a media item has been stopped. If there is no ID available extra information will be provided.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''boolean'' end ''Whether the player has reached the end of the playable item(s) or not''
* [ ''[[#Notifications.Item|Notifications.Item]]'' item ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Playback of a media item has been stopped. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"end": {
"description": "Whether the player has reached the end of the playable item(s) or not",
"type": "boolean",
"name": "end",
"required": true
},
"item": {
"$ref": "Notifications.Item",
"name": "item"
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== Playlist ===
==== Playlist.OnAdd ====
A playlist item has been added.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* [ ''[[#Notifications.Item|Notifications.Item]]'' item ]
* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
* [ ''[[#Playlist.Position|Playlist.Position]]'' position ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A playlist item has been added.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"item": {
"$ref": "Notifications.Item",
"name": "item"
},
"playlistid": {
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
"position": {
"$ref": "Playlist.Position",
"name": "position"
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Playlist.OnClear ====
A playlist item has been cleared.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A playlist item has been cleared.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Playlist.OnRemove ====
A playlist item has been removed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
* [ ''[[#Playlist.Position|Playlist.Position]]'' position ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A playlist item has been removed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
"position": {
"$ref": "Playlist.Position",
"name": "position"
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== System ===
==== System.OnLowBattery ====
The system is on low battery.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The system is on low battery.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== System.OnQuit ====
Kodi will be closed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''integer'' exitcode
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Kodi will be closed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"exitcode": {
"type": "integer",
"name": "exitcode",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== System.OnRestart ====
The system will be restarted.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The system will be restarted.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== System.OnSleep ====
The system will be suspended.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The system will be suspended.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== System.OnWake ====
The system woke up from suspension.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The system woke up from suspension.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== VideoLibrary ===
==== VideoLibrary.OnCleanFinished ====
The video library has been cleaned.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "The video library has been cleaned.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnCleanStarted ====
A video library clean operation has started.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A video library clean operation has started.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnExport ====
A video library export has finished.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* [ ''integer'' failcount = "0" ]
* [ ''string'' file ]
* [ ''string'' root ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A video library export has finished.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"failcount": {
"default": "0",
"type": "integer",
"name": "failcount"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"root": {
"default": "",
"type": "string",
"name": "root"
}
},
"type": "object",
"name": "data"
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnRemove ====
A video item has been removed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' id
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' transaction ] ''True if the removal is being performed within a transaction.''
* ''[[#Notifications.Library.Video.Type|Notifications.Library.Video.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A video item has been removed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"id": {
"$ref": "Library.Id",
"name": "id",
"required": true
},
"transaction": {
"description": "True if the removal is being performed within a transaction.",
"$ref": "Optional.Boolean",
"name": "transaction"
},
"type": {
"$ref": "Notifications.Library.Video.Type",
"name": "type",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnScanFinished ====
Scanning the video library has been finished.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "Scanning the video library has been finished.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnScanStarted ====
A video library scan has started.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A video library scan has started.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnUpdate ====
A video item has been updated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' id
* [ ''integer'' playcount = "-1" ]
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' transaction ] ''True if the update is being performed within a transaction.''
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"description": "A video item has been updated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"id": {
"$ref": "Library.Id",
"name": "id",
"required": true
},
"playcount": {
"default": "-1",
"type": "integer",
"name": "playcount"
},
"transaction": {
"description": "True if the update is being performed within a transaction.",
"$ref": "Optional.Boolean",
"name": "transaction"
},
"type": {
"type": "string",
"name": "type",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

== See also ==
* [[JSON-RPC API]]
* [[JSON-RPC API/v4|JSON-RPC API v4 (Eden)]]
* [[JSON-RPC API/v6|JSON-RPC API v6 (Frodo - Jarvis)]]

== External links ==
* [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]
* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]

[[Category:Development]]