Official Kodi Wiki - User contributions [en]

JSON-RPC API/v13.11

2026-05-07T19:25:30Z

Ronie:

{{JSON-RPC_API_nav}}
{{mininav|[[Development]]|[[JSON-RPC API]]}}
Version 13 is the current development version of Kodi's JSON-RPC API and will be published with the release of v22 (Piers).<br />
This document has been updated to version 13.11.0. Recent changes are announced on the [https://forum.kodi.tv/forumdisplay.php?fid=174 forum]

It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.

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

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

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

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

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

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

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

== Error message ==
If Kodi detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is
{|
|
<syntaxhighlight lang="json" 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:

{| class="prettytable" style="margin-right: 10;"
!style="padding-left: 10px; padding-right: 10px;"|Namespace
!style="padding-left: 10px; padding-right: 10px;"|Description
|-
|Addons
|List, enable and execute addons.
|-
|Application
|Application information and control.
|-
|AudioLibrary
|Audio Library information.
|-
|Favourites
|Favourites GetFavourites and AddFavourite.
|-
|Files
|Shares information & filesystem listings.
|-
|GUI
|Window properties and activation.
|-
|Input
|Allows limited navigation within Kodi.
|-
|JSONRPC
|A variety of standard JSONRPC calls.
|-
|PVR
|Live TV control.
|-
|Player
|Manages all available players.
|-
|Playlist
|Playlist modification.
|-
|Profiles
|Support for Profiles operations to Kodi.
|-
|Settings
|Allows manipulation of Kodi settings.
|-
|System
|System controls and information.
|-
|Textures
|Supplies GetTextures and RemoveTexture. Textures are images.
|-
|VideoLibrary
|Video Library information.
|-
|XBMC
|Dumping ground for very Kodi specific operations.
|}
== Methods ==
=== Addons ===
==== Addons.ExecuteAddon ====
Executes the given addon with the given parameters (if possible)<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<br />
# [''mixed: object|array|string'' params = ""]<br />
# [''boolean'' wait = False]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Executes the given addon with the given parameters (if possible)",
"params": [
{
"name": "addonid",
"required": true,
"type": "string"
},
{
"default": "",
"name": "params",
"type": [
{
"additionalProperties": {
"default": "",
"type": "string"
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"description": "URL path (must start with / or ?",
"type": "string"
}
]
},
{
"default": false,
"name": "wait",
"type": "boolean"
}
],
"permission": "ExecuteAddon",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Addon.Fields|Addon.Fields]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#Addon.Details|Addon.Details]]'' addon<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Gets the details of a specific addon",
"params": [
{
"name": "addonid",
"required": true,
"type": "string"
},
{
"$ref": "Addon.Fields",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"addon": {
"$ref": "Addon.Details",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#Addon.Content|Addon.Content]]'' content = unknown] (Content provided by the addon. Only considered for plugins and scripts.)<br />
# [''mixed: boolean|string'' enabled = all]<br />
# [''[[#Addon.Fields|Addon.Fields]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''mixed: boolean|string'' installed = True]<br />
</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:'''
# [''array[ [[#Addon.Details|Addon.Details]] ]'' addons]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Gets all available addons",
"params": [
{
"$ref": "Addon.Types",
"default": "unknown",
"name": "type"
},
{
"$ref": "Addon.Content",
"default": "unknown",
"description": "Content provided by the addon. Only considered for plugins and scripts.",
"name": "content"
},
{
"default": "all",
"name": "enabled",
"type": [
{
"type": "boolean"
},
{
"enums": [
"all"
],
"type": "string"
}
]
},
{
"$ref": "Addon.Fields",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"default": true,
"name": "installed",
"type": [
{
"type": "boolean"
},
{
"enums": [
"all"
],
"type": "string"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"addons": {
"items": {
"$ref": "Addon.Details"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# ''[[#Global.Toggle|Global.Toggle]]'' enabled<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Enables/Disables a specific addon",
"params": [
{
"name": "addonid",
"required": true,
"type": "string"
},
{
"$ref": "Global.Toggle",
"name": "enabled",
"required": true
}
],
"permission": "ManageAddon",
"returns": {
"type": "string"
},
"type": "method"
}
</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">
# ''array[ [[#Application.Property.Name|Application.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Application.Property.Value|Application.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"items": {
"$ref": "Application.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "Application.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== Application.Quit ====
Quit application<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Quit application",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean (Mute state)''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Toggle mute/unmute",
"params": [
{
"$ref": "Global.Toggle",
"name": "mute",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"description": "Mute state",
"type": "boolean"
},
"type": "method"
}
</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: integer|[[#Global.IncrementDecrement|Global.IncrementDecrement]]'' volume<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''integer''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the current volume",
"params": [
{
"name": "volume",
"required": true,
"type": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"$ref": "Global.IncrementDecrement"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "integer"
},
"type": "method"
}
</syntaxhighlight>}}
=== AudioLibrary ===
==== AudioLibrary.Clean ====
Cleans the audio library from non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Cleans the audio library from non-existent items",
"params": [
{
"default": true,
"description": "Whether or not to show the progress bar or any other GUI dialog",
"name": "showdialogs",
"type": "boolean"
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.Export ====
Exports all items from the audio library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''mixed: object|object'' options]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Exports all items from the audio library",
"params": [
{
"name": "options",
"type": [
{
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the directory to where the data should be exported",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"images": {
"default": false,
"description": "Whether to export thumbnails and fanart images",
"type": "boolean"
},
"overwrite": {
"default": false,
"description": "Whether to overwrite existing exported files",
"type": "boolean"
}
},
"type": "object"
}
]
}
],
"permission": "WriteFile",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific album",
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
{
"$ref": "Audio.Fields.Album",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"albumdetails": {
"$ref": "Audio.Details.Album"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetAlbums ====
Retrieve all albums from specified artist (and role) or that has songs of the specified genre<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|object|[[#List.Filter.Albums|List.Filter.Albums]]'' filter]<br />
# [''boolean'' includesingles = False]<br />
# [''boolean'' allroles = False] (Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.)<br />
</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:'''
# [''array[ [[#Audio.Details.Album|Audio.Details.Album]] ]'' albums]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all albums from specified artist (and role) or that has songs of the specified genre",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Song genre. Filter for existence of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Song genre. Filter for existence of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Albums"
}
]
},
{
"default": false,
"name": "includesingles",
"type": "boolean"
},
{
"default": false,
"description": "Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.",
"name": "allroles",
"type": "boolean"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific artist",
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
{
"$ref": "Audio.Fields.Artist",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"artistdetails": {
"$ref": "Audio.Details.Artist"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetArtists ====
Retrieve all artists. For backward compatibility by default this implicitly does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true<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 = None] (Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used)<br />
# [''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|object|object|object|object|object|object|object|object|[[#List.Filter.Artists|List.Filter.Artists]]'' filter]<br />
# [''boolean'' allroles = False] (Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.)<br />
</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:'''
# [''array[ [[#Audio.Details.Artist|Audio.Details.Artist]] ]'' artists]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all artists. For backward compatibility by default this implicitly does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true",
"params": [
{
"$ref": "Optional.Boolean",
"default": null,
"description": "Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used",
"name": "albumartistsonly"
},
{
"$ref": "Audio.Fields.Artist",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Deprecated, use songgenreid. Filter for existence of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songgenreid": {
"$ref": "Library.Id",
"description": "Song genreid. Filter for existence of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songgenreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songgenreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Deprecated, use songgenre. Filter for existence of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songgenre": {
"description": "Song genre. Filter for existence of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songgenre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songgenre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"album": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"description": "Role contributed by artist. Overridden by allroles parameter",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"description": "Role contributed by artist. Overridden by allroles parameter",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Artists"
}
]
},
{
"default": false,
"description": "Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.",
"name": "allroles",
"type": "boolean"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"artists": {
"items": {
"$ref": "Audio.Details.Artist"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetAvailableArt ====
Retrieve all potential art URLs for a media item by art 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">
# ''mixed: object|object'' item<br />
# [''string'' arttype = ""]<br />
</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:'''
# ''array'' availableart<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all potential art URLs for a media item by art type",
"params": [
{
"name": "item",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
},
{
"default": "",
"name": "arttype",
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"availableart": {
"items": {
"properties": {
"arttype": {
"required": true,
"type": "string"
},
"previewurl": {
"default": "",
"description": "URL to a preview thumbnail of the image",
"type": "string"
},
"url": {
"description": "URL to the original image",
"required": true,
"type": "string"
}
},
"type": "object"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetAvailableArtTypes ====
Retrieve a list of potential art types for a media 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">
# ''mixed: object|object'' item<br />
</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:'''
# ''array'' availablearttypes<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve a list of potential art types for a media item",
"params": [
{
"name": "item",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"availablearttypes": {
"items": {
"type": "string"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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:'''
# ''array[ [[#Library.Details.Genre|Library.Details.Genre]] ]'' genres<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all genres",
"params": [
{
"$ref": "Library.Fields.Genre",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"genres": {
"items": {
"$ref": "Library.Details.Genre"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetProperties ====
Retrieves the values of the music library properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[ [[#Audio.Property.Name|Audio.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Audio.Property.Value|Audio.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the music library properties",
"params": [
{
"items": {
"$ref": "Audio.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "Audio.Property.Value"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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:'''
# [''array[ [[#Audio.Details.Album|Audio.Details.Album]] ]'' albums]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve recently added albums",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetRecentlyAddedSongs ====
Retrieve recently added songs<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#List.Amount|List.Amount]]'' albumlimit = -1] (The amount of recently added albums from which to return the songs)<br />
# [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# [''array[ [[#Audio.Details.Song|Audio.Details.Song]] ]'' songs]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve recently added songs",
"params": [
{
"$ref": "List.Amount",
"default": -1,
"description": "The amount of recently added albums from which to return the songs",
"name": "albumlimit"
},
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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:'''
# [''array[ [[#Audio.Details.Album|Audio.Details.Album]] ]'' albums]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve recently played albums",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# [''array[ [[#Audio.Details.Song|Audio.Details.Song]] ]'' songs]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve recently played songs",
"params": [
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetRoles ====
Retrieve all contributor roles<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Audio.Fields.Role|Audio.Fields.Role]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# ''array[ [[#Audio.Details.Role|Audio.Details.Role]] ]'' roles<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all contributor roles",
"params": [
{
"$ref": "Audio.Fields.Role",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"roles": {
"items": {
"$ref": "Audio.Details.Role"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific song",
"params": [
{
"$ref": "Library.Id",
"name": "songid",
"required": true
},
{
"$ref": "Audio.Fields.Song",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"songdetails": {
"$ref": "Audio.Details.Song"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|object|object|object|[[#List.Filter.Songs|List.Filter.Songs]]'' filter]<br />
# [''boolean'' includesingles = True] (Only songs from albums are returned when false, but overridden when singlesonly parameter is true)<br />
# [''boolean'' allroles = False] (Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.)<br />
# [''boolean'' singlesonly = False] (Only singles are returned when true, and overrides includesingles parameter)<br />
</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<br />
# [''array[ [[#Audio.Details.Song|Audio.Details.Song]] ]'' songs]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all songs from specified album, artist or genre",
"params": [
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Song genre. Filter for existence of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Song genre. Filter for existence of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"album": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Songs"
}
]
},
{
"default": true,
"description": "Only songs from albums are returned when false, but overridden when singlesonly parameter is true",
"name": "includesingles",
"type": "boolean"
},
{
"default": false,
"description": "Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.",
"name": "allroles",
"type": "boolean"
},
{
"default": false,
"description": "Only singles are returned when true, and overrides includesingles parameter",
"name": "singlesonly",
"type": "boolean"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetSources ====
Get all music sources, including unique ID<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.Source|Library.Fields.Source]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# ''array[ [[#Library.Details.Source|Library.Details.Source]] ]'' sources<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get all music sources, including unique ID",
"params": [
{
"$ref": "Library.Fields.Source",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sources": {
"items": {
"$ref": "Library.Details.Source"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.RefreshAlbum ====
Refresh the additional information for the given album<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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the additional information for the given album",
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.RefreshArtist ====
Refresh the additional information for the given artist<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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the additional information for the given artist",
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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 = ""]<br />
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Scans the audio sources for new library items",
"params": [
{
"default": "",
"name": "directory",
"type": "string"
},
{
"default": true,
"description": "Whether or not to show the progress bar or any other GUI dialog",
"name": "showdialogs",
"type": "boolean"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br />
# [''[[#Optional.String|Optional.String]]'' description = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' theme = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' mood = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' style = None]<br />
# [''[[#Optional.String|Optional.String]]'' type = None]<br />
# [''[[#Optional.String|Optional.String]]'' albumlabel = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' year = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainzalbumid = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainzreleasegroupid = None]<br />
# [''[[#Optional.String|Optional.String]]'' sortartist = None]<br />
# [''[[#Optional.String|Optional.String]]'' displayartist = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' musicbrainzalbumartistid = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.Boolean|Optional.Boolean]]'' isboxset = None]<br />
# [''[[#Optional.String|Optional.String]]'' releasedate = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaldate = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given album with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"default": null,
"name": "artist",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "description"
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "theme",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "mood",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "style",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "type"
},
{
"$ref": "Optional.String",
"default": null,
"name": "albumlabel"
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "year"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainzalbumid"
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainzreleasegroupid"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sortartist"
},
{
"$ref": "Optional.String",
"default": null,
"name": "displayartist"
},
{
"default": null,
"name": "musicbrainzalbumartistid",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.Boolean",
"default": null,
"name": "isboxset"
},
{
"$ref": "Optional.String",
"default": null,
"name": "releasedate"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaldate"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Optional.String|Optional.String]]'' artist = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' instrument = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' style = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' mood = None]<br />
# [''[[#Optional.String|Optional.String]]'' born = None]<br />
# [''[[#Optional.String|Optional.String]]'' formed = None]<br />
# [''[[#Optional.String|Optional.String]]'' description = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.String|Optional.String]]'' died = None]<br />
# [''[[#Optional.String|Optional.String]]'' disbanded = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' yearsactive = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainzartistid = None]<br />
# [''[[#Optional.String|Optional.String]]'' sortname = None]<br />
# [''[[#Optional.String|Optional.String]]'' type = None]<br />
# [''[[#Optional.String|Optional.String]]'' gender = None]<br />
# [''[[#Optional.String|Optional.String]]'' disambiguation = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given artist with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "artist"
},
{
"default": null,
"name": "instrument",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "style",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "mood",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "born"
},
{
"$ref": "Optional.String",
"default": null,
"name": "formed"
},
{
"$ref": "Optional.String",
"default": null,
"name": "description"
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "died"
},
{
"$ref": "Optional.String",
"default": null,
"name": "disbanded"
},
{
"default": null,
"name": "yearsactive",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainzartistid"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sortname"
},
{
"$ref": "Optional.String",
"default": null,
"name": "type"
},
{
"$ref": "Optional.String",
"default": null,
"name": "gender"
},
{
"$ref": "Optional.String",
"default": null,
"name": "disambiguation"
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' year = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' track = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' disc = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' duration = None]<br />
# [''[[#Optional.String|Optional.String]]'' comment = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainztrackid = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainzartistid = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' displayartist = None]<br />
# [''[[#Optional.String|Optional.String]]'' sortartist = None]<br />
# [''[[#Optional.String|Optional.String]]'' mood = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.String|Optional.String]]'' disctitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' releasedate = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaldate = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' bpm = None]<br />
# [''[[#Optional.String|Optional.String]]'' songvideourl = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given song with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "songid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"default": null,
"name": "artist",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "year"
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "track"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "disc"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "duration"
},
{
"$ref": "Optional.String",
"default": null,
"name": "comment"
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainztrackid"
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainzartistid"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "displayartist"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sortartist"
},
{
"$ref": "Optional.String",
"default": null,
"name": "mood"
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "disctitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "releasedate"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaldate"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "bpm"
},
{
"$ref": "Optional.String",
"default": null,
"name": "songvideourl"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Favourites ===
==== Favourites.AddFavourite ====
Add a favourite with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' title<br />
# ''[[#Favourite.Type|Favourite.Type]]'' type<br />
# [''[[#Optional.String|Optional.String]]'' path = None] (Required for media, script and androidapp favourites types)<br />
# [''[[#Optional.String|Optional.String]]'' window = None] (Required for window favourite type)<br />
# [''[[#Optional.String|Optional.String]]'' windowparameter = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Add a favourite with the given details",
"params": [
{
"name": "title",
"required": true,
"type": "string"
},
{
"$ref": "Favourite.Type",
"name": "type",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"description": "Required for media, script and androidapp favourites types",
"name": "path"
},
{
"$ref": "Optional.String",
"default": null,
"description": "Required for window favourite type",
"name": "window"
},
{
"$ref": "Optional.String",
"default": null,
"name": "windowparameter"
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Favourites.GetFavourites ====
Retrieve all favourites<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''mixed: null|[[#Favourite.Type|Favourite.Type]]'' type = None]<br />
# [''[[#Favourite.Fields.Favourite|Favourite.Fields.Favourite]]'' properties]<br />
</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:'''
# [''array[ [[#Favourite.Details.Favourite|Favourite.Details.Favourite]] ]'' favourites]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all favourites",
"params": [
{
"default": null,
"name": "type",
"type": [
{
"type": "null"
},
{
"$ref": "Favourite.Type"
}
]
},
{
"$ref": "Favourite.Fields.Favourite",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"favourites": {
"items": {
"$ref": "Favourite.Details.Favourite"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''any''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Downloads the given file",
"params": [
{
"name": "path",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"type": "any"
},
"type": "method"
}
</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<br />
# [''[[#Files.Media|Files.Media]]'' media = files]<br />
# [''[[#List.Fields.Files|List.Fields.Files]]'' properties]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''[[#List.Limits|List.Limits]]'' limits] (Limits are applied after getting the directory content thus retrieval is not faster when they are applied.)<br />
</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:'''
# ''array[ [[#List.Item.File|List.Item.File]] ]'' files<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get the directories and files in the given directory",
"params": [
{
"name": "directory",
"required": true,
"type": "string"
},
{
"$ref": "Files.Media",
"default": "files",
"name": "media"
},
{
"$ref": "List.Fields.Files",
"name": "properties"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"$ref": "List.Limits",
"description": "Limits are applied after getting the directory content thus retrieval is not faster when they are applied.",
"name": "limits"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"files": {
"items": {
"$ref": "List.Item.File"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Files.GetFileDetails ====
Get details for a specific file<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file (Full path to the file)<br />
# [''[[#Files.Media|Files.Media]]'' media = files]<br />
# [''[[#List.Fields.Files|List.Fields.Files]]'' properties]<br />
</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<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get details for a specific file",
"params": [
{
"description": "Full path to the file",
"name": "file",
"required": true,
"type": "string"
},
{
"$ref": "Files.Media",
"default": "files",
"name": "media"
},
{
"$ref": "List.Fields.Files",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"filedetails": {
"$ref": "List.Item.File",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# ''[[#List.Items.Sources|List.Items.Sources]]'' sources<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get the sources of the media windows",
"params": [
{
"$ref": "Files.Media",
"name": "media",
"required": true
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sources": {
"$ref": "List.Items.Sources",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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<br />
</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:'''
# ''any'' details (Transport specific details on how/from where to download the given file)<br />
# ''string'' mode (Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol)<br />
# ''string'' protocol<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Provides a way to download a given file (e.g. providing an URL to the real file location)",
"params": [
{
"name": "path",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"details": {
"description": "Transport specific details on how/from where to download the given file",
"required": true,
"type": "any"
},
"mode": {
"description": "Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol",
"enums": [
"redirect",
"direct"
],
"required": true,
"type": "string"
},
"protocol": {
"enums": [
"http"
],
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Files.SetFileDetails ====
Update the given specific file with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file (Full path to the file)<br />
# ''[[#Files.Media|Files.Media]]'' media (File type to update correct database. Currently only "video" is supported.)<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None] (Setting a valid lastplayed without a playcount will force playcount to 1.)<br />
# [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given specific file with the given details",
"params": [
{
"description": "Full path to the file",
"name": "file",
"required": true,
"type": "string"
},
{
"$ref": "Files.Media",
"description": "File type to update correct database. Currently only \"video\" is supported.",
"name": "media",
"required": true
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.String",
"default": null,
"description": "Setting a valid lastplayed without a playcount will force playcount to 1.",
"name": "lastplayed"
},
{
"default": null,
"name": "resume",
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== GUI ===
==== GUI.ActivateScreenSaver ====
Activates currently used screensaver<br />
'''Permissions:'''
* ControlGUI
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Activates currently used screensaver",
"params": [],
"permission": "ControlGUI",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== 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<br />
# [''array[string]'' parameters]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Activates the given window",
"params": [
{
"$ref": "GUI.Window",
"name": "window",
"required": true
},
{
"items": {
"minLength": 1,
"type": "string"
},
"minItems": 1,
"name": "parameters",
"type": "array"
}
],
"permission": "ControlGUI",
"returns": {
"type": "string"
},
"type": "method"
}
</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">
# ''array[ [[#GUI.Property.Name|GUI.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#GUI.Property.Value|GUI.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"items": {
"$ref": "GUI.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "GUI.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== GUI.GetStereoscopicModes ====
Returns the supported stereoscopic modes of the GUI<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]] ]'' stereoscopicmodes]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Returns the supported stereoscopic modes of the GUI",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"stereoscopicmodes": {
"items": {
"$ref": "GUI.Stereoscopy.Mode"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean (Fullscreen state)''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Toggle fullscreen/GUI",
"params": [
{
"$ref": "Global.Toggle",
"name": "fullscreen",
"required": true
}
],
"permission": "ControlGUI",
"returns": {
"description": "Fullscreen state",
"type": "boolean"
},
"type": "method"
}
</syntaxhighlight>}}
==== GUI.SetStereoscopicMode ====
Sets the stereoscopic mode of the GUI to the given mode<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' mode<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Sets the stereoscopic mode of the GUI to the given mode",
"params": [
{
"enums": [
"toggle",
"tomono",
"next",
"previous",
"select",
"off",
"split_vertical",
"split_horizontal",
"row_interleaved",
"hardware_based",
"anaglyph_cyan_red",
"anaglyph_green_magenta",
"monoscopic"
],
"name": "mode",
"required": true,
"type": "string"
}
],
"permission": "ControlGUI",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''string'' message<br />
# [''mixed: string|string'' image = ""]<br />
# [''integer'' displaytime = 5000] (The time in milliseconds the notification will be visible)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shows a GUI notification",
"params": [
{
"name": "title",
"required": true,
"type": "string"
},
{
"name": "message",
"required": true,
"type": "string"
},
{
"default": "",
"name": "image",
"type": [
{
"enums": [
"info",
"warning",
"error"
],
"type": "string"
},
{
"type": "string"
}
]
},
{
"default": 5000,
"description": "The time in milliseconds the notification will be visible",
"minimum": 1500,
"name": "displaytime",
"type": "integer"
}
],
"permission": "ControlGUI",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Input ===
==== Input.Back ====
Goes back in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Goes back in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ButtonEvent ====
Send a button press event<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'' button (Button name)<br />
# ''string'' keymap (Keymap name (KB, XG, R1, or R2))<br />
# [''integer'' holdtime = 0] (Number of milliseconds to simulate button hold.)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Send a button press event",
"params": [
{
"description": "Button name",
"name": "button",
"required": true,
"type": "string"
},
{
"description": "Keymap name (KB, XG, R1, or R2)",
"enums": [
"KB",
"XG",
"R1",
"R2"
],
"name": "keymap",
"required": true,
"type": "string"
},
{
"default": 0,
"description": "Number of milliseconds to simulate button hold.",
"minimum": 0,
"name": "holdtime",
"type": "integer"
}
],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ContextMenu ====
Shows the context menu<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shows the context menu",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Down ====
Navigate down in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Navigate down in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Execute a specific action",
"params": [
{
"$ref": "Input.Action",
"name": "action",
"required": true
}
],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Home ====
Goes to home window in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Goes to home window in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Info ====
Shows the information dialog<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shows the information dialog",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Left ====
Navigate left in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Navigate left in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Right ====
Navigate right in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Navigate right in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Select ====
Select current item in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Select current item in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.SendText ====
Send a generic (unicode) text<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' text (Unicode text)<br />
# [''boolean'' done = True] (Whether this is the whole input or not (closes an open input dialog if true).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Send a generic (unicode) text",
"params": [
{
"description": "Unicode text",
"name": "text",
"required": true,
"type": "string"
},
{
"default": true,
"description": "Whether this is the whole input or not (closes an open input dialog if true).",
"name": "done",
"type": "boolean"
}
],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ShowCodec ====
Show codec information of the playing item<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Show codec information of the playing item",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ShowOSD ====
Show the on-screen display for the current player<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Show the on-screen display for the current player",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ShowPlayerProcessInfo ====
Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Up ====
Navigate up in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Navigate up in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== JSONRPC ===
==== JSONRPC.GetConfiguration ====
Get client-specific configurations<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Configuration|Configuration]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get client-specific configurations",
"params": [],
"permission": "ReadData",
"returns": {
"$ref": "Configuration"
},
"type": "method"
}
</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]<br />
# [''boolean'' getmetadata = False]<br />
# [''boolean'' filterbytransport = True]<br />
# [''object'' filter]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Enumerates all actions and descriptions",
"params": [
{
"default": true,
"name": "getdescriptions",
"type": "boolean"
},
{
"default": false,
"name": "getmetadata",
"type": "boolean"
},
{
"default": true,
"name": "filterbytransport",
"type": "boolean"
},
{
"name": "filter",
"properties": {
"getreferences": {
"default": true,
"description": "Whether or not to print the schema for referenced types",
"type": "boolean"
},
"id": {
"description": "Name of a namespace, method or type",
"required": true,
"type": "string"
},
"type": {
"description": "Type of the given name",
"enums": [
"method",
"namespace",
"type",
"notification"
],
"required": true,
"type": "string"
}
},
"type": "object"
}
],
"permission": "ReadData",
"returns": {
"additionalProperties": false,
"type": "object"
},
"type": "method"
}
</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<br />
# ''string'' message<br />
# [''any'' data = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''any''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Notify all other connected clients",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "message",
"required": true,
"type": "string"
},
{
"default": null,
"name": "data",
"type": "any"
}
],
"permission": "ReadData",
"returns": {
"type": "any"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.Permission ====
Retrieve the clients permissions<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''boolean'' controlgui<br />
# ''boolean'' controlnotify<br />
# ''boolean'' controlplayback<br />
# ''boolean'' controlpower<br />
# ''boolean'' controlpvr<br />
# ''boolean'' controlsystem<br />
# ''boolean'' executeaddon<br />
# ''boolean'' manageaddon<br />
# ''boolean'' navigate<br />
# ''boolean'' readdata<br />
# ''boolean'' removedata<br />
# ''boolean'' updatedata<br />
# ''boolean'' writefile<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve the clients permissions",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"controlgui": {
"required": true,
"type": "boolean"
},
"controlnotify": {
"required": true,
"type": "boolean"
},
"controlplayback": {
"required": true,
"type": "boolean"
},
"controlpower": {
"required": true,
"type": "boolean"
},
"controlpvr": {
"required": true,
"type": "boolean"
},
"controlsystem": {
"required": true,
"type": "boolean"
},
"executeaddon": {
"required": true,
"type": "boolean"
},
"manageaddon": {
"required": true,
"type": "boolean"
},
"navigate": {
"required": true,
"type": "boolean"
},
"readdata": {
"required": true,
"type": "boolean"
},
"removedata": {
"required": true,
"type": "boolean"
},
"updatedata": {
"required": true,
"type": "boolean"
},
"writefile": {
"required": true,
"type": "boolean"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.Ping ====
Ping responder<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Ping responder",
"params": [],
"permission": "ReadData",
"returns": {
"type": "string"
},
"type": "method"
}
</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 />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Configuration|Configuration]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Change the client-specific configuration",
"params": [
{
"name": "notifications",
"properties": {
"application": {
"$ref": "Optional.Boolean",
"default": null
},
"audiolibrary": {
"$ref": "Optional.Boolean",
"default": null
},
"gui": {
"$ref": "Optional.Boolean",
"default": null
},
"input": {
"$ref": "Optional.Boolean",
"default": null
},
"other": {
"$ref": "Optional.Boolean",
"default": null
},
"player": {
"$ref": "Optional.Boolean",
"default": null
},
"playlist": {
"$ref": "Optional.Boolean",
"default": null
},
"system": {
"$ref": "Optional.Boolean",
"default": null
},
"videolibrary": {
"$ref": "Optional.Boolean",
"default": null
}
},
"type": "object"
}
],
"permission": "ControlNotify",
"returns": {
"$ref": "Configuration"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.Version ====
Retrieve the JSON-RPC protocol version.<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''object'' version<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve the JSON-RPC protocol version.",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"version": {
"properties": {
"major": {
"description": "Bumped on backwards incompatible changes to the API definition",
"minimum": 0,
"required": true,
"type": "integer"
},
"minor": {
"description": "Bumped on backwards compatible additions/changes to the API definition",
"minimum": 0,
"required": true,
"type": "integer"
},
"patch": {
"description": "Bumped on any changes to the internal implementation but not to the API definition",
"minimum": 0,
"required": true,
"type": "integer"
}
},
"required": true,
"type": "object"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
=== PVR ===
==== PVR.AddTimer ====
Adds a timer to record the given show one times or a timer rule to record all showings of the given show or adds a reminder timer or reminder timer rule<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid (the broadcast id of the item to record)<br />
# [''boolean'' timerrule = False] (controls whether to create a timer rule or a onetime timer)<br />
# [''boolean'' reminder = False] (controls whether to create a reminder timer or a recording timer)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Adds a timer to record the given show one times or a timer rule to record all showings of the given show or adds a reminder timer or reminder timer rule",
"params": [
{
"$ref": "Library.Id",
"description": "the broadcast id of the item to record",
"name": "broadcastid",
"required": true
},
{
"default": false,
"description": "controls whether to create a timer rule or a onetime timer",
"name": "timerrule",
"type": "boolean"
},
{
"default": false,
"description": "controls whether to create a reminder timer or a recording timer",
"name": "reminder",
"type": "boolean"
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.DeleteTimer ====
Deletes a onetime timer or a timer rule<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' timerid (the id of the onetime timer or timer rule to delete)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Deletes a onetime timer or a timer rule",
"params": [
{
"$ref": "Library.Id",
"description": "the id of the onetime timer or timer rule to delete",
"name": "timerid",
"required": true
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetBroadcastDetails ====
Retrieves the details of a specific broadcast<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid<br />
# [''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific broadcast",
"params": [
{
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
{
"$ref": "PVR.Fields.Broadcast",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"broadcastdetails": {
"$ref": "PVR.Details.Broadcast"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetBroadcastIsPlayable ====
Retrieves whether or not a broadcast is playable<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid (the id of the broadcast to check for playability)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves whether or not a broadcast is playable",
"params": [
{
"$ref": "Library.Id",
"description": "the id of the broadcast to check for playability",
"name": "broadcastid",
"required": true
}
],
"permission": "ReadData",
"returns": {
"type": "boolean"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetBroadcasts ====
Retrieves the program of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid<br />
# [''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
</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:'''
# ''array[ [[#PVR.Details.Broadcast|PVR.Details.Broadcast]] ]'' broadcasts<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the program of a specific channel",
"params": [
{
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
{
"$ref": "PVR.Fields.Broadcast",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"broadcasts": {
"items": {
"$ref": "PVR.Details.Broadcast"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetChannelDetails ====
Retrieves the details of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid<br />
# [''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific channel",
"params": [
{
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
{
"$ref": "PVR.Fields.Channel",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"channeldetails": {
"$ref": "PVR.Details.Channel"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''object'' channels]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific channel group",
"params": [
{
"$ref": "PVR.ChannelGroup.Id",
"name": "channelgroupid",
"required": true
},
{
"name": "channels",
"properties": {
"limits": {
"$ref": "List.Limits"
},
"properties": {
"$ref": "PVR.Fields.Channel"
}
},
"type": "object"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"channelgroupdetails": {
"$ref": "PVR.Details.ChannelGroup.Extended"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
</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:'''
# ''array[ [[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]] ]'' channelgroups<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the channel groups for the specified type",
"params": [
{
"$ref": "PVR.Channel.Type",
"name": "channeltype",
"required": true
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"channelgroups": {
"items": {
"$ref": "PVR.Details.ChannelGroup"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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:'''
# ''array[ [[#PVR.Details.Channel|PVR.Details.Channel]] ]'' channels<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the channel list",
"params": [
{
"$ref": "PVR.ChannelGroup.Id",
"name": "channelgroupid",
"required": true
},
{
"$ref": "PVR.Fields.Channel",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetClients ====
Retrieves the enabled PVR clients and their capabilities<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.Limits|List.Limits]]'' limits]<br />
</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:'''
# ''array[ [[#PVR.Details.Client|PVR.Details.Client]] ]'' clients<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the enabled PVR clients and their capabilities",
"params": [
{
"$ref": "List.Limits",
"name": "limits"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"clients": {
"items": {
"$ref": "PVR.Details.Client"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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">
# ''array[ [[#PVR.Property.Name|PVR.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#PVR.Property.Value|PVR.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"items": {
"$ref": "PVR.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "PVR.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetRecordingDetails ====
Retrieves the details of a specific recording<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' recordingid<br />
# [''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#PVR.Details.Recording|PVR.Details.Recording]]'' recordingdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific recording",
"params": [
{
"$ref": "Library.Id",
"name": "recordingid",
"required": true
},
{
"$ref": "PVR.Fields.Recording",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"recordingdetails": {
"$ref": "PVR.Details.Recording"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetRecordings ====
Retrieves the recordings<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# ''array[ [[#PVR.Details.Recording|PVR.Details.Recording]] ]'' recordings<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the recordings",
"params": [
{
"$ref": "PVR.Fields.Recording",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"recordings": {
"items": {
"$ref": "PVR.Details.Recording"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetTimerDetails ====
Retrieves the details of a specific timer<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' timerid<br />
# [''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#PVR.Details.Timer|PVR.Details.Timer]]'' timerdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific timer",
"params": [
{
"$ref": "Library.Id",
"name": "timerid",
"required": true
},
{
"$ref": "PVR.Fields.Timer",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"timerdetails": {
"$ref": "PVR.Details.Timer"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetTimers ====
Retrieves the timers<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# ''array[ [[#PVR.Details.Timer|PVR.Details.Timer]] ]'' timers<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the timers",
"params": [
{
"$ref": "PVR.Fields.Timer",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"timers": {
"items": {
"$ref": "PVR.Details.Timer"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''mixed: string|[[#Library.Id|Library.Id]]'' channel = current]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Toggle recording of a channel",
"params": [
{
"$ref": "Global.Toggle",
"default": "toggle",
"name": "record"
},
{
"default": "current",
"name": "channel",
"type": [
{
"enums": [
"current"
],
"type": "string"
},
{
"$ref": "Library.Id"
}
]
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.Scan ====
Starts a channel scan<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Library.Id|Library.Id]]'' clientid = -1] (Specify a PVR client id to avoid UI dialog, optional in kodi 19, required in kodi 20)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Starts a channel scan",
"params": [
{
"$ref": "Library.Id",
"default": -1,
"description": "Specify a PVR client id to avoid UI dialog, optional in kodi 19, required in kodi 20",
"name": "clientid"
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.ToggleTimer ====
Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid (the broadcast id of the item to toggle a onetime timer or time rule for)<br />
# [''boolean'' timerrule = False] (controls whether to create / delete a timer rule or a onetime timer)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created",
"params": [
{
"$ref": "Library.Id",
"description": "the broadcast id of the item to toggle a onetime timer or time rule for",
"name": "broadcastid",
"required": true
},
{
"default": false,
"description": "controls whether to create / delete a timer rule or a onetime timer",
"name": "timerrule",
"type": "boolean"
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Player ===
==== Player.AddSubtitle ====
Add subtitle to 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<br />
# ''string'' subtitle (Local path or remote URL to the subtitle file to load)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Add subtitle to the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"description": "Local path or remote URL to the subtitle file to load",
"name": "subtitle",
"required": true,
"type": "string"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetActivePlayers ====
Returns all active players<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Returns all active players",
"params": [],
"permission": "ReadData",
"returns": {
"items": {
"properties": {
"playerid": {
"$ref": "Player.Id",
"required": true
},
"playertype": {
"enums": [
"internal",
"external",
"remote"
],
"required": true,
"type": "string"
},
"type": {
"$ref": "Player.Type",
"required": true
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetAudioDelay ====
Get the audio delay for the current playback<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''number'' offset (The offset value used in the current playback.)<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get the audio delay for the current playback",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"offset": {
"description": "The offset value used in the current playback.",
"required": true,
"type": "number"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetChapters ====
Returns the chapters of the currently playing item for the given player<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<br />
</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:'''
# ''array[ [[#Player.Chapter|Player.Chapter]] ]'' chapters<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Returns the chapters of the currently playing item for the given player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
}
],
"permission": "ReadData",
"returns": {
"properties": {
"chapters": {
"items": {
"$ref": "Player.Chapter",
"description": "Single chapter of the currently playing video"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#List.Fields.All|List.Fields.All]]'' properties]<br />
</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<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the currently played item",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "List.Fields.All",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"item": {
"$ref": "List.Item.All",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetPlayers ====
Get a list of available players<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''string'' media = all]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get a list of available players",
"params": [
{
"default": "all",
"enums": [
"all",
"video",
"audio"
],
"name": "media",
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"items": {
"properties": {
"name": {
"$ref": "Global.String.NotEmpty",
"required": true
},
"playsaudio": {
"required": true,
"type": "boolean"
},
"playsvideo": {
"required": true,
"type": "boolean"
},
"type": {
"enums": [
"internal",
"external",
"remote"
],
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"type": "method"
}
</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<br />
# ''array[ [[#Player.Property.Name|Player.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Property.Value|Player.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"items": {
"$ref": "Player.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "Player.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetViewMode ====
Get view mode of video player<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''boolean'' nonlinearstretch<br />
# ''number'' pixelratio<br />
# ''number'' verticalshift<br />
# ''[[#Player.ViewMode|Player.ViewMode]]'' viewmode<br />
# ''number'' zoom<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get view mode of video player",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"nonlinearstretch": {
"required": true,
"type": "boolean"
},
"pixelratio": {
"required": true,
"type": "number"
},
"verticalshift": {
"required": true,
"type": "number"
},
"viewmode": {
"$ref": "Player.ViewMode",
"required": true
},
"zoom": {
"required": true,
"type": "number"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# ''mixed: string|[[#Playlist.Position|Playlist.Position]]'' to<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Go to previous/next/specific item in the playlist",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "to",
"required": true,
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"$ref": "Playlist.Position",
"description": "position in playlist"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''string'' direction<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "If picture is zoomed move viewport left/right/up/down otherwise skip previous/next",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"enums": [
"left",
"right",
"up",
"down"
],
"name": "direction",
"required": true,
"type": "string"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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: object|[[#Playlist.Item|Playlist.Item]]|object|object|object|object|object'' item]<br />
# [''object'' options]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.",
"params": [
{
"name": "item",
"type": [
{
"additionalProperties": false,
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"position": {
"$ref": "Playlist.Position",
"default": 0
}
},
"type": "object"
},
{
"$ref": "Playlist.Item"
},
{
"additionalProperties": false,
"properties": {
"path": {
"required": true,
"type": "string"
},
"random": {
"default": true,
"description": "Deprecated, use the shuffled property of the options parameter instead",
"type": "boolean"
},
"recursive": {
"default": true,
"type": "boolean"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"partymode": {
"default": "",
"type": [
{
"enums": [
"music",
"video"
],
"type": "string"
},
{
"description": "Path to a smartplaylist (*.xsp) file",
"minLength": 5,
"type": "string"
}
]
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"broadcastid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"channelid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"recordingid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
},
{
"additionalProperties": false,
"name": "options",
"properties": {
"playername": {
"default": null,
"type": [
{
"type": "null"
},
{
"enums": [
"default"
],
"type": "string"
},
{
"description": "name of player",
"minLength": 1,
"type": "string"
}
]
},
"repeat": {
"default": null,
"type": [
{
"type": "null"
},
{
"$ref": "Player.Repeat"
}
]
},
"resume": {
"default": false,
"type": [
{
"description": "Whether to resume from the resume point or not",
"type": "boolean"
},
{
"$ref": "Player.Position.Percentage",
"description": "Percentage value to start from"
},
{
"$ref": "Player.Position.Time",
"description": "Time to start from"
}
]
},
"shuffled": {
"$ref": "Optional.Boolean",
"default": null
}
},
"type": "object"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Global.Toggle|Global.Toggle]]'' play = toggle]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Pauses or unpause playback and returns the new state",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"default": "toggle",
"name": "play"
}
],
"permission": "ControlPlayback",
"returns": {
"$ref": "Player.Speed"
},
"type": "method"
}
</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<br />
# [''string'' value = clockwise]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Rotates current picture",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"default": "clockwise",
"enums": [
"clockwise",
"counterclockwise"
],
"name": "value",
"type": "string"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''mixed: object|object|object|object'' value<br />
</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]<br />
# [''[[#Global.Time|Global.Time]]'' time] (A duration.)<br />
# [''[[#Global.Time|Global.Time]]'' totaltime] (A duration.)<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Seek through the playing item",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "value",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"percentage": {
"$ref": "Player.Position.Percentage",
"description": "Percentage value to seek to",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"time": {
"$ref": "Player.Position.Time",
"description": "Time to seek to",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"step": {
"description": "Seek by predefined jumps",
"enums": [
"smallforward",
"smallbackward",
"bigforward",
"bigbackward"
],
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"seconds": {
"description": "Seek by the given number of seconds",
"required": true,
"type": "integer"
}
},
"type": "object"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"properties": {
"percentage": {
"$ref": "Player.Position.Percentage",
"default": 0.0
},
"time": {
"$ref": "Global.Time",
"description": "A duration."
},
"totaltime": {
"$ref": "Global.Time",
"description": "A duration."
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetAudioDelay ====
Set the audio delay for 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<br />
# ''mixed: number|[[#Global.IncrementDecrement|Global.IncrementDecrement]]'' offset<br />
</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:'''
# ''number'' offset (The offset value used in the current playback.)<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the audio delay for the current playback",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "offset",
"required": true,
"type": [
{
"description": "The value should be a multiple of 0.025 in a range of +/-10 (the default range can be overridden by advancedsettings.xml).",
"type": "number"
},
{
"$ref": "Global.IncrementDecrement"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"properties": {
"offset": {
"description": "The offset value used in the current playback.",
"required": true,
"type": "number"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# ''mixed: string|integer'' stream<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the audio stream played by the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "stream",
"required": true,
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"description": "Index of the audio stream to play",
"minimum": 0,
"type": "integer"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''[[#Global.Toggle|Global.Toggle]]'' partymode<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Turn partymode on or off",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "partymode",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''mixed: [[#Player.Repeat|Player.Repeat]]|string'' repeat<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the repeat mode of the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "repeat",
"required": true,
"type": [
{
"$ref": "Player.Repeat"
},
{
"enums": [
"cycle"
],
"type": "string"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''[[#Global.Toggle|Global.Toggle]]'' shuffle<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shuffle/Unshuffle items in the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "shuffle",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''mixed: integer|[[#Global.IncrementDecrement|Global.IncrementDecrement]]'' speed<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the speed of the current playback",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "speed",
"required": true,
"type": [
{
"enums": [
-32,
-16,
-8,
-4,
-2,
-1,
0,
1,
2,
4,
8,
16,
32
],
"type": "integer"
},
{
"$ref": "Global.IncrementDecrement"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"$ref": "Player.Speed"
},
"type": "method"
}
</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<br />
# ''mixed: string|integer'' subtitle<br />
# [''boolean'' enable = False] (Whether to enable subtitles to be displayed after setting the new subtitle)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the subtitle displayed by the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "subtitle",
"required": true,
"type": [
{
"enums": [
"previous",
"next",
"off",
"on"
],
"type": "string"
},
{
"description": "Index of the subtitle to display",
"minimum": 0,
"type": "integer"
}
]
},
{
"default": false,
"description": "Whether to enable subtitles to be displayed after setting the new subtitle",
"name": "enable",
"type": "boolean"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetTempo ====
Set the tempo 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<br />
# ''mixed: number|[[#Global.IncrementDecrement|Global.IncrementDecrement]]'' tempo<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Tempo|Player.Tempo]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the tempo of the current playback",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "tempo",
"required": true,
"type": [
{
"type": "number"
},
{
"$ref": "Global.IncrementDecrement"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"$ref": "Player.Tempo"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetVideoStream ====
Set the video stream played by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: string|integer'' stream<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the video stream played by the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "stream",
"required": true,
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"description": "Index of the video stream to play",
"minimum": 0,
"type": "integer"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetViewMode ====
Set view mode of video 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">
# ''mixed: [[#Player.CustomViewMode|Player.CustomViewMode]]|[[#Player.ViewMode|Player.ViewMode]]'' viewmode<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set view mode of video player",
"params": [
{
"name": "viewmode",
"required": true,
"type": [
{
"$ref": "Player.CustomViewMode",
"description": "Custom view mode"
},
{
"$ref": "Player.ViewMode"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Stops playback",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''mixed: string|integer'' zoom<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Zoom current picture",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "zoom",
"required": true,
"type": [
{
"enums": [
"in",
"out"
],
"type": "string"
},
{
"description": "zoom level",
"maximum": 10,
"minimum": 1,
"type": "integer"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''mixed: [[#Playlist.Item|Playlist.Item]]|array'' item<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Add item(s) to playlist",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"name": "item",
"required": true,
"type": [
{
"$ref": "Playlist.Item"
},
{
"items": {
"$ref": "Playlist.Item"
},
"type": "array"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Clear playlist",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#List.Fields.All|List.Fields.All]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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:'''
# ''array[ [[#List.Item.All|List.Item.All]] ]'' items<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get all items from playlist",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "List.Fields.All",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"items": {
"items": {
"$ref": "List.Item.All"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Playlist.GetPlaylists ====
Returns all existing playlists<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Returns all existing playlists",
"params": [],
"permission": "ReadData",
"returns": {
"items": {
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"type": {
"$ref": "Playlist.Type",
"required": true
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"type": "method"
}
</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<br />
# ''array[ [[#Playlist.Property.Name|Playlist.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Playlist.Property.Value|Playlist.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"items": {
"$ref": "Playlist.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "Playlist.Property.Value"
},
"type": "method"
}
</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<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position<br />
# ''mixed: [[#Playlist.Item|Playlist.Item]]|array'' item<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position",
"required": true
},
{
"name": "item",
"required": true,
"type": [
{
"$ref": "Playlist.Item"
},
{
"items": {
"$ref": "Playlist.Item"
},
"type": "array"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Remove item from playlist. Does not work for picture playlists (aka slideshows).",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position1<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position2<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Swap items in the playlist. Does not work for picture playlists (aka slideshows).",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position1",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position2",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Profiles ===
==== Profiles.GetCurrentProfile ====
Retrieve the current profile<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Profiles.Fields.Profile|Profiles.Fields.Profile]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Profiles.Details.Profile|Profiles.Details.Profile]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve the current profile",
"params": [
{
"$ref": "Profiles.Fields.Profile",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"$ref": "Profiles.Details.Profile"
},
"type": "method"
}
</syntaxhighlight>}}
==== Profiles.GetProfiles ====
Retrieve all profiles<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Profiles.Fields.Profile|Profiles.Fields.Profile]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# ''array[ [[#Profiles.Details.Profile|Profiles.Details.Profile]] ]'' profiles<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all profiles",
"params": [
{
"$ref": "Profiles.Fields.Profile",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"profiles": {
"items": {
"$ref": "Profiles.Details.Profile"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Profiles.LoadProfile ====
Load the specified profile<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' profile (Profile name)<br />
# [''boolean'' prompt = False] (Prompt for password)<br />
# [''[[#Profiles.Password|Profiles.Password]]'' password]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Load the specified profile",
"params": [
{
"description": "Profile name",
"name": "profile",
"required": true,
"type": "string"
},
{
"default": false,
"description": "Prompt for password",
"name": "prompt",
"type": "boolean"
},
{
"$ref": "Profiles.Password",
"name": "password"
}
],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Settings ===
==== Settings.GetCategories ====
Retrieves all setting categories<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Setting.Level|Setting.Level]]'' level = standard]<br />
# [''string'' section = ""]<br />
# [''string'' properties]<br />
</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:'''
# [''array[ [[#Setting.Details.Category|Setting.Details.Category]] ]'' categories]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves all setting categories",
"params": [
{
"$ref": "Setting.Level",
"default": "standard",
"name": "level"
},
{
"default": "",
"name": "section",
"type": "string"
},
{
"extends": "Item.Fields.Base",
"items": {
"enums": [
"settings"
],
"type": "string"
},
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"categories": {
"items": {
"$ref": "Setting.Details.Category"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.GetSections ====
Retrieves all setting sections<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Setting.Level|Setting.Level]]'' level = standard]<br />
# [''[[#Setting.Level|Setting.Level]]'' properties]<br />
</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:'''
# [''array[ [[#Setting.Details.Section|Setting.Details.Section]] ]'' sections]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves all setting sections",
"params": [
{
"$ref": "Setting.Level",
"default": "standard",
"name": "level"
},
{
"extends": "Item.Fields.Base",
"items": {
"enums": [
"categories"
],
"type": "string"
},
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"sections": {
"items": {
"$ref": "Setting.Details.Section"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.GetSettingValue ====
Retrieves the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the value of a setting",
"params": [
{
"minLength": 1,
"name": "setting",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"value": {
"$ref": "Setting.Value.Extended",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.GetSettings ====
Retrieves all settings<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Setting.Level|Setting.Level]]'' level = standard]<br />
# [''mixed: object'' filter]<br />
</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:'''
# [''array[ [[#Setting.Details.Setting|Setting.Details.Setting]] ]'' settings]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves all settings",
"params": [
{
"$ref": "Setting.Level",
"default": "standard",
"name": "level"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"category": {
"minLength": 1,
"required": true,
"type": "string"
},
"section": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"settings": {
"items": {
"$ref": "Setting.Details.Setting"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.GetSkinSettingValue ====
Retrieves the value of the specified skin setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting<br />
</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:'''
# ''[{'type': 'boolean'}, {'type': 'string'}]'' value<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the value of the specified skin setting",
"params": [
{
"minLength": 1,
"name": "setting",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"value": {
"required": true,
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.GetSkinSettings ====
Retrieves all skin settings of the currently used skin<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array'' settings]<br />
# ''string'' skin<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves all skin settings of the currently used skin",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"settings": {
"items": {
"properties": {
"id": {
"minLength": 1,
"required": true,
"type": "string"
},
"type": {
"enums": [
"boolean",
"string"
],
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": "array"
},
"skin": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.ResetSettingValue ====
Resets the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Resets the value of a setting",
"params": [
{
"minLength": 1,
"name": "setting",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.SetSettingValue ====
Changes the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting<br />
# ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Changes the value of a setting",
"params": [
{
"minLength": 1,
"name": "setting",
"required": true,
"type": "string"
},
{
"$ref": "Setting.Value.Extended",
"name": "value",
"required": true
}
],
"permission": "ReadData",
"returns": {
"type": "boolean"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.SetSkinSettingValue ====
Changes the value of the specified skin setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting<br />
# ''mixed: boolean|string'' value<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Changes the value of the specified skin setting",
"params": [
{
"minLength": 1,
"name": "setting",
"required": true,
"type": "string"
},
{
"name": "value",
"required": true,
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
]
}
],
"permission": "ReadData",
"returns": {
"type": "boolean"
},
"type": "method"
}
</syntaxhighlight>}}
=== System ===
==== System.EjectOpticalDrive ====
Ejects or closes the optical disc drive (if available)<br />
'''Permissions:'''
* ControlSystem
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Ejects or closes the optical disc drive (if available)",
"params": [],
"permission": "ControlSystem",
"returns": {
"type": "string"
},
"type": "method"
}
</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">
# ''array[ [[#System.Property.Name|System.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#System.Property.Value|System.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"items": {
"$ref": "System.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "System.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.Hibernate ====
Puts the system running Kodi into hibernate mode<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Puts the system running Kodi into hibernate mode",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.Reboot ====
Reboots the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Reboots the system running Kodi",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.Shutdown ====
Shuts the system running Kodi down<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shuts the system running Kodi down",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.Suspend ====
Suspends the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Suspends the system running Kodi",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Textures ===
==== Textures.GetTextures ====
Retrieve all textures<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Textures.Fields.Texture|Textures.Fields.Texture]]'' properties]<br />
# [''[[#List.Filter.Textures|List.Filter.Textures]]'' filter]<br />
</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:'''
# ''array[ [[#Textures.Details.Texture|Textures.Details.Texture]] ]'' textures<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all textures",
"params": [
{
"$ref": "Textures.Fields.Texture",
"name": "properties"
},
{
"$ref": "List.Filter.Textures",
"name": "filter"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"textures": {
"items": {
"$ref": "Textures.Details.Texture"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Textures.RemoveTexture ====
Remove the specified texture<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' textureid (Texture database identifier)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Remove the specified texture",
"params": [
{
"$ref": "Library.Id",
"description": "Texture database identifier",
"name": "textureid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== VideoLibrary ===
==== VideoLibrary.Clean ====
Cleans the video library for non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
# [''string'' content = video] (Content type to clean for)<br />
# [''string'' directory = ""] (Path to the directory to clean up; performs a global cleanup if not specified)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Cleans the video library for non-existent items",
"params": [
{
"default": true,
"description": "Whether or not to show the progress bar or any other GUI dialog",
"name": "showdialogs",
"type": "boolean"
},
{
"default": "video",
"description": "Content type to clean for",
"enums": [
"video",
"movies",
"tvshows",
"musicvideos"
],
"name": "content",
"type": "string"
},
{
"default": "",
"description": "Path to the directory to clean up; performs a global cleanup if not specified",
"name": "directory",
"type": "string"
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.Export ====
Exports all items from the video library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''mixed: object|object'' options]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Exports all items from the video library",
"params": [
{
"name": "options",
"type": [
{
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the directory to where the data should be exported",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actorthumbs": {
"default": false,
"description": "Whether to export actor thumbnails",
"type": "boolean"
},
"images": {
"default": false,
"description": "Whether to export thumbnails and fanart images",
"type": "boolean"
},
"overwrite": {
"default": false,
"description": "Whether to overwrite existing exported files",
"type": "boolean"
}
},
"type": "object"
}
]
}
],
"permission": "WriteFile",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetAvailableArt ====
Retrieve all potential art URLs for a media item by art 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">
# ''mixed: object|object|object|object|object|object'' item<br />
# [''string'' arttype = ""]<br />
</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:'''
# ''array'' availableart<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all potential art URLs for a media item by art type",
"params": [
{
"name": "item",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"episodeid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tvshowid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"seasonid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"movieid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"musicvideoid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
},
{
"default": "",
"name": "arttype",
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"availableart": {
"items": {
"properties": {
"arttype": {
"required": true,
"type": "string"
},
"previewurl": {
"default": "",
"description": "URL to a preview thumbnail of the image",
"type": "string"
},
"url": {
"description": "URL to the original image",
"required": true,
"type": "string"
}
},
"type": "object"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetAvailableArtTypes ====
Retrieve a list of potential art types for a media 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">
# ''mixed: object|object|object|object|object|object'' item<br />
</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:'''
# ''array'' availablearttypes<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve a list of potential art types for a media item",
"params": [
{
"name": "item",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"episodeid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tvshowid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"seasonid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"movieid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"musicvideoid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"availablearttypes": {
"items": {
"type": "string"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific tv show episode",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"$ref": "Video.Fields.Episode",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"episodedetails": {
"$ref": "Video.Details.Episode"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''integer'' season = -1]<br />
# [''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|[[#List.Filter.Episodes|List.Filter.Episodes]]'' filter]<br />
</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:'''
# [''array[ [[#Video.Details.Episode|Video.Details.Episode]] ]'' episodes]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all tv show episodes",
"params": [
{
"$ref": "Library.Id",
"default": -1,
"name": "tvshowid"
},
{
"default": -1,
"minimum": 0,
"name": "season",
"type": "integer"
},
{
"$ref": "Video.Fields.Episode",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Requires tvshowid to be set",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Requires tvshowid to be set",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"description": "Requires tvshowid to be set",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Episodes"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"episodes": {
"items": {
"$ref": "Video.Details.Episode"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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:'''
# ''array[ [[#Library.Details.Genre|Library.Details.Genre]] ]'' genres<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all genres",
"params": [
{
"enums": [
"movie",
"tvshow",
"musicvideo"
],
"name": "type",
"required": true,
"type": "string"
},
{
"$ref": "Library.Fields.Genre",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"genres": {
"items": {
"$ref": "Library.Details.Genre"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetInProgressTVShows ====
Retrieve all in progress tvshows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# [''array[ [[#Video.Details.TVShow|Video.Details.TVShow]] ]'' tvshows]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all in progress tvshows",
"params": [
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tvshows": {
"items": {
"$ref": "Video.Details.TVShow"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific movie",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"$ref": "Video.Fields.Movie",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"moviedetails": {
"$ref": "Video.Details.Movie"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties]<br />
# [''object'' movies]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific movie set",
"params": [
{
"$ref": "Library.Id",
"name": "setid",
"required": true
},
{
"$ref": "Video.Fields.MovieSet",
"name": "properties"
},
{
"name": "movies",
"properties": {
"limits": {
"$ref": "List.Limits"
},
"properties": {
"$ref": "Video.Fields.Movie"
},
"sort": {
"$ref": "List.Sort"
}
},
"type": "object"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"setdetails": {
"$ref": "Video.Details.MovieSet.Extended"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# [''array[ [[#Video.Details.MovieSet|Video.Details.MovieSet]] ]'' sets]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all movie sets",
"params": [
{
"$ref": "Video.Fields.MovieSet",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sets": {
"items": {
"$ref": "Video.Details.MovieSet"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|object|object|object|[[#List.Filter.Movies|List.Filter.Movies]]'' filter]<br />
</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<br />
# [''array[ [[#Video.Details.Movie|Video.Details.Movie]] ]'' movies]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all movies",
"params": [
{
"$ref": "Video.Fields.Movie",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"country": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"set": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Movies"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific music video",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"musicvideodetails": {
"$ref": "Video.Details.MusicVideo"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|[[#List.Filter.MusicVideos|List.Filter.MusicVideos]]'' filter]<br />
</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<br />
# [''array[ [[#Video.Details.MusicVideo|Video.Details.MusicVideo]] ]'' musicvideos]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all music videos",
"params": [
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.MusicVideos"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"musicvideos": {
"items": {
"$ref": "Video.Details.MusicVideo"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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:'''
# [''array[ [[#Video.Details.Episode|Video.Details.Episode]] ]'' episodes]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all recently added tv episodes",
"params": [
{
"$ref": "Video.Fields.Episode",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"episodes": {
"items": {
"$ref": "Video.Details.Episode"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# [''array[ [[#Video.Details.Movie|Video.Details.Movie]] ]'' movies]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all recently added movies",
"params": [
{
"$ref": "Video.Fields.Movie",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# [''array[ [[#Video.Details.MusicVideo|Video.Details.MusicVideo]] ]'' musicvideos]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all recently added music videos",
"params": [
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"musicvideos": {
"items": {
"$ref": "Video.Details.MusicVideo"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetSeasonDetails ====
Retrieve details about a specific tv show season<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' seasonid<br />
# [''[[#Video.Fields.Season|Video.Fields.Season]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Video.Details.Season|Video.Details.Season]]'' seasondetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific tv show season",
"params": [
{
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
{
"$ref": "Video.Fields.Season",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"seasondetails": {
"$ref": "Video.Details.Season"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetSeasons ====
Retrieve all tv seasons<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Library.Id|Library.Id]]'' tvshowid = -1]<br />
# [''[[#Video.Fields.Season|Video.Fields.Season]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# [''array[ [[#Video.Details.Season|Video.Details.Season]] ]'' seasons]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all tv seasons",
"params": [
{
"$ref": "Library.Id",
"default": -1,
"name": "tvshowid"
},
{
"$ref": "Video.Fields.Season",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"seasons": {
"items": {
"$ref": "Video.Details.Season"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific tv show",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"tvshowdetails": {
"$ref": "Video.Details.TVShow"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|[[#List.Filter.TVShows|List.Filter.TVShows]]'' filter]<br />
</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<br />
# [''array[ [[#Video.Details.TVShow|Video.Details.TVShow]] ]'' tvshows]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all tv shows",
"params": [
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.TVShows"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tvshows": {
"items": {
"$ref": "Video.Details.TVShow"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetTags ====
Retrieve all tags<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' type<br />
# [''[[#Library.Fields.Tag|Library.Fields.Tag]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# ''array[ [[#Library.Details.Tag|Library.Details.Tag]] ]'' tags<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all tags",
"params": [
{
"enums": [
"movie",
"tvshow",
"musicvideo"
],
"name": "type",
"required": true,
"type": "string"
},
{
"$ref": "Library.Fields.Tag",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tags": {
"items": {
"$ref": "Library.Details.Tag"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RefreshEpisode ====
Refresh the given episode in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid<br />
# [''boolean'' ignorenfo = False] (Whether or not to ignore a local NFO if present.)<br />
# [''string'' title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the given episode in the library",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"default": false,
"description": "Whether or not to ignore a local NFO if present.",
"name": "ignorenfo",
"type": "boolean"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"name": "title",
"type": "string"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RefreshMovie ====
Refresh the given movie in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid<br />
# [''boolean'' ignorenfo = False] (Whether or not to ignore a local NFO if present.)<br />
# [''string'' title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the given movie in the library",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"default": false,
"description": "Whether or not to ignore a local NFO if present.",
"name": "ignorenfo",
"type": "boolean"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"name": "title",
"type": "string"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RefreshMusicVideo ====
Refresh the given music video in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid<br />
# [''boolean'' ignorenfo = False] (Whether or not to ignore a local NFO if present.)<br />
# [''string'' title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the given music video in the library",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"default": false,
"description": "Whether or not to ignore a local NFO if present.",
"name": "ignorenfo",
"type": "boolean"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"name": "title",
"type": "string"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RefreshTVShow ====
Refresh the given tv show in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid<br />
# [''boolean'' ignorenfo = False] (Whether or not to ignore a local NFO if present.)<br />
# [''boolean'' refreshepisodes = False] (Whether or not to refresh all episodes belonging to the TV show.)<br />
# [''string'' title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the given tv show in the library",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"default": false,
"description": "Whether or not to ignore a local NFO if present.",
"name": "ignorenfo",
"type": "boolean"
},
{
"default": false,
"description": "Whether or not to refresh all episodes belonging to the TV show.",
"name": "refreshepisodes",
"type": "boolean"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"name": "title",
"type": "string"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Removes the given episode from the library",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Removes the given movie from the library",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Removes the given music video from the library",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Removes the given tv show from the library",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</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 = ""]<br />
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Scans the video sources for new library items",
"params": [
{
"default": "",
"name": "directory",
"type": "string"
},
{
"default": true,
"description": "Whether or not to show the progress bar or any other GUI dialog",
"name": "showdialogs",
"type": "boolean"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br />
# [''mixed: null|[[#Array.String|Array.String]]'' director = None]<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.String|Optional.String]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' writer = None]<br />
# [''[[#Optional.String|Optional.String]]'' firstaired = None]<br />
# [''[[#Optional.String|Optional.String]]'' productioncode = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' season = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' episode = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaltitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
# [''[[#Optional.String|Optional.String]]'' fanart = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings]<br />
# [''[[#Optional.String|Optional.String]]'' dateadded = None]<br />
# [''mixed: null|[[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given episode with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "Runtime in seconds",
"name": "runtime"
},
{
"default": null,
"name": "director",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"default": null,
"name": "writer",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "firstaired"
},
{
"$ref": "Optional.String",
"default": null,
"name": "productioncode"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "season"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "episode"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"default": null,
"name": "fanart"
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"default": null,
"name": "resume",
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"default": null,
"name": "dateadded"
},
{
"default": null,
"name": "uniqueid",
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br />
# [''mixed: null|[[#Array.String|Array.String]]'' director = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' studio = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' year = None] (linked with premiered. Overridden by premiered parameter)<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.String|Optional.String]]'' mpaa = None]<br />
# [''[[#Optional.String|Optional.String]]'' imdbnumber = None]<br />
# [''[[#Optional.String|Optional.String]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaltitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' trailer = None]<br />
# [''[[#Optional.String|Optional.String]]'' tagline = None]<br />
# [''[[#Optional.String|Optional.String]]'' plotoutline = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' writer = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' country = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' top250 = None]<br />
# [''[[#Optional.String|Optional.String]]'' sorttitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' set = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' showlink = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
# [''[[#Optional.String|Optional.String]]'' fanart = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' tag = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings]<br />
# [''[[#Optional.String|Optional.String]]'' dateadded = None]<br />
# [''[[#Optional.String|Optional.String]]'' premiered = None] (linked with year. Overrides year)<br />
# [''mixed: null|[[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given movie with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "Runtime in seconds",
"name": "runtime"
},
{
"default": null,
"name": "director",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "studio",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "linked with premiered. Overridden by premiered parameter",
"name": "year"
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "mpaa"
},
{
"$ref": "Optional.String",
"default": null,
"name": "imdbnumber"
},
{
"$ref": "Optional.String",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "trailer"
},
{
"$ref": "Optional.String",
"default": null,
"name": "tagline"
},
{
"$ref": "Optional.String",
"default": null,
"name": "plotoutline"
},
{
"default": null,
"name": "writer",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "country",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "top250"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sorttitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "set"
},
{
"default": null,
"name": "showlink",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"default": null,
"name": "fanart"
},
{
"default": null,
"name": "tag",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"default": null,
"name": "resume",
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"default": null,
"name": "dateadded"
},
{
"$ref": "Optional.String",
"default": null,
"description": "linked with year. Overrides year",
"name": "premiered"
},
{
"default": null,
"name": "uniqueid",
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.SetMovieSetDetails ====
Update the given movie set with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' setid<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given movie set with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "setid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br />
# [''mixed: null|[[#Array.String|Array.String]]'' director = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' studio = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' year = None] (linked with premiered. Overridden by premiered parameter)<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
# [''[[#Optional.String|Optional.String]]'' album = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' track = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
# [''[[#Optional.String|Optional.String]]'' fanart = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' tag = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Optional.String|Optional.String]]'' dateadded = None]<br />
# [''[[#Optional.String|Optional.String]]'' premiered = None] (linked with year. Overrides year)<br />
# [''mixed: null|[[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given music video with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "Runtime in seconds",
"name": "runtime"
},
{
"default": null,
"name": "director",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "studio",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "linked with premiered. Overridden by premiered parameter",
"name": "year"
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
},
{
"$ref": "Optional.String",
"default": null,
"name": "album"
},
{
"default": null,
"name": "artist",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "track"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"default": null,
"name": "fanart"
},
{
"default": null,
"name": "tag",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"default": null,
"name": "resume",
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
]
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "dateadded"
},
{
"$ref": "Optional.String",
"default": null,
"description": "linked with year. Overrides year",
"name": "premiered"
},
{
"default": null,
"name": "uniqueid",
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.SetSeasonDetails ====
Update the given season with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' seasonid<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given season with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' studio = None]<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.String|Optional.String]]'' mpaa = None]<br />
# [''[[#Optional.String|Optional.String]]'' imdbnumber = None]<br />
# [''[[#Optional.String|Optional.String]]'' premiered = None]<br />
# [''[[#Optional.String|Optional.String]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaltitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' sorttitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' episodeguide = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
# [''[[#Optional.String|Optional.String]]'' fanart = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' tag = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings]<br />
# [''[[#Optional.String|Optional.String]]'' dateadded = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br />
# [''[[#Optional.String|Optional.String]]'' status = None] (Valid values: 'returning series', 'in production', 'planned', 'cancelled', 'ended')<br />
# [''mixed: null|[[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given tvshow with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"default": null,
"name": "studio",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "mpaa"
},
{
"$ref": "Optional.String",
"default": null,
"name": "imdbnumber"
},
{
"$ref": "Optional.String",
"default": null,
"name": "premiered"
},
{
"$ref": "Optional.String",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sorttitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "episodeguide"
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"default": null,
"name": "fanart"
},
{
"default": null,
"name": "tag",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"default": null,
"name": "dateadded"
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "Runtime in seconds",
"name": "runtime"
},
{
"$ref": "Optional.String",
"default": null,
"description": "Valid values: 'returning series', 'in production', 'planned', 'cancelled', 'ended'",
"name": "status"
},
{
"default": null,
"name": "uniqueid",
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== XBMC ===
==== XBMC.GetInfoBooleans ====
Retrieve info booleans about Kodi and the system<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[string]'' booleans<br />
</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 (Object containing key-value pairs of the retrieved info booleans)''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve info booleans about Kodi and the system",
"params": [
{
"items": {
"type": "string"
},
"minItems": 1,
"name": "booleans",
"required": true,
"type": "array"
}
],
"permission": "ReadData",
"returns": {
"additionalProperties": {
"default": "",
"type": "string"
},
"description": "Object containing key-value pairs of the retrieved info booleans",
"type": "object"
},
"type": "method"
}
</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[string]'' labels (See http://kodi.wiki/view/InfoLabels for a list of possible info labels)<br />
</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 (Object containing key-value pairs of the retrieved info labels)''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve info labels about Kodi and the system",
"params": [
{
"description": "See http://kodi.wiki/view/InfoLabels for a list of possible info labels",
"items": {
"type": "string"
},
"minItems": 1,
"name": "labels",
"required": true,
"type": "array"
}
],
"permission": "ReadData",
"returns": {
"additionalProperties": {
"default": "",
"type": "string"
},
"description": "Object containing key-value pairs of the retrieved info labels",
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
== Global Types ==
=== Addon ===
==== Addon.Content ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"video",
"audio",
"image",
"executable"
],
"id": "Addon.Content",
"type": "string"
}
</syntaxhighlight>}}
==== Addon.Details ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' addonid
* [''string'' author]
* [''mixed: boolean|string'' broken]
* [''array'' dependencies]
* [''mixed: boolean|string'' deprecated]
* [''string'' description]
* [''string'' disclaimer]
* [''boolean'' enabled]
* [''array'' extrainfo]
* [''string'' fanart]
* [''boolean'' installed]
* [''string'' name]
* [''string'' path]
* [''integer'' rating]
* [''string'' summary]
* [''string'' thumbnail]
* ''[[#Addon.Types|Addon.Types]]'' type
* [''string'' version]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Addon.Details",
"properties": {
"addonid": {
"required": true,
"type": "string"
},
"author": {
"default": "",
"type": "string"
},
"broken": {
"default": null,
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"dependencies": {
"items": {
"properties": {
"addonid": {
"required": true,
"type": "string"
},
"optional": {
"required": true,
"type": "boolean"
},
"version": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"deprecated": {
"default": null,
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"description": {
"default": "",
"type": "string"
},
"disclaimer": {
"default": "",
"type": "string"
},
"enabled": {
"default": false,
"type": "boolean"
},
"extrainfo": {
"items": {
"properties": {
"key": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"fanart": {
"default": "",
"type": "string"
},
"installed": {
"default": false,
"type": "boolean"
},
"name": {
"default": "",
"type": "string"
},
"path": {
"default": "",
"type": "string"
},
"rating": {
"default": 0,
"type": "integer"
},
"summary": {
"default": "",
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
},
"type": {
"$ref": "Addon.Types",
"required": true
},
"version": {
"default": "",
"type": "string"
}
}
}
</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="json">
{
"extends": "Item.Fields.Base",
"id": "Addon.Fields",
"items": {
"enums": [
"name",
"version",
"summary",
"description",
"path",
"author",
"thumbnail",
"disclaimer",
"fanart",
"dependencies",
"broken",
"extrainfo",
"rating",
"enabled",
"installed",
"deprecated"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Addon.Types ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"xbmc.player.musicviz",
"xbmc.gui.skin",
"kodi.pvrclient",
"kodi.inputstream",
"kodi.gameclient",
"kodi.shader.presets",
"kodi.peripheral",
"xbmc.python.script",
"xbmc.python.weather",
"xbmc.subtitle.module",
"xbmc.python.lyrics",
"xbmc.metadata.scraper.albums",
"xbmc.metadata.scraper.artists",
"xbmc.metadata.scraper.movies",
"xbmc.metadata.scraper.musicvideos",
"xbmc.metadata.scraper.tvshows",
"xbmc.ui.screensaver",
"xbmc.python.pluginsource",
"xbmc.addon.repository",
"xbmc.webinterface",
"xbmc.service",
"kodi.audioencoder",
"kodi.context.item",
"kodi.audiodecoder",
"kodi.resource.images",
"kodi.resource.language",
"kodi.resource.uisounds",
"kodi.resource.games",
"kodi.resource.font",
"kodi.resource.skin",
"kodi.vfs",
"kodi.imagedecoder",
"xbmc.metadata.scraper.library",
"xbmc.python.library",
"xbmc.python.module",
"kodi.game.controller",
"",
"xbmc.addon.video",
"xbmc.addon.audio",
"xbmc.addon.image",
"xbmc.addon.executable",
"kodi.addon.game"
],
"id": "Addon.Types",
"type": "string"
}
</syntaxhighlight>}}
=== Application ===
==== Application.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "volume",
"enums": [
"volume",
"muted",
"name",
"version",
"sorttokens",
"language"
],
"id": "Application.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== Application.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' language]
* [''boolean'' muted]
* [''string'' name]
* [''[[#Array.String|Array.String]]'' sorttokens]
* [''object'' version]
* [''integer'' volume]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Application.Property.Value",
"properties": {
"language": {
"default": "",
"description": "Current language code and region e.g. en_GB",
"minLength": 1,
"type": "string"
},
"muted": {
"default": false,
"type": "boolean"
},
"name": {
"default": "",
"minLength": 1,
"type": "string"
},
"sorttokens": {
"$ref": "Array.String",
"description": "Articles ignored during sorting when ignorearticle is enabled."
},
"version": {
"properties": {
"major": {
"minimum": 0,
"required": true,
"type": "integer"
},
"minor": {
"minimum": 0,
"required": true,
"type": "integer"
},
"revision": {
"default": null,
"type": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"tag": {
"enums": [
"prealpha",
"alpha",
"beta",
"releasecandidate",
"stable"
],
"required": true,
"type": "string"
},
"tagversion": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"volume": {
"default": 0,
"maximum": 100,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Array ===
==== Array.Integer ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Array.Integer",
"items": {
"type": "integer"
},
"type": "array"
}
</syntaxhighlight>}}
==== Array.String ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Array.String",
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
}
</syntaxhighlight>}}
=== Audio ===
==== Audio.Album.ReleaseType ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "album",
"enums": [
"album",
"single"
],
"id": "Audio.Album.ReleaseType",
"type": "string"
}
</syntaxhighlight>}}
==== Audio.Artist.Roles ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Audio.Artist.Roles",
"items": {
"additionalProperties": false,
"description": "The various roles contributed by an artist to one or more songs",
"properties": {
"role": {
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
"type": "array"
}
</syntaxhighlight>}}
==== Audio.Contributors ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Audio.Contributors",
"items": {
"additionalProperties": false,
"description": "The artist and the role they contribute to a song",
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"name": {
"required": true,
"type": "string"
},
"role": {
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
"type": "array"
}
</syntaxhighlight>}}
==== Audio.Details.Album ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' albumduration]
* ''[[#Library.Id|Library.Id]]'' albumid
* [''string'' albumlabel]
* [''string'' albumstatus]
* [''boolean'' compilation]
* [''string'' description]
* [''boolean'' isboxset]
* [''string'' lastplayed]
* [''[[#Array.String|Array.String]]'' mood]
* [''string'' musicbrainzalbumid]
* [''string'' musicbrainzreleasegroupid]
* [''integer'' playcount]
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = album]
* [''[[#Audio.Details.Genres|Audio.Details.Genres]]'' songgenres]
* [''[[#Array.Integer|Array.Integer]]'' sourceid]
* [''[[#Array.String|Array.String]]'' style]
* [''[[#Array.String|Array.String]]'' theme]
* [''integer'' totaldiscs]
* [''string'' type]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Audio.Details.Media",
"id": "Audio.Details.Album",
"properties": {
"albumduration": {
"default": 0,
"type": "integer"
},
"albumid": {
"$ref": "Library.Id",
"required": true
},
"albumlabel": {
"default": "",
"type": "string"
},
"albumstatus": {
"default": "",
"type": "string"
},
"compilation": {
"default": false,
"type": "boolean"
},
"description": {
"default": "",
"type": "string"
},
"isboxset": {
"default": false,
"type": "boolean"
},
"lastplayed": {
"default": "",
"type": "string"
},
"mood": {
"$ref": "Array.String"
},
"musicbrainzalbumid": {
"default": "",
"type": "string"
},
"musicbrainzreleasegroupid": {
"default": "",
"type": "string"
},
"playcount": {
"default": 0,
"type": "integer"
},
"releasetype": {
"$ref": "Audio.Album.ReleaseType",
"default": "album"
},
"songgenres": {
"$ref": "Audio.Details.Genres"
},
"sourceid": {
"$ref": "Array.Integer"
},
"style": {
"$ref": "Array.String"
},
"theme": {
"$ref": "Array.String"
},
"totaldiscs": {
"default": 0,
"type": "integer"
},
"type": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Artist ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' artist
* ''[[#Library.Id|Library.Id]]'' artistid
* [''string'' born]
* [''boolean'' compilationartist]
* [''string'' description]
* [''string'' died]
* [''string'' disambiguation]
* [''string'' disbanded]
* [''string'' formed]
* [''string'' gender]
* [''[[#Array.String|Array.String]]'' instrument]
* [''boolean'' isalbumartist]
* [''[[#Array.String|Array.String]]'' mood]
* [''[[#Array.String|Array.String]]'' musicbrainzartistid]
* [''[[#Audio.Artist.Roles|Audio.Artist.Roles]]'' roles]
* [''[[#Audio.Details.Genres|Audio.Details.Genres]]'' songgenres]
* [''string'' sortname]
* [''[[#Array.Integer|Array.Integer]]'' sourceid]
* [''[[#Array.String|Array.String]]'' style]
* [''string'' type]
* [''[[#Array.String|Array.String]]'' yearsactive]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Audio.Details.Base",
"id": "Audio.Details.Artist",
"properties": {
"artist": {
"required": true,
"type": "string"
},
"artistid": {
"$ref": "Library.Id",
"required": true
},
"born": {
"default": "",
"type": "string"
},
"compilationartist": {
"default": false,
"type": "boolean"
},
"description": {
"default": "",
"type": "string"
},
"died": {
"default": "",
"type": "string"
},
"disambiguation": {
"default": "",
"type": "string"
},
"disbanded": {
"default": "",
"type": "string"
},
"formed": {
"default": "",
"type": "string"
},
"gender": {
"default": "",
"type": "string"
},
"instrument": {
"$ref": "Array.String"
},
"isalbumartist": {
"default": false,
"type": "boolean"
},
"mood": {
"$ref": "Array.String"
},
"musicbrainzartistid": {
"$ref": "Array.String"
},
"roles": {
"$ref": "Audio.Artist.Roles"
},
"songgenres": {
"$ref": "Audio.Details.Genres"
},
"sortname": {
"default": "",
"type": "string"
},
"sourceid": {
"$ref": "Array.Integer"
},
"style": {
"$ref": "Array.String"
},
"type": {
"default": "",
"type": "string"
},
"yearsactive": {
"$ref": "Array.String"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Media.Artwork|Media.Artwork]]'' art]
* [''string'' dateadded]
* [''[[#Array.String|Array.String]]'' genre]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Media.Details.Base",
"id": "Audio.Details.Base",
"properties": {
"art": {
"$ref": "Media.Artwork"
},
"dateadded": {
"default": "",
"type": "string"
},
"genre": {
"$ref": "Array.String"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Genres ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Audio.Details.Genres",
"items": {
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
</syntaxhighlight>}}
==== Audio.Details.Media ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Array.String|Array.String]]'' artist]
* [''[[#Array.Integer|Array.Integer]]'' artistid]
* [''string'' displayartist]
* [''[[#Array.String|Array.String]]'' musicbrainzalbumartistid]
* [''string'' originaldate]
* [''number'' rating]
* [''string'' releasedate]
* [''string'' sortartist]
* [''string'' title]
* [''integer'' userrating]
* [''integer'' votes]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Audio.Details.Base",
"id": "Audio.Details.Media",
"properties": {
"artist": {
"$ref": "Array.String"
},
"artistid": {
"$ref": "Array.Integer"
},
"displayartist": {
"default": "",
"type": "string"
},
"musicbrainzalbumartistid": {
"$ref": "Array.String"
},
"originaldate": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"releasedate": {
"default": "",
"type": "string"
},
"sortartist": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
},
"userrating": {
"default": 0,
"type": "integer"
},
"votes": {
"default": 0,
"type": "integer"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Role ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' roleid
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Audio.Details.Role",
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Song ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' album]
* [''[[#Array.String|Array.String]]'' albumartist]
* [''[[#Array.Integer|Array.Integer]]'' albumartistid]
* [''[[#Library.Id|Library.Id]]'' albumid = -1]
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' albumreleasetype = album]
* [''any'' bitrate]
* [''any'' bpm]
* [''any'' channels]
* [''string'' comment]
* [''[[#Audio.Contributors|Audio.Contributors]]'' contributors]
* [''integer'' disc]
* [''string'' disctitle]
* [''string'' displaycomposer]
* [''string'' displayconductor]
* [''string'' displaylyricist]
* [''string'' displayorchestra]
* [''integer'' duration]
* [''string'' file]
* [''[[#Array.Integer|Array.Integer]]'' genreid]
* [''string'' lastplayed]
* [''string'' lyrics]
* [''string'' mood]
* [''[[#Array.String|Array.String]]'' musicbrainzartistid]
* [''string'' musicbrainztrackid]
* [''integer'' playcount]
* [''any'' samplerate]
* ''[[#Library.Id|Library.Id]]'' songid
* [''string'' songvideourl]
* [''[[#Array.Integer|Array.Integer]]'' sourceid]
* [''integer'' track]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Audio.Details.Media",
"id": "Audio.Details.Song",
"properties": {
"album": {
"default": "",
"type": "string"
},
"albumartist": {
"$ref": "Array.String"
},
"albumartistid": {
"$ref": "Array.Integer"
},
"albumid": {
"$ref": "Library.Id",
"default": -1
},
"albumreleasetype": {
"$ref": "Audio.Album.ReleaseType",
"default": "album"
},
"bitrate": {
"default": null,
"type": "any"
},
"bpm": {
"default": null,
"type": "any"
},
"channels": {
"default": null,
"type": "any"
},
"comment": {
"default": "",
"type": "string"
},
"contributors": {
"$ref": "Audio.Contributors"
},
"disc": {
"default": 0,
"type": "integer"
},
"disctitle": {
"default": "",
"type": "string"
},
"displaycomposer": {
"default": "",
"type": "string"
},
"displayconductor": {
"default": "",
"type": "string"
},
"displaylyricist": {
"default": "",
"type": "string"
},
"displayorchestra": {
"default": "",
"type": "string"
},
"duration": {
"default": 0,
"type": "integer"
},
"file": {
"default": "",
"type": "string"
},
"genreid": {
"$ref": "Array.Integer"
},
"lastplayed": {
"default": "",
"type": "string"
},
"lyrics": {
"default": "",
"type": "string"
},
"mood": {
"default": "",
"type": "string"
},
"musicbrainzartistid": {
"$ref": "Array.String"
},
"musicbrainztrackid": {
"default": "",
"type": "string"
},
"playcount": {
"default": 0,
"type": "integer"
},
"samplerate": {
"default": null,
"type": "any"
},
"songid": {
"$ref": "Library.Id",
"required": true
},
"songvideourl": {
"default": "",
"type": "string"
},
"sourceid": {
"$ref": "Array.Integer"
},
"track": {
"default": 0,
"type": "integer"
}
}
}
</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="json">
{
"extends": "Item.Fields.Base",
"id": "Audio.Fields.Album",
"items": {
"description": "Requesting the songgenres, artistid and/or sourceid fields will result in increased response times",
"enums": [
"title",
"description",
"artist",
"genre",
"theme",
"mood",
"style",
"type",
"albumlabel",
"rating",
"votes",
"userrating",
"year",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"fanart",
"thumbnail",
"playcount",
"artistid",
"displayartist",
"compilation",
"releasetype",
"dateadded",
"sortartist",
"musicbrainzreleasegroupid",
"songgenres",
"art",
"lastplayed",
"sourceid",
"isboxset",
"totaldiscs",
"releasedate",
"originaldate",
"albumstatus",
"datemodified",
"datenew",
"albumduration"
],
"type": "string"
}
}
</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="json">
{
"extends": "Item.Fields.Base",
"id": "Audio.Fields.Artist",
"items": {
"description": "Requesting the (song)genreid/genre, roleid/role or sourceid fields will result in increased response times",
"enums": [
"instrument",
"style",
"mood",
"born",
"formed",
"description",
"genre",
"died",
"disbanded",
"yearsactive",
"musicbrainzartistid",
"fanart",
"thumbnail",
"compilationartist",
"dateadded",
"roles",
"songgenres",
"isalbumartist",
"sortname",
"type",
"gender",
"disambiguation",
"art",
"sourceid",
"datemodified",
"datenew"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Audio.Fields.Role ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Audio.Fields.Role",
"items": {
"enums": [
"title"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Audio.Fields.Song ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Audio.Fields.Song",
"items": {
"description": "Requesting the genreid, artistid, albumartistid and/or sourceid fields will result in increased response times",
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"thumbnail",
"file",
"albumid",
"lastplayed",
"disc",
"genreid",
"artistid",
"displayartist",
"albumartistid",
"albumreleasetype",
"dateadded",
"votes",
"userrating",
"mood",
"contributors",
"displaycomposer",
"displayconductor",
"displayorchestra",
"displaylyricist",
"sortartist",
"art",
"sourceid",
"disctitle",
"releasedate",
"originaldate",
"bpm",
"samplerate",
"bitrate",
"channels",
"datemodified",
"datenew",
"songvideourl"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Audio.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "missingartistid",
"enums": [
"missingartistid",
"librarylastupdated",
"librarylastcleaned",
"artistlinksupdated",
"songslastadded",
"albumslastadded",
"artistslastadded",
"genreslastadded",
"songsmodified",
"albumsmodified",
"artistsmodified"
],
"id": "Audio.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== Audio.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' albumslastadded]
* [''string'' albumsmodified]
* [''string'' artistlinksupdated]
* [''string'' artistslastadded]
* [''string'' artistsmodified]
* [''string'' genreslastadded]
* [''string'' librarylastcleaned]
* [''string'' librarylastupdated]
* [''[[#Library.Id|Library.Id]]'' missingartistid = -1]
* [''string'' songslastadded]
* [''string'' songsmodified]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Audio.Property.Value",
"properties": {
"albumslastadded": {
"default": "",
"type": "string"
},
"albumsmodified": {
"default": "",
"type": "string"
},
"artistlinksupdated": {
"default": "",
"type": "string"
},
"artistslastadded": {
"default": "",
"type": "string"
},
"artistsmodified": {
"default": "",
"type": "string"
},
"genreslastadded": {
"default": "",
"type": "string"
},
"librarylastcleaned": {
"default": "",
"type": "string"
},
"librarylastupdated": {
"default": "",
"type": "string"
},
"missingartistid": {
"$ref": "Library.Id",
"default": -1
},
"songslastadded": {
"default": "",
"type": "string"
},
"songsmodified": {
"default": "",
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Configuration ===
==== Configuration ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Configuration.Notifications|Configuration.Notifications]]'' notifications
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Configuration",
"properties": {
"notifications": {
"$ref": "Configuration.Notifications",
"required": true
}
},
"required": true,
"type": "object"
}
</syntaxhighlight>}}
==== Configuration.Notifications ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' application
* ''boolean'' audiolibrary
* ''boolean'' gui
* ''boolean'' input
* ''boolean'' other
* ''boolean'' player
* ''boolean'' playlist
* ''boolean'' pvr
* ''boolean'' system
* ''boolean'' videolibrary
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Configuration.Notifications",
"properties": {
"application": {
"required": true,
"type": "boolean"
},
"audiolibrary": {
"required": true,
"type": "boolean"
},
"gui": {
"required": true,
"type": "boolean"
},
"input": {
"required": true,
"type": "boolean"
},
"other": {
"required": true,
"type": "boolean"
},
"player": {
"required": true,
"type": "boolean"
},
"playlist": {
"required": true,
"type": "boolean"
},
"pvr": {
"required": true,
"type": "boolean"
},
"system": {
"required": true,
"type": "boolean"
},
"videolibrary": {
"required": true,
"type": "boolean"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Favourite ===
==== Favourite.Details.Favourite ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' path]
* [''string'' thumbnail]
* ''string'' title
* ''[[#Favourite.Type|Favourite.Type]]'' type
* [''string'' window]
* [''string'' windowparameter]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Favourite.Details.Favourite",
"properties": {
"path": {
"default": "",
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Favourite.Type",
"required": true
},
"window": {
"default": "",
"type": "string"
},
"windowparameter": {
"default": "",
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Favourite.Fields.Favourite ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Favourite.Fields.Favourite",
"items": {
"enums": [
"window",
"windowparameter",
"thumbnail",
"path"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Favourite.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "media",
"enums": [
"media",
"window",
"script",
"androidapp",
"unknown"
],
"id": "Favourite.Type",
"type": "string"
}
</syntaxhighlight>}}
=== Files ===
==== Files.Media ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "video",
"enums": [
"video",
"music",
"pictures",
"files",
"programs"
],
"id": "Files.Media",
"type": "string"
}
</syntaxhighlight>}}
=== GUI ===
==== GUI.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "currentwindow",
"enums": [
"currentwindow",
"currentcontrol",
"skin",
"fullscreen",
"stereoscopicmode"
],
"id": "GUI.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== GUI.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''object'' currentcontrol]
* [''object'' currentwindow]
* [''boolean'' fullscreen]
* [''object'' skin]
* [''[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]'' stereoscopicmode]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "GUI.Property.Value",
"properties": {
"currentcontrol": {
"properties": {
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"currentwindow": {
"properties": {
"id": {
"required": true,
"type": "integer"
},
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"fullscreen": {
"default": false,
"type": "boolean"
},
"skin": {
"properties": {
"id": {
"minLength": 1,
"required": true,
"type": "string"
},
"name": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"stereoscopicmode": {
"$ref": "GUI.Stereoscopy.Mode"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== GUI.Stereoscopy.Mode ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' label
* ''string'' mode
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "GUI.Stereoscopy.Mode",
"properties": {
"label": {
"required": true,
"type": "string"
},
"mode": {
"enums": [
"off",
"split_vertical",
"split_horizontal",
"row_interleaved",
"hardware_based",
"anaglyph_cyan_red",
"anaglyph_green_magenta",
"anaglyph_yellow_blue",
"monoscopic"
],
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== GUI.Window ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "addon",
"enums": [
"addon",
"addonbrowser",
"addoninformation",
"addonsettings",
"appearancesettings",
"busydialog",
"busydialognocancel",
"contentsettings",
"contextmenu",
"dialogcolorpicker",
"dialogselectaudio",
"dialogselectsubtitle",
"dialogselectvideo",
"eventlog",
"extendedprogressdialog",
"favouritesbrowser",
"filebrowser",
"filemanager",
"fullscreengame",
"fullscreeninfo",
"fullscreenlivetv",
"fullscreenlivetvinput",
"fullscreenlivetvpreview",
"fullscreenradio",
"fullscreenradioinput",
"fullscreenradiopreview",
"fullscreenvideo",
"gameadvancedsettings",
"gameagents",
"gamecontrollers",
"gameosd",
"gamepadinput",
"gameports",
"games",
"gamesaves",
"gamesettings",
"gamestretchmode",
"gamevideofilter",
"gamevideorotation",
"gamevolume",
"home",
"infoprovidersettings",
"ingamesaves",
"interfacesettings",
"libexportsettings",
"locksettings",
"loginscreen",
"managevideoextras",
"managevideoversions",
"mediafilter",
"mediasettings",
"mediasource",
"movieinformation",
"music",
"musicinformation",
"musicosd",
"musicplaylist",
"musicplaylisteditor",
"networksetup",
"notification",
"numericinput",
"okdialog",
"osdaudiosettings",
"osdcmssettings",
"osdsubtitlesettings",
"osdvideosettings",
"peripherals",
"peripheralsettings",
"pictureinfo",
"pictures",
"playercontrols",
"playerprocessinfo",
"playersettings",
"profiles",
"profilesettings",
"programs",
"progressdialog",
"pvrchannelguide",
"pvrchannelmanager",
"pvrchannelscan",
"pvrgroupmanager",
"pvrguidecontrols",
"pvrguideinfo",
"pvrguidesearch",
"pvrosdchannels",
"pvrosdguide",
"pvrosdteletext",
"pvrradiordsinfo",
"pvrrecordinginfo",
"pvrsettings",
"pvrtimersetting",
"pvrupdateprogress",
"radiochannels",
"radioguide",
"radioproviders",
"radiorecordings",
"radiosearch",
"radiotimerrules",
"radiotimers",
"screencalibration",
"screensaver",
"seekbar",
"selectdialog",
"servicesettings",
"settings",
"shutdownmenu",
"skinsettings",
"sliderdialog",
"slideshow",
"smartplaylisteditor",
"smartplaylistrule",
"songinformation",
"splash",
"startup",
"startwindow",
"submenu",
"subtitlesearch",
"systeminfo",
"systemsettings",
"teletext",
"textviewer",
"tvchannels",
"tvguide",
"tvproviders",
"tvrecordings",
"tvsearch",
"tvtimerrules",
"tvtimers",
"videobookmarks",
"videomenu",
"videoosd",
"videoplaylist",
"videos",
"videotimeseek",
"virtualkeyboard",
"visualisation",
"visualisationpresetlist",
"volumebar",
"weather",
"yesnodialog"
],
"id": "GUI.Window",
"type": "string"
}
</syntaxhighlight>}}
=== Global ===
==== Global.IncrementDecrement ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "increment",
"enums": [
"increment",
"decrement"
],
"id": "Global.IncrementDecrement",
"type": "string"
}
</syntaxhighlight>}}
==== Global.String.NotEmpty ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "",
"id": "Global.String.NotEmpty",
"minLength": 1,
"type": "string"
}
</syntaxhighlight>}}
==== Global.Time ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' hours
* ''integer'' milliseconds
* ''integer'' minutes
* ''integer'' seconds
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"description": "A duration.",
"id": "Global.Time",
"properties": {
"hours": {
"minimum": 0,
"required": true,
"type": "integer"
},
"milliseconds": {
"maximum": 999,
"minimum": 0,
"required": true,
"type": "integer"
},
"minutes": {
"maximum": 59,
"minimum": 0,
"required": true,
"type": "integer"
},
"seconds": {
"maximum": 59,
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Global.Toggle ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Global.Toggle",
"type": [
{
"type": "boolean"
},
{
"enums": [
"toggle"
],
"type": "string"
}
]
}
</syntaxhighlight>}}
==== Global.Weekday ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "monday",
"enums": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"id": "Global.Weekday",
"type": "string"
}
</syntaxhighlight>}}
=== Input ===
==== Input.Action ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "analogfastforward",
"enums": [
"analogfastforward",
"analogmove",
"analogmovexleft",
"analogmovexright",
"analogmoveydown",
"analogmoveyup",
"analogrewind",
"analogseekback",
"analogseekforward",
"aspectratio",
"audiodelay",
"audiodelayminus",
"audiodelayplus",
"audionextlanguage",
"audiotoggledigital",
"back",
"backspace",
"bigstepback",
"bigstepforward",
"blue",
"browsesubtitle",
"channeldown",
"channelnumberseparator",
"channelup",
"chapterorbigstepback",
"chapterorbigstepforward",
"close",
"codecinfo",
"contextmenu",
"copy",
"createbookmark",
"createepisodebookmark",
"cursorleft",
"cursorright",
"cyclesubtitle",
"cycletonemapmethod",
"decreasepar",
"decreaserating",
"decreasevisrating",
"delete",
"dialogselectaudio",
"dialogselectsubtitle",
"dialogselectvideo",
"doubleclick",
"down",
"enter",
"error",
"fastforward",
"filter",
"filterclear",
"filtersms2",
"filtersms3",
"filtersms4",
"filtersms5",
"filtersms6",
"filtersms7",
"filtersms8",
"filtersms9",
"firstpage",
"fullscreen",
"green",
"guiprofile",
"hdrtoggle",
"highlight",
"increasepar",
"increaserating",
"increasevisrating",
"info",
"jumpsms2",
"jumpsms3",
"jumpsms4",
"jumpsms5",
"jumpsms6",
"jumpsms7",
"jumpsms8",
"jumpsms9",
"lastpage",
"left",
"leftclick",
"lockpreset",
"longclick",
"longpress",
"menu",
"middleclick",
"mousedrag",
"mousedragend",
"mousemove",
"move",
"moveitemdown",
"moveitemup",
"mute",
"nextcalibration",
"nextchannelgroup",
"nextletter",
"nextpicture",
"nextpreset",
"nextresolution",
"nextscene",
"nextstereomode",
"nextsubtitle",
"noop",
"number0",
"number1",
"number2",
"number3",
"number4",
"number5",
"number6",
"number7",
"number8",
"number9",
"osd",
"pagedown",
"pageup",
"pangesture",
"parentdir",
"parentfolder",
"pause",
"play",
"playerdebug",
"playerdebugvideo",
"playerprocessinfo",
"playerprogramselect",
"playerresolutionselect",
"playlist",
"playnext",
"playpause",
"playpvr",
"playpvrradio",
"playpvrtv",
"previouschannelgroup",
"previousmenu",
"previouspicture",
"previouspreset",
"previousscene",
"previousstereomode",
"previoussubtitle",
"prevletter",
"queue",
"randompreset",
"record",
"red",
"reloadkeymaps",
"rename",
"resetcalibration",
"rewind",
"right",
"rightclick",
"rotate",
"rotateccw",
"rotategesture",
"scanitem",
"screenshot",
"scrolldown",
"scrollup",
"select",
"setrating",
"settingslevelchange",
"settingsreset",
"shift",
"showpreset",
"showsubtitles",
"showtime",
"showtimerrule",
"showvideomenu",
"skipnext",
"skipprevious",
"smallstepback",
"stepback",
"stepforward",
"stereomode",
"stereomodetomono",
"stop",
"subtitlealign",
"subtitledelay",
"subtitledelayminus",
"subtitledelayplus",
"subtitleshiftdown",
"subtitleshiftup",
"swipedown",
"swipeleft",
"swiperight",
"swipeup",
"switchplayer",
"symbols",
"tap",
"tempodown",
"tempoup",
"togglecommskip",
"togglefont",
"togglefullscreen",
"togglestereomode",
"togglewatched",
"up",
"verticalshiftdown",
"verticalshiftup",
"videonextstream",
"voicerecognizer",
"volampdown",
"volampup",
"volumeamplification",
"volumedown",
"volumeup",
"wheeldown",
"wheelup",
"yellow",
"zoomgesture",
"zoomin",
"zoomlevel1",
"zoomlevel2",
"zoomlevel3",
"zoomlevel4",
"zoomlevel5",
"zoomlevel6",
"zoomlevel7",
"zoomlevel8",
"zoomlevel9",
"zoomnormal",
"zoomout"
],
"id": "Input.Action",
"type": "string"
}
</syntaxhighlight>}}
=== Item ===
==== Item.CustomProperties ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"id": "Item.CustomProperties",
"type": "object"
}
</syntaxhighlight>}}
==== Item.Details.Base ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' label
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Item.Details.Base",
"properties": {
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Item.Fields.Base ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Item.Fields.Base",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
</syntaxhighlight>}}
=== Library ===
==== Library.Details.Genre ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' genreid
* [''[[#Array.Integer|Array.Integer]]'' sourceid]
* [''string'' thumbnail]
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Library.Details.Genre",
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
},
"sourceid": {
"$ref": "Array.Integer",
"description": "The ids of sources with songs of the genre"
},
"thumbnail": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Library.Details.Source ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' file
* [''[[#Array.String|Array.String]]'' paths]
* ''[[#Library.Id|Library.Id]]'' sourceid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Library.Details.Source",
"properties": {
"file": {
"description": "The url encoded multipath string combining all paths of the source ",
"required": true,
"type": "string"
},
"paths": {
"$ref": "Array.String",
"description": "The individual paths of the media source"
},
"sourceid": {
"$ref": "Library.Id",
"required": true
}
}
}
</syntaxhighlight>}}
==== Library.Details.Tag ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' tagid
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Library.Details.Tag",
"properties": {
"tagid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
}
}
}
</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="json">
{
"extends": "Item.Fields.Base",
"id": "Library.Fields.Genre",
"items": {
"enums": [
"title",
"thumbnail",
"sourceid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Library.Fields.Source ====
'''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="json">
{
"extends": "Item.Fields.Base",
"id": "Library.Fields.Source",
"items": {
"enums": [
"file",
"paths"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Library.Fields.Tag ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Library.Fields.Tag",
"items": {
"enums": [
"title"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Library.Id ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "Library.Id",
"minimum": 1,
"type": "integer"
}
</syntaxhighlight>}}
=== List ===
==== List.Amount ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "List.Amount",
"minimum": 0,
"type": "integer"
}
</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="json">
{
"extends": "Item.Fields.Base",
"id": "List.Fields.All",
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"episodepart",
"episodename",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"channel",
"channeltype",
"hidden",
"locked",
"channelnumber",
"subchannelnumber",
"starttime",
"endtime",
"specialsortseason",
"specialsortepisode",
"compilation",
"releasetype",
"albumreleasetype",
"contributors",
"displaycomposer",
"displayconductor",
"displayorchestra",
"displaylyricist",
"userrating",
"sortartist",
"musicbrainzreleasegroupid",
"mediapath",
"dynpath",
"isboxset",
"totaldiscs",
"disctitle",
"releasedate",
"originaldate",
"bpm",
"bitrate",
"samplerate",
"channels",
"albumstatus",
"datemodified",
"datenew",
"customproperties",
"albumduration",
"songvideourl"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== List.Fields.Files ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "List.Fields.Files",
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"size",
"lastmodified",
"mimetype",
"specialsortseason",
"specialsortepisode",
"sortartist",
"musicbrainzreleasegroupid",
"isboxset",
"totaldiscs",
"disctitle",
"releasedate",
"originaldate",
"bpm",
"bitrate",
"samplerate",
"channels",
"datemodified",
"datenew",
"customproperties",
"albumduration",
"userrating",
"songvideourl"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== List.Filter.Albums ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Albums",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Albums"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Albums"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Albums"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Artists ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Artists",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Artists"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Artists"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Artists"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Episodes ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Episodes",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Episodes"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Episodes"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Episodes"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Fields.Albums ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "genre",
"enums": [
"genre",
"source",
"album",
"disctitle",
"totaldiscs",
"isboxset",
"artist",
"albumartist",
"year",
"originalyear",
"albumduration",
"review",
"themes",
"moods",
"styles",
"compilation",
"type",
"label",
"rating",
"userrating",
"playcount",
"lastplayed",
"path",
"albumstatus",
"dateadded",
"datemodified",
"datenew",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Albums",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Artists ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "artist",
"enums": [
"artist",
"source",
"genre",
"moods",
"styles",
"instruments",
"biography",
"artisttype",
"gender",
"disambiguation",
"born",
"bandformed",
"disbanded",
"died",
"role",
"path",
"dateadded",
"datemodified",
"datenew",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Artists",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Episodes ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "title",
"enums": [
"title",
"tvshow",
"originaltitle",
"plot",
"votes",
"rating",
"userrating",
"time",
"writers",
"airdate",
"playcount",
"lastplayed",
"inprogress",
"genre",
"year",
"director",
"actor",
"episode",
"season",
"filename",
"path",
"studio",
"mpaarating",
"dateadded",
"tag",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"hdrtype",
"hdrdetail",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Episodes",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Movies ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "title",
"enums": [
"title",
"originaltitle",
"plot",
"plotoutline",
"tagline",
"votes",
"rating",
"userrating",
"time",
"writers",
"playcount",
"lastplayed",
"inprogress",
"genre",
"country",
"year",
"director",
"actor",
"mpaarating",
"top250",
"studio",
"hastrailer",
"filename",
"path",
"set",
"tag",
"dateadded",
"hasversions",
"hasextras",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"hdrtype",
"hdrdetail",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Movies",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.MusicVideos ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "title",
"enums": [
"title",
"genre",
"album",
"year",
"artist",
"filename",
"path",
"playcount",
"lastplayed",
"rating",
"userrating",
"time",
"director",
"studio",
"plot",
"tag",
"dateadded",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"hdrtype",
"hdrdetail",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.MusicVideos",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Songs ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "genre",
"enums": [
"genre",
"source",
"album",
"disctitle",
"artist",
"albumartist",
"title",
"year",
"originalyear",
"time",
"tracknumber",
"filename",
"path",
"playcount",
"lastplayed",
"rating",
"userrating",
"comment",
"moods",
"bpm",
"samplerate",
"bitrate",
"channels",
"dateadded",
"datemodified",
"datenew",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Songs",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.TVShows ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "title",
"enums": [
"title",
"originaltitle",
"plot",
"tagline",
"status",
"votes",
"rating",
"userrating",
"year",
"genre",
"director",
"actor",
"numepisodes",
"numwatched",
"playcount",
"path",
"studio",
"mpaarating",
"dateadded",
"lastplayed",
"inprogress",
"tag",
"hastrailer",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.TVShows",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Textures ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "textureid",
"enums": [
"textureid",
"url",
"cachedurl",
"lasthashcheck",
"imagehash",
"width",
"height",
"usecount",
"lastused",
"lastlibrarycheck"
],
"id": "List.Filter.Fields.Textures",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Movies ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Movies",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Movies"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Movies"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Movies"
}
]
}
</syntaxhighlight>}}
==== List.Filter.MusicVideos ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.MusicVideos",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.MusicVideos"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.MusicVideos"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.MusicVideos"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Operators ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "contains",
"enums": [
"contains",
"doesnotcontain",
"is",
"isnot",
"startswith",
"endswith",
"greaterthan",
"lessthan",
"after",
"before",
"inthelast",
"notinthelast",
"true",
"false",
"between"
],
"id": "List.Filter.Operators",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Rule ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Operators|List.Filter.Operators]]'' operator
* ''mixed: string|array'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Rule",
"properties": {
"operator": {
"$ref": "List.Filter.Operators",
"required": true
},
"value": {
"required": true,
"type": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
}
</syntaxhighlight>}}
==== List.Filter.Rule.Albums ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Albums|List.Filter.Fields.Albums]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Albums",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Albums",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Artists ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Artists|List.Filter.Fields.Artists]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Artists",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Artists",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Episodes ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Episodes|List.Filter.Fields.Episodes]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Episodes",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Episodes",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Movies ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Movies|List.Filter.Fields.Movies]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Movies",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Movies",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.MusicVideos ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.MusicVideos|List.Filter.Fields.MusicVideos]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.MusicVideos",
"properties": {
"field": {
"$ref": "List.Filter.Fields.MusicVideos",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Songs ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Songs|List.Filter.Fields.Songs]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Songs",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Songs",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.TVShows ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.TVShows|List.Filter.Fields.TVShows]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.TVShows",
"properties": {
"field": {
"$ref": "List.Filter.Fields.TVShows",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Textures ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Textures|List.Filter.Fields.Textures]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Textures",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Textures",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Songs ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Songs",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Songs"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Songs"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Songs"
}
]
}
</syntaxhighlight>}}
==== List.Filter.TVShows ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.TVShows",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.TVShows"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.TVShows"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.TVShows"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Textures ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Textures",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Textures"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Textures"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Textures"
}
]
}
</syntaxhighlight>}}
==== List.Item.All ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' channel]
* [''integer'' channelnumber]
* [''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = tv]
* [''string'' endtime]
* [''boolean'' hidden]
* [''boolean'' locked]
* [''string'' starttime]
* [''integer'' subchannelnumber]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Item.Base",
"id": "List.Item.All",
"properties": {
"channel": {
"default": "",
"type": "string"
},
"channelnumber": {
"default": 0,
"type": "integer"
},
"channeltype": {
"$ref": "PVR.Channel.Type",
"default": "tv"
},
"endtime": {
"default": "",
"type": "string"
},
"hidden": {
"default": false,
"type": "boolean"
},
"locked": {
"default": false,
"type": "boolean"
},
"starttime": {
"default": "",
"type": "string"
},
"subchannelnumber": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== List.Item.Base ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' album]
* [''[[#Array.String|Array.String]]'' albumartist]
* [''[[#Array.Integer|Array.Integer]]'' albumartistid]
* [''[[#Library.Id|Library.Id]]'' albumid = -1]
* [''string'' albumlabel]
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' albumreleasetype = album]
* [''string'' albumstatus]
* [''integer'' bitrate]
* [''integer'' bpm]
* [''[[#Video.Cast|Video.Cast]]'' cast]
* [''integer'' channels]
* [''string'' comment]
* [''boolean'' compilation]
* [''[[#Audio.Contributors|Audio.Contributors]]'' contributors]
* [''[[#Array.String|Array.String]]'' country]
* [''[[#Item.CustomProperties|Item.CustomProperties]]'' customproperties]
* [''string'' description]
* [''integer'' disc]
* [''string'' disctitle]
* [''string'' displaycomposer]
* [''string'' displayconductor]
* [''string'' displaylyricist]
* [''string'' displayorchestra]
* [''integer'' duration]
* [''string'' dynpath]
* [''integer'' episode]
* [''string'' episodeguide]
* [''string'' firstaired]
* [''[[#Library.Id|Library.Id]]'' id = -1]
* [''string'' imdbnumber]
* [''boolean'' isboxset]
* [''string'' lyrics]
* [''string'' mediapath]
* [''[[#Array.String|Array.String]]'' mood]
* [''string'' mpaa]
* [''[[#Array.String|Array.String]]'' musicbrainzartistid]
* [''string'' musicbrainztrackid]
* [''string'' originaldate]
* [''string'' originaltitle]
* [''string'' plotoutline]
* [''string'' premiered]
* [''string'' productioncode]
* [''string'' releasedate]
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = album]
* [''integer'' samplerate]
* [''integer'' season]
* [''string'' set]
* [''[[#Library.Id|Library.Id]]'' setid = -1]
* [''[[#Array.String|Array.String]]'' showlink]
* [''string'' showtitle]
* [''string'' songvideourl]
* [''string'' sorttitle]
* [''integer'' specialsortepisode]
* [''integer'' specialsortseason]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Array.String|Array.String]]'' style]
* [''[[#Array.String|Array.String]]'' tag]
* [''string'' tagline]
* [''[[#Array.String|Array.String]]'' theme]
* [''integer'' top250]
* [''integer'' totaldiscs]
* [''integer'' track]
* [''string'' trailer]
* [''[[#Library.Id|Library.Id]]'' tvshowid = -1]
* [''string'' type = unknown]
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''string'' votes]
* [''integer'' watchedepisodes]
* [''[[#Array.String|Array.String]]'' writer]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": [
"Video.Details.File",
"Audio.Details.Media"
],
"id": "List.Item.Base",
"properties": {
"album": {
"default": "",
"type": "string"
},
"albumartist": {
"$ref": "Array.String"
},
"albumartistid": {
"$ref": "Array.Integer"
},
"albumid": {
"$ref": "Library.Id",
"default": -1
},
"albumlabel": {
"default": "",
"type": "string"
},
"albumreleasetype": {
"$ref": "Audio.Album.ReleaseType",
"default": "album"
},
"albumstatus": {
"default": "",
"type": "string"
},
"bitrate": {
"default": 0,
"type": "integer"
},
"bpm": {
"default": 0,
"type": "integer"
},
"cast": {
"$ref": "Video.Cast"
},
"channels": {
"default": 0,
"type": "integer"
},
"comment": {
"default": "",
"type": "string"
},
"compilation": {
"default": false,
"type": "boolean"
},
"contributors": {
"$ref": "Audio.Contributors"
},
"country": {
"$ref": "Array.String"
},
"customproperties": {
"$ref": "Item.CustomProperties"
},
"description": {
"default": "",
"type": "string"
},
"disc": {
"default": 0,
"type": "integer"
},
"disctitle": {
"default": "",
"type": "string"
},
"displaycomposer": {
"default": "",
"type": "string"
},
"displayconductor": {
"default": "",
"type": "string"
},
"displaylyricist": {
"default": "",
"type": "string"
},
"displayorchestra": {
"default": "",
"type": "string"
},
"duration": {
"default": 0,
"type": "integer"
},
"dynpath": {
"default": "",
"description": "An experimental property for debug purposes, often same as mediapath but when different gives the actual file playing that should also be in file property",
"type": "string"
},
"episode": {
"default": 0,
"type": "integer"
},
"episodeguide": {
"default": "",
"type": "string"
},
"firstaired": {
"default": "",
"type": "string"
},
"id": {
"$ref": "Library.Id",
"default": -1
},
"imdbnumber": {
"default": "",
"type": "string"
},
"isboxset": {
"default": false,
"type": "boolean"
},
"lyrics": {
"default": "",
"type": "string"
},
"mediapath": {
"default": "",
"description": "Media source path that identifies the item",
"type": "string"
},
"mood": {
"$ref": "Array.String"
},
"mpaa": {
"default": "",
"type": "string"
},
"musicbrainzartistid": {
"$ref": "Array.String"
},
"musicbrainztrackid": {
"default": "",
"type": "string"
},
"originaldate": {
"default": "",
"type": "string"
},
"originaltitle": {
"default": "",
"type": "string"
},
"plotoutline": {
"default": "",
"type": "string"
},
"premiered": {
"default": "",
"type": "string"
},
"productioncode": {
"default": "",
"type": "string"
},
"releasedate": {
"default": "",
"type": "string"
},
"releasetype": {
"$ref": "Audio.Album.ReleaseType",
"default": "album"
},
"samplerate": {
"default": 0,
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"set": {
"default": "",
"type": "string"
},
"setid": {
"$ref": "Library.Id",
"default": -1
},
"showlink": {
"$ref": "Array.String"
},
"showtitle": {
"default": "",
"type": "string"
},
"songvideourl": {
"default": "",
"type": "string"
},
"sorttitle": {
"default": "",
"type": "string"
},
"specialsortepisode": {
"default": 0,
"type": "integer"
},
"specialsortseason": {
"default": 0,
"type": "integer"
},
"studio": {
"$ref": "Array.String"
},
"style": {
"$ref": "Array.String"
},
"tag": {
"$ref": "Array.String"
},
"tagline": {
"default": "",
"type": "string"
},
"theme": {
"$ref": "Array.String"
},
"top250": {
"default": 0,
"type": "integer"
},
"totaldiscs": {
"default": 0,
"type": "integer"
},
"track": {
"default": 0,
"type": "integer"
},
"trailer": {
"default": "",
"type": "string"
},
"tvshowid": {
"$ref": "Library.Id",
"default": -1
},
"type": {
"default": "unknown",
"enums": [
"unknown",
"movie",
"episode",
"musicvideo",
"song",
"picture",
"channel",
"recording"
],
"type": "string"
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"votes": {
"default": "",
"type": "string"
},
"watchedepisodes": {
"default": 0,
"type": "integer"
},
"writer": {
"$ref": "Array.String"
}
}
}
</syntaxhighlight>}}
==== List.Item.File ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' file
* ''string'' filetype
* [''string'' lastmodified]
* [''string'' mimetype]
* [''integer'' size]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Item.Base",
"id": "List.Item.File",
"properties": {
"file": {
"required": true,
"type": "string"
},
"filetype": {
"enums": [
"file",
"directory"
],
"required": true,
"type": "string"
},
"lastmodified": {
"default": "",
"type": "string"
},
"mimetype": {
"default": "",
"type": "string"
},
"size": {
"default": 0,
"description": "Size of the file in bytes",
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== List.Items.Sources ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Items.Sources",
"items": {
"extends": "Item.Details.Base",
"properties": {
"file": {
"required": true,
"type": "string"
}
}
},
"type": "array"
}
</syntaxhighlight>}}
==== List.Limits ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#List.Amount|List.Amount]]'' end = -1]
* [''integer'' start]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "List.Limits",
"properties": {
"end": {
"$ref": "List.Amount",
"default": -1,
"description": "Index of the last item to return"
},
"start": {
"default": 0,
"description": "Index of the first item to return",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== List.LimitsReturned ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#List.Amount|List.Amount]]'' end = -1]
* [''integer'' start]
* ''integer'' total
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "List.LimitsReturned",
"properties": {
"end": {
"$ref": "List.Amount",
"default": -1
},
"start": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"total": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== List.Sort ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''boolean'' ignorearticle]
* [''string'' method = none]
* [''string'' order = ascending]
* [''boolean'' useartistsortname]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Sort",
"properties": {
"ignorearticle": {
"default": false,
"type": "boolean"
},
"method": {
"default": "none",
"enums": [
"none",
"label",
"date",
"size",
"file",
"path",
"drivetype",
"title",
"track",
"time",
"artist",
"album",
"albumtype",
"genre",
"country",
"year",
"rating",
"userrating",
"votes",
"top250",
"programcount",
"playlist",
"episode",
"season",
"totalepisodes",
"watchedepisodes",
"tvshowstatus",
"tvshowtitle",
"sorttitle",
"productioncode",
"mpaa",
"studio",
"dateadded",
"lastplayed",
"playcount",
"listeners",
"bitrate",
"random",
"totaldiscs",
"originaldate",
"bpm",
"originaltitle"
],
"type": "string"
},
"order": {
"default": "ascending",
"enums": [
"ascending",
"descending"
],
"type": "string"
},
"useartistsortname": {
"default": false,
"type": "boolean"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Media ===
==== Media.Artwork ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' banner]
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' fanart]
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' poster]
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' thumb]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"id": "Media.Artwork",
"properties": {
"banner": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"fanart": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"poster": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"thumb": {
"$ref": "Global.String.NotEmpty",
"default": ""
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Media.Artwork.Set ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' banner]
* [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' fanart]
* [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' poster]
* [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' thumb]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"default": null,
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"id": "Media.Artwork.Set",
"properties": {
"banner": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"fanart": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"poster": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"thumb": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Media.Details.Base ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' fanart]
* [''string'' thumbnail]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Media.Details.Base",
"properties": {
"fanart": {
"default": "",
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Media.UniqueID ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"id": "Media.UniqueID",
"type": "object"
}
</syntaxhighlight>}}
==== Media.UniqueID.Set ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"default": null,
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"id": "Media.UniqueID.Set",
"type": "object"
}
</syntaxhighlight>}}
=== Notifications ===
==== Notifications.Item ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Notifications.Item",
"type": [
{
"description": "An unknown item does not have any additional information.",
"properties": {
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "An item known to the database has an identification.",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A movie item has a title and may have a release year.",
"properties": {
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
},
"year": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
{
"description": "A tv episode has a title and may have an episode number, season number and the title of the show it belongs to.",
"properties": {
"episode": {
"default": 0,
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"showtitle": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A music video has a title and may have an album and an artist.",
"properties": {
"album": {
"default": "",
"type": "string"
},
"artist": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A song has a title and may have an album, an artist and a track number.",
"properties": {
"album": {
"default": "",
"type": "string"
},
"artist": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"track": {
"default": 0,
"type": "integer"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A picture has a file path.",
"properties": {
"file": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A PVR channel is either a radio or tv channel and has a title.",
"properties": {
"channeltype": {
"$ref": "PVR.Channel.Type",
"required": true
},
"id": {
"$ref": "Library.Id",
"required": true
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
}
]
}
</syntaxhighlight>}}
==== Notifications.Item.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"movie",
"episode",
"musicvideo",
"song",
"picture",
"channel"
],
"id": "Notifications.Item.Type",
"type": "string"
}
</syntaxhighlight>}}
=== Optional ===
==== Optional.Boolean ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Optional.Boolean",
"type": [
{
"type": "null"
},
{
"type": "boolean"
}
]
}
</syntaxhighlight>}}
==== Optional.Integer ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Optional.Integer",
"type": [
{
"type": "null"
},
{
"type": "integer"
}
]
}
</syntaxhighlight>}}
==== Optional.Number ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Optional.Number",
"type": [
{
"type": "null"
},
{
"type": "number"
}
]
}
</syntaxhighlight>}}
==== Optional.String ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Optional.String",
"type": [
{
"type": "null"
},
{
"type": "string"
}
]
}
</syntaxhighlight>}}
=== PVR ===
==== PVR.Channel.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "tv",
"enums": [
"tv",
"radio"
],
"id": "PVR.Channel.Type",
"type": "string"
}
</syntaxhighlight>}}
==== PVR.ChannelGroup.Id ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "PVR.ChannelGroup.Id",
"type": [
{
"$ref": "Library.Id"
},
{
"enums": [
"alltv",
"allradio"
],
"type": "string"
}
]
}
</syntaxhighlight>}}
==== PVR.Details.Broadcast ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' broadcastid
* [''string'' cast]
* [''[[#Library.Id|Library.Id]]'' clientid = -1]
* [''string'' director]
* [''string'' endtime]
* [''integer'' episode]
* [''string'' episodename]
* [''integer'' episodenum]
* [''integer'' episodepart]
* [''string'' firstaired]
* [''string'' genre]
* [''boolean'' hasrecording]
* [''boolean'' hasreminder]
* [''boolean'' hastimer]
* [''boolean'' hastimerrule]
* [''integer'' imdbnumber]
* [''boolean'' isactive]
* [''boolean'' isplayable]
* [''boolean'' isseries]
* [''string'' originaltitle]
* [''integer'' parentalrating]
* [''string'' plot]
* [''string'' plotoutline]
* [''integer'' progress]
* [''number'' progresspercentage]
* [''integer'' rating]
* [''string'' recording]
* [''integer'' runtime]
* [''integer'' season]
* [''integer'' seasonnum]
* [''string'' starttime]
* [''string'' thumbnail]
* [''string'' title]
* [''boolean'' wasactive]
* [''string'' writer]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Broadcast",
"properties": {
"broadcastid": {
"$ref": "Library.Id",
"required": true
},
"cast": {
"default": "",
"type": "string"
},
"clientid": {
"$ref": "Library.Id",
"default": -1
},
"director": {
"default": "",
"type": "string"
},
"endtime": {
"default": "",
"type": "string"
},
"episode": {
"default": 0,
"type": "integer"
},
"episodename": {
"default": "",
"type": "string"
},
"episodenum": {
"default": 0,
"description": "Deprecated - Use episode",
"type": "integer"
},
"episodepart": {
"default": 0,
"type": "integer"
},
"firstaired": {
"default": "",
"type": "string"
},
"genre": {
"default": "",
"type": "string"
},
"hasrecording": {
"default": false,
"type": "boolean"
},
"hasreminder": {
"default": false,
"type": "boolean"
},
"hastimer": {
"default": false,
"type": "boolean"
},
"hastimerrule": {
"default": false,
"type": "boolean"
},
"imdbnumber": {
"default": 0,
"type": "integer"
},
"isactive": {
"default": false,
"type": "boolean"
},
"isplayable": {
"default": false,
"description": "Deprecated - Use GetBroadcastIsPlayable instead",
"type": "boolean"
},
"isseries": {
"default": false,
"type": "boolean"
},
"originaltitle": {
"default": "",
"type": "string"
},
"parentalrating": {
"default": 0,
"type": "integer"
},
"plot": {
"default": "",
"type": "string"
},
"plotoutline": {
"default": "",
"type": "string"
},
"progress": {
"default": 0,
"type": "integer"
},
"progresspercentage": {
"default": 0.0,
"type": "number"
},
"rating": {
"default": 0,
"type": "integer"
},
"recording": {
"default": "",
"type": "string"
},
"runtime": {
"default": 0,
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"seasonnum": {
"default": 0,
"description": "Deprecated - Use season",
"type": "integer"
},
"starttime": {
"default": "",
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
},
"wasactive": {
"default": false,
"type": "boolean"
},
"writer": {
"default": "",
"type": "string"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== PVR.Details.Channel ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastnext]
* [''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastnow]
* [''string'' channel]
* ''[[#Library.Id|Library.Id]]'' channelid
* [''integer'' channelnumber]
* [''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = tv]
* [''[[#Library.Id|Library.Id]]'' clientid = -1]
* [''boolean'' hasarchive]
* [''boolean'' hidden]
* [''string'' icon]
* [''boolean'' isrecording]
* [''string'' lastplayed]
* [''boolean'' locked]
* [''integer'' subchannelnumber]
* [''string'' thumbnail]
* ''integer'' uniqueid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Channel",
"properties": {
"broadcastnext": {
"$ref": "PVR.Details.Broadcast"
},
"broadcastnow": {
"$ref": "PVR.Details.Broadcast"
},
"channel": {
"default": "",
"type": "string"
},
"channelid": {
"$ref": "Library.Id",
"required": true
},
"channelnumber": {
"default": 0,
"type": "integer"
},
"channeltype": {
"$ref": "PVR.Channel.Type",
"default": "tv"
},
"clientid": {
"$ref": "Library.Id",
"default": -1
},
"hasarchive": {
"default": false,
"type": "boolean"
},
"hidden": {
"default": false,
"type": "boolean"
},
"icon": {
"default": "",
"type": "string"
},
"isrecording": {
"default": false,
"type": "boolean"
},
"lastplayed": {
"default": "",
"type": "string"
},
"locked": {
"default": false,
"type": "boolean"
},
"subchannelnumber": {
"default": 0,
"type": "integer"
},
"thumbnail": {
"default": "",
"type": "string"
},
"uniqueid": {
"required": true,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== PVR.Details.ChannelGroup ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' channelgroupid
* ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.ChannelGroup",
"properties": {
"channelgroupid": {
"$ref": "Library.Id",
"required": true
},
"channeltype": {
"$ref": "PVR.Channel.Type",
"required": true
}
}
}
</syntaxhighlight>}}
==== PVR.Details.ChannelGroup.Extended ====
'''Extends:'''
* ''[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' channels]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "PVR.Details.ChannelGroup",
"id": "PVR.Details.ChannelGroup.Extended",
"properties": {
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
</syntaxhighlight>}}
==== PVR.Details.Client ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' addonid]
* ''[[#Library.Id|Library.Id]]'' clientid
* [''boolean'' supportschannelgroups]
* [''boolean'' supportschannelscan]
* [''boolean'' supportsepg]
* [''boolean'' supportsradio]
* [''boolean'' supportsrecordings]
* [''boolean'' supportstimers]
* [''boolean'' supportstv]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Client",
"properties": {
"addonid": {
"default": "",
"type": "string"
},
"clientid": {
"$ref": "Library.Id",
"required": true
},
"supportschannelgroups": {
"default": false,
"type": "boolean"
},
"supportschannelscan": {
"default": false,
"type": "boolean"
},
"supportsepg": {
"default": false,
"type": "boolean"
},
"supportsradio": {
"default": false,
"type": "boolean"
},
"supportsrecordings": {
"default": false,
"type": "boolean"
},
"supportstimers": {
"default": false,
"type": "boolean"
},
"supportstv": {
"default": false,
"type": "boolean"
}
}
}
</syntaxhighlight>}}
==== PVR.Details.Recording ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Media.Artwork|Media.Artwork]]'' art]
* [''string'' channel]
* [''integer'' channeluid]
* [''[[#Library.Id|Library.Id]]'' clientid = -1]
* [''string'' directory]
* [''string'' endtime]
* [''integer'' epgeventid]
* [''integer'' episode]
* [''string'' file]
* [''string'' genre]
* [''string'' icon]
* [''boolean'' isdeleted]
* [''integer'' lifetime]
* [''integer'' playcount]
* [''string'' plot]
* [''string'' plotoutline]
* [''boolean'' radio]
* ''[[#Library.Id|Library.Id]]'' recordingid
* [''[[#Video.Resume|Video.Resume]]'' resume]
* [''integer'' runtime]
* [''integer'' season]
* [''string'' showtitle]
* [''string'' starttime]
* [''string'' streamurl]
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Recording",
"properties": {
"art": {
"$ref": "Media.Artwork"
},
"channel": {
"default": "",
"type": "string"
},
"channeluid": {
"default": 0,
"type": "integer"
},
"clientid": {
"$ref": "Library.Id",
"default": -1
},
"directory": {
"default": "",
"type": "string"
},
"endtime": {
"default": "",
"type": "string"
},
"epgeventid": {
"default": 0,
"type": "integer"
},
"episode": {
"default": 0,
"type": "integer"
},
"file": {
"default": "",
"type": "string"
},
"genre": {
"default": "",
"type": "string"
},
"icon": {
"default": "",
"type": "string"
},
"isdeleted": {
"default": false,
"type": "boolean"
},
"lifetime": {
"default": 0,
"type": "integer"
},
"playcount": {
"default": 0,
"type": "integer"
},
"plot": {
"default": "",
"type": "string"
},
"plotoutline": {
"default": "",
"type": "string"
},
"radio": {
"default": false,
"type": "boolean"
},
"recordingid": {
"$ref": "Library.Id",
"required": true
},
"resume": {
"$ref": "Video.Resume"
},
"runtime": {
"default": 0,
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"showtitle": {
"default": "",
"type": "string"
},
"starttime": {
"default": "",
"type": "string"
},
"streamurl": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== PVR.Details.Timer ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Library.Id|Library.Id]]'' broadcastid = -1]
* [''[[#Library.Id|Library.Id]]'' channelid = -1]
* [''[[#Library.Id|Library.Id]]'' clientid = -1]
* [''string'' directory]
* [''boolean'' endanytime]
* [''integer'' endmargin]
* [''string'' endtime]
* [''string'' epgsearchstring]
* [''integer'' epguid]
* [''string'' file]
* [''string'' firstday]
* [''boolean'' fulltextepgsearch]
* [''boolean'' ismanual]
* [''boolean'' isradio]
* [''boolean'' isreadonly]
* [''boolean'' isreminder]
* [''boolean'' istimerrule]
* [''integer'' lifetime]
* [''integer'' maxrecordings]
* [''integer'' preventduplicateepisodes]
* [''integer'' priority]
* [''integer'' recordinggroup]
* [''integer'' runtime]
* [''boolean'' startanytime]
* [''integer'' startmargin]
* [''string'' starttime]
* [''[[#PVR.TimerState|PVR.TimerState]]'' state = unknown]
* [''string'' summary]
* ''[[#Library.Id|Library.Id]]'' timerid
* [''string'' title]
* [''array'' weekdays]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Timer",
"properties": {
"broadcastid": {
"$ref": "Library.Id",
"default": -1
},
"channelid": {
"$ref": "Library.Id",
"default": -1
},
"clientid": {
"$ref": "Library.Id",
"default": -1
},
"directory": {
"default": "",
"type": "string"
},
"endanytime": {
"default": false,
"type": "boolean"
},
"endmargin": {
"default": 0,
"type": "integer"
},
"endtime": {
"default": "",
"type": "string"
},
"epgsearchstring": {
"default": "",
"type": "string"
},
"epguid": {
"default": 0,
"type": "integer"
},
"file": {
"default": "",
"type": "string"
},
"firstday": {
"default": "",
"type": "string"
},
"fulltextepgsearch": {
"default": false,
"type": "boolean"
},
"ismanual": {
"default": false,
"type": "boolean"
},
"isradio": {
"default": false,
"type": "boolean"
},
"isreadonly": {
"default": false,
"type": "boolean"
},
"isreminder": {
"default": false,
"type": "boolean"
},
"istimerrule": {
"default": false,
"type": "boolean"
},
"lifetime": {
"default": 0,
"type": "integer"
},
"maxrecordings": {
"default": 0,
"type": "integer"
},
"preventduplicateepisodes": {
"default": 0,
"type": "integer"
},
"priority": {
"default": 0,
"type": "integer"
},
"recordinggroup": {
"default": 0,
"type": "integer"
},
"runtime": {
"default": 0,
"type": "integer"
},
"startanytime": {
"default": false,
"type": "boolean"
},
"startmargin": {
"default": 0,
"type": "integer"
},
"starttime": {
"default": "",
"type": "string"
},
"state": {
"$ref": "PVR.TimerState",
"default": "unknown"
},
"summary": {
"default": "",
"type": "string"
},
"timerid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
},
"weekdays": {
"items": {
"$ref": "Global.Weekday"
},
"type": "array",
"uniqueItems": true
}
}
}
</syntaxhighlight>}}
==== PVR.Fields.Broadcast ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Broadcast",
"items": {
"enums": [
"title",
"plot",
"plotoutline",
"starttime",
"endtime",
"runtime",
"progress",
"progresspercentage",
"genre",
"episode",
"episodename",
"episodenum",
"episodepart",
"firstaired",
"hastimer",
"isactive",
"parentalrating",
"wasactive",
"thumbnail",
"rating",
"originaltitle",
"cast",
"director",
"writer",
"year",
"imdbnumber",
"hastimerrule",
"hasrecording",
"recording",
"isseries",
"isplayable",
"clientid",
"hasreminder",
"season",
"seasonnum"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Fields.Channel ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Channel",
"items": {
"enums": [
"thumbnail",
"channeltype",
"hidden",
"locked",
"channel",
"lastplayed",
"broadcastnow",
"broadcastnext",
"uniqueid",
"icon",
"channelnumber",
"subchannelnumber",
"isrecording",
"hasarchive",
"clientid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Fields.Client ====
'''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="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Client",
"items": {
"enums": [
"addonid",
"supportstv",
"supportsradio",
"supportsepg",
"supportsrecordings",
"supportstimers",
"supportschannelgroups",
"supportschannelscan"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Fields.Recording ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Recording",
"items": {
"enums": [
"title",
"plot",
"plotoutline",
"genre",
"playcount",
"resume",
"channel",
"starttime",
"endtime",
"runtime",
"lifetime",
"icon",
"art",
"streamurl",
"file",
"directory",
"radio",
"isdeleted",
"epgeventid",
"channeluid",
"season",
"episode",
"showtitle",
"clientid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Fields.Timer ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Timer",
"items": {
"enums": [
"title",
"summary",
"channelid",
"isradio",
"istimerrule",
"ismanual",
"starttime",
"endtime",
"runtime",
"lifetime",
"firstday",
"weekdays",
"priority",
"startmargin",
"endmargin",
"state",
"file",
"directory",
"preventduplicateepisodes",
"startanytime",
"endanytime",
"epgsearchstring",
"fulltextepgsearch",
"recordinggroup",
"maxrecordings",
"epguid",
"isreadonly",
"isreminder",
"clientid",
"broadcastid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "available",
"enums": [
"available",
"recording",
"scanning"
],
"id": "PVR.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== PVR.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''boolean'' available]
* [''boolean'' recording]
* [''boolean'' scanning]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "PVR.Property.Value",
"properties": {
"available": {
"default": false,
"type": "boolean"
},
"recording": {
"default": false,
"type": "boolean"
},
"scanning": {
"default": false,
"type": "boolean"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== PVR.TimerState ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"new",
"scheduled",
"recording",
"completed",
"aborted",
"cancelled",
"conflict_ok",
"conflict_notok",
"error",
"disabled"
],
"id": "PVR.TimerState",
"type": "string"
}
</syntaxhighlight>}}
=== Player ===
==== Player.Audio.Stream ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' bitrate
* ''integer'' bitspersample
* ''integer'' channels
* ''string'' codec
* ''integer'' index
* ''boolean'' isdefault
* ''boolean'' isimpaired
* ''boolean'' isoriginal
* ''string'' language
* ''string'' name
* ''integer'' samplerate
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Audio.Stream",
"properties": {
"bitrate": {
"required": true,
"type": "integer"
},
"bitspersample": {
"required": true,
"type": "integer"
},
"channels": {
"required": true,
"type": "integer"
},
"codec": {
"required": true,
"type": "string"
},
"index": {
"minimum": 0,
"required": true,
"type": "integer"
},
"isdefault": {
"required": true,
"type": "boolean"
},
"isimpaired": {
"required": true,
"type": "boolean"
},
"isoriginal": {
"required": true,
"type": "boolean"
},
"language": {
"required": true,
"type": "string"
},
"name": {
"required": true,
"type": "string"
},
"samplerate": {
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Chapter ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' index
* [''string'' name]
* ''integer'' time
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Single chapter of the currently playing video",
"id": "Player.Chapter",
"properties": {
"index": {
"description": "One-based chapter index",
"required": true,
"type": "integer"
},
"name": {
"default": "",
"description": "Chapter name if available",
"type": "string"
},
"time": {
"description": "Chapter position in seconds from start",
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.CustomViewMode ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''mixed: string|[[#Optional.Boolean|Optional.Boolean]]'' nonlinearstretch]
* [''mixed: string|[[#Optional.Number|Optional.Number]]'' pixelratio]
* [''mixed: string|[[#Optional.Number|Optional.Number]]'' verticalshift]
* [''mixed: string|[[#Optional.Number|Optional.Number]]'' zoom]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.CustomViewMode",
"properties": {
"nonlinearstretch": {
"default": null,
"type": [
{
"enums": [
"increase",
"decrease"
],
"type": "string"
},
{
"$ref": "Optional.Boolean",
"description": "Flag to enable nonlinear stretch"
}
]
},
"pixelratio": {
"default": null,
"type": [
{
"enums": [
"increase",
"decrease"
],
"type": "string"
},
{
"$ref": "Optional.Number",
"description": "Pixel aspect ratio where 1.0 means square pixel"
}
]
},
"verticalshift": {
"default": null,
"type": [
{
"enums": [
"increase",
"decrease"
],
"type": "string"
},
{
"$ref": "Optional.Number",
"description": "Vertical shift 1.0 means shift to bottom"
}
]
},
"zoom": {
"default": null,
"type": [
{
"enums": [
"increase",
"decrease"
],
"type": "string"
},
{
"$ref": "Optional.Number",
"description": "Zoom where 1.0 means 100%"
}
]
}
},
"required": true,
"type": "object"
}
</syntaxhighlight>}}
==== Player.Id ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "Player.Id",
"maximum": 2,
"minimum": 0,
"type": "integer"
}
</syntaxhighlight>}}
==== Player.Notifications.Data ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Notifications.Item|Notifications.Item]]'' item
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Notifications.Data",
"properties": {
"item": {
"$ref": "Notifications.Item",
"required": true
},
"player": {
"$ref": "Player.Notifications.Player",
"required": true
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Notifications.Player ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Player.Id|Player.Id]]'' playerid
* [''integer'' speed]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Notifications.Player",
"properties": {
"playerid": {
"$ref": "Player.Id",
"required": true
},
"speed": {
"default": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Notifications.Player.Seek ====
'''Extends:'''
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Global.Time|Global.Time]]'' seekoffset]
* [''[[#Global.Time|Global.Time]]'' time]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Player.Notifications.Player",
"id": "Player.Notifications.Player.Seek",
"properties": {
"seekoffset": {
"$ref": "Global.Time",
"description": "A duration."
},
"time": {
"$ref": "Global.Time",
"description": "A duration."
}
}
}
</syntaxhighlight>}}
==== Player.Position.Percentage ====
'''Type:''' ''number''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": 0.0,
"id": "Player.Position.Percentage",
"maximum": 100.0,
"minimum": 0.0,
"type": "number"
}
</syntaxhighlight>}}
==== Player.Position.Time ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' hours]
* [''integer'' milliseconds]
* [''integer'' minutes]
* [''integer'' seconds]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"description": "A position in duration.",
"id": "Player.Position.Time",
"properties": {
"hours": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"milliseconds": {
"default": 0,
"maximum": 999,
"minimum": 0,
"type": "integer"
},
"minutes": {
"default": 0,
"maximum": 59,
"minimum": 0,
"type": "integer"
},
"seconds": {
"default": 0,
"maximum": 59,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "type",
"enums": [
"type",
"partymode",
"speed",
"time",
"percentage",
"totaltime",
"playlistid",
"position",
"repeat",
"shuffled",
"canseek",
"canchangespeed",
"canmove",
"canzoom",
"canrotate",
"canshuffle",
"canrepeat",
"currentaudiostream",
"audiostreams",
"subtitleenabled",
"currentsubtitle",
"subtitles",
"live",
"currentvideostream",
"videostreams",
"cachepercentage"
],
"id": "Player.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== Player.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' audiostreams]
* [''[[#Player.Position.Percentage|Player.Position.Percentage]]'' cachepercentage]
* [''boolean'' canchangespeed]
* [''boolean'' canmove]
* [''boolean'' canrepeat]
* [''boolean'' canrotate]
* [''boolean'' canseek]
* [''boolean'' canshuffle]
* [''boolean'' canzoom]
* [''[[#Player.Audio.Stream|Player.Audio.Stream]]'' currentaudiostream]
* [''[[#Player.Subtitle|Player.Subtitle]]'' currentsubtitle]
* [''[[#Player.Video.Stream|Player.Video.Stream]]'' currentvideostream]
* [''boolean'' live]
* [''boolean'' partymode]
* [''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage]
* [''[[#Playlist.Id|Playlist.Id]]'' playlistid = -1]
* [''[[#Playlist.Position|Playlist.Position]]'' position = -1]
* [''[[#Player.Repeat|Player.Repeat]]'' repeat = off]
* [''boolean'' shuffled]
* [''integer'' speed]
* [''boolean'' subtitleenabled]
* [''array'' subtitles]
* [''[[#Global.Time|Global.Time]]'' time]
* [''[[#Global.Time|Global.Time]]'' totaltime]
* [''[[#Player.Type|Player.Type]]'' type = video]
* [''array'' videostreams]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Property.Value",
"properties": {
"audiostreams": {
"items": {
"$ref": "Player.Audio.Stream"
},
"type": "array"
},
"cachepercentage": {
"$ref": "Player.Position.Percentage",
"default": 0.0
},
"canchangespeed": {
"default": false,
"type": "boolean"
},
"canmove": {
"default": false,
"type": "boolean"
},
"canrepeat": {
"default": false,
"type": "boolean"
},
"canrotate": {
"default": false,
"type": "boolean"
},
"canseek": {
"default": false,
"type": "boolean"
},
"canshuffle": {
"default": false,
"type": "boolean"
},
"canzoom": {
"default": false,
"type": "boolean"
},
"currentaudiostream": {
"$ref": "Player.Audio.Stream"
},
"currentsubtitle": {
"$ref": "Player.Subtitle"
},
"currentvideostream": {
"$ref": "Player.Video.Stream"
},
"live": {
"default": false,
"type": "boolean"
},
"partymode": {
"default": false,
"type": "boolean"
},
"percentage": {
"$ref": "Player.Position.Percentage",
"default": 0.0
},
"playlistid": {
"$ref": "Playlist.Id",
"default": -1
},
"position": {
"$ref": "Playlist.Position",
"default": -1
},
"repeat": {
"$ref": "Player.Repeat",
"default": "off"
},
"shuffled": {
"default": false,
"type": "boolean"
},
"speed": {
"default": 0,
"type": "integer"
},
"subtitleenabled": {
"default": false,
"type": "boolean"
},
"subtitles": {
"items": {
"$ref": "Player.Subtitle"
},
"type": "array"
},
"time": {
"$ref": "Global.Time",
"description": "A duration."
},
"totaltime": {
"$ref": "Global.Time",
"description": "A duration."
},
"type": {
"$ref": "Player.Type",
"default": "video"
},
"videostreams": {
"items": {
"$ref": "Player.Video.Stream"
},
"type": "array"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Repeat ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "off",
"enums": [
"off",
"one",
"all"
],
"id": "Player.Repeat",
"type": "string"
}
</syntaxhighlight>}}
==== Player.Speed ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' speed]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Speed",
"properties": {
"speed": {
"default": 0,
"type": "integer"
}
},
"required": true,
"type": "object"
}
</syntaxhighlight>}}
==== Player.Subtitle ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' index
* ''boolean'' isdefault
* ''boolean'' isforced
* ''boolean'' isimpaired
* ''string'' language
* ''string'' name
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Subtitle",
"properties": {
"index": {
"minimum": 0,
"required": true,
"type": "integer"
},
"isdefault": {
"required": true,
"type": "boolean"
},
"isforced": {
"required": true,
"type": "boolean"
},
"isimpaired": {
"required": true,
"type": "boolean"
},
"language": {
"required": true,
"type": "string"
},
"name": {
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Tempo ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''number'' tempo]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Tempo",
"properties": {
"tempo": {
"default": 0.0,
"type": "number"
}
},
"required": true,
"type": "object"
}
</syntaxhighlight>}}
==== Player.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "video",
"enums": [
"video",
"audio",
"picture"
],
"id": "Player.Type",
"type": "string"
}
</syntaxhighlight>}}
==== Player.Video.Stream ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' codec
* ''integer'' height
* ''integer'' index
* ''string'' language
* ''string'' name
* ''integer'' width
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Video.Stream",
"properties": {
"codec": {
"required": true,
"type": "string"
},
"height": {
"required": true,
"type": "integer"
},
"index": {
"minimum": 0,
"required": true,
"type": "integer"
},
"language": {
"required": true,
"type": "string"
},
"name": {
"required": true,
"type": "string"
},
"width": {
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.ViewMode ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "normal",
"enums": [
"normal",
"zoom",
"stretch4x3",
"widezoom",
"stretch16x9",
"original",
"stretch16x9nonlin",
"zoom120width",
"zoom110width"
],
"id": "Player.ViewMode",
"type": "string"
}
</syntaxhighlight>}}
=== Playlist ===
==== Playlist.Id ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "Playlist.Id",
"maximum": 2,
"minimum": 0,
"type": "integer"
}
</syntaxhighlight>}}
==== Playlist.Item ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Playlist.Item",
"type": [
{
"additionalProperties": false,
"properties": {
"file": {
"description": "Path to a file (not a directory) to be added to the playlist",
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"directory": {
"required": true,
"type": "string"
},
"media": {
"$ref": "Files.Media",
"default": "files"
},
"recursive": {
"default": false,
"type": "boolean"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"movieid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"episodeid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"musicvideoid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Identification of a genre from the AudioLibrary",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"recordingid": {
"$ref": "Library.Id",
"description": "Identification of a PVR recording",
"required": true
}
},
"type": "object"
}
]
}
</syntaxhighlight>}}
==== Playlist.Position ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "Playlist.Position",
"minimum": 0,
"type": "integer"
}
</syntaxhighlight>}}
==== Playlist.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "type",
"enums": [
"type",
"size"
],
"id": "Playlist.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== Playlist.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' size]
* [''[[#Playlist.Type|Playlist.Type]]'' type = unknown]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Playlist.Property.Value",
"properties": {
"size": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"type": {
"$ref": "Playlist.Type",
"default": "unknown"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Playlist.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"video",
"audio",
"picture",
"mixed"
],
"id": "Playlist.Type",
"type": "string"
}
</syntaxhighlight>}}
=== Profiles ===
==== Profiles.Details.Profile ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' lockmode]
* [''string'' thumbnail]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Profiles.Details.Profile",
"properties": {
"lockmode": {
"default": 0,
"type": "integer"
},
"thumbnail": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Profiles.Fields.Profile ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Profiles.Fields.Profile",
"items": {
"enums": [
"thumbnail",
"lockmode"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Profiles.Password ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' encryption = md5]
* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Profiles.Password",
"properties": {
"encryption": {
"default": "md5",
"description": "Password Encryption",
"enums": [
"none",
"md5"
],
"type": "string"
},
"value": {
"description": "Password",
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Setting ===
==== Setting.Details.Base ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' help]
* ''string'' id
* ''string'' label
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Details.Base",
"properties": {
"help": {
"default": "",
"type": "string"
},
"id": {
"minLength": 1,
"required": true,
"type": "string"
},
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Setting.Details.Category ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' groups]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.Base",
"id": "Setting.Details.Category",
"properties": {
"groups": {
"items": {
"$ref": "Setting.Details.Group"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.Control ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Details.Control",
"type": [
{
"$ref": "Setting.Details.ControlCheckmark"
},
{
"$ref": "Setting.Details.ControlSpinner"
},
{
"$ref": "Setting.Details.ControlEdit"
},
{
"$ref": "Setting.Details.ControlButton"
},
{
"$ref": "Setting.Details.ControlList"
},
{
"$ref": "Setting.Details.ControlSlider"
},
{
"$ref": "Setting.Details.ControlRange"
},
{
"$ref": "Setting.Details.ControlLabel"
}
]
}
</syntaxhighlight>}}
==== Setting.Details.ControlBase ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' delayed
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Details.ControlBase",
"properties": {
"delayed": {
"required": true,
"type": "boolean"
},
"format": {
"required": true,
"type": "string"
},
"type": {
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Setting.Details.ControlButton ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlHeading",
"id": "Setting.Details.ControlButton",
"properties": {
"type": {
"enums": [
"button"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlCheckmark ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlCheckmark",
"properties": {
"format": {
"enums": [
"boolean"
],
"required": true,
"type": "string"
},
"type": {
"enums": [
"toggle"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlEdit ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' hidden
* ''string'' type
* ''boolean'' verifynewvalue
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlHeading",
"id": "Setting.Details.ControlEdit",
"properties": {
"hidden": {
"required": true,
"type": "boolean"
},
"type": {
"enums": [
"edit"
],
"required": true,
"type": "string"
},
"verifynewvalue": {
"required": true,
"type": "boolean"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlHeading ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' heading]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlHeading",
"properties": {
"heading": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlLabel ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlLabel",
"properties": {
"format": {
"enums": [
"string"
],
"required": true,
"type": "string"
},
"type": {
"enums": [
"label"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlList ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' multiselect
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlHeading",
"id": "Setting.Details.ControlList",
"properties": {
"multiselect": {
"required": true,
"type": "boolean"
},
"type": {
"enums": [
"list"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlRange ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' formatlabel
* ''string'' formatvalue
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlRange",
"properties": {
"formatlabel": {
"required": true,
"type": "string"
},
"formatvalue": {
"required": true,
"type": "string"
},
"type": {
"enums": [
"range"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlSlider ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' formatlabel
* ''boolean'' popup
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlHeading",
"id": "Setting.Details.ControlSlider",
"properties": {
"formatlabel": {
"required": true,
"type": "string"
},
"popup": {
"required": true,
"type": "boolean"
},
"type": {
"enums": [
"slider"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlSpinner ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' formatlabel]
* [''string'' minimumlabel]
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlSpinner",
"properties": {
"formatlabel": {
"default": "",
"type": "string"
},
"minimumlabel": {
"default": "",
"type": "string"
},
"type": {
"enums": [
"spinner"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.Group ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' id
* [''array'' settings]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Setting.Details.Group",
"properties": {
"id": {
"minLength": 1,
"required": true,
"type": "string"
},
"settings": {
"items": {
"$ref": "Setting.Details.Setting"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Setting.Details.Section ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' categories]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.Base",
"id": "Setting.Details.Section",
"properties": {
"categories": {
"items": {
"$ref": "Setting.Details.Category"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.Setting ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Details.Setting",
"type": [
{
"$ref": "Setting.Details.SettingBool"
},
{
"$ref": "Setting.Details.SettingInt"
},
{
"$ref": "Setting.Details.SettingNumber"
},
{
"$ref": "Setting.Details.SettingString"
},
{
"$ref": "Setting.Details.SettingAction"
},
{
"$ref": "Setting.Details.SettingList"
},
{
"$ref": "Setting.Details.SettingPath"
},
{
"$ref": "Setting.Details.SettingAddon"
},
{
"$ref": "Setting.Details.SettingDate"
},
{
"$ref": "Setting.Details.SettingTime"
}
]
}
</syntaxhighlight>}}
==== Setting.Details.SettingAction ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingAction",
"properties": {
"data": {
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingAddon ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Addon.Types|Addon.Types]]'' addontype
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingString",
"id": "Setting.Details.SettingAddon",
"properties": {
"addontype": {
"$ref": "Addon.Types",
"required": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingBase ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Setting.Details.Control|Setting.Details.Control]]'' control]
* ''boolean'' enabled
* ''[[#Setting.Level|Setting.Level]]'' level
* [''string'' parent]
* ''[[#Setting.Type|Setting.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.Base",
"id": "Setting.Details.SettingBase",
"properties": {
"control": {
"$ref": "Setting.Details.Control"
},
"enabled": {
"required": true,
"type": "boolean"
},
"level": {
"$ref": "Setting.Level",
"required": true
},
"parent": {
"default": "",
"type": "string"
},
"type": {
"$ref": "Setting.Type",
"required": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingBool ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' default
* ''boolean'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingBool",
"properties": {
"default": {
"required": true,
"type": "boolean"
},
"value": {
"required": true,
"type": "boolean"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingDate ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingString",
"id": "Setting.Details.SettingDate"
}
</syntaxhighlight>}}
==== Setting.Details.SettingInt ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' default
* [''integer'' maximum]
* [''integer'' minimum]
* [''array'' options]
* [''integer'' step]
* ''integer'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingInt",
"properties": {
"default": {
"required": true,
"type": "integer"
},
"maximum": {
"default": 0,
"type": "integer"
},
"minimum": {
"default": 0,
"type": "integer"
},
"options": {
"items": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"step": {
"default": 0,
"type": "integer"
},
"value": {
"required": true,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingList ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Setting.Value.List|Setting.Value.List]]'' default
* ''[[#Setting.Details.Setting|Setting.Details.Setting]]'' definition
* ''string'' delimiter
* ''[[#Setting.Type|Setting.Type]]'' elementtype
* [''integer'' maximumitems]
* [''integer'' minimumitems]
* ''[[#Setting.Value.List|Setting.Value.List]]'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingList",
"properties": {
"default": {
"$ref": "Setting.Value.List",
"required": true
},
"definition": {
"$ref": "Setting.Details.Setting",
"required": true
},
"delimiter": {
"required": true,
"type": "string"
},
"elementtype": {
"$ref": "Setting.Type",
"required": true
},
"maximumitems": {
"default": 0,
"type": "integer"
},
"minimumitems": {
"default": 0,
"type": "integer"
},
"value": {
"$ref": "Setting.Value.List",
"required": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingNumber ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''number'' default
* ''number'' maximum
* ''number'' minimum
* ''number'' step
* ''number'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingNumber",
"properties": {
"default": {
"required": true,
"type": "number"
},
"maximum": {
"required": true,
"type": "number"
},
"minimum": {
"required": true,
"type": "number"
},
"step": {
"required": true,
"type": "number"
},
"value": {
"required": true,
"type": "number"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingPath ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' sources]
* ''boolean'' writable
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingString",
"id": "Setting.Details.SettingPath",
"properties": {
"sources": {
"items": {
"type": "string"
},
"type": "array"
},
"writable": {
"required": true,
"type": "boolean"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingString ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' allowempty
* ''string'' default
* [''array'' options]
* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingString",
"properties": {
"allowempty": {
"required": true,
"type": "boolean"
},
"default": {
"required": true,
"type": "string"
},
"options": {
"items": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"value": {
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingTime ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingString",
"id": "Setting.Details.SettingTime"
}
</syntaxhighlight>}}
==== Setting.Level ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "basic",
"enums": [
"basic",
"standard",
"advanced",
"expert"
],
"id": "Setting.Level",
"type": "string"
}
</syntaxhighlight>}}
==== Setting.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "boolean",
"enums": [
"boolean",
"integer",
"number",
"string",
"action",
"list",
"path",
"addon",
"date",
"time"
],
"id": "Setting.Type",
"type": "string"
}
</syntaxhighlight>}}
==== Setting.Value ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Setting.Value",
"type": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
}
</syntaxhighlight>}}
==== Setting.Value.Extended ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Setting.Value.Extended",
"type": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"$ref": "Setting.Value.List"
}
]
}
</syntaxhighlight>}}
==== Setting.Value.List ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Value.List",
"items": {
"$ref": "Setting.Value"
},
"type": "array"
}
</syntaxhighlight>}}
=== System ===
==== System.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "canshutdown",
"enums": [
"canshutdown",
"cansuspend",
"canhibernate",
"canreboot"
],
"id": "System.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== System.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''boolean'' canhibernate]
* [''boolean'' canreboot]
* [''boolean'' canshutdown]
* [''boolean'' cansuspend]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "System.Property.Value",
"properties": {
"canhibernate": {
"default": false,
"type": "boolean"
},
"canreboot": {
"default": false,
"type": "boolean"
},
"canshutdown": {
"default": false,
"type": "boolean"
},
"cansuspend": {
"default": false,
"type": "boolean"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Textures ===
==== Textures.Details.Size ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' height]
* [''string'' lastused]
* [''integer'' size]
* [''integer'' usecount]
* [''integer'' width]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Textures.Details.Size",
"properties": {
"height": {
"default": 0,
"description": "Height of texture",
"type": "integer"
},
"lastused": {
"default": "",
"description": "Date of last use",
"type": "string"
},
"size": {
"default": 0,
"description": "Size of the texture (1 == largest)",
"type": "integer"
},
"usecount": {
"default": 0,
"description": "Number of uses",
"type": "integer"
},
"width": {
"default": 0,
"description": "Width of texture",
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Textures.Details.Texture ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' cachedurl]
* [''string'' imagehash]
* [''string'' lasthashcheck]
* [''string'' lastlibrarycheck]
* [''array'' sizes]
* [''[[#Library.Id|Library.Id]]'' textureid = -1]
* [''string'' url]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Textures.Details.Texture",
"properties": {
"cachedurl": {
"default": "",
"description": "Cached URL on disk",
"type": "string"
},
"imagehash": {
"default": "",
"description": "Hash of image",
"type": "string"
},
"lasthashcheck": {
"default": "",
"description": "Last time source was checked for changes",
"type": "string"
},
"lastlibrarycheck": {
"default": "",
"description": "Last time texture existence was verified in library",
"type": "string"
},
"sizes": {
"items": {
"$ref": "Textures.Details.Size"
},
"type": "array"
},
"textureid": {
"$ref": "Library.Id",
"default": -1
},
"url": {
"default": "",
"description": "Original source URL",
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Textures.Fields.Texture ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Textures.Fields.Texture",
"items": {
"enums": [
"url",
"cachedurl",
"lasthashcheck",
"imagehash",
"sizes",
"lastlibrarycheck"
],
"type": "string"
}
}
</syntaxhighlight>}}
=== Video ===
==== Video.Cast ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Video.Cast",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"required": true,
"type": "string"
},
"order": {
"required": true,
"type": "integer"
},
"role": {
"required": true,
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
</syntaxhighlight>}}
==== Video.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Media.Artwork|Media.Artwork]]'' art]
* [''integer'' playcount]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Media.Details.Base",
"id": "Video.Details.Base",
"properties": {
"art": {
"$ref": "Media.Artwork"
},
"playcount": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Episode ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Video.Cast|Video.Cast]]'' cast]
* [''integer'' episode]
* ''[[#Library.Id|Library.Id]]'' episodeid
* [''string'' firstaired]
* [''[[#Array.String|Array.String]]'' genre]
* [''string'' originaltitle]
* [''string'' productioncode]
* [''number'' rating]
* [''any'' ratings]
* [''integer'' season]
* [''[[#Library.Id|Library.Id]]'' seasonid = -1]
* [''string'' showtitle]
* [''integer'' specialsortepisode]
* [''integer'' specialsortseason]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Library.Id|Library.Id]]'' tvshowid = -1]
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''integer'' userrating]
* [''string'' votes]
* [''[[#Array.String|Array.String]]'' writer]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.File",
"id": "Video.Details.Episode",
"properties": {
"cast": {
"$ref": "Video.Cast"
},
"episode": {
"default": 0,
"type": "integer"
},
"episodeid": {
"$ref": "Library.Id",
"required": true
},
"firstaired": {
"default": "",
"type": "string"
},
"genre": {
"$ref": "Array.String"
},
"originaltitle": {
"default": "",
"type": "string"
},
"productioncode": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"ratings": {
"default": null,
"type": "any"
},
"season": {
"default": 0,
"type": "integer"
},
"seasonid": {
"$ref": "Library.Id",
"default": -1
},
"showtitle": {
"default": "",
"type": "string"
},
"specialsortepisode": {
"default": 0,
"type": "integer"
},
"specialsortseason": {
"default": 0,
"type": "integer"
},
"studio": {
"$ref": "Array.String"
},
"tvshowid": {
"$ref": "Library.Id",
"default": -1
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"userrating": {
"default": 0,
"type": "integer"
},
"votes": {
"default": "",
"type": "string"
},
"writer": {
"$ref": "Array.String"
}
}
}
</syntaxhighlight>}}
==== Video.Details.File ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Array.String|Array.String]]'' director]
* [''[[#Video.Resume|Video.Resume]]'' resume]
* [''integer'' runtime]
* [''[[#Video.Streams|Video.Streams]]'' streamdetails]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Item",
"id": "Video.Details.File",
"properties": {
"director": {
"$ref": "Array.String"
},
"resume": {
"$ref": "Video.Resume"
},
"runtime": {
"default": 0,
"description": "Runtime in seconds",
"type": "integer"
},
"streamdetails": {
"$ref": "Video.Streams"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Item ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' dateadded]
* [''string'' file]
* [''string'' lastplayed]
* [''string'' plot]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Media",
"id": "Video.Details.Item",
"properties": {
"dateadded": {
"default": "",
"type": "string"
},
"file": {
"default": "",
"type": "string"
},
"lastplayed": {
"default": "",
"type": "string"
},
"plot": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Media ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Base",
"id": "Video.Details.Media",
"properties": {
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Movie ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Video.Cast|Video.Cast]]'' cast]
* [''[[#Array.String|Array.String]]'' country]
* [''[[#Array.String|Array.String]]'' genre]
* [''string'' imdbnumber]
* ''[[#Library.Id|Library.Id]]'' movieid
* [''string'' mpaa]
* [''string'' originaltitle]
* [''string'' plotoutline]
* [''string'' premiered]
* [''number'' rating]
* [''any'' ratings]
* [''string'' set]
* [''[[#Library.Id|Library.Id]]'' setid = -1]
* [''[[#Array.String|Array.String]]'' showlink]
* [''string'' sorttitle]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Array.String|Array.String]]'' tag]
* [''string'' tagline]
* [''integer'' top250]
* [''string'' trailer]
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''integer'' userrating]
* [''string'' votes]
* [''[[#Array.String|Array.String]]'' writer]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.File",
"id": "Video.Details.Movie",
"properties": {
"cast": {
"$ref": "Video.Cast"
},
"country": {
"$ref": "Array.String"
},
"genre": {
"$ref": "Array.String"
},
"imdbnumber": {
"default": "",
"type": "string"
},
"movieid": {
"$ref": "Library.Id",
"required": true
},
"mpaa": {
"default": "",
"type": "string"
},
"originaltitle": {
"default": "",
"type": "string"
},
"plotoutline": {
"default": "",
"type": "string"
},
"premiered": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"ratings": {
"default": null,
"type": "any"
},
"set": {
"default": "",
"type": "string"
},
"setid": {
"$ref": "Library.Id",
"default": -1
},
"showlink": {
"$ref": "Array.String"
},
"sorttitle": {
"default": "",
"type": "string"
},
"studio": {
"$ref": "Array.String"
},
"tag": {
"$ref": "Array.String"
},
"tagline": {
"default": "",
"type": "string"
},
"top250": {
"default": 0,
"type": "integer"
},
"trailer": {
"default": "",
"type": "string"
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"userrating": {
"default": 0,
"type": "integer"
},
"votes": {
"default": "",
"type": "string"
},
"writer": {
"$ref": "Array.String"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Details.MovieSet ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' plot]
* ''[[#Library.Id|Library.Id]]'' setid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Media",
"id": "Video.Details.MovieSet",
"properties": {
"plot": {
"default": "",
"type": "string"
},
"setid": {
"$ref": "Library.Id",
"required": true
}
}
}
</syntaxhighlight>}}
==== Video.Details.MovieSet.Extended ====
'''Extends:'''
* ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [''array'' movies]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.MovieSet",
"id": "Video.Details.MovieSet.Extended",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
}
}
</syntaxhighlight>}}
==== Video.Details.MusicVideo ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' album]
* [''[[#Array.String|Array.String]]'' artist]
* [''[[#Array.String|Array.String]]'' genre]
* ''[[#Library.Id|Library.Id]]'' musicvideoid
* [''string'' premiered]
* [''number'' rating]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Array.String|Array.String]]'' tag]
* [''integer'' track]
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''integer'' userrating]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.File",
"id": "Video.Details.MusicVideo",
"properties": {
"album": {
"default": "",
"type": "string"
},
"artist": {
"$ref": "Array.String"
},
"genre": {
"$ref": "Array.String"
},
"musicvideoid": {
"$ref": "Library.Id",
"required": true
},
"premiered": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"studio": {
"$ref": "Array.String"
},
"tag": {
"$ref": "Array.String"
},
"track": {
"default": 0,
"type": "integer"
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"userrating": {
"default": 0,
"type": "integer"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Season ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' episode]
* ''integer'' season
* ''[[#Library.Id|Library.Id]]'' seasonid
* [''string'' showtitle]
* [''string'' title]
* [''[[#Library.Id|Library.Id]]'' tvshowid = -1]
* [''integer'' userrating]
* [''integer'' watchedepisodes]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Base",
"id": "Video.Details.Season",
"properties": {
"episode": {
"default": 0,
"type": "integer"
},
"season": {
"required": true,
"type": "integer"
},
"seasonid": {
"$ref": "Library.Id",
"required": true
},
"showtitle": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
},
"tvshowid": {
"$ref": "Library.Id",
"default": -1
},
"userrating": {
"default": 0,
"type": "integer"
},
"watchedepisodes": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Details.TVShow ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Video.Cast|Video.Cast]]'' cast]
* [''integer'' episode]
* [''string'' episodeguide]
* [''[[#Array.String|Array.String]]'' genre]
* [''string'' imdbnumber]
* [''string'' mpaa]
* [''string'' originaltitle]
* [''string'' premiered]
* [''number'' rating]
* [''any'' ratings]
* [''integer'' runtime]
* [''integer'' season]
* [''string'' sorttitle]
* [''string'' status]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Array.String|Array.String]]'' tag]
* [''string'' trailer]
* ''[[#Library.Id|Library.Id]]'' tvshowid
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''integer'' userrating]
* [''string'' votes]
* [''integer'' watchedepisodes]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Item",
"id": "Video.Details.TVShow",
"properties": {
"cast": {
"$ref": "Video.Cast"
},
"episode": {
"default": 0,
"type": "integer"
},
"episodeguide": {
"default": "",
"type": "string"
},
"genre": {
"$ref": "Array.String"
},
"imdbnumber": {
"default": "",
"type": "string"
},
"mpaa": {
"default": "",
"type": "string"
},
"originaltitle": {
"default": "",
"type": "string"
},
"premiered": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"ratings": {
"default": null,
"type": "any"
},
"runtime": {
"default": 0,
"description": "Runtime in seconds",
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"sorttitle": {
"default": "",
"type": "string"
},
"status": {
"default": "",
"description": "Returns 'returning series', 'in production', 'planned', 'cancelled' or 'ended'",
"type": "string"
},
"studio": {
"$ref": "Array.String"
},
"tag": {
"$ref": "Array.String"
},
"trailer": {
"default": "",
"type": "string"
},
"tvshowid": {
"$ref": "Library.Id",
"required": true
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"userrating": {
"default": 0,
"type": "integer"
},
"votes": {
"default": "",
"type": "string"
},
"watchedepisodes": {
"default": 0,
"type": "integer"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</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="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.Episode",
"items": {
"description": "Requesting the cast, ratings, streamdetails, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"plot",
"votes",
"rating",
"writer",
"firstaired",
"playcount",
"runtime",
"director",
"productioncode",
"season",
"episode",
"originaltitle",
"showtitle",
"cast",
"streamdetails",
"lastplayed",
"fanart",
"thumbnail",
"file",
"resume",
"tvshowid",
"dateadded",
"uniqueid",
"art",
"specialsortseason",
"specialsortepisode",
"userrating",
"seasonid",
"ratings",
"genre",
"studio"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.Movie ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.Movie",
"items": {
"description": "Requesting the cast, ratings, showlink, streamdetails, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"genre",
"year",
"rating",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"playcount",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"fanart",
"thumbnail",
"file",
"sorttitle",
"resume",
"setid",
"dateadded",
"tag",
"art",
"userrating",
"ratings",
"premiered",
"uniqueid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.MovieSet ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.MovieSet",
"items": {
"enums": [
"title",
"playcount",
"fanart",
"thumbnail",
"art",
"plot"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.MusicVideo ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.MusicVideo",
"items": {
"description": "Requesting the streamdetails, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"playcount",
"runtime",
"director",
"studio",
"year",
"plot",
"album",
"artist",
"genre",
"track",
"streamdetails",
"lastplayed",
"fanart",
"thumbnail",
"file",
"resume",
"dateadded",
"tag",
"art",
"rating",
"userrating",
"premiered",
"uniqueid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.Season ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.Season",
"items": {
"enums": [
"season",
"showtitle",
"playcount",
"episode",
"fanart",
"thumbnail",
"tvshowid",
"watchedepisodes",
"art",
"userrating",
"title"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.TVShow ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.TVShow",
"items": {
"description": "Requesting the cast, ratings, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"genre",
"year",
"rating",
"plot",
"studio",
"mpaa",
"cast",
"playcount",
"episode",
"imdbnumber",
"premiered",
"votes",
"lastplayed",
"fanart",
"thumbnail",
"file",
"originaltitle",
"sorttitle",
"episodeguide",
"season",
"watchedepisodes",
"dateadded",
"tag",
"art",
"userrating",
"ratings",
"runtime",
"uniqueid",
"trailer"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Rating ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''boolean'' default]
* ''number'' rating
* [''integer'' votes]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Video.Rating",
"properties": {
"default": {
"default": false,
"type": "boolean"
},
"rating": {
"required": true,
"type": "number"
},
"votes": {
"default": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Video.Ratings ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"$ref": "Video.Rating"
},
"id": "Video.Ratings",
"type": "object"
}
</syntaxhighlight>}}
==== Video.Ratings.Set ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"default": null,
"type": [
{
"type": "null"
},
{
"$ref": "Video.Rating"
}
]
},
"id": "Video.Ratings.Set",
"type": "object"
}
</syntaxhighlight>}}
==== Video.Resume ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''number'' position]
* [''number'' total]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Video.Resume",
"properties": {
"position": {
"default": 0.0,
"minimum": 0.0,
"type": "number"
},
"total": {
"default": 0.0,
"minimum": 0.0,
"type": "number"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Video.Streams ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' audio]
* [''array'' subtitle]
* [''array'' video]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Video.Streams",
"properties": {
"audio": {
"items": {
"additionalProperties": false,
"properties": {
"channels": {
"default": 0,
"type": "integer"
},
"codec": {
"default": "",
"type": "string"
},
"language": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"subtitle": {
"items": {
"additionalProperties": false,
"properties": {
"language": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"video": {
"items": {
"additionalProperties": false,
"properties": {
"aspect": {
"default": 0.0,
"type": "number"
},
"codec": {
"default": "",
"type": "string"
},
"duration": {
"default": 0,
"type": "integer"
},
"hdrtype": {
"default": "",
"type": "string"
},
"height": {
"default": 0,
"type": "integer"
},
"width": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"minItems": 1,
"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:
#* ''boolean'' muted
#* ''integer'' volume
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The volume of the application has changed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"muted": {
"required": true,
"type": "boolean"
},
"volume": {
"maximum": 100,
"minimum": 0,
"required": true,
"type": "integer"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The audio library has been cleaned.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio library clean operation has started.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== AudioLibrary.OnExport ====
An audio library export has 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
# [''object'' data]:
#* [''integer'' failcount = 0]
#* [''string'' file = ""]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio library export has finished.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"failcount": {
"default": 0,
"minimum": 0,
"required": false,
"type": "integer"
},
"file": {
"default": "",
"required": false,
"type": "string"
}
},
"required": false,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#Library.Id|Library.Id]]'' id
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction
#* ''[[#Notifications.Library.Audio.Type|Notifications.Library.Audio.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio item has been removed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"transaction": {
"$ref": "Optional.Boolean",
"description": "True if the removal is being performed within a transaction."
},
"type": {
"$ref": "Notifications.Library.Audio.Type",
"required": true
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Scanning the audio library has been finished.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio library scan has started.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#Optional.Boolean|Optional.Boolean]]'' added
#* ''[[#Library.Id|Library.Id]]'' id
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction
#* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio item has been updated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"added": {
"$ref": "Optional.Boolean",
"description": "True if the update is for a newly added item."
},
"id": {
"$ref": "Library.Id",
"required": true
},
"transaction": {
"$ref": "Optional.Boolean",
"description": "True if the update is being performed within a transaction."
},
"type": {
"enum": [
"song"
],
"id": "Notifications.Library.Audio.Type",
"required": true,
"type": "string"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== GUI ===
==== GUI.OnDPMSActivated ====
Energy saving/DPMS has been activated.<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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Energy saving/DPMS has been activated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== GUI.OnDPMSDeactivated ====
Energy saving/DPMS has been deactivated.<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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Energy saving/DPMS has been deactivated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== GUI.OnScreensaverActivated ====
The screensaver has been activated.<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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The screensaver has been activated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== GUI.OnScreensaverDeactivated ====
The screensaver has been deactivated.<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:
#* ''boolean'' shuttingdown
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The screensaver has been deactivated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"shuttingdown": {
"required": true,
"type": "boolean"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The user has provided the requested input.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''string'' title
#* ''string'' type
#* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The user is requested to provide some information.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"title": {
"type": "string"
},
"type": {
"enum": [
"keyboard",
"time",
"date",
"ip",
"password",
"numericpassword",
"number",
"seconds"
],
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== Player ===
==== Player.OnAVChange ====
Audio- or videostream 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="json">
{
"description": "Audio- or videostream has changed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnAVStart ====
Playback of a media item has been started and first frame is available. If there is no ID available extra information will be provided.<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="json">
{
"description": "Playback of a media item has been started and first frame is available. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== 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="json">
{
"description": "Playback of a media item has been paused. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</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="json">
{
"description": "Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
#* ''[[#Player.Property.Value|Player.Property.Value]]'' property
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A property of the playing items has changed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"player": {
"$ref": "Player.Notifications.Player",
"required": true
},
"property": {
"$ref": "Player.Property.Value"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnResume ====
Playback of a media item has been resumed. 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="json">
{
"description": "Playback of a media item has been resumed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#Notifications.Item|Notifications.Item]]'' item
#* ''[[#Player.Notifications.Player.Seek|Player.Notifications.Player.Seek]]'' player
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The playback position has been changed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"item": {
"$ref": "Notifications.Item"
},
"player": {
"$ref": "Player.Notifications.Player.Seek",
"required": true
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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="json">
{
"description": "Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''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="json">
{
"description": "Playback of a media item has been stopped. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"end": {
"description": "Whether the player has reached the end of the playable item(s) or not",
"required": true,
"type": "boolean"
},
"item": {
"$ref": "Notifications.Item"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#Notifications.Item|Notifications.Item]]'' item
#* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
#* ''[[#Playlist.Position|Playlist.Position]]'' position
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A playlist item has been added.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"item": {
"$ref": "Notifications.Item"
},
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"position": {
"$ref": "Playlist.Position"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#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="json">
{
"description": "A playlist item has been cleared.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
#* ''[[#Playlist.Position|Playlist.Position]]'' position
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A playlist item has been removed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"position": {
"$ref": "Playlist.Position"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The system is on low battery.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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
# ''object'' data:
#* ''integer'' exitcode
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Kodi will be closed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"exitcode": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The system will be restarted.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The system will be suspended.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The system woke up from suspension.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The video library has been cleaned.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video library clean operation has started.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnExport ====
A video library export has 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
# [''object'' data]:
#* [''integer'' failcount = 0]
#* [''string'' file = ""]
#* [''string'' root = ""]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video library export has finished.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"failcount": {
"default": 0,
"minimum": 0,
"required": false,
"type": "integer"
},
"file": {
"default": "",
"required": false,
"type": "string"
},
"root": {
"default": "",
"required": false,
"type": "string"
}
},
"required": false,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnRefresh ====
The video library has been refreshed and a home screen reload might be necessary.<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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The video library has been refreshed and a home screen reload might be necessary.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#Library.Id|Library.Id]]'' id
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction
#* ''[[#Notifications.Library.Video.Type|Notifications.Library.Video.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video item has been removed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"transaction": {
"$ref": "Optional.Boolean",
"description": "True if the removal is being performed within a transaction."
},
"type": {
"$ref": "Notifications.Library.Video.Type",
"required": true
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Scanning the video library has been finished.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video library scan has started.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#Optional.Boolean|Optional.Boolean]]'' added
#* ''[[#Library.Id|Library.Id]]'' id
#* ''integer'' playcount = -1
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction
#* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video item has been updated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"added": {
"$ref": "Optional.Boolean",
"description": "True if the update is for a newly added item."
},
"id": {
"$ref": "Library.Id",
"required": true
},
"playcount": {
"default": -1,
"minimum": 0,
"type": "integer"
},
"transaction": {
"$ref": "Optional.Boolean",
"description": "True if the update is being performed within a transaction."
},
"type": {
"enum": [
"movie",
"tvshow",
"episode",
"musicvideo"
],
"id": "Notifications.Library.Video.Type",
"required": true,
"type": "string"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}

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

{{updated|22}}
[[Category:JSON-RPC]]

JSON-RPC API/v13.5

2026-05-07T19:23:58Z

Ronie: Created page with "{{JSON-RPC_API_nav}} {{mininav|Development|JSON-RPC API}} Version 13 is the stable version of Kodi's JSON-RPC API and is published with the release of v21 (Omega).<br /> This document has been updated to version 13.5.0. Recent changes are announced on the [https://forum.kodi.tv/forumdisplay.php?fid=174 forum] It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using WebSockets will al..."

{{JSON-RPC_API_nav}}
{{mininav|[[Development]]|[[JSON-RPC API]]}}
Version 13 is the stable version of Kodi's JSON-RPC API and is published with the release of v21 (Omega).<br />
This document has been updated to version 13.5.0. Recent changes are announced on the [https://forum.kodi.tv/forumdisplay.php?fid=174 forum]

It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.

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

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

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

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

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

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

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

== Error message ==
If Kodi detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is
{|
|
<syntaxhighlight lang="json" 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:

{| class="prettytable" style="margin-right: 10;"
!style="padding-left: 10px; padding-right: 10px;"|Namespace
!style="padding-left: 10px; padding-right: 10px;"|Description
|-
|Addons
|List, enable and execute addons.
|-
|Application
|Application information and control.
|-
|AudioLibrary
|Audio Library information.
|-
|Favourites
|Favourites GetFavourites and AddFavourite.
|-
|Files
|Shares information & filesystem listings.
|-
|GUI
|Window properties and activation.
|-
|Input
|Allows limited navigation within Kodi.
|-
|JSONRPC
|A variety of standard JSONRPC calls.
|-
|PVR
|Live TV control.
|-
|Player
|Manages all available players.
|-
|Playlist
|Playlist modification.
|-
|Profiles
|Support for Profiles operations to Kodi.
|-
|Settings
|Allows manipulation of Kodi settings.
|-
|System
|System controls and information.
|-
|Textures
|Supplies GetTextures and RemoveTexture. Textures are images.
|-
|VideoLibrary
|Video Library information.
|-
|XBMC
|Dumping ground for very Kodi specific operations.
|}
== Methods ==
=== Addons ===
==== Addons.ExecuteAddon ====
Executes the given addon with the given parameters (if possible)<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<br />
# [''mixed: object|array|string'' params = ""]<br />
# [''boolean'' wait = False]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Executes the given addon with the given parameters (if possible)",
"params": [
{
"name": "addonid",
"required": true,
"type": "string"
},
{
"default": "",
"name": "params",
"type": [
{
"additionalProperties": {
"default": "",
"type": "string"
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"description": "URL path (must start with / or ?",
"type": "string"
}
]
},
{
"default": false,
"name": "wait",
"type": "boolean"
}
],
"permission": "ExecuteAddon",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Addon.Fields|Addon.Fields]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#Addon.Details|Addon.Details]]'' addon<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Gets the details of a specific addon",
"params": [
{
"name": "addonid",
"required": true,
"type": "string"
},
{
"$ref": "Addon.Fields",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"addon": {
"$ref": "Addon.Details",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#Addon.Content|Addon.Content]]'' content = unknown] (Content provided by the addon. Only considered for plugins and scripts.)<br />
# [''mixed: boolean|string'' enabled = all]<br />
# [''[[#Addon.Fields|Addon.Fields]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''mixed: boolean|string'' installed = True]<br />
</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:'''
# [''array[ [[#Addon.Details|Addon.Details]] ]'' addons]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Gets all available addons",
"params": [
{
"$ref": "Addon.Types",
"default": "unknown",
"name": "type"
},
{
"$ref": "Addon.Content",
"default": "unknown",
"description": "Content provided by the addon. Only considered for plugins and scripts.",
"name": "content"
},
{
"default": "all",
"name": "enabled",
"type": [
{
"type": "boolean"
},
{
"enums": [
"all"
],
"type": "string"
}
]
},
{
"$ref": "Addon.Fields",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"default": true,
"name": "installed",
"type": [
{
"type": "boolean"
},
{
"enums": [
"all"
],
"type": "string"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"addons": {
"items": {
"$ref": "Addon.Details"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# ''[[#Global.Toggle|Global.Toggle]]'' enabled<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Enables/Disables a specific addon",
"params": [
{
"name": "addonid",
"required": true,
"type": "string"
},
{
"$ref": "Global.Toggle",
"name": "enabled",
"required": true
}
],
"permission": "ManageAddon",
"returns": {
"type": "string"
},
"type": "method"
}
</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">
# ''array[ [[#Application.Property.Name|Application.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Application.Property.Value|Application.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"items": {
"$ref": "Application.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "Application.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== Application.Quit ====
Quit application<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Quit application",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean (Mute state)''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Toggle mute/unmute",
"params": [
{
"$ref": "Global.Toggle",
"name": "mute",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"description": "Mute state",
"type": "boolean"
},
"type": "method"
}
</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: integer|[[#Global.IncrementDecrement|Global.IncrementDecrement]]'' volume<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''integer''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the current volume",
"params": [
{
"name": "volume",
"required": true,
"type": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"$ref": "Global.IncrementDecrement"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "integer"
},
"type": "method"
}
</syntaxhighlight>}}
=== AudioLibrary ===
==== AudioLibrary.Clean ====
Cleans the audio library from non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Cleans the audio library from non-existent items",
"params": [
{
"default": true,
"description": "Whether or not to show the progress bar or any other GUI dialog",
"name": "showdialogs",
"type": "boolean"
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.Export ====
Exports all items from the audio library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''mixed: object|object'' options]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Exports all items from the audio library",
"params": [
{
"name": "options",
"type": [
{
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the directory to where the data should be exported",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"images": {
"default": false,
"description": "Whether to export thumbnails and fanart images",
"type": "boolean"
},
"overwrite": {
"default": false,
"description": "Whether to overwrite existing exported files",
"type": "boolean"
}
},
"type": "object"
}
]
}
],
"permission": "WriteFile",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific album",
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
{
"$ref": "Audio.Fields.Album",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"albumdetails": {
"$ref": "Audio.Details.Album"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetAlbums ====
Retrieve all albums from specified artist (and role) or that has songs of the specified genre<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|object|[[#List.Filter.Albums|List.Filter.Albums]]'' filter]<br />
# [''boolean'' includesingles = False]<br />
# [''boolean'' allroles = False] (Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.)<br />
</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:'''
# [''array[ [[#Audio.Details.Album|Audio.Details.Album]] ]'' albums]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all albums from specified artist (and role) or that has songs of the specified genre",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Song genre. Filter for existence of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Song genre. Filter for existence of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Albums"
}
]
},
{
"default": false,
"name": "includesingles",
"type": "boolean"
},
{
"default": false,
"description": "Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.",
"name": "allroles",
"type": "boolean"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific artist",
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
{
"$ref": "Audio.Fields.Artist",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"artistdetails": {
"$ref": "Audio.Details.Artist"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetArtists ====
Retrieve all artists. For backward compatibility by default this implicitly does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true<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 = None] (Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used)<br />
# [''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|object|object|object|object|object|object|object|object|[[#List.Filter.Artists|List.Filter.Artists]]'' filter]<br />
# [''boolean'' allroles = False] (Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.)<br />
</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:'''
# [''array[ [[#Audio.Details.Artist|Audio.Details.Artist]] ]'' artists]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all artists. For backward compatibility by default this implicitly does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true",
"params": [
{
"$ref": "Optional.Boolean",
"default": null,
"description": "Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used",
"name": "albumartistsonly"
},
{
"$ref": "Audio.Fields.Artist",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Deprecated, use songgenreid. Filter for existence of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songgenreid": {
"$ref": "Library.Id",
"description": "Song genreid. Filter for existence of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songgenreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songgenreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Deprecated, use songgenre. Filter for existence of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songgenre": {
"description": "Song genre. Filter for existence of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songgenre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songgenre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"album": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"description": "Role contributed by artist. Overridden by allroles parameter",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"description": "Role contributed by artist. Overridden by allroles parameter",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Artists"
}
]
},
{
"default": false,
"description": "Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.",
"name": "allroles",
"type": "boolean"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"artists": {
"items": {
"$ref": "Audio.Details.Artist"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetAvailableArt ====
Retrieve all potential art URLs for a media item by art 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">
# ''mixed: object|object'' item<br />
# [''string'' arttype = ""]<br />
</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:'''
# ''array'' availableart<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all potential art URLs for a media item by art type",
"params": [
{
"name": "item",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
},
{
"default": "",
"name": "arttype",
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"availableart": {
"items": {
"properties": {
"arttype": {
"required": true,
"type": "string"
},
"previewurl": {
"default": "",
"description": "URL to a preview thumbnail of the image",
"type": "string"
},
"url": {
"description": "URL to the original image",
"required": true,
"type": "string"
}
},
"type": "object"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetAvailableArtTypes ====
Retrieve a list of potential art types for a media 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">
# ''mixed: object|object'' item<br />
</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:'''
# ''array'' availablearttypes<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve a list of potential art types for a media item",
"params": [
{
"name": "item",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"availablearttypes": {
"items": {
"type": "string"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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:'''
# ''array[ [[#Library.Details.Genre|Library.Details.Genre]] ]'' genres<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all genres",
"params": [
{
"$ref": "Library.Fields.Genre",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"genres": {
"items": {
"$ref": "Library.Details.Genre"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetProperties ====
Retrieves the values of the music library properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[ [[#Audio.Property.Name|Audio.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Audio.Property.Value|Audio.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the music library properties",
"params": [
{
"items": {
"$ref": "Audio.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "Audio.Property.Value"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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:'''
# [''array[ [[#Audio.Details.Album|Audio.Details.Album]] ]'' albums]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve recently added albums",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetRecentlyAddedSongs ====
Retrieve recently added songs<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#List.Amount|List.Amount]]'' albumlimit = -1] (The amount of recently added albums from which to return the songs)<br />
# [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# [''array[ [[#Audio.Details.Song|Audio.Details.Song]] ]'' songs]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve recently added songs",
"params": [
{
"$ref": "List.Amount",
"default": -1,
"description": "The amount of recently added albums from which to return the songs",
"name": "albumlimit"
},
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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:'''
# [''array[ [[#Audio.Details.Album|Audio.Details.Album]] ]'' albums]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve recently played albums",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# [''array[ [[#Audio.Details.Song|Audio.Details.Song]] ]'' songs]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve recently played songs",
"params": [
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetRoles ====
Retrieve all contributor roles<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Audio.Fields.Role|Audio.Fields.Role]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# ''array[ [[#Audio.Details.Role|Audio.Details.Role]] ]'' roles<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all contributor roles",
"params": [
{
"$ref": "Audio.Fields.Role",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"roles": {
"items": {
"$ref": "Audio.Details.Role"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific song",
"params": [
{
"$ref": "Library.Id",
"name": "songid",
"required": true
},
{
"$ref": "Audio.Fields.Song",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"songdetails": {
"$ref": "Audio.Details.Song"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|object|object|object|[[#List.Filter.Songs|List.Filter.Songs]]'' filter]<br />
# [''boolean'' includesingles = True] (Only songs from albums are returned when false, but overridden when singlesonly parameter is true)<br />
# [''boolean'' allroles = False] (Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.)<br />
# [''boolean'' singlesonly = False] (Only singles are returned when true, and overrides includesingles parameter)<br />
</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<br />
# [''array[ [[#Audio.Details.Song|Audio.Details.Song]] ]'' songs]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all songs from specified album, artist or genre",
"params": [
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Song genre. Filter for existence of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Song genre. Filter for existence of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"album": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Songs"
}
]
},
{
"default": true,
"description": "Only songs from albums are returned when false, but overridden when singlesonly parameter is true",
"name": "includesingles",
"type": "boolean"
},
{
"default": false,
"description": "Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.",
"name": "allroles",
"type": "boolean"
},
{
"default": false,
"description": "Only singles are returned when true, and overrides includesingles parameter",
"name": "singlesonly",
"type": "boolean"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetSources ====
Get all music sources, including unique ID<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.Source|Library.Fields.Source]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# ''array[ [[#Library.Details.Source|Library.Details.Source]] ]'' sources<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get all music sources, including unique ID",
"params": [
{
"$ref": "Library.Fields.Source",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sources": {
"items": {
"$ref": "Library.Details.Source"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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 = ""]<br />
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Scans the audio sources for new library items",
"params": [
{
"default": "",
"name": "directory",
"type": "string"
},
{
"default": true,
"description": "Whether or not to show the progress bar or any other GUI dialog",
"name": "showdialogs",
"type": "boolean"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br />
# [''[[#Optional.String|Optional.String]]'' description = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' theme = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' mood = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' style = None]<br />
# [''[[#Optional.String|Optional.String]]'' type = None]<br />
# [''[[#Optional.String|Optional.String]]'' albumlabel = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' year = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainzalbumid = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainzreleasegroupid = None]<br />
# [''[[#Optional.String|Optional.String]]'' sortartist = None]<br />
# [''[[#Optional.String|Optional.String]]'' displayartist = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' musicbrainzalbumartistid = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.Boolean|Optional.Boolean]]'' isboxset = None]<br />
# [''[[#Optional.String|Optional.String]]'' releasedate = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaldate = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given album with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"default": null,
"name": "artist",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "description"
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "theme",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "mood",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "style",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "type"
},
{
"$ref": "Optional.String",
"default": null,
"name": "albumlabel"
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "year"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainzalbumid"
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainzreleasegroupid"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sortartist"
},
{
"$ref": "Optional.String",
"default": null,
"name": "displayartist"
},
{
"default": null,
"name": "musicbrainzalbumartistid",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.Boolean",
"default": null,
"name": "isboxset"
},
{
"$ref": "Optional.String",
"default": null,
"name": "releasedate"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaldate"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Optional.String|Optional.String]]'' artist = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' instrument = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' style = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' mood = None]<br />
# [''[[#Optional.String|Optional.String]]'' born = None]<br />
# [''[[#Optional.String|Optional.String]]'' formed = None]<br />
# [''[[#Optional.String|Optional.String]]'' description = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.String|Optional.String]]'' died = None]<br />
# [''[[#Optional.String|Optional.String]]'' disbanded = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' yearsactive = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainzartistid = None]<br />
# [''[[#Optional.String|Optional.String]]'' sortname = None]<br />
# [''[[#Optional.String|Optional.String]]'' type = None]<br />
# [''[[#Optional.String|Optional.String]]'' gender = None]<br />
# [''[[#Optional.String|Optional.String]]'' disambiguation = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given artist with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "artist"
},
{
"default": null,
"name": "instrument",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "style",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "mood",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "born"
},
{
"$ref": "Optional.String",
"default": null,
"name": "formed"
},
{
"$ref": "Optional.String",
"default": null,
"name": "description"
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "died"
},
{
"$ref": "Optional.String",
"default": null,
"name": "disbanded"
},
{
"default": null,
"name": "yearsactive",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainzartistid"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sortname"
},
{
"$ref": "Optional.String",
"default": null,
"name": "type"
},
{
"$ref": "Optional.String",
"default": null,
"name": "gender"
},
{
"$ref": "Optional.String",
"default": null,
"name": "disambiguation"
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' year = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' track = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' disc = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' duration = None]<br />
# [''[[#Optional.String|Optional.String]]'' comment = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainztrackid = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainzartistid = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' displayartist = None]<br />
# [''[[#Optional.String|Optional.String]]'' sortartist = None]<br />
# [''[[#Optional.String|Optional.String]]'' mood = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.String|Optional.String]]'' disctitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' releasedate = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaldate = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' bpm = None]<br />
# [''[[#Optional.String|Optional.String]]'' songvideourl = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given song with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "songid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"default": null,
"name": "artist",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "year"
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "track"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "disc"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "duration"
},
{
"$ref": "Optional.String",
"default": null,
"name": "comment"
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainztrackid"
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainzartistid"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "displayartist"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sortartist"
},
{
"$ref": "Optional.String",
"default": null,
"name": "mood"
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "disctitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "releasedate"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaldate"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "bpm"
},
{
"$ref": "Optional.String",
"default": null,
"name": "songvideourl"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Favourites ===
==== Favourites.AddFavourite ====
Add a favourite with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' title<br />
# ''[[#Favourite.Type|Favourite.Type]]'' type<br />
# [''[[#Optional.String|Optional.String]]'' path = None] (Required for media, script and androidapp favourites types)<br />
# [''[[#Optional.String|Optional.String]]'' window = None] (Required for window favourite type)<br />
# [''[[#Optional.String|Optional.String]]'' windowparameter = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Add a favourite with the given details",
"params": [
{
"name": "title",
"required": true,
"type": "string"
},
{
"$ref": "Favourite.Type",
"name": "type",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"description": "Required for media, script and androidapp favourites types",
"name": "path"
},
{
"$ref": "Optional.String",
"default": null,
"description": "Required for window favourite type",
"name": "window"
},
{
"$ref": "Optional.String",
"default": null,
"name": "windowparameter"
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Favourites.GetFavourites ====
Retrieve all favourites<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''mixed: null|[[#Favourite.Type|Favourite.Type]]'' type = None]<br />
# [''[[#Favourite.Fields.Favourite|Favourite.Fields.Favourite]]'' properties]<br />
</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:'''
# [''array[ [[#Favourite.Details.Favourite|Favourite.Details.Favourite]] ]'' favourites]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all favourites",
"params": [
{
"default": null,
"name": "type",
"type": [
{
"type": "null"
},
{
"$ref": "Favourite.Type"
}
]
},
{
"$ref": "Favourite.Fields.Favourite",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"favourites": {
"items": {
"$ref": "Favourite.Details.Favourite"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''any''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Downloads the given file",
"params": [
{
"name": "path",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"type": "any"
},
"type": "method"
}
</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<br />
# [''[[#Files.Media|Files.Media]]'' media = files]<br />
# [''[[#List.Fields.Files|List.Fields.Files]]'' properties]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''[[#List.Limits|List.Limits]]'' limits] (Limits are applied after getting the directory content thus retrieval is not faster when they are applied.)<br />
</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:'''
# ''array[ [[#List.Item.File|List.Item.File]] ]'' files<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get the directories and files in the given directory",
"params": [
{
"name": "directory",
"required": true,
"type": "string"
},
{
"$ref": "Files.Media",
"default": "files",
"name": "media"
},
{
"$ref": "List.Fields.Files",
"name": "properties"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"$ref": "List.Limits",
"description": "Limits are applied after getting the directory content thus retrieval is not faster when they are applied.",
"name": "limits"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"files": {
"items": {
"$ref": "List.Item.File"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Files.GetFileDetails ====
Get details for a specific file<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file (Full path to the file)<br />
# [''[[#Files.Media|Files.Media]]'' media = files]<br />
# [''[[#List.Fields.Files|List.Fields.Files]]'' properties]<br />
</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<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get details for a specific file",
"params": [
{
"description": "Full path to the file",
"name": "file",
"required": true,
"type": "string"
},
{
"$ref": "Files.Media",
"default": "files",
"name": "media"
},
{
"$ref": "List.Fields.Files",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"filedetails": {
"$ref": "List.Item.File",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# ''[[#List.Items.Sources|List.Items.Sources]]'' sources<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get the sources of the media windows",
"params": [
{
"$ref": "Files.Media",
"name": "media",
"required": true
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sources": {
"$ref": "List.Items.Sources",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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<br />
</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:'''
# ''any'' details (Transport specific details on how/from where to download the given file)<br />
# ''string'' mode (Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol)<br />
# ''string'' protocol<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Provides a way to download a given file (e.g. providing an URL to the real file location)",
"params": [
{
"name": "path",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"details": {
"description": "Transport specific details on how/from where to download the given file",
"required": true,
"type": "any"
},
"mode": {
"description": "Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol",
"enums": [
"redirect",
"direct"
],
"required": true,
"type": "string"
},
"protocol": {
"enums": [
"http"
],
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Files.SetFileDetails ====
Update the given specific file with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file (Full path to the file)<br />
# ''[[#Files.Media|Files.Media]]'' media (File type to update correct database. Currently only "video" is supported.)<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None] (Setting a valid lastplayed without a playcount will force playcount to 1.)<br />
# [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given specific file with the given details",
"params": [
{
"description": "Full path to the file",
"name": "file",
"required": true,
"type": "string"
},
{
"$ref": "Files.Media",
"description": "File type to update correct database. Currently only \"video\" is supported.",
"name": "media",
"required": true
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.String",
"default": null,
"description": "Setting a valid lastplayed without a playcount will force playcount to 1.",
"name": "lastplayed"
},
{
"default": null,
"name": "resume",
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== GUI ===
==== GUI.ActivateScreenSaver ====
Activates currently used screensaver<br />
'''Permissions:'''
* ControlGUI
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Activates currently used screensaver",
"params": [],
"permission": "ControlGUI",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== 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<br />
# [''array[string]'' parameters]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Activates the given window",
"params": [
{
"$ref": "GUI.Window",
"name": "window",
"required": true
},
{
"items": {
"minLength": 1,
"type": "string"
},
"minItems": 1,
"name": "parameters",
"type": "array"
}
],
"permission": "ControlGUI",
"returns": {
"type": "string"
},
"type": "method"
}
</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">
# ''array[ [[#GUI.Property.Name|GUI.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#GUI.Property.Value|GUI.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"items": {
"$ref": "GUI.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "GUI.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== GUI.GetStereoscopicModes ====
Returns the supported stereoscopic modes of the GUI<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]] ]'' stereoscopicmodes]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Returns the supported stereoscopic modes of the GUI",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"stereoscopicmodes": {
"items": {
"$ref": "GUI.Stereoscopy.Mode"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean (Fullscreen state)''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Toggle fullscreen/GUI",
"params": [
{
"$ref": "Global.Toggle",
"name": "fullscreen",
"required": true
}
],
"permission": "ControlGUI",
"returns": {
"description": "Fullscreen state",
"type": "boolean"
},
"type": "method"
}
</syntaxhighlight>}}
==== GUI.SetStereoscopicMode ====
Sets the stereoscopic mode of the GUI to the given mode<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' mode<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Sets the stereoscopic mode of the GUI to the given mode",
"params": [
{
"enums": [
"toggle",
"tomono",
"next",
"previous",
"select",
"off",
"split_vertical",
"split_horizontal",
"row_interleaved",
"hardware_based",
"anaglyph_cyan_red",
"anaglyph_green_magenta",
"monoscopic"
],
"name": "mode",
"required": true,
"type": "string"
}
],
"permission": "ControlGUI",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''string'' message<br />
# [''mixed: string|string'' image = ""]<br />
# [''integer'' displaytime = 5000] (The time in milliseconds the notification will be visible)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shows a GUI notification",
"params": [
{
"name": "title",
"required": true,
"type": "string"
},
{
"name": "message",
"required": true,
"type": "string"
},
{
"default": "",
"name": "image",
"type": [
{
"enums": [
"info",
"warning",
"error"
],
"type": "string"
},
{
"type": "string"
}
]
},
{
"default": 5000,
"description": "The time in milliseconds the notification will be visible",
"minimum": 1500,
"name": "displaytime",
"type": "integer"
}
],
"permission": "ControlGUI",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Input ===
==== Input.Back ====
Goes back in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Goes back in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ButtonEvent ====
Send a button press event<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'' button (Button name)<br />
# ''string'' keymap (Keymap name (KB, XG, R1, or R2))<br />
# [''integer'' holdtime = 0] (Number of milliseconds to simulate button hold.)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Send a button press event",
"params": [
{
"description": "Button name",
"name": "button",
"required": true,
"type": "string"
},
{
"description": "Keymap name (KB, XG, R1, or R2)",
"enums": [
"KB",
"XG",
"R1",
"R2"
],
"name": "keymap",
"required": true,
"type": "string"
},
{
"default": 0,
"description": "Number of milliseconds to simulate button hold.",
"minimum": 0,
"name": "holdtime",
"type": "integer"
}
],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ContextMenu ====
Shows the context menu<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shows the context menu",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Down ====
Navigate down in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Navigate down in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Execute a specific action",
"params": [
{
"$ref": "Input.Action",
"name": "action",
"required": true
}
],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Home ====
Goes to home window in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Goes to home window in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Info ====
Shows the information dialog<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shows the information dialog",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Left ====
Navigate left in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Navigate left in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Right ====
Navigate right in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Navigate right in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Select ====
Select current item in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Select current item in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.SendText ====
Send a generic (unicode) text<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' text (Unicode text)<br />
# [''boolean'' done = True] (Whether this is the whole input or not (closes an open input dialog if true).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Send a generic (unicode) text",
"params": [
{
"description": "Unicode text",
"name": "text",
"required": true,
"type": "string"
},
{
"default": true,
"description": "Whether this is the whole input or not (closes an open input dialog if true).",
"name": "done",
"type": "boolean"
}
],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ShowCodec ====
Show codec information of the playing item<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Show codec information of the playing item",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ShowOSD ====
Show the on-screen display for the current player<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Show the on-screen display for the current player",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ShowPlayerProcessInfo ====
Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Up ====
Navigate up in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Navigate up in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== JSONRPC ===
==== JSONRPC.GetConfiguration ====
Get client-specific configurations<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Configuration|Configuration]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get client-specific configurations",
"params": [],
"permission": "ReadData",
"returns": {
"$ref": "Configuration"
},
"type": "method"
}
</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]<br />
# [''boolean'' getmetadata = False]<br />
# [''boolean'' filterbytransport = True]<br />
# [''object'' filter]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Enumerates all actions and descriptions",
"params": [
{
"default": true,
"name": "getdescriptions",
"type": "boolean"
},
{
"default": false,
"name": "getmetadata",
"type": "boolean"
},
{
"default": true,
"name": "filterbytransport",
"type": "boolean"
},
{
"name": "filter",
"properties": {
"getreferences": {
"default": true,
"description": "Whether or not to print the schema for referenced types",
"type": "boolean"
},
"id": {
"description": "Name of a namespace, method or type",
"required": true,
"type": "string"
},
"type": {
"description": "Type of the given name",
"enums": [
"method",
"namespace",
"type",
"notification"
],
"required": true,
"type": "string"
}
},
"type": "object"
}
],
"permission": "ReadData",
"returns": {
"additionalProperties": false,
"type": "object"
},
"type": "method"
}
</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<br />
# ''string'' message<br />
# [''any'' data = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''any''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Notify all other connected clients",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "message",
"required": true,
"type": "string"
},
{
"default": null,
"name": "data",
"type": "any"
}
],
"permission": "ReadData",
"returns": {
"type": "any"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.Permission ====
Retrieve the clients permissions<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''boolean'' controlgui<br />
# ''boolean'' controlnotify<br />
# ''boolean'' controlplayback<br />
# ''boolean'' controlpower<br />
# ''boolean'' controlpvr<br />
# ''boolean'' controlsystem<br />
# ''boolean'' executeaddon<br />
# ''boolean'' manageaddon<br />
# ''boolean'' navigate<br />
# ''boolean'' readdata<br />
# ''boolean'' removedata<br />
# ''boolean'' updatedata<br />
# ''boolean'' writefile<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve the clients permissions",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"controlgui": {
"required": true,
"type": "boolean"
},
"controlnotify": {
"required": true,
"type": "boolean"
},
"controlplayback": {
"required": true,
"type": "boolean"
},
"controlpower": {
"required": true,
"type": "boolean"
},
"controlpvr": {
"required": true,
"type": "boolean"
},
"controlsystem": {
"required": true,
"type": "boolean"
},
"executeaddon": {
"required": true,
"type": "boolean"
},
"manageaddon": {
"required": true,
"type": "boolean"
},
"navigate": {
"required": true,
"type": "boolean"
},
"readdata": {
"required": true,
"type": "boolean"
},
"removedata": {
"required": true,
"type": "boolean"
},
"updatedata": {
"required": true,
"type": "boolean"
},
"writefile": {
"required": true,
"type": "boolean"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.Ping ====
Ping responder<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Ping responder",
"params": [],
"permission": "ReadData",
"returns": {
"type": "string"
},
"type": "method"
}
</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 />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Configuration|Configuration]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Change the client-specific configuration",
"params": [
{
"name": "notifications",
"properties": {
"application": {
"$ref": "Optional.Boolean",
"default": null
},
"audiolibrary": {
"$ref": "Optional.Boolean",
"default": null
},
"gui": {
"$ref": "Optional.Boolean",
"default": null
},
"input": {
"$ref": "Optional.Boolean",
"default": null
},
"other": {
"$ref": "Optional.Boolean",
"default": null
},
"player": {
"$ref": "Optional.Boolean",
"default": null
},
"playlist": {
"$ref": "Optional.Boolean",
"default": null
},
"system": {
"$ref": "Optional.Boolean",
"default": null
},
"videolibrary": {
"$ref": "Optional.Boolean",
"default": null
}
},
"type": "object"
}
],
"permission": "ControlNotify",
"returns": {
"$ref": "Configuration"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.Version ====
Retrieve the JSON-RPC protocol version.<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''object'' version<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve the JSON-RPC protocol version.",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"version": {
"properties": {
"major": {
"description": "Bumped on backwards incompatible changes to the API definition",
"minimum": 0,
"required": true,
"type": "integer"
},
"minor": {
"description": "Bumped on backwards compatible additions/changes to the API definition",
"minimum": 0,
"required": true,
"type": "integer"
},
"patch": {
"description": "Bumped on any changes to the internal implementation but not to the API definition",
"minimum": 0,
"required": true,
"type": "integer"
}
},
"required": true,
"type": "object"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
=== PVR ===
==== PVR.AddTimer ====
Adds a timer to record the given show one times or a timer rule to record all showings of the given show or adds a reminder timer or reminder timer rule<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid (the broadcast id of the item to record)<br />
# [''boolean'' timerrule = False] (controls whether to create a timer rule or a onetime timer)<br />
# [''boolean'' reminder = False] (controls whether to create a reminder timer or a recording timer)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Adds a timer to record the given show one times or a timer rule to record all showings of the given show or adds a reminder timer or reminder timer rule",
"params": [
{
"$ref": "Library.Id",
"description": "the broadcast id of the item to record",
"name": "broadcastid",
"required": true
},
{
"default": false,
"description": "controls whether to create a timer rule or a onetime timer",
"name": "timerrule",
"type": "boolean"
},
{
"default": false,
"description": "controls whether to create a reminder timer or a recording timer",
"name": "reminder",
"type": "boolean"
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.DeleteTimer ====
Deletes a onetime timer or a timer rule<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' timerid (the id of the onetime timer or timer rule to delete)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Deletes a onetime timer or a timer rule",
"params": [
{
"$ref": "Library.Id",
"description": "the id of the onetime timer or timer rule to delete",
"name": "timerid",
"required": true
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetBroadcastDetails ====
Retrieves the details of a specific broadcast<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid<br />
# [''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific broadcast",
"params": [
{
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
{
"$ref": "PVR.Fields.Broadcast",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"broadcastdetails": {
"$ref": "PVR.Details.Broadcast"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetBroadcastIsPlayable ====
Retrieves whether or not a broadcast is playable<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid (the id of the broadcast to check for playability)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves whether or not a broadcast is playable",
"params": [
{
"$ref": "Library.Id",
"description": "the id of the broadcast to check for playability",
"name": "broadcastid",
"required": true
}
],
"permission": "ReadData",
"returns": {
"type": "boolean"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetBroadcasts ====
Retrieves the program of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid<br />
# [''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
</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:'''
# ''array[ [[#PVR.Details.Broadcast|PVR.Details.Broadcast]] ]'' broadcasts<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the program of a specific channel",
"params": [
{
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
{
"$ref": "PVR.Fields.Broadcast",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"broadcasts": {
"items": {
"$ref": "PVR.Details.Broadcast"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetChannelDetails ====
Retrieves the details of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid<br />
# [''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific channel",
"params": [
{
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
{
"$ref": "PVR.Fields.Channel",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"channeldetails": {
"$ref": "PVR.Details.Channel"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''object'' channels]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific channel group",
"params": [
{
"$ref": "PVR.ChannelGroup.Id",
"name": "channelgroupid",
"required": true
},
{
"name": "channels",
"properties": {
"limits": {
"$ref": "List.Limits"
},
"properties": {
"$ref": "PVR.Fields.Channel"
}
},
"type": "object"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"channelgroupdetails": {
"$ref": "PVR.Details.ChannelGroup.Extended"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
</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:'''
# ''array[ [[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]] ]'' channelgroups<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the channel groups for the specified type",
"params": [
{
"$ref": "PVR.Channel.Type",
"name": "channeltype",
"required": true
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"channelgroups": {
"items": {
"$ref": "PVR.Details.ChannelGroup"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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:'''
# ''array[ [[#PVR.Details.Channel|PVR.Details.Channel]] ]'' channels<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the channel list",
"params": [
{
"$ref": "PVR.ChannelGroup.Id",
"name": "channelgroupid",
"required": true
},
{
"$ref": "PVR.Fields.Channel",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetClients ====
Retrieves the enabled PVR clients and their capabilities<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.Limits|List.Limits]]'' limits]<br />
</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:'''
# ''array[ [[#PVR.Details.Client|PVR.Details.Client]] ]'' clients<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the enabled PVR clients and their capabilities",
"params": [
{
"$ref": "List.Limits",
"name": "limits"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"clients": {
"items": {
"$ref": "PVR.Details.Client"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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">
# ''array[ [[#PVR.Property.Name|PVR.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#PVR.Property.Value|PVR.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"items": {
"$ref": "PVR.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "PVR.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetRecordingDetails ====
Retrieves the details of a specific recording<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' recordingid<br />
# [''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#PVR.Details.Recording|PVR.Details.Recording]]'' recordingdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific recording",
"params": [
{
"$ref": "Library.Id",
"name": "recordingid",
"required": true
},
{
"$ref": "PVR.Fields.Recording",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"recordingdetails": {
"$ref": "PVR.Details.Recording"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetRecordings ====
Retrieves the recordings<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# ''array[ [[#PVR.Details.Recording|PVR.Details.Recording]] ]'' recordings<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the recordings",
"params": [
{
"$ref": "PVR.Fields.Recording",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"recordings": {
"items": {
"$ref": "PVR.Details.Recording"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetTimerDetails ====
Retrieves the details of a specific timer<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' timerid<br />
# [''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#PVR.Details.Timer|PVR.Details.Timer]]'' timerdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific timer",
"params": [
{
"$ref": "Library.Id",
"name": "timerid",
"required": true
},
{
"$ref": "PVR.Fields.Timer",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"timerdetails": {
"$ref": "PVR.Details.Timer"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetTimers ====
Retrieves the timers<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# ''array[ [[#PVR.Details.Timer|PVR.Details.Timer]] ]'' timers<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the timers",
"params": [
{
"$ref": "PVR.Fields.Timer",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"timers": {
"items": {
"$ref": "PVR.Details.Timer"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''mixed: string|[[#Library.Id|Library.Id]]'' channel = current]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Toggle recording of a channel",
"params": [
{
"$ref": "Global.Toggle",
"default": "toggle",
"name": "record"
},
{
"default": "current",
"name": "channel",
"type": [
{
"enums": [
"current"
],
"type": "string"
},
{
"$ref": "Library.Id"
}
]
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.Scan ====
Starts a channel scan<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Library.Id|Library.Id]]'' clientid = -1] (Specify a PVR client id to avoid UI dialog, optional in kodi 19, required in kodi 20)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Starts a channel scan",
"params": [
{
"$ref": "Library.Id",
"default": -1,
"description": "Specify a PVR client id to avoid UI dialog, optional in kodi 19, required in kodi 20",
"name": "clientid"
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.ToggleTimer ====
Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid (the broadcast id of the item to toggle a onetime timer or time rule for)<br />
# [''boolean'' timerrule = False] (controls whether to create / delete a timer rule or a onetime timer)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created",
"params": [
{
"$ref": "Library.Id",
"description": "the broadcast id of the item to toggle a onetime timer or time rule for",
"name": "broadcastid",
"required": true
},
{
"default": false,
"description": "controls whether to create / delete a timer rule or a onetime timer",
"name": "timerrule",
"type": "boolean"
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Player ===
==== Player.AddSubtitle ====
Add subtitle to 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<br />
# ''string'' subtitle (Local path or remote URL to the subtitle file to load)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Add subtitle to the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"description": "Local path or remote URL to the subtitle file to load",
"name": "subtitle",
"required": true,
"type": "string"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetActivePlayers ====
Returns all active players<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Returns all active players",
"params": [],
"permission": "ReadData",
"returns": {
"items": {
"properties": {
"playerid": {
"$ref": "Player.Id",
"required": true
},
"playertype": {
"enums": [
"internal",
"external",
"remote"
],
"required": true,
"type": "string"
},
"type": {
"$ref": "Player.Type",
"required": true
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetAudioDelay ====
Get the audio delay for the current playback<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''number'' offset (The offset value used in the current playback.)<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get the audio delay for the current playback",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"offset": {
"description": "The offset value used in the current playback.",
"required": true,
"type": "number"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#List.Fields.All|List.Fields.All]]'' properties]<br />
</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<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the currently played item",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "List.Fields.All",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"item": {
"$ref": "List.Item.All",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetPlayers ====
Get a list of available players<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''string'' media = all]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get a list of available players",
"params": [
{
"default": "all",
"enums": [
"all",
"video",
"audio"
],
"name": "media",
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"items": {
"properties": {
"name": {
"$ref": "Global.String.NotEmpty",
"required": true
},
"playsaudio": {
"required": true,
"type": "boolean"
},
"playsvideo": {
"required": true,
"type": "boolean"
},
"type": {
"enums": [
"internal",
"external",
"remote"
],
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"type": "method"
}
</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<br />
# ''array[ [[#Player.Property.Name|Player.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Property.Value|Player.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"items": {
"$ref": "Player.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "Player.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetViewMode ====
Get view mode of video player<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''boolean'' nonlinearstretch<br />
# ''number'' pixelratio<br />
# ''number'' verticalshift<br />
# ''[[#Player.ViewMode|Player.ViewMode]]'' viewmode<br />
# ''number'' zoom<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get view mode of video player",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"nonlinearstretch": {
"required": true,
"type": "boolean"
},
"pixelratio": {
"required": true,
"type": "number"
},
"verticalshift": {
"required": true,
"type": "number"
},
"viewmode": {
"$ref": "Player.ViewMode",
"required": true
},
"zoom": {
"required": true,
"type": "number"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# ''mixed: string|[[#Playlist.Position|Playlist.Position]]'' to<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Go to previous/next/specific item in the playlist",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "to",
"required": true,
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"$ref": "Playlist.Position",
"description": "position in playlist"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''string'' direction<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "If picture is zoomed move viewport left/right/up/down otherwise skip previous/next",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"enums": [
"left",
"right",
"up",
"down"
],
"name": "direction",
"required": true,
"type": "string"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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: object|[[#Playlist.Item|Playlist.Item]]|object|object|object|object|object'' item]<br />
# [''object'' options]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.",
"params": [
{
"name": "item",
"type": [
{
"additionalProperties": false,
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"position": {
"$ref": "Playlist.Position",
"default": 0
}
},
"type": "object"
},
{
"$ref": "Playlist.Item"
},
{
"additionalProperties": false,
"properties": {
"path": {
"required": true,
"type": "string"
},
"random": {
"default": true,
"description": "Deprecated, use the shuffled property of the options parameter instead",
"type": "boolean"
},
"recursive": {
"default": true,
"type": "boolean"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"partymode": {
"default": "",
"type": [
{
"enums": [
"music",
"video"
],
"type": "string"
},
{
"description": "Path to a smartplaylist (*.xsp) file",
"minLength": 5,
"type": "string"
}
]
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"broadcastid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"channelid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"recordingid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
},
{
"additionalProperties": false,
"name": "options",
"properties": {
"playername": {
"default": null,
"type": [
{
"type": "null"
},
{
"enums": [
"default"
],
"type": "string"
},
{
"description": "name of player",
"minLength": 1,
"type": "string"
}
]
},
"repeat": {
"default": null,
"type": [
{
"type": "null"
},
{
"$ref": "Player.Repeat"
}
]
},
"resume": {
"default": false,
"type": [
{
"description": "Whether to resume from the resume point or not",
"type": "boolean"
},
{
"$ref": "Player.Position.Percentage",
"description": "Percentage value to start from"
},
{
"$ref": "Player.Position.Time",
"description": "Time to start from"
}
]
},
"shuffled": {
"$ref": "Optional.Boolean",
"default": null
}
},
"type": "object"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Global.Toggle|Global.Toggle]]'' play = toggle]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Pauses or unpause playback and returns the new state",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"default": "toggle",
"name": "play"
}
],
"permission": "ControlPlayback",
"returns": {
"$ref": "Player.Speed"
},
"type": "method"
}
</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<br />
# [''string'' value = clockwise]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Rotates current picture",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"default": "clockwise",
"enums": [
"clockwise",
"counterclockwise"
],
"name": "value",
"type": "string"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''mixed: object|object|object|object'' value<br />
</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]<br />
# [''[[#Global.Time|Global.Time]]'' time] (A duration.)<br />
# [''[[#Global.Time|Global.Time]]'' totaltime] (A duration.)<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Seek through the playing item",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "value",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"percentage": {
"$ref": "Player.Position.Percentage",
"description": "Percentage value to seek to",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"time": {
"$ref": "Player.Position.Time",
"description": "Time to seek to",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"step": {
"description": "Seek by predefined jumps",
"enums": [
"smallforward",
"smallbackward",
"bigforward",
"bigbackward"
],
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"seconds": {
"description": "Seek by the given number of seconds",
"required": true,
"type": "integer"
}
},
"type": "object"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"properties": {
"percentage": {
"$ref": "Player.Position.Percentage",
"default": 0.0
},
"time": {
"$ref": "Global.Time",
"description": "A duration."
},
"totaltime": {
"$ref": "Global.Time",
"description": "A duration."
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetAudioDelay ====
Set the audio delay for 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<br />
# ''mixed: number|[[#Global.IncrementDecrement|Global.IncrementDecrement]]'' offset<br />
</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:'''
# ''number'' offset (The offset value used in the current playback.)<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the audio delay for the current playback",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "offset",
"required": true,
"type": [
{
"description": "The value should be a multiple of 0.025 in a range of +/-10 (the default range can be overriden by advancedsettings.xml).",
"type": "number"
},
{
"$ref": "Global.IncrementDecrement"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"properties": {
"offset": {
"description": "The offset value used in the current playback.",
"required": true,
"type": "number"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# ''mixed: string|integer'' stream<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the audio stream played by the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "stream",
"required": true,
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"description": "Index of the audio stream to play",
"minimum": 0,
"type": "integer"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''[[#Global.Toggle|Global.Toggle]]'' partymode<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Turn partymode on or off",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "partymode",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''mixed: [[#Player.Repeat|Player.Repeat]]|string'' repeat<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the repeat mode of the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "repeat",
"required": true,
"type": [
{
"$ref": "Player.Repeat"
},
{
"enums": [
"cycle"
],
"type": "string"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''[[#Global.Toggle|Global.Toggle]]'' shuffle<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shuffle/Unshuffle items in the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "shuffle",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''mixed: integer|[[#Global.IncrementDecrement|Global.IncrementDecrement]]'' speed<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the speed of the current playback",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "speed",
"required": true,
"type": [
{
"enums": [
-32,
-16,
-8,
-4,
-2,
-1,
0,
1,
2,
4,
8,
16,
32
],
"type": "integer"
},
{
"$ref": "Global.IncrementDecrement"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"$ref": "Player.Speed"
},
"type": "method"
}
</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<br />
# ''mixed: string|integer'' subtitle<br />
# [''boolean'' enable = False] (Whether to enable subtitles to be displayed after setting the new subtitle)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the subtitle displayed by the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "subtitle",
"required": true,
"type": [
{
"enums": [
"previous",
"next",
"off",
"on"
],
"type": "string"
},
{
"description": "Index of the subtitle to display",
"minimum": 0,
"type": "integer"
}
]
},
{
"default": false,
"description": "Whether to enable subtitles to be displayed after setting the new subtitle",
"name": "enable",
"type": "boolean"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetTempo ====
Set the tempo 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<br />
# ''mixed: number|[[#Global.IncrementDecrement|Global.IncrementDecrement]]'' tempo<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Tempo|Player.Tempo]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the tempo of the current playback",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "tempo",
"required": true,
"type": [
{
"type": "number"
},
{
"$ref": "Global.IncrementDecrement"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"$ref": "Player.Tempo"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetVideoStream ====
Set the video stream played by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: string|integer'' stream<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the video stream played by the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "stream",
"required": true,
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"description": "Index of the video stream to play",
"minimum": 0,
"type": "integer"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetViewMode ====
Set view mode of video 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">
# ''mixed: [[#Player.CustomViewMode|Player.CustomViewMode]]|[[#Player.ViewMode|Player.ViewMode]]'' viewmode<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set view mode of video player",
"params": [
{
"name": "viewmode",
"required": true,
"type": [
{
"$ref": "Player.CustomViewMode",
"description": "Custom view mode"
},
{
"$ref": "Player.ViewMode"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Stops playback",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''mixed: string|integer'' zoom<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Zoom current picture",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "zoom",
"required": true,
"type": [
{
"enums": [
"in",
"out"
],
"type": "string"
},
{
"description": "zoom level",
"maximum": 10,
"minimum": 1,
"type": "integer"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''mixed: [[#Playlist.Item|Playlist.Item]]|array'' item<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Add item(s) to playlist",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"name": "item",
"required": true,
"type": [
{
"$ref": "Playlist.Item"
},
{
"items": {
"$ref": "Playlist.Item"
},
"type": "array"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Clear playlist",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#List.Fields.All|List.Fields.All]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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:'''
# ''array[ [[#List.Item.All|List.Item.All]] ]'' items<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get all items from playlist",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "List.Fields.All",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"items": {
"items": {
"$ref": "List.Item.All"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Playlist.GetPlaylists ====
Returns all existing playlists<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Returns all existing playlists",
"params": [],
"permission": "ReadData",
"returns": {
"items": {
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"type": {
"$ref": "Playlist.Type",
"required": true
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"type": "method"
}
</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<br />
# ''array[ [[#Playlist.Property.Name|Playlist.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Playlist.Property.Value|Playlist.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"items": {
"$ref": "Playlist.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "Playlist.Property.Value"
},
"type": "method"
}
</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<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position<br />
# ''mixed: [[#Playlist.Item|Playlist.Item]]|array'' item<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position",
"required": true
},
{
"name": "item",
"required": true,
"type": [
{
"$ref": "Playlist.Item"
},
{
"items": {
"$ref": "Playlist.Item"
},
"type": "array"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Remove item from playlist. Does not work for picture playlists (aka slideshows).",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position1<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position2<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Swap items in the playlist. Does not work for picture playlists (aka slideshows).",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position1",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position2",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Profiles ===
==== Profiles.GetCurrentProfile ====
Retrieve the current profile<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Profiles.Fields.Profile|Profiles.Fields.Profile]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Profiles.Details.Profile|Profiles.Details.Profile]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve the current profile",
"params": [
{
"$ref": "Profiles.Fields.Profile",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"$ref": "Profiles.Details.Profile"
},
"type": "method"
}
</syntaxhighlight>}}
==== Profiles.GetProfiles ====
Retrieve all profiles<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Profiles.Fields.Profile|Profiles.Fields.Profile]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# ''array[ [[#Profiles.Details.Profile|Profiles.Details.Profile]] ]'' profiles<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all profiles",
"params": [
{
"$ref": "Profiles.Fields.Profile",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"profiles": {
"items": {
"$ref": "Profiles.Details.Profile"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Profiles.LoadProfile ====
Load the specified profile<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' profile (Profile name)<br />
# [''boolean'' prompt = False] (Prompt for password)<br />
# [''[[#Profiles.Password|Profiles.Password]]'' password]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Load the specified profile",
"params": [
{
"description": "Profile name",
"name": "profile",
"required": true,
"type": "string"
},
{
"default": false,
"description": "Prompt for password",
"name": "prompt",
"type": "boolean"
},
{
"$ref": "Profiles.Password",
"name": "password"
}
],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Settings ===
==== Settings.GetCategories ====
Retrieves all setting categories<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Setting.Level|Setting.Level]]'' level = standard]<br />
# [''string'' section = ""]<br />
# [''string'' properties]<br />
</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:'''
# [''array[ [[#Setting.Details.Category|Setting.Details.Category]] ]'' categories]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves all setting categories",
"params": [
{
"$ref": "Setting.Level",
"default": "standard",
"name": "level"
},
{
"default": "",
"name": "section",
"type": "string"
},
{
"extends": "Item.Fields.Base",
"items": {
"enums": [
"settings"
],
"type": "string"
},
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"categories": {
"items": {
"$ref": "Setting.Details.Category"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.GetSections ====
Retrieves all setting sections<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Setting.Level|Setting.Level]]'' level = standard]<br />
# [''[[#Setting.Level|Setting.Level]]'' properties]<br />
</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:'''
# [''array[ [[#Setting.Details.Section|Setting.Details.Section]] ]'' sections]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves all setting sections",
"params": [
{
"$ref": "Setting.Level",
"default": "standard",
"name": "level"
},
{
"extends": "Item.Fields.Base",
"items": {
"enums": [
"categories"
],
"type": "string"
},
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"sections": {
"items": {
"$ref": "Setting.Details.Section"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.GetSettingValue ====
Retrieves the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the value of a setting",
"params": [
{
"minLength": 1,
"name": "setting",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"value": {
"$ref": "Setting.Value.Extended",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.GetSettings ====
Retrieves all settings<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Setting.Level|Setting.Level]]'' level = standard]<br />
# [''mixed: object'' filter]<br />
</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:'''
# [''array[ [[#Setting.Details.Setting|Setting.Details.Setting]] ]'' settings]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves all settings",
"params": [
{
"$ref": "Setting.Level",
"default": "standard",
"name": "level"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"category": {
"minLength": 1,
"required": true,
"type": "string"
},
"section": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"settings": {
"items": {
"$ref": "Setting.Details.Setting"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.GetSkinSettingValue ====
Retrieves the value of the specified skin setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting<br />
</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:'''
# ''[{'type': 'boolean'}, {'type': 'string'}]'' value<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the value of the specified skin setting",
"params": [
{
"minLength": 1,
"name": "setting",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"value": {
"required": true,
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.GetSkinSettings ====
Retrieves all skin settings of the currently used skin<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array'' settings]<br />
# ''string'' skin<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves all skin settings of the currently used skin",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"settings": {
"items": {
"properties": {
"id": {
"minLength": 1,
"required": true,
"type": "string"
},
"type": {
"enums": [
"boolean",
"string"
],
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": "array"
},
"skin": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.ResetSettingValue ====
Resets the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Resets the value of a setting",
"params": [
{
"minLength": 1,
"name": "setting",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.SetSettingValue ====
Changes the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting<br />
# ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Changes the value of a setting",
"params": [
{
"minLength": 1,
"name": "setting",
"required": true,
"type": "string"
},
{
"$ref": "Setting.Value.Extended",
"name": "value",
"required": true
}
],
"permission": "ReadData",
"returns": {
"type": "boolean"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.SetSkinSettingValue ====
Changes the value of the specified skin setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting<br />
# ''mixed: boolean|string'' value<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Changes the value of the specified skin setting",
"params": [
{
"minLength": 1,
"name": "setting",
"required": true,
"type": "string"
},
{
"name": "value",
"required": true,
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
]
}
],
"permission": "ReadData",
"returns": {
"type": "boolean"
},
"type": "method"
}
</syntaxhighlight>}}
=== System ===
==== System.EjectOpticalDrive ====
Ejects or closes the optical disc drive (if available)<br />
'''Permissions:'''
* ControlSystem
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Ejects or closes the optical disc drive (if available)",
"params": [],
"permission": "ControlSystem",
"returns": {
"type": "string"
},
"type": "method"
}
</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">
# ''array[ [[#System.Property.Name|System.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#System.Property.Value|System.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"items": {
"$ref": "System.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "System.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.Hibernate ====
Puts the system running Kodi into hibernate mode<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Puts the system running Kodi into hibernate mode",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.Reboot ====
Reboots the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Reboots the system running Kodi",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.Shutdown ====
Shuts the system running Kodi down<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shuts the system running Kodi down",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.Suspend ====
Suspends the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Suspends the system running Kodi",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Textures ===
==== Textures.GetTextures ====
Retrieve all textures<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Textures.Fields.Texture|Textures.Fields.Texture]]'' properties]<br />
# [''[[#List.Filter.Textures|List.Filter.Textures]]'' filter]<br />
</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:'''
# ''array[ [[#Textures.Details.Texture|Textures.Details.Texture]] ]'' textures<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all textures",
"params": [
{
"$ref": "Textures.Fields.Texture",
"name": "properties"
},
{
"$ref": "List.Filter.Textures",
"name": "filter"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"textures": {
"items": {
"$ref": "Textures.Details.Texture"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Textures.RemoveTexture ====
Remove the specified texture<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' textureid (Texture database identifier)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Remove the specified texture",
"params": [
{
"$ref": "Library.Id",
"description": "Texture database identifier",
"name": "textureid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== VideoLibrary ===
==== VideoLibrary.Clean ====
Cleans the video library for non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
# [''string'' content = video] (Content type to clean for)<br />
# [''string'' directory = ""] (Path to the directory to clean up; performs a global cleanup if not specified)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Cleans the video library for non-existent items",
"params": [
{
"default": true,
"description": "Whether or not to show the progress bar or any other GUI dialog",
"name": "showdialogs",
"type": "boolean"
},
{
"default": "video",
"description": "Content type to clean for",
"enums": [
"video",
"movies",
"tvshows",
"musicvideos"
],
"name": "content",
"type": "string"
},
{
"default": "",
"description": "Path to the directory to clean up; performs a global cleanup if not specified",
"name": "directory",
"type": "string"
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.Export ====
Exports all items from the video library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''mixed: object|object'' options]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Exports all items from the video library",
"params": [
{
"name": "options",
"type": [
{
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the directory to where the data should be exported",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actorthumbs": {
"default": false,
"description": "Whether to export actor thumbnails",
"type": "boolean"
},
"images": {
"default": false,
"description": "Whether to export thumbnails and fanart images",
"type": "boolean"
},
"overwrite": {
"default": false,
"description": "Whether to overwrite existing exported files",
"type": "boolean"
}
},
"type": "object"
}
]
}
],
"permission": "WriteFile",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetAvailableArt ====
Retrieve all potential art URLs for a media item by art 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">
# ''mixed: object|object|object|object|object|object'' item<br />
# [''string'' arttype = ""]<br />
</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:'''
# ''array'' availableart<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all potential art URLs for a media item by art type",
"params": [
{
"name": "item",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"episodeid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tvshowid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"seasonid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"movieid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"musicvideoid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
},
{
"default": "",
"name": "arttype",
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"availableart": {
"items": {
"properties": {
"arttype": {
"required": true,
"type": "string"
},
"previewurl": {
"default": "",
"description": "URL to a preview thumbnail of the image",
"type": "string"
},
"url": {
"description": "URL to the original image",
"required": true,
"type": "string"
}
},
"type": "object"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetAvailableArtTypes ====
Retrieve a list of potential art types for a media 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">
# ''mixed: object|object|object|object|object|object'' item<br />
</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:'''
# ''array'' availablearttypes<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve a list of potential art types for a media item",
"params": [
{
"name": "item",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"episodeid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tvshowid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"seasonid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"movieid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"musicvideoid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"availablearttypes": {
"items": {
"type": "string"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific tv show episode",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"$ref": "Video.Fields.Episode",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"episodedetails": {
"$ref": "Video.Details.Episode"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''integer'' season = -1]<br />
# [''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|[[#List.Filter.Episodes|List.Filter.Episodes]]'' filter]<br />
</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:'''
# [''array[ [[#Video.Details.Episode|Video.Details.Episode]] ]'' episodes]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all tv show episodes",
"params": [
{
"$ref": "Library.Id",
"default": -1,
"name": "tvshowid"
},
{
"default": -1,
"minimum": 0,
"name": "season",
"type": "integer"
},
{
"$ref": "Video.Fields.Episode",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Requires tvshowid to be set",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Requires tvshowid to be set",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"description": "Requires tvshowid to be set",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Episodes"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"episodes": {
"items": {
"$ref": "Video.Details.Episode"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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:'''
# ''array[ [[#Library.Details.Genre|Library.Details.Genre]] ]'' genres<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all genres",
"params": [
{
"enums": [
"movie",
"tvshow",
"musicvideo"
],
"name": "type",
"required": true,
"type": "string"
},
{
"$ref": "Library.Fields.Genre",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"genres": {
"items": {
"$ref": "Library.Details.Genre"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetInProgressTVShows ====
Retrieve all in progress tvshows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# [''array[ [[#Video.Details.TVShow|Video.Details.TVShow]] ]'' tvshows]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all in progress tvshows",
"params": [
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tvshows": {
"items": {
"$ref": "Video.Details.TVShow"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific movie",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"$ref": "Video.Fields.Movie",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"moviedetails": {
"$ref": "Video.Details.Movie"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties]<br />
# [''object'' movies]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific movie set",
"params": [
{
"$ref": "Library.Id",
"name": "setid",
"required": true
},
{
"$ref": "Video.Fields.MovieSet",
"name": "properties"
},
{
"name": "movies",
"properties": {
"limits": {
"$ref": "List.Limits"
},
"properties": {
"$ref": "Video.Fields.Movie"
},
"sort": {
"$ref": "List.Sort"
}
},
"type": "object"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"setdetails": {
"$ref": "Video.Details.MovieSet.Extended"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# [''array[ [[#Video.Details.MovieSet|Video.Details.MovieSet]] ]'' sets]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all movie sets",
"params": [
{
"$ref": "Video.Fields.MovieSet",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sets": {
"items": {
"$ref": "Video.Details.MovieSet"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|object|object|object|[[#List.Filter.Movies|List.Filter.Movies]]'' filter]<br />
</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<br />
# [''array[ [[#Video.Details.Movie|Video.Details.Movie]] ]'' movies]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all movies",
"params": [
{
"$ref": "Video.Fields.Movie",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"country": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"set": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Movies"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific music video",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"musicvideodetails": {
"$ref": "Video.Details.MusicVideo"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|[[#List.Filter.MusicVideos|List.Filter.MusicVideos]]'' filter]<br />
</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<br />
# [''array[ [[#Video.Details.MusicVideo|Video.Details.MusicVideo]] ]'' musicvideos]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all music videos",
"params": [
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.MusicVideos"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"musicvideos": {
"items": {
"$ref": "Video.Details.MusicVideo"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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:'''
# [''array[ [[#Video.Details.Episode|Video.Details.Episode]] ]'' episodes]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all recently added tv episodes",
"params": [
{
"$ref": "Video.Fields.Episode",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"episodes": {
"items": {
"$ref": "Video.Details.Episode"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# [''array[ [[#Video.Details.Movie|Video.Details.Movie]] ]'' movies]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all recently added movies",
"params": [
{
"$ref": "Video.Fields.Movie",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# [''array[ [[#Video.Details.MusicVideo|Video.Details.MusicVideo]] ]'' musicvideos]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all recently added music videos",
"params": [
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"musicvideos": {
"items": {
"$ref": "Video.Details.MusicVideo"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetSeasonDetails ====
Retrieve details about a specific tv show season<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' seasonid<br />
# [''[[#Video.Fields.Season|Video.Fields.Season]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Video.Details.Season|Video.Details.Season]]'' seasondetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific tv show season",
"params": [
{
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
{
"$ref": "Video.Fields.Season",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"seasondetails": {
"$ref": "Video.Details.Season"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetSeasons ====
Retrieve all tv seasons<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Library.Id|Library.Id]]'' tvshowid = -1]<br />
# [''[[#Video.Fields.Season|Video.Fields.Season]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# [''array[ [[#Video.Details.Season|Video.Details.Season]] ]'' seasons]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all tv seasons",
"params": [
{
"$ref": "Library.Id",
"default": -1,
"name": "tvshowid"
},
{
"$ref": "Video.Fields.Season",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"seasons": {
"items": {
"$ref": "Video.Details.Season"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</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<br />
# [''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties]<br />
</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]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific tv show",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"tvshowdetails": {
"$ref": "Video.Details.TVShow"
}
},
"type": "object"
},
"type": "method"
}
</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]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|[[#List.Filter.TVShows|List.Filter.TVShows]]'' filter]<br />
</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<br />
# [''array[ [[#Video.Details.TVShow|Video.Details.TVShow]] ]'' tvshows]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all tv shows",
"params": [
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.TVShows"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tvshows": {
"items": {
"$ref": "Video.Details.TVShow"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetTags ====
Retrieve all tags<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' type<br />
# [''[[#Library.Fields.Tag|Library.Fields.Tag]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</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<br />
# ''array[ [[#Library.Details.Tag|Library.Details.Tag]] ]'' tags<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all tags",
"params": [
{
"enums": [
"movie",
"tvshow",
"musicvideo"
],
"name": "type",
"required": true,
"type": "string"
},
{
"$ref": "Library.Fields.Tag",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tags": {
"items": {
"$ref": "Library.Details.Tag"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RefreshEpisode ====
Refresh the given episode in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid<br />
# [''boolean'' ignorenfo = False] (Whether or not to ignore a local NFO if present.)<br />
# [''string'' title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the given episode in the library",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"default": false,
"description": "Whether or not to ignore a local NFO if present.",
"name": "ignorenfo",
"type": "boolean"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"name": "title",
"type": "string"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RefreshMovie ====
Refresh the given movie in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid<br />
# [''boolean'' ignorenfo = False] (Whether or not to ignore a local NFO if present.)<br />
# [''string'' title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the given movie in the library",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"default": false,
"description": "Whether or not to ignore a local NFO if present.",
"name": "ignorenfo",
"type": "boolean"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"name": "title",
"type": "string"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RefreshMusicVideo ====
Refresh the given music video in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid<br />
# [''boolean'' ignorenfo = False] (Whether or not to ignore a local NFO if present.)<br />
# [''string'' title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the given music video in the library",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"default": false,
"description": "Whether or not to ignore a local NFO if present.",
"name": "ignorenfo",
"type": "boolean"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"name": "title",
"type": "string"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RefreshTVShow ====
Refresh the given tv show in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid<br />
# [''boolean'' ignorenfo = False] (Whether or not to ignore a local NFO if present.)<br />
# [''boolean'' refreshepisodes = False] (Whether or not to refresh all episodes belonging to the TV show.)<br />
# [''string'' title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the given tv show in the library",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"default": false,
"description": "Whether or not to ignore a local NFO if present.",
"name": "ignorenfo",
"type": "boolean"
},
{
"default": false,
"description": "Whether or not to refresh all episodes belonging to the TV show.",
"name": "refreshepisodes",
"type": "boolean"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"name": "title",
"type": "string"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Removes the given episode from the library",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Removes the given movie from the library",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Removes the given music video from the library",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Removes the given tv show from the library",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</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 = ""]<br />
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Scans the video sources for new library items",
"params": [
{
"default": "",
"name": "directory",
"type": "string"
},
{
"default": true,
"description": "Whether or not to show the progress bar or any other GUI dialog",
"name": "showdialogs",
"type": "boolean"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br />
# [''mixed: null|[[#Array.String|Array.String]]'' director = None]<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.String|Optional.String]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' writer = None]<br />
# [''[[#Optional.String|Optional.String]]'' firstaired = None]<br />
# [''[[#Optional.String|Optional.String]]'' productioncode = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' season = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' episode = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaltitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
# [''[[#Optional.String|Optional.String]]'' fanart = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings]<br />
# [''[[#Optional.String|Optional.String]]'' dateadded = None]<br />
# [''mixed: null|[[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given episode with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "Runtime in seconds",
"name": "runtime"
},
{
"default": null,
"name": "director",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"default": null,
"name": "writer",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "firstaired"
},
{
"$ref": "Optional.String",
"default": null,
"name": "productioncode"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "season"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "episode"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"default": null,
"name": "fanart"
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"default": null,
"name": "resume",
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"default": null,
"name": "dateadded"
},
{
"default": null,
"name": "uniqueid",
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br />
# [''mixed: null|[[#Array.String|Array.String]]'' director = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' studio = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' year = None] (linked with premiered. Overridden by premiered parameter)<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.String|Optional.String]]'' mpaa = None]<br />
# [''[[#Optional.String|Optional.String]]'' imdbnumber = None]<br />
# [''[[#Optional.String|Optional.String]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaltitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' trailer = None]<br />
# [''[[#Optional.String|Optional.String]]'' tagline = None]<br />
# [''[[#Optional.String|Optional.String]]'' plotoutline = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' writer = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' country = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' top250 = None]<br />
# [''[[#Optional.String|Optional.String]]'' sorttitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' set = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' showlink = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
# [''[[#Optional.String|Optional.String]]'' fanart = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' tag = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings]<br />
# [''[[#Optional.String|Optional.String]]'' dateadded = None]<br />
# [''[[#Optional.String|Optional.String]]'' premiered = None] (linked with year. Overrides year)<br />
# [''mixed: null|[[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given movie with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "Runtime in seconds",
"name": "runtime"
},
{
"default": null,
"name": "director",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "studio",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "linked with premiered. Overridden by premiered parameter",
"name": "year"
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "mpaa"
},
{
"$ref": "Optional.String",
"default": null,
"name": "imdbnumber"
},
{
"$ref": "Optional.String",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "trailer"
},
{
"$ref": "Optional.String",
"default": null,
"name": "tagline"
},
{
"$ref": "Optional.String",
"default": null,
"name": "plotoutline"
},
{
"default": null,
"name": "writer",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "country",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "top250"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sorttitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "set"
},
{
"default": null,
"name": "showlink",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"default": null,
"name": "fanart"
},
{
"default": null,
"name": "tag",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"default": null,
"name": "resume",
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"default": null,
"name": "dateadded"
},
{
"$ref": "Optional.String",
"default": null,
"description": "linked with year. Overrides year",
"name": "premiered"
},
{
"default": null,
"name": "uniqueid",
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.SetMovieSetDetails ====
Update the given movie set with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' setid<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given movie set with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "setid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br />
# [''mixed: null|[[#Array.String|Array.String]]'' director = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' studio = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' year = None] (linked with premiered. Overridden by premiered parameter)<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
# [''[[#Optional.String|Optional.String]]'' album = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' track = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
# [''[[#Optional.String|Optional.String]]'' fanart = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' tag = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Optional.String|Optional.String]]'' dateadded = None]<br />
# [''[[#Optional.String|Optional.String]]'' premiered = None] (linked with year. Overrides year)<br />
# [''mixed: null|[[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given music video with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "Runtime in seconds",
"name": "runtime"
},
{
"default": null,
"name": "director",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "studio",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "linked with premiered. Overridden by premiered parameter",
"name": "year"
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
},
{
"$ref": "Optional.String",
"default": null,
"name": "album"
},
{
"default": null,
"name": "artist",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "track"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"default": null,
"name": "fanart"
},
{
"default": null,
"name": "tag",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"default": null,
"name": "resume",
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
]
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "dateadded"
},
{
"$ref": "Optional.String",
"default": null,
"description": "linked with year. Overrides year",
"name": "premiered"
},
{
"default": null,
"name": "uniqueid",
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.SetSeasonDetails ====
Update the given season with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' seasonid<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given season with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</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<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' studio = None]<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.String|Optional.String]]'' mpaa = None]<br />
# [''[[#Optional.String|Optional.String]]'' imdbnumber = None]<br />
# [''[[#Optional.String|Optional.String]]'' premiered = None]<br />
# [''[[#Optional.String|Optional.String]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaltitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' sorttitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' episodeguide = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
# [''[[#Optional.String|Optional.String]]'' fanart = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' tag = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings]<br />
# [''[[#Optional.String|Optional.String]]'' dateadded = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br />
# [''[[#Optional.String|Optional.String]]'' status = None] (Valid values: 'returning series', 'in production', 'planned', 'cancelled', 'ended')<br />
# [''mixed: null|[[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given tvshow with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"default": null,
"name": "studio",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "mpaa"
},
{
"$ref": "Optional.String",
"default": null,
"name": "imdbnumber"
},
{
"$ref": "Optional.String",
"default": null,
"name": "premiered"
},
{
"$ref": "Optional.String",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sorttitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "episodeguide"
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"default": null,
"name": "fanart"
},
{
"default": null,
"name": "tag",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"default": null,
"name": "dateadded"
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "Runtime in seconds",
"name": "runtime"
},
{
"$ref": "Optional.String",
"default": null,
"description": "Valid values: 'returning series', 'in production', 'planned', 'cancelled', 'ended'",
"name": "status"
},
{
"default": null,
"name": "uniqueid",
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== XBMC ===
==== XBMC.GetInfoBooleans ====
Retrieve info booleans about Kodi and the system<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[string]'' booleans<br />
</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 (Object containing key-value pairs of the retrieved info booleans)''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve info booleans about Kodi and the system",
"params": [
{
"items": {
"type": "string"
},
"minItems": 1,
"name": "booleans",
"required": true,
"type": "array"
}
],
"permission": "ReadData",
"returns": {
"additionalProperties": {
"default": "",
"type": "string"
},
"description": "Object containing key-value pairs of the retrieved info booleans",
"type": "object"
},
"type": "method"
}
</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[string]'' labels (See http://kodi.wiki/view/InfoLabels for a list of possible info labels)<br />
</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 (Object containing key-value pairs of the retrieved info labels)''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve info labels about Kodi and the system",
"params": [
{
"description": "See http://kodi.wiki/view/InfoLabels for a list of possible info labels",
"items": {
"type": "string"
},
"minItems": 1,
"name": "labels",
"required": true,
"type": "array"
}
],
"permission": "ReadData",
"returns": {
"additionalProperties": {
"default": "",
"type": "string"
},
"description": "Object containing key-value pairs of the retrieved info labels",
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
== Global Types ==
=== Addon ===
==== Addon.Content ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"video",
"audio",
"image",
"executable"
],
"id": "Addon.Content",
"type": "string"
}
</syntaxhighlight>}}
==== Addon.Details ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' addonid
* [''string'' author]
* [''mixed: boolean|string'' broken]
* [''array'' dependencies]
* [''mixed: boolean|string'' deprecated]
* [''string'' description]
* [''string'' disclaimer]
* [''boolean'' enabled]
* [''array'' extrainfo]
* [''string'' fanart]
* [''boolean'' installed]
* [''string'' name]
* [''string'' path]
* [''integer'' rating]
* [''string'' summary]
* [''string'' thumbnail]
* ''[[#Addon.Types|Addon.Types]]'' type
* [''string'' version]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Addon.Details",
"properties": {
"addonid": {
"required": true,
"type": "string"
},
"author": {
"default": "",
"type": "string"
},
"broken": {
"default": null,
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"dependencies": {
"items": {
"properties": {
"addonid": {
"required": true,
"type": "string"
},
"optional": {
"required": true,
"type": "boolean"
},
"version": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"deprecated": {
"default": null,
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"description": {
"default": "",
"type": "string"
},
"disclaimer": {
"default": "",
"type": "string"
},
"enabled": {
"default": false,
"type": "boolean"
},
"extrainfo": {
"items": {
"properties": {
"key": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"fanart": {
"default": "",
"type": "string"
},
"installed": {
"default": false,
"type": "boolean"
},
"name": {
"default": "",
"type": "string"
},
"path": {
"default": "",
"type": "string"
},
"rating": {
"default": 0,
"type": "integer"
},
"summary": {
"default": "",
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
},
"type": {
"$ref": "Addon.Types",
"required": true
},
"version": {
"default": "",
"type": "string"
}
}
}
</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="json">
{
"extends": "Item.Fields.Base",
"id": "Addon.Fields",
"items": {
"enums": [
"name",
"version",
"summary",
"description",
"path",
"author",
"thumbnail",
"disclaimer",
"fanart",
"dependencies",
"broken",
"extrainfo",
"rating",
"enabled",
"installed",
"deprecated"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Addon.Types ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"xbmc.player.musicviz",
"xbmc.gui.skin",
"kodi.pvrclient",
"kodi.inputstream",
"kodi.gameclient",
"kodi.peripheral",
"xbmc.python.script",
"xbmc.python.weather",
"xbmc.subtitle.module",
"xbmc.python.lyrics",
"xbmc.metadata.scraper.albums",
"xbmc.metadata.scraper.artists",
"xbmc.metadata.scraper.movies",
"xbmc.metadata.scraper.musicvideos",
"xbmc.metadata.scraper.tvshows",
"xbmc.ui.screensaver",
"xbmc.python.pluginsource",
"xbmc.addon.repository",
"xbmc.webinterface",
"xbmc.service",
"kodi.audioencoder",
"kodi.context.item",
"kodi.audiodecoder",
"kodi.resource.images",
"kodi.resource.language",
"kodi.resource.uisounds",
"kodi.resource.games",
"kodi.resource.font",
"kodi.vfs",
"kodi.imagedecoder",
"xbmc.metadata.scraper.library",
"xbmc.python.library",
"xbmc.python.module",
"kodi.game.controller",
"",
"xbmc.addon.video",
"xbmc.addon.audio",
"xbmc.addon.image",
"xbmc.addon.executable",
"kodi.addon.game"
],
"id": "Addon.Types",
"type": "string"
}
</syntaxhighlight>}}
=== Application ===
==== Application.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "volume",
"enums": [
"volume",
"muted",
"name",
"version",
"sorttokens",
"language"
],
"id": "Application.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== Application.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' language]
* [''boolean'' muted]
* [''string'' name]
* [''[[#Array.String|Array.String]]'' sorttokens]
* [''object'' version]
* [''integer'' volume]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Application.Property.Value",
"properties": {
"language": {
"default": "",
"description": "Current language code and region e.g. en_GB",
"minLength": 1,
"type": "string"
},
"muted": {
"default": false,
"type": "boolean"
},
"name": {
"default": "",
"minLength": 1,
"type": "string"
},
"sorttokens": {
"$ref": "Array.String",
"description": "Articles ignored during sorting when ignorearticle is enabled."
},
"version": {
"properties": {
"major": {
"minimum": 0,
"required": true,
"type": "integer"
},
"minor": {
"minimum": 0,
"required": true,
"type": "integer"
},
"revision": {
"default": null,
"type": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"tag": {
"enums": [
"prealpha",
"alpha",
"beta",
"releasecandidate",
"stable"
],
"required": true,
"type": "string"
},
"tagversion": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"volume": {
"default": 0,
"maximum": 100,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Array ===
==== Array.Integer ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Array.Integer",
"items": {
"type": "integer"
},
"type": "array"
}
</syntaxhighlight>}}
==== Array.String ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Array.String",
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
}
</syntaxhighlight>}}
=== Audio ===
==== Audio.Album.ReleaseType ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "album",
"enums": [
"album",
"single"
],
"id": "Audio.Album.ReleaseType",
"type": "string"
}
</syntaxhighlight>}}
==== Audio.Artist.Roles ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Audio.Artist.Roles",
"items": {
"additionalProperties": false,
"description": "The various roles contributed by an artist to one or more songs",
"properties": {
"role": {
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
"type": "array"
}
</syntaxhighlight>}}
==== Audio.Contributors ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Audio.Contributors",
"items": {
"additionalProperties": false,
"description": "The artist and the role they contribute to a song",
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"name": {
"required": true,
"type": "string"
},
"role": {
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
"type": "array"
}
</syntaxhighlight>}}
==== Audio.Details.Album ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' albumduration]
* ''[[#Library.Id|Library.Id]]'' albumid
* [''string'' albumlabel]
* [''string'' albumstatus]
* [''boolean'' compilation]
* [''string'' description]
* [''boolean'' isboxset]
* [''string'' lastplayed]
* [''[[#Array.String|Array.String]]'' mood]
* [''string'' musicbrainzalbumid]
* [''string'' musicbrainzreleasegroupid]
* [''integer'' playcount]
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = album]
* [''[[#Audio.Details.Genres|Audio.Details.Genres]]'' songgenres]
* [''[[#Array.Integer|Array.Integer]]'' sourceid]
* [''[[#Array.String|Array.String]]'' style]
* [''[[#Array.String|Array.String]]'' theme]
* [''integer'' totaldiscs]
* [''string'' type]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Audio.Details.Media",
"id": "Audio.Details.Album",
"properties": {
"albumduration": {
"default": 0,
"type": "integer"
},
"albumid": {
"$ref": "Library.Id",
"required": true
},
"albumlabel": {
"default": "",
"type": "string"
},
"albumstatus": {
"default": "",
"type": "string"
},
"compilation": {
"default": false,
"type": "boolean"
},
"description": {
"default": "",
"type": "string"
},
"isboxset": {
"default": false,
"type": "boolean"
},
"lastplayed": {
"default": "",
"type": "string"
},
"mood": {
"$ref": "Array.String"
},
"musicbrainzalbumid": {
"default": "",
"type": "string"
},
"musicbrainzreleasegroupid": {
"default": "",
"type": "string"
},
"playcount": {
"default": 0,
"type": "integer"
},
"releasetype": {
"$ref": "Audio.Album.ReleaseType",
"default": "album"
},
"songgenres": {
"$ref": "Audio.Details.Genres"
},
"sourceid": {
"$ref": "Array.Integer"
},
"style": {
"$ref": "Array.String"
},
"theme": {
"$ref": "Array.String"
},
"totaldiscs": {
"default": 0,
"type": "integer"
},
"type": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Artist ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' artist
* ''[[#Library.Id|Library.Id]]'' artistid
* [''string'' born]
* [''boolean'' compilationartist]
* [''string'' description]
* [''string'' died]
* [''string'' disambiguation]
* [''string'' disbanded]
* [''string'' formed]
* [''string'' gender]
* [''[[#Array.String|Array.String]]'' instrument]
* [''boolean'' isalbumartist]
* [''[[#Array.String|Array.String]]'' mood]
* [''[[#Array.String|Array.String]]'' musicbrainzartistid]
* [''[[#Audio.Artist.Roles|Audio.Artist.Roles]]'' roles]
* [''[[#Audio.Details.Genres|Audio.Details.Genres]]'' songgenres]
* [''string'' sortname]
* [''[[#Array.Integer|Array.Integer]]'' sourceid]
* [''[[#Array.String|Array.String]]'' style]
* [''string'' type]
* [''[[#Array.String|Array.String]]'' yearsactive]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Audio.Details.Base",
"id": "Audio.Details.Artist",
"properties": {
"artist": {
"required": true,
"type": "string"
},
"artistid": {
"$ref": "Library.Id",
"required": true
},
"born": {
"default": "",
"type": "string"
},
"compilationartist": {
"default": false,
"type": "boolean"
},
"description": {
"default": "",
"type": "string"
},
"died": {
"default": "",
"type": "string"
},
"disambiguation": {
"default": "",
"type": "string"
},
"disbanded": {
"default": "",
"type": "string"
},
"formed": {
"default": "",
"type": "string"
},
"gender": {
"default": "",
"type": "string"
},
"instrument": {
"$ref": "Array.String"
},
"isalbumartist": {
"default": false,
"type": "boolean"
},
"mood": {
"$ref": "Array.String"
},
"musicbrainzartistid": {
"$ref": "Array.String"
},
"roles": {
"$ref": "Audio.Artist.Roles"
},
"songgenres": {
"$ref": "Audio.Details.Genres"
},
"sortname": {
"default": "",
"type": "string"
},
"sourceid": {
"$ref": "Array.Integer"
},
"style": {
"$ref": "Array.String"
},
"type": {
"default": "",
"type": "string"
},
"yearsactive": {
"$ref": "Array.String"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Media.Artwork|Media.Artwork]]'' art]
* [''string'' dateadded]
* [''[[#Array.String|Array.String]]'' genre]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Media.Details.Base",
"id": "Audio.Details.Base",
"properties": {
"art": {
"$ref": "Media.Artwork"
},
"dateadded": {
"default": "",
"type": "string"
},
"genre": {
"$ref": "Array.String"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Genres ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Audio.Details.Genres",
"items": {
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
</syntaxhighlight>}}
==== Audio.Details.Media ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Array.String|Array.String]]'' artist]
* [''[[#Array.Integer|Array.Integer]]'' artistid]
* [''string'' displayartist]
* [''[[#Array.String|Array.String]]'' musicbrainzalbumartistid]
* [''string'' originaldate]
* [''number'' rating]
* [''string'' releasedate]
* [''string'' sortartist]
* [''string'' title]
* [''integer'' userrating]
* [''integer'' votes]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Audio.Details.Base",
"id": "Audio.Details.Media",
"properties": {
"artist": {
"$ref": "Array.String"
},
"artistid": {
"$ref": "Array.Integer"
},
"displayartist": {
"default": "",
"type": "string"
},
"musicbrainzalbumartistid": {
"$ref": "Array.String"
},
"originaldate": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"releasedate": {
"default": "",
"type": "string"
},
"sortartist": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
},
"userrating": {
"default": 0,
"type": "integer"
},
"votes": {
"default": 0,
"type": "integer"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Role ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' roleid
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Audio.Details.Role",
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Song ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' album]
* [''[[#Array.String|Array.String]]'' albumartist]
* [''[[#Array.Integer|Array.Integer]]'' albumartistid]
* [''[[#Library.Id|Library.Id]]'' albumid = -1]
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' albumreleasetype = album]
* [''any'' bitrate]
* [''any'' bpm]
* [''any'' channels]
* [''string'' comment]
* [''[[#Audio.Contributors|Audio.Contributors]]'' contributors]
* [''integer'' disc]
* [''string'' disctitle]
* [''string'' displaycomposer]
* [''string'' displayconductor]
* [''string'' displaylyricist]
* [''string'' displayorchestra]
* [''integer'' duration]
* [''string'' file]
* [''[[#Array.Integer|Array.Integer]]'' genreid]
* [''string'' lastplayed]
* [''string'' lyrics]
* [''string'' mood]
* [''[[#Array.String|Array.String]]'' musicbrainzartistid]
* [''string'' musicbrainztrackid]
* [''integer'' playcount]
* [''any'' samplerate]
* ''[[#Library.Id|Library.Id]]'' songid
* [''string'' songvideourl]
* [''[[#Array.Integer|Array.Integer]]'' sourceid]
* [''integer'' track]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Audio.Details.Media",
"id": "Audio.Details.Song",
"properties": {
"album": {
"default": "",
"type": "string"
},
"albumartist": {
"$ref": "Array.String"
},
"albumartistid": {
"$ref": "Array.Integer"
},
"albumid": {
"$ref": "Library.Id",
"default": -1
},
"albumreleasetype": {
"$ref": "Audio.Album.ReleaseType",
"default": "album"
},
"bitrate": {
"default": null,
"type": "any"
},
"bpm": {
"default": null,
"type": "any"
},
"channels": {
"default": null,
"type": "any"
},
"comment": {
"default": "",
"type": "string"
},
"contributors": {
"$ref": "Audio.Contributors"
},
"disc": {
"default": 0,
"type": "integer"
},
"disctitle": {
"default": "",
"type": "string"
},
"displaycomposer": {
"default": "",
"type": "string"
},
"displayconductor": {
"default": "",
"type": "string"
},
"displaylyricist": {
"default": "",
"type": "string"
},
"displayorchestra": {
"default": "",
"type": "string"
},
"duration": {
"default": 0,
"type": "integer"
},
"file": {
"default": "",
"type": "string"
},
"genreid": {
"$ref": "Array.Integer"
},
"lastplayed": {
"default": "",
"type": "string"
},
"lyrics": {
"default": "",
"type": "string"
},
"mood": {
"default": "",
"type": "string"
},
"musicbrainzartistid": {
"$ref": "Array.String"
},
"musicbrainztrackid": {
"default": "",
"type": "string"
},
"playcount": {
"default": 0,
"type": "integer"
},
"samplerate": {
"default": null,
"type": "any"
},
"songid": {
"$ref": "Library.Id",
"required": true
},
"songvideourl": {
"default": "",
"type": "string"
},
"sourceid": {
"$ref": "Array.Integer"
},
"track": {
"default": 0,
"type": "integer"
}
}
}
</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="json">
{
"extends": "Item.Fields.Base",
"id": "Audio.Fields.Album",
"items": {
"description": "Requesting the songgenres, artistid and/or sourceid fields will result in increased response times",
"enums": [
"title",
"description",
"artist",
"genre",
"theme",
"mood",
"style",
"type",
"albumlabel",
"rating",
"votes",
"userrating",
"year",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"fanart",
"thumbnail",
"playcount",
"artistid",
"displayartist",
"compilation",
"releasetype",
"dateadded",
"sortartist",
"musicbrainzreleasegroupid",
"songgenres",
"art",
"lastplayed",
"sourceid",
"isboxset",
"totaldiscs",
"releasedate",
"originaldate",
"albumstatus",
"datemodified",
"datenew",
"albumduration"
],
"type": "string"
}
}
</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="json">
{
"extends": "Item.Fields.Base",
"id": "Audio.Fields.Artist",
"items": {
"description": "Requesting the (song)genreid/genre, roleid/role or sourceid fields will result in increased response times",
"enums": [
"instrument",
"style",
"mood",
"born",
"formed",
"description",
"genre",
"died",
"disbanded",
"yearsactive",
"musicbrainzartistid",
"fanart",
"thumbnail",
"compilationartist",
"dateadded",
"roles",
"songgenres",
"isalbumartist",
"sortname",
"type",
"gender",
"disambiguation",
"art",
"sourceid",
"datemodified",
"datenew"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Audio.Fields.Role ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Audio.Fields.Role",
"items": {
"enums": [
"title"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Audio.Fields.Song ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Audio.Fields.Song",
"items": {
"description": "Requesting the genreid, artistid, albumartistid and/or sourceid fields will result in increased response times",
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"thumbnail",
"file",
"albumid",
"lastplayed",
"disc",
"genreid",
"artistid",
"displayartist",
"albumartistid",
"albumreleasetype",
"dateadded",
"votes",
"userrating",
"mood",
"contributors",
"displaycomposer",
"displayconductor",
"displayorchestra",
"displaylyricist",
"sortartist",
"art",
"sourceid",
"disctitle",
"releasedate",
"originaldate",
"bpm",
"samplerate",
"bitrate",
"channels",
"datemodified",
"datenew",
"songvideourl"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Audio.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "missingartistid",
"enums": [
"missingartistid",
"librarylastupdated",
"librarylastcleaned",
"artistlinksupdated",
"songslastadded",
"albumslastadded",
"artistslastadded",
"genreslastadded",
"songsmodified",
"albumsmodified",
"artistsmodified"
],
"id": "Audio.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== Audio.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' albumslastadded]
* [''string'' albumsmodified]
* [''string'' artistlinksupdated]
* [''string'' artistslastadded]
* [''string'' artistsmodified]
* [''string'' genreslastadded]
* [''string'' librarylastcleaned]
* [''string'' librarylastupdated]
* [''[[#Library.Id|Library.Id]]'' missingartistid = -1]
* [''string'' songslastadded]
* [''string'' songsmodified]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Audio.Property.Value",
"properties": {
"albumslastadded": {
"default": "",
"type": "string"
},
"albumsmodified": {
"default": "",
"type": "string"
},
"artistlinksupdated": {
"default": "",
"type": "string"
},
"artistslastadded": {
"default": "",
"type": "string"
},
"artistsmodified": {
"default": "",
"type": "string"
},
"genreslastadded": {
"default": "",
"type": "string"
},
"librarylastcleaned": {
"default": "",
"type": "string"
},
"librarylastupdated": {
"default": "",
"type": "string"
},
"missingartistid": {
"$ref": "Library.Id",
"default": -1
},
"songslastadded": {
"default": "",
"type": "string"
},
"songsmodified": {
"default": "",
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Configuration ===
==== Configuration ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Configuration.Notifications|Configuration.Notifications]]'' notifications
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Configuration",
"properties": {
"notifications": {
"$ref": "Configuration.Notifications",
"required": true
}
},
"required": true,
"type": "object"
}
</syntaxhighlight>}}
==== Configuration.Notifications ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' application
* ''boolean'' audiolibrary
* ''boolean'' gui
* ''boolean'' input
* ''boolean'' other
* ''boolean'' player
* ''boolean'' playlist
* ''boolean'' pvr
* ''boolean'' system
* ''boolean'' videolibrary
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Configuration.Notifications",
"properties": {
"application": {
"required": true,
"type": "boolean"
},
"audiolibrary": {
"required": true,
"type": "boolean"
},
"gui": {
"required": true,
"type": "boolean"
},
"input": {
"required": true,
"type": "boolean"
},
"other": {
"required": true,
"type": "boolean"
},
"player": {
"required": true,
"type": "boolean"
},
"playlist": {
"required": true,
"type": "boolean"
},
"pvr": {
"required": true,
"type": "boolean"
},
"system": {
"required": true,
"type": "boolean"
},
"videolibrary": {
"required": true,
"type": "boolean"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Favourite ===
==== Favourite.Details.Favourite ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' path]
* [''string'' thumbnail]
* ''string'' title
* ''[[#Favourite.Type|Favourite.Type]]'' type
* [''string'' window]
* [''string'' windowparameter]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Favourite.Details.Favourite",
"properties": {
"path": {
"default": "",
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Favourite.Type",
"required": true
},
"window": {
"default": "",
"type": "string"
},
"windowparameter": {
"default": "",
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Favourite.Fields.Favourite ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Favourite.Fields.Favourite",
"items": {
"enums": [
"window",
"windowparameter",
"thumbnail",
"path"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Favourite.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "media",
"enums": [
"media",
"window",
"script",
"androidapp",
"unknown"
],
"id": "Favourite.Type",
"type": "string"
}
</syntaxhighlight>}}
=== Files ===
==== Files.Media ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "video",
"enums": [
"video",
"music",
"pictures",
"files",
"programs"
],
"id": "Files.Media",
"type": "string"
}
</syntaxhighlight>}}
=== GUI ===
==== GUI.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "currentwindow",
"enums": [
"currentwindow",
"currentcontrol",
"skin",
"fullscreen",
"stereoscopicmode"
],
"id": "GUI.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== GUI.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''object'' currentcontrol]
* [''object'' currentwindow]
* [''boolean'' fullscreen]
* [''object'' skin]
* [''[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]'' stereoscopicmode]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "GUI.Property.Value",
"properties": {
"currentcontrol": {
"properties": {
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"currentwindow": {
"properties": {
"id": {
"required": true,
"type": "integer"
},
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"fullscreen": {
"default": false,
"type": "boolean"
},
"skin": {
"properties": {
"id": {
"minLength": 1,
"required": true,
"type": "string"
},
"name": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"stereoscopicmode": {
"$ref": "GUI.Stereoscopy.Mode"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== GUI.Stereoscopy.Mode ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' label
* ''string'' mode
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "GUI.Stereoscopy.Mode",
"properties": {
"label": {
"required": true,
"type": "string"
},
"mode": {
"enums": [
"off",
"split_vertical",
"split_horizontal",
"row_interleaved",
"hardware_based",
"anaglyph_cyan_red",
"anaglyph_green_magenta",
"anaglyph_yellow_blue",
"monoscopic"
],
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== GUI.Window ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "addon",
"enums": [
"addon",
"addonbrowser",
"addoninformation",
"addonsettings",
"appearancesettings",
"busydialog",
"busydialognocancel",
"contentsettings",
"contextmenu",
"dialogcolorpicker",
"eventlog",
"extendedprogressdialog",
"favouritesbrowser",
"filebrowser",
"filemanager",
"fullscreengame",
"fullscreeninfo",
"fullscreenlivetv",
"fullscreenlivetvinput",
"fullscreenlivetvpreview",
"fullscreenradio",
"fullscreenradioinput",
"fullscreenradiopreview",
"fullscreenvideo",
"gameadvancedsettings",
"gameagents",
"gamecontrollers",
"gameosd",
"gamepadinput",
"gameports",
"games",
"gamesaves",
"gamesettings",
"gamestretchmode",
"gamevideofilter",
"gamevideorotation",
"gamevolume",
"home",
"infoprovidersettings",
"ingamesaves",
"interfacesettings",
"libexportsettings",
"locksettings",
"loginscreen",
"managevideoextras",
"managevideoversions",
"mediafilter",
"mediasettings",
"mediasource",
"movieinformation",
"music",
"musicinformation",
"musicosd",
"musicplaylist",
"musicplaylisteditor",
"networksetup",
"notification",
"numericinput",
"okdialog",
"osdaudiosettings",
"osdcmssettings",
"osdsubtitlesettings",
"osdvideosettings",
"peripherals",
"peripheralsettings",
"pictureinfo",
"pictures",
"playercontrols",
"playerprocessinfo",
"playersettings",
"profiles",
"profilesettings",
"programs",
"progressdialog",
"pvrchannelguide",
"pvrchannelmanager",
"pvrchannelscan",
"pvrgroupmanager",
"pvrguidecontrols",
"pvrguideinfo",
"pvrguidesearch",
"pvrosdchannels",
"pvrosdguide",
"pvrosdteletext",
"pvrradiordsinfo",
"pvrrecordinginfo",
"pvrsettings",
"pvrtimersetting",
"pvrupdateprogress",
"radiochannels",
"radioguide",
"radiorecordings",
"radiosearch",
"radiotimerrules",
"radiotimers",
"screencalibration",
"screensaver",
"seekbar",
"selectdialog",
"selectvideoextra",
"selectvideoversion",
"servicesettings",
"settings",
"shutdownmenu",
"skinsettings",
"sliderdialog",
"slideshow",
"smartplaylisteditor",
"smartplaylistrule",
"songinformation",
"splash",
"startup",
"startwindow",
"submenu",
"subtitlesearch",
"systeminfo",
"systemsettings",
"teletext",
"textviewer",
"tvchannels",
"tvguide",
"tvrecordings",
"tvsearch",
"tvtimerrules",
"tvtimers",
"videobookmarks",
"videomenu",
"videoosd",
"videoplaylist",
"videos",
"videotimeseek",
"virtualkeyboard",
"visualisation",
"visualisationpresetlist",
"volumebar",
"weather",
"yesnodialog"
],
"id": "GUI.Window",
"type": "string"
}
</syntaxhighlight>}}
=== Global ===
==== Global.IncrementDecrement ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "increment",
"enums": [
"increment",
"decrement"
],
"id": "Global.IncrementDecrement",
"type": "string"
}
</syntaxhighlight>}}
==== Global.String.NotEmpty ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "",
"id": "Global.String.NotEmpty",
"minLength": 1,
"type": "string"
}
</syntaxhighlight>}}
==== Global.Time ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' hours
* ''integer'' milliseconds
* ''integer'' minutes
* ''integer'' seconds
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"description": "A duration.",
"id": "Global.Time",
"properties": {
"hours": {
"minimum": 0,
"required": true,
"type": "integer"
},
"milliseconds": {
"maximum": 999,
"minimum": 0,
"required": true,
"type": "integer"
},
"minutes": {
"maximum": 59,
"minimum": 0,
"required": true,
"type": "integer"
},
"seconds": {
"maximum": 59,
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Global.Toggle ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Global.Toggle",
"type": [
{
"type": "boolean"
},
{
"enums": [
"toggle"
],
"type": "string"
}
]
}
</syntaxhighlight>}}
==== Global.Weekday ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "monday",
"enums": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"id": "Global.Weekday",
"type": "string"
}
</syntaxhighlight>}}
=== Input ===
==== Input.Action ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "analogfastforward",
"enums": [
"analogfastforward",
"analogmove",
"analogmovexleft",
"analogmovexright",
"analogmoveydown",
"analogmoveyup",
"analogrewind",
"analogseekback",
"analogseekforward",
"aspectratio",
"audiodelay",
"audiodelayminus",
"audiodelayplus",
"audionextlanguage",
"audiotoggledigital",
"back",
"backspace",
"bigstepback",
"bigstepforward",
"blue",
"browsesubtitle",
"channeldown",
"channelnumberseparator",
"channelup",
"chapterorbigstepback",
"chapterorbigstepforward",
"close",
"codecinfo",
"contextmenu",
"copy",
"createbookmark",
"createepisodebookmark",
"cursorleft",
"cursorright",
"cyclesubtitle",
"cycletonemapmethod",
"decreasepar",
"decreaserating",
"decreasevisrating",
"delete",
"doubleclick",
"down",
"enter",
"error",
"fastforward",
"filter",
"filterclear",
"filtersms2",
"filtersms3",
"filtersms4",
"filtersms5",
"filtersms6",
"filtersms7",
"filtersms8",
"filtersms9",
"firstpage",
"fullscreen",
"green",
"guiprofile",
"hdrtoggle",
"highlight",
"increasepar",
"increaserating",
"increasevisrating",
"info",
"jumpsms2",
"jumpsms3",
"jumpsms4",
"jumpsms5",
"jumpsms6",
"jumpsms7",
"jumpsms8",
"jumpsms9",
"lastpage",
"left",
"leftclick",
"lockpreset",
"longclick",
"longpress",
"menu",
"middleclick",
"mousedrag",
"mousedragend",
"mousemove",
"move",
"moveitemdown",
"moveitemup",
"mute",
"nextcalibration",
"nextchannelgroup",
"nextletter",
"nextpicture",
"nextpreset",
"nextresolution",
"nextscene",
"nextstereomode",
"nextsubtitle",
"noop",
"number0",
"number1",
"number2",
"number3",
"number4",
"number5",
"number6",
"number7",
"number8",
"number9",
"osd",
"pagedown",
"pageup",
"pangesture",
"parentdir",
"parentfolder",
"pause",
"play",
"playerdebug",
"playerdebugvideo",
"playerprocessinfo",
"playerprogramselect",
"playerresolutionselect",
"playlist",
"playnext",
"playpause",
"playpvr",
"playpvrradio",
"playpvrtv",
"previouschannelgroup",
"previousmenu",
"previouspicture",
"previouspreset",
"previousscene",
"previousstereomode",
"prevletter",
"queue",
"randompreset",
"record",
"red",
"reloadkeymaps",
"rename",
"resetcalibration",
"rewind",
"right",
"rightclick",
"rotate",
"rotateccw",
"rotategesture",
"scanitem",
"screenshot",
"scrolldown",
"scrollup",
"select",
"setrating",
"settingslevelchange",
"settingsreset",
"shift",
"showpreset",
"showsubtitles",
"showtime",
"showtimerrule",
"showvideomenu",
"skipnext",
"skipprevious",
"smallstepback",
"stepback",
"stepforward",
"stereomode",
"stereomodetomono",
"stop",
"subtitlealign",
"subtitledelay",
"subtitledelayminus",
"subtitledelayplus",
"subtitleshiftdown",
"subtitleshiftup",
"swipedown",
"swipeleft",
"swiperight",
"swipeup",
"switchplayer",
"symbols",
"tap",
"tempodown",
"tempoup",
"togglecommskip",
"togglefont",
"togglefullscreen",
"togglestereomode",
"togglewatched",
"up",
"verticalshiftdown",
"verticalshiftup",
"videonextstream",
"voicerecognizer",
"volampdown",
"volampup",
"volumeamplification",
"volumedown",
"volumeup",
"wheeldown",
"wheelup",
"yellow",
"zoomgesture",
"zoomin",
"zoomlevel1",
"zoomlevel2",
"zoomlevel3",
"zoomlevel4",
"zoomlevel5",
"zoomlevel6",
"zoomlevel7",
"zoomlevel8",
"zoomlevel9",
"zoomnormal",
"zoomout"
],
"id": "Input.Action",
"type": "string"
}
</syntaxhighlight>}}
=== Item ===
==== Item.CustomProperties ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"id": "Item.CustomProperties",
"type": "object"
}
</syntaxhighlight>}}
==== Item.Details.Base ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' label
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Item.Details.Base",
"properties": {
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Item.Fields.Base ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Item.Fields.Base",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
</syntaxhighlight>}}
=== Library ===
==== Library.Details.Genre ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' genreid
* [''[[#Array.Integer|Array.Integer]]'' sourceid]
* [''string'' thumbnail]
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Library.Details.Genre",
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
},
"sourceid": {
"$ref": "Array.Integer",
"description": "The ids of sources with songs of the genre"
},
"thumbnail": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Library.Details.Source ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' file
* [''[[#Array.String|Array.String]]'' paths]
* ''[[#Library.Id|Library.Id]]'' sourceid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Library.Details.Source",
"properties": {
"file": {
"description": "The url encoded multipath string combining all paths of the source ",
"required": true,
"type": "string"
},
"paths": {
"$ref": "Array.String",
"description": "The individual paths of the media source"
},
"sourceid": {
"$ref": "Library.Id",
"required": true
}
}
}
</syntaxhighlight>}}
==== Library.Details.Tag ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' tagid
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Library.Details.Tag",
"properties": {
"tagid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
}
}
}
</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="json">
{
"extends": "Item.Fields.Base",
"id": "Library.Fields.Genre",
"items": {
"enums": [
"title",
"thumbnail",
"sourceid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Library.Fields.Source ====
'''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="json">
{
"extends": "Item.Fields.Base",
"id": "Library.Fields.Source",
"items": {
"enums": [
"file",
"paths"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Library.Fields.Tag ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Library.Fields.Tag",
"items": {
"enums": [
"title"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Library.Id ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "Library.Id",
"minimum": 1,
"type": "integer"
}
</syntaxhighlight>}}
=== List ===
==== List.Amount ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "List.Amount",
"minimum": 0,
"type": "integer"
}
</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="json">
{
"extends": "Item.Fields.Base",
"id": "List.Fields.All",
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"channel",
"channeltype",
"hidden",
"locked",
"channelnumber",
"subchannelnumber",
"starttime",
"endtime",
"specialsortseason",
"specialsortepisode",
"compilation",
"releasetype",
"albumreleasetype",
"contributors",
"displaycomposer",
"displayconductor",
"displayorchestra",
"displaylyricist",
"userrating",
"sortartist",
"musicbrainzreleasegroupid",
"mediapath",
"dynpath",
"isboxset",
"totaldiscs",
"disctitle",
"releasedate",
"originaldate",
"bpm",
"bitrate",
"samplerate",
"channels",
"albumstatus",
"datemodified",
"datenew",
"customproperties",
"albumduration",
"songvideourl"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== List.Fields.Files ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "List.Fields.Files",
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"size",
"lastmodified",
"mimetype",
"specialsortseason",
"specialsortepisode",
"sortartist",
"musicbrainzreleasegroupid",
"isboxset",
"totaldiscs",
"disctitle",
"releasedate",
"originaldate",
"bpm",
"bitrate",
"samplerate",
"channels",
"datemodified",
"datenew",
"customproperties",
"albumduration",
"userrating",
"songvideourl"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== List.Filter.Albums ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Albums",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Albums"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Albums"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Albums"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Artists ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Artists",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Artists"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Artists"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Artists"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Episodes ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Episodes",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Episodes"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Episodes"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Episodes"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Fields.Albums ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "genre",
"enums": [
"genre",
"source",
"album",
"disctitle",
"totaldiscs",
"isboxset",
"artist",
"albumartist",
"year",
"originalyear",
"albumduration",
"review",
"themes",
"moods",
"styles",
"compilation",
"type",
"label",
"rating",
"userrating",
"playcount",
"lastplayed",
"path",
"albumstatus",
"dateadded",
"datemodified",
"datenew",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Albums",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Artists ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "artist",
"enums": [
"artist",
"source",
"genre",
"moods",
"styles",
"instruments",
"biography",
"artisttype",
"gender",
"disambiguation",
"born",
"bandformed",
"disbanded",
"died",
"role",
"path",
"dateadded",
"datemodified",
"datenew",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Artists",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Episodes ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "title",
"enums": [
"title",
"tvshow",
"originaltitle",
"plot",
"votes",
"rating",
"userrating",
"time",
"writers",
"airdate",
"playcount",
"lastplayed",
"inprogress",
"genre",
"year",
"director",
"actor",
"episode",
"season",
"filename",
"path",
"studio",
"mpaarating",
"dateadded",
"tag",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"hdrtype",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Episodes",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Movies ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "title",
"enums": [
"title",
"originaltitle",
"plot",
"plotoutline",
"tagline",
"votes",
"rating",
"userrating",
"time",
"writers",
"playcount",
"lastplayed",
"inprogress",
"genre",
"country",
"year",
"director",
"actor",
"mpaarating",
"top250",
"studio",
"hastrailer",
"filename",
"path",
"set",
"tag",
"dateadded",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"hdrtype",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Movies",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.MusicVideos ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "title",
"enums": [
"title",
"genre",
"album",
"year",
"artist",
"filename",
"path",
"playcount",
"lastplayed",
"rating",
"userrating",
"time",
"director",
"studio",
"plot",
"tag",
"dateadded",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"hdrtype",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.MusicVideos",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Songs ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "genre",
"enums": [
"genre",
"source",
"album",
"disctitle",
"artist",
"albumartist",
"title",
"year",
"originalyear",
"time",
"tracknumber",
"filename",
"path",
"playcount",
"lastplayed",
"rating",
"userrating",
"comment",
"moods",
"bpm",
"samplerate",
"bitrate",
"channels",
"dateadded",
"datemodified",
"datenew",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Songs",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.TVShows ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "title",
"enums": [
"title",
"originaltitle",
"plot",
"status",
"votes",
"rating",
"userrating",
"year",
"genre",
"director",
"actor",
"numepisodes",
"numwatched",
"playcount",
"path",
"studio",
"mpaarating",
"dateadded",
"lastplayed",
"inprogress",
"tag",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.TVShows",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Textures ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "textureid",
"enums": [
"textureid",
"url",
"cachedurl",
"lasthashcheck",
"imagehash",
"width",
"height",
"usecount",
"lastused"
],
"id": "List.Filter.Fields.Textures",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Movies ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Movies",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Movies"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Movies"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Movies"
}
]
}
</syntaxhighlight>}}
==== List.Filter.MusicVideos ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.MusicVideos",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.MusicVideos"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.MusicVideos"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.MusicVideos"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Operators ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "contains",
"enums": [
"contains",
"doesnotcontain",
"is",
"isnot",
"startswith",
"endswith",
"greaterthan",
"lessthan",
"after",
"before",
"inthelast",
"notinthelast",
"true",
"false",
"between"
],
"id": "List.Filter.Operators",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Rule ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Operators|List.Filter.Operators]]'' operator
* ''mixed: string|array'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Rule",
"properties": {
"operator": {
"$ref": "List.Filter.Operators",
"required": true
},
"value": {
"required": true,
"type": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
}
</syntaxhighlight>}}
==== List.Filter.Rule.Albums ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Albums|List.Filter.Fields.Albums]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Albums",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Albums",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Artists ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Artists|List.Filter.Fields.Artists]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Artists",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Artists",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Episodes ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Episodes|List.Filter.Fields.Episodes]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Episodes",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Episodes",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Movies ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Movies|List.Filter.Fields.Movies]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Movies",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Movies",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.MusicVideos ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.MusicVideos|List.Filter.Fields.MusicVideos]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.MusicVideos",
"properties": {
"field": {
"$ref": "List.Filter.Fields.MusicVideos",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Songs ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Songs|List.Filter.Fields.Songs]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Songs",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Songs",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.TVShows ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.TVShows|List.Filter.Fields.TVShows]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.TVShows",
"properties": {
"field": {
"$ref": "List.Filter.Fields.TVShows",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Textures ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Textures|List.Filter.Fields.Textures]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Textures",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Textures",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Songs ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Songs",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Songs"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Songs"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Songs"
}
]
}
</syntaxhighlight>}}
==== List.Filter.TVShows ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.TVShows",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.TVShows"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.TVShows"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.TVShows"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Textures ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Textures",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Textures"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Textures"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Textures"
}
]
}
</syntaxhighlight>}}
==== List.Item.All ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' channel]
* [''integer'' channelnumber]
* [''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = tv]
* [''string'' endtime]
* [''boolean'' hidden]
* [''boolean'' locked]
* [''string'' starttime]
* [''integer'' subchannelnumber]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Item.Base",
"id": "List.Item.All",
"properties": {
"channel": {
"default": "",
"type": "string"
},
"channelnumber": {
"default": 0,
"type": "integer"
},
"channeltype": {
"$ref": "PVR.Channel.Type",
"default": "tv"
},
"endtime": {
"default": "",
"type": "string"
},
"hidden": {
"default": false,
"type": "boolean"
},
"locked": {
"default": false,
"type": "boolean"
},
"starttime": {
"default": "",
"type": "string"
},
"subchannelnumber": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== List.Item.Base ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' album]
* [''[[#Array.String|Array.String]]'' albumartist]
* [''[[#Array.Integer|Array.Integer]]'' albumartistid]
* [''[[#Library.Id|Library.Id]]'' albumid = -1]
* [''string'' albumlabel]
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' albumreleasetype = album]
* [''string'' albumstatus]
* [''integer'' bitrate]
* [''integer'' bpm]
* [''[[#Video.Cast|Video.Cast]]'' cast]
* [''integer'' channels]
* [''string'' comment]
* [''boolean'' compilation]
* [''[[#Audio.Contributors|Audio.Contributors]]'' contributors]
* [''[[#Array.String|Array.String]]'' country]
* [''[[#Item.CustomProperties|Item.CustomProperties]]'' customproperties]
* [''string'' description]
* [''integer'' disc]
* [''string'' disctitle]
* [''string'' displaycomposer]
* [''string'' displayconductor]
* [''string'' displaylyricist]
* [''string'' displayorchestra]
* [''integer'' duration]
* [''string'' dynpath]
* [''integer'' episode]
* [''string'' episodeguide]
* [''string'' firstaired]
* [''[[#Library.Id|Library.Id]]'' id = -1]
* [''string'' imdbnumber]
* [''boolean'' isboxset]
* [''string'' lyrics]
* [''string'' mediapath]
* [''[[#Array.String|Array.String]]'' mood]
* [''string'' mpaa]
* [''[[#Array.String|Array.String]]'' musicbrainzartistid]
* [''string'' musicbrainztrackid]
* [''string'' originaldate]
* [''string'' originaltitle]
* [''string'' plotoutline]
* [''string'' premiered]
* [''string'' productioncode]
* [''string'' releasedate]
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = album]
* [''integer'' samplerate]
* [''integer'' season]
* [''string'' set]
* [''[[#Library.Id|Library.Id]]'' setid = -1]
* [''[[#Array.String|Array.String]]'' showlink]
* [''string'' showtitle]
* [''string'' songvideourl]
* [''string'' sorttitle]
* [''integer'' specialsortepisode]
* [''integer'' specialsortseason]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Array.String|Array.String]]'' style]
* [''[[#Array.String|Array.String]]'' tag]
* [''string'' tagline]
* [''[[#Array.String|Array.String]]'' theme]
* [''integer'' top250]
* [''integer'' totaldiscs]
* [''integer'' track]
* [''string'' trailer]
* [''[[#Library.Id|Library.Id]]'' tvshowid = -1]
* [''string'' type = unknown]
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''string'' votes]
* [''integer'' watchedepisodes]
* [''[[#Array.String|Array.String]]'' writer]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": [
"Video.Details.File",
"Audio.Details.Media"
],
"id": "List.Item.Base",
"properties": {
"album": {
"default": "",
"type": "string"
},
"albumartist": {
"$ref": "Array.String"
},
"albumartistid": {
"$ref": "Array.Integer"
},
"albumid": {
"$ref": "Library.Id",
"default": -1
},
"albumlabel": {
"default": "",
"type": "string"
},
"albumreleasetype": {
"$ref": "Audio.Album.ReleaseType",
"default": "album"
},
"albumstatus": {
"default": "",
"type": "string"
},
"bitrate": {
"default": 0,
"type": "integer"
},
"bpm": {
"default": 0,
"type": "integer"
},
"cast": {
"$ref": "Video.Cast"
},
"channels": {
"default": 0,
"type": "integer"
},
"comment": {
"default": "",
"type": "string"
},
"compilation": {
"default": false,
"type": "boolean"
},
"contributors": {
"$ref": "Audio.Contributors"
},
"country": {
"$ref": "Array.String"
},
"customproperties": {
"$ref": "Item.CustomProperties"
},
"description": {
"default": "",
"type": "string"
},
"disc": {
"default": 0,
"type": "integer"
},
"disctitle": {
"default": "",
"type": "string"
},
"displaycomposer": {
"default": "",
"type": "string"
},
"displayconductor": {
"default": "",
"type": "string"
},
"displaylyricist": {
"default": "",
"type": "string"
},
"displayorchestra": {
"default": "",
"type": "string"
},
"duration": {
"default": 0,
"type": "integer"
},
"dynpath": {
"default": "",
"description": "An experimental property for debug purposes, often same as mediapath but when different gives the actual file playing that should also be in file property",
"type": "string"
},
"episode": {
"default": 0,
"type": "integer"
},
"episodeguide": {
"default": "",
"type": "string"
},
"firstaired": {
"default": "",
"type": "string"
},
"id": {
"$ref": "Library.Id",
"default": -1
},
"imdbnumber": {
"default": "",
"type": "string"
},
"isboxset": {
"default": false,
"type": "boolean"
},
"lyrics": {
"default": "",
"type": "string"
},
"mediapath": {
"default": "",
"description": "Media source path that identifies the item",
"type": "string"
},
"mood": {
"$ref": "Array.String"
},
"mpaa": {
"default": "",
"type": "string"
},
"musicbrainzartistid": {
"$ref": "Array.String"
},
"musicbrainztrackid": {
"default": "",
"type": "string"
},
"originaldate": {
"default": "",
"type": "string"
},
"originaltitle": {
"default": "",
"type": "string"
},
"plotoutline": {
"default": "",
"type": "string"
},
"premiered": {
"default": "",
"type": "string"
},
"productioncode": {
"default": "",
"type": "string"
},
"releasedate": {
"default": "",
"type": "string"
},
"releasetype": {
"$ref": "Audio.Album.ReleaseType",
"default": "album"
},
"samplerate": {
"default": 0,
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"set": {
"default": "",
"type": "string"
},
"setid": {
"$ref": "Library.Id",
"default": -1
},
"showlink": {
"$ref": "Array.String"
},
"showtitle": {
"default": "",
"type": "string"
},
"songvideourl": {
"default": "",
"type": "string"
},
"sorttitle": {
"default": "",
"type": "string"
},
"specialsortepisode": {
"default": 0,
"type": "integer"
},
"specialsortseason": {
"default": 0,
"type": "integer"
},
"studio": {
"$ref": "Array.String"
},
"style": {
"$ref": "Array.String"
},
"tag": {
"$ref": "Array.String"
},
"tagline": {
"default": "",
"type": "string"
},
"theme": {
"$ref": "Array.String"
},
"top250": {
"default": 0,
"type": "integer"
},
"totaldiscs": {
"default": 0,
"type": "integer"
},
"track": {
"default": 0,
"type": "integer"
},
"trailer": {
"default": "",
"type": "string"
},
"tvshowid": {
"$ref": "Library.Id",
"default": -1
},
"type": {
"default": "unknown",
"enums": [
"unknown",
"movie",
"episode",
"musicvideo",
"song",
"picture",
"channel",
"recording"
],
"type": "string"
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"votes": {
"default": "",
"type": "string"
},
"watchedepisodes": {
"default": 0,
"type": "integer"
},
"writer": {
"$ref": "Array.String"
}
}
}
</syntaxhighlight>}}
==== List.Item.File ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' file
* ''string'' filetype
* [''string'' lastmodified]
* [''string'' mimetype]
* [''integer'' size]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Item.Base",
"id": "List.Item.File",
"properties": {
"file": {
"required": true,
"type": "string"
},
"filetype": {
"enums": [
"file",
"directory"
],
"required": true,
"type": "string"
},
"lastmodified": {
"default": "",
"type": "string"
},
"mimetype": {
"default": "",
"type": "string"
},
"size": {
"default": 0,
"description": "Size of the file in bytes",
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== List.Items.Sources ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Items.Sources",
"items": {
"extends": "Item.Details.Base",
"properties": {
"file": {
"required": true,
"type": "string"
}
}
},
"type": "array"
}
</syntaxhighlight>}}
==== List.Limits ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#List.Amount|List.Amount]]'' end = -1]
* [''integer'' start]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "List.Limits",
"properties": {
"end": {
"$ref": "List.Amount",
"default": -1,
"description": "Index of the last item to return"
},
"start": {
"default": 0,
"description": "Index of the first item to return",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== List.LimitsReturned ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#List.Amount|List.Amount]]'' end = -1]
* [''integer'' start]
* ''integer'' total
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "List.LimitsReturned",
"properties": {
"end": {
"$ref": "List.Amount",
"default": -1
},
"start": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"total": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== List.Sort ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''boolean'' ignorearticle]
* [''string'' method = none]
* [''string'' order = ascending]
* [''boolean'' useartistsortname]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Sort",
"properties": {
"ignorearticle": {
"default": false,
"type": "boolean"
},
"method": {
"default": "none",
"enums": [
"none",
"label",
"date",
"size",
"file",
"path",
"drivetype",
"title",
"track",
"time",
"artist",
"album",
"albumtype",
"genre",
"country",
"year",
"rating",
"userrating",
"votes",
"top250",
"programcount",
"playlist",
"episode",
"season",
"totalepisodes",
"watchedepisodes",
"tvshowstatus",
"tvshowtitle",
"sorttitle",
"productioncode",
"mpaa",
"studio",
"dateadded",
"lastplayed",
"playcount",
"listeners",
"bitrate",
"random",
"totaldiscs",
"originaldate",
"bpm",
"originaltitle"
],
"type": "string"
},
"order": {
"default": "ascending",
"enums": [
"ascending",
"descending"
],
"type": "string"
},
"useartistsortname": {
"default": false,
"type": "boolean"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Media ===
==== Media.Artwork ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' banner]
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' fanart]
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' poster]
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' thumb]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"id": "Media.Artwork",
"properties": {
"banner": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"fanart": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"poster": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"thumb": {
"$ref": "Global.String.NotEmpty",
"default": ""
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Media.Artwork.Set ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' banner]
* [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' fanart]
* [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' poster]
* [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' thumb]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"default": null,
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"id": "Media.Artwork.Set",
"properties": {
"banner": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"fanart": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"poster": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"thumb": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Media.Details.Base ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' fanart]
* [''string'' thumbnail]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Media.Details.Base",
"properties": {
"fanart": {
"default": "",
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Media.UniqueID ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"id": "Media.UniqueID",
"type": "object"
}
</syntaxhighlight>}}
==== Media.UniqueID.Set ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"default": null,
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"id": "Media.UniqueID.Set",
"type": "object"
}
</syntaxhighlight>}}
=== Notifications ===
==== Notifications.Item ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Notifications.Item",
"type": [
{
"description": "An unknown item does not have any additional information.",
"properties": {
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "An item known to the database has an identification.",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A movie item has a title and may have a release year.",
"properties": {
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
},
"year": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
{
"description": "A tv episode has a title and may have an episode number, season number and the title of the show it belongs to.",
"properties": {
"episode": {
"default": 0,
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"showtitle": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A music video has a title and may have an album and an artist.",
"properties": {
"album": {
"default": "",
"type": "string"
},
"artist": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A song has a title and may have an album, an artist and a track number.",
"properties": {
"album": {
"default": "",
"type": "string"
},
"artist": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"track": {
"default": 0,
"type": "integer"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A picture has a file path.",
"properties": {
"file": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A PVR channel is either a radio or tv channel and has a title.",
"properties": {
"channeltype": {
"$ref": "PVR.Channel.Type",
"required": true
},
"id": {
"$ref": "Library.Id",
"required": true
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
}
]
}
</syntaxhighlight>}}
==== Notifications.Item.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"movie",
"episode",
"musicvideo",
"song",
"picture",
"channel"
],
"id": "Notifications.Item.Type",
"type": "string"
}
</syntaxhighlight>}}
=== Optional ===
==== Optional.Boolean ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Optional.Boolean",
"type": [
{
"type": "null"
},
{
"type": "boolean"
}
]
}
</syntaxhighlight>}}
==== Optional.Integer ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Optional.Integer",
"type": [
{
"type": "null"
},
{
"type": "integer"
}
]
}
</syntaxhighlight>}}
==== Optional.Number ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Optional.Number",
"type": [
{
"type": "null"
},
{
"type": "number"
}
]
}
</syntaxhighlight>}}
==== Optional.String ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Optional.String",
"type": [
{
"type": "null"
},
{
"type": "string"
}
]
}
</syntaxhighlight>}}
=== PVR ===
==== PVR.Channel.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "tv",
"enums": [
"tv",
"radio"
],
"id": "PVR.Channel.Type",
"type": "string"
}
</syntaxhighlight>}}
==== PVR.ChannelGroup.Id ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "PVR.ChannelGroup.Id",
"type": [
{
"$ref": "Library.Id"
},
{
"enums": [
"alltv",
"allradio"
],
"type": "string"
}
]
}
</syntaxhighlight>}}
==== PVR.Details.Broadcast ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' broadcastid
* [''string'' cast]
* [''[[#Library.Id|Library.Id]]'' clientid = -1]
* [''string'' director]
* [''string'' endtime]
* [''string'' episodename]
* [''integer'' episodenum]
* [''integer'' episodepart]
* [''string'' firstaired]
* [''string'' genre]
* [''boolean'' hasrecording]
* [''boolean'' hasreminder]
* [''boolean'' hastimer]
* [''boolean'' hastimerrule]
* [''integer'' imdbnumber]
* [''boolean'' isactive]
* [''boolean'' isplayable]
* [''boolean'' isseries]
* [''string'' originaltitle]
* [''integer'' parentalrating]
* [''string'' plot]
* [''string'' plotoutline]
* [''integer'' progress]
* [''number'' progresspercentage]
* [''integer'' rating]
* [''string'' recording]
* [''integer'' runtime]
* [''integer'' seasonnum]
* [''string'' starttime]
* [''string'' thumbnail]
* [''string'' title]
* [''boolean'' wasactive]
* [''string'' writer]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Broadcast",
"properties": {
"broadcastid": {
"$ref": "Library.Id",
"required": true
},
"cast": {
"default": "",
"type": "string"
},
"clientid": {
"$ref": "Library.Id",
"default": -1
},
"director": {
"default": "",
"type": "string"
},
"endtime": {
"default": "",
"type": "string"
},
"episodename": {
"default": "",
"type": "string"
},
"episodenum": {
"default": 0,
"type": "integer"
},
"episodepart": {
"default": 0,
"type": "integer"
},
"firstaired": {
"default": "",
"type": "string"
},
"genre": {
"default": "",
"type": "string"
},
"hasrecording": {
"default": false,
"type": "boolean"
},
"hasreminder": {
"default": false,
"type": "boolean"
},
"hastimer": {
"default": false,
"type": "boolean"
},
"hastimerrule": {
"default": false,
"type": "boolean"
},
"imdbnumber": {
"default": 0,
"type": "integer"
},
"isactive": {
"default": false,
"type": "boolean"
},
"isplayable": {
"default": false,
"description": "Deprecated - Use GetBroadcastIsPlayable instead",
"type": "boolean"
},
"isseries": {
"default": false,
"type": "boolean"
},
"originaltitle": {
"default": "",
"type": "string"
},
"parentalrating": {
"default": 0,
"type": "integer"
},
"plot": {
"default": "",
"type": "string"
},
"plotoutline": {
"default": "",
"type": "string"
},
"progress": {
"default": 0,
"type": "integer"
},
"progresspercentage": {
"default": 0.0,
"type": "number"
},
"rating": {
"default": 0,
"type": "integer"
},
"recording": {
"default": "",
"type": "string"
},
"runtime": {
"default": 0,
"type": "integer"
},
"seasonnum": {
"default": 0,
"type": "integer"
},
"starttime": {
"default": "",
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
},
"wasactive": {
"default": false,
"type": "boolean"
},
"writer": {
"default": "",
"type": "string"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== PVR.Details.Channel ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastnext]
* [''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastnow]
* [''string'' channel]
* ''[[#Library.Id|Library.Id]]'' channelid
* [''integer'' channelnumber]
* [''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = tv]
* [''[[#Library.Id|Library.Id]]'' clientid = -1]
* [''boolean'' hasarchive]
* [''boolean'' hidden]
* [''string'' icon]
* [''boolean'' isrecording]
* [''string'' lastplayed]
* [''boolean'' locked]
* [''integer'' subchannelnumber]
* [''string'' thumbnail]
* ''integer'' uniqueid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Channel",
"properties": {
"broadcastnext": {
"$ref": "PVR.Details.Broadcast"
},
"broadcastnow": {
"$ref": "PVR.Details.Broadcast"
},
"channel": {
"default": "",
"type": "string"
},
"channelid": {
"$ref": "Library.Id",
"required": true
},
"channelnumber": {
"default": 0,
"type": "integer"
},
"channeltype": {
"$ref": "PVR.Channel.Type",
"default": "tv"
},
"clientid": {
"$ref": "Library.Id",
"default": -1
},
"hasarchive": {
"default": false,
"type": "boolean"
},
"hidden": {
"default": false,
"type": "boolean"
},
"icon": {
"default": "",
"type": "string"
},
"isrecording": {
"default": false,
"type": "boolean"
},
"lastplayed": {
"default": "",
"type": "string"
},
"locked": {
"default": false,
"type": "boolean"
},
"subchannelnumber": {
"default": 0,
"type": "integer"
},
"thumbnail": {
"default": "",
"type": "string"
},
"uniqueid": {
"required": true,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== PVR.Details.ChannelGroup ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' channelgroupid
* ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.ChannelGroup",
"properties": {
"channelgroupid": {
"$ref": "Library.Id",
"required": true
},
"channeltype": {
"$ref": "PVR.Channel.Type",
"required": true
}
}
}
</syntaxhighlight>}}
==== PVR.Details.ChannelGroup.Extended ====
'''Extends:'''
* ''[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' channels]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "PVR.Details.ChannelGroup",
"id": "PVR.Details.ChannelGroup.Extended",
"properties": {
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
</syntaxhighlight>}}
==== PVR.Details.Client ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' addonid]
* ''[[#Library.Id|Library.Id]]'' clientid
* [''boolean'' supportschannelgroups]
* [''boolean'' supportschannelscan]
* [''boolean'' supportsepg]
* [''boolean'' supportsradio]
* [''boolean'' supportsrecordings]
* [''boolean'' supportstimers]
* [''boolean'' supportstv]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Client",
"properties": {
"addonid": {
"default": "",
"type": "string"
},
"clientid": {
"$ref": "Library.Id",
"required": true
},
"supportschannelgroups": {
"default": false,
"type": "boolean"
},
"supportschannelscan": {
"default": false,
"type": "boolean"
},
"supportsepg": {
"default": false,
"type": "boolean"
},
"supportsradio": {
"default": false,
"type": "boolean"
},
"supportsrecordings": {
"default": false,
"type": "boolean"
},
"supportstimers": {
"default": false,
"type": "boolean"
},
"supportstv": {
"default": false,
"type": "boolean"
}
}
}
</syntaxhighlight>}}
==== PVR.Details.Recording ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Media.Artwork|Media.Artwork]]'' art]
* [''string'' channel]
* [''integer'' channeluid]
* [''[[#Library.Id|Library.Id]]'' clientid = -1]
* [''string'' directory]
* [''string'' endtime]
* [''integer'' epgeventid]
* [''integer'' episode]
* [''string'' file]
* [''string'' genre]
* [''string'' icon]
* [''boolean'' isdeleted]
* [''integer'' lifetime]
* [''integer'' playcount]
* [''string'' plot]
* [''string'' plotoutline]
* [''boolean'' radio]
* ''[[#Library.Id|Library.Id]]'' recordingid
* [''[[#Video.Resume|Video.Resume]]'' resume]
* [''integer'' runtime]
* [''integer'' season]
* [''string'' showtitle]
* [''string'' starttime]
* [''string'' streamurl]
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Recording",
"properties": {
"art": {
"$ref": "Media.Artwork"
},
"channel": {
"default": "",
"type": "string"
},
"channeluid": {
"default": 0,
"type": "integer"
},
"clientid": {
"$ref": "Library.Id",
"default": -1
},
"directory": {
"default": "",
"type": "string"
},
"endtime": {
"default": "",
"type": "string"
},
"epgeventid": {
"default": 0,
"type": "integer"
},
"episode": {
"default": 0,
"type": "integer"
},
"file": {
"default": "",
"type": "string"
},
"genre": {
"default": "",
"type": "string"
},
"icon": {
"default": "",
"type": "string"
},
"isdeleted": {
"default": false,
"type": "boolean"
},
"lifetime": {
"default": 0,
"type": "integer"
},
"playcount": {
"default": 0,
"type": "integer"
},
"plot": {
"default": "",
"type": "string"
},
"plotoutline": {
"default": "",
"type": "string"
},
"radio": {
"default": false,
"type": "boolean"
},
"recordingid": {
"$ref": "Library.Id",
"required": true
},
"resume": {
"$ref": "Video.Resume"
},
"runtime": {
"default": 0,
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"showtitle": {
"default": "",
"type": "string"
},
"starttime": {
"default": "",
"type": "string"
},
"streamurl": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== PVR.Details.Timer ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Library.Id|Library.Id]]'' broadcastid = -1]
* [''[[#Library.Id|Library.Id]]'' channelid = -1]
* [''[[#Library.Id|Library.Id]]'' clientid = -1]
* [''string'' directory]
* [''boolean'' endanytime]
* [''integer'' endmargin]
* [''string'' endtime]
* [''string'' epgsearchstring]
* [''integer'' epguid]
* [''string'' file]
* [''string'' firstday]
* [''boolean'' fulltextepgsearch]
* [''boolean'' ismanual]
* [''boolean'' isradio]
* [''boolean'' isreadonly]
* [''boolean'' isreminder]
* [''boolean'' istimerrule]
* [''integer'' lifetime]
* [''integer'' maxrecordings]
* [''integer'' preventduplicateepisodes]
* [''integer'' priority]
* [''integer'' recordinggroup]
* [''integer'' runtime]
* [''boolean'' startanytime]
* [''integer'' startmargin]
* [''string'' starttime]
* [''[[#PVR.TimerState|PVR.TimerState]]'' state = unknown]
* [''string'' summary]
* ''[[#Library.Id|Library.Id]]'' timerid
* [''string'' title]
* [''array'' weekdays]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Timer",
"properties": {
"broadcastid": {
"$ref": "Library.Id",
"default": -1
},
"channelid": {
"$ref": "Library.Id",
"default": -1
},
"clientid": {
"$ref": "Library.Id",
"default": -1
},
"directory": {
"default": "",
"type": "string"
},
"endanytime": {
"default": false,
"type": "boolean"
},
"endmargin": {
"default": 0,
"type": "integer"
},
"endtime": {
"default": "",
"type": "string"
},
"epgsearchstring": {
"default": "",
"type": "string"
},
"epguid": {
"default": 0,
"type": "integer"
},
"file": {
"default": "",
"type": "string"
},
"firstday": {
"default": "",
"type": "string"
},
"fulltextepgsearch": {
"default": false,
"type": "boolean"
},
"ismanual": {
"default": false,
"type": "boolean"
},
"isradio": {
"default": false,
"type": "boolean"
},
"isreadonly": {
"default": false,
"type": "boolean"
},
"isreminder": {
"default": false,
"type": "boolean"
},
"istimerrule": {
"default": false,
"type": "boolean"
},
"lifetime": {
"default": 0,
"type": "integer"
},
"maxrecordings": {
"default": 0,
"type": "integer"
},
"preventduplicateepisodes": {
"default": 0,
"type": "integer"
},
"priority": {
"default": 0,
"type": "integer"
},
"recordinggroup": {
"default": 0,
"type": "integer"
},
"runtime": {
"default": 0,
"type": "integer"
},
"startanytime": {
"default": false,
"type": "boolean"
},
"startmargin": {
"default": 0,
"type": "integer"
},
"starttime": {
"default": "",
"type": "string"
},
"state": {
"$ref": "PVR.TimerState",
"default": "unknown"
},
"summary": {
"default": "",
"type": "string"
},
"timerid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
},
"weekdays": {
"items": {
"$ref": "Global.Weekday"
},
"type": "array",
"uniqueItems": true
}
}
}
</syntaxhighlight>}}
==== PVR.Fields.Broadcast ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Broadcast",
"items": {
"enums": [
"title",
"plot",
"plotoutline",
"starttime",
"endtime",
"runtime",
"progress",
"progresspercentage",
"genre",
"episodename",
"episodenum",
"episodepart",
"firstaired",
"hastimer",
"isactive",
"parentalrating",
"wasactive",
"thumbnail",
"rating",
"originaltitle",
"cast",
"director",
"writer",
"year",
"imdbnumber",
"hastimerrule",
"hasrecording",
"recording",
"isseries",
"isplayable",
"clientid",
"hasreminder",
"seasonnum"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Fields.Channel ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Channel",
"items": {
"enums": [
"thumbnail",
"channeltype",
"hidden",
"locked",
"channel",
"lastplayed",
"broadcastnow",
"broadcastnext",
"uniqueid",
"icon",
"channelnumber",
"subchannelnumber",
"isrecording",
"hasarchive",
"clientid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Fields.Client ====
'''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="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Client",
"items": {
"enums": [
"addonid",
"supportstv",
"supportsradio",
"supportsepg",
"supportsrecordings",
"supportstimers",
"supportschannelgroups",
"supportschannelscan"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Fields.Recording ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Recording",
"items": {
"enums": [
"title",
"plot",
"plotoutline",
"genre",
"playcount",
"resume",
"channel",
"starttime",
"endtime",
"runtime",
"lifetime",
"icon",
"art",
"streamurl",
"file",
"directory",
"radio",
"isdeleted",
"epgeventid",
"channeluid",
"season",
"episode",
"showtitle",
"clientid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Fields.Timer ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Timer",
"items": {
"enums": [
"title",
"summary",
"channelid",
"isradio",
"istimerrule",
"ismanual",
"starttime",
"endtime",
"runtime",
"lifetime",
"firstday",
"weekdays",
"priority",
"startmargin",
"endmargin",
"state",
"file",
"directory",
"preventduplicateepisodes",
"startanytime",
"endanytime",
"epgsearchstring",
"fulltextepgsearch",
"recordinggroup",
"maxrecordings",
"epguid",
"isreadonly",
"isreminder",
"clientid",
"broadcastid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "available",
"enums": [
"available",
"recording",
"scanning"
],
"id": "PVR.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== PVR.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''boolean'' available]
* [''boolean'' recording]
* [''boolean'' scanning]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "PVR.Property.Value",
"properties": {
"available": {
"default": false,
"type": "boolean"
},
"recording": {
"default": false,
"type": "boolean"
},
"scanning": {
"default": false,
"type": "boolean"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== PVR.TimerState ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"new",
"scheduled",
"recording",
"completed",
"aborted",
"cancelled",
"conflict_ok",
"conflict_notok",
"error",
"disabled"
],
"id": "PVR.TimerState",
"type": "string"
}
</syntaxhighlight>}}
=== Player ===
==== Player.Audio.Stream ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' bitrate
* ''integer'' channels
* ''string'' codec
* ''integer'' index
* ''boolean'' isdefault
* ''boolean'' isimpaired
* ''boolean'' isoriginal
* ''string'' language
* ''string'' name
* ''integer'' samplerate
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Audio.Stream",
"properties": {
"bitrate": {
"required": true,
"type": "integer"
},
"channels": {
"required": true,
"type": "integer"
},
"codec": {
"required": true,
"type": "string"
},
"index": {
"minimum": 0,
"required": true,
"type": "integer"
},
"isdefault": {
"required": true,
"type": "boolean"
},
"isimpaired": {
"required": true,
"type": "boolean"
},
"isoriginal": {
"required": true,
"type": "boolean"
},
"language": {
"required": true,
"type": "string"
},
"name": {
"required": true,
"type": "string"
},
"samplerate": {
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.CustomViewMode ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''mixed: string|[[#Optional.Boolean|Optional.Boolean]]'' nonlinearstretch]
* [''mixed: string|[[#Optional.Number|Optional.Number]]'' pixelratio]
* [''mixed: string|[[#Optional.Number|Optional.Number]]'' verticalshift]
* [''mixed: string|[[#Optional.Number|Optional.Number]]'' zoom]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.CustomViewMode",
"properties": {
"nonlinearstretch": {
"default": null,
"type": [
{
"enums": [
"increase",
"decrease"
],
"type": "string"
},
{
"$ref": "Optional.Boolean",
"description": "Flag to enable nonlinear stretch"
}
]
},
"pixelratio": {
"default": null,
"type": [
{
"enums": [
"increase",
"decrease"
],
"type": "string"
},
{
"$ref": "Optional.Number",
"description": "Pixel aspect ratio where 1.0 means square pixel"
}
]
},
"verticalshift": {
"default": null,
"type": [
{
"enums": [
"increase",
"decrease"
],
"type": "string"
},
{
"$ref": "Optional.Number",
"description": "Vertical shift 1.0 means shift to bottom"
}
]
},
"zoom": {
"default": null,
"type": [
{
"enums": [
"increase",
"decrease"
],
"type": "string"
},
{
"$ref": "Optional.Number",
"description": "Zoom where 1.0 means 100%"
}
]
}
},
"required": true,
"type": "object"
}
</syntaxhighlight>}}
==== Player.Id ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "Player.Id",
"maximum": 2,
"minimum": 0,
"type": "integer"
}
</syntaxhighlight>}}
==== Player.Notifications.Data ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Notifications.Item|Notifications.Item]]'' item
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Notifications.Data",
"properties": {
"item": {
"$ref": "Notifications.Item",
"required": true
},
"player": {
"$ref": "Player.Notifications.Player",
"required": true
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Notifications.Player ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Player.Id|Player.Id]]'' playerid
* [''integer'' speed]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Notifications.Player",
"properties": {
"playerid": {
"$ref": "Player.Id",
"required": true
},
"speed": {
"default": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Notifications.Player.Seek ====
'''Extends:'''
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Global.Time|Global.Time]]'' seekoffset]
* [''[[#Global.Time|Global.Time]]'' time]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Player.Notifications.Player",
"id": "Player.Notifications.Player.Seek",
"properties": {
"seekoffset": {
"$ref": "Global.Time",
"description": "A duration."
},
"time": {
"$ref": "Global.Time",
"description": "A duration."
}
}
}
</syntaxhighlight>}}
==== Player.Position.Percentage ====
'''Type:''' ''number''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": 0.0,
"id": "Player.Position.Percentage",
"maximum": 100.0,
"minimum": 0.0,
"type": "number"
}
</syntaxhighlight>}}
==== Player.Position.Time ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' hours]
* [''integer'' milliseconds]
* [''integer'' minutes]
* [''integer'' seconds]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"description": "A position in duration.",
"id": "Player.Position.Time",
"properties": {
"hours": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"milliseconds": {
"default": 0,
"maximum": 999,
"minimum": 0,
"type": "integer"
},
"minutes": {
"default": 0,
"maximum": 59,
"minimum": 0,
"type": "integer"
},
"seconds": {
"default": 0,
"maximum": 59,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "type",
"enums": [
"type",
"partymode",
"speed",
"time",
"percentage",
"totaltime",
"playlistid",
"position",
"repeat",
"shuffled",
"canseek",
"canchangespeed",
"canmove",
"canzoom",
"canrotate",
"canshuffle",
"canrepeat",
"currentaudiostream",
"audiostreams",
"subtitleenabled",
"currentsubtitle",
"subtitles",
"live",
"currentvideostream",
"videostreams",
"cachepercentage"
],
"id": "Player.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== Player.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' audiostreams]
* [''[[#Player.Position.Percentage|Player.Position.Percentage]]'' cachepercentage]
* [''boolean'' canchangespeed]
* [''boolean'' canmove]
* [''boolean'' canrepeat]
* [''boolean'' canrotate]
* [''boolean'' canseek]
* [''boolean'' canshuffle]
* [''boolean'' canzoom]
* [''[[#Player.Audio.Stream|Player.Audio.Stream]]'' currentaudiostream]
* [''[[#Player.Subtitle|Player.Subtitle]]'' currentsubtitle]
* [''[[#Player.Video.Stream|Player.Video.Stream]]'' currentvideostream]
* [''boolean'' live]
* [''boolean'' partymode]
* [''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage]
* [''[[#Playlist.Id|Playlist.Id]]'' playlistid = -1]
* [''[[#Playlist.Position|Playlist.Position]]'' position = -1]
* [''[[#Player.Repeat|Player.Repeat]]'' repeat = off]
* [''boolean'' shuffled]
* [''integer'' speed]
* [''boolean'' subtitleenabled]
* [''array'' subtitles]
* [''[[#Global.Time|Global.Time]]'' time]
* [''[[#Global.Time|Global.Time]]'' totaltime]
* [''[[#Player.Type|Player.Type]]'' type = video]
* [''array'' videostreams]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Property.Value",
"properties": {
"audiostreams": {
"items": {
"$ref": "Player.Audio.Stream"
},
"type": "array"
},
"cachepercentage": {
"$ref": "Player.Position.Percentage",
"default": 0.0
},
"canchangespeed": {
"default": false,
"type": "boolean"
},
"canmove": {
"default": false,
"type": "boolean"
},
"canrepeat": {
"default": false,
"type": "boolean"
},
"canrotate": {
"default": false,
"type": "boolean"
},
"canseek": {
"default": false,
"type": "boolean"
},
"canshuffle": {
"default": false,
"type": "boolean"
},
"canzoom": {
"default": false,
"type": "boolean"
},
"currentaudiostream": {
"$ref": "Player.Audio.Stream"
},
"currentsubtitle": {
"$ref": "Player.Subtitle"
},
"currentvideostream": {
"$ref": "Player.Video.Stream"
},
"live": {
"default": false,
"type": "boolean"
},
"partymode": {
"default": false,
"type": "boolean"
},
"percentage": {
"$ref": "Player.Position.Percentage",
"default": 0.0
},
"playlistid": {
"$ref": "Playlist.Id",
"default": -1
},
"position": {
"$ref": "Playlist.Position",
"default": -1
},
"repeat": {
"$ref": "Player.Repeat",
"default": "off"
},
"shuffled": {
"default": false,
"type": "boolean"
},
"speed": {
"default": 0,
"type": "integer"
},
"subtitleenabled": {
"default": false,
"type": "boolean"
},
"subtitles": {
"items": {
"$ref": "Player.Subtitle"
},
"type": "array"
},
"time": {
"$ref": "Global.Time",
"description": "A duration."
},
"totaltime": {
"$ref": "Global.Time",
"description": "A duration."
},
"type": {
"$ref": "Player.Type",
"default": "video"
},
"videostreams": {
"items": {
"$ref": "Player.Video.Stream"
},
"type": "array"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Repeat ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "off",
"enums": [
"off",
"one",
"all"
],
"id": "Player.Repeat",
"type": "string"
}
</syntaxhighlight>}}
==== Player.Speed ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' speed]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Speed",
"properties": {
"speed": {
"default": 0,
"type": "integer"
}
},
"required": true,
"type": "object"
}
</syntaxhighlight>}}
==== Player.Subtitle ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' index
* ''boolean'' isdefault
* ''boolean'' isforced
* ''boolean'' isimpaired
* ''string'' language
* ''string'' name
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Subtitle",
"properties": {
"index": {
"minimum": 0,
"required": true,
"type": "integer"
},
"isdefault": {
"required": true,
"type": "boolean"
},
"isforced": {
"required": true,
"type": "boolean"
},
"isimpaired": {
"required": true,
"type": "boolean"
},
"language": {
"required": true,
"type": "string"
},
"name": {
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Tempo ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''number'' tempo]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Tempo",
"properties": {
"tempo": {
"default": 0.0,
"type": "number"
}
},
"required": true,
"type": "object"
}
</syntaxhighlight>}}
==== Player.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "video",
"enums": [
"video",
"audio",
"picture"
],
"id": "Player.Type",
"type": "string"
}
</syntaxhighlight>}}
==== Player.Video.Stream ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' codec
* ''integer'' height
* ''integer'' index
* ''string'' language
* ''string'' name
* ''integer'' width
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Video.Stream",
"properties": {
"codec": {
"required": true,
"type": "string"
},
"height": {
"required": true,
"type": "integer"
},
"index": {
"minimum": 0,
"required": true,
"type": "integer"
},
"language": {
"required": true,
"type": "string"
},
"name": {
"required": true,
"type": "string"
},
"width": {
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.ViewMode ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "normal",
"enums": [
"normal",
"zoom",
"stretch4x3",
"widezoom",
"stretch16x9",
"original",
"stretch16x9nonlin",
"zoom120width",
"zoom110width"
],
"id": "Player.ViewMode",
"type": "string"
}
</syntaxhighlight>}}
=== Playlist ===
==== Playlist.Id ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "Playlist.Id",
"maximum": 2,
"minimum": 0,
"type": "integer"
}
</syntaxhighlight>}}
==== Playlist.Item ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Playlist.Item",
"type": [
{
"additionalProperties": false,
"properties": {
"file": {
"description": "Path to a file (not a directory) to be added to the playlist",
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"directory": {
"required": true,
"type": "string"
},
"media": {
"$ref": "Files.Media",
"default": "files"
},
"recursive": {
"default": false,
"type": "boolean"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"movieid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"episodeid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"musicvideoid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Identification of a genre from the AudioLibrary",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"recordingid": {
"$ref": "Library.Id",
"description": "Identification of a PVR recording",
"required": true
}
},
"type": "object"
}
]
}
</syntaxhighlight>}}
==== Playlist.Position ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "Playlist.Position",
"minimum": 0,
"type": "integer"
}
</syntaxhighlight>}}
==== Playlist.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "type",
"enums": [
"type",
"size"
],
"id": "Playlist.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== Playlist.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' size]
* [''[[#Playlist.Type|Playlist.Type]]'' type = unknown]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Playlist.Property.Value",
"properties": {
"size": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"type": {
"$ref": "Playlist.Type",
"default": "unknown"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Playlist.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"video",
"audio",
"picture",
"mixed"
],
"id": "Playlist.Type",
"type": "string"
}
</syntaxhighlight>}}
=== Profiles ===
==== Profiles.Details.Profile ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' lockmode]
* [''string'' thumbnail]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Profiles.Details.Profile",
"properties": {
"lockmode": {
"default": 0,
"type": "integer"
},
"thumbnail": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Profiles.Fields.Profile ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Profiles.Fields.Profile",
"items": {
"enums": [
"thumbnail",
"lockmode"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Profiles.Password ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' encryption = md5]
* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Profiles.Password",
"properties": {
"encryption": {
"default": "md5",
"description": "Password Encryption",
"enums": [
"none",
"md5"
],
"type": "string"
},
"value": {
"description": "Password",
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Setting ===
==== Setting.Details.Base ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' help]
* ''string'' id
* ''string'' label
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Details.Base",
"properties": {
"help": {
"default": "",
"type": "string"
},
"id": {
"minLength": 1,
"required": true,
"type": "string"
},
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Setting.Details.Category ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' groups]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.Base",
"id": "Setting.Details.Category",
"properties": {
"groups": {
"items": {
"$ref": "Setting.Details.Group"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.Control ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Details.Control",
"type": [
{
"$ref": "Setting.Details.ControlCheckmark"
},
{
"$ref": "Setting.Details.ControlSpinner"
},
{
"$ref": "Setting.Details.ControlEdit"
},
{
"$ref": "Setting.Details.ControlButton"
},
{
"$ref": "Setting.Details.ControlList"
},
{
"$ref": "Setting.Details.ControlSlider"
},
{
"$ref": "Setting.Details.ControlRange"
},
{
"$ref": "Setting.Details.ControlLabel"
}
]
}
</syntaxhighlight>}}
==== Setting.Details.ControlBase ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' delayed
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Details.ControlBase",
"properties": {
"delayed": {
"required": true,
"type": "boolean"
},
"format": {
"required": true,
"type": "string"
},
"type": {
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Setting.Details.ControlButton ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlHeading",
"id": "Setting.Details.ControlButton",
"properties": {
"type": {
"enums": [
"button"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlCheckmark ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlCheckmark",
"properties": {
"format": {
"enums": [
"boolean"
],
"required": true,
"type": "string"
},
"type": {
"enums": [
"toggle"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlEdit ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' hidden
* ''string'' type
* ''boolean'' verifynewvalue
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlHeading",
"id": "Setting.Details.ControlEdit",
"properties": {
"hidden": {
"required": true,
"type": "boolean"
},
"type": {
"enums": [
"edit"
],
"required": true,
"type": "string"
},
"verifynewvalue": {
"required": true,
"type": "boolean"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlHeading ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' heading]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlHeading",
"properties": {
"heading": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlLabel ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlLabel",
"properties": {
"format": {
"enums": [
"string"
],
"required": true,
"type": "string"
},
"type": {
"enums": [
"label"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlList ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' multiselect
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlHeading",
"id": "Setting.Details.ControlList",
"properties": {
"multiselect": {
"required": true,
"type": "boolean"
},
"type": {
"enums": [
"list"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlRange ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' formatlabel
* ''string'' formatvalue
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlRange",
"properties": {
"formatlabel": {
"required": true,
"type": "string"
},
"formatvalue": {
"required": true,
"type": "string"
},
"type": {
"enums": [
"range"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlSlider ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' formatlabel
* ''boolean'' popup
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlHeading",
"id": "Setting.Details.ControlSlider",
"properties": {
"formatlabel": {
"required": true,
"type": "string"
},
"popup": {
"required": true,
"type": "boolean"
},
"type": {
"enums": [
"slider"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlSpinner ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' formatlabel]
* [''string'' minimumlabel]
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlSpinner",
"properties": {
"formatlabel": {
"default": "",
"type": "string"
},
"minimumlabel": {
"default": "",
"type": "string"
},
"type": {
"enums": [
"spinner"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.Group ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' id
* [''array'' settings]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Setting.Details.Group",
"properties": {
"id": {
"minLength": 1,
"required": true,
"type": "string"
},
"settings": {
"items": {
"$ref": "Setting.Details.Setting"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Setting.Details.Section ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' categories]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.Base",
"id": "Setting.Details.Section",
"properties": {
"categories": {
"items": {
"$ref": "Setting.Details.Category"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.Setting ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Details.Setting",
"type": [
{
"$ref": "Setting.Details.SettingBool"
},
{
"$ref": "Setting.Details.SettingInt"
},
{
"$ref": "Setting.Details.SettingNumber"
},
{
"$ref": "Setting.Details.SettingString"
},
{
"$ref": "Setting.Details.SettingAction"
},
{
"$ref": "Setting.Details.SettingList"
},
{
"$ref": "Setting.Details.SettingPath"
},
{
"$ref": "Setting.Details.SettingAddon"
},
{
"$ref": "Setting.Details.SettingDate"
},
{
"$ref": "Setting.Details.SettingTime"
}
]
}
</syntaxhighlight>}}
==== Setting.Details.SettingAction ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingAction",
"properties": {
"data": {
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingAddon ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Addon.Types|Addon.Types]]'' addontype
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingString",
"id": "Setting.Details.SettingAddon",
"properties": {
"addontype": {
"$ref": "Addon.Types",
"required": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingBase ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Setting.Details.Control|Setting.Details.Control]]'' control]
* ''boolean'' enabled
* ''[[#Setting.Level|Setting.Level]]'' level
* [''string'' parent]
* ''[[#Setting.Type|Setting.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.Base",
"id": "Setting.Details.SettingBase",
"properties": {
"control": {
"$ref": "Setting.Details.Control"
},
"enabled": {
"required": true,
"type": "boolean"
},
"level": {
"$ref": "Setting.Level",
"required": true
},
"parent": {
"default": "",
"type": "string"
},
"type": {
"$ref": "Setting.Type",
"required": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingBool ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' default
* ''boolean'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingBool",
"properties": {
"default": {
"required": true,
"type": "boolean"
},
"value": {
"required": true,
"type": "boolean"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingDate ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingString",
"id": "Setting.Details.SettingDate"
}
</syntaxhighlight>}}
==== Setting.Details.SettingInt ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' default
* [''integer'' maximum]
* [''integer'' minimum]
* [''array'' options]
* [''integer'' step]
* ''integer'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingInt",
"properties": {
"default": {
"required": true,
"type": "integer"
},
"maximum": {
"default": 0,
"type": "integer"
},
"minimum": {
"default": 0,
"type": "integer"
},
"options": {
"items": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"step": {
"default": 0,
"type": "integer"
},
"value": {
"required": true,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingList ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Setting.Value.List|Setting.Value.List]]'' default
* ''[[#Setting.Details.Setting|Setting.Details.Setting]]'' definition
* ''string'' delimiter
* ''[[#Setting.Type|Setting.Type]]'' elementtype
* [''integer'' maximumitems]
* [''integer'' minimumitems]
* ''[[#Setting.Value.List|Setting.Value.List]]'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingList",
"properties": {
"default": {
"$ref": "Setting.Value.List",
"required": true
},
"definition": {
"$ref": "Setting.Details.Setting",
"required": true
},
"delimiter": {
"required": true,
"type": "string"
},
"elementtype": {
"$ref": "Setting.Type",
"required": true
},
"maximumitems": {
"default": 0,
"type": "integer"
},
"minimumitems": {
"default": 0,
"type": "integer"
},
"value": {
"$ref": "Setting.Value.List",
"required": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingNumber ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''number'' default
* ''number'' maximum
* ''number'' minimum
* ''number'' step
* ''number'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingNumber",
"properties": {
"default": {
"required": true,
"type": "number"
},
"maximum": {
"required": true,
"type": "number"
},
"minimum": {
"required": true,
"type": "number"
},
"step": {
"required": true,
"type": "number"
},
"value": {
"required": true,
"type": "number"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingPath ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' sources]
* ''boolean'' writable
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingString",
"id": "Setting.Details.SettingPath",
"properties": {
"sources": {
"items": {
"type": "string"
},
"type": "array"
},
"writable": {
"required": true,
"type": "boolean"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingString ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' allowempty
* ''string'' default
* [''array'' options]
* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingString",
"properties": {
"allowempty": {
"required": true,
"type": "boolean"
},
"default": {
"required": true,
"type": "string"
},
"options": {
"items": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"value": {
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingTime ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingString",
"id": "Setting.Details.SettingTime"
}
</syntaxhighlight>}}
==== Setting.Level ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "basic",
"enums": [
"basic",
"standard",
"advanced",
"expert"
],
"id": "Setting.Level",
"type": "string"
}
</syntaxhighlight>}}
==== Setting.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "boolean",
"enums": [
"boolean",
"integer",
"number",
"string",
"action",
"list",
"path",
"addon",
"date",
"time"
],
"id": "Setting.Type",
"type": "string"
}
</syntaxhighlight>}}
==== Setting.Value ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Setting.Value",
"type": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
}
</syntaxhighlight>}}
==== Setting.Value.Extended ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Setting.Value.Extended",
"type": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"$ref": "Setting.Value.List"
}
]
}
</syntaxhighlight>}}
==== Setting.Value.List ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Value.List",
"items": {
"$ref": "Setting.Value"
},
"type": "array"
}
</syntaxhighlight>}}
=== System ===
==== System.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "canshutdown",
"enums": [
"canshutdown",
"cansuspend",
"canhibernate",
"canreboot"
],
"id": "System.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== System.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''boolean'' canhibernate]
* [''boolean'' canreboot]
* [''boolean'' canshutdown]
* [''boolean'' cansuspend]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "System.Property.Value",
"properties": {
"canhibernate": {
"default": false,
"type": "boolean"
},
"canreboot": {
"default": false,
"type": "boolean"
},
"canshutdown": {
"default": false,
"type": "boolean"
},
"cansuspend": {
"default": false,
"type": "boolean"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Textures ===
==== Textures.Details.Size ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' height]
* [''string'' lastused]
* [''integer'' size]
* [''integer'' usecount]
* [''integer'' width]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Textures.Details.Size",
"properties": {
"height": {
"default": 0,
"description": "Height of texture",
"type": "integer"
},
"lastused": {
"default": "",
"description": "Date of last use",
"type": "string"
},
"size": {
"default": 0,
"description": "Size of the texture (1 == largest)",
"type": "integer"
},
"usecount": {
"default": 0,
"description": "Number of uses",
"type": "integer"
},
"width": {
"default": 0,
"description": "Width of texture",
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Textures.Details.Texture ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' cachedurl]
* [''string'' imagehash]
* [''string'' lasthashcheck]
* [''array'' sizes]
* [''[[#Library.Id|Library.Id]]'' textureid = -1]
* [''string'' url]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Textures.Details.Texture",
"properties": {
"cachedurl": {
"default": "",
"description": "Cached URL on disk",
"type": "string"
},
"imagehash": {
"default": "",
"description": "Hash of image",
"type": "string"
},
"lasthashcheck": {
"default": "",
"description": "Last time source was checked for changes",
"type": "string"
},
"sizes": {
"items": {
"$ref": "Textures.Details.Size"
},
"type": "array"
},
"textureid": {
"$ref": "Library.Id",
"default": -1
},
"url": {
"default": "",
"description": "Original source URL",
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Textures.Fields.Texture ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Textures.Fields.Texture",
"items": {
"enums": [
"url",
"cachedurl",
"lasthashcheck",
"imagehash",
"sizes"
],
"type": "string"
}
}
</syntaxhighlight>}}
=== Video ===
==== Video.Cast ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Video.Cast",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"required": true,
"type": "string"
},
"order": {
"required": true,
"type": "integer"
},
"role": {
"required": true,
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
</syntaxhighlight>}}
==== Video.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Media.Artwork|Media.Artwork]]'' art]
* [''integer'' playcount]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Media.Details.Base",
"id": "Video.Details.Base",
"properties": {
"art": {
"$ref": "Media.Artwork"
},
"playcount": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Episode ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Video.Cast|Video.Cast]]'' cast]
* [''integer'' episode]
* ''[[#Library.Id|Library.Id]]'' episodeid
* [''string'' firstaired]
* [''[[#Array.String|Array.String]]'' genre]
* [''string'' originaltitle]
* [''string'' productioncode]
* [''number'' rating]
* [''any'' ratings]
* [''integer'' season]
* [''[[#Library.Id|Library.Id]]'' seasonid = -1]
* [''string'' showtitle]
* [''integer'' specialsortepisode]
* [''integer'' specialsortseason]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Library.Id|Library.Id]]'' tvshowid = -1]
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''integer'' userrating]
* [''string'' votes]
* [''[[#Array.String|Array.String]]'' writer]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.File",
"id": "Video.Details.Episode",
"properties": {
"cast": {
"$ref": "Video.Cast"
},
"episode": {
"default": 0,
"type": "integer"
},
"episodeid": {
"$ref": "Library.Id",
"required": true
},
"firstaired": {
"default": "",
"type": "string"
},
"genre": {
"$ref": "Array.String"
},
"originaltitle": {
"default": "",
"type": "string"
},
"productioncode": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"ratings": {
"default": null,
"type": "any"
},
"season": {
"default": 0,
"type": "integer"
},
"seasonid": {
"$ref": "Library.Id",
"default": -1
},
"showtitle": {
"default": "",
"type": "string"
},
"specialsortepisode": {
"default": 0,
"type": "integer"
},
"specialsortseason": {
"default": 0,
"type": "integer"
},
"studio": {
"$ref": "Array.String"
},
"tvshowid": {
"$ref": "Library.Id",
"default": -1
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"userrating": {
"default": 0,
"type": "integer"
},
"votes": {
"default": "",
"type": "string"
},
"writer": {
"$ref": "Array.String"
}
}
}
</syntaxhighlight>}}
==== Video.Details.File ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Array.String|Array.String]]'' director]
* [''[[#Video.Resume|Video.Resume]]'' resume]
* [''integer'' runtime]
* [''[[#Video.Streams|Video.Streams]]'' streamdetails]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Item",
"id": "Video.Details.File",
"properties": {
"director": {
"$ref": "Array.String"
},
"resume": {
"$ref": "Video.Resume"
},
"runtime": {
"default": 0,
"description": "Runtime in seconds",
"type": "integer"
},
"streamdetails": {
"$ref": "Video.Streams"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Item ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' dateadded]
* [''string'' file]
* [''string'' lastplayed]
* [''string'' plot]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Media",
"id": "Video.Details.Item",
"properties": {
"dateadded": {
"default": "",
"type": "string"
},
"file": {
"default": "",
"type": "string"
},
"lastplayed": {
"default": "",
"type": "string"
},
"plot": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Media ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Base",
"id": "Video.Details.Media",
"properties": {
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Movie ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Video.Cast|Video.Cast]]'' cast]
* [''[[#Array.String|Array.String]]'' country]
* [''[[#Array.String|Array.String]]'' genre]
* [''string'' imdbnumber]
* ''[[#Library.Id|Library.Id]]'' movieid
* [''string'' mpaa]
* [''string'' originaltitle]
* [''string'' plotoutline]
* [''string'' premiered]
* [''number'' rating]
* [''any'' ratings]
* [''string'' set]
* [''[[#Library.Id|Library.Id]]'' setid = -1]
* [''[[#Array.String|Array.String]]'' showlink]
* [''string'' sorttitle]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Array.String|Array.String]]'' tag]
* [''string'' tagline]
* [''integer'' top250]
* [''string'' trailer]
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''integer'' userrating]
* [''string'' votes]
* [''[[#Array.String|Array.String]]'' writer]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.File",
"id": "Video.Details.Movie",
"properties": {
"cast": {
"$ref": "Video.Cast"
},
"country": {
"$ref": "Array.String"
},
"genre": {
"$ref": "Array.String"
},
"imdbnumber": {
"default": "",
"type": "string"
},
"movieid": {
"$ref": "Library.Id",
"required": true
},
"mpaa": {
"default": "",
"type": "string"
},
"originaltitle": {
"default": "",
"type": "string"
},
"plotoutline": {
"default": "",
"type": "string"
},
"premiered": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"ratings": {
"default": null,
"type": "any"
},
"set": {
"default": "",
"type": "string"
},
"setid": {
"$ref": "Library.Id",
"default": -1
},
"showlink": {
"$ref": "Array.String"
},
"sorttitle": {
"default": "",
"type": "string"
},
"studio": {
"$ref": "Array.String"
},
"tag": {
"$ref": "Array.String"
},
"tagline": {
"default": "",
"type": "string"
},
"top250": {
"default": 0,
"type": "integer"
},
"trailer": {
"default": "",
"type": "string"
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"userrating": {
"default": 0,
"type": "integer"
},
"votes": {
"default": "",
"type": "string"
},
"writer": {
"$ref": "Array.String"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Details.MovieSet ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' plot]
* ''[[#Library.Id|Library.Id]]'' setid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Media",
"id": "Video.Details.MovieSet",
"properties": {
"plot": {
"default": "",
"type": "string"
},
"setid": {
"$ref": "Library.Id",
"required": true
}
}
}
</syntaxhighlight>}}
==== Video.Details.MovieSet.Extended ====
'''Extends:'''
* ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [''array'' movies]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.MovieSet",
"id": "Video.Details.MovieSet.Extended",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
}
}
</syntaxhighlight>}}
==== Video.Details.MusicVideo ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' album]
* [''[[#Array.String|Array.String]]'' artist]
* [''[[#Array.String|Array.String]]'' genre]
* ''[[#Library.Id|Library.Id]]'' musicvideoid
* [''string'' premiered]
* [''number'' rating]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Array.String|Array.String]]'' tag]
* [''integer'' track]
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''integer'' userrating]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.File",
"id": "Video.Details.MusicVideo",
"properties": {
"album": {
"default": "",
"type": "string"
},
"artist": {
"$ref": "Array.String"
},
"genre": {
"$ref": "Array.String"
},
"musicvideoid": {
"$ref": "Library.Id",
"required": true
},
"premiered": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"studio": {
"$ref": "Array.String"
},
"tag": {
"$ref": "Array.String"
},
"track": {
"default": 0,
"type": "integer"
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"userrating": {
"default": 0,
"type": "integer"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Season ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' episode]
* ''integer'' season
* ''[[#Library.Id|Library.Id]]'' seasonid
* [''string'' showtitle]
* [''string'' title]
* [''[[#Library.Id|Library.Id]]'' tvshowid = -1]
* [''integer'' userrating]
* [''integer'' watchedepisodes]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Base",
"id": "Video.Details.Season",
"properties": {
"episode": {
"default": 0,
"type": "integer"
},
"season": {
"required": true,
"type": "integer"
},
"seasonid": {
"$ref": "Library.Id",
"required": true
},
"showtitle": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
},
"tvshowid": {
"$ref": "Library.Id",
"default": -1
},
"userrating": {
"default": 0,
"type": "integer"
},
"watchedepisodes": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Details.TVShow ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Video.Cast|Video.Cast]]'' cast]
* [''integer'' episode]
* [''string'' episodeguide]
* [''[[#Array.String|Array.String]]'' genre]
* [''string'' imdbnumber]
* [''string'' mpaa]
* [''string'' originaltitle]
* [''string'' premiered]
* [''number'' rating]
* [''any'' ratings]
* [''integer'' runtime]
* [''integer'' season]
* [''string'' sorttitle]
* [''string'' status]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Array.String|Array.String]]'' tag]
* ''[[#Library.Id|Library.Id]]'' tvshowid
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''integer'' userrating]
* [''string'' votes]
* [''integer'' watchedepisodes]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Item",
"id": "Video.Details.TVShow",
"properties": {
"cast": {
"$ref": "Video.Cast"
},
"episode": {
"default": 0,
"type": "integer"
},
"episodeguide": {
"default": "",
"type": "string"
},
"genre": {
"$ref": "Array.String"
},
"imdbnumber": {
"default": "",
"type": "string"
},
"mpaa": {
"default": "",
"type": "string"
},
"originaltitle": {
"default": "",
"type": "string"
},
"premiered": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"ratings": {
"default": null,
"type": "any"
},
"runtime": {
"default": 0,
"description": "Runtime in seconds",
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"sorttitle": {
"default": "",
"type": "string"
},
"status": {
"default": "",
"description": "Returns 'returning series', 'in production', 'planned', 'cancelled' or 'ended'",
"type": "string"
},
"studio": {
"$ref": "Array.String"
},
"tag": {
"$ref": "Array.String"
},
"tvshowid": {
"$ref": "Library.Id",
"required": true
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"userrating": {
"default": 0,
"type": "integer"
},
"votes": {
"default": "",
"type": "string"
},
"watchedepisodes": {
"default": 0,
"type": "integer"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</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="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.Episode",
"items": {
"description": "Requesting the cast, ratings, streamdetails, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"plot",
"votes",
"rating",
"writer",
"firstaired",
"playcount",
"runtime",
"director",
"productioncode",
"season",
"episode",
"originaltitle",
"showtitle",
"cast",
"streamdetails",
"lastplayed",
"fanart",
"thumbnail",
"file",
"resume",
"tvshowid",
"dateadded",
"uniqueid",
"art",
"specialsortseason",
"specialsortepisode",
"userrating",
"seasonid",
"ratings",
"genre",
"studio"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.Movie ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.Movie",
"items": {
"description": "Requesting the cast, ratings, showlink, streamdetails, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"genre",
"year",
"rating",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"playcount",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"fanart",
"thumbnail",
"file",
"sorttitle",
"resume",
"setid",
"dateadded",
"tag",
"art",
"userrating",
"ratings",
"premiered",
"uniqueid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.MovieSet ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.MovieSet",
"items": {
"enums": [
"title",
"playcount",
"fanart",
"thumbnail",
"art",
"plot"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.MusicVideo ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.MusicVideo",
"items": {
"description": "Requesting the streamdetails, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"playcount",
"runtime",
"director",
"studio",
"year",
"plot",
"album",
"artist",
"genre",
"track",
"streamdetails",
"lastplayed",
"fanart",
"thumbnail",
"file",
"resume",
"dateadded",
"tag",
"art",
"rating",
"userrating",
"premiered",
"uniqueid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.Season ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.Season",
"items": {
"enums": [
"season",
"showtitle",
"playcount",
"episode",
"fanart",
"thumbnail",
"tvshowid",
"watchedepisodes",
"art",
"userrating",
"title"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.TVShow ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.TVShow",
"items": {
"description": "Requesting the cast, ratings, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"genre",
"year",
"rating",
"plot",
"studio",
"mpaa",
"cast",
"playcount",
"episode",
"imdbnumber",
"premiered",
"votes",
"lastplayed",
"fanart",
"thumbnail",
"file",
"originaltitle",
"sorttitle",
"episodeguide",
"season",
"watchedepisodes",
"dateadded",
"tag",
"art",
"userrating",
"ratings",
"runtime",
"uniqueid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Rating ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''boolean'' default]
* ''number'' rating
* [''integer'' votes]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Video.Rating",
"properties": {
"default": {
"default": false,
"type": "boolean"
},
"rating": {
"required": true,
"type": "number"
},
"votes": {
"default": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Video.Ratings ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"$ref": "Video.Rating"
},
"id": "Video.Ratings",
"type": "object"
}
</syntaxhighlight>}}
==== Video.Ratings.Set ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"default": null,
"type": [
{
"type": "null"
},
{
"$ref": "Video.Rating"
}
]
},
"id": "Video.Ratings.Set",
"type": "object"
}
</syntaxhighlight>}}
==== Video.Resume ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''number'' position]
* [''number'' total]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Video.Resume",
"properties": {
"position": {
"default": 0.0,
"minimum": 0.0,
"type": "number"
},
"total": {
"default": 0.0,
"minimum": 0.0,
"type": "number"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Video.Streams ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' audio]
* [''array'' subtitle]
* [''array'' video]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Video.Streams",
"properties": {
"audio": {
"items": {
"additionalProperties": false,
"properties": {
"channels": {
"default": 0,
"type": "integer"
},
"codec": {
"default": "",
"type": "string"
},
"language": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"subtitle": {
"items": {
"additionalProperties": false,
"properties": {
"language": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"video": {
"items": {
"additionalProperties": false,
"properties": {
"aspect": {
"default": 0.0,
"type": "number"
},
"codec": {
"default": "",
"type": "string"
},
"duration": {
"default": 0,
"type": "integer"
},
"hdrtype": {
"default": "",
"type": "string"
},
"height": {
"default": 0,
"type": "integer"
},
"width": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"minItems": 1,
"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:
#* ''boolean'' muted
#* ''integer'' volume
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The volume of the application has changed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"muted": {
"required": true,
"type": "boolean"
},
"volume": {
"maximum": 100,
"minimum": 0,
"required": true,
"type": "integer"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The audio library has been cleaned.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio library clean operation has started.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== AudioLibrary.OnExport ====
An audio library export has 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
# [''object'' data]:
#* [''integer'' failcount = 0]
#* [''string'' file = ""]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio library export has finished.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"failcount": {
"default": 0,
"minimum": 0,
"required": false,
"type": "integer"
},
"file": {
"default": "",
"required": false,
"type": "string"
}
},
"required": false,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#Library.Id|Library.Id]]'' id
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction
#* ''[[#Notifications.Library.Audio.Type|Notifications.Library.Audio.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio item has been removed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"transaction": {
"$ref": "Optional.Boolean",
"description": "True if the removal is being performed within a transaction."
},
"type": {
"$ref": "Notifications.Library.Audio.Type",
"required": true
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Scanning the audio library has been finished.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio library scan has started.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#Optional.Boolean|Optional.Boolean]]'' added
#* ''[[#Library.Id|Library.Id]]'' id
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction
#* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio item has been updated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"added": {
"$ref": "Optional.Boolean",
"description": "True if the update is for a newly added item."
},
"id": {
"$ref": "Library.Id",
"required": true
},
"transaction": {
"$ref": "Optional.Boolean",
"description": "True if the update is being performed within a transaction."
},
"type": {
"enum": [
"song"
],
"id": "Notifications.Library.Audio.Type",
"required": true,
"type": "string"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== GUI ===
==== GUI.OnDPMSActivated ====
Energy saving/DPMS has been activated.<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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Energy saving/DPMS has been activated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== GUI.OnDPMSDeactivated ====
Energy saving/DPMS has been deactivated.<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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Energy saving/DPMS has been deactivated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== GUI.OnScreensaverActivated ====
The screensaver has been activated.<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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The screensaver has been activated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== GUI.OnScreensaverDeactivated ====
The screensaver has been deactivated.<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:
#* ''boolean'' shuttingdown
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The screensaver has been deactivated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"shuttingdown": {
"required": true,
"type": "boolean"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The user has provided the requested input.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''string'' title
#* ''string'' type
#* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The user is requested to provide some information.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"title": {
"type": "string"
},
"type": {
"enum": [
"keyboard",
"time",
"date",
"ip",
"password",
"numericpassword",
"number",
"seconds"
],
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== Player ===
==== Player.OnAVChange ====
Audio- or videostream 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="json">
{
"description": "Audio- or videostream has changed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnAVStart ====
Playback of a media item has been started and first frame is available. If there is no ID available extra information will be provided.<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="json">
{
"description": "Playback of a media item has been started and first frame is available. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== 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="json">
{
"description": "Playback of a media item has been paused. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</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="json">
{
"description": "Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
#* ''[[#Player.Property.Value|Player.Property.Value]]'' property
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A property of the playing items has changed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"player": {
"$ref": "Player.Notifications.Player",
"required": true
},
"property": {
"$ref": "Player.Property.Value"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnResume ====
Playback of a media item has been resumed. 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="json">
{
"description": "Playback of a media item has been resumed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#Notifications.Item|Notifications.Item]]'' item
#* ''[[#Player.Notifications.Player.Seek|Player.Notifications.Player.Seek]]'' player
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The playback position has been changed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"item": {
"$ref": "Notifications.Item"
},
"player": {
"$ref": "Player.Notifications.Player.Seek",
"required": true
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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="json">
{
"description": "Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''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="json">
{
"description": "Playback of a media item has been stopped. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"end": {
"description": "Whether the player has reached the end of the playable item(s) or not",
"required": true,
"type": "boolean"
},
"item": {
"$ref": "Notifications.Item"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#Notifications.Item|Notifications.Item]]'' item
#* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
#* ''[[#Playlist.Position|Playlist.Position]]'' position
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A playlist item has been added.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"item": {
"$ref": "Notifications.Item"
},
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"position": {
"$ref": "Playlist.Position"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#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="json">
{
"description": "A playlist item has been cleared.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
#* ''[[#Playlist.Position|Playlist.Position]]'' position
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A playlist item has been removed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"position": {
"$ref": "Playlist.Position"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The system is on low battery.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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
# ''object'' data:
#* ''integer'' exitcode
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Kodi will be closed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"exitcode": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The system will be restarted.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The system will be suspended.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The system woke up from suspension.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The video library has been cleaned.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video library clean operation has started.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnExport ====
A video library export has 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
# [''object'' data]:
#* [''integer'' failcount = 0]
#* [''string'' file = ""]
#* [''string'' root = ""]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video library export has finished.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"failcount": {
"default": 0,
"minimum": 0,
"required": false,
"type": "integer"
},
"file": {
"default": "",
"required": false,
"type": "string"
},
"root": {
"default": "",
"required": false,
"type": "string"
}
},
"required": false,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnRefresh ====
The video library has been refreshed and a home screen reload might be necessary.<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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The video library has been refreshed and a home screen reload might be necessary.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#Library.Id|Library.Id]]'' id
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction
#* ''[[#Notifications.Library.Video.Type|Notifications.Library.Video.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video item has been removed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"transaction": {
"$ref": "Optional.Boolean",
"description": "True if the removal is being performed within a transaction."
},
"type": {
"$ref": "Notifications.Library.Video.Type",
"required": true
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Scanning the video library has been finished.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video library scan has started.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</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:
#* ''[[#Optional.Boolean|Optional.Boolean]]'' added
#* ''[[#Library.Id|Library.Id]]'' id
#* ''integer'' playcount = -1
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction
#* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video item has been updated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"added": {
"$ref": "Optional.Boolean",
"description": "True if the update is for a newly added item."
},
"id": {
"$ref": "Library.Id",
"required": true
},
"playcount": {
"default": -1,
"minimum": 0,
"type": "integer"
},
"transaction": {
"$ref": "Optional.Boolean",
"description": "True if the update is being performed within a transaction."
},
"type": {
"enum": [
"movie",
"tvshow",
"episode",
"musicvideo"
],
"id": "Notifications.Library.Video.Type",
"required": true,
"type": "string"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}

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

{{updated|21}}
[[Category:JSON-RPC]]

Template:JSON-RPC API nav

2026-05-07T19:20:14Z

Ronie:

{|class="{{{1|infobox}}}" style="margin: 0.5em 0 0.5em 1em; {{border-radius|5px}}; {{box-shadow|0px|1px|3px|#878787}}; float: right; clear: right;" width="256"
! '''JSON-RPC Pages'''
|-
| [[JSON-RPC_API|Main JSON-RPC Page]]
|-
| [[JSON-RPC_API/v8|- v8 (Krypton)]]
|-
| [[JSON-RPC_API/v10|- v10 (Leia)]]
|-
| [[JSON-RPC_API/v12|- v12 (Matrix)]]
|-
| [[JSON-RPC_API/v13|- v13 (Nexus)]]
|-
| [[JSON-RPC_API/v13.5|- v13.5 (Omega)]]
|-
| [[JSON-RPC_API/v13.11|- v13.11 (Piers)]]
|-
| [[JSON-RPC_API/Examples|Examples]]
|-
| [[:Category:JSON-RPC|All JSON-RPC Pages]]
|}

Template:JSON-RPC API nav

2026-05-07T19:20:00Z

Ronie:

{|class="{{{1|infobox}}}" style="margin: 0.5em 0 0.5em 1em; {{border-radius|5px}}; {{box-shadow|0px|1px|3px|#878787}}; float: right; clear: right;" width="256"
! '''JSON-RPC Pages'''
|-
| [[JSON-RPC_API|Main JSON-RPC Page]]
|-
| [[JSON-RPC_API/v8|- v8 (Krypton)]]
|-
| [[JSON-RPC_API/v10|- v10 (Leia)]]
|-
| [[JSON-RPC_API/v12|- v12 (Matrix)]]
|-
| [[JSON-RPC_API/v13|- v13 (Nexus)]]
|-
| [[JSON-RPC_API/v13.5|- v13.5 (Omega)]]
|-
| [[JSON-RPC_API/v13.5|- v13.11 (Piers)]]
|-
| [[JSON-RPC_API/Examples|Examples]]
|-
| [[:Category:JSON-RPC|All JSON-RPC Pages]]
|}

JSON-RPC API/v13.11

2026-05-07T19:19:23Z

Ronie: Created page with "{{JSON-RPC_API_nav}} {{mininav|Development|JSON-RPC API}} Version 13 is the current development version of Kodi's JSON-RPC API and will be published with the release of v22 (Piers).<br /> This document has been updated to version 13.11.0. Recent changes are announced on the [https://forum.kodi.tv/forumdisplay.php?fid=174 forum] It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using..."