Archive:JSON-RPC API/v6

2016-03-23T07:44:44Z

Bailus: added v16 (Jarvis)

{{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>
JSONRPC A variety of standard JSONRPC calls
Player Manages all available players
Playlist Playlist modification
Files Shares information
AudioLibrary Audio Library information
VideoLibrary Video Library information
Input Allows limited navigation within Kodi
Application Application information and control
System System controls and information
Favourites Favourites GetFavourites and AddFavourite
Profiles Support for Profiles operations to xbmc.
Settings Allows manipulation of Kodi settings.
Textures with GetTextures and RemoveTexture
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:''' 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 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 = "" ]
</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 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]]''
<br />
'''Properties:'''
* ''string'' addonid
* [ ''string'' disclaimer = "" ]
* [ ''string'' fanart = "" ]
* [ ''mixed'' broken = null ]
* [ ''string'' author = "" ]
* [ ''boolean'' enabled = False ]
* [ ''array'' extrainfo ]
* [ ''string'' thumbnail = "" ]
* [ ''string'' path = "" ]
* [ ''array'' dependencies ]
* ''[[#Addon.Types|Addon.Types]]'' type
* [ ''string'' description = "" ]
* [ ''string'' name = "" ]
* [ ''string'' version = "" ]
* [ ''string'' summary = "" ]
* [ ''integer'' rating = 0 ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"id": "Addon.Details",
"properties": {
"addonid": {
"required": true,
"type": "string"
},
"disclaimer": {
"type": "string",
"default": ""
},
"fanart": {
"type": "string",
"default": ""
},
"broken": {
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
],
"default": null
},
"author": {
"type": "string",
"default": ""
},
"enabled": {
"type": "boolean",
"default": false
},
"extrainfo": {
"items": {
"properties": {
"value": {
"required": true,
"type": "string"
},
"key": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"thumbnail": {
"type": "string",
"default": ""
},
"path": {
"type": "string",
"default": ""
},
"dependencies": {
"items": {
"properties": {
"addonid": {
"required": true,
"type": "string"
},
"version": {
"required": true,
"type": "string"
},
"optional": {
"required": true,
"type": "boolean"
}
},
"type": "object"
},
"type": "array"
},
"type": {
"$ref": "Addon.Types",
"required": true
},
"description": {
"type": "string",
"default": ""
},
"name": {
"type": "string",
"default": ""
},
"version": {
"type": "string",
"default": ""
},
"summary": {
"type": "string",
"default": ""
},
"rating": {
"type": "integer",
"default": 0
}
},
"extends": "Item.Details.Base"
}</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">{
"items": {
"enums": [
"name",
"version",
"summary",
"description",
"path",
"author",
"thumbnail",
"disclaimer",
"fanart",
"dependencies",
"broken",
"extrainfo",
"rating",
"enabled"
],
"type": "string"
},
"id": "Addon.Fields",
"extends": "Item.Fields.Base"
}</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.metadata.scraper.albums",
"xbmc.metadata.scraper.artists",
"xbmc.metadata.scraper.movies",
"xbmc.metadata.scraper.musicvideos",
"xbmc.metadata.scraper.tvshows",
"xbmc.ui.screensaver",
"xbmc.player.musicviz",
"xbmc.python.pluginsource",
"xbmc.python.script",
"xbmc.python.weather",
"xbmc.python.subtitles",
"xbmc.python.lyrics",
"xbmc.gui.skin",
"xbmc.gui.webinterface",
"xbmc.addon.video",
"xbmc.addon.audio",
"xbmc.addon.image",
"xbmc.addon.executable",
"xbmc.service"
],
"id": "Addon.Types",
"type": "string",
"default": "unknown"
}</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:''' ''object''<br />
'''Properties:'''
* [ ''object'' version ]<br />
'''Properties:'''
** ''integer'' minor
** ''string'' tag
** ''integer'' major
** [ ''mixed'' revision = null ]

* [ ''string'' name = "" ]
* [ ''integer'' volume = 0 ]
* [ ''boolean'' muted = False ]
{{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",
"properties": {
"version": {
"properties": {
"minor": {
"minimum": 0,
"required": true,
"type": "integer"
},
"tag": {
"enums": [
"prealpha",
"alpha",
"beta",
"releasecandidate",
"stable"
],
"required": true,
"type": "string"
},
"major": {
"minimum": 0,
"required": true,
"type": "integer"
},
"revision": {
"type": [
{
"type": "string"
},
{
"type": "integer"
}
],
"default": null
}
},
"type": "object"
},
"name": {
"minLength": 1,
"type": "string",
"default": ""
},
"volume": {
"minimum": 0,
"type": "integer",
"default": 0,
"maximum": 100
},
"muted": {
"type": "boolean",
"default": false
}
},
"type": "object"
}</syntaxhighlight>}}

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

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

=== Audio ===
==== Audio.Details.Album ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
<br />
'''Properties:'''
* [ ''[[#Array.String|Array.String]]'' theme ]
* [ ''string'' description = "" ]
* [ ''string'' type = "" ]
* [ ''[[#Array.String|Array.String]]'' style ]
* ''[[#Library.Id|Library.Id]]'' albumid
* [ ''integer'' playcount = 0 ]
* [ ''string'' albumlabel = "" ]
* [ ''[[#Array.String|Array.String]]'' mood ]
{{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.Album",
"properties": {
"theme": {
"$ref": "Array.String"
},
"description": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"style": {
"$ref": "Array.String"
},
"albumid": {
"$ref": "Library.Id",
"required": true
},
"playcount": {
"type": "integer",
"default": 0
},
"albumlabel": {
"type": "string",
"default": ""
},
"mood": {
"$ref": "Array.String"
}
},
"extends": "Audio.Details.Media"
}</syntaxhighlight>}}

==== Audio.Details.Artist ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
<br />
'''Properties:'''
* [ ''string'' born = "" ]
* [ ''string'' formed = "" ]
* [ ''string'' died = "" ]
* [ ''[[#Array.String|Array.String]]'' style ]
* [ ''[[#Array.String|Array.String]]'' yearsactive ]
* [ ''[[#Array.String|Array.String]]'' mood ]
* [ ''string'' musicbrainzartistid = "" ]
* [ ''string'' disbanded = "" ]
* [ ''string'' description = "" ]
* ''string'' artist
* [ ''[[#Array.String|Array.String]]'' instrument ]
* ''[[#Library.Id|Library.Id]]'' artistid
{{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.Artist",
"properties": {
"born": {
"type": "string",
"default": ""
},
"formed": {
"type": "string",
"default": ""
},
"died": {
"type": "string",
"default": ""
},
"style": {
"$ref": "Array.String"
},
"yearsactive": {
"$ref": "Array.String"
},
"mood": {
"$ref": "Array.String"
},
"musicbrainzartistid": {
"type": "string",
"default": ""
},
"disbanded": {
"type": "string",
"default": ""
},
"description": {
"type": "string",
"default": ""
},
"artist": {
"required": true,
"type": "string"
},
"instrument": {
"$ref": "Array.String"
},
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"extends": "Audio.Details.Base"
}</syntaxhighlight>}}

==== Audio.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
<br />
'''Properties:'''
* [ ''[[#Array.String|Array.String]]'' genre ]
{{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.Base",
"properties": {
"genre": {
"$ref": "Array.String"
}
},
"extends": "Media.Details.Base"
}</syntaxhighlight>}}

==== Audio.Details.Media ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
<br />
'''Properties:'''
* [ ''string'' displayartist = "" ]
* [ ''[[#Array.String|Array.String]]'' artist ]
* [ ''[[#Array.Integer|Array.Integer]]'' genreid ]
* [ ''string'' musicbrainzalbumartistid = "" ]
* [ ''integer'' year = 0 ]
* [ ''integer'' rating = 0 ]
* [ ''[[#Array.Integer|Array.Integer]]'' artistid ]
* [ ''string'' title = "" ]
* [ ''string'' musicbrainzalbumid = "" ]
{{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.Media",
"properties": {
"displayartist": {
"type": "string",
"default": ""
},
"artist": {
"$ref": "Array.String"
},
"genreid": {
"$ref": "Array.Integer"
},
"musicbrainzalbumartistid": {
"type": "string",
"default": ""
},
"year": {
"type": "integer",
"default": 0
},
"rating": {
"type": "integer",
"default": 0
},
"artistid": {
"$ref": "Array.Integer"
},
"title": {
"type": "string",
"default": ""
},
"musicbrainzalbumid": {
"type": "string",
"default": ""
}
},
"extends": "Audio.Details.Base"
}</syntaxhighlight>}}

==== Audio.Details.Song ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
<br />
'''Properties:'''
* [ ''string'' lyrics = "" ]
* ''[[#Library.Id|Library.Id]]'' songid
* [ ''[[#Array.Integer|Array.Integer]]'' albumartistid ]
* [ ''integer'' disc = 0 ]
* [ ''string'' comment = "" ]
* [ ''integer'' playcount = 0 ]
* [ ''string'' album = "" ]
* [ ''string'' file = "" ]
* [ ''string'' lastplayed = "" ]
* [ ''[[#Library.Id|Library.Id]]'' albumid = -1 ]
* [ ''string'' musicbrainzartistid = "" ]
* [ ''[[#Array.String|Array.String]]'' albumartist ]
* [ ''integer'' duration = 0 ]
* [ ''string'' musicbrainztrackid = "" ]
* [ ''integer'' track = 0 ]
{{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.Song",
"properties": {
"lyrics": {
"type": "string",
"default": ""
},
"songid": {
"$ref": "Library.Id",
"required": true
},
"albumartistid": {
"$ref": "Array.Integer"
},
"disc": {
"type": "integer",
"default": 0
},
"comment": {
"type": "string",
"default": ""
},
"playcount": {
"type": "integer",
"default": 0
},
"album": {
"type": "string",
"default": ""
},
"file": {
"type": "string",
"default": ""
},
"lastplayed": {
"type": "string",
"default": ""
},
"albumid": {
"$ref": "Library.Id",
"default": -1
},
"musicbrainzartistid": {
"type": "string",
"default": ""
},
"albumartist": {
"$ref": "Array.String"
},
"duration": {
"type": "integer",
"default": 0
},
"musicbrainztrackid": {
"type": "string",
"default": ""
},
"track": {
"type": "integer",
"default": 0
}
},
"extends": "Audio.Details.Media"
}</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">{
"items": {
"enums": [
"title",
"description",
"artist",
"genre",
"theme",
"mood",
"style",
"type",
"albumlabel",
"rating",
"year",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"fanart",
"thumbnail",
"playcount",
"genreid",
"artistid",
"displayartist"
],
"description": "Requesting the genreid and/or artistid field will result in increased response times",
"type": "string"
},
"id": "Audio.Fields.Album",
"extends": "Item.Fields.Base"
}</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">{
"items": {
"enums": [
"instrument",
"style",
"mood",
"born",
"formed",
"description",
"genre",
"died",
"disbanded",
"yearsactive",
"musicbrainzartistid",
"fanart",
"thumbnail"
],
"type": "string"
},
"id": "Audio.Fields.Artist",
"extends": "Item.Fields.Base"
}</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">{
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"thumbnail",
"file",
"albumid",
"lastplayed",
"disc",
"genreid",
"artistid",
"displayartist",
"albumartistid"
],
"description": "Requesting the genreid, artistid and/or albumartistid field will result in increased response times",
"type": "string"
},
"id": "Audio.Fields.Song",
"extends": "Item.Fields.Base"
}</syntaxhighlight>}}

=== Configuration ===
==== Configuration ====
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Configuration.Notifications|Configuration.Notifications]]'' notifications
{{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",
"properties": {
"notifications": {
"$ref": "Configuration.Notifications",
"required": true
}
},
"required": true,
"type": "object"
}</syntaxhighlight>}}

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

=== 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"
],
"id": "GUI.Property.Name",
"type": "string",
"default": "currentwindow"
}</syntaxhighlight>}}

==== GUI.Property.Value ====
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''object'' currentwindow ]<br />
'''Properties:'''
** ''string'' label
** ''integer'' id

* [ ''boolean'' fullscreen = False ]
* [ ''object'' skin ]<br />
'''Properties:'''
** ''string'' id
** [ ''string'' name = "" ]

* [ ''object'' currentcontrol ]<br />
'''Properties:'''
** ''string'' label

{{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",
"properties": {
"currentwindow": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"id": {
"required": true,
"type": "integer"
}
},
"type": "object"
},
"fullscreen": {
"type": "boolean",
"default": false
},
"skin": {
"properties": {
"id": {
"minLength": 1,
"required": true,
"type": "string"
},
"name": {
"type": "string",
"default": ""
}
},
"type": "object"
},
"currentcontrol": {
"properties": {
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}</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",
"files",
"settings",
"music",
"video",
"videos",
"tv",
"pvr",
"pvrguideinfo",
"pvrrecordinginfo",
"pvrtimersetting",
"pvrgroupmanager",
"pvrchannelmanager",
"pvrguidesearch",
"pvrchannelscan",
"pvrupdateprogress",
"pvrosdchannels",
"pvrosdguide",
"pvrosddirector",
"pvrosdcutter",
"pvrosdteletext",
"systeminfo",
"testpattern",
"screencalibration",
"guicalibration",
"picturessettings",
"programssettings",
"weathersettings",
"musicsettings",
"systemsettings",
"videossettings",
"networksettings",
"servicesettings",
"appearancesettings",
"pvrsettings",
"tvsettings",
"scripts",
"videofiles",
"videolibrary",
"videoplaylist",
"loginscreen",
"profiles",
"skinsettings",
"addonbrowser",
"yesnodialog",
"progressdialog",
"virtualkeyboard",
"volumebar",
"submenu",
"favourites",
"contextmenu",
"infodialog",
"numericinput",
"gamepadinput",
"shutdownmenu",
"mutebug",
"playercontrols",
"seekbar",
"musicosd",
"addonsettings",
"visualisationsettings",
"visualisationpresetlist",
"osdvideosettings",
"osdaudiosettings",
"videobookmarks",
"filebrowser",
"networksetup",
"mediasource",
"profilesettings",
"locksettings",
"contentsettings",
"songinformation",
"smartplaylisteditor",
"smartplaylistrule",
"busydialog",
"pictureinfo",
"accesspoints",
"fullscreeninfo",
"karaokeselector",
"karaokelargeselector",
"sliderdialog",
"addoninformation",
"musicplaylist",
"musicfiles",
"musiclibrary",
"musicplaylisteditor",
"teletext",
"selectdialog",
"musicinformation",
"okdialog",
"movieinformation",
"textviewer",
"fullscreenvideo",
"fullscreenlivetv",
"visualisation",
"slideshow",
"filestackingdialog",
"karaoke",
"weather",
"screensaver",
"videoosd",
"videomenu",
"videotimeseek",
"musicoverlay",
"videooverlay",
"startwindow",
"startup",
"peripherals",
"peripheralsettings",
"extendedprogressdialog",
"mediafilter"
],
"id": "GUI.Window",
"type": "string",
"default": "home"
}</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",
"minLength": 1,
"type": "string",
"default": ""
}</syntaxhighlight>}}

==== Global.Time ====
'''Type:''' ''object''<br />
'''Properties:'''
* ''integer'' hours
* ''integer'' milliseconds
* ''integer'' seconds
* ''integer'' minutes
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"additionalProperties": false,
"id": "Global.Time",
"properties": {
"hours": {
"minimum": 0,
"required": true,
"type": "integer",
"maximum": 23
},
"milliseconds": {
"minimum": 0,
"required": true,
"type": "integer",
"maximum": 999
},
"seconds": {
"minimum": 0,
"required": true,
"type": "integer",
"maximum": 59
},
"minutes": {
"minimum": 0,
"required": true,
"type": "integer",
"maximum": 59
}
},
"type": "object"
}</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"
}
],
"default": null
}</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",
"previousmenu",
"info",
"pause",
"stop",
"skipnext",
"skipprevious",
"fullscreen",
"aspectratio",
"stepforward",
"stepback",
"bigstepforward",
"bigstepback",
"osd",
"showsubtitles",
"nextsubtitle",
"codecinfo",
"nextpicture",
"previouspicture",
"zoomout",
"zoomin",
"playlist",
"queue",
"zoomnormal",
"zoomlevel1",
"zoomlevel2",
"zoomlevel3",
"zoomlevel4",
"zoomlevel5",
"zoomlevel6",
"zoomlevel7",
"zoomlevel8",
"zoomlevel9",
"nextcalibration",
"resetcalibration",
"analogmove",
"rotate",
"rotateccw",
"close",
"subtitledelayminus",
"subtitledelay",
"subtitledelayplus",
"audiodelayminus",
"audiodelay",
"audiodelayplus",
"subtitleshiftup",
"subtitleshiftdown",
"subtitlealign",
"audionextlanguage",
"verticalshiftup",
"verticalshiftdown",
"nextresolution",
"audiotoggledigital",
"number0",
"number1",
"number2",
"number3",
"number4",
"number5",
"number6",
"number7",
"number8",
"number9",
"osdleft",
"osdright",
"osdup",
"osddown",
"osdselect",
"osdvalueplus",
"osdvalueminus",
"smallstepback",
"fastforward",
"rewind",
"play",
"playpause",
"delete",
"copy",
"move",
"mplayerosd",
"hidesubmenu",
"screenshot",
"rename",
"togglewatched",
"scanitem",
"reloadkeymaps",
"volumeup",
"volumedown",
"mute",
"backspace",
"scrollup",
"scrolldown",
"analogfastforward",
"analogrewind",
"moveitemup",
"moveitemdown",
"contextmenu",
"shift",
"symbols",
"cursorleft",
"cursorright",
"showtime",
"analogseekforward",
"analogseekback",
"showpreset",
"presetlist",
"nextpreset",
"previouspreset",
"lockpreset",
"randompreset",
"increasevisrating",
"decreasevisrating",
"showvideomenu",
"enter",
"increaserating",
"decreaserating",
"togglefullscreen",
"nextscene",
"previousscene",
"nextletter",
"prevletter",
"jumpsms2",
"jumpsms3",
"jumpsms4",
"jumpsms5",
"jumpsms6",
"jumpsms7",
"jumpsms8",
"jumpsms9",
"filter",
"filterclear",
"filtersms2",
"filtersms3",
"filtersms4",
"filtersms5",
"filtersms6",
"filtersms7",
"filtersms8",
"filtersms9",
"firstpage",
"lastpage",
"guiprofile",
"red",
"green",
"yellow",
"blue",
"increasepar",
"decreasepar",
"volampup",
"volampdown",
"channelup",
"channeldown",
"previouschannelgroup",
"nextchannelgroup",
"leftclick",
"rightclick",
"middleclick",
"doubleclick",
"wheelup",
"wheeldown",
"mousedrag",
"mousemove",
"noop"
],
"id": "Input.Action",
"type": "string",
"default": "left"
}</syntaxhighlight>}}

=== Item ===
==== Item.Details.Base ====
'''Type:''' ''object''<br />
'''Properties:'''
* ''string'' label
{{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",
"properties": {
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
}</syntaxhighlight>}}

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

=== Library ===
==== Library.Details.Genre ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
* [ ''string'' thumbnail = "" ]
* [ ''string'' title = "" ]
* ''[[#Library.Id|Library.Id]]'' genreid
{{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.Details.Genre",
"properties": {
"thumbnail": {
"type": "string",
"default": ""
},
"title": {
"type": "string",
"default": ""
},
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"extends": "Item.Details.Base"
}</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">{
"items": {
"enums": [
"title",
"thumbnail"
],
"type": "string"
},
"id": "Library.Fields.Genre",
"extends": "Item.Fields.Base"
}</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">{
"minimum": 1,
"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">{
"minimum": 0,
"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">{
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"channel",
"channeltype",
"hidden",
"locked",
"channelnumber",
"starttime",
"endtime"
],
"type": "string"
},
"id": "List.Fields.All",
"extends": "Item.Fields.Base"
}</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">{
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"size",
"lastmodified",
"mimetype"
],
"type": "string"
},
"id": "List.Fields.Files",
"extends": "Item.Fields.Base"
}</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": {
"minItems": 1,
"items": {
"$ref": "List.Filter.Albums"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"minItems": 1,
"items": {
"$ref": "List.Filter.Albums"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Albums"
}
]
}</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": {
"minItems": 1,
"items": {
"$ref": "List.Filter.Artists"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"minItems": 1,
"items": {
"$ref": "List.Filter.Artists"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Artists"
}
]
}</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": {
"minItems": 1,
"items": {
"$ref": "List.Filter.Episodes"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"minItems": 1,
"items": {
"$ref": "List.Filter.Episodes"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Episodes"
}
]
}</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",
"type",
"label",
"rating",
"playcount",
"playlist"
],
"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",
"playlist"
],
"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",
"time",
"writers",
"airdate",
"playcount",
"lastplayed",
"inprogress",
"genre",
"year",
"director",
"actor",
"episode",
"season",
"filename",
"path",
"studio",
"mpaarating",
"dateadded",
"videoresolution",
"audiochannels",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist"
],
"id": "List.Filter.Fields.Episodes",
"type": "string",
"default": "title"
}</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",
"time",
"writers",
"playcount",
"lastplayed",
"inprogress",
"genre",
"country",
"year",
"director",
"actor",
"mpaarating",
"top250",
"studio",
"hastrailer",
"filename",
"path",
"set",
"tag",
"dateadded",
"videoresolution",
"audiochannels",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist"
],
"id": "List.Filter.Fields.Movies",
"type": "string",
"default": "title"
}</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",
"time",
"director",
"studio",
"plot",
"dateadded",
"videoresolution",
"audiochannels",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist"
],
"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",
"comment",
"dateadded",
"playlist"
],
"id": "List.Filter.Fields.Songs",
"type": "string",
"default": "genre"
}</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",
"year",
"genre",
"director",
"actor",
"numepisodes",
"numwatched",
"playcount",
"path",
"studio",
"mpaarating",
"dateadded",
"lastplayed",
"inprogress",
"playlist"
],
"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": {
"minItems": 1,
"items": {
"$ref": "List.Filter.Movies"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"minItems": 1,
"items": {
"$ref": "List.Filter.Movies"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Movies"
}
]
}</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": {
"minItems": 1,
"items": {
"$ref": "List.Filter.MusicVideos"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"minItems": 1,
"items": {
"$ref": "List.Filter.MusicVideos"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.MusicVideos"
}
]
}</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:''' ''object''<br />
'''Properties:'''
* ''mixed'' value
* ''[[#List.Filter.Operators|List.Filter.Operators]]'' operator
{{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",
"properties": {
"value": {
"required": true,
"type": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"operator": {
"$ref": "List.Filter.Operators",
"required": true
}
},
"type": "object"
}</syntaxhighlight>}}

==== List.Filter.Rule.Albums ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
* ''[[#List.Filter.Fields.Albums|List.Filter.Fields.Albums]]'' field
{{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.Albums",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Albums",
"required": true
}
},
"extends": "List.Filter.Rule"
}</syntaxhighlight>}}

==== List.Filter.Rule.Artists ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
* ''[[#List.Filter.Fields.Artists|List.Filter.Fields.Artists]]'' field
{{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.Artists",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Artists",
"required": true
}
},
"extends": "List.Filter.Rule"
}</syntaxhighlight>}}

==== List.Filter.Rule.Episodes ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
* ''[[#List.Filter.Fields.Episodes|List.Filter.Fields.Episodes]]'' field
{{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.Episodes",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Episodes",
"required": true
}
},
"extends": "List.Filter.Rule"
}</syntaxhighlight>}}

==== List.Filter.Rule.Movies ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
* ''[[#List.Filter.Fields.Movies|List.Filter.Fields.Movies]]'' field
{{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.Movies",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Movies",
"required": true
}
},
"extends": "List.Filter.Rule"
}</syntaxhighlight>}}

==== List.Filter.Rule.MusicVideos ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
* ''[[#List.Filter.Fields.MusicVideos|List.Filter.Fields.MusicVideos]]'' field
{{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.MusicVideos",
"properties": {
"field": {
"$ref": "List.Filter.Fields.MusicVideos",
"required": true
}
},
"extends": "List.Filter.Rule"
}</syntaxhighlight>}}

==== List.Filter.Rule.Songs ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
* ''[[#List.Filter.Fields.Songs|List.Filter.Fields.Songs]]'' field
{{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.Songs",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Songs",
"required": true
}
},
"extends": "List.Filter.Rule"
}</syntaxhighlight>}}

==== List.Filter.Rule.TVShows ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
* ''[[#List.Filter.Fields.TVShows|List.Filter.Fields.TVShows]]'' field
{{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.TVShows",
"properties": {
"field": {
"$ref": "List.Filter.Fields.TVShows",
"required": true
}
},
"extends": "List.Filter.Rule"
}</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": {
"minItems": 1,
"items": {
"$ref": "List.Filter.Songs"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"minItems": 1,
"items": {
"$ref": "List.Filter.Songs"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Songs"
}
]
}</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": {
"minItems": 1,
"items": {
"$ref": "List.Filter.TVShows"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"minItems": 1,
"items": {
"$ref": "List.Filter.TVShows"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.TVShows"
}
]
}</syntaxhighlight>}}

==== List.Item.All ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
<br />
'''Properties:'''
* [ ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = "tv" ]
* [ ''string'' channel = "" ]
* [ ''string'' starttime = "" ]
* [ ''string'' endtime = "" ]
* [ ''integer'' channelnumber = 0 ]
* [ ''boolean'' hidden = False ]
* [ ''boolean'' locked = False ]
{{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.Item.All",
"properties": {
"channeltype": {
"$ref": "PVR.Channel.Type",
"default": "tv"
},
"channel": {
"type": "string",
"default": ""
},
"starttime": {
"type": "string",
"default": ""
},
"endtime": {
"type": "string",
"default": ""
},
"channelnumber": {
"type": "integer",
"default": 0
},
"hidden": {
"type": "boolean",
"default": false
},
"locked": {
"type": "boolean",
"default": false
}
},
"extends": "List.Item.Base"
}</syntaxhighlight>}}

==== List.Item.Base ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
<br />
'''Properties:'''
* [ ''string'' sorttitle = "" ]
* [ ''string'' productioncode = "" ]
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''string'' votes = "" ]
* [ ''integer'' duration = 0 ]
* [ ''string'' trailer = "" ]
* [ ''[[#Library.Id|Library.Id]]'' albumid = -1 ]
* [ ''string'' musicbrainzartistid = "" ]
* [ ''string'' mpaa = "" ]
* [ ''string'' albumlabel = "" ]
* [ ''string'' originaltitle = "" ]
* [ ''[[#Array.String|Array.String]]'' writer ]
* [ ''[[#Array.Integer|Array.Integer]]'' albumartistid ]
* [ ''string'' type = "unknown" ]
* [ ''integer'' episode = 0 ]
* [ ''string'' firstaired = "" ]
* [ ''string'' showtitle = "" ]
* [ ''[[#Array.String|Array.String]]'' country ]
* [ ''[[#Array.String|Array.String]]'' mood ]
* [ ''string'' set = "" ]
* [ ''string'' musicbrainztrackid = "" ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* [ ''string'' lyrics = "" ]
* [ ''integer'' top250 = 0 ]
* [ ''string'' comment = "" ]
* [ ''string'' premiered = "" ]
* [ ''[[#Array.String|Array.String]]'' showlink ]
* [ ''[[#Array.String|Array.String]]'' style ]
* [ ''string'' album = "" ]
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ]
* [ ''integer'' season = 0 ]
* [ ''[[#Array.String|Array.String]]'' theme ]
* [ ''string'' description = "" ]
* [ ''[[#Library.Id|Library.Id]]'' setid = -1 ]
* [ ''integer'' track = 0 ]
* [ ''string'' tagline = "" ]
* [ ''string'' plotoutline = "" ]
* [ ''integer'' watchedepisodes = 0 ]
* [ ''[[#Library.Id|Library.Id]]'' id = -1 ]
* [ ''integer'' disc = 0 ]
* [ ''[[#Array.String|Array.String]]'' albumartist ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''object'' uniqueid ]
* [ ''string'' episodeguide = "" ]
* [ ''string'' imdbnumber = "" ]
{{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.Item.Base",
"properties": {
"sorttitle": {
"type": "string",
"default": ""
},
"productioncode": {
"type": "string",
"default": ""
},
"cast": {
"$ref": "Video.Cast"
},
"votes": {
"type": "string",
"default": ""
},
"duration": {
"type": "integer",
"default": 0
},
"trailer": {
"type": "string",
"default": ""
},
"albumid": {
"$ref": "Library.Id",
"default": -1
},
"musicbrainzartistid": {
"type": "string",
"default": ""
},
"mpaa": {
"type": "string",
"default": ""
},
"albumlabel": {
"type": "string",
"default": ""
},
"originaltitle": {
"type": "string",
"default": ""
},
"writer": {
"$ref": "Array.String"
},
"albumartistid": {
"$ref": "Array.Integer"
},
"type": {
"enums": [
"unknown",
"movie",
"episode",
"musicvideo",
"song",
"picture",
"channel"
],
"type": "string",
"default": "unknown"
},
"episode": {
"type": "integer",
"default": 0
},
"firstaired": {
"type": "string",
"default": ""
},
"showtitle": {
"type": "string",
"default": ""
},
"country": {
"$ref": "Array.String"
},
"mood": {
"$ref": "Array.String"
},
"set": {
"type": "string",
"default": ""
},
"musicbrainztrackid": {
"type": "string",
"default": ""
},
"tag": {
"$ref": "Array.String"
},
"lyrics": {
"type": "string",
"default": ""
},
"top250": {
"type": "integer",
"default": 0
},
"comment": {
"type": "string",
"default": ""
},
"premiered": {
"type": "string",
"default": ""
},
"showlink": {
"$ref": "Array.String"
},
"style": {
"$ref": "Array.String"
},
"album": {
"type": "string",
"default": ""
},
"tvshowid": {
"$ref": "Library.Id",
"default": -1
},
"season": {
"type": "integer",
"default": 0
},
"theme": {
"$ref": "Array.String"
},
"description": {
"type": "string",
"default": ""
},
"setid": {
"$ref": "Library.Id",
"default": -1
},
"track": {
"type": "integer",
"default": 0
},
"tagline": {
"type": "string",
"default": ""
},
"plotoutline": {
"type": "string",
"default": ""
},
"watchedepisodes": {
"type": "integer",
"default": 0
},
"id": {
"$ref": "Library.Id",
"default": -1
},
"disc": {
"type": "integer",
"default": 0
},
"albumartist": {
"$ref": "Array.String"
},
"studio": {
"$ref": "Array.String"
},
"uniqueid": {
"additionalProperties": {
"minLength": 1,
"type": "string",
"default": ""
},
"type": "object"
},
"episodeguide": {
"type": "string",
"default": ""
},
"imdbnumber": {
"type": "string",
"default": ""
}
},
"extends": [
"Video.Details.File",
"Audio.Details.Media"
]
}</syntaxhighlight>}}

==== List.Item.File ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
<br />
'''Properties:'''
* ''string'' filetype
* [ ''integer'' size = 0 ]
* [ ''string'' mimetype = "" ]
* ''string'' file
* [ ''string'' lastmodified = "" ]
{{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.Item.File",
"properties": {
"filetype": {
"enums": [
"file",
"directory"
],
"required": true,
"type": "string"
},
"size": {
"description": "Size of the file in kB (1000 Byte)",
"type": "integer",
"default": 0
},
"mimetype": {
"type": "string",
"default": ""
},
"file": {
"required": true,
"type": "string"
},
"lastmodified": {
"type": "string",
"default": ""
}
},
"extends": "List.Item.Base"
}</syntaxhighlight>}}

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

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

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

==== List.Sort ====
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''string'' order = "ascending" ]
* [ ''boolean'' ignorearticle = False ]
* [ ''string'' method = "none" ]
{{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",
"properties": {
"order": {
"enums": [
"ascending",
"descending"
],
"type": "string",
"default": "ascending"
},
"ignorearticle": {
"type": "boolean",
"default": false
},
"method": {
"enums": [
"none",
"label",
"date",
"size",
"file",
"path",
"drivetype",
"title",
"track",
"time",
"artist",
"album",
"albumtype",
"genre",
"country",
"year",
"rating",
"votes",
"top250",
"programcount",
"playlist",
"episode",
"season",
"totalepisodes",
"watchedepisodes",
"tvshowstatus",
"tvshowtitle",
"sorttitle",
"productioncode",
"mpaa",
"studio",
"dateadded",
"lastplayed",
"playcount",
"listeners",
"bitrate",
"random"
],
"type": "string",
"default": "none"
}
},
"type": "object"
}</syntaxhighlight>}}

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

==== Media.Details.Base ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
* [ ''string'' fanart = "" ]
* [ ''string'' thumbnail = "" ]
{{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.Details.Base",
"properties": {
"fanart": {
"type": "string",
"default": ""
},
"thumbnail": {
"type": "string",
"default": ""
}
},
"extends": "Item.Details.Base"
}</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": {
"type": "integer",
"default": 0
}
},
"type": "object"
},
{
"description": "A tv episode has a title and may have an episode number, season number and the title of the show it belongs to.",
"properties": {
"showtitle": {
"type": "string",
"default": ""
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
},
"title": {
"required": true,
"type": "string"
},
"episode": {
"type": "integer",
"default": 0
},
"season": {
"type": "integer",
"default": 0
}
},
"type": "object"
},
{
"description": "A music video has a title and may have an album and an artist.",
"properties": {
"album": {
"type": "string",
"default": ""
},
"artist": {
"type": "string",
"default": ""
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
},
"title": {
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"description": "A song has a title and may have an album, an artist and a track number.",
"properties": {
"album": {
"type": "string",
"default": ""
},
"track": {
"type": "integer",
"default": 0
},
"artist": {
"type": "string",
"default": ""
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
},
"title": {
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"description": "A picture has a file path.",
"properties": {
"file": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A PVR channel is either a radio or tv channel and has a title.",
"properties": {
"channeltype": {
"$ref": "PVR.Channel.Type",
"required": true
},
"id": {
"$ref": "Library.Id",
"required": true
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
}
]
}</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"
}
],
"default": null
}</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"
}
],
"default": null
}</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"
}
],
"default": null
}</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"
}
],
"default": null
}</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"
}
],
"default": null
}</syntaxhighlight>}}

==== PVR.Details.Channel ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
* [ ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = "tv" ]
* [ ''string'' thumbnail = "" ]
* [ ''string'' channel = "" ]
* [ ''boolean'' hidden = False ]
* ''[[#Library.Id|Library.Id]]'' channelid
* [ ''boolean'' locked = False ]
* [ ''string'' lastplayed = "" ]
{{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.Details.Channel",
"properties": {
"channeltype": {
"$ref": "PVR.Channel.Type",
"default": "tv"
},
"thumbnail": {
"type": "string",
"default": ""
},
"channel": {
"type": "string",
"default": ""
},
"hidden": {
"type": "boolean",
"default": false
},
"channelid": {
"$ref": "Library.Id",
"required": true
},
"locked": {
"type": "boolean",
"default": false
},
"lastplayed": {
"type": "string",
"default": ""
}
},
"extends": "Item.Details.Base"
}</syntaxhighlight>}}

==== PVR.Details.ChannelGroup ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
* ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype
* ''[[#Library.Id|Library.Id]]'' channelgroupid
{{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.Details.ChannelGroup",
"properties": {
"channeltype": {
"$ref": "PVR.Channel.Type",
"required": true
},
"channelgroupid": {
"$ref": "Library.Id",
"required": true
}
},
"extends": "Item.Details.Base"
}</syntaxhighlight>}}

==== PVR.Details.ChannelGroup.Extended ====
'''Extends:'''
* ''[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]''
<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#PVR.Details.Channel|PVR.Details.Channel]]''[] channels ]
{{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.Details.ChannelGroup.Extended",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"type": "array"
}
},
"extends": "PVR.Details.ChannelGroup"
}</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">{
"items": {
"enums": [
"thumbnail",
"channeltype",
"hidden",
"locked",
"channel",
"lastplayed"
],
"type": "string"
},
"id": "PVR.Fields.Channel",
"extends": "Item.Fields.Base"
}</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:''' ''object''<br />
'''Properties:'''
* [ ''boolean'' scanning = False ]
* [ ''boolean'' recording = False ]
* [ ''boolean'' available = False ]
{{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",
"properties": {
"scanning": {
"type": "boolean",
"default": false
},
"recording": {
"type": "boolean",
"default": false
},
"available": {
"type": "boolean",
"default": false
}
},
"type": "object"
}</syntaxhighlight>}}

=== Player ===
==== Player.Audio.Stream ====
'''Type:''' ''object''<br />
'''Properties:'''
* ''integer'' index
* ''string'' language
* ''string'' name
{{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",
"properties": {
"index": {
"minimum": 0,
"required": true,
"type": "integer"
},
"language": {
"required": true,
"type": "string"
},
"name": {
"required": true,
"type": "string"
}
},
"type": "object"
}</syntaxhighlight>}}

==== Player.Audio.Stream.Extended ====
'''Extends:'''
* ''[[#Player.Audio.Stream|Player.Audio.Stream]]''
<br />
'''Properties:'''
* ''integer'' channels
* ''string'' codec
* ''integer'' bitrate
{{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.Extended",
"properties": {
"channels": {
"required": true,
"type": "integer"
},
"codec": {
"required": true,
"type": "string"
},
"bitrate": {
"required": true,
"type": "integer"
}
},
"extends": "Player.Audio.Stream"
}</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">{
"minimum": 0,
"id": "Player.Id",
"type": "integer",
"default": -1,
"maximum": 2
}</syntaxhighlight>}}

==== Player.Notifications.Data ====
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
* ''[[#Notifications.Item|Notifications.Item]]'' item
{{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",
"properties": {
"player": {
"$ref": "Player.Notifications.Player",
"required": true
},
"item": {
"$ref": "Notifications.Item",
"required": true
}
},
"type": "object"
}</syntaxhighlight>}}

==== Player.Notifications.Player ====
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''integer'' speed = 0 ]
* ''[[#Player.Id|Player.Id]]'' playerid
{{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",
"properties": {
"speed": {
"type": "integer",
"default": 0
},
"playerid": {
"$ref": "Player.Id",
"required": true
}
},
"type": "object"
}</syntaxhighlight>}}

==== Player.Notifications.Player.Seek ====
'''Extends:'''
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]''
<br />
'''Properties:'''
* [ ''[[#Global.Time|Global.Time]]'' seekoffset ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
{{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.Seek",
"properties": {
"seekoffset": {
"$ref": "Global.Time"
},
"time": {
"$ref": "Global.Time"
}
},
"extends": "Player.Notifications.Player"
}</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">{
"minimum": 0,
"id": "Player.Position.Percentage",
"type": "number",
"default": 0,
"maximum": 100
}</syntaxhighlight>}}

==== Player.Position.Time ====
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''integer'' hours = 0 ]
* [ ''integer'' milliseconds = 0 ]
* [ ''integer'' seconds = 0 ]
* [ ''integer'' minutes = 0 ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"additionalProperties": false,
"id": "Player.Position.Time",
"properties": {
"hours": {
"minimum": 0,
"type": "integer",
"default": 0,
"maximum": 23
},
"milliseconds": {
"minimum": 0,
"type": "integer",
"default": 0,
"maximum": 999
},
"seconds": {
"minimum": 0,
"type": "integer",
"default": 0,
"maximum": 59
},
"minutes": {
"minimum": 0,
"type": "integer",
"default": 0,
"maximum": 59
}
},
"type": "object"
}</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"
],
"id": "Player.Property.Name",
"type": "string",
"default": "type"
}</syntaxhighlight>}}

==== Player.Property.Value ====
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''boolean'' canrepeat = False ]
* [ ''boolean'' canmove = False ]
* [ ''boolean'' canshuffle = False ]
* [ ''integer'' speed = 0 ]
* [ ''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage = 0 ]
* [ ''[[#Playlist.Id|Playlist.Id]]'' playlistid = -1 ]
* [ ''[[#Player.Audio.Stream|Player.Audio.Stream]]''[] audiostreams ]
* [ ''[[#Playlist.Position|Playlist.Position]]'' position = -1 ]
* [ ''[[#Player.Repeat|Player.Repeat]]'' repeat = "off" ]
* [ ''[[#Player.Subtitle|Player.Subtitle]]'' currentsubtitle ]
* [ ''boolean'' canrotate = False ]
* [ ''boolean'' canzoom = False ]
* [ ''boolean'' canchangespeed = False ]
* [ ''[[#Player.Type|Player.Type]]'' type = "video" ]
* [ ''boolean'' partymode = False ]
* [ ''[[#Player.Subtitle|Player.Subtitle]]''[] subtitles ]
* [ ''boolean'' canseek = False ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
* [ ''[[#Global.Time|Global.Time]]'' totaltime ]
* [ ''boolean'' shuffled = False ]
* [ ''[[#Player.Audio.Stream.Extended|Player.Audio.Stream.Extended]]'' currentaudiostream ]
* [ ''boolean'' live = False ]
* [ ''boolean'' subtitleenabled = False ]
{{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",
"properties": {
"canrepeat": {
"type": "boolean",
"default": false
},
"canmove": {
"type": "boolean",
"default": false
},
"canshuffle": {
"type": "boolean",
"default": false
},
"speed": {
"type": "integer",
"default": 0
},
"percentage": {
"$ref": "Player.Position.Percentage",
"default": 0
},
"playlistid": {
"$ref": "Playlist.Id",
"default": -1
},
"audiostreams": {
"items": {
"$ref": "Player.Audio.Stream"
},
"type": "array"
},
"position": {
"$ref": "Playlist.Position",
"default": -1
},
"repeat": {
"$ref": "Player.Repeat",
"default": "off"
},
"currentsubtitle": {
"$ref": "Player.Subtitle"
},
"canrotate": {
"type": "boolean",
"default": false
},
"canzoom": {
"type": "boolean",
"default": false
},
"canchangespeed": {
"type": "boolean",
"default": false
},
"type": {
"$ref": "Player.Type",
"default": "video"
},
"partymode": {
"type": "boolean",
"default": false
},
"subtitles": {
"items": {
"$ref": "Player.Subtitle"
},
"type": "array"
},
"canseek": {
"type": "boolean",
"default": false
},
"time": {
"$ref": "Global.Time"
},
"totaltime": {
"$ref": "Global.Time"
},
"shuffled": {
"type": "boolean",
"default": false
},
"currentaudiostream": {
"$ref": "Player.Audio.Stream.Extended"
},
"live": {
"type": "boolean",
"default": false
},
"subtitleenabled": {
"type": "boolean",
"default": false
}
},
"type": "object"
}</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:''' ''object''<br />
'''Properties:'''
* [ ''integer'' speed = 0 ]
{{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",
"properties": {
"speed": {
"type": "integer",
"default": 0
}
},
"required": true,
"type": "object"
}</syntaxhighlight>}}

==== Player.Subtitle ====
'''Type:''' ''object''<br />
'''Properties:'''
* ''integer'' index
* ''string'' language
* ''string'' name
{{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",
"properties": {
"index": {
"minimum": 0,
"required": true,
"type": "integer"
},
"language": {
"required": true,
"type": "string"
},
"name": {
"required": true,
"type": "string"
}
},
"type": "object"
}</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>}}

=== 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">{
"minimum": 0,
"id": "Playlist.Id",
"type": "integer",
"default": -1,
"maximum": 2
}</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"
}
},
"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">{
"minimum": 0,
"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:''' ''object''<br />
'''Properties:'''
* [ ''integer'' size = 0 ]
* [ ''[[#Playlist.Type|Playlist.Type]]'' type = "unknown" ]
{{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",
"properties": {
"size": {
"minimum": 0,
"type": "integer",
"default": 0
},
"type": {
"$ref": "Playlist.Type",
"default": "unknown"
}
},
"type": "object"
}</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>}}

=== 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:''' ''object''<br />
'''Properties:'''
* [ ''boolean'' canshutdown = False ]
* [ ''boolean'' canhibernate = False ]
* [ ''boolean'' cansuspend = False ]
* [ ''boolean'' canreboot = False ]
{{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",
"properties": {
"canshutdown": {
"type": "boolean",
"default": false
},
"canhibernate": {
"type": "boolean",
"default": false
},
"cansuspend": {
"type": "boolean",
"default": false
},
"canreboot": {
"type": "boolean",
"default": false
}
},
"type": "object"
}</syntaxhighlight>}}

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

==== Video.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
<br />
'''Properties:'''
* [ ''[[#Media.Artwork|Media.Artwork]]'' art ]
* [ ''integer'' playcount = 0 ]
{{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.Details.Base",
"properties": {
"art": {
"$ref": "Media.Artwork"
},
"playcount": {
"type": "integer",
"default": 0
}
},
"extends": "Media.Details.Base"
}</syntaxhighlight>}}

==== Video.Details.Episode ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
<br />
'''Properties:'''
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''string'' productioncode = "" ]
* [ ''number'' rating = 0 ]
* [ ''string'' votes = "" ]
* [ ''integer'' episode = 0 ]
* [ ''string'' showtitle = "" ]
* ''[[#Library.Id|Library.Id]]'' episodeid
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ]
* [ ''integer'' season = 0 ]
* [ ''string'' firstaired = "" ]
* [ ''object'' uniqueid ]
* [ ''[[#Array.String|Array.String]]'' writer ]
* [ ''string'' originaltitle = "" ]
{{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.Details.Episode",
"properties": {
"cast": {
"$ref": "Video.Cast"
},
"productioncode": {
"type": "string",
"default": ""
},
"rating": {
"type": "number",
"default": 0
},
"votes": {
"type": "string",
"default": ""
},
"episode": {
"type": "integer",
"default": 0
},
"showtitle": {
"type": "string",
"default": ""
},
"episodeid": {
"$ref": "Library.Id",
"required": true
},
"tvshowid": {
"$ref": "Library.Id",
"default": -1
},
"season": {
"type": "integer",
"default": 0
},
"firstaired": {
"type": "string",
"default": ""
},
"uniqueid": {
"additionalProperties": {
"minLength": 1,
"type": "string",
"default": ""
},
"type": "object"
},
"writer": {
"$ref": "Array.String"
},
"originaltitle": {
"type": "string",
"default": ""
}
},
"extends": "Video.Details.File"
}</syntaxhighlight>}}

==== Video.Details.File ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
<br />
'''Properties:'''
* [ ''[[#Video.Streams|Video.Streams]]'' streamdetails ]
* [ ''[[#Array.String|Array.String]]'' director ]
* [ ''[[#Video.Resume|Video.Resume]]'' resume ]
* [ ''integer'' runtime = 0 ]
{{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.Details.File",
"properties": {
"streamdetails": {
"$ref": "Video.Streams"
},
"director": {
"$ref": "Array.String"
},
"resume": {
"$ref": "Video.Resume"
},
"runtime": {
"description": "Runtime in seconds",
"type": "integer",
"default": 0
}
},
"extends": "Video.Details.Item"
}</syntaxhighlight>}}

==== Video.Details.Item ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
<br />
'''Properties:'''
* [ ''string'' dateadded = "" ]
* [ ''string'' file = "" ]
* [ ''string'' lastplayed = "" ]
* [ ''string'' plot = "" ]
{{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.Details.Item",
"properties": {
"dateadded": {
"type": "string",
"default": ""
},
"file": {
"type": "string",
"default": ""
},
"lastplayed": {
"type": "string",
"default": ""
},
"plot": {
"type": "string",
"default": ""
}
},
"extends": "Video.Details.Media"
}</syntaxhighlight>}}

==== Video.Details.Media ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
<br />
'''Properties:'''
* [ ''string'' title = "" ]
{{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.Details.Media",
"properties": {
"title": {
"type": "string",
"default": ""
}
},
"extends": "Video.Details.Base"
}</syntaxhighlight>}}

==== Video.Details.Movie ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
<br />
'''Properties:'''
* [ ''string'' plotoutline = "" ]
* [ ''string'' sorttitle = "" ]
* ''[[#Library.Id|Library.Id]]'' movieid
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''string'' votes = "" ]
* [ ''[[#Array.String|Array.String]]'' showlink ]
* [ ''integer'' top250 = 0 ]
* [ ''string'' trailer = "" ]
* [ ''integer'' year = 0 ]
* [ ''[[#Array.String|Array.String]]'' country ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''string'' set = "" ]
* [ ''[[#Array.String|Array.String]]'' genre ]
* [ ''string'' mpaa = "" ]
* [ ''[[#Library.Id|Library.Id]]'' setid = -1 ]
* [ ''number'' rating = 0 ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* [ ''string'' tagline = "" ]
* [ ''[[#Array.String|Array.String]]'' writer ]
* [ ''string'' originaltitle = "" ]
* [ ''string'' imdbnumber = "" ]
{{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.Details.Movie",
"properties": {
"plotoutline": {
"type": "string",
"default": ""
},
"sorttitle": {
"type": "string",
"default": ""
},
"movieid": {
"$ref": "Library.Id",
"required": true
},
"cast": {
"$ref": "Video.Cast"
},
"votes": {
"type": "string",
"default": ""
},
"showlink": {
"$ref": "Array.String"
},
"top250": {
"type": "integer",
"default": 0
},
"trailer": {
"type": "string",
"default": ""
},
"year": {
"type": "integer",
"default": 0
},
"country": {
"$ref": "Array.String"
},
"studio": {
"$ref": "Array.String"
},
"set": {
"type": "string",
"default": ""
},
"genre": {
"$ref": "Array.String"
},
"mpaa": {
"type": "string",
"default": ""
},
"setid": {
"$ref": "Library.Id",
"default": -1
},
"rating": {
"type": "number",
"default": 0
},
"tag": {
"$ref": "Array.String"
},
"tagline": {
"type": "string",
"default": ""
},
"writer": {
"$ref": "Array.String"
},
"originaltitle": {
"type": "string",
"default": ""
},
"imdbnumber": {
"type": "string",
"default": ""
}
},
"extends": "Video.Details.File"
}</syntaxhighlight>}}

==== Video.Details.MovieSet ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
<br />
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' setid
{{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.Details.MovieSet",
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"extends": "Video.Details.Media"
}</syntaxhighlight>}}

==== Video.Details.MovieSet.Extended ====
'''Extends:'''
* ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''
<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]
{{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.Details.MovieSet.Extended",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
},
"extends": "Video.Details.MovieSet"
}</syntaxhighlight>}}

==== Video.Details.MusicVideo ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
<br />
'''Properties:'''
* [ ''[[#Array.String|Array.String]]'' genre ]
* [ ''[[#Array.String|Array.String]]'' artist ]
* ''[[#Library.Id|Library.Id]]'' musicvideoid
* [ ''[[#Array.String|Array.String]]'' tag ]
* [ ''string'' album = "" ]
* [ ''integer'' track = 0 ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''integer'' year = 0 ]
{{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.Details.MusicVideo",
"properties": {
"genre": {
"$ref": "Array.String"
},
"artist": {
"$ref": "Array.String"
},
"musicvideoid": {
"$ref": "Library.Id",
"required": true
},
"tag": {
"$ref": "Array.String"
},
"album": {
"type": "string",
"default": ""
},
"track": {
"type": "integer",
"default": 0
},
"studio": {
"$ref": "Array.String"
},
"year": {
"type": "integer",
"default": 0
}
},
"extends": "Video.Details.File"
}</syntaxhighlight>}}

==== Video.Details.Season ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
<br />
'''Properties:'''
* [ ''string'' showtitle = "" ]
* [ ''integer'' watchedepisodes = 0 ]
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ]
* [ ''integer'' episode = 0 ]
* ''integer'' season
{{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.Details.Season",
"properties": {
"showtitle": {
"type": "string",
"default": ""
},
"watchedepisodes": {
"type": "integer",
"default": 0
},
"tvshowid": {
"$ref": "Library.Id",
"default": -1
},
"episode": {
"type": "integer",
"default": 0
},
"season": {
"required": true,
"type": "integer"
}
},
"extends": "Video.Details.Base"
}</syntaxhighlight>}}

==== Video.Details.TVShow ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
<br />
'''Properties:'''
* [ ''string'' sorttitle = "" ]
* [ ''string'' mpaa = "" ]
* [ ''string'' premiered = "" ]
* [ ''integer'' year = 0 ]
* [ ''integer'' episode = 0 ]
* [ ''integer'' watchedepisodes = 0 ]
* [ ''string'' votes = "" ]
* [ ''number'' rating = 0 ]
* ''[[#Library.Id|Library.Id]]'' tvshowid
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''integer'' season = 0 ]
* [ ''[[#Array.String|Array.String]]'' genre ]
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''string'' episodeguide = "" ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* [ ''string'' originaltitle = "" ]
* [ ''string'' imdbnumber = "" ]
{{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.Details.TVShow",
"properties": {
"sorttitle": {
"type": "string",
"default": ""
},
"mpaa": {
"type": "string",
"default": ""
},
"premiered": {
"type": "string",
"default": ""
},
"year": {
"type": "integer",
"default": 0
},
"episode": {
"type": "integer",
"default": 0
},
"watchedepisodes": {
"type": "integer",
"default": 0
},
"votes": {
"type": "string",
"default": ""
},
"rating": {
"type": "number",
"default": 0
},
"tvshowid": {
"$ref": "Library.Id",
"required": true
},
"studio": {
"$ref": "Array.String"
},
"season": {
"type": "integer",
"default": 0
},
"genre": {
"$ref": "Array.String"
},
"cast": {
"$ref": "Video.Cast"
},
"episodeguide": {
"type": "string",
"default": ""
},
"tag": {
"$ref": "Array.String"
},
"originaltitle": {
"type": "string",
"default": ""
},
"imdbnumber": {
"type": "string",
"default": ""
}
},
"extends": "Video.Details.Item"
}</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">{
"items": {
"enums": [
"title",
"plot",
"votes",
"rating",
"writer",
"firstaired",
"playcount",
"runtime",
"director",
"productioncode",
"season",
"episode",
"originaltitle",
"showtitle",
"cast",
"streamdetails",
"lastplayed",
"fanart",
"thumbnail",
"file",
"resume",
"tvshowid",
"dateadded",
"uniqueid",
"art"
],
"description": "Requesting the cast field will result in increased response times",
"type": "string"
},
"id": "Video.Fields.Episode",
"extends": "Item.Fields.Base"
}</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">{
"items": {
"enums": [
"title",
"genre",
"year",
"rating",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"playcount",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"fanart",
"thumbnail",
"file",
"sorttitle",
"resume",
"setid",
"dateadded",
"tag",
"art"
],
"description": "Requesting the cast, showlink and/or tag field will result in increased response times",
"type": "string"
},
"id": "Video.Fields.Movie",
"extends": "Item.Fields.Base"
}</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">{
"items": {
"enums": [
"title",
"playcount",
"fanart",
"thumbnail",
"art"
],
"type": "string"
},
"id": "Video.Fields.MovieSet",
"extends": "Item.Fields.Base"
}</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">{
"items": {
"enums": [
"title",
"playcount",
"runtime",
"director",
"studio",
"year",
"plot",
"album",
"artist",
"genre",
"track",
"streamdetails",
"lastplayed",
"fanart",
"thumbnail",
"file",
"resume",
"dateadded",
"tag",
"art"
],
"type": "string"
},
"id": "Video.Fields.MusicVideo",
"extends": "Item.Fields.Base"
}</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">{
"items": {
"enums": [
"season",
"showtitle",
"playcount",
"episode",
"fanart",
"thumbnail",
"tvshowid",
"watchedepisodes",
"art"
],
"type": "string"
},
"id": "Video.Fields.Season",
"extends": "Item.Fields.Base"
}</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">{
"items": {
"enums": [
"title",
"genre",
"year",
"rating",
"plot",
"studio",
"mpaa",
"cast",
"playcount",
"episode",
"imdbnumber",
"premiered",
"votes",
"lastplayed",
"fanart",
"thumbnail",
"file",
"originaltitle",
"sorttitle",
"episodeguide",
"season",
"watchedepisodes",
"dateadded",
"tag",
"art"
],
"description": "Requesting the cast field will result in increased response times",
"type": "string"
},
"id": "Video.Fields.TVShow",
"extends": "Item.Fields.Base"
}</syntaxhighlight>}}

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

==== Video.Streams ====
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''array''[1..X] video ]
* [ ''array''[1..X] audio ]
* [ ''array''[1..X] subtitle ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
"additionalProperties": false,
"id": "Video.Streams",
"properties": {
"video": {
"minItems": 1,
"items": {
"additionalProperties": false,
"properties": {
"height": {
"type": "integer",
"default": 0
},
"width": {
"type": "integer",
"default": 0
},
"aspect": {
"type": "number",
"default": 0
},
"codec": {
"type": "string",
"default": ""
},
"duration": {
"type": "integer",
"default": 0
}
},
"type": "object"
},
"type": "array"
},
"audio": {
"minItems": 1,
"items": {
"additionalProperties": false,
"properties": {
"channels": {
"type": "integer",
"default": 0
},
"language": {
"type": "string",
"default": ""
},
"codec": {
"type": "string",
"default": ""
}
},
"type": "object"
},
"type": "array"
},
"subtitle": {
"minItems": 1,
"items": {
"additionalProperties": false,
"properties": {
"language": {
"type": "string",
"default": ""
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}</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)]]

== 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]]

Official Kodi Wiki - User contributions [en]

NFO files/Music videos

Archive:JSON-RPC API/v6