JSON-RPC API/v12: Difference between revisions
(Created page with "{{mininav|Development|JSON-RPC API}} Version 12 is the current development version of Kodi's JSON-RPC API and will be published with the release of v19 (Matrix).<br />...") |
No edit summary |
||
(19 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{JSON-RPC_API_nav}} | |||
{{mininav|[[Development]]|[[JSON-RPC API]]}} | {{mininav|[[Development]]|[[JSON-RPC API]]}} | ||
Version 12 is the | Version 12 is the stable version of Kodi's JSON-RPC API and is published with the release of v19 (Matrix). | ||
This document has been updated to version | This document has been updated to version 12.3.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. | 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. | ||
Line 151: | Line 152: | ||
{| | {| | ||
| | | | ||
<syntaxhighlight lang=json enclose="div"> | <syntaxhighlight lang="json" enclose="div"> | ||
{ | { | ||
"type": "object", | "type": "object", | ||
Line 177: | Line 178: | ||
== Namespaces == | == Namespaces == | ||
The Kodi JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are: | 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 | |||
Addons | !style="padding-left: 10px; padding-right: 10px;"|Description | ||
Application | |- | ||
AudioLibrary | |Addons | ||
Favourites | |List, enable and execute addons. | ||
Files | |- | ||
GUI | |Application | ||
Input | |Application information and control. | ||
JSONRPC | |- | ||
Player | |AudioLibrary | ||
Playlist | |Audio Library information. | ||
Profiles | |- | ||
|Favourites | |||
Settings | |Favourites GetFavourites and AddFavourite. | ||
System | |- | ||
Textures | |Files | ||
VideoLibrary | |Shares information & filesystem listings. | ||
XBMC | |- | ||
|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 == | == Methods == | ||
=== Addons === | === Addons === | ||
Line 209: | Line 243: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# ''string'' addonid<br /> | # ''string'' addonid<br /> | ||
# [''mixed: object|array|string'' params = ]<br /> | # [''mixed: object|array|string'' params = ""]<br /> | ||
# [''boolean'' wait = False]<br /> | # [''boolean'' wait = False]<br /> | ||
</div> | </div> | ||
Line 216: | Line 250: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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)", | "description": "Executes the given addon with the given parameters (if possible)", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "addonid", | "name": "addonid", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"default": "", | |||
"name": "params", | "name": "params", | ||
"type": [ | "type": [ | ||
{ | { | ||
"additionalProperties": { | "additionalProperties": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"items": { | "items": { | ||
"type": "string" | "type": "string" | ||
} | }, | ||
"type": "array" | |||
}, | }, | ||
{ | { | ||
"description": "URL path (must start with / or ?", | |||
"description": "URL path (must start with / or ?" | "type": "string" | ||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": false, | |||
"name": "wait", | "name": "wait", | ||
"type": "boolean" | "type": "boolean" | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ExecuteAddon", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 272: | Line 308: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# ''[[#Addon.Details|Addon.Details]]'' addon<br /> | |||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Gets the details of a specific addon", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "addonid", | "name": "addonid", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Addon.Fields", | ||
" | "name": "properties" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"addon": { | |||
"$ref": "Addon.Details", | |||
"required": true | |||
}, | |||
"limits": { | "limits": { | ||
"$ref": "List.LimitsReturned", | "$ref": "List.LimitsReturned", | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 313: | Line 348: | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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]<br /> | # [''[[#Addon.Types|Addon.Types]]'' type = unknown]<br /> | ||
# [''[[#Addon.Content|Addon.Content]]'' content] (Content provided by the addon. Only considered for plugins and scripts.)<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 /> | # [''mixed: boolean|string'' enabled = all]<br /> | ||
# [''[[#Addon.Fields|Addon.Fields]]'' properties]<br /> | # [''[[#Addon.Fields|Addon.Fields]]'' properties]<br /> | ||
Line 324: | Line 359: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''array[ [[#Addon.Details|Addon.Details]] ]'' addons]<br /> | |||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Gets all available addons", | ||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Addon.Types", | ||
" | "default": "unknown", | ||
"name": "type" | |||
}, | }, | ||
{ | { | ||
"$ref": "Addon.Content", | "$ref": "Addon.Content", | ||
"description": "Content provided by the addon. Only considered for plugins and scripts." | "default": "unknown", | ||
"description": "Content provided by the addon. Only considered for plugins and scripts.", | |||
"name": "content" | |||
}, | }, | ||
{ | { | ||
"default": "all", | |||
"name": "enabled", | "name": "enabled", | ||
"type": [ | "type": [ | ||
Line 350: | Line 385: | ||
}, | }, | ||
{ | { | ||
" | "enums": [ | ||
"all" | "all" | ||
] | ], | ||
"type": "string" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Addon.Fields", | ||
" | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
}, | }, | ||
{ | { | ||
"default": true, | |||
"name": "installed", | "name": "installed", | ||
"type": [ | "type": [ | ||
Line 373: | Line 408: | ||
}, | }, | ||
{ | { | ||
" | "enums": [ | ||
"all" | "all" | ||
] | ], | ||
"type": "string" | |||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"addons": { | |||
"items": { | |||
"$ref": "Addon.Details" | |||
}, | |||
"type": "array" | |||
}, | |||
"limits": { | "limits": { | ||
"$ref": "List.LimitsReturned", | "$ref": "List.LimitsReturned", | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 412: | Line 448: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Enables/Disables a specific addon", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "addonid", | "name": "addonid", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Global.Toggle", | |||
"name": "enabled", | "name": "enabled", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ManageAddon", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 440: | Line 477: | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# ''array'' properties<br /> | # ''array[ [[#Application.Property.Name|Application.Property.Name]] ]'' properties<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 446: | Line 483: | ||
'''Type:''' ''[[#Application.Property.Value|Application.Property.Value]]''<br /> | '''Type:''' ''[[#Application.Property.Value|Application.Property.Value]]''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the values of the given properties", | ||
"params": [ | "params": [ | ||
{ | { | ||
"items": { | |||
"$ref": "Application.Property.Name" | |||
}, | |||
"name": "properties", | "name": "properties", | ||
"required": true, | |||
"type": "array", | "type": "array", | ||
"uniqueItems": true | "uniqueItems": true | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"$ref": "Application.Property.Value", | "$ref": "Application.Property.Value" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 477: | Line 512: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | ||
{ | { | ||
"description": "Quit application", | "description": "Quit application", | ||
" | "params": [], | ||
"permission": "ControlPower", | "permission": "ControlPower", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 499: | Line 535: | ||
'''Type:''' ''boolean (Mute state)''<br /> | '''Type:''' ''boolean (Mute state)''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Toggle mute/unmute", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Global.Toggle", | |||
"name": "mute", | "name": "mute", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"permission": "ControlPlayback", | |||
"returns": { | "returns": { | ||
" | "description": "Mute state", | ||
" | "type": "boolean" | ||
} | }, | ||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 530: | Line 565: | ||
'''Type:''' ''integer''<br /> | '''Type:''' ''integer''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Set the current volume", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "volume", | "name": "volume", | ||
"required": true, | |||
"type": [ | "type": [ | ||
{ | { | ||
" | "maximum": 100, | ||
"minimum": 0, | "minimum": 0, | ||
" | "type": "integer" | ||
}, | }, | ||
{ | { | ||
"$ref": "Global.IncrementDecrement" | "$ref": "Global.IncrementDecrement" | ||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"returns": "integer" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "integer" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 570: | Line 604: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Cleans the audio library from non-existent items", | ||
"params": [ | "params": [ | ||
{ | { | ||
"default": true, | |||
"description": "Whether or not to show the progress bar or any other GUI dialog", | |||
"name": "showdialogs", | "name": "showdialogs", | ||
"type": "boolean | "type": "boolean" | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "RemoveData", | ||
} | "returns": { | ||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | |||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== AudioLibrary.Export ==== | ==== AudioLibrary.Export ==== | ||
Line 599: | Line 634: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Exports all items from the audio library", | ||
"params": [ | "params": [ | ||
{ | { | ||
Line 610: | Line 642: | ||
"type": [ | "type": [ | ||
{ | { | ||
"additionalProperties": false, | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"path": { | "path": { | ||
" | "description": "Path to the directory to where the data should be exported", | ||
"minLength": 1, | |||
"required": true, | "required": true, | ||
" | "type": "string" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"additionalProperties": false, | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
" | "images": { | ||
"default": false, | "default": false, | ||
"description": "Whether to | "description": "Whether to export thumbnails and fanart images", | ||
"type": "boolean" | |||
}, | }, | ||
" | "overwrite": { | ||
"default": false, | "default": false, | ||
"description": "Whether to | "description": "Whether to overwrite existing exported files", | ||
"type": "boolean" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "WriteFile", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 660: | Line 694: | ||
# [''[[#Audio.Details.Album|Audio.Details.Album]]'' albumdetails]<br /> | # [''[[#Audio.Details.Album|Audio.Details.Album]]'' albumdetails]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieve details about a specific album", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"name": "albumid", | "name": "albumid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Audio.Fields.Album", | ||
" | "name": "properties" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"albumdetails": { | "albumdetails": { | ||
"$ref": "Audio.Details.Album" | "$ref": "Audio.Details.Album" | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 704: | Line 737: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''array[ [[#Audio.Details.Album|Audio.Details.Album]] ]'' albums]<br /> | |||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieve all albums from specified artist (and role) or that has songs of the specified genre", | ||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Audio.Fields.Album", | ||
" | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
}, | }, | ||
{ | { | ||
Line 730: | Line 760: | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"genreid": { | "genreid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"description": "Song genre. Filter for existence of songs with this genre", | |||
"description": "Song genre. Filter for existence of songs with this genre" | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"genre": { | "genre": { | ||
" | "description": "Song genre. Filter for existence of songs with this genre", | ||
"minLength": 1, | "minLength": 1, | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"artistid": { | "artistid": { | ||
Line 760: | Line 790: | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"artistid": { | "artistid": { | ||
Line 774: | Line 804: | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"artistid": { | "artistid": { | ||
Line 784: | Line 814: | ||
}, | }, | ||
"role": { | "role": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"artist": { | "artist": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"artist": { | "artist": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
}, | }, | ||
"roleid": { | "roleid": { | ||
Line 815: | Line 845: | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"artist": { | "artist": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
}, | }, | ||
"role": { | "role": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
Line 839: | Line 869: | ||
}, | }, | ||
{ | { | ||
"default": false, | |||
"name": "includesingles", | "name": "includesingles", | ||
"type": "boolean" | "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", | "name": "allroles", | ||
"type": "boolean | "type": "boolean" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"albums": { | |||
"items": { | |||
"$ref": "Audio.Details.Album" | |||
}, | |||
"type": "array" | |||
}, | |||
"limits": { | "limits": { | ||
"$ref": "List.LimitsReturned", | "$ref": "List.LimitsReturned", | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 882: | Line 914: | ||
# [''[[#Audio.Details.Artist|Audio.Details.Artist]]'' artistdetails]<br /> | # [''[[#Audio.Details.Artist|Audio.Details.Artist]]'' artistdetails]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieve details about a specific artist", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"name": "artistid", | "name": "artistid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Audio.Fields.Artist", | ||
" | "name": "properties" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"artistdetails": { | "artistdetails": { | ||
"$ref": "Audio.Details.Artist" | "$ref": "Audio.Details.Artist" | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== AudioLibrary.GetArtists ==== | ==== AudioLibrary.GetArtists ==== | ||
Retrieve all artists. For backward compatibility by default this | 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:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# [''[[#Optional.Boolean|Optional.Boolean]]'' albumartistsonly] (Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used)<br /> | # [''[[#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 /> | # [''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties]<br /> | ||
# [''[[#List.Limits|List.Limits]]'' limits]<br /> | # [''[[#List.Limits|List.Limits]]'' limits]<br /> | ||
Line 926: | Line 957: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''array[ [[#Audio.Details.Artist|Audio.Details.Artist]] ]'' artists]<br /> | |||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve all artists. For backward compatibility by default this | |||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Optional.Boolean", | "$ref": "Optional.Boolean", | ||
"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" | "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" | ||
}, | }, | ||
{ | { | ||
Line 957: | Line 986: | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"genreid": { | "genreid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"description": "Deprecated, use songgenreid. Filter for existence of songs with this genre", | |||
"description": "Deprecated, use songgenreid. Filter for existence of songs with this genre" | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"songgenreid": { | "songgenreid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"description": "Song genreid. Filter for existence of songs with this genre", | |||
"description": "Song genreid. Filter for existence of songs with this genre" | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
" | "roleid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
}, | }, | ||
" | "songgenreid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"role": { | |||
"minLength": 1, | |||
"required": true, | |||
"type": "string" | |||
}, | |||
"songgenreid": { | "songgenreid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"genre": { | "genre": { | ||
" | "description": "Deprecated, use songgenre. Filter for existence of songs with this genre", | ||
"minLength": 1, | "minLength": 1, | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"songgenre": { | "songgenre": { | ||
" | "description": "Song genre. Filter for existence of songs with this genre", | ||
"minLength": 1, | "minLength": 1, | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"roleid": { | "roleid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
}, | |||
"songgenre": { | |||
"minLength": 1, | |||
"required": true, | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
" | "role": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
}, | }, | ||
" | "songgenre": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"albumid": { | "albumid": { | ||
Line 1,070: | Line 1,099: | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"album": { | "album": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"songid": { | "songid": { | ||
Line 1,091: | Line 1,120: | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
" | "roleid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
}, | }, | ||
" | "songid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"role": { | |||
"minLength": 1, | |||
"required": true, | |||
"type": "string" | |||
}, | |||
"songid": { | "songid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"roleid": { | "roleid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"description": "Role contributed by artist. Overridden by allroles parameter", | |||
"description": "Role contributed by artist. Overridden by allroles parameter" | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"role": { | "role": { | ||
" | "description": "Role contributed by artist. Overridden by allroles parameter", | ||
"minLength": 1, | "minLength": 1, | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
Line 1,151: | Line 1,180: | ||
}, | }, | ||
{ | { | ||
"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", | "name": "allroles", | ||
"type": "boolean | "type": "boolean" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"artists": { | |||
"items": { | |||
"$ref": "Audio.Details.Artist" | |||
}, | |||
"type": "array" | |||
}, | |||
"limits": { | "limits": { | ||
"$ref": "List.LimitsReturned", | "$ref": "List.LimitsReturned", | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== AudioLibrary. | ==== AudioLibrary.GetAvailableArt ==== | ||
Retrieve all | Retrieve all potential art URLs for a media item by art type<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 1,188: | Line 1,218: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# ''array'' availableart<br /> | |||
# ''array | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve all | |||
"params": [ | "params": [ | ||
{ | { | ||
"name": " | "name": "item", | ||
"$ref": "Library. | "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" | |||
"name": " | |||
" | |||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "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, | "required": true, | ||
" | "type": "array" | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== AudioLibrary. | ==== AudioLibrary.GetAvailableArtTypes ==== | ||
Retrieve a list of potential art types for a media item<br /> | |||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
'''Type:''' '' | '''Type:''' ''object''<br /> | ||
'''Properties:''' | |||
# ''array'' availablearttypes<br /> | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": " | |||
"params": [ | "params": [ | ||
{ | { | ||
"name": " | "name": "item", | ||
"required": true, | "required": true, | ||
" | "type": [ | ||
"$ref": " | { | ||
"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": { | "returns": { | ||
" | "properties": { | ||
"availablearttypes": { | |||
} | "items": { | ||
"type": "string" | |||
}, | |||
"required": true, | |||
"type": "array" | |||
} | |||
}, | |||
"type": "object" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== AudioLibrary. | ==== AudioLibrary.GetGenres ==== | ||
Retrieve | Retrieve all genres<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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.Limits|List.Limits]]'' limits]<br /> | ||
# [''[[#List.Sort|List.Sort]]'' sort]<br /> | # [''[[#List.Sort|List.Sort]]'' sort]<br /> | ||
Line 1,278: | Line 1,363: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# ''array[ [[#Library.Details.Genre|Library.Details.Genre]] ]'' genres<br /> | |||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve | |||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Library.Fields.Genre", | ||
" | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"genres": { | |||
"items": { | |||
"$ref": "Library.Details.Genre" | |||
}, | |||
"required": true, | |||
"type": "array" | |||
}, | |||
"limits": { | "limits": { | ||
"$ref": "List.LimitsReturned", | "$ref": "List.LimitsReturned", | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== AudioLibrary. | ==== AudioLibrary.GetProperties ==== | ||
Retrieves the values of the music library properties<br /> | |||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
'''Type:''' '' | '''Type:''' ''[[#Audio.Property.Value|Audio.Property.Value]]''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": " | |||
"params": [ | "params": [ | ||
{ | { | ||
" | "items": { | ||
"$ref": "Audio.Property.Name" | |||
}, | |||
"name": "properties", | "name": "properties", | ||
" | "required": true, | ||
"type": "array", | |||
"uniqueItems": true | |||
" | |||
" | |||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"$ref": "Audio.Property.Value" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== AudioLibrary. | ==== AudioLibrary.GetRecentlyAddedAlbums ==== | ||
Retrieve recently | Retrieve recently added albums<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
Line 1,392: | Line 1,450: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''array[ [[#Audio.Details.Album|Audio.Details.Album]] ]'' albums]<br /> | |||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve recently | |||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Audio.Fields.Album", | ||
" | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"albums": { | |||
"items": { | |||
"$ref": "Audio.Details.Album" | |||
}, | |||
"type": "array" | |||
}, | |||
"limits": { | "limits": { | ||
"$ref": "List.LimitsReturned", | "$ref": "List.LimitsReturned", | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== AudioLibrary. | ==== AudioLibrary.GetRecentlyAddedSongs ==== | ||
Retrieve recently | Retrieve recently added songs<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 /> | # [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br /> | ||
# [''[[#List.Limits|List.Limits]]'' limits]<br /> | # [''[[#List.Limits|List.Limits]]'' limits]<br /> | ||
Line 1,447: | Line 1,505: | ||
'''Properties:''' | '''Properties:''' | ||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
# [''array[[#Audio.Details.Song|Audio.Details.Song]]'' songs]<br /> | # [''array[ [[#Audio.Details.Song|Audio.Details.Song]] ]'' songs]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve recently | |||
"params": [ | "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" | ||
}, | }, | ||
{ | { | ||
"name": " | "$ref": "List.Limits", | ||
"$ref": "List.Sort" | "name": "limits" | ||
} | }, | ||
{ | |||
"$ref": "List.Sort", | |||
"name": "sort" | |||
} | |||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"limits": { | "limits": { | ||
Line 1,477: | Line 1,538: | ||
}, | }, | ||
"songs": { | "songs": { | ||
"items": { | "items": { | ||
"$ref": "Audio.Details.Song" | "$ref": "Audio.Details.Song" | ||
} | }, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== AudioLibrary. | ==== AudioLibrary.GetRecentlyPlayedAlbums ==== | ||
Retrieve | Retrieve recently played albums<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# [''[[#Audio.Fields. | # [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br /> | ||
# [''[[#List.Limits|List.Limits]]'' limits]<br /> | # [''[[#List.Limits|List.Limits]]'' limits]<br /> | ||
# [''[[#List.Sort|List.Sort]]'' sort]<br /> | # [''[[#List.Sort|List.Sort]]'' sort]<br /> | ||
Line 1,500: | Line 1,563: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''array[ [[#Audio.Details.Album|Audio.Details.Album]] ]'' albums]<br /> | |||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve | |||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Audio.Fields.Album", | ||
" | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"albums": { | |||
"items": { | |||
"$ref": "Audio.Details.Album" | |||
}, | |||
"type": "array" | |||
}, | |||
"limits": { | "limits": { | ||
"$ref": "List.LimitsReturned", | "$ref": "List.LimitsReturned", | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== AudioLibrary. | ==== AudioLibrary.GetRecentlyPlayedSongs ==== | ||
Retrieve | Retrieve recently played songs<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 /> | # [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br /> | ||
# [''[[#List.Limits|List.Limits]]'' limits]<br /> | |||
# [''[[#List.Sort|List.Sort]]'' sort]<br /> | |||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 1,554: | Line 1,616: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''[[#Audio.Details.Song|Audio.Details.Song]]'' | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
# [''array[ [[#Audio.Details.Song|Audio.Details.Song]] ]'' songs]<br /> | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve | |||
"params": [ | "params": [ | ||
{ | { | ||
"name": " | "$ref": "Audio.Fields.Song", | ||
"$ref": " | "name": "properties" | ||
" | }, | ||
{ | |||
"$ref": "List.Limits", | |||
"name": "limits" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
" | "limits": { | ||
"$ref": "Audio.Details.Song" | "$ref": "List.LimitsReturned", | ||
"required": true | |||
}, | |||
"songs": { | |||
"items": { | |||
"$ref": "Audio.Details.Song" | |||
}, | |||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== AudioLibrary. | ==== AudioLibrary.GetRoles ==== | ||
Retrieve all | Retrieve all contributor roles<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# [''[[#Audio.Fields. | # [''[[#Audio.Fields.Role|Audio.Fields.Role]]'' properties]<br /> | ||
# [''[[#List.Limits|List.Limits]]'' limits]<br /> | # [''[[#List.Limits|List.Limits]]'' limits]<br /> | ||
# [''[[#List.Sort|List.Sort]]'' sort]<br /> | # [''[[#List.Sort|List.Sort]]'' sort]<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 1,602: | Line 1,670: | ||
'''Properties:''' | '''Properties:''' | ||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
# | # ''array[ [[#Audio.Details.Role|Audio.Details.Role]] ]'' roles<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve all | |||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Audio.Fields.Role", | ||
" | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
}, | }, | ||
{ | { | ||
"name": "sort", | "$ref": "List.Sort", | ||
"$ref": "List. | "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": [ | |||
{ | { | ||
"name": "filter", | "$ref": "Library.Id", | ||
"type": [ | "name": "songid", | ||
{ | "required": true | ||
" | }, | ||
"properties": { | { | ||
"genreid": { | "$ref": "Audio.Fields.Song", | ||
"$ref": "Library.Id" | "name": "properties" | ||
} | |||
"description": "Song genre. Filter for existence of songs with this genre" | ], | ||
} | "permission": "ReadData", | ||
}, | "returns": { | ||
" | "properties": { | ||
}, | "songdetails": { | ||
{ | "$ref": "Audio.Details.Song" | ||
" | } | ||
"properties": { | }, | ||
"genre": { | "type": "object" | ||
" | }, | ||
"minLength": 1, | "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, | "required": true, | ||
" | "type": "string" | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"artistid": { | "artistid": { | ||
Line 1,657: | Line 1,821: | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"artistid": { | "artistid": { | ||
Line 1,671: | Line 1,835: | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"artistid": { | "artistid": { | ||
Line 1,681: | Line 1,845: | ||
}, | }, | ||
"role": { | "role": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"artist": { | "artist": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"artist": { | "artist": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
}, | }, | ||
"roleid": { | "roleid": { | ||
Line 1,712: | Line 1,876: | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"artist": { | "artist": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
}, | }, | ||
"role": { | "role": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"albumid": { | "albumid": { | ||
Line 1,738: | Line 1,902: | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"album": { | "album": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
Line 1,757: | Line 1,921: | ||
}, | }, | ||
{ | { | ||
"default": true, | |||
"description": "Only songs from albums are returned when false, but overridden when singlesonly parameter is true", | |||
"name": "includesingles", | "name": "includesingles", | ||
"type": "boolean | "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", | "name": "allroles", | ||
"type": "boolean | "type": "boolean" | ||
}, | }, | ||
{ | { | ||
"default": false, | |||
"description": "Only singles are returned when true, and overrides includesingles parameter", | |||
"name": "singlesonly", | "name": "singlesonly", | ||
"type": "boolean | "type": "boolean" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"limits": { | "limits": { | ||
Line 1,783: | Line 1,947: | ||
}, | }, | ||
"songs": { | "songs": { | ||
"items": { | "items": { | ||
"$ref": "Audio.Details.Song" | "$ref": "Audio.Details.Song" | ||
} | }, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 1,807: | Line 1,973: | ||
'''Properties:''' | '''Properties:''' | ||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
# ''array[[#Library.Details.Source|Library.Details.Source]]'' sources<br /> | # ''array[ [[#Library.Details.Source|Library.Details.Source]] ]'' sources<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Get all music sources, including unique ID", | ||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Library.Fields.Source", | ||
" | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"limits": { | "limits": { | ||
Line 1,837: | Line 2,000: | ||
}, | }, | ||
"sources": { | "sources": { | ||
"items": { | "items": { | ||
"$ref": "Library.Details.Source" | "$ref": "Library.Details.Source" | ||
} | }, | ||
"required": true, | |||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 1,853: | Line 2,018: | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# [''string'' directory = ]<br /> | # [''string'' directory = ""]<br /> | ||
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br /> | # [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br /> | ||
</div> | </div> | ||
Line 1,860: | Line 2,025: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Scans the audio sources for new library items", | ||
"params": [ | "params": [ | ||
{ | { | ||
"default": "", | |||
"name": "directory", | "name": "directory", | ||
"type": "string | "type": "string" | ||
}, | }, | ||
{ | { | ||
"default": true, | |||
"description": "Whether or not to show the progress bar or any other GUI dialog", | |||
"name": "showdialogs", | "name": "showdialogs", | ||
"type": "boolean | "type": "boolean" | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "UpdateData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 1,889: | Line 2,055: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 /> | # ''[[#Library.Id|Library.Id]]'' albumid<br /> | ||
# [''[[#Optional.String|Optional.String]]'' title]<br /> | # [''[[#Optional.String|Optional.String]]'' title = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' artist = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' description]<br /> | # [''[[#Optional.String|Optional.String]]'' description = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' genre = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' theme = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' theme = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' mood = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' mood = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' style = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' style = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' type]<br /> | # [''[[#Optional.String|Optional.String]]'' type = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' albumlabel]<br /> | # [''[[#Optional.String|Optional.String]]'' albumlabel = None]<br /> | ||
# [''[[#Optional.Number|Optional.Number]]'' rating]<br /> | # [''[[#Optional.Number|Optional.Number]]'' rating = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' year]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' year = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' userrating]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' votes]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' votes = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' musicbrainzalbumid]<br /> | # [''[[#Optional.String|Optional.String]]'' musicbrainzalbumid = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' musicbrainzreleasegroupid]<br /> | # [''[[#Optional.String|Optional.String]]'' musicbrainzreleasegroupid = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' sortartist]<br /> | # [''[[#Optional.String|Optional.String]]'' sortartist = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' displayartist]<br /> | # [''[[#Optional.String|Optional.String]]'' displayartist = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' musicbrainzalbumartistid = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' musicbrainzalbumartistid = None]<br /> | ||
# [''mixed: [[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /> | # [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /> | ||
# [''[[#Optional.Boolean|Optional.Boolean]]'' isboxset]<br /> | # [''[[#Optional.Boolean|Optional.Boolean]]'' isboxset = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' releasedate]<br /> | # [''[[#Optional.String|Optional.String]]'' releasedate = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' originaldate]<br /> | # [''[[#Optional.String|Optional.String]]'' originaldate = None]<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 1,916: | Line 2,082: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Update the given album with the given details", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"name": "albumid", | "name": "albumid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "title" | |||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "artist", | "name": "artist", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "description" | |||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "genre", | "name": "genre", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "theme", | "name": "theme", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "mood", | "name": "mood", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "style", | "name": "style", | ||
"type": [ | "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", | "name": "musicbrainzalbumartistid", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "art", | "name": "art", | ||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Media.Artwork.Set" | "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" | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "UpdateData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 2,076: | Line 2,265: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 /> | # ''[[#Library.Id|Library.Id]]'' artistid<br /> | ||
# [''[[#Optional.String|Optional.String]]'' artist]<br /> | # [''[[#Optional.String|Optional.String]]'' artist = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' instrument = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' instrument = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' style = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' style = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' mood = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' mood = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' born]<br /> | # [''[[#Optional.String|Optional.String]]'' born = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' formed]<br /> | # [''[[#Optional.String|Optional.String]]'' formed = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' description]<br /> | # [''[[#Optional.String|Optional.String]]'' description = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' genre = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' died]<br /> | # [''[[#Optional.String|Optional.String]]'' died = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' disbanded]<br /> | # [''[[#Optional.String|Optional.String]]'' disbanded = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' yearsactive = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' yearsactive = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' musicbrainzartistid]<br /> | # [''[[#Optional.String|Optional.String]]'' musicbrainzartistid = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' sortname]<br /> | # [''[[#Optional.String|Optional.String]]'' sortname = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' type]<br /> | # [''[[#Optional.String|Optional.String]]'' type = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' gender]<br /> | # [''[[#Optional.String|Optional.String]]'' gender = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' disambiguation]<br /> | # [''[[#Optional.String|Optional.String]]'' disambiguation = None]<br /> | ||
# [''mixed: [[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /> | # [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 2,098: | Line 2,287: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Update the given artist with the given details", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"name": "artistid", | "name": "artistid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "artist" | |||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "instrument", | "name": "instrument", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "style", | "name": "style", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "mood", | "name": "mood", | ||
"type": [ | "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", | "name": "genre", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "died" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "disbanded" | |||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "yearsactive", | "name": "yearsactive", | ||
"type": [ | "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", | "name": "art", | ||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Media.Artwork.Set" | "type": "null" | ||
}, | |||
{ | |||
"$ref": "Media.Artwork.Set" | |||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "UpdateData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 2,231: | Line 2,438: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 /> | # ''[[#Library.Id|Library.Id]]'' songid<br /> | ||
# [''[[#Optional.String|Optional.String]]'' title]<br /> | # [''[[#Optional.String|Optional.String]]'' title = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' artist = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' genre = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' year]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' year = None]<br /> | ||
# [''[[#Optional.Number|Optional.Number]]'' rating]<br /> | # [''[[#Optional.Number|Optional.Number]]'' rating = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' track]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' track = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' disc]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' disc = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' duration]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' duration = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' comment]<br /> | # [''[[#Optional.String|Optional.String]]'' comment = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' musicbrainztrackid]<br /> | # [''[[#Optional.String|Optional.String]]'' musicbrainztrackid = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' musicbrainzartistid]<br /> | # [''[[#Optional.String|Optional.String]]'' musicbrainzartistid = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' playcount]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' lastplayed]<br /> | # [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' userrating]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' votes]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' votes = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' displayartist]<br /> | # [''[[#Optional.String|Optional.String]]'' displayartist = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' sortartist]<br /> | # [''[[#Optional.String|Optional.String]]'' sortartist = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' mood]<br /> | # [''[[#Optional.String|Optional.String]]'' mood = None]<br /> | ||
# [''mixed: [[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /> | # [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' disctitle]<br /> | # [''[[#Optional.String|Optional.String]]'' disctitle = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' releasedate]<br /> | # [''[[#Optional.String|Optional.String]]'' releasedate = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' originaldate]<br /> | # [''[[#Optional.String|Optional.String]]'' originaldate = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' bpm]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' bpm = None]<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 2,259: | Line 2,466: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Update the given song with the given details", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"name": "songid", | "name": "songid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "title" | |||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "artist", | "name": "artist", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "genre", | "name": "genre", | ||
"type": [ | "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", | "name": "art", | ||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Media.Artwork.Set" | "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" | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "UpdateData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 2,397: | Line 2,628: | ||
# ''string'' title<br /> | # ''string'' title<br /> | ||
# ''[[#Favourite.Type|Favourite.Type]]'' type<br /> | # ''[[#Favourite.Type|Favourite.Type]]'' type<br /> | ||
# [''[[#Optional.String|Optional.String]]'' path] (Required for media, script and androidapp favourites types)<br /> | # [''[[#Optional.String|Optional.String]]'' path = None] (Required for media, script and androidapp favourites types)<br /> | ||
# [''[[#Optional.String|Optional.String]]'' window] (Required for window favourite type)<br /> | # [''[[#Optional.String|Optional.String]]'' window = None] (Required for window favourite type)<br /> | ||
# [''[[#Optional.String|Optional.String]]'' windowparameter]<br /> | # [''[[#Optional.String|Optional.String]]'' windowparameter = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' thumbnail]<br /> | # [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 2,406: | Line 2,637: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Add a favourite with the given details", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "title", | "name": "title", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Favourite.Type", | |||
"name": "type", | "name": "type", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"$ref": "Optional.String", | "$ref": "Optional.String", | ||
"description": "Required for media, script and androidapp favourites types" | "default": null, | ||
"description": "Required for media, script and androidapp favourites types", | |||
"name": "path" | |||
}, | }, | ||
{ | { | ||
"$ref": "Optional.String", | "$ref": "Optional.String", | ||
"description": "Required for window favourite type" | "default": null, | ||
"description": "Required for window favourite type", | |||
"name": "window" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "windowparameter" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "thumbnail" | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "UpdateData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 2,451: | Line 2,687: | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# [''mixed: [[#Favourite.Type|Favourite.Type]]'' type = None]<br /> | # [''mixed: null|[[#Favourite.Type|Favourite.Type]]'' type = None]<br /> | ||
# [''[[#Favourite.Fields.Favourite|Favourite.Fields.Favourite]]'' properties]<br /> | # [''[[#Favourite.Fields.Favourite|Favourite.Fields.Favourite]]'' properties]<br /> | ||
</div> | </div> | ||
Line 2,458: | Line 2,694: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''array[ [[#Favourite.Details.Favourite|Favourite.Details.Favourite]] ]'' favourites]<br /> | |||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieve all favourites", | ||
"params": [ | "params": [ | ||
{ | { | ||
"default": null, | |||
"name": "type", | "name": "type", | ||
"type": [ | "type": [ | ||
"null", | { | ||
"type": "null" | |||
}, | |||
{ | { | ||
"$ref": "Favourite.Type" | "$ref": "Favourite.Type" | ||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Favourite.Fields.Favourite", | ||
" | "name": "properties" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"favourites": { | |||
"items": { | |||
"$ref": "Favourite.Details.Favourite" | |||
}, | |||
"type": "array" | |||
}, | |||
"limits": { | "limits": { | ||
"$ref": "List.LimitsReturned", | "$ref": "List.LimitsReturned", | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 2,513: | Line 2,750: | ||
'''Type:''' ''any''<br /> | '''Type:''' ''any''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Downloads the given file", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "path", | "name": "path", | ||
" | "required": true, | ||
" | "type": "string" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"type": "any", | "type": "any" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 2,551: | Line 2,783: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# ''array[ [[#List.Item.File|List.Item.File]] ]'' files<br /> | |||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Get the directories and files in the given directory", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "directory", | "name": "directory", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Files.Media", | "$ref": "Files.Media", | ||
"default": "files" | "default": "files", | ||
"name": "media" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Fields.Files", | ||
" | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
}, | }, | ||
{ | { | ||
"$ref": "List.Limits", | "$ref": "List.Limits", | ||
"description": "Limits are applied after getting the directory content thus retrieval is not faster when they are applied." | "description": "Limits are applied after getting the directory content thus retrieval is not faster when they are applied.", | ||
"name": "limits" | |||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"files": { | "files": { | ||
"items": { | "items": { | ||
"$ref": "List.Item.File" | "$ref": "List.Item.File" | ||
}, | }, | ||
"required": true, | |||
"type": "array" | |||
}, | |||
"limits": { | |||
"$ref": "List.LimitsReturned", | |||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 2,619: | Line 2,850: | ||
# ''[[#List.Item.File|List.Item.File]]'' filedetails<br /> | # ''[[#List.Item.File|List.Item.File]]'' filedetails<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Get details for a specific file", | ||
"params": [ | "params": [ | ||
{ | { | ||
"description": "Full path to the file", | |||
"name": "file", | "name": "file", | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Files.Media", | "$ref": "Files.Media", | ||
"default": "files" | "default": "files", | ||
"name": "media" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Fields.Files", | ||
" | "name": "properties" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"filedetails": { | "filedetails": { | ||
Line 2,649: | Line 2,877: | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 2,670: | Line 2,900: | ||
# ''[[#List.Items.Sources|List.Items.Sources]]'' sources<br /> | # ''[[#List.Items.Sources|List.Items.Sources]]'' sources<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Get the sources of the media windows", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Files.Media", | |||
"name": "media", | "name": "media", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"limits": { | "limits": { | ||
Line 2,702: | Line 2,929: | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 2,718: | Line 2,947: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# ''any'' details (Transport specific details on how/from where to download the given file)<br /> | # ''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'' mode (Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol)<br /> | ||
# ''string'' protocol<br /> | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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)", | "description": "Provides a way to download a given file (e.g. providing an URL to the real file location)", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "path", | "name": "path", | ||
" | "required": true, | ||
" | "type": "string" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"details": { | "details": { | ||
" | "description": "Transport specific details on how/from where to download the given file", | ||
"required": true, | "required": true, | ||
" | "type": "any" | ||
}, | }, | ||
"mode": { | "mode": { | ||
" | "description": "Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol", | ||
" | "enums": [ | ||
"redirect", | "redirect", | ||
"direct" | "direct" | ||
], | ], | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
}, | |||
"protocol": { | |||
"enums": [ | |||
"http" | |||
], | |||
"required": true, | |||
"type": "string" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 2,774: | Line 2,999: | ||
# ''string'' file (Full path to the file)<br /> | # ''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 /> | # ''[[#Files.Media|Files.Media]]'' media (File type to update correct database. Currently only "video" is supported.)<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' playcount]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' lastplayed] (Setting a valid lastplayed without a playcount will force playcount to 1.)<br /> | # [''[[#Optional.String|Optional.String]]'' lastplayed = None] (Setting a valid lastplayed without a playcount will force playcount to 1.)<br /> | ||
# [''mixed: [[#Video.Resume|Video.Resume]]'' resume = None]<br /> | # [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 2,782: | Line 3,007: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Update the given specific file with the given details", | ||
"params": [ | "params": [ | ||
{ | { | ||
"description": "Full path to the file", | |||
"name": "file", | "name": "file", | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Files.Media", | |||
"description": "File type to update correct database. Currently only \"video\" is supported.", | |||
"name": "media", | "name": "media", | ||
"required": true | |||
"required": true | |||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.Integer", | ||
" | "default": null, | ||
"name": "playcount" | |||
}, | }, | ||
{ | { | ||
"$ref": "Optional.String", | "$ref": "Optional.String", | ||
"description": "Setting a valid lastplayed without a playcount will force playcount to 1." | "default": null, | ||
"description": "Setting a valid lastplayed without a playcount will force playcount to 1.", | |||
"name": "lastplayed" | |||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "resume", | "name": "resume", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Video.Resume" | |||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "UpdateData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 2,833: | Line 3,062: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 /> | # ''[[#GUI.Window|GUI.Window]]'' window<br /> | ||
# [''array'' parameters]<br /> | # [''array[string]'' parameters]<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 2,839: | Line 3,068: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Activates the given window", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "GUI.Window", | |||
"name": "window", | "name": "window", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"items": { | "items": { | ||
"minLength": 1, | "minLength": 1, | ||
" | "type": "string" | ||
}, | }, | ||
"minItems": 1 | "minItems": 1, | ||
"name": "parameters", | |||
"type": "array" | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlGUI", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 2,871: | Line 3,100: | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# ''array'' properties<br /> | # ''array[ [[#GUI.Property.Name|GUI.Property.Name]] ]'' properties<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 2,877: | Line 3,106: | ||
'''Type:''' ''[[#GUI.Property.Value|GUI.Property.Value]]''<br /> | '''Type:''' ''[[#GUI.Property.Value|GUI.Property.Value]]''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the values of the given properties", | ||
"params": [ | "params": [ | ||
{ | { | ||
"items": { | |||
"$ref": "GUI.Property.Name" | |||
}, | |||
"name": "properties", | "name": "properties", | ||
"required": true, | |||
"type": "array", | "type": "array", | ||
"uniqueItems": true | "uniqueItems": true | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"$ref": "GUI.Property.Value", | "$ref": "GUI.Property.Value" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 2,908: | Line 3,135: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''array[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]'' stereoscopicmodes]<br /> | # [''array[ [[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]] ]'' stereoscopicmodes]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Returns the supported stereoscopic modes of the GUI", | ||
" | "params": [], | ||
"permission": "ReadData", | "permission": "ReadData", | ||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"stereoscopicmodes": { | "stereoscopicmodes": { | ||
"items": { | "items": { | ||
"$ref": "GUI.Stereoscopy.Mode" | "$ref": "GUI.Stereoscopy.Mode" | ||
} | }, | ||
"type": "array", | |||
"uniqueItems": true | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 2,943: | Line 3,169: | ||
'''Type:''' ''boolean (Fullscreen state)''<br /> | '''Type:''' ''boolean (Fullscreen state)''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Toggle fullscreen/GUI", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Global.Toggle", | |||
"name": "fullscreen", | "name": "fullscreen", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"permission": "ControlGUI", | |||
"returns": { | "returns": { | ||
" | "description": "Fullscreen state", | ||
" | "type": "boolean" | ||
} | }, | ||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 2,974: | Line 3,199: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Sets the stereoscopic mode of the GUI to the given mode", | ||
"params": [ | "params": [ | ||
{ | { | ||
" | "enums": [ | ||
"toggle", | "toggle", | ||
"tomono", | "tomono", | ||
Line 2,999: | Line 3,219: | ||
"monoscopic" | "monoscopic" | ||
], | ], | ||
"required": true | "name": "mode", | ||
"required": true, | |||
"type": "string" | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlGUI", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,013: | Line 3,239: | ||
# ''string'' title<br /> | # ''string'' title<br /> | ||
# ''string'' message<br /> | # ''string'' message<br /> | ||
# [''mixed: string|string'' image = ]<br /> | # [''mixed: string|string'' image = ""]<br /> | ||
# [''integer'' displaytime = 5000] (The time in milliseconds the notification will be visible)<br /> | # [''integer'' displaytime = 5000] (The time in milliseconds the notification will be visible)<br /> | ||
</div> | </div> | ||
Line 3,020: | Line 3,246: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Shows a GUI notification", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "title", | "name": "title", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "message", | "name": "message", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"default": "", | |||
"name": "image", | "name": "image", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "enums": [ | ||
"info", | "info", | ||
"warning", | "warning", | ||
"error" | "error" | ||
] | ], | ||
"type": "string" | |||
}, | }, | ||
{ | { | ||
"type": "string" | "type": "string" | ||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": 5000, | |||
"description": "The time in milliseconds the notification will be visible", | |||
"minimum": 1500, | |||
"name": "displaytime", | "name": "displaytime", | ||
"type": "integer | "type": "integer" | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlGUI", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,076: | Line 3,301: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Goes back in GUI", | ||
" | "params": [], | ||
"permission": "Navigate", | "permission": "Navigate", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,094: | Line 3,320: | ||
# ''string'' button (Button name)<br /> | # ''string'' button (Button name)<br /> | ||
# ''string'' keymap (Keymap name (KB, XG, R1, or R2))<br /> | # ''string'' keymap (Keymap name (KB, XG, R1, or R2))<br /> | ||
# ''integer'' holdtime = 0 (Number of milliseconds to simulate button hold.)<br /> | # [''integer'' holdtime = 0] (Number of milliseconds to simulate button hold.)<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 3,100: | Line 3,326: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Send a button press event", | ||
"params": [ | "params": [ | ||
{ | { | ||
"description": "Button name", | |||
"name": "button", | "name": "button", | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"description": "Keymap name (KB, XG, R1, or R2)", | "description": "Keymap name (KB, XG, R1, or R2)", | ||
" | "enums": [ | ||
"KB", | "KB", | ||
"XG", | "XG", | ||
"R1", | "R1", | ||
"R2" | "R2" | ||
] | ], | ||
"name": "keymap", | |||
"required": true, | |||
"type": "string" | |||
}, | }, | ||
{ | { | ||
"default": 0, | |||
"description": "Number of milliseconds to simulate button hold.", | |||
"minimum": 0, | |||
"name": "holdtime", | "name": "holdtime", | ||
"type": "integer | "type": "integer" | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "Navigate", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,145: | Line 3,371: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Shows the context menu", | ||
" | "params": [], | ||
"permission": "Navigate", | "permission": "Navigate", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,163: | Line 3,390: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Navigate down in GUI", | ||
" | "params": [], | ||
"permission": "Navigate", | "permission": "Navigate", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,185: | Line 3,413: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Execute a specific action", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Input.Action", | |||
"name": "action", | "name": "action", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "Navigate", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,209: | Line 3,438: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Goes to home window in GUI", | ||
" | "params": [], | ||
"permission": "Navigate", | "permission": "Navigate", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,227: | Line 3,457: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Shows the information dialog", | ||
" | "params": [], | ||
"permission": "Navigate", | "permission": "Navigate", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,245: | Line 3,476: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Navigate left in GUI", | ||
" | "params": [], | ||
"permission": "Navigate", | "permission": "Navigate", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,263: | Line 3,495: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Navigate right in GUI", | ||
" | "params": [], | ||
"permission": "Navigate", | "permission": "Navigate", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,281: | Line 3,514: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Select current item in GUI", | ||
" | "params": [], | ||
"permission": "Navigate", | "permission": "Navigate", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,304: | Line 3,538: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Send a generic (unicode) text", | ||
"params": [ | "params": [ | ||
{ | { | ||
"description": "Unicode text", | |||
"name": "text", | "name": "text", | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"default": true, | |||
"description": "Whether this is the whole input or not (closes an open input dialog if true).", | |||
"name": "done", | "name": "done", | ||
"type": "boolean | "type": "boolean" | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "Navigate", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,335: | Line 3,570: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Show codec information of the playing item", | ||
" | "params": [], | ||
"permission": "Navigate", | "permission": "Navigate", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,353: | Line 3,589: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Show the on-screen display for the current player", | ||
" | "params": [], | ||
"permission": "Navigate", | "permission": "Navigate", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,371: | Line 3,608: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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, ...", | "description": "Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...", | ||
" | "params": [], | ||
"permission": "Navigate", | "permission": "Navigate", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,389: | Line 3,627: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Navigate up in GUI", | ||
" | "params": [], | ||
"permission": "Navigate", | "permission": "Navigate", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,408: | Line 3,647: | ||
'''Type:''' ''[[#Configuration|Configuration]]''<br /> | '''Type:''' ''[[#Configuration|Configuration]]''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Get client-specific configurations", | ||
" | "params": [], | ||
"permission": "ReadData", | "permission": "ReadData", | ||
"returns": { | "returns": { | ||
"$ref": "Configuration" | "$ref": "Configuration" | ||
} | }, | ||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,435: | Line 3,673: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Enumerates all actions and descriptions", | ||
"params": [ | "params": [ | ||
{ | { | ||
"default": true, | |||
"name": "getdescriptions", | "name": "getdescriptions", | ||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
{ | { | ||
"default": false, | |||
"name": "getmetadata", | "name": "getmetadata", | ||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
{ | { | ||
"default": true, | |||
"name": "filterbytransport", | "name": "filterbytransport", | ||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
{ | { | ||
"name": "filter", | "name": "filter", | ||
"properties": { | "properties": { | ||
"getreferences": { | |||
"default": true, | |||
"description": "Whether or not to print the schema for referenced types", | |||
"type": "boolean" | |||
}, | |||
"id": { | "id": { | ||
" | "description": "Name of a namespace, method or type", | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
"type": { | "type": { | ||
" | "description": "Type of the given name", | ||
" | "enums": [ | ||
"method", | "method", | ||
"namespace", | "namespace", | ||
Line 3,475: | Line 3,713: | ||
"notification" | "notification" | ||
], | ], | ||
" | "required": true, | ||
"type": "string" | |||
"type": " | |||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": "object" | "permission": "ReadData", | ||
"returns": { | |||
"additionalProperties": false, | |||
"type": "object" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,502: | Line 3,742: | ||
'''Type:''' ''any''<br /> | '''Type:''' ''any''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Notify all other connected clients", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "message", | "name": "message", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "data", | "name": "data", | ||
"type": "any" | "type": "any" | ||
} | } | ||
], | ], | ||
"returns": "any" | "permission": "ReadData", | ||
"returns": { | |||
"type": "any" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,536: | Line 3,777: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# ''boolean'' | # ''boolean'' controlgui<br /> | ||
# ''boolean'' | # ''boolean'' controlnotify<br /> | ||
# ''boolean'' | # ''boolean'' controlplayback<br /> | ||
# ''boolean'' | # ''boolean'' controlpower<br /> | ||
# ''boolean'' | # ''boolean'' controlpvr<br /> | ||
# ''boolean'' | # ''boolean'' controlsystem<br /> | ||
# ''boolean'' | # ''boolean'' executeaddon<br /> | ||
# ''boolean'' | # ''boolean'' manageaddon<br /> | ||
# ''boolean'' | # ''boolean'' navigate<br /> | ||
# ''boolean'' | # ''boolean'' readdata<br /> | ||
# ''boolean'' | # ''boolean'' removedata<br /> | ||
# ''boolean'' | # ''boolean'' updatedata<br /> | ||
# ''boolean'' | # ''boolean'' writefile<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieve the clients permissions", | ||
" | "params": [], | ||
"permission": "ReadData", | "permission": "ReadData", | ||
"returns": { | "returns": { | ||
"properties": { | "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>}} | </syntaxhighlight>}} | ||
Line 3,624: | Line 3,864: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | ||
{ | { | ||
"description": "Ping responder", | "description": "Ping responder", | ||
" | "params": [], | ||
"permission": "ReadData", | "permission": "ReadData", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,646: | Line 3,887: | ||
'''Type:''' ''[[#Configuration|Configuration]]''<br /> | '''Type:''' ''[[#Configuration|Configuration]]''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Change the client-specific configuration", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "notifications", | "name": "notifications", | ||
"properties": { | "properties": { | ||
" | "application": { | ||
"$ref": "Optional.Boolean" | "$ref": "Optional.Boolean", | ||
"default": null | |||
}, | }, | ||
" | "audiolibrary": { | ||
"$ref": "Optional.Boolean" | "$ref": "Optional.Boolean", | ||
"default": null | |||
}, | }, | ||
" | "gui": { | ||
"$ref": "Optional.Boolean" | "$ref": "Optional.Boolean", | ||
"default": null | |||
}, | }, | ||
" | "input": { | ||
"$ref": "Optional.Boolean" | "$ref": "Optional.Boolean", | ||
"default": null | |||
}, | }, | ||
" | "other": { | ||
"$ref": "Optional.Boolean" | "$ref": "Optional.Boolean", | ||
"default": null | |||
}, | }, | ||
" | "player": { | ||
"$ref": "Optional.Boolean" | "$ref": "Optional.Boolean", | ||
"default": null | |||
}, | }, | ||
" | "playlist": { | ||
"$ref": "Optional.Boolean" | "$ref": "Optional.Boolean", | ||
"default": null | |||
}, | }, | ||
" | "system": { | ||
"$ref": "Optional.Boolean" | "$ref": "Optional.Boolean", | ||
"default": null | |||
}, | }, | ||
" | "videolibrary": { | ||
"$ref": "Optional.Boolean" | "$ref": "Optional.Boolean", | ||
"default": null | |||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
], | ], | ||
"permission": "ControlNotify", | |||
"returns": { | "returns": { | ||
"$ref": "Configuration" | "$ref": "Configuration" | ||
} | }, | ||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,702: | Line 3,951: | ||
# ''object'' version<br /> | # ''object'' version<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "Retrieve the JSON-RPC protocol version.", | ||
" | "params": [], | ||
"permission": "ReadData", | "permission": "ReadData", | ||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"version": { | "version": { | ||
"properties": { | "properties": { | ||
"major": { | "major": { | ||
" | "description": "Bumped on backwards incompatible changes to the API definition", | ||
"minimum": 0, | "minimum": 0, | ||
"required": true, | "required": true, | ||
" | "type": "integer" | ||
}, | }, | ||
"minor": { | "minor": { | ||
" | "description": "Bumped on backwards compatible additions/changes to the API definition", | ||
"minimum": 0, | "minimum": 0, | ||
"required": true, | "required": true, | ||
" | "type": "integer" | ||
}, | }, | ||
"patch": { | "patch": { | ||
" | "description": "Bumped on any changes to the internal implementation but not to the API definition", | ||
"minimum": 0, | "minimum": 0, | ||
"required": true, | "required": true, | ||
" | "type": "integer" | ||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
=== PVR === | === PVR === | ||
==== PVR.AddTimer ==== | ==== PVR.AddTimer ==== | ||
Adds a timer to record the given show one times or a timer rule to record all showings of the given show<br /> | 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:''' | '''Permissions:''' | ||
* ControlPVR | * ControlPVR | ||
Line 3,749: | Line 3,997: | ||
# ''[[#Library.Id|Library.Id]]'' broadcastid (the broadcast id of the item to record)<br /> | # ''[[#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'' 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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 3,754: | Line 4,003: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Adds a timer to record the given show one times or a timer rule to record all showings of the given show | |||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"description": "the broadcast id of the item to record", | |||
"name": "broadcastid", | "name": "broadcastid", | ||
"required": true | |||
"required": true | |||
}, | }, | ||
{ | { | ||
"default": false, | |||
"description": "controls whether to create a timer rule or a onetime timer", | |||
"name": "timerrule", | "name": "timerrule", | ||
"type": "boolean", | "type": "boolean" | ||
}, | |||
{ | |||
"default": false, | "default": false, | ||
"description": "controls whether to create a timer | "description": "controls whether to create a reminder timer or a recording timer", | ||
"name": "reminder", | |||
"type": "boolean" | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPVR", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,789: | Line 4,045: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Deletes a onetime timer or a timer rule", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"description": "the id of the onetime timer or timer rule to delete", | |||
"name": "timerid", | "name": "timerid", | ||
"required": true | |||
"required": true | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPVR", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,821: | Line 4,078: | ||
# [''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastdetails]<br /> | # [''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastdetails]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the details of a specific broadcast", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"name": "broadcastid", | "name": "broadcastid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "PVR.Fields.Broadcast", | ||
" | "name": "properties" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"broadcastdetails": { | "broadcastdetails": { | ||
"$ref": "PVR.Details.Broadcast" | "$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 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 to check for playability", | |||
"name": "broadcastid", | |||
"required": true | |||
} | } | ||
} | ], | ||
"permission": "ReadData", | |||
"returns": { | |||
"type": "boolean" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,862: | Line 4,148: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# ''array[ [[#PVR.Details.Broadcast|PVR.Details.Broadcast]] ]'' broadcasts<br /> | |||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the program of a specific channel", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"name": "channelid", | "name": "channelid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "PVR.Fields.Broadcast", | ||
" | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"broadcasts": { | |||
"items": { | |||
"$ref": "PVR.Details.Broadcast" | |||
}, | |||
"required": true, | |||
"type": "array" | |||
}, | |||
"limits": { | "limits": { | ||
"$ref": "List.LimitsReturned", | "$ref": "List.LimitsReturned", | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,919: | Line 4,204: | ||
# [''[[#PVR.Details.Channel|PVR.Details.Channel]]'' channeldetails]<br /> | # [''[[#PVR.Details.Channel|PVR.Details.Channel]]'' channeldetails]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the details of a specific channel", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"name": "channelid", | "name": "channelid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "PVR.Fields.Channel", | ||
" | "name": "properties" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"channeldetails": { | "channeldetails": { | ||
"$ref": "PVR.Details.Channel" | "$ref": "PVR.Details.Channel" | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 3,961: | Line 4,245: | ||
# [''[[#PVR.Details.ChannelGroup.Extended|PVR.Details.ChannelGroup.Extended]]'' channelgroupdetails]<br /> | # [''[[#PVR.Details.ChannelGroup.Extended|PVR.Details.ChannelGroup.Extended]]'' channelgroupdetails]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the details of a specific channel group", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "PVR.ChannelGroup.Id", | |||
"name": "channelgroupid", | "name": "channelgroupid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"name": "channels", | "name": "channels", | ||
"properties": { | "properties": { | ||
"limits": { | |||
"$ref": "List.Limits" | |||
}, | |||
"properties": { | "properties": { | ||
"$ref": "PVR.Fields.Channel" | "$ref": "PVR.Fields.Channel" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"channelgroupdetails": { | "channelgroupdetails": { | ||
"$ref": "PVR.Details.ChannelGroup.Extended" | "$ref": "PVR.Details.ChannelGroup.Extended" | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,009: | Line 4,292: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# ''array[ [[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]] ]'' channelgroups<br /> | |||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the channel groups for the specified type", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "PVR.Channel.Type", | |||
"name": "channeltype", | "name": "channeltype", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"channelgroups": { | |||
"items": { | |||
"$ref": "PVR.Details.ChannelGroup" | |||
}, | |||
"required": true, | |||
"type": "array" | |||
}, | |||
"limits": { | "limits": { | ||
"$ref": "List.LimitsReturned", | "$ref": "List.LimitsReturned", | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,056: | Line 4,338: | ||
# [''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties]<br /> | # [''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties]<br /> | ||
# [''[[#List.Limits|List.Limits]]'' limits]<br /> | # [''[[#List.Limits|List.Limits]]'' limits]<br /> | ||
# [''[[#List.Sort|List.Sort]]'' sort]<br /> | |||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 4,061: | Line 4,344: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# ''array[ [[#PVR.Details.Channel|PVR.Details.Channel]] ]'' channels<br /> | |||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the channel list", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "PVR.ChannelGroup.Id", | |||
"name": "channelgroupid", | "name": "channelgroupid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"name": "properties", | "$ref": "PVR.Fields.Channel", | ||
"$ref": " | "name": "properties" | ||
}, | |||
{ | |||
"$ref": "List.Limits", | |||
"name": "limits" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"channels": { | |||
"items": { | |||
"$ref": "PVR.Details.Channel" | |||
}, | |||
"required": true, | |||
"type": "array" | |||
}, | |||
"limits": { | "limits": { | ||
"$ref": "List.LimitsReturned", | "$ref": "List.LimitsReturned", | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== PVR. | ==== PVR.GetClients ==== | ||
Retrieves the | Retrieves the enabled PVR clients and their capabilities<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
'''Type:''' ''[[#PVR. | '''Type:''' ''object''<br /> | ||
'''Properties:''' | |||
# ''array[ [[#PVR.Details.Client|PVR.Details.Client]] ]'' clients<br /> | |||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the values of the given properties", | ||
"params": [ | "params": [ | ||
{ | { | ||
"items": { | |||
"$ref": "PVR.Property.Name" | |||
}, | |||
"name": "properties", | "name": "properties", | ||
"required": true, | |||
"type": "array", | "type": "array", | ||
"uniqueItems": true | "uniqueItems": true | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"$ref": "PVR.Property.Value", | "$ref": "PVR.Property.Value" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,153: | Line 4,481: | ||
# [''[[#PVR.Details.Recording|PVR.Details.Recording]]'' recordingdetails]<br /> | # [''[[#PVR.Details.Recording|PVR.Details.Recording]]'' recordingdetails]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the details of a specific recording", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"name": "recordingid", | "name": "recordingid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "PVR.Fields.Recording", | ||
" | "name": "properties" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"recordingdetails": { | "recordingdetails": { | ||
"$ref": "PVR.Details.Recording" | "$ref": "PVR.Details.Recording" | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,188: | Line 4,515: | ||
# [''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties]<br /> | # [''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties]<br /> | ||
# [''[[#List.Limits|List.Limits]]'' limits]<br /> | # [''[[#List.Limits|List.Limits]]'' limits]<br /> | ||
# [''[[#List.Sort|List.Sort]]'' sort]<br /> | |||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 4,194: | Line 4,522: | ||
'''Properties:''' | '''Properties:''' | ||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
# ''array[[#PVR.Details.Recording|PVR.Details.Recording]]'' recordings<br /> | # ''array[ [[#PVR.Details.Recording|PVR.Details.Recording]] ]'' recordings<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the recordings", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "properties", | "$ref": "PVR.Fields.Recording", | ||
"$ref": " | "name": "properties" | ||
}, | |||
{ | |||
"$ref": "List.Limits", | |||
"name": "limits" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"limits": { | "limits": { | ||
Line 4,220: | Line 4,549: | ||
}, | }, | ||
"recordings": { | "recordings": { | ||
"items": { | "items": { | ||
"$ref": "PVR.Details.Recording" | "$ref": "PVR.Details.Recording" | ||
} | }, | ||
"required": true, | |||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,245: | Line 4,576: | ||
# [''[[#PVR.Details.Timer|PVR.Details.Timer]]'' timerdetails]<br /> | # [''[[#PVR.Details.Timer|PVR.Details.Timer]]'' timerdetails]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the details of a specific timer", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"name": "timerid", | "name": "timerid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "PVR.Fields.Timer", | ||
" | "name": "properties" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"timerdetails": { | "timerdetails": { | ||
"$ref": "PVR.Details.Timer" | "$ref": "PVR.Details.Timer" | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,280: | Line 4,610: | ||
# [''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties]<br /> | # [''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties]<br /> | ||
# [''[[#List.Limits|List.Limits]]'' limits]<br /> | # [''[[#List.Limits|List.Limits]]'' limits]<br /> | ||
# [''[[#List.Sort|List.Sort]]'' sort]<br /> | |||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 4,286: | Line 4,617: | ||
'''Properties:''' | '''Properties:''' | ||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
# ''array[[#PVR.Details.Timer|PVR.Details.Timer]]'' timers<br /> | # ''array[ [[#PVR.Details.Timer|PVR.Details.Timer]] ]'' timers<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the timers", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "properties", | "$ref": "PVR.Fields.Timer", | ||
"$ref": " | "name": "properties" | ||
}, | |||
{ | |||
"$ref": "List.Limits", | |||
"name": "limits" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"limits": { | "limits": { | ||
Line 4,312: | Line 4,644: | ||
}, | }, | ||
"timers": { | "timers": { | ||
"items": { | "items": { | ||
"$ref": "PVR.Details.Timer" | "$ref": "PVR.Details.Timer" | ||
} | }, | ||
"required": true, | |||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,335: | Line 4,669: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Toggle recording of a channel", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Global.Toggle", | "$ref": "Global.Toggle", | ||
"default": "toggle" | "default": "toggle", | ||
"name": "record" | |||
}, | }, | ||
{ | { | ||
"default": "current", | |||
"name": "channel", | "name": "channel", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "enums": [ | ||
"current" | "current" | ||
], | ], | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Library.Id" | "$ref": "Library.Id" | ||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPVR", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,372: | Line 4,705: | ||
'''Permissions:''' | '''Permissions:''' | ||
* ControlPVR | * 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:''' | '''Returns:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "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", | "permission": "ControlPVR", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,399: | Line 4,744: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "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": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"description": "the broadcast id of the item to toggle a onetime timer or time rule for", | |||
"name": "broadcastid", | "name": "broadcastid", | ||
"required": true | |||
"required": true | |||
}, | }, | ||
{ | { | ||
"default": false, | |||
"description": "controls whether to create / delete a timer rule or a onetime timer", | |||
"name": "timerrule", | "name": "timerrule", | ||
"type": "boolean | "type": "boolean" | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPVR", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
=== Player === | === Player === | ||
==== Player. | ==== Player.AddSubtitle ==== | ||
Add subtitle to the player<br /> | |||
'''Permissions:''' | '''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:''' | '''Returns:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
'''Type:''' '' | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | ||
"description": " | "params": [ | ||
{ | |||
"$ref": "Player.Id", | |||
" | "name": "playerid", | ||
"returns": { | "required": true | ||
"type": "array", | }, | ||
{ | |||
"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": { | "items": { | ||
"properties": { | "properties": { | ||
"playerid": { | "playerid": { | ||
"$ref": "Player.Id", | "$ref": "Player.Id", | ||
"required": true | "required": true | ||
}, | }, | ||
"playertype": { | "playertype": { | ||
" | "enums": [ | ||
"internal", | "internal", | ||
"external", | "external", | ||
"remote" | "remote" | ||
], | ], | ||
"required": true, | |||
"type": "string" | |||
}, | |||
"type": { | |||
"$ref": "Player.Type", | |||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
} | }, | ||
"type": "array", | |||
"uniqueItems": true | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,481: | Line 4,862: | ||
# ''[[#List.Item.All|List.Item.All]]'' item<br /> | # ''[[#List.Item.All|List.Item.All]]'' item<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the currently played item", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Player.Id", | |||
"name": "playerid", | "name": "playerid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Fields.All", | ||
" | "name": "properties" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"item": { | "item": { | ||
Line 4,505: | Line 4,883: | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,521: | Line 4,901: | ||
'''Type:''' ''array''<br /> | '''Type:''' ''array''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Get a list of available players", | ||
"params": [ | "params": [ | ||
{ | { | ||
" | "default": "all", | ||
" | "enums": [ | ||
"all", | "all", | ||
"video", | "video", | ||
"audio" | "audio" | ||
], | ], | ||
" | "name": "media", | ||
"type": "string" | |||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"items": { | "items": { | ||
"properties": { | "properties": { | ||
"name": { | "name": { | ||
"$ref": "Global.String.NotEmpty", | "$ref": "Global.String.NotEmpty", | ||
"required": true | "required": true | ||
}, | |||
"playsaudio": { | |||
"required": true, | |||
"type": "boolean" | |||
}, | |||
"playsvideo": { | |||
"required": true, | |||
"type": "boolean" | |||
}, | }, | ||
"type": { | "type": { | ||
" | "enums": [ | ||
"internal", | "internal", | ||
"external", | "external", | ||
"remote" | "remote" | ||
], | ], | ||
"required": true | "required": true, | ||
"type": "string" | |||
} | |||
"type": " | }, | ||
"type": "object" | |||
}, | |||
"type": "array", | |||
"uniqueItems": true | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,578: | Line 4,957: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 /> | # ''[[#Player.Id|Player.Id]]'' playerid<br /> | ||
# ''array'' properties<br /> | # ''array[ [[#Player.Property.Name|Player.Property.Name]] ]'' properties<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 4,584: | Line 4,963: | ||
'''Type:''' ''[[#Player.Property.Value|Player.Property.Value]]''<br /> | '''Type:''' ''[[#Player.Property.Value|Player.Property.Value]]''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the values of the given properties", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Player.Id", | |||
"name": "playerid", | "name": "playerid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"items": { | |||
"$ref": "Player.Property.Name" | |||
}, | |||
"name": "properties", | "name": "properties", | ||
"required": true, | |||
"type": "array", | "type": "array", | ||
"uniqueItems": true | "uniqueItems": true | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"$ref": "Player.Property.Value", | "$ref": "Player.Property.Value" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,620: | Line 4,997: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# ''boolean'' nonlinearstretch<br /> | |||
# ''number'' pixelratio<br /> | |||
# ''number'' verticalshift<br /> | |||
# ''[[#Player.ViewMode|Player.ViewMode]]'' viewmode<br /> | # ''[[#Player.ViewMode|Player.ViewMode]]'' viewmode<br /> | ||
# ''number'' zoom<br /> | # ''number'' zoom<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Get view mode of video player", | ||
" | "params": [], | ||
"permission": "ReadData", | "permission": "ReadData", | ||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
" | "nonlinearstretch": { | ||
"required": true, | |||
"required": true | "type": "boolean" | ||
"type": " | |||
}, | }, | ||
"pixelratio": { | "pixelratio": { | ||
" | "required": true, | ||
" | "type": "number" | ||
}, | }, | ||
"verticalshift": { | "verticalshift": { | ||
"type": "number", | "required": true, | ||
"type": "number" | |||
}, | |||
"viewmode": { | |||
"$ref": "Player.ViewMode", | |||
"required": true | "required": true | ||
}, | }, | ||
" | "zoom": { | ||
" | "required": true, | ||
" | "type": "number" | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,673: | Line 5,049: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Go to previous/next/specific item in the playlist", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Player.Id", | |||
"name": "playerid", | "name": "playerid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"name": "to", | "name": "to", | ||
"required": true, | |||
"type": [ | "type": [ | ||
{ | { | ||
" | "enums": [ | ||
"previous", | "previous", | ||
"next" | "next" | ||
], | ], | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Playlist.Position", | "$ref": "Playlist.Position", | ||
"description": "position in playlist" | "description": "position in playlist" | ||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,721: | Line 5,096: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "If picture is zoomed move viewport left/right/up/down otherwise skip previous/next", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Player.Id", | |||
"name": "playerid", | "name": "playerid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "enums": [ | ||
"left", | "left", | ||
"right", | "right", | ||
Line 4,742: | Line 5,112: | ||
"down" | "down" | ||
], | ], | ||
"required": true | "name": "direction", | ||
"required": true, | |||
"type": "string" | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,754: | Line 5,130: | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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'' item]<br /> | # [''mixed: object|[[#Playlist.Item|Playlist.Item]]|object|object|object|object|object'' item]<br /> | ||
# [''object'' options]<br /> | # [''object'' options]<br /> | ||
</div> | </div> | ||
Line 4,761: | Line 5,137: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "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": [ | "params": [ | ||
{ | { | ||
Line 4,772: | Line 5,145: | ||
"type": [ | "type": [ | ||
{ | { | ||
"additionalProperties": false, | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
Line 4,784: | Line 5,155: | ||
"default": 0 | "default": 0 | ||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"$ref": "Playlist.Item" | "$ref": "Playlist.Item" | ||
}, | }, | ||
{ | { | ||
"additionalProperties": false, | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"path": { | "path": { | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
"random": { | "random": { | ||
"default": true, | "default": true, | ||
"description": "Deprecated, use the shuffled property of the options parameter instead" | "description": "Deprecated, use the shuffled property of the options parameter instead", | ||
"type": "boolean" | |||
}, | }, | ||
"recursive": { | "recursive": { | ||
" | "default": true, | ||
" | "type": "boolean" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"additionalProperties": false, | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"partymode": { | "partymode": { | ||
"default": "", | |||
"type": [ | "type": [ | ||
{ | { | ||
" | "enums": [ | ||
"music", | "music", | ||
"video" | "video" | ||
] | ], | ||
"type": "string" | |||
}, | }, | ||
{ | { | ||
" | "description": "Path to a smartplaylist (*.xsp) file", | ||
"minLength": 5, | "minLength": 5, | ||
" | "type": "string" | ||
} | } | ||
] | ] | ||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | |||
{ | |||
"additionalProperties": false, | |||
"properties": { | |||
"broadcastid": { | |||
"$ref": "Library.Id", | |||
"required": true | |||
} | |||
}, | |||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"additionalProperties": false, | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
Line 4,844: | Line 5,220: | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"additionalProperties": false, | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
Line 4,855: | Line 5,230: | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"additionalProperties": false, | |||
"name": "options", | "name": "options", | ||
"properties": { | "properties": { | ||
"playername": { | "playername": { | ||
"default": null, | |||
"type": [ | "type": [ | ||
{ | { | ||
"type": " | "type": "null" | ||
" | }, | ||
{ | |||
"enums": [ | |||
"default" | "default" | ||
], | ], | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
" | "description": "name of player", | ||
"minLength": 1, | "minLength": 1, | ||
" | "type": "string" | ||
} | } | ||
] | ] | ||
}, | }, | ||
"repeat": { | "repeat": { | ||
"default": null, | |||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Player.Repeat" | |||
} | } | ||
] | ] | ||
}, | }, | ||
"resume": { | "resume": { | ||
"default": false, | |||
"type": [ | "type": [ | ||
{ | { | ||
"description": "Whether to resume from the resume point or not", | |||
"type": "boolean" | |||
"description": "Whether to resume from the resume point or not" | |||
}, | }, | ||
{ | { | ||
"$ref": "Player.Position.Percentage", | "$ref": "Player.Position.Percentage", | ||
"description": "Percentage value to start from" | "description": "Percentage value to start from" | ||
}, | }, | ||
{ | { | ||
"$ref": "Player.Position.Time", | "$ref": "Player.Position.Time", | ||
"description": "Time to start from" | "description": "Time to start from" | ||
} | } | ||
], | ] | ||
"default": | }, | ||
"shuffled": { | |||
"$ref": "Optional.Boolean", | |||
"default": null | |||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,935: | Line 5,314: | ||
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br /> | '''Type:''' ''[[#Player.Speed|Player.Speed]]''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Pauses or unpause playback and returns the new state", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Player.Id", | |||
"name": "playerid", | "name": "playerid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"$ref": "Global.Toggle", | "$ref": "Global.Toggle", | ||
"default": "toggle" | "default": "toggle", | ||
"name": "play" | |||
} | } | ||
], | ], | ||
"permission": "ControlPlayback", | |||
"returns": { | "returns": { | ||
"$ref": "Player.Speed" | "$ref": "Player.Speed" | ||
} | }, | ||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 4,971: | Line 5,349: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Rotates current picture", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Player.Id", | |||
"name": "playerid", | "name": "playerid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "default": "clockwise", | ||
" | "enums": [ | ||
"clockwise", | "clockwise", | ||
"counterclockwise" | "counterclockwise" | ||
], | ], | ||
" | "name": "value", | ||
"type": "string" | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,010: | Line 5,389: | ||
'''Properties:''' | '''Properties:''' | ||
# [''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage]<br /> | # [''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage]<br /> | ||
# [''[[#Global.Time|Global.Time]]'' time]<br /> | # [''[[#Global.Time|Global.Time]]'' time] (A duration.)<br /> | ||
# [''[[#Global.Time|Global.Time]]'' totaltime]<br /> | # [''[[#Global.Time|Global.Time]]'' totaltime] (A duration.)<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Seek through the playing item", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Player.Id", | |||
"name": "playerid", | "name": "playerid", | ||
"required": true | "required": true | ||
}, | }, | ||
Line 5,030: | Line 5,406: | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"percentage": { | "percentage": { | ||
"$ref": "Player.Position.Percentage", | "$ref": "Player.Position.Percentage", | ||
"description": "Percentage value to seek to", | |||
"description": "Percentage value to seek to" | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"time": { | "time": { | ||
"$ref": "Player.Position.Time", | "$ref": "Player.Position.Time", | ||
"description": "Time to seek to", | |||
"description": "Time to seek to" | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"step": { | "step": { | ||
" | "description": "Seek by predefined jumps", | ||
" | "enums": [ | ||
"smallforward", | "smallforward", | ||
"smallbackward", | "smallbackward", | ||
Line 5,065: | Line 5,439: | ||
], | ], | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"seconds": { | "seconds": { | ||
" | "description": "Seek by the given number of seconds", | ||
"required": true, | "required": true, | ||
" | "type": "integer" | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"permission": "ControlPlayback", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"percentage": { | "percentage": { | ||
"$ref": "Player.Position.Percentage" | "$ref": "Player.Position.Percentage", | ||
"default": 0.0 | |||
}, | }, | ||
"time": { | "time": { | ||
"$ref": "Global.Time" | "$ref": "Global.Time", | ||
"description": "A duration." | |||
}, | }, | ||
"totaltime": { | "totaltime": { | ||
"$ref": "Global.Time" | "$ref": "Global.Time", | ||
"description": "A duration." | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,115: | Line 5,492: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Set the audio stream played by the player", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Player.Id", | |||
"name": "playerid", | "name": "playerid", | ||
"required": true | "required": true | ||
}, | }, | ||
Line 5,132: | Line 5,506: | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "enums": [ | ||
"previous", | "previous", | ||
"next" | "next" | ||
] | ], | ||
"type": "string" | |||
}, | }, | ||
{ | { | ||
" | "description": "Index of the audio stream to play", | ||
"minimum": 0, | "minimum": 0, | ||
" | "type": "integer" | ||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,162: | Line 5,540: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Turn partymode on or off", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Player.Id", | |||
"name": "playerid", | "name": "playerid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"$ref": "Global.Toggle", | |||
"name": "partymode", | "name": "partymode", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,196: | Line 5,575: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Set the repeat mode of the player", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Player.Id", | |||
"name": "playerid", | "name": "playerid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"name": "repeat", | "name": "repeat", | ||
"required": true, | |||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Player.Repeat" | "$ref": "Player.Repeat" | ||
}, | }, | ||
{ | { | ||
" | "enums": [ | ||
"cycle" | "cycle" | ||
], | ], | ||
" | "type": "string" | ||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,242: | Line 5,620: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Shuffle/Unshuffle items in the player", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Player.Id", | |||
"name": "playerid", | "name": "playerid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"$ref": "Global.Toggle", | |||
"name": "shuffle", | "name": "shuffle", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,276: | Line 5,655: | ||
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br /> | '''Type:''' ''[[#Player.Speed|Player.Speed]]''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Set the speed of the current playback", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Player.Id", | |||
"name": "playerid", | "name": "playerid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"name": "speed", | "name": "speed", | ||
"required": true, | |||
"type": [ | "type": [ | ||
{ | { | ||
" | "enums": [ | ||
-32, | -32, | ||
-16, | -16, | ||
Line 5,308: | Line 5,683: | ||
16, | 16, | ||
32 | 32 | ||
] | ], | ||
"type": "integer" | |||
}, | }, | ||
{ | { | ||
"$ref": "Global.IncrementDecrement" | "$ref": "Global.IncrementDecrement" | ||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"permission": "ControlPlayback", | |||
"returns": { | "returns": { | ||
"$ref": "Player.Speed" | "$ref": "Player.Speed" | ||
} | }, | ||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,337: | Line 5,713: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Set the subtitle displayed by the player", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Player.Id", | |||
"name": "playerid", | "name": "playerid", | ||
"required": true | "required": true | ||
}, | }, | ||
Line 5,354: | Line 5,727: | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "enums": [ | ||
"previous", | "previous", | ||
"next", | "next", | ||
"off", | "off", | ||
"on" | "on" | ||
] | ], | ||
"type": "string" | |||
}, | }, | ||
{ | { | ||
" | "description": "Index of the subtitle to display", | ||
"minimum": 0, | "minimum": 0, | ||
" | "type": "integer" | ||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": false, | |||
"description": "Whether to enable subtitles to be displayed after setting the new subtitle", | |||
"name": "enable", | "name": "enable", | ||
"type": "boolean | "type": "boolean" | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,392: | Line 5,769: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Set the video stream played by the player", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Player.Id", | |||
"name": "playerid", | "name": "playerid", | ||
"required": true | "required": true | ||
}, | }, | ||
Line 5,409: | Line 5,783: | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "enums": [ | ||
"previous", | "previous", | ||
"next" | "next" | ||
] | ], | ||
"type": "string" | |||
}, | }, | ||
{ | { | ||
" | "description": "Index of the video stream to play", | ||
"minimum": 0, | "minimum": 0, | ||
" | "type": "integer" | ||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,438: | Line 5,816: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Set view mode of video player", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "viewmode", | "name": "viewmode", | ||
"required": true, | |||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Player.CustomViewMode", | "$ref": "Player.CustomViewMode", | ||
"description": "Custom view mode" | "description": "Custom view mode" | ||
}, | }, | ||
{ | { | ||
"$ref": "Player.ViewMode" | |||
"$ref": "Player.ViewMode" | |||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,477: | Line 5,853: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | ||
{ | { | ||
"description": "Stops playback", | "description": "Stops playback", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Player.Id", | |||
"name": "playerid", | "name": "playerid", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,506: | Line 5,883: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Zoom current picture", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Player.Id", | |||
"name": "playerid", | "name": "playerid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"name": "zoom", | "name": "zoom", | ||
"required": true, | |||
"type": [ | "type": [ | ||
{ | { | ||
" | "enums": [ | ||
"in", | "in", | ||
"out" | "out" | ||
], | ], | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
" | "description": "zoom level", | ||
"maximum": 10, | |||
"minimum": 1, | "minimum": 1, | ||
" | "type": "integer" | ||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,557: | Line 5,933: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Add item(s) to playlist", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Playlist.Id", | |||
"name": "playlistid", | "name": "playlistid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"name": "item", | "name": "item", | ||
"required": true, | |||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Playlist.Item" | "$ref": "Playlist.Item" | ||
}, | }, | ||
{ | { | ||
"items": { | "items": { | ||
"$ref": "Playlist.Item" | "$ref": "Playlist.Item" | ||
}, | }, | ||
" | "type": "array" | ||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,602: | Line 5,977: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | ||
{ | { | ||
"description": "Clear playlist", | "description": "Clear playlist", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Playlist.Id", | |||
"name": "playlistid", | "name": "playlistid", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,633: | Line 6,009: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# ''array[ [[#List.Item.All|List.Item.All]] ]'' items<br /> | |||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Get all items from playlist", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Playlist.Id", | |||
"name": "playlistid", | "name": "playlistid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Fields.All", | ||
" | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"items": { | "items": { | ||
"items": { | "items": { | ||
"$ref": "List.Item.All" | "$ref": "List.Item.All" | ||
}, | }, | ||
"required": true, | |||
"type": "array" | |||
}, | |||
"limits": { | |||
"$ref": "List.LimitsReturned", | |||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,687: | Line 6,062: | ||
'''Type:''' ''array''<br /> | '''Type:''' ''array''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Returns all existing playlists", | ||
" | "params": [], | ||
"permission": "ReadData", | "permission": "ReadData", | ||
"returns": { | "returns": { | ||
"items": { | "items": { | ||
"properties": { | "properties": { | ||
"playlistid": { | "playlistid": { | ||
Line 5,708: | Line 6,078: | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
} | }, | ||
"type": "array", | |||
"uniqueItems": true | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,720: | Line 6,094: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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.Id|Playlist.Id]]'' playlistid<br /> | ||
# ''array'' properties<br /> | # ''array[ [[#Playlist.Property.Name|Playlist.Property.Name]] ]'' properties<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 5,726: | Line 6,100: | ||
'''Type:''' ''[[#Playlist.Property.Value|Playlist.Property.Value]]''<br /> | '''Type:''' ''[[#Playlist.Property.Value|Playlist.Property.Value]]''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the values of the given properties", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Playlist.Id", | |||
"name": "playlistid", | "name": "playlistid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"items": { | |||
"$ref": "Playlist.Property.Name" | |||
}, | |||
"name": "properties", | "name": "properties", | ||
"required": true, | |||
"type": "array", | "type": "array", | ||
"uniqueItems": true | "uniqueItems": true | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"$ref": "Playlist.Property.Value", | "$ref": "Playlist.Property.Value" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,768: | Line 6,140: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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).", | "description": "Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Playlist.Id", | |||
"name": "playlistid", | "name": "playlistid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"$ref": "Playlist.Position", | |||
"name": "position", | "name": "position", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"name": "item", | "name": "item", | ||
"required": true, | |||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Playlist.Item" | "$ref": "Playlist.Item" | ||
}, | }, | ||
{ | { | ||
"items": { | "items": { | ||
"$ref": "Playlist.Item" | "$ref": "Playlist.Item" | ||
}, | }, | ||
" | "type": "array" | ||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,819: | Line 6,190: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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).", | "description": "Remove item from playlist. Does not work for picture playlists (aka slideshows).", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Playlist.Id", | |||
"name": "playlistid", | "name": "playlistid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"$ref": "Playlist.Position", | |||
"name": "position", | "name": "position", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,854: | Line 6,226: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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).", | "description": "Swap items in the playlist. Does not work for picture playlists (aka slideshows).", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Playlist.Id", | |||
"name": "playlistid", | "name": "playlistid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"$ref": "Playlist.Position", | |||
"name": "position1", | "name": "position1", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"$ref": "Playlist.Position", | |||
"name": "position2", | "name": "position2", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ControlPlayback", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,893: | Line 6,266: | ||
'''Type:''' ''[[#Profiles.Details.Profile|Profiles.Details.Profile]]''<br /> | '''Type:''' ''[[#Profiles.Details.Profile|Profiles.Details.Profile]]''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieve the current profile", | ||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Profiles.Fields.Profile", | ||
" | "name": "properties" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"$ref": "Profiles.Details.Profile", | "$ref": "Profiles.Details.Profile" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,926: | Line 6,297: | ||
'''Properties:''' | '''Properties:''' | ||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
# ''array[[#Profiles.Details.Profile|Profiles.Details.Profile]]'' profiles<br /> | # ''array[ [[#Profiles.Details.Profile|Profiles.Details.Profile]] ]'' profiles<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieve all profiles", | ||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Profiles.Fields.Profile", | ||
" | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"limits": { | "limits": { | ||
Line 5,956: | Line 6,324: | ||
}, | }, | ||
"profiles": { | "profiles": { | ||
"items": { | "items": { | ||
"$ref": "Profiles.Details.Profile" | "$ref": "Profiles.Details.Profile" | ||
} | }, | ||
"required": true, | |||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 5,973: | Line 6,343: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 /> | # ''string'' profile (Profile name)<br /> | ||
# [''boolean'' prompt] (Prompt for password)<br /> | # [''boolean'' prompt = False] (Prompt for password)<br /> | ||
# [''[[#Profiles.Password|Profiles.Password]]'' password]<br /> | # [''[[#Profiles.Password|Profiles.Password]]'' password]<br /> | ||
</div> | </div> | ||
Line 5,980: | Line 6,350: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Load the specified profile", | ||
"params": [ | "params": [ | ||
{ | { | ||
"description": "Profile name", | |||
"name": "profile", | "name": "profile", | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"default": false, | |||
"description": "Prompt for password", | |||
"name": "prompt", | "name": "prompt", | ||
"type": "boolean | "type": "boolean" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Profiles.Password", | ||
" | "name": "password" | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "Navigate", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 6,014: | Line 6,386: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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]]'' level = standard]<br /> | ||
# [''string'' section = ]<br /> | # [''string'' section = ""]<br /> | ||
# [''string'' properties]<br /> | # [''string'' properties]<br /> | ||
</div> | </div> | ||
Line 6,021: | Line 6,393: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''array[[#Setting.Details.Category|Setting.Details.Category]]'' categories]<br /> | # [''array[ [[#Setting.Details.Category|Setting.Details.Category]] ]'' categories]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves all setting categories", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Setting.Level", | "$ref": "Setting.Level", | ||
"default": "standard" | "default": "standard", | ||
"name": "level" | |||
}, | }, | ||
{ | { | ||
"default": "", | |||
"name": "section", | "name": "section", | ||
"type": "string | "type": "string" | ||
}, | }, | ||
{ | { | ||
"extends": "Item.Fields.Base", | "extends": "Item.Fields.Base", | ||
"items": { | "items": { | ||
" | "enums": [ | ||
"settings" | "settings" | ||
] | ], | ||
} | "type": "string" | ||
}, | |||
"name": "properties" | |||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"categories": { | "categories": { | ||
"items": { | "items": { | ||
"$ref": "Setting.Details.Category" | "$ref": "Setting.Details.Category" | ||
} | }, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 6,077: | Line 6,448: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''array[[#Setting.Details.Section|Setting.Details.Section]]'' sections]<br /> | # [''array[ [[#Setting.Details.Section|Setting.Details.Section]] ]'' sections]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves all setting sections", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Setting.Level", | "$ref": "Setting.Level", | ||
"default": "standard" | "default": "standard", | ||
"name": "level" | |||
}, | }, | ||
{ | { | ||
"extends": "Item.Fields.Base", | "extends": "Item.Fields.Base", | ||
"items": { | "items": { | ||
" | "enums": [ | ||
"categories" | "categories" | ||
] | ], | ||
} | "type": "string" | ||
}, | |||
"name": "properties" | |||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"sections": { | "sections": { | ||
"items": { | "items": { | ||
"$ref": "Setting.Details.Section" | "$ref": "Setting.Details.Section" | ||
} | }, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 6,129: | Line 6,499: | ||
# ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value<br /> | # ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the value of a setting", | ||
"params": [ | "params": [ | ||
{ | { | ||
"minLength": 1, | |||
"name": "setting", | "name": "setting", | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"value": { | "value": { | ||
Line 6,150: | Line 6,517: | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 6,161: | Line 6,530: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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]]'' level = standard]<br /> | ||
# [''mixed: object'' filter | # [''mixed: object'' filter]<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 6,167: | Line 6,536: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''array[[#Setting.Details.Setting|Setting.Details.Setting]]'' settings]<br /> | # [''array[ [[#Setting.Details.Setting|Setting.Details.Setting]] ]'' settings]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves all settings", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Setting.Level", | "$ref": "Setting.Level", | ||
"default": "standard" | "default": "standard", | ||
"name": "level" | |||
}, | }, | ||
{ | { | ||
Line 6,185: | Line 6,551: | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
" | "category": { | ||
" | "minLength": 1, | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
" | "section": { | ||
" | "minLength": 1, | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"settings": { | "settings": { | ||
"items": { | "items": { | ||
"$ref": "Setting.Details.Setting" | "$ref": "Setting.Details.Setting" | ||
} | }, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 6,221: | Line 6,587: | ||
Resets the value of a setting<br /> | Resets the value of a setting<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
Line 6,230: | Line 6,596: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Resets the value of a setting", | ||
"params": [ | "params": [ | ||
{ | { | ||
"minLength": 1, | |||
"name": "setting", | "name": "setting", | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "ReadData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 6,250: | Line 6,617: | ||
Changes the value of a setting<br /> | Changes the value of a setting<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
Line 6,260: | Line 6,627: | ||
'''Type:''' ''boolean''<br /> | '''Type:''' ''boolean''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Changes the value of a setting", | ||
"params": [ | "params": [ | ||
{ | { | ||
"minLength": 1, | |||
"name": "setting", | "name": "setting", | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Value.Extended", | |||
"name": "value", | "name": "value", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"returns": "boolean" | "permission": "ReadData", | ||
"returns": { | |||
"type": "boolean" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 6,291: | Line 6,659: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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)", | "description": "Ejects or closes the optical disc drive (if available)", | ||
" | "params": [], | ||
"permission": "ControlSystem", | "permission": "ControlSystem", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 6,307: | Line 6,676: | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# ''array'' properties<br /> | # ''array[ [[#System.Property.Name|System.Property.Name]] ]'' properties<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 6,313: | Line 6,682: | ||
'''Type:''' ''[[#System.Property.Value|System.Property.Value]]''<br /> | '''Type:''' ''[[#System.Property.Value|System.Property.Value]]''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieves the values of the given properties", | ||
"params": [ | "params": [ | ||
{ | { | ||
"items": { | |||
"$ref": "System.Property.Name" | |||
}, | |||
"name": "properties", | "name": "properties", | ||
"required": true, | |||
"type": "array", | "type": "array", | ||
"uniqueItems": true | "uniqueItems": true | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"$ref": "System.Property.Value", | "$ref": "System.Property.Value" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 6,344: | Line 6,711: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Puts the system running Kodi into hibernate mode", | ||
" | "params": [], | ||
"permission": "ControlPower", | "permission": "ControlPower", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 6,362: | Line 6,730: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Reboots the system running Kodi", | ||
" | "params": [], | ||
"permission": "ControlPower", | "permission": "ControlPower", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 6,380: | Line 6,749: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Shuts the system running Kodi down", | ||
" | "params": [], | ||
"permission": "ControlPower", | "permission": "ControlPower", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 6,398: | Line 6,768: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Suspends the system running Kodi", | ||
" | "params": [], | ||
"permission": "ControlPower", | "permission": "ControlPower", | ||
" | "returns": { | ||
" | "type": "string" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 6,422: | Line 6,793: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# ''array[[#Textures.Details.Texture|Textures.Details.Texture]]'' textures<br /> | # ''array[ [[#Textures.Details.Texture|Textures.Details.Texture]] ]'' textures<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieve all textures", | ||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Textures.Fields.Texture", | ||
" | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Filter.Textures", | ||
" | "name": "filter" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"textures": { | "textures": { | ||
"items": { | "items": { | ||
"$ref": "Textures.Details.Texture" | "$ref": "Textures.Details.Texture" | ||
} | }, | ||
"required": true, | |||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 6,466: | Line 6,836: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Remove the specified texture", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"description": "Texture database identifier", | |||
"name": "textureid", | "name": "textureid", | ||
"required": true | |||
"required": true | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "RemoveData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 6,492: | Line 6,863: | ||
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br /> | # [''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'' 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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 6,497: | Line 6,869: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Cleans the video library for non-existent items", | ||
"params": [ | "params": [ | ||
{ | { | ||
"default": true, | |||
"description": "Whether or not to show the progress bar or any other GUI dialog", | |||
"name": "showdialogs", | "name": "showdialogs", | ||
"type": "boolean | "type": "boolean" | ||
}, | }, | ||
{ | { | ||
"default": "video", | "default": "video", | ||
" | "description": "Content type to clean for", | ||
"enums": [ | |||
"video", | "video", | ||
"movies", | "movies", | ||
Line 6,520: | Line 6,888: | ||
"musicvideos" | "musicvideos" | ||
], | ], | ||
"description": " | "name": "content", | ||
"type": "string" | |||
}, | |||
{ | |||
"default": "", | |||
"description": "Path to the directory to clean up; performs a global cleanup if not specified", | |||
"name": "directory", | |||
"type": "string" | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "RemoveData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 6,538: | Line 6,917: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Exports all items from the video library", | ||
"params": [ | "params": [ | ||
{ | { | ||
Line 6,549: | Line 6,925: | ||
"type": [ | "type": [ | ||
{ | { | ||
"additionalProperties": false, | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"path": { | "path": { | ||
" | "description": "Path to the directory to where the data should be exported", | ||
"minLength": 1, | |||
"required": true, | "required": true, | ||
" | "type": "string" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"additionalProperties": false, | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
" | "actorthumbs": { | ||
"default": false, | "default": false, | ||
"description": "Whether to | "description": "Whether to export actor thumbnails", | ||
"type": "boolean" | |||
}, | }, | ||
"images": { | "images": { | ||
"default": false, | "default": false, | ||
"description": "Whether to export thumbnails and fanart images" | "description": "Whether to export thumbnails and fanart images", | ||
"type": "boolean" | |||
}, | }, | ||
" | "overwrite": { | ||
"default": false, | "default": false, | ||
"description": "Whether to | "description": "Whether to overwrite existing exported files", | ||
"type": "boolean" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"permission": "WriteFile", | |||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
"permission": " | |||
" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.GetAvailableArt ==== | ||
Retrieve all | Retrieve all potential art URLs for a media item by art type<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 6,648: | Line 6,980: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# | # ''array'' availableart<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve all | |||
"params": [ | "params": [ | ||
{ | { | ||
"name": " | "name": "item", | ||
" | "required": true, | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
" | "episodeid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
" | "tvshowid": { | ||
" | "$ref": "Library.Id", | ||
"required": true | |||
"required": true | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
" | "seasonid": { | ||
" | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
" | "movieid": { | ||
" | "$ref": "Library.Id", | ||
"required": true | |||
"required": true | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
" | "setid": { | ||
" | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
"$ref": " | "additionalProperties": false, | ||
"properties": { | |||
"musicvideoid": { | |||
"$ref": "Library.Id", | |||
"required": true | |||
} | |||
}, | |||
"type": "object" | |||
} | } | ||
] | ] | ||
}, | |||
{ | |||
"default": "", | |||
"name": "arttype", | |||
"type": "string" | |||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
" | "availableart": { | ||
"items": { | "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>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.GetAvailableArtTypes ==== | ||
Retrieve | Retrieve a list of potential art types for a media item<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 6,778: | Line 7,102: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# ''array'' availablearttypes<br /> | |||
# ''array | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve | |||
"params": [ | "params": [ | ||
{ | { | ||
"name": " | "name": "item", | ||
"required": true, | "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": { | "returns": { | ||
"properties": { | "properties": { | ||
" | "availablearttypes": { | ||
" | "items": { | ||
"type": "string" | |||
}, | |||
"required": true, | "required": true, | ||
" | "type": "array" | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.GetEpisodeDetails ==== | ||
Retrieve | Retrieve details about a specific tv show episode<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 6,843: | Line 7,204: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''[[#Video.Details.Episode|Video.Details.Episode]]'' episodedetails]<br /> | |||
# ['' | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve | |||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Library.Id", | ||
" | "name": "episodeid", | ||
"required": true | |||
}, | }, | ||
{ | { | ||
"$ref": "Video.Fields.Episode", | |||
"$ref": " | "name": "properties" | ||
"name": " | |||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
" | "episodedetails": { | ||
"$ref": "Video.Details.Episode" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.GetEpisodes ==== | ||
Retrieve | Retrieve all tv show episodes<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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]]'' | # [''[[#Library.Id|Library.Id]]'' tvshowid = -1]<br /> | ||
# [''[[#Video.Fields. | # [''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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 6,896: | Line 7,249: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''[[#Video.Details. | # [''array[ [[#Video.Details.Episode|Video.Details.Episode]] ]'' episodes]<br /> | ||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve | |||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | "$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": " | "name": "filter", | ||
"$ref": " | "type": [ | ||
{ | |||
"additionalProperties": false, | |||
"properties": { | |||
"genreid": { | |||
"properties": { | "$ref": "Library.Id", | ||
" | "description": "Requires tvshowid to be set", | ||
"$ref": "Video.Details. | "required": true | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
} | }, | ||
</syntaxhighlight>}} | { | ||
==== VideoLibrary. | "additionalProperties": false, | ||
Retrieve | "properties": { | ||
'''Permissions:''' | "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 | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# ''[[#Library. | # ''string'' type<br /> | ||
# [''[[# | # [''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties]<br /> | ||
# ['' | # [''[[#List.Limits|List.Limits]]'' limits]<br /> | ||
# [''[[#List.Sort|List.Sort]]'' sort]<br /> | |||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 6,939: | Line 7,379: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# | # ''array[ [[#Library.Details.Genre|Library.Details.Genre]] ]'' genres<br /> | ||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve | |||
"params": [ | "params": [ | ||
{ | { | ||
"name": " | "enums": [ | ||
"$ref": "Library. | "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": { | "returns": { | ||
"properties": { | "properties": { | ||
" | "genres": { | ||
"$ref": " | "items": { | ||
"$ref": "Library.Details.Genre" | |||
}, | |||
"required": true, | |||
"type": "array" | |||
}, | |||
"limits": { | |||
"$ref": "List.LimitsReturned", | |||
"required": true | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.GetInProgressTVShows ==== | ||
Retrieve all | Retrieve all in progress tvshows<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# [''[[#Video.Fields. | # [''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties]<br /> | ||
# [''[[#List.Limits|List.Limits]]'' limits]<br /> | # [''[[#List.Limits|List.Limits]]'' limits]<br /> | ||
# [''[[#List.Sort|List.Sort]]'' sort]<br /> | # [''[[#List.Sort|List.Sort]]'' sort]<br /> | ||
Line 6,998: | Line 7,444: | ||
'''Properties:''' | '''Properties:''' | ||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
# [''array[[#Video.Details. | # [''array[ [[#Video.Details.TVShow|Video.Details.TVShow]] ]'' tvshows]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve all | |||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Video.Fields.TVShow", | ||
" | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"limits": { | "limits": { | ||
Line 7,027: | Line 7,470: | ||
"required": true | "required": true | ||
}, | }, | ||
" | "tvshows": { | ||
"items": { | "items": { | ||
"$ref": "Video.Details. | "$ref": "Video.Details.TVShow" | ||
} | }, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.GetMovieDetails ==== | ||
Retrieve | Retrieve details about a specific movie<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 /> | # [''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties]<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 7,052: | Line 7,495: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''[[#Video.Details.Movie|Video.Details.Movie]]'' moviedetails]<br /> | |||
# ['' | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve | |||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Library.Id", | ||
" | "name": "movieid", | ||
"required": true | |||
}, | }, | ||
{ | { | ||
"name": " | "$ref": "Video.Fields.Movie", | ||
"$ref": " | "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": " | "name": "movies", | ||
"properties": { | |||
"limits": { | |||
"$ref": "List.Limits" | |||
}, | }, | ||
"properties": { | |||
"$ref": "Video.Fields.Movie" | |||
}, | }, | ||
"sort": { | |||
"$ref": "List.Sort" | |||
} | |||
}, | |||
"type": "object" | |||
} | |||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
" | "setdetails": { | ||
"$ref": " | "$ref": "Video.Details.MovieSet.Extended" | ||
} | |||
}, | |||
"type": "object" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.GetMovieSets ==== | ||
Retrieve | Retrieve all movie sets<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 7,221: | Line 7,594: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''[[#Video.Details. | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
# [''array[ [[#Video.Details.MovieSet|Video.Details.MovieSet]] ]'' sets]<br /> | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve | |||
"params": [ | "params": [ | ||
{ | { | ||
"name": " | "$ref": "Video.Fields.MovieSet", | ||
"$ref": " | "name": "properties" | ||
" | }, | ||
{ | |||
"$ref": "List.Limits", | |||
"name": "limits" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
" | "limits": { | ||
"$ref": "Video.Details. | "$ref": "List.LimitsReturned", | ||
"required": true | |||
}, | |||
"sets": { | |||
"items": { | |||
"$ref": "Video.Details.MovieSet" | |||
}, | |||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.GetMovies ==== | ||
Retrieve all | Retrieve all movies<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# [''[[#Video.Fields. | # [''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties]<br /> | ||
# [''[[#List.Limits|List.Limits]]'' limits]<br /> | # [''[[#List.Limits|List.Limits]]'' limits]<br /> | ||
# [''[[#List.Sort|List.Sort]]'' sort]<br /> | # [''[[#List.Sort|List.Sort]]'' sort]<br /> | ||
# [''mixed: object|object|object|object|object|object|object|[[#List.Filter. | # [''mixed: object|object|object|object|object|object|object|object|object|object|[[#List.Filter.Movies|List.Filter.Movies]]'' filter]<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 7,266: | Line 7,649: | ||
'''Properties:''' | '''Properties:''' | ||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
# [''array[[#Video.Details. | # [''array[ [[#Video.Details.Movie|Video.Details.Movie]] ]'' movies]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve all | |||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Video.Fields.Movie", | ||
" | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
}, | }, | ||
{ | { | ||
Line 7,291: | Line 7,671: | ||
"type": [ | "type": [ | ||
{ | { | ||
"additionalProperties": false, | |||
"additionalProperties": false | |||
"properties": { | "properties": { | ||
"genreid": { | "genreid": { | ||
Line 7,309: | Line 7,678: | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"genre": { | "genre": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"year": { | "year": { | ||
"minimum": 0, | "minimum": 0, | ||
"required": true | "required": true, | ||
"type": "integer" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
"type": "object", | "additionalProperties": false, | ||
"properties": { | |||
"actor": { | |||
"minLength": 1, | |||
"required": true, | |||
"type": "string" | |||
} | |||
}, | |||
"type": "object" | |||
}, | |||
{ | |||
"additionalProperties": false, | |||
"properties": { | "properties": { | ||
"director": { | "director": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"studio": { | "studio": { | ||
"minLength": 1, | "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 | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
"type": "object", | "additionalProperties": false, | ||
"properties": { | |||
"set": { | |||
"minLength": 1, | |||
"required": true, | |||
"type": "string" | |||
} | |||
}, | |||
"type": "object" | |||
}, | |||
{ | |||
"additionalProperties": false, | |||
"properties": { | "properties": { | ||
"tag": { | "tag": { | ||
"minLength": 1, | "minLength": 1, | ||
"required": true | "required": true, | ||
"type": "string" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
"$ref": "List.Filter. | "$ref": "List.Filter.Movies" | ||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"limits": { | "limits": { | ||
Line 7,379: | Line 7,791: | ||
"required": true | "required": true | ||
}, | }, | ||
" | "movies": { | ||
"items": { | "items": { | ||
"$ref": "Video.Details. | "$ref": "Video.Details.Movie" | ||
} | }, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.GetMusicVideoDetails ==== | ||
Retrieve | Retrieve details about a specific music video<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 7,403: | Line 7,816: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]'' musicvideodetails]<br /> | |||
# ['' | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve | |||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"$ref": " | "name": "musicvideoid", | ||
"required": true | |||
"name": " | |||
" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "Video.Fields.MusicVideo", | ||
" | "name": "properties" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
" | "musicvideodetails": { | ||
"$ref": "Video.Details.MusicVideo" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.GetMusicVideos ==== | ||
Retrieve all | Retrieve all music videos<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# [''[[#Video.Fields. | # [''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties]<br /> | ||
# [''[[#List.Limits|List.Limits]]'' limits]<br /> | # [''[[#List.Limits|List.Limits]]'' limits]<br /> | ||
# [''[[#List.Sort|List.Sort]]'' sort]<br /> | # [''[[#List.Sort|List.Sort]]'' sort]<br /> | ||
# [''mixed: object|object|object|object|object|object|object|[[#List.Filter.MusicVideos|List.Filter.MusicVideos]]'' filter]<br /> | |||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 7,458: | Line 7,860: | ||
'''Properties:''' | '''Properties:''' | ||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
# [''array[[#Video.Details. | # [''array[ [[#Video.Details.MusicVideo|Video.Details.MusicVideo]] ]'' musicvideos]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve all | |||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Video.Fields.MusicVideo", | ||
" | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
}, | }, | ||
{ | { | ||
"$ref": "List.Sort", | |||
"$ref": "List.Sort | "name": "sort" | ||
" | |||
}, | }, | ||
{ | { | ||
"name": " | "name": "filter", | ||
"$ref": " | "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": { | "returns": { | ||
"properties": { | "properties": { | ||
"limits": { | "limits": { | ||
Line 7,542: | Line 7,971: | ||
}, | }, | ||
"musicvideos": { | "musicvideos": { | ||
"items": { | "items": { | ||
"$ref": "Video.Details.MusicVideo" | "$ref": "Video.Details.MusicVideo" | ||
} | }, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.GetRecentlyAddedEpisodes ==== | ||
Retrieve | Retrieve all recently added tv episodes<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 7,564: | Line 7,996: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''[[#Video.Details. | # [''array[ [[#Video.Details.Episode|Video.Details.Episode]] ]'' episodes]<br /> | ||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve | |||
"params": [ | "params": [ | ||
{ | { | ||
"name": " | "$ref": "Video.Fields.Episode", | ||
"$ref": " | "name": "properties" | ||
" | }, | ||
{ | |||
"$ref": "List.Limits", | |||
"name": "limits" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
" | "episodes": { | ||
"$ref": "Video.Details. | "items": { | ||
"$ref": "Video.Details.Episode" | |||
}, | |||
"type": "array" | |||
}, | |||
"limits": { | |||
"$ref": "List.LimitsReturned", | |||
"required": true | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.GetRecentlyAddedMovies ==== | ||
Retrieve all | Retrieve all recently added movies<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 /> | |||
# [''[[#Video.Fields. | |||
# [''[[#List.Limits|List.Limits]]'' limits]<br /> | # [''[[#List.Limits|List.Limits]]'' limits]<br /> | ||
# [''[[#List.Sort|List.Sort]]'' sort]<br /> | # [''[[#List.Sort|List.Sort]]'' sort]<br /> | ||
Line 7,609: | Line 8,050: | ||
'''Properties:''' | '''Properties:''' | ||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
# [''array[[#Video.Details. | # [''array[ [[#Video.Details.Movie|Video.Details.Movie]] ]'' movies]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve all | |||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Video.Fields.Movie", | ||
" | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
}, | }, | ||
{ | { | ||
"$ref": "List.Sort", | |||
"$ref": "List. | "name": "sort" | ||
"name": "sort | |||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
"limits": { | "limits": { | ||
Line 7,642: | Line 8,076: | ||
"required": true | "required": true | ||
}, | }, | ||
" | "movies": { | ||
"items": { | "items": { | ||
"$ref": "Video.Details. | "$ref": "Video.Details.Movie" | ||
} | }, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.GetRecentlyAddedMusicVideos ==== | ||
Retrieve | Retrieve all recently added music videos<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 7,665: | Line 8,102: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# [''[[#Video.Details. | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
# [''array[ [[#Video.Details.MusicVideo|Video.Details.MusicVideo]] ]'' musicvideos]<br /> | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "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": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"name": "seasonid", | |||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Video.Fields.Season", | ||
" | "name": "properties" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
" | "seasondetails": { | ||
"$ref": "Video.Details. | "$ref": "Video.Details.Season" | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.GetSeasons ==== | ||
Retrieve all tv | Retrieve all tv seasons<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# [''[[#Video.Fields. | # [''[[#Library.Id|Library.Id]]'' tvshowid = -1]<br /> | ||
# [''[[#Video.Fields.Season|Video.Fields.Season]]'' properties]<br /> | |||
# [''[[#List.Limits|List.Limits]]'' limits]<br /> | # [''[[#List.Limits|List.Limits]]'' limits]<br /> | ||
# [''[[#List.Sort|List.Sort]]'' sort]<br /> | # [''[[#List.Sort|List.Sort]]'' sort]<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 7,710: | Line 8,198: | ||
'''Properties:''' | '''Properties:''' | ||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | # ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | ||
# [''array[[#Video.Details. | # [''array[ [[#Video.Details.Season|Video.Details.Season]] ]'' seasons]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve all tv | |||
"params": [ | "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": { | |||
"returns": { | |||
"properties": { | "properties": { | ||
"limits": { | "limits": { | ||
Line 7,812: | Line 8,229: | ||
"required": true | "required": true | ||
}, | }, | ||
" | "seasons": { | ||
"items": { | "items": { | ||
"$ref": "Video.Details. | "$ref": "Video.Details.Season" | ||
} | }, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.GetTVShowDetails ==== | ||
Retrieve | Retrieve details about a specific tv show<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 7,837: | Line 8,254: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
# | # [''[[#Video.Details.TVShow|Video.Details.TVShow]]'' tvshowdetails]<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Retrieve | |||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"name": "tvshowid", | |||
"required": true | |||
"$ref": "Library. | |||
"name": " | |||
" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "Video.Fields.TVShow", | ||
" | "name": "properties" | ||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"properties": { | "properties": { | ||
" | "tvshowdetails": { | ||
"$ref": " | "$ref": "Video.Details.TVShow" | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.GetTVShows ==== | ||
Retrieve all tv shows<br /> | |||
'''Permissions:''' | '''Permissions:''' | ||
* | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
'''Type:''' '' | '''Type:''' ''object''<br /> | ||
'''Properties:''' | |||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | |||
# [''array[ [[#Video.Details.TVShow|Video.Details.TVShow]] ]'' tvshows]<br /> | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": " | |||
"params": [ | "params": [ | ||
{ | { | ||
"name": " | "$ref": "Video.Fields.TVShow", | ||
"$ref": " | "name": "properties" | ||
" | }, | ||
{ | |||
"$ref": "List.Limits", | |||
"name": "limits" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "filter", | ||
"type": " | "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" | ||
} | } | ||
</syntaxhighlight>}} | }, | ||
==== VideoLibrary. | "type": "object" | ||
}, | |||
'''Permissions:''' | { | ||
* | "additionalProperties": false, | ||
'''Parameters:''' | "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"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# ''[[#Library. | # ''string'' type<br /> | ||
# '' | # [''[[#Library.Fields.Tag|Library.Fields.Tag]]'' properties]<br /> | ||
# '' | # [''[[#List.Limits|List.Limits]]'' limits]<br /> | ||
# [''[[#List.Sort|List.Sort]]'' sort]<br /> | |||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
'''Type:''' '' | '''Type:''' ''object''<br /> | ||
'''Properties:''' | |||
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /> | |||
# ''array[ [[#Library.Details.Tag|Library.Details.Tag]] ]'' tags<br /> | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": " | |||
"params": [ | "params": [ | ||
{ | { | ||
"name": " | "enums": [ | ||
"$ref": "Library. | "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" | ||
} | } | ||
], | ], | ||
"returns": " | "permission": "ReadData", | ||
} | "returns": { | ||
</syntaxhighlight>}} | "properties": { | ||
==== VideoLibrary. | "limits": { | ||
Refresh the given | "$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:''' | '''Permissions:''' | ||
* UpdateData | * UpdateData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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]]'' | # ''[[#Library.Id|Library.Id]]'' episodeid<br /> | ||
# ''boolean'' ignorenfo = False (Whether or not to ignore a local NFO if present.)<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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 8,035: | Line 8,488: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Refresh the given | |||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"name": "episodeid", | |||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"default": false, | |||
"description": "Whether or not to ignore a local NFO if present.", | |||
"name": "ignorenfo", | "name": "ignorenfo", | ||
"type": "boolean | "type": "boolean" | ||
}, | }, | ||
{ | { | ||
"default": "", | |||
"description": "Title to use for searching (instead of determining it from the item's filename/path).", | |||
"name": "title", | "name": "title", | ||
"type": "string | "type": "string" | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "UpdateData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.RefreshMovie ==== | ||
Refresh the given movie in the library<br /> | |||
'''Permissions:''' | '''Permissions:''' | ||
* | * UpdateData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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]]'' | # ''[[#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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 8,084: | Line 8,531: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": " | |||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"name": "movieid", | |||
"required": true | "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" | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "UpdateData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.RefreshMusicVideo ==== | ||
Refresh the given music video in the library<br /> | |||
'''Permissions:''' | '''Permissions:''' | ||
* | * UpdateData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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]]'' | # ''[[#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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 8,112: | Line 8,574: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": " | |||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"name": "musicvideoid", | |||
"required": true | "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" | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "UpdateData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.RefreshTVShow ==== | ||
Refresh the given tv show in the library<br /> | |||
'''Permissions:''' | '''Permissions:''' | ||
* | * UpdateData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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]]'' | # ''[[#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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 8,140: | Line 8,618: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": " | |||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"name": "tvshowid", | |||
"required": true | "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" | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "UpdateData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.RemoveEpisode ==== | ||
Removes the given | Removes the given episode from the library<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* RemoveData | * RemoveData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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]]'' | # ''[[#Library.Id|Library.Id]]'' episodeid<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 8,168: | Line 8,665: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": "Removes the given | |||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"name": "episodeid", | |||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "RemoveData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.RemoveMovie ==== | ||
Removes the given movie from the library<br /> | |||
'''Permissions:''' | '''Permissions:''' | ||
* | * RemoveData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 8,197: | Line 8,694: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": " | |||
"params": [ | "params": [ | ||
{ | { | ||
"name": " | "$ref": "Library.Id", | ||
"type": "string", | "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 | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "RemoveData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== VideoLibrary. | ==== VideoLibrary.RemoveTVShow ==== | ||
Removes the given tv show from the library<br /> | |||
'''Permissions:''' | '''Permissions:''' | ||
* | * RemoveData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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]]'' | # ''[[#Library.Id|Library.Id]]'' tvshowid<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 8,253: | Line 8,752: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | |||
"description": " | |||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"name": "tvshowid", | |||
"required": true | "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" | |||
"name": " | } | ||
" | ], | ||
}, | "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 /> | |||
"name": " | # [''[[#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" | |||
}, | }, | ||
{ | { | ||
"name": " | "default": null, | ||
"name": "director", | |||
"type": [ | "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" | |||
}, | }, | ||
{ | { | ||
"name": " | "default": null, | ||
"$ref": " | "name": "writer", | ||
"type": [ | |||
{ | |||
"type": "null" | |||
}, | |||
{ | |||
"$ref": "Array.String" | |||
} | |||
] | |||
}, | }, | ||
{ | { | ||
"name": " | "$ref": "Optional.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", | "name": "art", | ||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Media.Artwork.Set" | "type": "null" | ||
}, | |||
{ | |||
"$ref": "Media.Artwork.Set" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "resume", | "name": "resume", | ||
"type": [ | "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", | "name": "uniqueid", | ||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Media.UniqueID.Set" | "type": "null" | ||
}, | |||
{ | |||
"$ref": "Media.UniqueID.Set" | |||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "UpdateData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 8,400: | Line 9,008: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 /> | # ''[[#Library.Id|Library.Id]]'' movieid<br /> | ||
# [''[[#Optional.String|Optional.String]]'' title]<br /> | # [''[[#Optional.String|Optional.String]]'' title = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' playcount]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' runtime] (Runtime in seconds)<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' director = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' director = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' studio = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' studio = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' year] (linked with premiered. Overridden by premiered parameter)<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' year = None] (linked with premiered. Overridden by premiered parameter)<br /> | ||
# [''[[#Optional.String|Optional.String]]'' plot]<br /> | # [''[[#Optional.String|Optional.String]]'' plot = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' genre = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br /> | ||
# [''[[#Optional.Number|Optional.Number]]'' rating]<br /> | # [''[[#Optional.Number|Optional.Number]]'' rating = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' mpaa]<br /> | # [''[[#Optional.String|Optional.String]]'' mpaa = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' imdbnumber]<br /> | # [''[[#Optional.String|Optional.String]]'' imdbnumber = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' votes]<br /> | # [''[[#Optional.String|Optional.String]]'' votes = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' lastplayed]<br /> | # [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' originaltitle]<br /> | # [''[[#Optional.String|Optional.String]]'' originaltitle = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' trailer]<br /> | # [''[[#Optional.String|Optional.String]]'' trailer = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' tagline]<br /> | # [''[[#Optional.String|Optional.String]]'' tagline = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' plotoutline]<br /> | # [''[[#Optional.String|Optional.String]]'' plotoutline = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' writer = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' writer = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' country = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' country = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' top250]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' top250 = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' sorttitle]<br /> | # [''[[#Optional.String|Optional.String]]'' sorttitle = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' set]<br /> | # [''[[#Optional.String|Optional.String]]'' set = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' showlink = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' showlink = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' thumbnail]<br /> | # [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' fanart]<br /> | # [''[[#Optional.String|Optional.String]]'' fanart = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' tag = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' tag = None]<br /> | ||
# [''mixed: [[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /> | # [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /> | ||
# [''mixed: [[#Video.Resume|Video.Resume]]'' resume = None]<br /> | # [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' userrating]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br /> | ||
# [''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings]<br /> | # [''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' dateadded]<br /> | # [''[[#Optional.String|Optional.String]]'' dateadded = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' premiered] (linked with year. Overrides year)<br /> | # [''[[#Optional.String|Optional.String]]'' premiered = None] (linked with year. Overrides year)<br /> | ||
# [''mixed: [[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br /> | # [''mixed: null|[[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 8,438: | Line 9,046: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Update the given movie with the given details", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"name": "movieid", | "name": "movieid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "title" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.Integer", | ||
" | "default": null, | ||
"name": "playcount" | |||
}, | }, | ||
{ | { | ||
"$ref": "Optional.Integer", | "$ref": "Optional.Integer", | ||
"description": "Runtime in seconds" | "default": null, | ||
"description": "Runtime in seconds", | |||
"name": "runtime" | |||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "director", | "name": "director", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "studio", | "name": "studio", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"$ref": "Optional.Integer", | "$ref": "Optional.Integer", | ||
"description": "linked with premiered. Overridden by premiered parameter" | "default": null, | ||
"description": "linked with premiered. Overridden by premiered parameter", | |||
"name": "year" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "plot" | |||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "genre", | "name": "genre", | ||
"type": [ | "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", | "name": "writer", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "country", | "name": "country", | ||
"type": [ | "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", | "name": "showlink", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "thumbnail" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "fanart" | |||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "tag", | "name": "tag", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "art", | "name": "art", | ||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Media.Artwork.Set" | "type": "null" | ||
}, | |||
{ | |||
"$ref": "Media.Artwork.Set" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "resume", | "name": "resume", | ||
"type": [ | "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", | "$ref": "Optional.String", | ||
"description": "linked with year. Overrides year" | "default": null, | ||
"description": "linked with year. Overrides year", | |||
"name": "premiered" | |||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "uniqueid", | "name": "uniqueid", | ||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Media.UniqueID.Set" | "type": "null" | ||
}, | |||
{ | |||
"$ref": "Media.UniqueID.Set" | |||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "UpdateData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 8,666: | Line 9,307: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 /> | # ''[[#Library.Id|Library.Id]]'' setid<br /> | ||
# [''[[#Optional.String|Optional.String]]'' title]<br /> | # [''[[#Optional.String|Optional.String]]'' title = None]<br /> | ||
# [''mixed: [[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /> | # [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' plot]<br /> | # [''[[#Optional.String|Optional.String]]'' plot = None]<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 8,674: | Line 9,315: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Update the given movie set with the given details", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"name": "setid", | "name": "setid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "title" | |||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "art", | "name": "art", | ||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Media.Artwork.Set" | "type": "null" | ||
}, | |||
{ | |||
"$ref": "Media.Artwork.Set" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "plot" | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "UpdateData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 8,716: | Line 9,361: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 /> | # ''[[#Library.Id|Library.Id]]'' musicvideoid<br /> | ||
# [''[[#Optional.String|Optional.String]]'' title]<br /> | # [''[[#Optional.String|Optional.String]]'' title = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' playcount]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' runtime] (Runtime in seconds)<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' director = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' director = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' studio = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' studio = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' year] (linked with premiered. Overridden by premiered parameter)<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' year = None] (linked with premiered. Overridden by premiered parameter)<br /> | ||
# [''[[#Optional.String|Optional.String]]'' plot]<br /> | # [''[[#Optional.String|Optional.String]]'' plot = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' album]<br /> | # [''[[#Optional.String|Optional.String]]'' album = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' artist]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' genre = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' track]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' track = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' lastplayed]<br /> | # [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' thumbnail]<br /> | # [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' fanart]<br /> | # [''[[#Optional.String|Optional.String]]'' fanart = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' tag = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' tag = None]<br /> | ||
# [''mixed: [[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /> | # [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /> | ||
# [''mixed: [[#Video.Resume|Video.Resume]]'' resume = None]<br /> | # [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br /> | ||
# [''[[#Optional.Number|Optional.Number]]'' rating]<br /> | # [''[[#Optional.Number|Optional.Number]]'' rating = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' userrating]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' dateadded]<br /> | # [''[[#Optional.String|Optional.String]]'' dateadded = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' premiered] (linked with year. Overrides year)<br /> | # [''[[#Optional.String|Optional.String]]'' premiered = None] (linked with year. Overrides year)<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 8,742: | Line 9,387: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Update the given music video with the given details", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"name": "musicvideoid", | "name": "musicvideoid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "title" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.Integer", | ||
" | "default": null, | ||
"name": "playcount" | |||
}, | }, | ||
{ | { | ||
"$ref": "Optional.Integer", | "$ref": "Optional.Integer", | ||
"description": "Runtime in seconds" | "default": null, | ||
"description": "Runtime in seconds", | |||
"name": "runtime" | |||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "director", | "name": "director", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "studio", | "name": "studio", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"$ref": "Optional.Integer", | "$ref": "Optional.Integer", | ||
"description": "linked with premiered. Overridden by premiered parameter" | "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", | "name": "artist", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "genre", | "name": "genre", | ||
"type": [ | "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", | "name": "tag", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "art", | "name": "art", | ||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Media.Artwork.Set" | "type": "null" | ||
}, | |||
{ | |||
"$ref": "Media.Artwork.Set" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "resume", | "name": "resume", | ||
"type": [ | "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", | "$ref": "Optional.String", | ||
"description": "linked with year. Overrides year" | "default": null, | ||
"description": "linked with year. Overrides year", | |||
"name": "premiered" | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "UpdateData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 8,900: | Line 9,568: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 /> | # ''[[#Library.Id|Library.Id]]'' seasonid<br /> | ||
# [''mixed: [[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /> | # [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' userrating]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' title]<br /> | # [''[[#Optional.String|Optional.String]]'' title = None]<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 8,908: | Line 9,576: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Update the given season with the given details", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"name": "seasonid", | "name": "seasonid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "art", | "name": "art", | ||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Media.Artwork.Set" | "type": "null" | ||
}, | |||
{ | |||
"$ref": "Media.Artwork.Set" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.Integer", | ||
" | "default": null, | ||
"name": "userrating" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "title" | |||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "UpdateData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 8,950: | Line 9,622: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 /> | # ''[[#Library.Id|Library.Id]]'' tvshowid<br /> | ||
# [''[[#Optional.String|Optional.String]]'' title]<br /> | # [''[[#Optional.String|Optional.String]]'' title = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' playcount]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' studio = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' studio = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' plot]<br /> | # [''[[#Optional.String|Optional.String]]'' plot = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' genre = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br /> | ||
# [''[[#Optional.Number|Optional.Number]]'' rating]<br /> | # [''[[#Optional.Number|Optional.Number]]'' rating = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' mpaa]<br /> | # [''[[#Optional.String|Optional.String]]'' mpaa = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' imdbnumber]<br /> | # [''[[#Optional.String|Optional.String]]'' imdbnumber = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' premiered]<br /> | # [''[[#Optional.String|Optional.String]]'' premiered = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' votes]<br /> | # [''[[#Optional.String|Optional.String]]'' votes = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' lastplayed]<br /> | # [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' originaltitle]<br /> | # [''[[#Optional.String|Optional.String]]'' originaltitle = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' sorttitle]<br /> | # [''[[#Optional.String|Optional.String]]'' sorttitle = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' episodeguide]<br /> | # [''[[#Optional.String|Optional.String]]'' episodeguide = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' thumbnail]<br /> | # [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' fanart]<br /> | # [''[[#Optional.String|Optional.String]]'' fanart = None]<br /> | ||
# [''mixed: [[#Array.String|Array.String]]'' tag = None]<br /> | # [''mixed: null|[[#Array.String|Array.String]]'' tag = None]<br /> | ||
# [''mixed: [[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /> | # [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' userrating]<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br /> | ||
# [''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings]<br /> | # [''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings]<br /> | ||
# [''[[#Optional.String|Optional.String]]'' dateadded]<br /> | # [''[[#Optional.String|Optional.String]]'' dateadded = None]<br /> | ||
# [''[[#Optional.Integer|Optional.Integer]]'' runtime] (Runtime in seconds)<br /> | # [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br /> | ||
# [''[[#Optional.String|Optional.String]]'' status] (Valid values: 'returning series', 'in production', 'planned', 'cancelled', 'ended')<br /> | # [''[[#Optional.String|Optional.String]]'' status = None] (Valid values: 'returning series', 'in production', 'planned', 'cancelled', 'ended')<br /> | ||
# [''mixed: [[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br /> | # [''mixed: null|[[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 8,979: | Line 9,651: | ||
'''Type:''' ''string''<br /> | '''Type:''' ''string''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Update the given tvshow with the given details", | ||
"params": [ | "params": [ | ||
{ | { | ||
"$ref": "Library.Id", | |||
"name": "tvshowid", | "name": "tvshowid", | ||
"required": true | "required": true | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "title" | |||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.Integer", | ||
" | "default": null, | ||
"name": "playcount" | |||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "studio", | "name": "studio", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
" | "$ref": "Optional.String", | ||
" | "default": null, | ||
"name": "plot" | |||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "genre", | "name": "genre", | ||
"type": [ | "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", | "name": "tag", | ||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Array.String" | |||
} | } | ||
] | ] | ||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "art", | "name": "art", | ||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Media.Artwork.Set" | "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", | "$ref": "Optional.Integer", | ||
"description": "Runtime in seconds" | "default": null, | ||
"description": "Runtime in seconds", | |||
"name": "runtime" | |||
}, | }, | ||
{ | { | ||
"$ref": "Optional.String", | "$ref": "Optional.String", | ||
"description": "Valid values: 'returning series', 'in production', 'planned', 'cancelled', 'ended'" | "default": null, | ||
"description": "Valid values: 'returning series', 'in production', 'planned', 'cancelled', 'ended'", | |||
"name": "status" | |||
}, | }, | ||
{ | { | ||
"default": null, | |||
"name": "uniqueid", | "name": "uniqueid", | ||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Media.UniqueID.Set" | "type": "null" | ||
}, | |||
{ | |||
"$ref": "Media.UniqueID.Set" | |||
} | } | ||
] | ] | ||
} | } | ||
], | ], | ||
"returns": "string" | "permission": "UpdateData", | ||
"returns": { | |||
"type": "string" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 9,135: | Line 9,831: | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# ''array'' booleans<br /> | # ''array[string]'' booleans<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 9,141: | Line 9,837: | ||
'''Type:''' ''object (Object containing key-value pairs of the retrieved info booleans)''<br /> | '''Type:''' ''object (Object containing key-value pairs of the retrieved info booleans)''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieve info booleans about Kodi and the system", | ||
"params": [ | "params": [ | ||
{ | { | ||
"items": { | "items": { | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
"minItems": 1 | "minItems": 1, | ||
"name": "booleans", | |||
"required": true, | |||
"type": "array" | |||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"additionalProperties": { | "additionalProperties": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | }, | ||
} | "description": "Object containing key-value pairs of the retrieved info booleans", | ||
"type": "object" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 9,173: | Line 9,869: | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
# ''array'' labels (See http://kodi.wiki/view/InfoLabels for a list of possible info labels)<br /> | # ''array[string]'' labels (See http://kodi.wiki/view/InfoLabels for a list of possible info labels)<br /> | ||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 9,179: | Line 9,875: | ||
'''Type:''' ''object (Object containing key-value pairs of the retrieved info labels)''<br /> | '''Type:''' ''object (Object containing key-value pairs of the retrieved info labels)''<br /> | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "description": "Retrieve info labels about Kodi and the system", | ||
"params": [ | "params": [ | ||
{ | { | ||
" | "description": "See http://kodi.wiki/view/InfoLabels for a list of possible info labels", | ||
"items": { | "items": { | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
" | "name": "labels", | ||
"required": true, | |||
"type": "array" | |||
} | } | ||
], | ], | ||
"permission": "ReadData", | |||
"returns": { | "returns": { | ||
"additionalProperties": { | "additionalProperties": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | }, | ||
} | "description": "Object containing key-value pairs of the retrieved info labels", | ||
"type": "object" | |||
}, | |||
"type": "method" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 9,211: | Line 9,907: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "unknown", | ||
"video", | "video", | ||
Line 9,221: | Line 9,917: | ||
"executable" | "executable" | ||
], | ], | ||
" | "id": "Addon.Content", | ||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 9,230: | Line 9,927: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* ''string'' addonid | * ''string'' addonid | ||
* '' | * [''string'' author] | ||
* [''string'' | * [''mixed: boolean|string'' broken] | ||
* ['' | * [''array'' dependencies] | ||
* [''string'' | * [''mixed: boolean|string'' deprecated] | ||
* [''string'' description] | * [''string'' description] | ||
* [''string'' disclaimer] | * [''string'' disclaimer] | ||
* [''boolean'' enabled] | |||
* [''array'' extrainfo] | |||
* [''string'' fanart] | * [''string'' fanart] | ||
* ['' | * [''boolean'' installed] | ||
* ['' | * [''string'' name] | ||
* ['' | * [''string'' path] | ||
* [''integer'' rating] | * [''integer'' rating] | ||
* ['' | * [''string'' summary] | ||
* ['' | * [''string'' thumbnail] | ||
* ''[[#Addon.Types|Addon.Types]]'' type | |||
* [''string'' version] | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Item.Details.Base", | ||
"id": "Addon.Details", | |||
"properties": { | "properties": { | ||
"addonid": { | "addonid": { | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
" | "author": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "broken": { | ||
" | "default": null, | ||
"type": [ | |||
{ | |||
"type": "boolean" | |||
}, | |||
{ | |||
"type": "string" | |||
} | |||
] | |||
"type": | |||
}, | }, | ||
"dependencies": { | "dependencies": { | ||
"items": { | "items": { | ||
"properties": { | "properties": { | ||
"addonid": { | "addonid": { | ||
"type": "string", | "required": true, | ||
"required": true | "type": "string" | ||
}, | |||
"optional": { | |||
"required": true, | |||
"type": "boolean" | |||
}, | }, | ||
"version": { | "version": { | ||
"required": true, | |||
"required": true | "type": "string" | ||
"type": " | |||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "array" | |||
}, | }, | ||
" | "deprecated": { | ||
"default": null, | |||
"type": [ | "type": [ | ||
"boolean", | { | ||
"string" | "type": "boolean" | ||
}, | |||
{ | |||
"type": "string" | |||
} | |||
] | ] | ||
}, | |||
"description": { | |||
"default": "", | |||
"type": "string" | |||
}, | |||
"disclaimer": { | |||
"default": "", | |||
"type": "string" | |||
}, | |||
"enabled": { | |||
"default": false, | |||
"type": "boolean" | |||
}, | }, | ||
"extrainfo": { | "extrainfo": { | ||
"items": { | "items": { | ||
"properties": { | "properties": { | ||
"key": { | "key": { | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
"value": { | "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": { | "rating": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "summary": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
}, | |||
"thumbnail": { | |||
"default": "", | |||
"type": "string" | |||
}, | |||
"type": { | |||
"$ref": "Addon.Types", | |||
"required": true | |||
}, | }, | ||
" | "version": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
} | } | ||
} | } | ||
Line 9,343: | Line 10,070: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Addon.Fields", | |||
"items": { | "items": { | ||
" | "enums": [ | ||
"name", | "name", | ||
"version", | "version", | ||
Line 9,363: | Line 10,090: | ||
"rating", | "rating", | ||
"enabled", | "enabled", | ||
"installed" | "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>}} | </syntaxhighlight>}} | ||
Line 9,372: | Line 10,154: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "volume", | ||
"muted", | "muted", | ||
"name", | "name", | ||
"version", | "version", | ||
"sorttokens", | "sorttokens", | ||
"language" | "language" | ||
] | ], | ||
"id": "Application.Property.Name", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 9,391: | Line 10,174: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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] | * [''boolean'' muted] | ||
* [''string'' name] | * [''string'' name] | ||
* [''[[#Array.String|Array.String]]'' sorttokens] | |||
* [''object'' version] | * [''object'' version] | ||
* ['' | * [''integer'' volume] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
" | "language": { | ||
" | "default": "", | ||
" | "description": "Current language code and region e.g. en_GB", | ||
" | "minLength": 1, | ||
"type": "string" | |||
}, | }, | ||
"muted": { | "muted": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
"name": { | "name": { | ||
"type": "string", | "default": "", | ||
" | "minLength": 1, | ||
"type": "string" | |||
}, | |||
"sorttokens": { | |||
"$ref": "Array.String", | |||
"description": "Articles ignored during sorting when ignorearticle is enabled." | |||
}, | }, | ||
"version": { | "version": { | ||
"properties": { | "properties": { | ||
"major": { | "major": { | ||
"minimum": 0, | "minimum": 0, | ||
"required": true | "required": true, | ||
"type": "integer" | |||
}, | }, | ||
"minor": { | "minor": { | ||
"minimum": 0, | "minimum": 0, | ||
"required": true | "required": true, | ||
"type": "integer" | |||
}, | }, | ||
"revision": { | "revision": { | ||
"default": null, | |||
"type": [ | "type": [ | ||
"string", | { | ||
"integer" | "type": "string" | ||
}, | |||
{ | |||
"type": "integer" | |||
} | |||
] | ] | ||
}, | }, | ||
"tag": { | "tag": { | ||
" | "enums": [ | ||
"prealpha", | "prealpha", | ||
"alpha", | "alpha", | ||
Line 9,442: | Line 10,235: | ||
"stable" | "stable" | ||
], | ], | ||
"required": true | "required": true, | ||
"type": "string" | |||
}, | }, | ||
"tagversion": { | "tagversion": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
" | "volume": { | ||
" | "default": 0, | ||
"maximum": 100, | |||
"minimum": 0, | |||
"type": "integer" | |||
" | |||
" | |||
" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 9,465: | Line 10,259: | ||
'''Type:''' ''array'' | '''Type:''' ''array'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "items": { | ||
"type": "integer" | "type": "integer" | ||
} | }, | ||
"type": "array" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 9,476: | Line 10,271: | ||
'''Type:''' ''array'' | '''Type:''' ''array'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "items": { | ||
"type": "string", | "minLength": 1, | ||
"type": "string" | |||
}, | |||
"type": "array" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 9,489: | Line 10,285: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "album", | ||
"single" | "single" | ||
], | ], | ||
" | "id": "Audio.Album.ReleaseType", | ||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 9,502: | Line 10,299: | ||
'''Type:''' ''array'' | '''Type:''' ''array'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "items": { | ||
" | "additionalProperties": false, | ||
"description": "The various roles contributed by an artist to one or more songs", | "description": "The various roles contributed by an artist to one or more songs", | ||
"properties": { | "properties": { | ||
"role": { | |||
"required": true, | |||
"type": "string" | |||
}, | |||
"roleid": { | "roleid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
} | }, | ||
"type": "array" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 9,525: | Line 10,323: | ||
'''Type:''' ''array'' | '''Type:''' ''array'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "items": { | ||
" | "additionalProperties": false, | ||
"description": "The artist and the role they contribute to a song", | "description": "The artist and the role they contribute to a song", | ||
"properties": { | "properties": { | ||
"artistid": { | |||
"$ref": "Library.Id", | |||
"required": true | |||
}, | |||
"name": { | "name": { | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
"role": { | "role": { | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
"roleid": { | "roleid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
} | }, | ||
"type": "array" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 9,558: | Line 10,357: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''[[#Library.Id|Library.Id]]'' albumid | ||
* [''string'' albumlabel] | |||
* [''string'' albumstatus] | |||
* [''boolean'' compilation] | |||
* [''string'' description] | * [''string'' description] | ||
* [''[ | * [''boolean'' isboxset] | ||
* [''string'' lastplayed] | |||
* [''[[#Array.String|Array.String]]'' mood] | * [''[[#Array.String|Array.String]]'' mood] | ||
* [''string'' musicbrainzalbumid] | |||
* [''string'' | * [''string'' musicbrainzreleasegroupid] | ||
* [''string'' | |||
* [''integer'' playcount] | * [''integer'' playcount] | ||
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = album] | |||
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype | |||
* [''[[#Audio.Details.Genres|Audio.Details.Genres]]'' songgenres] | * [''[[#Audio.Details.Genres|Audio.Details.Genres]]'' songgenres] | ||
* [''[[#Array.Integer|Array.Integer]]'' sourceid] | * [''[[#Array.Integer|Array.Integer]]'' sourceid] | ||
* ['' | * [''[[#Array.String|Array.String]]'' style] | ||
* [''[[#Array.String|Array.String]]'' theme] | |||
* [''integer'' totaldiscs] | * [''integer'' totaldiscs] | ||
* [''string'' type] | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Audio.Details.Media", | ||
"id": "Audio.Details.Album", | |||
"properties": { | "properties": { | ||
"albumduration": { | |||
"default": 0, | |||
"type": "integer" | |||
}, | |||
"albumid": { | "albumid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
}, | |||
"albumlabel": { | |||
"default": "", | |||
"type": "string" | |||
}, | |||
"albumstatus": { | |||
"default": "", | |||
"type": "string" | |||
}, | |||
"compilation": { | |||
"default": false, | |||
"type": "boolean" | |||
}, | }, | ||
"description": { | "description": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "isboxset": { | ||
" | "default": false, | ||
"type": "boolean" | |||
}, | |||
"lastplayed": { | |||
"default": "", | |||
"type": "string" | |||
}, | }, | ||
"mood": { | "mood": { | ||
"$ref": "Array.String" | "$ref": "Array.String" | ||
}, | }, | ||
" | "musicbrainzalbumid": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "musicbrainzreleasegroupid": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
"playcount": { | "playcount": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
"releasetype": { | "releasetype": { | ||
"$ref": "Audio.Album.ReleaseType" | "$ref": "Audio.Album.ReleaseType", | ||
"default": "album" | |||
" | |||
}, | }, | ||
"songgenres": { | "songgenres": { | ||
"$ref": "Audio.Details.Genres" | "$ref": "Audio.Details.Genres" | ||
}, | }, | ||
"sourceid": { | "sourceid": { | ||
"$ref": "Array.Integer" | "$ref": "Array.Integer" | ||
}, | }, | ||
" | "style": { | ||
" | "$ref": "Array.String" | ||
}, | |||
"theme": { | |||
"$ref": "Array.String" | |||
}, | }, | ||
"totaldiscs": { | "totaldiscs": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | |||
"type": { | |||
"default": "", | |||
"type": "string" | |||
} | } | ||
} | } | ||
Line 9,640: | Line 10,461: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''[[#Library.Id|Library.Id]]'' artistid | ||
* [''string'' born] | * [''string'' born] | ||
* ['' | * [''boolean'' compilationartist] | ||
* [''string'' description] | * [''string'' description] | ||
* [''string'' died] | * [''string'' died] | ||
* [''string'' disambiguation] | |||
* [''string'' disbanded] | * [''string'' disbanded] | ||
* [''[[#Array.String|Array.String]]'' | * [''string'' formed] | ||
* [''boolean'' | * [''string'' gender] | ||
* [''[[#Array.String|Array.String]]'' instrument] | |||
* [''boolean'' isalbumartist] | |||
* [''[[#Array.String|Array.String]]'' mood] | |||
* [''[[#Array.String|Array.String]]'' musicbrainzartistid] | * [''[[#Array.String|Array.String]]'' musicbrainzartistid] | ||
* [''[[#Audio.Artist.Roles|Audio.Artist.Roles]]'' roles] | * [''[[#Audio.Artist.Roles|Audio.Artist.Roles]]'' roles] | ||
* [''[[#Audio.Details.Genres|Audio.Details.Genres]]'' songgenres] | * [''[[#Audio.Details.Genres|Audio.Details.Genres]]'' songgenres] | ||
* [''string'' sortname] | * [''string'' sortname] | ||
* [''[[#Array.Integer|Array.Integer]]'' sourceid] | |||
* [''[[#Array.String|Array.String]]'' style] | |||
* [''string'' type] | * [''string'' type] | ||
* [''[[#Array.String|Array.String]]'' yearsactive] | |||
* [''[[#Array. | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Audio.Details.Base", | ||
"id": "Audio.Details.Artist", | |||
"properties": { | "properties": { | ||
"artist": { | |||
"required": true, | |||
"type": "string" | |||
}, | |||
"artistid": { | "artistid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
}, | }, | ||
" | "born": { | ||
" | "default": "", | ||
" | "type": "string" | ||
}, | }, | ||
" | "compilationartist": { | ||
" | "default": false, | ||
"type": "boolean" | |||
}, | }, | ||
" | "description": { | ||
" | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "died": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "disambiguation": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "disbanded": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "formed": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "gender": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "instrument": { | ||
"$ref": "Array.String" | "$ref": "Array.String" | ||
}, | }, | ||
" | "isalbumartist": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | |||
"mood": { | |||
"$ref": "Array.String" | |||
}, | }, | ||
"musicbrainzartistid": { | "musicbrainzartistid": { | ||
Line 9,712: | Line 10,546: | ||
"songgenres": { | "songgenres": { | ||
"$ref": "Audio.Details.Genres" | "$ref": "Audio.Details.Genres" | ||
}, | }, | ||
"sortname": { | "sortname": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "sourceid": { | ||
" | "$ref": "Array.Integer" | ||
}, | }, | ||
" | "style": { | ||
" | "$ref": "Array.String" | ||
}, | }, | ||
" | "type": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "yearsactive": { | ||
"$ref": "Array. | "$ref": "Array.String" | ||
} | } | ||
} | } | ||
Line 9,739: | Line 10,572: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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] | * [''[[#Array.String|Array.String]]'' genre] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Media.Details.Base", | ||
"id": "Audio.Details.Base", | |||
"properties": { | "properties": { | ||
" | "art": { | ||
"$ref": " | "$ref": "Media.Artwork" | ||
}, | }, | ||
"dateadded": { | "dateadded": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "genre": { | ||
"$ref": " | "$ref": "Array.String" | ||
} | } | ||
} | } | ||
Line 9,762: | Line 10,597: | ||
'''Type:''' ''array'' | '''Type:''' ''array'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "items": { | ||
"properties": { | "properties": { | ||
"genreid": { | "genreid": { | ||
Line 9,773: | Line 10,607: | ||
}, | }, | ||
"title": { | "title": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "array" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 9,784: | Line 10,621: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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.String|Array.String]]'' artist] | ||
* [''[[#Array.Integer|Array.Integer]]'' artistid] | * [''[[#Array.Integer|Array.Integer]]'' artistid] | ||
* [''string'' displayartist] | * [''string'' displayartist] | ||
* [''[[#Array.String|Array.String]]'' musicbrainzalbumartistid] | |||
* [''string'' originaldate] | |||
* [''number'' rating] | |||
* [''string'' releasedate] | |||
* [''string'' sortartist] | |||
* [''string'' title] | |||
* [''integer'' userrating] | |||
* [''integer'' votes] | * [''integer'' votes] | ||
* [''integer'' | * [''integer'' year] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Audio.Details.Base", | ||
"id": "Audio.Details.Media", | |||
"properties": { | "properties": { | ||
"artist": { | "artist": { | ||
"$ref": "Array.String" | "$ref": "Array.String" | ||
}, | }, | ||
" | "artistid": { | ||
" | "$ref": "Array.Integer" | ||
}, | }, | ||
" | "displayartist": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
}, | }, | ||
"musicbrainzalbumartistid": { | "musicbrainzalbumartistid": { | ||
"$ref": "Array.String" | "$ref": "Array.String" | ||
}, | }, | ||
" | "originaldate": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "rating": { | ||
"type": " | "default": 0.0, | ||
"type": "number" | |||
}, | }, | ||
" | "releasedate": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
}, | }, | ||
"sortartist": { | "sortartist": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "title": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "userrating": { | ||
"type": " | "default": 0, | ||
"type": "integer" | |||
}, | |||
"votes": { | |||
"default": 0, | |||
"type": "integer" | |||
}, | |||
"year": { | |||
"default": 0, | |||
"type": "integer" | |||
} | } | ||
} | } | ||
Line 9,848: | Line 10,695: | ||
* [''string'' title] | * [''string'' title] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Item.Details.Base", | ||
"id": "Audio.Details.Role", | |||
"properties": { | "properties": { | ||
"roleid": { | "roleid": { | ||
Line 9,857: | Line 10,705: | ||
}, | }, | ||
"title": { | "title": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | } | ||
Line 9,867: | Line 10,716: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* [''string'' album] | |||
* [''string'' | |||
* [''[[#Array.String|Array.String]]'' albumartist] | * [''[[#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] | * [''string'' comment] | ||
* [''[[#Audio.Contributors|Audio.Contributors]]'' contributors] | |||
* [''[[# | |||
* [''integer'' disc] | * [''integer'' disc] | ||
* [''string'' disctitle] | |||
* [''string'' | |||
* [''string'' displaycomposer] | * [''string'' displaycomposer] | ||
* [''string'' displayconductor] | * [''string'' displayconductor] | ||
* [''string'' displaylyricist] | |||
* [''string'' displayorchestra] | * [''string'' displayorchestra] | ||
* [''string'' | * [''integer'' duration] | ||
* [''string'' file] | |||
* [''[[#Array.Integer|Array.Integer]]'' genreid] | * [''[[#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 | |||
* [''[[#Array.Integer|Array.Integer]]'' sourceid] | * [''[[#Array.Integer|Array.Integer]]'' sourceid] | ||
* ['' | * [''integer'' track] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Audio.Details.Media", | ||
"id": "Audio.Details.Song", | |||
"properties": { | "properties": { | ||
" | "album": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
Line 9,911: | Line 10,758: | ||
"$ref": "Array.String" | "$ref": "Array.String" | ||
}, | }, | ||
"album": { | "albumartistid": { | ||
"type": " | "$ref": "Array.Integer" | ||
}, | |||
"albumid": { | |||
"$ref": "Library.Id", | |||
"default": -1 | |||
}, | |||
"albumreleasetype": { | |||
"$ref": "Audio.Album.ReleaseType", | |||
"default": "album" | |||
}, | |||
"bitrate": { | |||
"default": null, | |||
"type": "any" | |||
}, | }, | ||
" | "bpm": { | ||
"type": " | "default": null, | ||
"type": "any" | |||
}, | }, | ||
" | "channels": { | ||
"type": " | "default": null, | ||
"type": "any" | |||
}, | }, | ||
"comment": { | "comment": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "contributors": { | ||
" | "$ref": "Audio.Contributors" | ||
}, | }, | ||
" | "disc": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "disctitle": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "displaycomposer": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "displayconductor": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "displaylyricist": { | ||
" | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "displayorchestra": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "duration": { | ||
" | "default": 0, | ||
"type": "integer" | |||
}, | }, | ||
" | "file": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "genreid": { | ||
"$ref": "Array.Integer" | |||
}, | |||
"lastplayed": { | |||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "lyrics": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "mood": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "musicbrainzartistid": { | ||
"$ref": "Array. | "$ref": "Array.String" | ||
}, | }, | ||
" | "musicbrainztrackid": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "playcount": { | ||
"type": " | "default": 0, | ||
"type": "integer" | |||
}, | }, | ||
"samplerate": { | "samplerate": { | ||
"type": " | "default": null, | ||
"type": "any" | |||
}, | }, | ||
" | "songid": { | ||
" | "$ref": "Library.Id", | ||
"required": true | |||
}, | |||
"sourceid": { | |||
"$ref": "Array.Integer" | |||
}, | }, | ||
" | "track": { | ||
"type": " | "default": 0, | ||
"type": "integer" | |||
} | } | ||
} | } | ||
Line 9,995: | Line 10,867: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Audio.Fields.Album", | |||
"items": { | "items": { | ||
"description": "Requesting the songgenres, artistid and/or sourceid fields will result in increased response times", | "description": "Requesting the songgenres, artistid and/or sourceid fields will result in increased response times", | ||
" | "enums": [ | ||
"title", | "title", | ||
"description", | "description", | ||
Line 10,034: | Line 10,906: | ||
"totaldiscs", | "totaldiscs", | ||
"releasedate", | "releasedate", | ||
"originaldate" | "originaldate", | ||
] | "albumstatus", | ||
"datemodified", | |||
"datenew", | |||
"albumduration" | |||
], | |||
"type": "string" | |||
} | } | ||
} | } | ||
Line 10,042: | Line 10,919: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Audio.Fields.Artist", | |||
"items": { | "items": { | ||
"description": "Requesting the (song)genreid/genre, roleid/role or sourceid fields will result in increased response times", | "description": "Requesting the (song)genreid/genre, roleid/role or sourceid fields will result in increased response times", | ||
" | "enums": [ | ||
"instrument", | "instrument", | ||
"style", | "style", | ||
Line 10,072: | Line 10,949: | ||
"disambiguation", | "disambiguation", | ||
"art", | "art", | ||
"sourceid" | "sourceid", | ||
] | "datemodified", | ||
"datenew" | |||
], | |||
"type": "string" | |||
} | } | ||
} | } | ||
Line 10,080: | Line 10,960: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Audio.Fields.Role", | |||
"items": { | "items": { | ||
" | "enums": [ | ||
"title" | "title" | ||
] | ], | ||
"type": "string" | |||
} | } | ||
} | } | ||
Line 10,094: | Line 10,975: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Audio.Fields.Song", | |||
"items": { | "items": { | ||
"description": "Requesting the genreid, artistid, albumartistid and/or sourceid fields will result in increased response times", | "description": "Requesting the genreid, artistid, albumartistid and/or sourceid fields will result in increased response times", | ||
" | "enums": [ | ||
"title", | "title", | ||
"artist", | "artist", | ||
Line 10,146: | Line 11,027: | ||
"samplerate", | "samplerate", | ||
"bitrate", | "bitrate", | ||
"channels" | "channels", | ||
] | "datemodified", | ||
"datenew" | |||
], | |||
"type": "string" | |||
} | } | ||
} | } | ||
Line 10,154: | Line 11,038: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "missingartistid", | ||
"librarylastupdated" | "librarylastupdated", | ||
] | "librarylastcleaned", | ||
"artistlinksupdated", | |||
"songslastadded", | |||
"albumslastadded", | |||
"artistslastadded", | |||
"genreslastadded", | |||
"songsmodified", | |||
"albumsmodified", | |||
"artistsmodified" | |||
], | |||
"id": "Audio.Property.Name", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 10,168: | Line 11,063: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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] | * [''string'' librarylastupdated] | ||
* [''[[#Library.Id|Library.Id]]'' missingartistid = -1] | |||
* [''string'' songslastadded] | |||
* [''string'' songsmodified] | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "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": { | "missingartistid": { | ||
"$ref": "Library.Id" | "$ref": "Library.Id", | ||
"default": -1 | |||
}, | |||
"songslastadded": { | |||
"default": "", | |||
"type": "string" | |||
}, | }, | ||
" | "songsmodified": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 10,192: | Line 11,135: | ||
* ''[[#Configuration.Notifications|Configuration.Notifications]]'' notifications | * ''[[#Configuration.Notifications|Configuration.Notifications]]'' notifications | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | ||
{ | { | ||
" | "id": "Configuration", | ||
"properties": { | "properties": { | ||
"notifications": { | "notifications": { | ||
Line 10,201: | Line 11,143: | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 10,209: | Line 11,153: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* ''boolean'' | * ''boolean'' application | ||
* ''boolean'' | * ''boolean'' audiolibrary | ||
* ''boolean'' | * ''boolean'' gui | ||
* ''boolean'' | * ''boolean'' input | ||
* ''boolean'' | * ''boolean'' other | ||
* ''boolean'' | * ''boolean'' player | ||
* ''boolean'' | * ''boolean'' playlist | ||
* ''boolean'' | * ''boolean'' pvr | ||
* ''boolean'' | * ''boolean'' system | ||
* ''boolean'' | * ''boolean'' videolibrary | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "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>}} | </syntaxhighlight>}} | ||
Line 10,274: | Line 11,219: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''string'' title | ||
* ''[[#Favourite.Type|Favourite.Type]]'' type | * ''[[#Favourite.Type|Favourite.Type]]'' type | ||
* [''string'' window] | * [''string'' window] | ||
* [''string'' windowparameter] | * [''string'' windowparameter] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"path": { | |||
"default": "", | |||
"type": "string" | |||
}, | |||
"thumbnail": { | |||
"default": "", | |||
"type": "string" | |||
}, | |||
"title": { | "title": { | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
"type": { | "type": { | ||
"$ref": "Favourite.Type", | "$ref": "Favourite.Type", | ||
"required": true | "required": true | ||
}, | }, | ||
"window": { | "window": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
"windowparameter": { | "windowparameter": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 10,312: | Line 11,262: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Favourite.Fields.Favourite", | |||
"items": { | "items": { | ||
" | "enums": [ | ||
"window", | "window", | ||
"windowparameter", | "windowparameter", | ||
"thumbnail", | "thumbnail", | ||
"path" | "path" | ||
] | ], | ||
"type": "string" | |||
} | } | ||
} | } | ||
Line 10,329: | Line 11,280: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "media", | ||
"window", | "window", | ||
Line 10,338: | Line 11,289: | ||
"androidapp", | "androidapp", | ||
"unknown" | "unknown" | ||
] | ], | ||
"id": "Favourite.Type", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 10,345: | Line 11,298: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "video", | ||
"music", | "music", | ||
Line 10,354: | Line 11,307: | ||
"files", | "files", | ||
"programs" | "programs" | ||
] | ], | ||
"id": "Files.Media", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 10,361: | Line 11,316: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "currentwindow", | ||
"currentcontrol", | "currentcontrol", | ||
Line 10,370: | Line 11,325: | ||
"fullscreen", | "fullscreen", | ||
"stereoscopicmode" | "stereoscopicmode" | ||
] | ], | ||
"id": "GUI.Property.Name", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 10,378: | Line 11,335: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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] | * [''object'' currentwindow] | ||
* ['' | * [''boolean'' fullscreen] | ||
* [''object'' skin] | * [''object'' skin] | ||
* [''[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]'' stereoscopicmode] | * [''[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]'' stereoscopicmode] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"currentcontrol": { | |||
"properties": { | |||
"label": { | |||
"required": true, | |||
"type": "string" | |||
} | |||
}, | |||
"type": "object" | |||
}, | |||
"currentwindow": { | "currentwindow": { | ||
"properties": { | "properties": { | ||
"id": { | "id": { | ||
" | "required": true, | ||
" | "type": "integer" | ||
}, | }, | ||
"label": { | "label": { | ||
" | "required": true, | ||
" | "type": "string" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
" | "fullscreen": { | ||
" | "default": false, | ||
"type": "boolean" | |||
}, | }, | ||
"skin": { | "skin": { | ||
"properties": { | "properties": { | ||
"id": { | "id": { | ||
" | "minLength": 1, | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
"name": { | "name": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | } | ||
}, | |||
"type": "object" | |||
"type": " | |||
}, | }, | ||
"stereoscopicmode": { | "stereoscopicmode": { | ||
"$ref": "GUI.Stereoscopy.Mode" | "$ref": "GUI.Stereoscopy.Mode" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 10,437: | Line 11,397: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''string'' mode | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
" | "label": { | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
}, | |||
"mode": { | |||
"enums": [ | |||
"off", | "off", | ||
"split_vertical", | "split_vertical", | ||
Line 10,457: | Line 11,419: | ||
"anaglyph_yellow_blue", | "anaglyph_yellow_blue", | ||
"monoscopic" | "monoscopic" | ||
] | ], | ||
"required": true, | |||
"type": "string" | |||
"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", | |||
"eventlog", | |||
"extendedprogressdialog", | |||
"favourites", | |||
"filebrowser", | |||
"filemanager", | |||
"fullscreengame", | |||
"fullscreeninfo", | |||
"fullscreenlivetv", | |||
"fullscreenlivetvinput", | |||
"fullscreenlivetvpreview", | |||
"fullscreenradio", | |||
"fullscreenradioinput", | |||
"fullscreenradiopreview", | |||
"fullscreenvideo", | |||
"gameadvancedsettings", | |||
"gamecontrollers", | |||
"gameosd", | |||
"gamepadinput", | |||
"games", | |||
"gamesettings", | |||
"gamestretchmode", | |||
"gamevideofilter", | |||
"gamevideorotation", | |||
"gamevolume", | |||
"home", | |||
"infoprovidersettings", | |||
"interfacesettings", | |||
"libexportsettings", | |||
"locksettings", | |||
"loginscreen", | |||
"mediafilter", | |||
"mediasettings", | |||
"mediasource", | |||
"movieinformation", | |||
"music", | |||
"musicinformation", | |||
"musicosd", | |||
"musicplaylist", | |||
"musicplaylisteditor", | |||
"networksetup", | |||
"notification", | |||
"numericinput", | |||
"okdialog", | |||
"osdaudiosettings", | |||
"osdcmssettings", | |||
"osdsubtitlesettings", | |||
"osdvideosettings", | |||
"peripheralsettings", | |||
"pictureinfo", | |||
"pictures", | |||
"playercontrols", | |||
"playerprocessinfo", | |||
"playersettings", | |||
"profiles", | |||
"profilesettings", | |||
"programs", | |||
"progressdialog", | |||
"pvrchannelguide", | |||
"pvrchannelmanager", | |||
"pvrchannelscan", | |||
"pvrgroupmanager", | |||
"pvrguidecontrols", | |||
"pvrguideinfo", | |||
"pvrguidesearch", | |||
"pvrosdchannels", | |||
"pvrosdguide", | |||
"pvrosdteletext", | |||
"pvrradiordsinfo", | |||
"pvrrecordinginfo", | |||
"pvrsettings", | |||
"pvrtimersetting", | |||
"pvrupdateprogress", | |||
"radiochannels", | |||
"radioguide", | |||
"radiorecordings", | |||
"radiosearch", | |||
"radiotimerrules", | |||
"radiotimers", | |||
"screencalibration", | |||
"screensaver", | |||
"seekbar", | |||
"selectdialog", | |||
"servicesettings", | |||
"settings", | |||
"shutdownmenu", | |||
"skinsettings", | |||
"sliderdialog", | |||
"slideshow", | |||
"smartplaylisteditor", | |||
"smartplaylistrule", | |||
"songinformation", | |||
"splash", | |||
"startup", | |||
"startwindow", | |||
"submenu", | |||
"subtitlesearch", | |||
"systeminfo", | |||
"systemsettings", | |||
"teletext", | |||
"textviewer", | |||
"tvchannels", | |||
"tvguide", | |||
"tvrecordings", | |||
"tvsearch", | |||
"tvtimerrules", | |||
"tvtimers", | |||
"videobookmarks", | |||
"videomenu", | |||
"videoosd", | |||
"videoplaylist", | |||
"videos", | |||
"videotimeseek", | |||
"virtualkeyboard", | |||
"visualisation", | |||
"visualisationpresetlist", | |||
"volumebar", | |||
"weather", | |||
"yesnodialog" | |||
], | |||
"id": "GUI.Window", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 10,470: | Line 11,570: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "increment", | ||
"decrement" | "decrement" | ||
] | ], | ||
"id": "Global.IncrementDecrement", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 10,482: | Line 11,584: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | ||
{ | { | ||
" | "default": "", | ||
"minLength": 1 | "id": "Global.String.NotEmpty", | ||
"minLength": 1, | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 10,494: | Line 11,598: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* ''integer'' hours | * ''integer'' hours | ||
* ''integer'' milliseconds | |||
* ''integer'' minutes | * ''integer'' minutes | ||
* ''integer'' seconds | * ''integer'' seconds | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"hours": { | "hours": { | ||
" | "minimum": 0, | ||
"required": true, | "required": true, | ||
"type": "integer" | |||
}, | |||
"milliseconds": { | |||
"maximum": 999, | |||
"minimum": 0, | "minimum": 0, | ||
" | "required": true, | ||
"type": "integer" | |||
}, | }, | ||
"minutes": { | "minutes": { | ||
" | "maximum": 59, | ||
"minimum": 0, | |||
"required": true, | "required": true, | ||
" | "type": "integer" | ||
}, | }, | ||
"seconds": { | "seconds": { | ||
" | "maximum": 59, | ||
"minimum": 0, | "minimum": 0, | ||
"required": true, | "required": true, | ||
" | "type": "integer" | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 10,533: | Line 11,638: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": [ | ||
{ | { | ||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
{ | { | ||
" | "enums": [ | ||
"toggle" | "toggle" | ||
], | ], | ||
" | "type": "string" | ||
} | } | ||
] | ] | ||
Line 10,553: | Line 11,658: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "monday", | ||
"tuesday", | "tuesday", | ||
Line 10,564: | Line 11,669: | ||
"saturday", | "saturday", | ||
"sunday" | "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", | |||
"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>}} | </syntaxhighlight>}} | ||
=== Item === | === 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 ==== | ==== Item.Details.Base ==== | ||
'''Type:''' ''object'' | '''Type:''' ''object'' | ||
Line 10,575: | Line 11,921: | ||
* ''string'' label | * ''string'' label | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"label": { | "label": { | ||
" | "required": true, | ||
" | "type": "string" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 10,589: | Line 11,936: | ||
'''Type:''' ''array'' | '''Type:''' ''array'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "items": { | ||
"type": "string" | "type": "string" | ||
} | }, | ||
"type": "array", | |||
"uniqueItems": true | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 10,605: | Line 11,953: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''[[#Library.Id|Library.Id]]'' genreid | ||
* [''[[#Array.Integer|Array.Integer]]'' sourceid] | |||
* [''string'' thumbnail] | |||
* [''string'' title] | * [''string'' title] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Item.Details.Base", | ||
"id": "Library.Details.Genre", | |||
"properties": { | "properties": { | ||
"genreid": { | "genreid": { | ||
Line 10,617: | Line 11,966: | ||
"required": true | "required": true | ||
}, | }, | ||
" | "sourceid": { | ||
" | "$ref": "Array.Integer", | ||
"description": "The ids of sources with songs of the genre" | |||
}, | }, | ||
"thumbnail": { | "thumbnail": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "title": { | ||
" | "default": "", | ||
" | "type": "string" | ||
} | } | ||
} | } | ||
Line 10,635: | Line 11,986: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* ''string'' file | * ''string'' file | ||
* [''[[#Array.String|Array.String]]'' paths] | * [''[[#Array.String|Array.String]]'' paths] | ||
* ''[[#Library.Id|Library.Id]]'' sourceid | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Item.Details.Base", | ||
"id": "Library.Details.Source", | |||
"properties": { | "properties": { | ||
"file": { | "file": { | ||
"description": "The url encoded multipath string combining all paths of the source ", | "description": "The url encoded multipath string combining all paths of the source ", | ||
"required": true | "required": true, | ||
"type": "string" | |||
}, | }, | ||
"paths": { | "paths": { | ||
"$ref": "Array.String", | "$ref": "Array.String", | ||
"description": "The individual paths of the media source" | "description": "The individual paths of the media source" | ||
}, | |||
"sourceid": { | |||
"$ref": "Library.Id", | |||
"required": true | |||
} | } | ||
} | } | ||
Line 10,667: | Line 12,019: | ||
* [''string'' title] | * [''string'' title] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Item.Details.Base", | ||
"id": "Library.Details.Tag", | |||
"properties": { | "properties": { | ||
"tagid": { | "tagid": { | ||
Line 10,676: | Line 12,029: | ||
}, | }, | ||
"title": { | "title": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | } | ||
Line 10,684: | Line 12,038: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Library.Fields.Genre", | |||
"items": { | "items": { | ||
" | "enums": [ | ||
"title", | "title", | ||
"thumbnail", | "thumbnail", | ||
"sourceid" | "sourceid" | ||
] | ], | ||
"type": "string" | |||
} | } | ||
} | } | ||
Line 10,700: | Line 12,055: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Library.Fields.Source", | |||
"items": { | "items": { | ||
" | "enums": [ | ||
"file", | "file", | ||
"paths" | "paths" | ||
] | ], | ||
"type": "string" | |||
} | } | ||
} | } | ||
Line 10,715: | Line 12,071: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Library.Fields.Tag", | |||
"items": { | "items": { | ||
" | "enums": [ | ||
"title" | "title" | ||
] | ], | ||
"type": "string" | |||
} | } | ||
} | } | ||
Line 10,729: | Line 12,086: | ||
'''Type:''' ''integer'' | '''Type:''' ''integer'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | ||
{ | { | ||
"default": -1, | "default": -1, | ||
"minimum": 1 | "id": "Library.Id", | ||
"minimum": 1, | |||
"type": "integer" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 10,740: | Line 12,098: | ||
'''Type:''' ''integer'' | '''Type:''' ''integer'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | ||
{ | { | ||
"default": -1, | "default": -1, | ||
"minimum": 0 | "id": "List.Amount", | ||
"minimum": 0, | |||
"type": "integer" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 10,750: | Line 12,109: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "List.Fields.All", | |||
"items": { | "items": { | ||
" | "enums": [ | ||
"title", | "title", | ||
"artist", | "artist", | ||
Line 10,826: | Line 12,185: | ||
"locked", | "locked", | ||
"channelnumber", | "channelnumber", | ||
"subchannelnumber", | |||
"starttime", | "starttime", | ||
"endtime", | "endtime", | ||
Line 10,839: | Line 12,199: | ||
"displaylyricist", | "displaylyricist", | ||
"userrating", | "userrating", | ||
"sortartist", | "sortartist", | ||
"musicbrainzreleasegroupid", | "musicbrainzreleasegroupid", | ||
Line 10,852: | Line 12,211: | ||
"bitrate", | "bitrate", | ||
"samplerate", | "samplerate", | ||
"channels" | "channels", | ||
] | "albumstatus", | ||
"datemodified", | |||
"datenew", | |||
"customproperties", | |||
"albumduration" | |||
], | |||
"type": "string" | |||
} | } | ||
} | } | ||
Line 10,860: | Line 12,225: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "List.Fields.Files", | |||
"items": { | "items": { | ||
" | "enums": [ | ||
"title", | "title", | ||
"artist", | "artist", | ||
Line 10,946: | Line 12,311: | ||
"bitrate", | "bitrate", | ||
"samplerate", | "samplerate", | ||
"channels" | "channels", | ||
] | "datemodified", | ||
"datenew", | |||
"customproperties", | |||
"albumduration" | |||
], | |||
"type": "string" | |||
} | } | ||
} | } | ||
Line 10,954: | Line 12,324: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": [ | "type": [ | ||
{ | { | ||
"properties": { | "properties": { | ||
"and": { | "and": { | ||
"items": { | "items": { | ||
"$ref": "List.Filter.Albums" | "$ref": "List.Filter.Albums" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"required": true | "required": true, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"properties": { | "properties": { | ||
"or": { | "or": { | ||
"items": { | "items": { | ||
"$ref": "List.Filter.Albums" | "$ref": "List.Filter.Albums" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"required": true | "required": true, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
Line 10,992: | Line 12,363: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": [ | "type": [ | ||
{ | { | ||
"properties": { | "properties": { | ||
"and": { | "and": { | ||
"items": { | "items": { | ||
"$ref": "List.Filter.Artists" | "$ref": "List.Filter.Artists" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"required": true | "required": true, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"properties": { | "properties": { | ||
"or": { | "or": { | ||
"items": { | "items": { | ||
"$ref": "List.Filter.Artists" | "$ref": "List.Filter.Artists" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"required": true | "required": true, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
Line 11,030: | Line 12,402: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": [ | "type": [ | ||
{ | { | ||
"properties": { | "properties": { | ||
"and": { | "and": { | ||
"items": { | "items": { | ||
"$ref": "List.Filter.Episodes" | "$ref": "List.Filter.Episodes" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"required": true | "required": true, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"properties": { | "properties": { | ||
"or": { | "or": { | ||
"items": { | "items": { | ||
"$ref": "List.Filter.Episodes" | "$ref": "List.Filter.Episodes" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"required": true | "required": true, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
Line 11,065: | Line 12,438: | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== List.Filter. | ==== List.Filter.Fields.Albums ==== | ||
'''Type:''' '' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | ||
{ | { | ||
"type": [ | "default": "genre", | ||
{ | "enums": [ | ||
"genre", | |||
"properties": { | "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", | |||
"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", | |||
"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", | |||
"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": { | "and": { | ||
"items": { | "items": { | ||
"$ref": "List.Filter.Movies" | "$ref": "List.Filter.Movies" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"required": true | "required": true, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"properties": { | "properties": { | ||
"or": { | "or": { | ||
"items": { | "items": { | ||
"$ref": "List.Filter.Movies" | "$ref": "List.Filter.Movies" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"required": true | "required": true, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
Line 11,106: | Line 12,788: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": [ | "type": [ | ||
{ | { | ||
"properties": { | "properties": { | ||
"and": { | "and": { | ||
"items": { | "items": { | ||
"$ref": "List.Filter.MusicVideos" | "$ref": "List.Filter.MusicVideos" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"required": true | "required": true, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"properties": { | "properties": { | ||
"or": { | "or": { | ||
"items": { | "items": { | ||
"$ref": "List.Filter.MusicVideos" | "$ref": "List.Filter.MusicVideos" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"required": true | "required": true, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
Line 11,139: | Line 12,822: | ||
} | } | ||
] | ] | ||
} | |||
</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>}} | </syntaxhighlight>}} | ||
Line 11,149: | Line 12,859: | ||
* ''mixed: string|array'' value | * ''mixed: string|array'' value | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"operator": { | "operator": { | ||
Line 11,158: | Line 12,868: | ||
}, | }, | ||
"value": { | "value": { | ||
"required": true, | |||
"type": [ | "type": [ | ||
{ | { | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"items": { | "items": { | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "type": "array" | ||
} | } | ||
] | ] | ||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 11,183: | Line 12,892: | ||
* ''[[#List.Filter.Fields.Albums|List.Filter.Fields.Albums]]'' field | * ''[[#List.Filter.Fields.Albums|List.Filter.Fields.Albums]]'' field | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "List.Filter.Rule", | ||
"id": "List.Filter.Rule.Albums", | |||
"properties": { | "properties": { | ||
"field": { | "field": { | ||
Line 11,201: | Line 12,911: | ||
* ''[[#List.Filter.Fields.Artists|List.Filter.Fields.Artists]]'' field | * ''[[#List.Filter.Fields.Artists|List.Filter.Fields.Artists]]'' field | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "List.Filter.Rule", | ||
"id": "List.Filter.Rule.Artists", | |||
"properties": { | "properties": { | ||
"field": { | "field": { | ||
Line 11,219: | Line 12,930: | ||
* ''[[#List.Filter.Fields.Episodes|List.Filter.Fields.Episodes]]'' field | * ''[[#List.Filter.Fields.Episodes|List.Filter.Fields.Episodes]]'' field | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "List.Filter.Rule", | ||
"id": "List.Filter.Rule.Episodes", | |||
"properties": { | "properties": { | ||
"field": { | "field": { | ||
Line 11,237: | Line 12,949: | ||
* ''[[#List.Filter.Fields.Movies|List.Filter.Fields.Movies]]'' field | * ''[[#List.Filter.Fields.Movies|List.Filter.Fields.Movies]]'' field | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "List.Filter.Rule", | ||
"id": "List.Filter.Rule.Movies", | |||
"properties": { | "properties": { | ||
"field": { | "field": { | ||
Line 11,255: | Line 12,968: | ||
* ''[[#List.Filter.Fields.MusicVideos|List.Filter.Fields.MusicVideos]]'' field | * ''[[#List.Filter.Fields.MusicVideos|List.Filter.Fields.MusicVideos]]'' field | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "List.Filter.Rule", | ||
"id": "List.Filter.Rule.MusicVideos", | |||
"properties": { | "properties": { | ||
"field": { | "field": { | ||
Line 11,273: | Line 12,987: | ||
* ''[[#List.Filter.Fields.Songs|List.Filter.Fields.Songs]]'' field | * ''[[#List.Filter.Fields.Songs|List.Filter.Fields.Songs]]'' field | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "List.Filter.Rule", | ||
"id": "List.Filter.Rule.Songs", | |||
"properties": { | "properties": { | ||
"field": { | "field": { | ||
Line 11,291: | Line 13,006: | ||
* ''[[#List.Filter.Fields.TVShows|List.Filter.Fields.TVShows]]'' field | * ''[[#List.Filter.Fields.TVShows|List.Filter.Fields.TVShows]]'' field | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "List.Filter.Rule", | ||
"id": "List.Filter.Rule.TVShows", | |||
"properties": { | "properties": { | ||
"field": { | "field": { | ||
Line 11,309: | Line 13,025: | ||
* ''[[#List.Filter.Fields.Textures|List.Filter.Fields.Textures]]'' field | * ''[[#List.Filter.Fields.Textures|List.Filter.Fields.Textures]]'' field | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "List.Filter.Rule", | ||
"id": "List.Filter.Rule.Textures", | |||
"properties": { | "properties": { | ||
"field": { | "field": { | ||
Line 11,323: | Line 13,040: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": [ | "type": [ | ||
{ | { | ||
"properties": { | "properties": { | ||
"and": { | "and": { | ||
"items": { | "items": { | ||
"$ref": "List.Filter.Songs" | "$ref": "List.Filter.Songs" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"required": true | "required": true, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"properties": { | "properties": { | ||
"or": { | "or": { | ||
"items": { | "items": { | ||
"$ref": "List.Filter.Songs" | "$ref": "List.Filter.Songs" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"required": true | "required": true, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
Line 11,361: | Line 13,079: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": [ | "type": [ | ||
{ | { | ||
"properties": { | "properties": { | ||
"and": { | "and": { | ||
"items": { | "items": { | ||
"$ref": "List.Filter.TVShows" | "$ref": "List.Filter.TVShows" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"required": true | "required": true, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"properties": { | "properties": { | ||
"or": { | "or": { | ||
"items": { | "items": { | ||
"$ref": "List.Filter.TVShows" | "$ref": "List.Filter.TVShows" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"required": true | "required": true, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
Line 11,399: | Line 13,118: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": [ | "type": [ | ||
{ | { | ||
"properties": { | "properties": { | ||
"and": { | "and": { | ||
"items": { | "items": { | ||
"$ref": "List.Filter.Textures" | "$ref": "List.Filter.Textures" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"required": true | "required": true, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"properties": { | "properties": { | ||
"or": { | "or": { | ||
"items": { | "items": { | ||
"$ref": "List.Filter.Textures" | "$ref": "List.Filter.Textures" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"required": true | "required": true, | ||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
Line 11,440: | Line 13,160: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* [''string'' channel] | * [''string'' channel] | ||
* [''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype] | * [''integer'' channelnumber] | ||
* [''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = tv] | |||
* [''string'' endtime] | |||
* [''boolean'' hidden] | * [''boolean'' hidden] | ||
* [''boolean'' locked] | * [''boolean'' locked] | ||
* [''string'' starttime] | * [''string'' starttime] | ||
* ['' | * [''integer'' subchannelnumber] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "List.Item.Base", | ||
"id": "List.Item.All", | |||
"properties": { | "properties": { | ||
"channel": { | "channel": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | |||
"channelnumber": { | |||
"default": 0, | |||
"type": "integer" | |||
}, | }, | ||
"channeltype": { | "channeltype": { | ||
"$ref": "PVR.Channel.Type" | "$ref": "PVR.Channel.Type", | ||
"default": "tv" | |||
}, | |||
"endtime": { | |||
"default": "", | |||
"type": "string" | |||
}, | }, | ||
"hidden": { | "hidden": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
"locked": { | "locked": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
"starttime": { | "starttime": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "subchannelnumber": { | ||
"type": " | "default": 0, | ||
"type": "integer" | |||
} | } | ||
} | } | ||
Line 11,481: | Line 13,214: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* [''string'' album] | |||
* [''string'' | |||
* [''[[#Array.String|Array.String]]'' albumartist] | * [''[[#Array.String|Array.String]]'' albumartist] | ||
* [''string'' album] | * [''[[#Array.Integer|Array.Integer]]'' albumartistid] | ||
* [''integer'' | * [''[[#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] | * [''integer'' duration] | ||
* [''string'' | * [''string'' dynpath] | ||
* [''integer'' episode] | |||
* [''string'' episodeguide] | |||
* [''string'' firstaired] | |||
* [''[[#Library.Id|Library.Id]]'' id = -1] | |||
* [''string'' imdbnumber] | |||
* [''boolean'' isboxset] | |||
* [''string'' lyrics] | * [''string'' lyrics] | ||
* [''string'' mediapath] | |||
* [''[[#Array.String|Array.String]]'' mood] | |||
* [''string'' mpaa] | |||
* [''[[#Array.String|Array.String]]'' musicbrainzartistid] | |||
* [''string'' musicbrainztrackid] | * [''string'' musicbrainztrackid] | ||
* [''string'' originaldate] | |||
* [''string'' | * [''string'' originaltitle] | ||
* [''string'' | |||
* [''string'' plotoutline] | * [''string'' plotoutline] | ||
* [''string'' premiered] | * [''string'' premiered] | ||
* [''string'' productioncode] | * [''string'' productioncode] | ||
* [''string'' releasedate] | |||
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = album] | |||
* [''integer'' samplerate] | |||
* [''integer'' season] | |||
* [''string'' set] | * [''string'' set] | ||
* [''[[#Library.Id|Library.Id]]'' setid = -1] | |||
* [''[[#Array.String|Array.String]]'' showlink] | * [''[[#Array.String|Array.String]]'' showlink] | ||
* [''string'' showtitle] | * [''string'' showtitle] | ||
* [''[[ | * [''string'' sorttitle] | ||
* [''[[# | * [''integer'' specialsortepisode] | ||
* [''[[# | * [''integer'' specialsortseason] | ||
* [''[[#Array.String|Array.String]]'' studio] | |||
* [''[[#Array.String|Array.String]]'' style] | |||
* [''[[#Array.String|Array.String]]'' tag] | * [''[[#Array.String|Array.String]]'' tag] | ||
* [''[[#Array. | * [''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] | * [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid] | ||
* [''string'' | * [''string'' votes] | ||
* ['' | * [''integer'' watchedepisodes] | ||
* [''[[#Array.String|Array.String]]'' writer] | |||
* [''[[#Array.String|Array.String]]'' | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | ||
{ | { | ||
"extends": [ | "extends": [ | ||
Line 11,554: | Line 13,289: | ||
"Audio.Details.Media" | "Audio.Details.Media" | ||
], | ], | ||
"id": "List.Item.Base", | |||
"properties": { | "properties": { | ||
" | "album": { | ||
" | "default": "", | ||
"type": "string" | |||
"type": "string" | |||
}, | }, | ||
"albumartist": { | "albumartist": { | ||
"$ref": "Array.String" | "$ref": "Array.String" | ||
}, | }, | ||
"album": { | "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" | "type": "string" | ||
}, | }, | ||
" | "bitrate": { | ||
"default": 0, | |||
"type": "integer" | |||
}, | |||
"bpm": { | |||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "cast": { | ||
"$ref": "Video.Cast" | |||
}, | |||
"channels": { | |||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
"comment": { | "comment": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "compilation": { | ||
"type": " | "default": false, | ||
"type": "boolean" | |||
}, | }, | ||
" | "contributors": { | ||
" | "$ref": "Audio.Contributors" | ||
}, | }, | ||
" | "country": { | ||
"$ref": "Array.String" | "$ref": "Array.String" | ||
}, | }, | ||
" | "customproperties": { | ||
" | "$ref": "Item.CustomProperties" | ||
}, | }, | ||
" | "description": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "disc": { | ||
"default": 0, | |||
"type": "integer" | |||
}, | |||
"disctitle": { | |||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "displaycomposer": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "displayconductor": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "displaylyricist": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "displayorchestra": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "duration": { | ||
"type": " | "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" | "type": "string" | ||
}, | }, | ||
" | "episode": { | ||
" | "default": 0, | ||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "episodeguide": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
"firstaired": { | "firstaired": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "id": { | ||
" | "$ref": "Library.Id", | ||
"default": -1 | |||
}, | }, | ||
" | "imdbnumber": { | ||
" | "default": "", | ||
"type": "string" | "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": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "musicbrainzartistid": { | ||
"$ref": "Array.String" | "$ref": "Array.String" | ||
}, | }, | ||
" | "musicbrainztrackid": { | ||
" | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "originaldate": { | ||
" | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "originaltitle": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "plotoutline": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "premiered": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "productioncode": { | ||
" | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "releasedate": { | ||
" | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "releasetype": { | ||
"$ref": " | "$ref": "Audio.Album.ReleaseType", | ||
"default": "album" | |||
}, | }, | ||
" | "samplerate": { | ||
" | "default": 0, | ||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "season": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "set": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "setid": { | ||
"$ref": " | "$ref": "Library.Id", | ||
"default": -1 | |||
}, | }, | ||
" | "showlink": { | ||
"$ref": " | "$ref": "Array.String" | ||
}, | }, | ||
" | "showtitle": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "sorttitle": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "specialsortepisode": { | ||
"type": " | "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" | "type": "string" | ||
}, | }, | ||
" | "theme": { | ||
" | "$ref": "Array.String" | ||
}, | }, | ||
" | "top250": { | ||
" | "default": 0, | ||
" | "type": "integer" | ||
}, | }, | ||
" | "totaldiscs": { | ||
"type": " | "default": 0, | ||
"type": "integer" | |||
}, | }, | ||
" | "track": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "trailer": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "tvshowid": { | ||
" | "$ref": "Library.Id", | ||
"default": -1 | |||
}, | }, | ||
" | "type": { | ||
"default": "unknown", | |||
"enums": [ | |||
"unknown", | |||
"movie", | |||
"episode", | |||
"musicvideo", | |||
"song", | |||
"picture", | |||
"channel" | |||
], | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "uniqueid": { | ||
" | "$ref": "Media.UniqueID" | ||
}, | }, | ||
" | "votes": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "watchedepisodes": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "writer": { | ||
" | "$ref": "Array.String" | ||
} | } | ||
} | } | ||
Line 11,774: | Line 13,569: | ||
* ''string'' file | * ''string'' file | ||
* ''string'' filetype | * ''string'' filetype | ||
* [''string'' lastmodified] | * [''string'' lastmodified] | ||
* [''string'' mimetype] | * [''string'' mimetype] | ||
* [''integer'' size] | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "List.Item.Base", | ||
"id": "List.Item.File", | |||
"properties": { | "properties": { | ||
"file": { | "file": { | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
"filetype": { | "filetype": { | ||
" | "enums": [ | ||
"file", | "file", | ||
"directory" | "directory" | ||
], | ], | ||
"required": true | "required": true, | ||
"type": "string" | |||
"type": " | |||
}, | }, | ||
"lastmodified": { | "lastmodified": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
"mimetype": { | "mimetype": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | |||
"size": { | |||
"default": 0, | |||
"description": "Size of the file in bytes", | |||
"type": "integer" | |||
} | } | ||
} | } | ||
Line 11,810: | Line 13,609: | ||
'''Type:''' ''array'' | '''Type:''' ''array'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "items": { | ||
"extends": "Item.Details.Base", | "extends": "Item.Details.Base", | ||
"properties": { | "properties": { | ||
"file": { | "file": { | ||
" | "required": true, | ||
" | "type": "string" | ||
} | } | ||
} | } | ||
} | }, | ||
"type": "array" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 11,829: | Line 13,629: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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'' start] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"end": { | "end": { | ||
"$ref": "List.Amount", | "$ref": "List.Amount", | ||
"default": -1, | |||
"description": "Index of the last item to return" | "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>}} | </syntaxhighlight>}} | ||
Line 11,855: | Line 13,657: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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'' start] | ||
* ''integer'' total | * ''integer'' total | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"end": { | |||
"$ref": "List.Amount", | |||
"default": -1 | |||
}, | |||
"start": { | "start": { | ||
" | "default": 0, | ||
"minimum": 0, | "minimum": 0, | ||
" | "type": "integer" | ||
}, | }, | ||
"total": { | "total": { | ||
"minimum": 0, | "minimum": 0, | ||
"required": true | "required": true, | ||
"type": "integer" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 11,885: | Line 13,689: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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'' method = none] | ||
* [''string'' order = ascending] | * [''string'' order = ascending] | ||
* [''boolean'' useartistsortname] | * [''boolean'' useartistsortname] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"ignorearticle": { | |||
"default": false, | |||
"type": "boolean" | |||
}, | |||
"method": { | "method": { | ||
"default": "none", | "default": "none", | ||
" | "enums": [ | ||
"none", | "none", | ||
"label", | "label", | ||
Line 11,939: | Line 13,746: | ||
"originaldate", | "originaldate", | ||
"bpm" | "bpm" | ||
] | ], | ||
"type": "string" | |||
}, | }, | ||
"order": { | "order": { | ||
"default": "ascending", | "default": "ascending", | ||
" | "enums": [ | ||
"ascending", | "ascending", | ||
"descending" | "descending" | ||
] | ], | ||
"type": "string" | |||
"type": " | |||
}, | }, | ||
"useartistsortname": { | "useartistsortname": { | ||
" | "default": false, | ||
" | "type": "boolean" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 11,966: | Line 13,771: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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]]'' banner] | ||
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' fanart] | * [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' fanart] | ||
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' poster] | |||
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' thumb] | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"banner": { | "banner": { | ||
"$ref": "Global.String.NotEmpty" | "$ref": "Global.String.NotEmpty", | ||
"default": "" | |||
}, | }, | ||
"fanart": { | "fanart": { | ||
"$ref": "Global.String.NotEmpty" | "$ref": "Global.String.NotEmpty", | ||
"default": "" | |||
}, | |||
"poster": { | |||
"$ref": "Global.String.NotEmpty", | |||
"default": "" | |||
}, | |||
"thumb": { | |||
"$ref": "Global.String.NotEmpty", | |||
"default": "" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 11,998: | Line 13,809: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* [''mixed: [[#Global.String.NotEmpty|Global.String.NotEmpty]]'' | * [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' banner] | ||
* [''mixed: [[#Global.String.NotEmpty|Global.String.NotEmpty]]'' | * [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' fanart] | ||
* [''mixed: [[#Global.String.NotEmpty|Global.String.NotEmpty]]'' | * [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' poster] | ||
* [''mixed: [[#Global.String.NotEmpty|Global.String.NotEmpty]]'' | * [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' thumb] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | ||
{ | { | ||
"type": " | "additionalProperties": { | ||
"default": null, | |||
"type": [ | |||
{ | |||
"type": "null" | |||
}, | |||
{ | |||
"$ref": "Global.String.NotEmpty" | |||
} | |||
] | |||
}, | |||
"id": "Media.Artwork.Set", | |||
"properties": { | "properties": { | ||
" | "banner": { | ||
"default": "", | |||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Global.String.NotEmpty" | "type": "null" | ||
}, | |||
{ | |||
"$ref": "Global.String.NotEmpty" | |||
} | } | ||
] | ] | ||
}, | }, | ||
" | "fanart": { | ||
"default": "", | |||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Global.String.NotEmpty" | "type": "null" | ||
}, | |||
{ | |||
"$ref": "Global.String.NotEmpty" | |||
} | } | ||
] | ] | ||
}, | }, | ||
" | "poster": { | ||
"default": "", | |||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Global.String.NotEmpty" | "type": "null" | ||
}, | |||
{ | |||
"$ref": "Global.String.NotEmpty" | |||
} | } | ||
] | ] | ||
}, | }, | ||
" | "thumb": { | ||
"default": "", | |||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Global.String.NotEmpty" | "type": "null" | ||
}, | |||
{ | |||
"$ref": "Global.String.NotEmpty" | |||
} | } | ||
] | ] | ||
} | } | ||
}, | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 12,067: | Line 13,885: | ||
* [''string'' thumbnail] | * [''string'' thumbnail] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Item.Details.Base", | ||
"id": "Media.Details.Base", | |||
"properties": { | "properties": { | ||
"fanart": { | "fanart": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
"thumbnail": { | "thumbnail": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | } | ||
Line 12,083: | Line 13,904: | ||
'''Type:''' ''object'' | '''Type:''' ''object'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | ||
{ | { | ||
"additionalProperties": { | "additionalProperties": { | ||
"$ref": "Global.String.NotEmpty" | "$ref": "Global.String.NotEmpty", | ||
} | "default": "" | ||
}, | |||
"id": "Media.UniqueID", | |||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 12,094: | Line 13,917: | ||
'''Type:''' ''object'' | '''Type:''' ''object'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | ||
{ | { | ||
"additionalProperties": { | "additionalProperties": { | ||
"default": null, | |||
"type": [ | "type": [ | ||
{ | { | ||
"$ref": "Global.String.NotEmpty" | "type": "null" | ||
}, | |||
{ | |||
"$ref": "Global.String.NotEmpty" | |||
} | } | ||
] | ] | ||
} | }, | ||
"id": "Media.UniqueID.Set", | |||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 12,112: | Line 13,938: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": [ | "type": [ | ||
{ | { | ||
"description": "An unknown item does not have any additional information.", | "description": "An unknown item does not have any additional information.", | ||
"properties": { | "properties": { | ||
Line 12,123: | Line 13,949: | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"description": "An item known to the database has an identification.", | "description": "An item known to the database has an identification.", | ||
"properties": { | "properties": { | ||
"id": { | |||
"$ref": "Library.Id", | |||
"required": true | |||
}, | |||
"type": { | "type": { | ||
"$ref": "Notifications.Item.Type", | "$ref": "Notifications.Item.Type", | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"description": "A movie item has a title and may have a release year.", | "description": "A movie item has a title and may have a release year.", | ||
"properties": { | "properties": { | ||
"title": { | |||
"required": true, | |||
"type": "string" | |||
}, | |||
"type": { | "type": { | ||
"$ref": "Notifications.Item.Type", | "$ref": "Notifications.Item.Type", | ||
"required": true | "required": true | ||
}, | }, | ||
"year": { | "year": { | ||
"default": 0, | |||
"type": "integer" | "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.", | "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": { | "properties": { | ||
"episode": { | "episode": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
"season": { | "season": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
"showtitle": { | "showtitle": { | ||
"default": "", | |||
"type": "string" | "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.", | "description": "A music video has a title and may have an album and an artist.", | ||
"properties": { | "properties": { | ||
"album": { | "album": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
"artist": { | "artist": { | ||
"default": "", | |||
"type": "string" | "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.", | "description": "A song has a title and may have an album, an artist and a track number.", | ||
"properties": { | "properties": { | ||
"album": { | "album": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
"artist": { | "artist": { | ||
"default": "", | |||
"type": "string" | |||
}, | |||
"title": { | |||
"required": true, | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
"track": { | "track": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | |||
"type": { | |||
"$ref": "Notifications.Item.Type", | |||
"required": true | |||
} | } | ||
} | }, | ||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"description": "A picture has a file path.", | "description": "A picture has a file path.", | ||
"properties": { | "properties": { | ||
"file": { | |||
"required": true, | |||
"type": "string" | |||
}, | |||
"type": { | "type": { | ||
"$ref": "Notifications.Item.Type", | "$ref": "Notifications.Item.Type", | ||
"required": true | "required": true | ||
}, | } | ||
}, | |||
"type": "object" | |||
}, | }, | ||
{ | { | ||
"description": "A PVR channel is either a radio or tv channel and has a title.", | "description": "A PVR channel is either a radio or tv channel and has a title.", | ||
"properties": { | "properties": { | ||
" | "channeltype": { | ||
"$ref": " | "$ref": "PVR.Channel.Type", | ||
"required": true | "required": true | ||
}, | }, | ||
Line 12,249: | Line 14,084: | ||
}, | }, | ||
"title": { | "title": { | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
" | "type": { | ||
"$ref": " | "$ref": "Notifications.Item.Type", | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
] | ] | ||
Line 12,264: | Line 14,100: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "unknown", | ||
"movie", | "movie", | ||
Line 12,275: | Line 14,111: | ||
"picture", | "picture", | ||
"channel" | "channel" | ||
] | ], | ||
"id": "Notifications.Item.Type", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 12,282: | Line 14,120: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | { | ||
"boolean" | "type": "null" | ||
] | }, | ||
{ | |||
"type": "boolean" | |||
} | |||
] | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 12,294: | Line 14,137: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | { | ||
"integer" | "type": "null" | ||
] | }, | ||
{ | |||
"type": "integer" | |||
} | |||
] | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 12,306: | Line 14,154: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | { | ||
"number" | "type": "null" | ||
] | }, | ||
{ | |||
"type": "number" | |||
} | |||
] | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 12,318: | Line 14,171: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | { | ||
"string" | "type": "null" | ||
] | }, | ||
{ | |||
"type": "string" | |||
} | |||
] | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 12,331: | Line 14,189: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "tv", | ||
"radio" | "radio" | ||
] | ], | ||
"id": "PVR.Channel.Type", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 12,343: | Line 14,203: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": [ | "type": [ | ||
{ | { | ||
"$ref": "Library.Id" | "$ref": "Library.Id" | ||
}, | }, | ||
{ | { | ||
" | "enums": [ | ||
"alltv", | "alltv", | ||
"allradio" | "allradio" | ||
], | ], | ||
" | "type": "string" | ||
} | } | ||
] | ] | ||
Line 12,367: | Line 14,227: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''[[#Library.Id|Library.Id]]'' broadcastid | ||
* [''string'' | * [''string'' cast] | ||
* ['' | * [''[[#Library.Id|Library.Id]]'' clientid = -1] | ||
* [''string'' director] | |||
* [''string'' | |||
* [''string'' endtime] | * [''string'' endtime] | ||
* [''string'' episodename] | * [''string'' episodename] | ||
* [''integer'' episodenum] | * [''integer'' episodenum] | ||
* [''integer'' episodepart] | * [''integer'' episodepart] | ||
* [''string'' firstaired] | * [''string'' firstaired] | ||
* [''string'' genre] | |||
* [''boolean'' hasrecording] | |||
* [''boolean'' hasreminder] | |||
* [''boolean'' hastimer] | * [''boolean'' hastimer] | ||
* [''boolean'' hastimerrule] | |||
* [''integer'' imdbnumber] | |||
* [''boolean'' isactive] | * [''boolean'' isactive] | ||
* [''boolean'' isplayable] | |||
* [''boolean'' isseries] | |||
* [''string'' originaltitle] | |||
* [''integer'' parentalrating] | * [''integer'' parentalrating] | ||
* ['' | * [''string'' plot] | ||
* [''string'' plotoutline] | |||
* [''integer'' progress] | |||
* [''number'' progresspercentage] | |||
* [''integer'' rating] | |||
* [''string'' recording] | |||
* [''integer'' runtime] | |||
* [''string'' starttime] | |||
* [''string'' thumbnail] | * [''string'' thumbnail] | ||
* [''string'' title] | |||
* [''boolean'' wasactive] | |||
* [''string'' | |||
* ['' | |||
* [''string'' writer] | * [''string'' writer] | ||
* [''integer'' year] | * [''integer'' year] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Item.Details.Base", | ||
"id": "PVR.Details.Broadcast", | |||
"properties": { | "properties": { | ||
"broadcastid": { | "broadcastid": { | ||
Line 12,406: | Line 14,269: | ||
"required": true | "required": true | ||
}, | }, | ||
" | "cast": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "clientid": { | ||
" | "$ref": "Library.Id", | ||
"default": -1 | |||
}, | }, | ||
" | "director": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
"endtime": { | "endtime": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
"episodename": { | "episodename": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
"episodenum": { | "episodenum": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
"episodepart": { | "episodepart": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
"firstaired": { | "firstaired": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | |||
"genre": { | |||
"default": "", | |||
"type": "string" | |||
}, | |||
"hasrecording": { | |||
"default": false, | |||
"type": "boolean" | |||
}, | |||
"hasreminder": { | |||
"default": false, | |||
"type": "boolean" | |||
}, | }, | ||
"hastimer": { | "hastimer": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
" | "hastimerrule": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
" | "imdbnumber": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "isactive": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
" | "isplayable": { | ||
"type": " | "default": false, | ||
"description": "Deprecated - Use GetBroadcastIsPlayable instead", | |||
"type": "boolean" | |||
}, | }, | ||
" | "isseries": { | ||
"type": " | "default": false, | ||
"type": "boolean" | |||
}, | }, | ||
"originaltitle": { | "originaltitle": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "parentalrating": { | ||
"default": 0, | |||
"type": "integer" | |||
}, | |||
"plot": { | |||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "plotoutline": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "progress": { | ||
"type": " | "default": 0, | ||
"type": "integer" | |||
}, | |||
"progresspercentage": { | |||
"default": 0.0, | |||
"type": "number" | |||
}, | }, | ||
" | "rating": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "recording": { | ||
"default": "", | |||
"type": "string" | |||
}, | |||
"runtime": { | |||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "starttime": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "thumbnail": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "title": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "wasactive": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
" | "writer": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
}, | |||
"year": { | |||
"default": 0, | |||
"type": "integer" | |||
} | } | ||
} | } | ||
Line 12,504: | Line 14,406: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''[[#Library.Id|Library.Id]]'' channelid | ||
* ['' | * [''integer'' channelnumber] | ||
* [''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype] | * [''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = tv] | ||
* [''[[#Library.Id|Library.Id]]'' clientid = -1] | |||
* [''boolean'' hasarchive] | |||
* [''boolean'' hidden] | * [''boolean'' hidden] | ||
* [''string'' icon] | |||
* [''boolean'' isrecording] | |||
* [''string'' lastplayed] | |||
* [''boolean'' locked] | * [''boolean'' locked] | ||
* [''integer'' subchannelnumber] | |||
* [''string'' thumbnail] | * [''string'' thumbnail] | ||
* ''integer'' uniqueid | * ''integer'' uniqueid | ||
</div> | |||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | |||
{ | |||
</div> | |||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | |||
{ | |||
"extends": "Item.Details.Base", | "extends": "Item.Details.Base", | ||
"id": "PVR.Details.Channel", | |||
"properties": { | "properties": { | ||
"broadcastnext": { | |||
"$ref": "PVR.Details.Broadcast" | |||
}, | |||
"broadcastnow": { | |||
"$ref": "PVR.Details.Broadcast" | |||
}, | |||
"channel": { | |||
"default": "", | |||
"type": "string" | |||
}, | |||
"channelid": { | "channelid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
}, | }, | ||
" | "channelnumber": { | ||
"type": " | "default": 0, | ||
"type": "integer" | |||
}, | }, | ||
"channeltype": { | "channeltype": { | ||
"$ref": "PVR.Channel.Type" | "$ref": "PVR.Channel.Type", | ||
"default": "tv" | |||
}, | |||
"clientid": { | |||
"$ref": "Library.Id", | |||
"default": -1 | |||
}, | }, | ||
" | "hasarchive": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
" | "hidden": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
" | "icon": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | |||
"isrecording": { | |||
"default": false, | |||
"type": "boolean" | |||
}, | }, | ||
"lastplayed": { | "lastplayed": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "locked": { | ||
" | "default": false, | ||
"type": "boolean" | |||
}, | }, | ||
" | "subchannelnumber": { | ||
" | "default": 0, | ||
"type": "integer" | |||
}, | }, | ||
" | "thumbnail": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "uniqueid": { | ||
"required": true, | |||
"type": "integer" | "type": "integer" | ||
} | } | ||
} | } | ||
Line 12,582: | Line 14,501: | ||
* ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype | * ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Item.Details.Base", | ||
"id": "PVR.Details.ChannelGroup", | |||
"properties": { | "properties": { | ||
"channelgroupid": { | "channelgroupid": { | ||
Line 12,602: | Line 14,522: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "PVR.Details.ChannelGroup", | ||
"id": "PVR.Details.ChannelGroup.Extended", | |||
"properties": { | "properties": { | ||
"channels": { | |||
"items": { | |||
"$ref": "PVR.Details.Channel" | |||
}, | |||
"type": "array" | |||
}, | |||
"limits": { | "limits": { | ||
"$ref": "List.LimitsReturned", | "$ref": "List.LimitsReturned", | ||
"required": true | "required": true | ||
} | } | ||
} | } | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== PVR.Details. | ==== PVR.Details.Client ==== | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Details.Base|Item.Details.Base]]'' | * ''[[#Item.Details.Base|Item.Details.Base]]'' | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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] | |||
* [''string'' | * [''boolean'' supportsepg] | ||
* [''boolean'' supportsradio] | |||
* | * [''boolean'' supportsrecordings] | ||
* ['' | * [''boolean'' supportstimers] | ||
* ['' | * [''boolean'' supportstv] | ||
* ['' | |||
* ['' | |||
* ['' | |||
* [''boolean'' | |||
* [''boolean'' | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Item.Details.Base", | ||
"id": "PVR.Details.Client", | |||
"properties": { | "properties": { | ||
" | "addonid": { | ||
"default": "", | |||
"type": "string" | |||
}, | |||
"clientid": { | |||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
}, | }, | ||
" | "supportschannelgroups": { | ||
"type": " | "default": false, | ||
"type": "boolean" | |||
}, | }, | ||
" | "supportschannelscan": { | ||
"type": " | "default": false, | ||
"type": "boolean" | |||
}, | }, | ||
" | "supportsepg": { | ||
"type": " | "default": false, | ||
"type": "boolean" | |||
}, | }, | ||
" | "supportsradio": { | ||
"type": " | "default": false, | ||
"type": "boolean" | |||
}, | }, | ||
" | "supportsrecordings": { | ||
"type": " | "default": false, | ||
"type": "boolean" | |||
}, | }, | ||
" | "supportstimers": { | ||
" | "default": false, | ||
"type": "boolean" | |||
}, | }, | ||
" | "supportstv": { | ||
"type": " | "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" | "type": "integer" | ||
}, | }, | ||
" | "clientid": { | ||
"type": " | "$ref": "Library.Id", | ||
"default": -1 | |||
}, | |||
"directory": { | |||
"default": "", | |||
"type": "string" | |||
}, | }, | ||
" | "endtime": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "epgeventid": { | ||
" | "default": 0, | ||
"type": "integer" | |||
}, | }, | ||
" | "episode": { | ||
"type": " | "default": 0, | ||
"type": "integer" | |||
}, | }, | ||
"file": { | "file": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "genre": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "icon": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
}, | }, | ||
"isdeleted": { | "isdeleted": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
" | "lifetime": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "playcount": { | ||
"default": 0, | |||
"type": "integer" | "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" | "type": "integer" | ||
}, | }, | ||
" | "season": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
"showtitle": { | "showtitle": { | ||
"default": "", | |||
"type": "string" | |||
}, | |||
"starttime": { | |||
"default": "", | |||
"type": "string" | |||
}, | |||
"streamurl": { | |||
"default": "", | |||
"type": "string" | |||
}, | |||
"title": { | |||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | } | ||
Line 12,737: | Line 14,744: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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]]'' | * [''[[#Library.Id|Library.Id]]'' broadcastid = -1] | ||
* [''string'' | * [''[[#Library.Id|Library.Id]]'' channelid = -1] | ||
* [''string'' | * [''[[#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'' isradio] | ||
* [''boolean'' isreadonly] | |||
* [''boolean'' isreminder] | |||
* [''boolean'' istimerrule] | * [''boolean'' istimerrule] | ||
* [''integer'' lifetime] | * [''integer'' lifetime] | ||
* ['' | * [''integer'' maxrecordings] | ||
* ['' | * [''integer'' preventduplicateepisodes] | ||
* [''integer'' priority] | * [''integer'' priority] | ||
* [''integer'' recordinggroup] | |||
* [''integer'' runtime] | |||
* [''boolean'' startanytime] | |||
* [''integer'' startmargin] | * [''integer'' startmargin] | ||
* ['' | * [''string'' starttime] | ||
* [''[[#PVR.TimerState|PVR.TimerState]]'' state] | * [''[[#PVR.TimerState|PVR.TimerState]]'' state = unknown] | ||
* [''string'' | * [''string'' summary] | ||
* | * ''[[#Library.Id|Library.Id]]'' timerid | ||
* [''string'' title] | |||
* [''array'' weekdays] | |||
* [''string'' | |||
* ['' | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Item.Details.Base", | ||
"id": "PVR.Details.Timer", | |||
"properties": { | "properties": { | ||
" | "broadcastid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
" | "default": -1 | ||
}, | }, | ||
"channelid": { | "channelid": { | ||
"$ref": "Library.Id" | "$ref": "Library.Id", | ||
"default": -1 | |||
}, | }, | ||
" | "clientid": { | ||
" | "$ref": "Library.Id", | ||
"default": -1 | |||
}, | }, | ||
" | "directory": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "endanytime": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
" | "endmargin": { | ||
"type": " | "default": 0, | ||
"type": "integer" | |||
}, | }, | ||
"endtime": { | "endtime": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "epgsearchstring": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "epguid": { | ||
" | "default": 0, | ||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
"file": { | "file": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "firstday": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "fulltextepgsearch": { | ||
" | "default": false, | ||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
" | "ismanual": { | ||
"default": false, | |||
"type": "boolean" | |||
}, | |||
"isradio": { | |||
"default": false, | |||
"type": "boolean" | |||
}, | |||
"isreadonly": { | |||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
" | "isreminder": { | ||
"type": " | "default": false, | ||
"type": "boolean" | |||
}, | }, | ||
" | "istimerrule": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
" | "lifetime": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
"maxrecordings": { | "maxrecordings": { | ||
"default": 0, | |||
"type": "integer" | |||
}, | |||
"preventduplicateepisodes": { | |||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "priority": { | ||
"default": 0, | |||
"type": "integer" | |||
}, | |||
"recordinggroup": { | |||
"default": 0, | |||
"type": "integer" | |||
}, | |||
"runtime": { | |||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "startanytime": { | ||
"default": false, | |||
"type": "boolean" | "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 | |||
} | } | ||
} | } | ||
Line 12,865: | Line 14,914: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "PVR.Fields.Broadcast", | |||
"items": { | "items": { | ||
" | "enums": [ | ||
"title", | "title", | ||
"plot", | "plot", | ||
Line 12,900: | Line 14,949: | ||
"recording", | "recording", | ||
"isseries", | "isseries", | ||
"isplayable" | "isplayable", | ||
] | "clientid", | ||
"hasreminder" | |||
], | |||
"type": "string" | |||
} | } | ||
} | } | ||
Line 12,908: | Line 14,960: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "PVR.Fields.Channel", | |||
"items": { | "items": { | ||
" | "enums": [ | ||
"thumbnail", | "thumbnail", | ||
"channeltype", | "channeltype", | ||
Line 12,927: | Line 14,979: | ||
"subchannelnumber", | "subchannelnumber", | ||
"isrecording", | "isrecording", | ||
"hasarchive" | "hasarchive", | ||
] | "clientid" | ||
], | |||
"type": "string" | |||
} | } | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
==== PVR.Fields. | ==== PVR.Fields.Client ==== | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "PVR.Fields.Client", | |||
"items": { | "items": { | ||
"type": "string", | "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", | "title", | ||
"plot", | "plot", | ||
Line 12,963: | Line 15,039: | ||
"season", | "season", | ||
"episode", | "episode", | ||
"showtitle" | "showtitle", | ||
] | "clientid" | ||
], | |||
"type": "string" | |||
} | } | ||
} | } | ||
Line 12,971: | Line 15,049: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "PVR.Fields.Timer", | |||
"items": { | "items": { | ||
" | "enums": [ | ||
"title", | "title", | ||
"summary", | "summary", | ||
Line 13,003: | Line 15,081: | ||
"maxrecordings", | "maxrecordings", | ||
"epguid", | "epguid", | ||
"isreadonly" | "isreadonly", | ||
] | "isreminder", | ||
"clientid", | |||
"broadcastid" | |||
], | |||
"type": "string" | |||
} | } | ||
} | } | ||
Line 13,011: | Line 15,093: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "available", | ||
"recording", | "recording", | ||
"scanning" | "scanning" | ||
] | ], | ||
"id": "PVR.Property.Name", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,030: | Line 15,114: | ||
* [''boolean'' scanning] | * [''boolean'' scanning] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"available": { | "available": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
"recording": { | "recording": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
"scanning": { | "scanning": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,049: | Line 15,137: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "unknown", | ||
"new", | "new", | ||
Line 13,064: | Line 15,152: | ||
"error", | "error", | ||
"disabled" | "disabled" | ||
] | ], | ||
"id": "PVR.TimerState", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,073: | Line 15,163: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* ''integer'' bitrate | * ''integer'' bitrate | ||
* ''integer'' channels | * ''integer'' channels | ||
* ''string'' codec | |||
* ''integer'' index | |||
* ''boolean'' isdefault | * ''boolean'' isdefault | ||
* ''boolean'' isimpaired | |||
* ''boolean'' isoriginal | * ''boolean'' isoriginal | ||
* '' | * ''string'' language | ||
* ''string'' name | |||
* ''integer'' samplerate | * ''integer'' samplerate | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
" | "bitrate": { | ||
" | "required": true, | ||
" | "type": "integer" | ||
}, | }, | ||
" | "channels": { | ||
"required": true, | |||
"required": true | "type": "integer" | ||
"type": " | |||
}, | }, | ||
"codec": { | "codec": { | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
" | "index": { | ||
" | "minimum": 0, | ||
" | "required": true, | ||
"type": "integer" | |||
}, | }, | ||
" | "isdefault": { | ||
" | "required": true, | ||
" | "type": "boolean" | ||
}, | }, | ||
" | "isimpaired": { | ||
" | "required": true, | ||
" | "type": "boolean" | ||
}, | }, | ||
"isoriginal": { | "isoriginal": { | ||
" | "required": true, | ||
" | "type": "boolean" | ||
}, | }, | ||
" | "language": { | ||
"type": " | "required": true, | ||
"required": true | "type": "string" | ||
}, | }, | ||
"samplerate": { | "name": { | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | |||
"samplerate": { | |||
"required": true, | |||
"type": "integer" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,137: | Line 15,228: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* [''mixed: string|[[#Optional. | * [''mixed: string|[[#Optional.Boolean|Optional.Boolean]]'' nonlinearstretch] | ||
* [''mixed: string|[[#Optional.Number|Optional.Number]]'' pixelratio] | * [''mixed: string|[[#Optional.Number|Optional.Number]]'' pixelratio] | ||
* [''mixed: string|[[#Optional.Number|Optional.Number]]'' verticalshift] | * [''mixed: string|[[#Optional.Number|Optional.Number]]'' verticalshift] | ||
* [''mixed: string|[[#Optional. | * [''mixed: string|[[#Optional.Number|Optional.Number]]'' zoom] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
" | "nonlinearstretch": { | ||
"default": null, | |||
"type": [ | "type": [ | ||
{ | { | ||
" | "enums": [ | ||
"increase", | "increase", | ||
"decrease" | "decrease" | ||
], | ], | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Optional. | "$ref": "Optional.Boolean", | ||
"description": "Flag to enable nonlinear stretch" | |||
"description": " | |||
} | } | ||
] | ] | ||
}, | }, | ||
"pixelratio": { | "pixelratio": { | ||
"default": null, | |||
"type": [ | "type": [ | ||
{ | { | ||
" | "enums": [ | ||
"increase", | "increase", | ||
"decrease" | "decrease" | ||
], | ], | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Optional.Number", | "$ref": "Optional.Number", | ||
"description": "Pixel aspect ratio where 1.0 means square pixel" | |||
"description": "Pixel aspect ratio where 1.0 means square pixel" | |||
} | } | ||
] | ] | ||
}, | }, | ||
"verticalshift": { | "verticalshift": { | ||
"default": null, | |||
"type": [ | "type": [ | ||
{ | { | ||
" | "enums": [ | ||
"increase", | "increase", | ||
"decrease" | "decrease" | ||
], | ], | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Optional.Number", | "$ref": "Optional.Number", | ||
"description": "Vertical shift 1.0 means shift to bottom" | |||
"description": "Vertical shift 1.0 means shift to bottom" | |||
} | } | ||
] | ] | ||
}, | }, | ||
" | "zoom": { | ||
"default": null, | |||
"type": [ | "type": [ | ||
{ | { | ||
" | "enums": [ | ||
"increase", | "increase", | ||
"decrease" | "decrease" | ||
], | ], | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Optional. | "$ref": "Optional.Number", | ||
"description": " | "description": "Zoom where 1.0 means 100%" | ||
} | } | ||
] | ] | ||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,227: | Line 15,309: | ||
'''Type:''' ''integer'' | '''Type:''' ''integer'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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, | "minimum": 0, | ||
" | "type": "integer" | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,243: | Line 15,326: | ||
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player | * ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"item": { | "item": { | ||
Line 13,255: | Line 15,338: | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,266: | Line 15,350: | ||
* [''integer'' speed] | * [''integer'' speed] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"playerid": { | "playerid": { | ||
Line 13,275: | Line 15,359: | ||
}, | }, | ||
"speed": { | "speed": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,285: | Line 15,371: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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] | * [''[[#Global.Time|Global.Time]]'' time] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Player.Notifications.Player", | ||
"id": "Player.Notifications.Player.Seek", | |||
"properties": { | "properties": { | ||
"seekoffset": { | |||
"$ref": "Global.Time", | |||
"description": "A duration." | |||
}, | |||
"time": { | "time": { | ||
"$ref": "Global.Time" | "$ref": "Global.Time", | ||
"description": "A duration." | |||
" | |||
} | } | ||
} | } | ||
Line 13,304: | Line 15,393: | ||
'''Type:''' ''number'' | '''Type:''' ''number'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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, | "minimum": 0.0, | ||
" | "type": "number" | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,317: | Line 15,408: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* [''integer'' hours] | * [''integer'' hours] | ||
* [''integer'' milliseconds] | |||
* [''integer'' minutes] | * [''integer'' minutes] | ||
* [''integer'' seconds] | * [''integer'' seconds] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | ||
{ | { | ||
"additionalProperties": false, | "additionalProperties": false, | ||
"description": "A position in duration.", | |||
"id": "Player.Position.Time", | |||
"properties": { | "properties": { | ||
"hours": { | "hours": { | ||
" | "default": 0, | ||
"minimum": 0, | "minimum": 0, | ||
" | "type": "integer" | ||
}, | }, | ||
" | "milliseconds": { | ||
" | "default": 0, | ||
"maximum": 999, | |||
"minimum": 0, | "minimum": 0, | ||
"maximum": 59, | "type": "integer" | ||
" | }, | ||
"minutes": { | |||
"default": 0, | |||
"maximum": 59, | |||
"minimum": 0, | |||
"type": "integer" | |||
}, | }, | ||
"seconds": { | "seconds": { | ||
" | "default": 0, | ||
"maximum": 59, | "maximum": 59, | ||
"minimum": 0, | "minimum": 0, | ||
" | "type": "integer" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,356: | Line 15,448: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "type", | ||
"partymode", | "partymode", | ||
Line 13,384: | Line 15,476: | ||
"live", | "live", | ||
"currentvideostream", | "currentvideostream", | ||
"videostreams" | "videostreams", | ||
] | "cachepercentage" | ||
], | |||
"id": "Player.Property.Name", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,393: | Line 15,488: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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] | |||
* [''[[#Player.Position.Percentage|Player.Position.Percentage]]'' | |||
* [''boolean'' canchangespeed] | * [''boolean'' canchangespeed] | ||
* [''boolean'' canmove] | * [''boolean'' canmove] | ||
* [''boolean'' | * [''boolean'' canrepeat] | ||
* [''boolean'' canrotate] | * [''boolean'' canrotate] | ||
* [''boolean'' canseek] | |||
* [''boolean'' canshuffle] | * [''boolean'' canshuffle] | ||
* [''boolean'' | * [''boolean'' canzoom] | ||
* [''[[#Player.Audio.Stream|Player.Audio.Stream]]'' currentaudiostream] | * [''[[#Player.Audio.Stream|Player.Audio.Stream]]'' currentaudiostream] | ||
* ['' | * [''[[#Player.Subtitle|Player.Subtitle]]'' currentsubtitle] | ||
* [''[[#Player.Video.Stream|Player.Video.Stream]]'' currentvideostream] | * [''[[#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] | * [''boolean'' subtitleenabled] | ||
* [''array'' subtitles] | * [''array'' subtitles] | ||
* ['' | * [''[[#Global.Time|Global.Time]]'' time] | ||
* [''[[#Global.Time|Global.Time]]'' totaltime] | |||
* [''[[#Player.Type|Player.Type]]'' type = video] | |||
* [''array'' videostreams] | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
" | "audiostreams": { | ||
"$ref": "Player. | "items": { | ||
"$ref": "Player.Audio.Stream" | |||
}, | |||
"type": "array" | |||
}, | }, | ||
" | "cachepercentage": { | ||
"$ref": "Player.Position.Percentage", | |||
"default": 0.0 | |||
"$ref": "Player.Position.Percentage" | |||
" | |||
}, | }, | ||
"canchangespeed": { | "canchangespeed": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
"canmove": { | "canmove": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
" | "canrepeat": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
"canrotate": { | "canrotate": { | ||
"default": false, | |||
"type": "boolean" | |||
}, | |||
"canseek": { | |||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
"canshuffle": { | "canshuffle": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
" | "canzoom": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
Line 13,477: | Line 15,560: | ||
"$ref": "Player.Audio.Stream" | "$ref": "Player.Audio.Stream" | ||
}, | }, | ||
" | "currentsubtitle": { | ||
"$ref": "Player.Subtitle" | |||
}, | }, | ||
"currentvideostream": { | "currentvideostream": { | ||
"$ref": "Player.Video.Stream" | "$ref": "Player.Video.Stream" | ||
}, | }, | ||
" | "live": { | ||
"type": " | "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": { | "subtitleenabled": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
"subtitles": { | "subtitles": { | ||
"items": { | "items": { | ||
"$ref": "Player.Subtitle" | "$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": { | ||
"type": " | "items": { | ||
"$ref": "Player.Video.Stream" | |||
}, | |||
"type": "array" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,513: | Line 15,633: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "off", | ||
"one", | "one", | ||
"all" | "all" | ||
] | ], | ||
"id": "Player.Repeat", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,530: | Line 15,652: | ||
* [''integer'' speed] | * [''integer'' speed] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"speed": { | "speed": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,547: | Line 15,671: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* ''integer'' index | * ''integer'' index | ||
* ''boolean'' isdefault | * ''boolean'' isdefault | ||
* ''boolean'' isforced | * ''boolean'' isforced | ||
* ''boolean'' isimpaired | * ''boolean'' isimpaired | ||
* ''string'' language | |||
* ''string'' name | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"index": { | "index": { | ||
"minimum": 0, | "minimum": 0, | ||
"required": true | "required": true, | ||
"type": "integer" | |||
"type": " | |||
}, | }, | ||
"isdefault": { | "isdefault": { | ||
" | "required": true, | ||
" | "type": "boolean" | ||
}, | }, | ||
"isforced": { | "isforced": { | ||
" | "required": true, | ||
" | "type": "boolean" | ||
}, | }, | ||
"isimpaired": { | "isimpaired": { | ||
"type": "boolean", | "required": true, | ||
"required": true | "type": "boolean" | ||
}, | |||
"language": { | |||
"required": true, | |||
"type": "string" | |||
}, | |||
"name": { | |||
"required": true, | |||
"type": "string" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,588: | Line 15,713: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "video", | ||
"audio", | "audio", | ||
"picture" | "picture" | ||
] | ], | ||
"id": "Player.Type", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,603: | Line 15,730: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''integer'' index | ||
* ''string'' language | |||
* ''string'' name | * ''string'' name | ||
* ''integer'' width | * ''integer'' width | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"codec": { | |||
"required": true, | |||
"type": "string" | |||
}, | |||
"height": { | |||
"required": true, | |||
"type": "integer" | |||
}, | |||
"index": { | "index": { | ||
"minimum": 0, | "minimum": 0, | ||
"required": true | "required": true, | ||
"type": "integer" | |||
"type": " | |||
}, | }, | ||
"language": { | "language": { | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
" | "name": { | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
"width": { | "width": { | ||
"required": true, | |||
"required": true | "type": "integer" | ||
"type": "integer" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,645: | Line 15,773: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "normal", | ||
"zoom", | "zoom", | ||
Line 13,658: | Line 15,786: | ||
"zoom120width", | "zoom120width", | ||
"zoom110width" | "zoom110width" | ||
] | ], | ||
"id": "Player.ViewMode", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,665: | Line 15,795: | ||
'''Type:''' ''integer'' | '''Type:''' ''integer'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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, | "minimum": 0, | ||
" | "type": "integer" | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,676: | Line 15,807: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": [ | "type": [ | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"file": { | "file": { | ||
"description": "Path to a file (not a directory) to be added to the playlist", | "description": "Path to a file (not a directory) to be added to the playlist", | ||
"required": true | "required": true, | ||
"type": "string" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"directory": { | "directory": { | ||
"required": true, | |||
"required": true | "type": "string" | ||
"type": " | |||
}, | }, | ||
"media": { | "media": { | ||
"$ref": "Files.Media", | "$ref": "Files.Media", | ||
"default": "files" | "default": "files" | ||
}, | |||
"recursive": { | |||
"default": false, | |||
"type": "boolean" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"movieid": { | "movieid": { | ||
Line 13,716: | Line 15,848: | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"episodeid": { | "episodeid": { | ||
Line 13,726: | Line 15,858: | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"musicvideoid": { | "musicvideoid": { | ||
Line 13,736: | Line 15,868: | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"artistid": { | "artistid": { | ||
Line 13,746: | Line 15,878: | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"albumid": { | "albumid": { | ||
Line 13,756: | Line 15,888: | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"songid": { | "songid": { | ||
Line 13,766: | Line 15,898: | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | }, | ||
{ | { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"genreid": { | "genreid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"description": "Identification of a genre from the AudioLibrary", | |||
"description": "Identification of a genre from the AudioLibrary" | "required": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
} | } | ||
] | ] | ||
Line 13,785: | Line 15,917: | ||
'''Type:''' ''integer'' | '''Type:''' ''integer'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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, | "minimum": 0, | ||
" | "type": "integer" | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,795: | Line 15,928: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "type", | ||
"size" | "size" | ||
] | ], | ||
"id": "Playlist.Property.Name", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,809: | Line 15,944: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* [''integer'' size] | * [''integer'' size] | ||
* [''[[#Playlist.Type|Playlist.Type]]'' type = unknown] | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"size": { | |||
"default": 0, | |||
"minimum": 0, | |||
"type": "integer" | |||
}, | |||
"type": { | "type": { | ||
"$ref": "Playlist.Type" | "$ref": "Playlist.Type", | ||
"default": "unknown" | |||
" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,829: | Line 15,967: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "unknown", | ||
"video", | "video", | ||
Line 13,838: | Line 15,976: | ||
"picture", | "picture", | ||
"mixed" | "mixed" | ||
] | ], | ||
"id": "Playlist.Type", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,847: | Line 15,987: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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] | * [''string'' thumbnail] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Item.Details.Base", | ||
"id": "Profiles.Details.Profile", | |||
"properties": { | "properties": { | ||
"lockmode": { | |||
"default": 0, | |||
"type": "integer" | |||
}, | |||
"thumbnail": { | "thumbnail": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | } | ||
} | } | ||
Line 13,866: | Line 16,009: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Profiles.Fields.Profile", | |||
"items": { | "items": { | ||
" | "enums": [ | ||
"thumbnail", | "thumbnail", | ||
"lockmode" | "lockmode" | ||
] | ], | ||
"type": "string" | |||
} | } | ||
} | } | ||
Line 13,883: | Line 16,027: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''string'' value | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"encryption": { | "encryption": { | ||
" | "default": "md5", | ||
"description": "Password Encryption", | "description": "Password Encryption", | ||
" | "enums": [ | ||
"none", | "none", | ||
"md5" | "md5" | ||
] | ], | ||
"type": "string" | |||
}, | |||
"value": { | |||
"description": "Password", | |||
"required": true, | |||
"type": "string" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,913: | Line 16,058: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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'' id | ||
* ''string'' label | * ''string'' label | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
" | "help": { | ||
"type": "string", | "default": "", | ||
"type": "string" | |||
}, | |||
"id": { | |||
"minLength": 1, | |||
"required": true, | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
"label": { | "label": { | ||
"required": true, | |||
"required": true | |||
"type": "string" | "type": "string" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,943: | Line 16,090: | ||
* [''array'' groups] | * [''array'' groups] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.Base", | ||
"id": "Setting.Details.Category", | |||
"properties": { | "properties": { | ||
"groups": { | "groups": { | ||
"items": { | "items": { | ||
"$ref": "Setting.Details.Group" | "$ref": "Setting.Details.Group" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"type": "array", | |||
"uniqueItems": true | "uniqueItems": true | ||
} | } | ||
} | } | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 13,962: | Line 16,110: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": [ | "type": [ | ||
{ | { | ||
"$ref": "Setting.Details.ControlCheckmark" | "$ref": "Setting.Details.ControlCheckmark" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Details.ControlSpinner" | "$ref": "Setting.Details.ControlSpinner" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Details.ControlEdit" | "$ref": "Setting.Details.ControlEdit" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Details.ControlButton" | "$ref": "Setting.Details.ControlButton" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Details.ControlList" | "$ref": "Setting.Details.ControlList" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Details.ControlSlider" | "$ref": "Setting.Details.ControlSlider" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Details.ControlRange" | "$ref": "Setting.Details.ControlRange" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Details.ControlLabel" | "$ref": "Setting.Details.ControlLabel" | ||
} | } | ||
] | ] | ||
Line 14,005: | Line 16,146: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''string'' type | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
" | "delayed": { | ||
" | "required": true, | ||
" | "type": "boolean" | ||
}, | }, | ||
"format": { | "format": { | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
" | "type": { | ||
" | "required": true, | ||
" | "type": "string" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,035: | Line 16,177: | ||
* ''string'' type | * ''string'' type | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.ControlHeading", | ||
"id": "Setting.Details.ControlButton", | |||
"properties": { | "properties": { | ||
"type": { | "type": { | ||
" | "enums": [ | ||
"button" | |||
], | |||
"required": true, | "required": true, | ||
" | "type": "string" | ||
} | } | ||
} | } | ||
Line 14,054: | Line 16,197: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''string'' type | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.ControlBase", | ||
"id": "Setting.Details.ControlCheckmark", | |||
"properties": { | "properties": { | ||
"format": { | |||
"enums": [ | |||
"boolean" | |||
], | |||
"required": true, | |||
"type": "string" | |||
}, | |||
"type": { | "type": { | ||
" | "enums": [ | ||
"toggle" | "toggle" | ||
] | ], | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
} | } | ||
} | } | ||
Line 14,083: | Line 16,227: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''string'' type | ||
* ''boolean'' verifynewvalue | * ''boolean'' verifynewvalue | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.ControlHeading", | ||
"id": "Setting.Details.ControlEdit", | |||
"properties": { | "properties": { | ||
"hidden": { | |||
"required": true, | |||
"type": "boolean" | |||
}, | |||
"type": { | "type": { | ||
" | "enums": [ | ||
"edit" | "edit" | ||
] | ], | ||
"required": true, | |||
"type": "string" | |||
"type": " | |||
}, | }, | ||
"verifynewvalue": { | "verifynewvalue": { | ||
" | "required": true, | ||
" | "type": "boolean" | ||
} | } | ||
} | } | ||
Line 14,116: | Line 16,261: | ||
* [''string'' heading] | * [''string'' heading] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.ControlBase", | ||
"id": "Setting.Details.ControlHeading", | |||
"properties": { | "properties": { | ||
"heading": { | "heading": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | } | ||
Line 14,131: | Line 16,278: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''string'' type | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.ControlBase", | ||
"id": "Setting.Details.ControlLabel", | |||
"properties": { | "properties": { | ||
"format": { | |||
"enums": [ | |||
"string" | |||
], | |||
"required": true, | |||
"type": "string" | |||
}, | |||
"type": { | "type": { | ||
" | "enums": [ | ||
"label" | "label" | ||
] | ], | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
} | } | ||
} | } | ||
Line 14,160: | Line 16,308: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''string'' type | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.ControlHeading", | ||
"id": "Setting.Details.ControlList", | |||
"properties": { | "properties": { | ||
"multiselect": { | |||
"required": true, | |||
"type": "boolean" | |||
}, | |||
"type": { | "type": { | ||
" | "enums": [ | ||
"list" | |||
], | |||
"required": true, | "required": true, | ||
"type": "string" | |||
"type": " | |||
} | } | ||
} | } | ||
Line 14,186: | Line 16,335: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* ''string'' formatlabel | * ''string'' formatlabel | ||
* ''string'' formatvalue | * ''string'' formatvalue | ||
* ''string'' type | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.ControlBase", | ||
"id": "Setting.Details.ControlRange", | |||
"properties": { | "properties": { | ||
" | "formatlabel": { | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
" | "formatvalue": { | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
" | "type": { | ||
" | "enums": [ | ||
"required": true | "range" | ||
], | |||
"required": true, | |||
"type": "string" | |||
} | } | ||
} | } | ||
Line 14,217: | Line 16,367: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* ''string'' formatlabel | * ''string'' formatlabel | ||
* ''boolean'' popup | * ''boolean'' popup | ||
* ''string'' type | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.ControlHeading", | ||
"id": "Setting.Details.ControlSlider", | |||
"properties": { | "properties": { | ||
" | "formatlabel": { | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
" | "popup": { | ||
" | "required": true, | ||
" | "type": "boolean" | ||
}, | }, | ||
" | "type": { | ||
" | "enums": [ | ||
"required": true | "slider" | ||
} | ], | ||
} | "required": true, | ||
"type": "string" | |||
} | |||
} | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,248: | Line 16,399: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* [''string'' formatlabel] | * [''string'' formatlabel] | ||
* [''string'' minimumlabel] | * [''string'' minimumlabel] | ||
* ''string'' type | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.ControlBase", | ||
"id": "Setting.Details.ControlSpinner", | |||
"properties": { | "properties": { | ||
"formatlabel": { | "formatlabel": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
"minimumlabel": { | "minimumlabel": { | ||
"default": "", | |||
"type": "string" | |||
}, | |||
"type": { | |||
"enums": [ | |||
"spinner" | |||
], | |||
"required": true, | |||
"type": "string" | "type": "string" | ||
} | } | ||
Line 14,280: | Line 16,434: | ||
* [''array'' settings] | * [''array'' settings] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"id": { | "id": { | ||
" | "minLength": 1, | ||
"required": true, | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
"settings": { | "settings": { | ||
"items": { | "items": { | ||
"$ref": "Setting.Details.Setting" | "$ref": "Setting.Details.Setting" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"type": "array", | |||
"uniqueItems": true | "uniqueItems": true | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,308: | Line 16,463: | ||
* [''array'' categories] | * [''array'' categories] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.Base", | ||
"id": "Setting.Details.Section", | |||
"properties": { | "properties": { | ||
"categories": { | "categories": { | ||
"items": { | "items": { | ||
"$ref": "Setting.Details.Category" | "$ref": "Setting.Details.Category" | ||
}, | }, | ||
"minItems": 1, | "minItems": 1, | ||
"type": "array", | |||
"uniqueItems": true | "uniqueItems": true | ||
} | } | ||
} | } | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,327: | Line 16,483: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": [ | "type": [ | ||
{ | { | ||
"$ref": "Setting.Details.SettingBool" | "$ref": "Setting.Details.SettingBool" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Details.SettingInt" | "$ref": "Setting.Details.SettingInt" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Details.SettingNumber" | "$ref": "Setting.Details.SettingNumber" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Details.SettingString" | "$ref": "Setting.Details.SettingString" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Details.SettingAction" | "$ref": "Setting.Details.SettingAction" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Details.SettingList" | "$ref": "Setting.Details.SettingList" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Details.SettingPath" | "$ref": "Setting.Details.SettingPath" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Details.SettingAddon" | "$ref": "Setting.Details.SettingAddon" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Details.SettingDate" | "$ref": "Setting.Details.SettingDate" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Details.SettingTime" | "$ref": "Setting.Details.SettingTime" | ||
} | } | ||
] | ] | ||
Line 14,380: | Line 16,527: | ||
* ''string'' data | * ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.SettingBase", | ||
"id": "Setting.Details.SettingAction", | |||
"properties": { | "properties": { | ||
"data": { | "data": { | ||
" | "required": true, | ||
" | "type": "string" | ||
} | } | ||
} | } | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,399: | Line 16,547: | ||
* ''[[#Addon.Types|Addon.Types]]'' addontype | * ''[[#Addon.Types|Addon.Types]]'' addontype | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.SettingString", | ||
"id": "Setting.Details.SettingAddon", | |||
"properties": { | "properties": { | ||
"addontype": { | "addontype": { | ||
Line 14,407: | Line 16,557: | ||
"required": true | "required": true | ||
} | } | ||
} | } | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,416: | Line 16,565: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* ''[[#Setting. | * [''[[#Setting.Details.Control|Setting.Details.Control]]'' control] | ||
* ''boolean'' enabled | * ''boolean'' enabled | ||
* ''[[#Setting.Level|Setting.Level]]'' level | * ''[[#Setting.Level|Setting.Level]]'' level | ||
* [''string'' parent] | * [''string'' parent] | ||
* | * ''[[#Setting.Type|Setting.Type]]'' type | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.Base", | ||
"id": "Setting.Details.SettingBase", | |||
"properties": { | "properties": { | ||
" | "control": { | ||
"$ref": "Setting. | "$ref": "Setting.Details.Control" | ||
}, | }, | ||
"enabled": { | "enabled": { | ||
" | "required": true, | ||
" | "type": "boolean" | ||
}, | }, | ||
"level": { | "level": { | ||
Line 14,439: | Line 16,589: | ||
}, | }, | ||
"parent": { | "parent": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "type": { | ||
"$ref": "Setting. | "$ref": "Setting.Type", | ||
"required": true | |||
} | } | ||
} | } | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,453: | Line 16,604: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''boolean'' value | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.SettingBase", | ||
"id": "Setting.Details.SettingBool", | |||
"properties": { | "properties": { | ||
"default": { | |||
"required": true, | |||
"type": "boolean" | |||
}, | |||
"value": { | "value": { | ||
"required": true, | |||
"required": true | "type": "boolean" | ||
"type": "boolean" | |||
} | } | ||
} | } | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,475: | Line 16,627: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]'' | * ''[[#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=" | {{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", | "extends": "Setting.Details.SettingString", | ||
" | "id": "Setting.Details.SettingDate" | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,486: | Line 16,639: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* ''integer'' default | * ''integer'' default | ||
* [''integer'' maximum] | |||
* [''integer'' minimum] | * [''integer'' minimum] | ||
* [''array'' options] | |||
* [''integer'' step] | * [''integer'' step] | ||
* | * ''integer'' value | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.SettingBase", | ||
"id": "Setting.Details.SettingInt", | |||
"properties": { | "properties": { | ||
"default": { | "default": { | ||
"required": true, | |||
"required": true | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "maximum": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "minimum": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
"options": { | "options": { | ||
"items": { | "items": { | ||
"properties": { | "properties": { | ||
"label": { | "label": { | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
"value": { | "value": { | ||
" | "required": true, | ||
" | "type": "integer" | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
}, | |||
"type": "array" | |||
}, | |||
"step": { | |||
"default": 0, | |||
"type": "integer" | |||
}, | |||
"value": { | |||
"required": true, | |||
"type": "integer" | |||
} | } | ||
} | } | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,539: | Line 16,696: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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.Value.List|Setting.Value.List]]'' default | ||
* ''[[#Setting.Details.Setting|Setting.Details.Setting]]'' definition | * ''[[#Setting.Details.Setting|Setting.Details.Setting]]'' definition | ||
* ''string'' delimiter | * ''string'' delimiter | ||
* [''integer'' | * ''[[#Setting.Type|Setting.Type]]'' elementtype | ||
* [''integer'' | * [''integer'' maximumitems] | ||
* [''integer'' minimumitems] | |||
* ''[[#Setting.Value.List|Setting.Value.List]]'' value | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.SettingBase", | ||
"id": "Setting.Details.SettingList", | |||
"properties": { | "properties": { | ||
"default": { | "default": { | ||
"$ref": "Setting.Value.List", | "$ref": "Setting.Value.List", | ||
"required": true | "required": true | ||
}, | }, | ||
Line 14,568: | Line 16,719: | ||
}, | }, | ||
"delimiter": { | "delimiter": { | ||
"type": "string", | "required": true, | ||
"type": "string" | |||
}, | |||
"elementtype": { | |||
"$ref": "Setting.Type", | |||
"required": true | "required": true | ||
}, | }, | ||
" | "maximumitems": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "minimumitems": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
} | }, | ||
"value": { | |||
"$ref": "Setting.Value.List", | |||
"required": true | |||
} | |||
} | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,586: | Line 16,746: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* ''number'' default | * ''number'' default | ||
* ''number'' maximum | |||
* ''number'' minimum | * ''number'' minimum | ||
* ''number'' step | * ''number'' step | ||
* ''number'' | * ''number'' value | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.SettingBase", | ||
"id": "Setting.Details.SettingNumber", | |||
"properties": { | "properties": { | ||
" | "default": { | ||
" | "required": true, | ||
" | "type": "number" | ||
}, | }, | ||
" | "maximum": { | ||
" | "required": true, | ||
" | "type": "number" | ||
}, | }, | ||
"minimum": { | "minimum": { | ||
" | "required": true, | ||
" | "type": "number" | ||
}, | }, | ||
"step": { | "step": { | ||
" | "required": true, | ||
" | "type": "number" | ||
}, | }, | ||
" | "value": { | ||
" | "required": true, | ||
" | "type": "number" | ||
} | } | ||
} | } | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,625: | Line 16,786: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''boolean'' writable | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.SettingString", | ||
"id": "Setting.Details.SettingPath", | |||
"properties": { | "properties": { | ||
"sources": { | "sources": { | ||
"items": { | "items": { | ||
"type": "string" | "type": "string" | ||
} | }, | ||
"type": "array" | |||
}, | |||
"writable": { | |||
"required": true, | |||
"type": "boolean" | |||
} | } | ||
} | } | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,651: | Line 16,813: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''string'' default | ||
* [''array'' options] | * [''array'' options] | ||
* ''string'' value | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Setting.Details.SettingBase", | ||
"id": "Setting.Details.SettingString", | |||
"properties": { | "properties": { | ||
" | "allowempty": { | ||
" | "required": true, | ||
" | "type": "boolean" | ||
}, | }, | ||
"default": { | "default": { | ||
"required": true, | |||
"required": true | "type": "string" | ||
"type": " | |||
}, | }, | ||
"options": { | "options": { | ||
"items": { | "items": { | ||
"properties": { | "properties": { | ||
"label": { | "label": { | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
"value": { | "value": { | ||
" | "required": true, | ||
" | "type": "string" | ||
} | } | ||
} | }, | ||
} | "type": "object" | ||
} | }, | ||
"type": "array" | |||
}, | |||
"value": { | |||
"required": true, | |||
"type": "string" | |||
} | |||
} | } | ||
} | } | ||
Line 14,694: | Line 16,857: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]'' | * ''[[#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=" | {{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", | "extends": "Setting.Details.SettingString", | ||
" | "id": "Setting.Details.SettingTime" | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,703: | Line 16,867: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "basic", | ||
"standard", | "standard", | ||
"advanced", | "advanced", | ||
"expert" | "expert" | ||
] | ], | ||
"id": "Setting.Level", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,717: | Line 16,883: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "boolean", | ||
"integer", | "integer", | ||
Line 14,731: | Line 16,897: | ||
"date", | "date", | ||
"time" | "time" | ||
] | ], | ||
"id": "Setting.Type", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,737: | Line 16,905: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": [ | ||
{ | { | ||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
{ | { | ||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
{ | { | ||
"type": "number" | "type": "number" | ||
}, | }, | ||
{ | { | ||
"type": "string" | "type": "string" | ||
} | } | ||
] | ] | ||
Line 14,762: | Line 16,928: | ||
'''Type:''' ''mixed'' | '''Type:''' ''mixed'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": [ | ||
{ | { | ||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
{ | { | ||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
{ | { | ||
"type": "number" | "type": "number" | ||
}, | }, | ||
{ | { | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Setting.Value.List" | "$ref": "Setting.Value.List" | ||
} | } | ||
] | ] | ||
Line 14,791: | Line 16,954: | ||
'''Type:''' ''array'' | '''Type:''' ''array'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "items": { | ||
"$ref": "Setting.Value" | "$ref": "Setting.Value" | ||
} | }, | ||
"type": "array" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,803: | Line 16,967: | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "canshutdown", | ||
"cansuspend", | "cansuspend", | ||
"canhibernate", | "canhibernate", | ||
"canreboot" | "canreboot" | ||
] | ], | ||
"id": "System.Property.Name", | |||
"type": "string" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,819: | Line 16,985: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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'' canshutdown] | ||
* [''boolean'' cansuspend] | * [''boolean'' cansuspend] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
" | "canhibernate": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
" | "canreboot": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
" | "canshutdown": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
" | "cansuspend": { | ||
"default": false, | |||
"type": "boolean" | "type": "boolean" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,849: | Line 17,020: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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'' size] | ||
* [''integer'' usecount] | |||
* [''integer'' width] | * [''integer'' width] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
" | "height": { | ||
" | "default": 0, | ||
"description": " | "description": "Height of texture", | ||
"type": "integer" | |||
}, | }, | ||
" | "lastused": { | ||
" | "default": "", | ||
"description": " | "description": "Date of last use", | ||
"type": "string" | |||
}, | }, | ||
" | "size": { | ||
" | "default": 0, | ||
"description": " | "description": "Size of the texture (1 == largest)", | ||
"type": "integer" | |||
}, | }, | ||
"usecount": { | "usecount": { | ||
" | "default": 0, | ||
"description": "Number of uses" | "description": "Number of uses", | ||
"type": "integer" | |||
}, | }, | ||
" | "width": { | ||
" | "default": 0, | ||
" | "description": "Width of texture", | ||
"type": "integer" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,887: | Line 17,064: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* [''string'' cachedurl] | * [''string'' cachedurl] | ||
* [''string'' imagehash] | |||
* [''string'' lasthashcheck] | * [''string'' lasthashcheck] | ||
* [''array'' sizes] | * [''array'' sizes] | ||
* [''[[#Library.Id|Library.Id]]'' textureid = -1] | |||
* [''string'' url] | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
" | "cachedurl": { | ||
" | "default": "", | ||
" | "description": "Cached URL on disk", | ||
"type": "string" | |||
}, | }, | ||
" | "imagehash": { | ||
" | "default": "", | ||
"description": " | "description": "Hash of image", | ||
"type": "string" | |||
"type": "string | |||
}, | }, | ||
"lasthashcheck": { | "lasthashcheck": { | ||
" | "default": "", | ||
"description": "Last time source was checked for changes" | "description": "Last time source was checked for changes", | ||
"type": "string" | |||
"type": "string | |||
}, | }, | ||
"sizes": { | "sizes": { | ||
"items": { | "items": { | ||
"$ref": "Textures.Details.Size" | "$ref": "Textures.Details.Size" | ||
} | }, | ||
"type": "array" | |||
}, | |||
"textureid": { | |||
"$ref": "Library.Id", | |||
"default": -1 | |||
}, | |||
"url": { | |||
"default": "", | |||
"description": "Original source URL", | |||
"type": "string" | |||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,930: | Line 17,112: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Textures.Fields.Texture", | |||
"items": { | "items": { | ||
" | "enums": [ | ||
"url", | "url", | ||
"cachedurl", | "cachedurl", | ||
Line 14,941: | Line 17,123: | ||
"imagehash", | "imagehash", | ||
"sizes" | "sizes" | ||
] | ], | ||
"type": "string" | |||
} | } | ||
} | } | ||
Line 14,949: | Line 17,132: | ||
'''Type:''' ''array'' | '''Type:''' ''array'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "items": { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"name": { | "name": { | ||
"type": "string", | "required": true, | ||
"required": true | "type": "string" | ||
}, | |||
"order": { | |||
"required": true, | |||
"type": "integer" | |||
}, | }, | ||
"role": { | "role": { | ||
"required": true, | |||
"required": true | "type": "string" | ||
"type": " | |||
}, | }, | ||
"thumbnail": { | "thumbnail": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
} | }, | ||
"type": "array" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 14,980: | Line 17,165: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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] | * [''integer'' playcount] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Media.Details.Base", | ||
"id": "Video.Details.Base", | |||
"properties": { | "properties": { | ||
"art": { | |||
"$ref": "Media.Artwork" | |||
}, | |||
"playcount": { | "playcount": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
} | } | ||
} | } | ||
Line 15,001: | Line 17,188: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''[[#Library.Id|Library.Id]]'' episodeid | ||
* [''string'' firstaired] | * [''string'' firstaired] | ||
* [''string'' originaltitle] | |||
* [''string'' productioncode] | * [''string'' productioncode] | ||
* [''number'' rating] | |||
* [''any'' ratings] | |||
* [''integer'' season] | * [''integer'' season] | ||
* [''[[#Library.Id|Library.Id]]'' seasonid = -1] | |||
* [''[[# | |||
* [''string'' showtitle] | * [''string'' showtitle] | ||
* ['' | * [''integer'' specialsortepisode] | ||
* [''integer'' specialsortseason] | * [''integer'' specialsortseason] | ||
* ['' | * [''[[#Library.Id|Library.Id]]'' tvshowid = -1] | ||
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid] | |||
* [''integer'' userrating] | * [''integer'' userrating] | ||
* ['' | * [''string'' votes] | ||
* ['' | * [''[[#Array.String|Array.String]]'' writer] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Video.Details.File", | ||
"id": "Video.Details.Episode", | |||
"properties": { | "properties": { | ||
"cast": { | |||
"$ref": "Video.Cast" | |||
}, | |||
"episode": { | |||
"default": 0, | |||
"type": "integer" | |||
}, | |||
"episodeid": { | "episodeid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
}, | }, | ||
" | "firstaired": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "originaltitle": { | ||
" | "default": "", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
"productioncode": { | "productioncode": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | |||
"rating": { | |||
"default": 0.0, | |||
"type": "number" | |||
}, | |||
"ratings": { | |||
"default": null, | |||
"type": "any" | |||
}, | }, | ||
"season": { | "season": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "seasonid": { | ||
"$ref": "Library.Id", | |||
"default": -1 | |||
"$ref": " | |||
" | |||
}, | }, | ||
"showtitle": { | "showtitle": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "specialsortepisode": { | ||
" | "default": 0, | ||
"type": "integer" | |||
" | |||
}, | }, | ||
"specialsortseason": { | "specialsortseason": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "tvshowid": { | ||
" | "$ref": "Library.Id", | ||
"default": -1 | |||
}, | |||
"uniqueid": { | |||
"$ref": "Media.UniqueID" | |||
}, | }, | ||
"userrating": { | "userrating": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "votes": { | ||
" | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "writer": { | ||
" | "$ref": "Array.String" | ||
} | } | ||
} | } | ||
Line 15,087: | Line 17,289: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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] | * [''integer'' runtime] | ||
* [''[[#Video.Streams|Video.Streams]]'' streamdetails] | * [''[[#Video.Streams|Video.Streams]]'' streamdetails] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Video.Details.Item", | ||
"id": "Video.Details.File", | |||
"properties": { | "properties": { | ||
"director": { | "director": { | ||
"$ref": "Array.String" | "$ref": "Array.String" | ||
}, | }, | ||
"resume": { | "resume": { | ||
"$ref": "Video.Resume" | "$ref": "Video.Resume" | ||
}, | |||
"runtime": { | |||
"default": 0, | |||
"description": "Runtime in seconds", | |||
"type": "integer" | |||
}, | |||
"streamdetails": { | |||
"$ref": "Video.Streams" | |||
} | } | ||
} | } | ||
Line 15,117: | Line 17,321: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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'' file] | ||
* [''string'' lastplayed] | |||
* [''string'' plot] | * [''string'' plot] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Video.Details.Media", | ||
"id": "Video.Details.Item", | |||
"properties": { | "properties": { | ||
" | "dateadded": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "file": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
"lastplayed": { | "lastplayed": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "plot": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | } | ||
Line 15,148: | Line 17,357: | ||
* [''string'' title] | * [''string'' title] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Video.Details.Base", | ||
"id": "Video.Details.Media", | |||
"properties": { | "properties": { | ||
"title": { | "title": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | } | ||
Line 15,163: | Line 17,374: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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] | * [''[[#Video.Cast|Video.Cast]]'' cast] | ||
* [''[[#Array.String|Array.String]]'' country] | * [''[[#Array.String|Array.String]]'' country] | ||
* [''[[#Array.String|Array.String]]'' genre] | |||
* [''string'' imdbnumber] | * [''string'' imdbnumber] | ||
* ''[[#Library.Id|Library.Id]]'' movieid | |||
* [''string'' mpaa] | |||
* [''string'' originaltitle] | |||
* [''string'' plotoutline] | |||
* [''string'' premiered] | |||
* [''number'' rating] | |||
* [''any'' ratings] | |||
* [''string'' set] | * [''string'' set] | ||
* [''[[#Library.Id|Library.Id]]'' setid = -1] | |||
* [''[[#Array.String|Array.String]]'' showlink] | * [''[[#Array.String|Array.String]]'' showlink] | ||
* [''string'' sorttitle] | |||
* [''[[#Array.String|Array.String]]'' studio] | |||
* [''[[#Array.String|Array.String]]'' tag] | |||
* [''string'' tagline] | |||
* [''integer'' top250] | * [''integer'' top250] | ||
* [''string'' trailer] | |||
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid] | |||
* [''integer'' userrating] | |||
* [''string'' votes] | * [''string'' votes] | ||
* [''[[#Array.String|Array.String]]'' writer] | |||
* [''[[#Array.String|Array.String]]'' | * [''integer'' year] | ||
* [''integer'' | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Video.Details.File", | ||
"id": "Video.Details.Movie", | |||
"properties": { | "properties": { | ||
" | "cast": { | ||
"$ref": " | "$ref": "Video.Cast" | ||
" | }, | ||
"country": { | |||
"$ref": "Array.String" | |||
}, | }, | ||
"genre": { | "genre": { | ||
"$ref": "Array.String" | "$ref": "Array.String" | ||
}, | }, | ||
" | "imdbnumber": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "movieid": { | ||
" | "$ref": "Library.Id", | ||
"required": true | |||
}, | }, | ||
" | "mpaa": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "originaltitle": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
"plotoutline": { | "plotoutline": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "premiered": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "rating": { | ||
"default": 0.0, | |||
"type": "number" | |||
}, | |||
"ratings": { | |||
"default": null, | |||
"type": "any" | |||
}, | |||
"set": { | |||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "setid": { | ||
"$ref": " | "$ref": "Library.Id", | ||
"default": -1 | |||
}, | }, | ||
" | "showlink": { | ||
"$ref": "Array.String" | "$ref": "Array.String" | ||
}, | }, | ||
" | "sorttitle": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "studio": { | ||
"$ref": " | "$ref": "Array.String" | ||
}, | }, | ||
" | "tag": { | ||
"$ref": "Array.String" | "$ref": "Array.String" | ||
}, | }, | ||
" | "tagline": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "top250": { | ||
"default": 0, | |||
"type": "integer" | |||
}, | |||
"trailer": { | |||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "uniqueid": { | ||
"$ref": " | "$ref": "Media.UniqueID" | ||
}, | }, | ||
" | "userrating": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
"votes": { | "votes": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "writer": { | ||
"$ref": "Array.String" | "$ref": "Array.String" | ||
}, | }, | ||
" | "year": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
} | } | ||
} | } | ||
Line 15,277: | Line 17,505: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''[[#Library.Id|Library.Id]]'' setid | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Video.Details.Media", | ||
"id": "Video.Details.MovieSet", | |||
"properties": { | "properties": { | ||
"plot": { | |||
"default": "", | |||
"type": "string" | |||
}, | |||
"setid": { | "setid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
} | } | ||
} | } | ||
Line 15,302: | Line 17,532: | ||
* [''array'' movies] | * [''array'' movies] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Video.Details.MovieSet", | ||
"id": "Video.Details.MovieSet.Extended", | |||
"properties": { | "properties": { | ||
"limits": { | "limits": { | ||
Line 15,311: | Line 17,542: | ||
}, | }, | ||
"movies": { | "movies": { | ||
"items": { | "items": { | ||
"$ref": "Video.Details.Movie" | "$ref": "Video.Details.Movie" | ||
} | }, | ||
"type": "array" | |||
} | } | ||
} | } | ||
Line 15,324: | Line 17,555: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* [''string'' album] | * [''string'' album] | ||
* [''[[#Array.String|Array.String]]'' artist] | * [''[[#Array.String|Array.String]]'' artist] | ||
* [''[[#Array.String|Array.String]]'' genre] | * [''[[#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] | * [''integer'' track] | ||
* [''integer'' userrating] | * [''integer'' userrating] | ||
* ['' | * [''integer'' year] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Video.Details.File", | ||
"id": "Video.Details.MusicVideo", | |||
"properties": { | "properties": { | ||
"album": { | "album": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
Line 15,359: | Line 17,582: | ||
"$ref": "Array.String" | "$ref": "Array.String" | ||
}, | }, | ||
" | "musicvideoid": { | ||
"type": " | "$ref": "Library.Id", | ||
"required": true | |||
}, | |||
"premiered": { | |||
"default": "", | |||
"type": "string" | |||
}, | |||
"rating": { | |||
"default": 0.0, | |||
"type": "number" | |||
}, | |||
"studio": { | |||
"$ref": "Array.String" | |||
}, | }, | ||
"tag": { | "tag": { | ||
"$ref": "Array.String" | "$ref": "Array.String" | ||
}, | }, | ||
" | "track": { | ||
"type": " | "default": 0, | ||
"type": "integer" | |||
}, | }, | ||
"userrating": { | "userrating": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "year": { | ||
"type": " | "default": 0, | ||
"type": "integer" | |||
} | } | ||
} | } | ||
Line 15,382: | Line 17,620: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''[[#Library.Id|Library.Id]]'' seasonid | ||
* [''string'' showtitle] | * [''string'' showtitle] | ||
* [''integer'' | * [''string'' title] | ||
* [''[[#Library.Id|Library.Id]]'' tvshowid = -1] | |||
* [''integer'' userrating] | |||
* [''integer'' watchedepisodes] | * [''integer'' watchedepisodes] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Video.Details.Base", | ||
"id": "Video.Details.Season", | |||
"properties": { | "properties": { | ||
"episode": { | |||
"default": 0, | |||
"type": "integer" | |||
}, | |||
"season": { | |||
"required": true, | |||
"type": "integer" | |||
}, | |||
"seasonid": { | "seasonid": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
}, | }, | ||
"showtitle": { | "showtitle": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "title": { | ||
" | "default": "", | ||
"type": "string" | |||
"type": " | |||
}, | }, | ||
"tvshowid": { | "tvshowid": { | ||
"$ref": "Library.Id" | "$ref": "Library.Id", | ||
"default": -1 | |||
}, | }, | ||
"userrating": { | "userrating": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "watchedepisodes": { | ||
"type": " | "default": 0, | ||
"type": "integer" | |||
} | } | ||
} | } | ||
Line 15,429: | Line 17,674: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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] | * [''[[#Video.Cast|Video.Cast]]'' cast] | ||
* [''integer'' episode] | * [''integer'' episode] | ||
* ['' | * [''string'' episodeguide] | ||
* [''[[#Array.String|Array.String]]'' genre] | |||
* [''string'' imdbnumber] | * [''string'' imdbnumber] | ||
* [''string'' mpaa] | |||
* [''string'' originaltitle] | |||
* [''string'' premiered] | * [''string'' premiered] | ||
* ['' | * [''number'' rating] | ||
* ['' | * [''any'' ratings] | ||
* [''integer'' runtime] | |||
* [''integer'' season] | * [''integer'' season] | ||
* [''string'' sorttitle] | |||
* [''string'' status] | |||
* [''[[#Array.String|Array.String]]'' studio] | |||
* [''[[#Array.String|Array.String]]'' tag] | * [''[[#Array.String|Array.String]]'' tag] | ||
* ''[[#Library.Id|Library.Id]]'' tvshowid | |||
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid] | |||
* [''integer'' userrating] | * [''integer'' userrating] | ||
* ['' | * [''string'' votes] | ||
* [''integer'' | * [''integer'' watchedepisodes] | ||
* ['' | * [''integer'' year] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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", | "extends": "Video.Details.Item", | ||
"id": "Video.Details.TVShow", | |||
"properties": { | "properties": { | ||
" | "cast": { | ||
"$ref": " | "$ref": "Video.Cast" | ||
" | }, | ||
"episode": { | |||
"default": 0, | |||
"type": "integer" | |||
}, | |||
"episodeguide": { | |||
"default": "", | |||
"type": "string" | |||
}, | }, | ||
"genre": { | "genre": { | ||
"$ref": "Array.String" | "$ref": "Array.String" | ||
}, | }, | ||
" | "imdbnumber": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "mpaa": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
}, | }, | ||
"originaltitle": { | "originaltitle": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "premiered": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "rating": { | ||
" | "default": 0.0, | ||
"type": "number" | |||
}, | }, | ||
" | "ratings": { | ||
"type": " | "default": null, | ||
"type": "any" | |||
}, | }, | ||
" | "runtime": { | ||
" | "default": 0, | ||
"description": "Runtime in seconds", | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "season": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "sorttitle": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "status": { | ||
"default": "", | |||
"description": "Returns 'returning series', 'in production', 'planned', 'cancelled' or 'ended'", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "studio": { | ||
" | "$ref": "Array.String" | ||
}, | }, | ||
" | "tag": { | ||
" | "$ref": "Array.String" | ||
}, | }, | ||
" | "tvshowid": { | ||
" | "$ref": "Library.Id", | ||
"required": true | |||
}, | }, | ||
" | "uniqueid": { | ||
"$ref": " | "$ref": "Media.UniqueID" | ||
}, | }, | ||
"userrating": { | "userrating": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "votes": { | ||
"type": " | "default": "", | ||
"type": "string" | |||
}, | }, | ||
" | "watchedepisodes": { | ||
" | "default": 0, | ||
" | "type": "integer" | ||
}, | }, | ||
" | "year": { | ||
" | "default": 0, | ||
" | "type": "integer" | ||
} | } | ||
} | } | ||
Line 15,531: | Line 17,793: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Video.Fields.Episode", | |||
"items": { | "items": { | ||
"description": "Requesting the cast, ratings, streamdetails, uniqueid and/or tag field will result in increased response times", | "description": "Requesting the cast, ratings, streamdetails, uniqueid and/or tag field will result in increased response times", | ||
" | "enums": [ | ||
"title", | "title", | ||
"plot", | "plot", | ||
Line 15,568: | Line 17,830: | ||
"seasonid", | "seasonid", | ||
"ratings" | "ratings" | ||
] | ], | ||
"type": "string" | |||
} | } | ||
} | } | ||
Line 15,575: | Line 17,838: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Video.Fields.Movie", | |||
"items": { | "items": { | ||
"description": "Requesting the cast, ratings, showlink, streamdetails, uniqueid and/or tag field will result in increased response times", | "description": "Requesting the cast, ratings, showlink, streamdetails, uniqueid and/or tag field will result in increased response times", | ||
" | "enums": [ | ||
"title", | "title", | ||
"genre", | "genre", | ||
Line 15,619: | Line 17,882: | ||
"premiered", | "premiered", | ||
"uniqueid" | "uniqueid" | ||
] | ], | ||
"type": "string" | |||
} | } | ||
} | } | ||
Line 15,626: | Line 17,890: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Video.Fields.MovieSet", | |||
"items": { | "items": { | ||
" | "enums": [ | ||
"title", | "title", | ||
"playcount", | "playcount", | ||
Line 15,638: | Line 17,902: | ||
"art", | "art", | ||
"plot" | "plot" | ||
] | ], | ||
"type": "string" | |||
} | } | ||
} | } | ||
Line 15,645: | Line 17,910: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Video.Fields.MusicVideo", | |||
"items": { | "items": { | ||
"description": "Requesting the streamdetails and/or tag field will result in increased response times", | "description": "Requesting the streamdetails and/or tag field will result in increased response times", | ||
" | "enums": [ | ||
"title", | "title", | ||
"playcount", | "playcount", | ||
Line 15,675: | Line 17,940: | ||
"userrating", | "userrating", | ||
"premiered" | "premiered" | ||
] | ], | ||
"type": "string" | |||
} | } | ||
} | } | ||
Line 15,682: | Line 17,948: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Video.Fields.Season", | |||
"items": { | "items": { | ||
" | "enums": [ | ||
"season", | "season", | ||
"showtitle", | "showtitle", | ||
Line 15,699: | Line 17,965: | ||
"userrating", | "userrating", | ||
"title" | "title" | ||
] | ], | ||
"type": "string" | |||
} | } | ||
} | } | ||
Line 15,706: | Line 17,973: | ||
'''Extends:''' | '''Extends:''' | ||
* ''[[#Item.Fields.Base|Item.Fields.Base]]'' | * ''[[#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=" | {{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", | "extends": "Item.Fields.Base", | ||
"id": "Video.Fields.TVShow", | |||
"items": { | "items": { | ||
"description": "Requesting the cast, ratings, uniqueid and/or tag field will result in increased response times", | "description": "Requesting the cast, ratings, uniqueid and/or tag field will result in increased response times", | ||
" | "enums": [ | ||
"title", | "title", | ||
"genre", | "genre", | ||
Line 15,742: | Line 18,009: | ||
"runtime", | "runtime", | ||
"uniqueid" | "uniqueid" | ||
] | ], | ||
"type": "string" | |||
} | } | ||
} | } | ||
Line 15,751: | Line 18,019: | ||
'''Properties:''' | '''Properties:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <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 | * ''number'' rating | ||
* [''integer'' votes] | * [''integer'' votes] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"default": { | |||
"default": false, | |||
"type": "boolean" | |||
}, | |||
"rating": { | "rating": { | ||
" | "required": true, | ||
" | "type": "number" | ||
}, | }, | ||
"votes": { | "votes": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
} | } | ||
} | }, | ||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 15,775: | Line 18,046: | ||
'''Type:''' ''object'' | '''Type:''' ''object'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | ||
{ | { | ||
"additionalProperties": { | "additionalProperties": { | ||
"$ref": "Video.Rating" | "$ref": "Video.Rating" | ||
} | }, | ||
"id": "Video.Ratings", | |||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 15,786: | Line 18,058: | ||
'''Type:''' ''object'' | '''Type:''' ''object'' | ||
<br /> | <br /> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json"> | ||
{ | { | ||
"additionalProperties": { | "additionalProperties": { | ||
"default": null, | |||
"type": [ | "type": [ | ||
{ | { | ||
" | "type": "null" | ||
" | }, | ||
{ | |||
"$ref": "Video.Rating" | |||
} | } | ||
] | ] | ||
} | }, | ||
"id": "Video.Ratings.Set", | |||
"type": "object" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 15,808: | Line 18,083: | ||
* [''number'' total] | * [''number'' total] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"position": { | "position": { | ||
" | "default": 0.0, | ||
"minimum": 0.0 | "minimum": 0.0, | ||
"type": "number" | |||
}, | }, | ||
"total": { | "total": { | ||
" | "default": 0.0, | ||
"minimum": 0.0 | "minimum": 0.0, | ||
"type": "number" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 15,830: | Line 18,108: | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
* [''array'' audio] | * [''array'' audio] | ||
* [''array'' subtitle] | |||
* [''array'' video] | * [''array'' video] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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": { | "properties": { | ||
"audio": { | "audio": { | ||
"items": { | "items": { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"channels": { | |||
"default": 0, | |||
"type": "integer" | |||
}, | |||
"codec": { | "codec": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
"language": { | "language": { | ||
"default": "", | |||
"type": "string" | |||
} | |||
}, | |||
"type": "object" | |||
}, | |||
"minItems": 1, | |||
"type": "array" | |||
}, | |||
"subtitle": { | |||
"items": { | |||
"additionalProperties": false, | |||
"properties": { | |||
"language": { | |||
"default": "", | |||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
} | }, | ||
"minItems": 1, | |||
"type": "array" | |||
}, | }, | ||
"video": { | "video": { | ||
"items": { | "items": { | ||
" | "additionalProperties": false, | ||
"properties": { | "properties": { | ||
"aspect": { | |||
"default": 0.0, | |||
"type": "number" | |||
}, | |||
"codec": { | "codec": { | ||
"default": "", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "duration": { | ||
" | "default": 0, | ||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
"height": { | "height": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
}, | }, | ||
" | "width": { | ||
"default": 0, | |||
"type": "integer" | "type": "integer" | ||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
}, | |||
"minItems": 1, | "minItems": 1, | ||
"type": "array" | |||
} | } | ||
}, | }, | ||
" | "type": "object" | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 15,906: | Line 18,194: | ||
# ''string'' sender | # ''string'' sender | ||
# ''object'' data: | # ''object'' data: | ||
#* ''boolean'' muted | |||
#* ''integer'' volume | #* ''integer'' volume | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "The volume of the application has changed.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
"properties": { | "properties": { | ||
"muted": { | |||
"required": true, | |||
"type": "boolean" | |||
}, | |||
"volume": { | "volume": { | ||
" | "maximum": 100, | ||
"minimum": 0, | "minimum": 0, | ||
"required": true, | |||
"required": true | "type": "integer" | ||
"type": " | |||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 15,948: | Line 18,236: | ||
# ''string'' data | # ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "The audio library has been cleaned.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
" | "required": true, | ||
" | "type": "null" | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 15,974: | Line 18,262: | ||
# ''string'' data | # ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "An audio library clean operation has started.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
" | "required": true, | ||
" | "type": "null" | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 15,999: | Line 18,287: | ||
# ''string'' sender | # ''string'' sender | ||
# [''object'' data]: | # [''object'' data]: | ||
#* [''integer'' failcount = 0] | |||
#* [''string'' file = ""] | #* [''string'' file = ""] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "An audio library export has finished.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
"properties": { | "properties": { | ||
" | "failcount": { | ||
" | "default": 0, | ||
"minimum": 0, | |||
"required": false, | "required": false, | ||
" | "type": "integer" | ||
}, | }, | ||
" | "file": { | ||
" | "default": "", | ||
"required": false, | "required": false, | ||
" | "type": "string" | ||
} | } | ||
} | }, | ||
"required": false, | |||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,041: | Line 18,329: | ||
# ''object'' data: | # ''object'' data: | ||
#* ''[[#Library.Id|Library.Id]]'' id | #* ''[[#Library.Id|Library.Id]]'' id | ||
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction | |||
#* ''[[#Notifications.Library.Audio.Type|Notifications.Library.Audio.Type]]'' type | #* ''[[#Notifications.Library.Audio.Type|Notifications.Library.Audio.Type]]'' type | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "An audio item has been removed.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
"properties": { | "properties": { | ||
"id": { | "id": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
}, | |||
"transaction": { | |||
"$ref": "Optional.Boolean", | |||
"description": "True if the removal is being performed within a transaction." | |||
}, | }, | ||
"type": { | "type": { | ||
"$ref": "Notifications.Library.Audio.Type", | "$ref": "Notifications.Library.Audio.Type", | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,084: | Line 18,372: | ||
# ''string'' data | # ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "Scanning the audio library has been finished.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
" | "required": true, | ||
" | "type": "null" | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,110: | Line 18,398: | ||
# ''string'' data | # ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "An audio library scan has started.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
" | "required": true, | ||
" | "type": "null" | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,135: | Line 18,423: | ||
# ''string'' sender | # ''string'' sender | ||
# ''object'' data: | # ''object'' data: | ||
#* ''[[#Optional.Boolean|Optional.Boolean]]'' added | |||
#* ''[[#Library.Id|Library.Id]]'' id | #* ''[[#Library.Id|Library.Id]]'' id | ||
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction | |||
#* ''string'' type | #* ''string'' type | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "An audio item has been updated.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
"properties": { | "properties": { | ||
"added": { | |||
"$ref": "Optional.Boolean", | |||
"description": "True if the update is for a newly added item." | |||
}, | |||
"id": { | "id": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
}, | |||
"transaction": { | |||
"$ref": "Optional.Boolean", | |||
"description": "True if the update is being performed within a transaction." | |||
}, | }, | ||
"type": { | "type": { | ||
"enum": [ | "enum": [ | ||
"song" | "song" | ||
], | ], | ||
" | "id": "Notifications.Library.Audio.Type", | ||
"required": true, | |||
"type": "string" | |||
" | |||
" | |||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,189: | Line 18,477: | ||
# ''string'' data | # ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "Energy saving/DPMS has been activated.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
" | "required": true, | ||
" | "type": "null" | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,215: | Line 18,503: | ||
# ''string'' data | # ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "Energy saving/DPMS has been deactivated.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
" | "required": true, | ||
" | "type": "null" | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,241: | Line 18,529: | ||
# ''string'' data | # ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "The screensaver has been activated.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
" | "required": true, | ||
" | "type": "null" | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,268: | Line 18,556: | ||
#* ''boolean'' shuttingdown | #* ''boolean'' shuttingdown | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "The screensaver has been deactivated.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
"properties": { | "properties": { | ||
"shuttingdown": { | "shuttingdown": { | ||
" | "required": true, | ||
" | "type": "boolean" | ||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,301: | Line 18,589: | ||
# ''string'' data | # ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "The user has provided the requested input.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
" | "required": true, | ||
" | "type": "null" | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,326: | Line 18,614: | ||
# ''string'' sender | # ''string'' sender | ||
# ''object'' data: | # ''object'' data: | ||
#* ''string'' title | |||
#* ''string'' type | #* ''string'' type | ||
#* ''string'' value | #* ''string'' value | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "The user is requested to provide some information.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
"properties": { | "properties": { | ||
"title": { | |||
"type": "string" | |||
}, | |||
"type": { | "type": { | ||
"enum": [ | "enum": [ | ||
"keyboard", | "keyboard", | ||
Line 16,357: | Line 18,644: | ||
"seconds" | "seconds" | ||
], | ], | ||
"required": true | "required": true, | ||
"type": "string" | |||
}, | }, | ||
"value": { | "value": { | ||
"required": true, | |||
"required": true | |||
"type": "string" | "type": "string" | ||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,380: | Line 18,668: | ||
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data | # ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "Audio- or videostream has changed. If there is no ID available extra information will be provided.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Player.Notifications.Data", | |||
"name": "data", | "name": "data", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,406: | Line 18,694: | ||
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data | # ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "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": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Player.Notifications.Data", | |||
"name": "data", | "name": "data", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,432: | Line 18,720: | ||
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data | # ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "Playback of a media item has been paused. If there is no ID available extra information will be provided.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Player.Notifications.Data", | |||
"name": "data", | "name": "data", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,458: | Line 18,746: | ||
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data | # ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "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": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Player.Notifications.Data", | |||
"name": "data", | "name": "data", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,483: | Line 18,771: | ||
# ''string'' sender | # ''string'' sender | ||
# ''object'' data: | # ''object'' data: | ||
#* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player | |||
#* ''[[#Player.Property.Value|Player.Property.Value]]'' property | #* ''[[#Player.Property.Value|Player.Property.Value]]'' property | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "A property of the playing items has changed.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
"properties": { | "properties": { | ||
"player": { | "player": { | ||
"$ref": "Player.Notifications.Player", | "$ref": "Player.Notifications.Player", | ||
"required": true | "required": true | ||
}, | |||
"property": { | |||
"$ref": "Player.Property.Value" | |||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,521: | Line 18,809: | ||
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data | # ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "Playback of a media item has been resumed. If there is no ID available extra information will be provided.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Player.Notifications.Data", | |||
"name": "data", | "name": "data", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,549: | Line 18,837: | ||
#* ''[[#Player.Notifications.Player.Seek|Player.Notifications.Player.Seek]]'' player | #* ''[[#Player.Notifications.Player.Seek|Player.Notifications.Player.Seek]]'' player | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "The playback position has been changed. If there is no ID available extra information will be provided.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
"properties": { | "properties": { | ||
"item": { | "item": { | ||
Line 16,571: | Line 18,856: | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,584: | Line 18,872: | ||
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data | # ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"$ref": "Player.Notifications.Data", | |||
"name": "data", | "name": "data", | ||
"required": true | "required": true | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,609: | Line 18,897: | ||
# ''string'' sender | # ''string'' sender | ||
# ''object'' data: | # ''object'' data: | ||
#* ''boolean'' end | |||
#* ''[[#Notifications.Item|Notifications.Item]]'' item | #* ''[[#Notifications.Item|Notifications.Item]]'' item | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "Playback of a media item has been stopped. If there is no ID available extra information will be provided.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
"properties": { | "properties": { | ||
"end": { | |||
"description": "Whether the player has reached the end of the playable item(s) or not", | |||
"required": true, | |||
"type": "boolean" | |||
}, | |||
"item": { | "item": { | ||
"$ref": "Notifications.Item" | "$ref": "Notifications.Item" | ||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,648: | Line 18,936: | ||
# ''string'' sender | # ''string'' sender | ||
# ''object'' data: | # ''object'' data: | ||
#* ''[[#Notifications.Item|Notifications.Item]]'' item | |||
#* ''[[#Playlist.Id|Playlist.Id]]'' playlistid | #* ''[[#Playlist.Id|Playlist.Id]]'' playlistid | ||
#* ''[[#Playlist.Position|Playlist.Position]]'' position | #* ''[[#Playlist.Position|Playlist.Position]]'' position | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "A playlist item has been added.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
"properties": { | "properties": { | ||
"item": { | |||
"$ref": "Notifications.Item" | |||
}, | |||
"playlistid": { | "playlistid": { | ||
"$ref": "Playlist.Id", | "$ref": "Playlist.Id", | ||
"required": true | "required": true | ||
}, | }, | ||
"position": { | "position": { | ||
"$ref": "Playlist.Position" | "$ref": "Playlist.Position" | ||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,691: | Line 18,979: | ||
#* ''[[#Playlist.Id|Playlist.Id]]'' playlistid | #* ''[[#Playlist.Id|Playlist.Id]]'' playlistid | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "A playlist item has been cleared.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
"properties": { | "properties": { | ||
"playlistid": { | "playlistid": { | ||
Line 16,710: | Line 18,995: | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,725: | Line 19,013: | ||
#* ''[[#Playlist.Position|Playlist.Position]]'' position | #* ''[[#Playlist.Position|Playlist.Position]]'' position | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "A playlist item has been removed.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
"properties": { | "properties": { | ||
"playlistid": { | "playlistid": { | ||
Line 16,747: | Line 19,032: | ||
"$ref": "Playlist.Position" | "$ref": "Playlist.Position" | ||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,761: | Line 19,049: | ||
# ''string'' data | # ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "The system is on low battery.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
" | "required": true, | ||
" | "type": "null" | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,788: | Line 19,076: | ||
#* ''integer'' exitcode | #* ''integer'' exitcode | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "Kodi will be closed.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
"properties": { | "properties": { | ||
"exitcode": { | "exitcode": { | ||
"minimum": 0, | "minimum": 0, | ||
"required": true | "required": true, | ||
"type": "integer" | |||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,821: | Line 19,109: | ||
# ''string'' data | # ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "The system will be restarted.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
" | "required": true, | ||
" | "type": "null" | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,847: | Line 19,135: | ||
# ''string'' data | # ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "The system will be suspended.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
" | "required": true, | ||
" | "type": "null" | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,873: | Line 19,161: | ||
# ''string'' data | # ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "The system woke up from suspension.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
" | "required": true, | ||
" | "type": "null" | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,900: | Line 19,188: | ||
# ''string'' data | # ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "The video library has been cleaned.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
" | "required": true, | ||
" | "type": "null" | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,926: | Line 19,214: | ||
# ''string'' data | # ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "A video library clean operation has started.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
" | "required": true, | ||
" | "type": "null" | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,951: | Line 19,239: | ||
# ''string'' sender | # ''string'' sender | ||
# [''object'' data]: | # [''object'' data]: | ||
#* [''integer'' failcount = 0] | |||
#* [''string'' file = ""] | #* [''string'' file = ""] | ||
#* [''string'' root = ""] | #* [''string'' root = ""] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "A video library export has finished.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
"properties": { | "properties": { | ||
"failcount": { | |||
"default": 0, | |||
"minimum": 0, | |||
"required": false, | |||
"type": "integer" | |||
}, | |||
"file": { | "file": { | ||
" | "default": "", | ||
"required": false, | "required": false, | ||
" | "type": "string" | ||
}, | }, | ||
"root": { | "root": { | ||
" | "default": "", | ||
"required": false, | "required": false, | ||
"type": "string" | |||
"type": " | |||
} | } | ||
} | }, | ||
"required": false, | |||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 16,999: | Line 19,287: | ||
# ''string'' data | # ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "The video library has been refreshed and a home screen reload might be necessary.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
" | "required": true, | ||
" | "type": "null" | ||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 17,025: | Line 19,313: | ||
# ''object'' data: | # ''object'' data: | ||
#* ''[[#Library.Id|Library.Id]]'' id | #* ''[[#Library.Id|Library.Id]]'' id | ||
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction | |||
#* ''[[#Notifications.Library.Video.Type|Notifications.Library.Video.Type]]'' type | #* ''[[#Notifications.Library.Video.Type|Notifications.Library.Video.Type]]'' type | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "A video item has been removed.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
" | "required": true, | ||
" | "type": "string" | ||
}, | }, | ||
{ | { | ||
"name": "data", | "name": "data", | ||
"properties": { | "properties": { | ||
"id": { | "id": { | ||
"$ref": "Library.Id", | "$ref": "Library.Id", | ||
"required": true | "required": true | ||
}, | |||
"transaction": { | |||
"$ref": "Optional.Boolean", | |||
"description": "True if the removal is being performed within a transaction." | |||
}, | }, | ||
"type": { | "type": { | ||
"$ref": "Notifications.Library.Video.Type", | "$ref": "Notifications.Library.Video.Type", | ||
"required": true | "required": true | ||
} | } | ||
} | }, | ||
"required": true, | |||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
Line 17,068: | Line 19,356: | ||
# ''string'' data | # ''string'' data | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=" | {{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.", | "description": "Scanning the video library has been finished.", | ||
"params": [ | "params": [ | ||
{ | { | ||
"name": "sender", | "name": "sender", | ||
"type": "string", | "required": true, | ||
"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", | "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, | "required": true, | ||
"type": "object" | |||
} | } | ||
], | ], | ||
"returns": null | "returns": null, | ||
"type": "notification" | |||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
== External links == | == External links == | ||
Line 17,186: | Line 19,467: | ||
* [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)] | * [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)] | ||
[[Category: | {{updated|19}} | ||
[[Category:JSON-RPC]] |
Latest revision as of 22:30, 1 June 2021
JSON-RPC Pages |
---|
Main JSON-RPC Page |
- v8 (Krypton) |
- v10 (Leia) |
- v12 (Matrix) |
- v13 (Nexus) |
- v14 (Omega) |
Examples |
All JSON-RPC Pages |
Development | JSON-RPC API | v12 |
Version 12 is the stable version of Kodi's JSON-RPC API and is published with the release of v19 (Matrix). This document has been updated to version 12.3.0. Recent changes are announced on the forum
It comes with support for WebSockets as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.
JSON-RPC 2.0 compatibility
Version | Method calls | Notifications (server-side) |
Notifications (client-side) |
Parameters by-name |
Parameters by-position |
Batch requests |
---|---|---|---|---|---|---|
Version 6 | Yes | Yes | Yes | Yes | Yes | Yes |
Documentation (JSON Schema)
Supported features of JSON Schema
Schema | IETF Draft 03 |
---|---|
type | Yes |
properties | Yes |
patternProperties | No |
additionalProperties | Yes |
items | Yes |
additionalItems | Yes |
required | Yes |
dependencies | No |
minimum | Yes |
maximum | Yes |
Schema | IETF Draft 03 |
---|---|
exclusiveMinimum | Yes |
exclusiveMaximum | Yes |
minItems | Yes |
maxItems | Yes |
uniqueItems | Yes |
pattern | No |
minLength | Yes |
maxLength | Yes |
enum | Yes |
default | Yes |
Schema | IETF Draft 03 |
---|---|
title | No |
description | Yes |
format | No |
divisibleBy | Yes |
disallow | No |
extends | Yes |
id | Yes |
$ref | Yes |
$schema | No |
Hyper Schema | No |
Error message
If Kodi detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is
{ "type": "object", "properties": { "code": { "type": "integer", "required": true }, "message": { "type": "string", "required": true }, "data": { "type": "object", "properties": { "method": { "type": "string", "required": true }, "stack": { "type": "object", "id": "Error.Stack", "properties": { "name": { "type": "string", "required": true }, "type": { "type": "string", "required": true }, "message": { "type": "string", "required": true }, "property": { "$ref": "Error.Stack" } } } } } } } |
Namespaces
The Kodi JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:
Namespace | Description |
---|---|
Addons | List, enable and execute addons. |
Application | Application information and control. |
AudioLibrary | Audio Library information. |
Favourites | Favourites GetFavourites and AddFavourite. |
Files | Shares information & filesystem listings. |
GUI | Window properties and activation. |
Input | Allows limited navigation within Kodi. |
JSONRPC | A variety of standard JSONRPC calls. |
PVR | Live TV control. |
Player | Manages all available players. |
Playlist | Playlist modification. |
Profiles | Support for Profiles operations to Kodi. |
Settings | Allows manipulation of Kodi settings. |
System | System controls and information. |
Textures | Supplies GetTextures and RemoveTexture. Textures are images. |
VideoLibrary | Video Library information. |
XBMC | Dumping ground for very Kodi specific operations. |
Methods
Addons
Addons.ExecuteAddon
Executes the given addon with the given parameters (if possible)
Permissions:
- ExecuteAddon
Parameters:
- string addonid
- [mixed: object|array|string params = ""]
- [boolean wait = False]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Executes the given addon with the given parameters (if possible)", "params": [ { "name": "addonid", "required": true, "type": "string" }, { "default": "", "name": "params", "type": [ { "additionalProperties": { "default": "", "type": "string" }, "type": "object" }, { "items": { "type": "string" }, "type": "array" }, { "description": "URL path (must start with / or ?", "type": "string" } ] }, { "default": false, "name": "wait", "type": "boolean" } ], "permission": "ExecuteAddon", "returns": { "type": "string" }, "type": "method" } |
Addons.GetAddonDetails
Gets the details of a specific addon
Permissions:
- ReadData
Parameters:
- string addonid
- [Addon.Fields properties]
Returns:
Type: object
Properties:
- Addon.Details addon
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Gets the details of a specific addon", "params": [ { "name": "addonid", "required": true, "type": "string" }, { "$ref": "Addon.Fields", "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "addon": { "$ref": "Addon.Details", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
Addons.GetAddons
Gets all available addons
Permissions:
- ReadData
Parameters:
- [Addon.Types type = unknown]
- [Addon.Content content = unknown] (Content provided by the addon. Only considered for plugins and scripts.)
- [mixed: boolean|string enabled = all]
- [Addon.Fields properties]
- [List.Limits limits]
- [mixed: boolean|string installed = True]
Returns:
Type: object
Properties:
- [array[ Addon.Details ] addons]
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Gets all available addons", "params": [ { "$ref": "Addon.Types", "default": "unknown", "name": "type" }, { "$ref": "Addon.Content", "default": "unknown", "description": "Content provided by the addon. Only considered for plugins and scripts.", "name": "content" }, { "default": "all", "name": "enabled", "type": [ { "type": "boolean" }, { "enums": [ "all" ], "type": "string" } ] }, { "$ref": "Addon.Fields", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "default": true, "name": "installed", "type": [ { "type": "boolean" }, { "enums": [ "all" ], "type": "string" } ] } ], "permission": "ReadData", "returns": { "properties": { "addons": { "items": { "$ref": "Addon.Details" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
Addons.SetAddonEnabled
Enables/Disables a specific addon
Permissions:
- ManageAddon
Parameters:
- string addonid
- Global.Toggle enabled
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Enables/Disables a specific addon", "params": [ { "name": "addonid", "required": true, "type": "string" }, { "$ref": "Global.Toggle", "name": "enabled", "required": true } ], "permission": "ManageAddon", "returns": { "type": "string" }, "type": "method" } |
Application
Application.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- array[ Application.Property.Name ] properties
Returns:
JSON Schema Description |
---|
{ "description": "Retrieves the values of the given properties", "params": [ { "items": { "$ref": "Application.Property.Name" }, "name": "properties", "required": true, "type": "array", "uniqueItems": true } ], "permission": "ReadData", "returns": { "$ref": "Application.Property.Value" }, "type": "method" } |
Application.Quit
Quit application
Permissions:
- ControlPower
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Quit application", "params": [], "permission": "ControlPower", "returns": { "type": "string" }, "type": "method" } |
Application.SetMute
Toggle mute/unmute
Permissions:
- ControlPlayback
Parameters:
- Global.Toggle mute
Returns:
Type: boolean (Mute state)
JSON Schema Description |
---|
{ "description": "Toggle mute/unmute", "params": [ { "$ref": "Global.Toggle", "name": "mute", "required": true } ], "permission": "ControlPlayback", "returns": { "description": "Mute state", "type": "boolean" }, "type": "method" } |
Application.SetVolume
Set the current volume
Permissions:
- ControlPlayback
Parameters:
- mixed: integer|Global.IncrementDecrement volume
Returns:
Type: integer
JSON Schema Description |
---|
{ "description": "Set the current volume", "params": [ { "name": "volume", "required": true, "type": [ { "maximum": 100, "minimum": 0, "type": "integer" }, { "$ref": "Global.IncrementDecrement" } ] } ], "permission": "ControlPlayback", "returns": { "type": "integer" }, "type": "method" } |
AudioLibrary
AudioLibrary.Clean
Cleans the audio library from non-existent items
Permissions:
- RemoveData
Parameters:
- [boolean showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Cleans the audio library from non-existent items", "params": [ { "default": true, "description": "Whether or not to show the progress bar or any other GUI dialog", "name": "showdialogs", "type": "boolean" } ], "permission": "RemoveData", "returns": { "type": "string" }, "type": "method" } |
AudioLibrary.Export
Exports all items from the audio library
Permissions:
- WriteFile
Parameters:
- [mixed: object|object options]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Exports all items from the audio library", "params": [ { "name": "options", "type": [ { "additionalProperties": false, "properties": { "path": { "description": "Path to the directory to where the data should be exported", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "images": { "default": false, "description": "Whether to export thumbnails and fanart images", "type": "boolean" }, "overwrite": { "default": false, "description": "Whether to overwrite existing exported files", "type": "boolean" } }, "type": "object" } ] } ], "permission": "WriteFile", "returns": { "type": "string" }, "type": "method" } |
AudioLibrary.GetAlbumDetails
Retrieve details about a specific album
Permissions:
- ReadData
Parameters:
- Library.Id albumid
- [Audio.Fields.Album properties]
Returns:
Type: object
Properties:
- [Audio.Details.Album albumdetails]
JSON Schema Description |
---|
{ "description": "Retrieve details about a specific album", "params": [ { "$ref": "Library.Id", "name": "albumid", "required": true }, { "$ref": "Audio.Fields.Album", "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "albumdetails": { "$ref": "Audio.Details.Album" } }, "type": "object" }, "type": "method" } |
AudioLibrary.GetAlbums
Retrieve all albums from specified artist (and role) or that has songs of the specified genre
Permissions:
- ReadData
Parameters:
- [Audio.Fields.Album properties]
- [List.Limits limits]
- [List.Sort sort]
- [mixed: object|object|object|object|object|object|object|object|List.Filter.Albums filter]
- [boolean includesingles = False]
- [boolean allroles = False] (Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.)
Returns:
Type: object
Properties:
- [array[ Audio.Details.Album ] albums]
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Retrieve all albums from specified artist (and role) or that has songs of the specified genre", "params": [ { "$ref": "Audio.Fields.Album", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "name": "filter", "type": [ { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "description": "Song genre. Filter for existence of songs with this genre", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "description": "Song genre. Filter for existence of songs with this genre", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true }, "roleid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true }, "role": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" }, "roleid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" }, "role": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "$ref": "List.Filter.Albums" } ] }, { "default": false, "name": "includesingles", "type": "boolean" }, { "default": false, "description": "Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.", "name": "allroles", "type": "boolean" } ], "permission": "ReadData", "returns": { "properties": { "albums": { "items": { "$ref": "Audio.Details.Album" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
AudioLibrary.GetArtistDetails
Retrieve details about a specific artist
Permissions:
- ReadData
Parameters:
- Library.Id artistid
- [Audio.Fields.Artist properties]
Returns:
Type: object
Properties:
- [Audio.Details.Artist artistdetails]
JSON Schema Description |
---|
{ "description": "Retrieve details about a specific artist", "params": [ { "$ref": "Library.Id", "name": "artistid", "required": true }, { "$ref": "Audio.Fields.Artist", "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "artistdetails": { "$ref": "Audio.Details.Artist" } }, "type": "object" }, "type": "method" } |
AudioLibrary.GetArtists
Retrieve all artists. For backward compatibility by default this implicitly does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true
Permissions:
- ReadData
Parameters:
- [Optional.Boolean albumartistsonly = None] (Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used)
- [Audio.Fields.Artist properties]
- [List.Limits limits]
- [List.Sort sort]
- [mixed: object|object|object|object|object|object|object|object|object|object|object|object|object|object|object|List.Filter.Artists filter]
- [boolean allroles = False] (Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.)
Returns:
Type: object
Properties:
- [array[ Audio.Details.Artist ] artists]
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Retrieve all artists. For backward compatibility by default this implicitly does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true", "params": [ { "$ref": "Optional.Boolean", "default": null, "description": "Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used", "name": "albumartistsonly" }, { "$ref": "Audio.Fields.Artist", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "name": "filter", "type": [ { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "description": "Deprecated, use songgenreid. Filter for existence of songs with this genre", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "songgenreid": { "$ref": "Library.Id", "description": "Song genreid. Filter for existence of songs with this genre", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "roleid": { "$ref": "Library.Id", "required": true }, "songgenreid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "role": { "minLength": 1, "required": true, "type": "string" }, "songgenreid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "description": "Deprecated, use songgenre. Filter for existence of songs with this genre", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "songgenre": { "description": "Song genre. Filter for existence of songs with this genre", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "roleid": { "$ref": "Library.Id", "required": true }, "songgenre": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "role": { "minLength": 1, "required": true, "type": "string" }, "songgenre": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "albumid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "album": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "songid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "roleid": { "$ref": "Library.Id", "required": true }, "songid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "role": { "minLength": 1, "required": true, "type": "string" }, "songid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "roleid": { "$ref": "Library.Id", "description": "Role contributed by artist. Overridden by allroles parameter", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "role": { "description": "Role contributed by artist. Overridden by allroles parameter", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "$ref": "List.Filter.Artists" } ] }, { "default": false, "description": "Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.", "name": "allroles", "type": "boolean" } ], "permission": "ReadData", "returns": { "properties": { "artists": { "items": { "$ref": "Audio.Details.Artist" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
AudioLibrary.GetAvailableArt
Retrieve all potential art URLs for a media item by art type
Permissions:
- ReadData
Parameters:
- mixed: object|object item
- [string arttype = ""]
Returns:
Type: object
Properties:
- array availableart
JSON Schema Description |
---|
{ "description": "Retrieve all potential art URLs for a media item by art type", "params": [ { "name": "item", "required": true, "type": [ { "additionalProperties": false, "properties": { "albumid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true } }, "type": "object" } ] }, { "default": "", "name": "arttype", "type": "string" } ], "permission": "ReadData", "returns": { "properties": { "availableart": { "items": { "properties": { "arttype": { "required": true, "type": "string" }, "previewurl": { "default": "", "description": "URL to a preview thumbnail of the image", "type": "string" }, "url": { "description": "URL to the original image", "required": true, "type": "string" } }, "type": "object" }, "required": true, "type": "array" } }, "type": "object" }, "type": "method" } |
AudioLibrary.GetAvailableArtTypes
Retrieve a list of potential art types for a media item
Permissions:
- ReadData
Parameters:
- mixed: object|object item
Returns:
Type: object
Properties:
- array availablearttypes
JSON Schema Description |
---|
{ "description": "Retrieve a list of potential art types for a media item", "params": [ { "name": "item", "required": true, "type": [ { "additionalProperties": false, "properties": { "albumid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true } }, "type": "object" } ] } ], "permission": "ReadData", "returns": { "properties": { "availablearttypes": { "items": { "type": "string" }, "required": true, "type": "array" } }, "type": "object" }, "type": "method" } |
AudioLibrary.GetGenres
Retrieve all genres
Permissions:
- ReadData
Parameters:
- [Library.Fields.Genre properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- array[ Library.Details.Genre ] genres
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Retrieve all genres", "params": [ { "$ref": "Library.Fields.Genre", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "genres": { "items": { "$ref": "Library.Details.Genre" }, "required": true, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
AudioLibrary.GetProperties
Retrieves the values of the music library properties
Permissions:
- ReadData
Parameters:
- array[ Audio.Property.Name ] properties
Returns:
Type: Audio.Property.Value
JSON Schema Description |
---|
{ "description": "Retrieves the values of the music library properties", "params": [ { "items": { "$ref": "Audio.Property.Name" }, "name": "properties", "required": true, "type": "array", "uniqueItems": true } ], "permission": "ReadData", "returns": { "$ref": "Audio.Property.Value" }, "type": "method" } |
AudioLibrary.GetRecentlyAddedAlbums
Retrieve recently added albums
Permissions:
- ReadData
Parameters:
- [Audio.Fields.Album properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- [array[ Audio.Details.Album ] albums]
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Retrieve recently added albums", "params": [ { "$ref": "Audio.Fields.Album", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "albums": { "items": { "$ref": "Audio.Details.Album" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
AudioLibrary.GetRecentlyAddedSongs
Retrieve recently added songs
Permissions:
- ReadData
Parameters:
- [List.Amount albumlimit = -1] (The amount of recently added albums from which to return the songs)
- [Audio.Fields.Song properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [array[ Audio.Details.Song ] songs]
JSON Schema Description |
---|
{ "description": "Retrieve recently added songs", "params": [ { "$ref": "List.Amount", "default": -1, "description": "The amount of recently added albums from which to return the songs", "name": "albumlimit" }, { "$ref": "Audio.Fields.Song", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "songs": { "items": { "$ref": "Audio.Details.Song" }, "type": "array" } }, "type": "object" }, "type": "method" } |
AudioLibrary.GetRecentlyPlayedAlbums
Retrieve recently played albums
Permissions:
- ReadData
Parameters:
- [Audio.Fields.Album properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- [array[ Audio.Details.Album ] albums]
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Retrieve recently played albums", "params": [ { "$ref": "Audio.Fields.Album", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "albums": { "items": { "$ref": "Audio.Details.Album" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
AudioLibrary.GetRecentlyPlayedSongs
Retrieve recently played songs
Permissions:
- ReadData
Parameters:
- [Audio.Fields.Song properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [array[ Audio.Details.Song ] songs]
JSON Schema Description |
---|
{ "description": "Retrieve recently played songs", "params": [ { "$ref": "Audio.Fields.Song", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "songs": { "items": { "$ref": "Audio.Details.Song" }, "type": "array" } }, "type": "object" }, "type": "method" } |
AudioLibrary.GetRoles
Retrieve all contributor roles
Permissions:
- ReadData
Parameters:
- [Audio.Fields.Role properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- array[ Audio.Details.Role ] roles
JSON Schema Description |
---|
{ "description": "Retrieve all contributor roles", "params": [ { "$ref": "Audio.Fields.Role", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "roles": { "items": { "$ref": "Audio.Details.Role" }, "required": true, "type": "array" } }, "type": "object" }, "type": "method" } |
AudioLibrary.GetSongDetails
Retrieve details about a specific song
Permissions:
- ReadData
Parameters:
- Library.Id songid
- [Audio.Fields.Song properties]
Returns:
Type: object
Properties:
- [Audio.Details.Song songdetails]
JSON Schema Description |
---|
{ "description": "Retrieve details about a specific song", "params": [ { "$ref": "Library.Id", "name": "songid", "required": true }, { "$ref": "Audio.Fields.Song", "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "songdetails": { "$ref": "Audio.Details.Song" } }, "type": "object" }, "type": "method" } |
AudioLibrary.GetSongs
Retrieve all songs from specified album, artist or genre
Permissions:
- ReadData
Parameters:
- [Audio.Fields.Song properties]
- [List.Limits limits]
- [List.Sort sort]
- [mixed: object|object|object|object|object|object|object|object|object|object|List.Filter.Songs filter]
- [boolean includesingles = True] (Only songs from albums are returned when false, but overridden when singlesonly parameter is true)
- [boolean allroles = False] (Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.)
- [boolean singlesonly = False] (Only singles are returned when true, and overrides includesingles parameter)
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [array[ Audio.Details.Song ] songs]
JSON Schema Description |
---|
{ "description": "Retrieve all songs from specified album, artist or genre", "params": [ { "$ref": "Audio.Fields.Song", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "name": "filter", "type": [ { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "description": "Song genre. Filter for existence of songs with this genre", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "description": "Song genre. Filter for existence of songs with this genre", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true }, "roleid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true }, "role": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" }, "roleid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" }, "role": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "albumid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "album": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "$ref": "List.Filter.Songs" } ] }, { "default": true, "description": "Only songs from albums are returned when false, but overridden when singlesonly parameter is true", "name": "includesingles", "type": "boolean" }, { "default": false, "description": "Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.", "name": "allroles", "type": "boolean" }, { "default": false, "description": "Only singles are returned when true, and overrides includesingles parameter", "name": "singlesonly", "type": "boolean" } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "songs": { "items": { "$ref": "Audio.Details.Song" }, "type": "array" } }, "type": "object" }, "type": "method" } |
AudioLibrary.GetSources
Get all music sources, including unique ID
Permissions:
- ReadData
Parameters:
- [Library.Fields.Source properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- array[ Library.Details.Source ] sources
JSON Schema Description |
---|
{ "description": "Get all music sources, including unique ID", "params": [ { "$ref": "Library.Fields.Source", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "sources": { "items": { "$ref": "Library.Details.Source" }, "required": true, "type": "array" } }, "type": "object" }, "type": "method" } |
AudioLibrary.Scan
Scans the audio sources for new library items
Permissions:
- UpdateData
Parameters:
- [string directory = ""]
- [boolean showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Scans the audio sources for new library items", "params": [ { "default": "", "name": "directory", "type": "string" }, { "default": true, "description": "Whether or not to show the progress bar or any other GUI dialog", "name": "showdialogs", "type": "boolean" } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
AudioLibrary.SetAlbumDetails
Update the given album with the given details
Permissions:
- UpdateData
Parameters:
- Library.Id albumid
- [Optional.String title = None]
- [mixed: null|Array.String artist = None]
- [Optional.String description = None]
- [mixed: null|Array.String genre = None]
- [mixed: null|Array.String theme = None]
- [mixed: null|Array.String mood = None]
- [mixed: null|Array.String style = None]
- [Optional.String type = None]
- [Optional.String albumlabel = None]
- [Optional.Number rating = None]
- [Optional.Integer year = None]
- [Optional.Integer userrating = None]
- [Optional.Integer votes = None]
- [Optional.String musicbrainzalbumid = None]
- [Optional.String musicbrainzreleasegroupid = None]
- [Optional.String sortartist = None]
- [Optional.String displayartist = None]
- [mixed: null|Array.String musicbrainzalbumartistid = None]
- [mixed: null|Media.Artwork.Set art = None]
- [Optional.Boolean isboxset = None]
- [Optional.String releasedate = None]
- [Optional.String originaldate = None]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Update the given album with the given details", "params": [ { "$ref": "Library.Id", "name": "albumid", "required": true }, { "$ref": "Optional.String", "default": null, "name": "title" }, { "default": null, "name": "artist", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "$ref": "Optional.String", "default": null, "name": "description" }, { "default": null, "name": "genre", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "default": null, "name": "theme", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "default": null, "name": "mood", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "default": null, "name": "style", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "$ref": "Optional.String", "default": null, "name": "type" }, { "$ref": "Optional.String", "default": null, "name": "albumlabel" }, { "$ref": "Optional.Number", "default": null, "name": "rating" }, { "$ref": "Optional.Integer", "default": null, "name": "year" }, { "$ref": "Optional.Integer", "default": null, "name": "userrating" }, { "$ref": "Optional.Integer", "default": null, "name": "votes" }, { "$ref": "Optional.String", "default": null, "name": "musicbrainzalbumid" }, { "$ref": "Optional.String", "default": null, "name": "musicbrainzreleasegroupid" }, { "$ref": "Optional.String", "default": null, "name": "sortartist" }, { "$ref": "Optional.String", "default": null, "name": "displayartist" }, { "default": null, "name": "musicbrainzalbumartistid", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "default": null, "name": "art", "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ] }, { "$ref": "Optional.Boolean", "default": null, "name": "isboxset" }, { "$ref": "Optional.String", "default": null, "name": "releasedate" }, { "$ref": "Optional.String", "default": null, "name": "originaldate" } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
AudioLibrary.SetArtistDetails
Update the given artist with the given details
Permissions:
- UpdateData
Parameters:
- Library.Id artistid
- [Optional.String artist = None]
- [mixed: null|Array.String instrument = None]
- [mixed: null|Array.String style = None]
- [mixed: null|Array.String mood = None]
- [Optional.String born = None]
- [Optional.String formed = None]
- [Optional.String description = None]
- [mixed: null|Array.String genre = None]
- [Optional.String died = None]
- [Optional.String disbanded = None]
- [mixed: null|Array.String yearsactive = None]
- [Optional.String musicbrainzartistid = None]
- [Optional.String sortname = None]
- [Optional.String type = None]
- [Optional.String gender = None]
- [Optional.String disambiguation = None]
- [mixed: null|Media.Artwork.Set art = None]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Update the given artist with the given details", "params": [ { "$ref": "Library.Id", "name": "artistid", "required": true }, { "$ref": "Optional.String", "default": null, "name": "artist" }, { "default": null, "name": "instrument", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "default": null, "name": "style", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "default": null, "name": "mood", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "$ref": "Optional.String", "default": null, "name": "born" }, { "$ref": "Optional.String", "default": null, "name": "formed" }, { "$ref": "Optional.String", "default": null, "name": "description" }, { "default": null, "name": "genre", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "$ref": "Optional.String", "default": null, "name": "died" }, { "$ref": "Optional.String", "default": null, "name": "disbanded" }, { "default": null, "name": "yearsactive", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "$ref": "Optional.String", "default": null, "name": "musicbrainzartistid" }, { "$ref": "Optional.String", "default": null, "name": "sortname" }, { "$ref": "Optional.String", "default": null, "name": "type" }, { "$ref": "Optional.String", "default": null, "name": "gender" }, { "$ref": "Optional.String", "default": null, "name": "disambiguation" }, { "default": null, "name": "art", "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ] } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
AudioLibrary.SetSongDetails
Update the given song with the given details
Permissions:
- UpdateData
Parameters:
- Library.Id songid
- [Optional.String title = None]
- [mixed: null|Array.String artist = None]
- [mixed: null|Array.String genre = None]
- [Optional.Integer year = None]
- [Optional.Number rating = None]
- [Optional.Integer track = None]
- [Optional.Integer disc = None]
- [Optional.Integer duration = None]
- [Optional.String comment = None]
- [Optional.String musicbrainztrackid = None]
- [Optional.String musicbrainzartistid = None]
- [Optional.Integer playcount = None]
- [Optional.String lastplayed = None]
- [Optional.Integer userrating = None]
- [Optional.Integer votes = None]
- [Optional.String displayartist = None]
- [Optional.String sortartist = None]
- [Optional.String mood = None]
- [mixed: null|Media.Artwork.Set art = None]
- [Optional.String disctitle = None]
- [Optional.String releasedate = None]
- [Optional.String originaldate = None]
- [Optional.Integer bpm = None]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Update the given song with the given details", "params": [ { "$ref": "Library.Id", "name": "songid", "required": true }, { "$ref": "Optional.String", "default": null, "name": "title" }, { "default": null, "name": "artist", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "default": null, "name": "genre", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "$ref": "Optional.Integer", "default": null, "name": "year" }, { "$ref": "Optional.Number", "default": null, "name": "rating" }, { "$ref": "Optional.Integer", "default": null, "name": "track" }, { "$ref": "Optional.Integer", "default": null, "name": "disc" }, { "$ref": "Optional.Integer", "default": null, "name": "duration" }, { "$ref": "Optional.String", "default": null, "name": "comment" }, { "$ref": "Optional.String", "default": null, "name": "musicbrainztrackid" }, { "$ref": "Optional.String", "default": null, "name": "musicbrainzartistid" }, { "$ref": "Optional.Integer", "default": null, "name": "playcount" }, { "$ref": "Optional.String", "default": null, "name": "lastplayed" }, { "$ref": "Optional.Integer", "default": null, "name": "userrating" }, { "$ref": "Optional.Integer", "default": null, "name": "votes" }, { "$ref": "Optional.String", "default": null, "name": "displayartist" }, { "$ref": "Optional.String", "default": null, "name": "sortartist" }, { "$ref": "Optional.String", "default": null, "name": "mood" }, { "default": null, "name": "art", "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ] }, { "$ref": "Optional.String", "default": null, "name": "disctitle" }, { "$ref": "Optional.String", "default": null, "name": "releasedate" }, { "$ref": "Optional.String", "default": null, "name": "originaldate" }, { "$ref": "Optional.Integer", "default": null, "name": "bpm" } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
Favourites
Favourites.AddFavourite
Add a favourite with the given details
Permissions:
- UpdateData
Parameters:
- string title
- Favourite.Type type
- [Optional.String path = None] (Required for media, script and androidapp favourites types)
- [Optional.String window = None] (Required for window favourite type)
- [Optional.String windowparameter = None]
- [Optional.String thumbnail = None]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Add a favourite with the given details", "params": [ { "name": "title", "required": true, "type": "string" }, { "$ref": "Favourite.Type", "name": "type", "required": true }, { "$ref": "Optional.String", "default": null, "description": "Required for media, script and androidapp favourites types", "name": "path" }, { "$ref": "Optional.String", "default": null, "description": "Required for window favourite type", "name": "window" }, { "$ref": "Optional.String", "default": null, "name": "windowparameter" }, { "$ref": "Optional.String", "default": null, "name": "thumbnail" } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
Favourites.GetFavourites
Retrieve all favourites
Permissions:
- ReadData
Parameters:
- [mixed: null|Favourite.Type type = None]
- [Favourite.Fields.Favourite properties]
Returns:
Type: object
Properties:
- [array[ Favourite.Details.Favourite ] favourites]
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Retrieve all favourites", "params": [ { "default": null, "name": "type", "type": [ { "type": "null" }, { "$ref": "Favourite.Type" } ] }, { "$ref": "Favourite.Fields.Favourite", "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "favourites": { "items": { "$ref": "Favourite.Details.Favourite" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
Files
Files.Download
Downloads the given file
Permissions:
- ReadData
Parameters:
- string path
Returns:
Type: any
JSON Schema Description |
---|
{ "description": "Downloads the given file", "params": [ { "name": "path", "required": true, "type": "string" } ], "permission": "ReadData", "returns": { "type": "any" }, "type": "method" } |
Files.GetDirectory
Get the directories and files in the given directory
Permissions:
- ReadData
Parameters:
- string directory
- [Files.Media media = files]
- [List.Fields.Files properties]
- [List.Sort sort]
- [List.Limits limits] (Limits are applied after getting the directory content thus retrieval is not faster when they are applied.)
Returns:
Type: object
Properties:
- array[ List.Item.File ] files
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Get the directories and files in the given directory", "params": [ { "name": "directory", "required": true, "type": "string" }, { "$ref": "Files.Media", "default": "files", "name": "media" }, { "$ref": "List.Fields.Files", "name": "properties" }, { "$ref": "List.Sort", "name": "sort" }, { "$ref": "List.Limits", "description": "Limits are applied after getting the directory content thus retrieval is not faster when they are applied.", "name": "limits" } ], "permission": "ReadData", "returns": { "properties": { "files": { "items": { "$ref": "List.Item.File" }, "required": true, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
Files.GetFileDetails
Get details for a specific file
Permissions:
- ReadData
Parameters:
- string file (Full path to the file)
- [Files.Media media = files]
- [List.Fields.Files properties]
Returns:
Type: object
Properties:
- List.Item.File filedetails
JSON Schema Description |
---|
{ "description": "Get details for a specific file", "params": [ { "description": "Full path to the file", "name": "file", "required": true, "type": "string" }, { "$ref": "Files.Media", "default": "files", "name": "media" }, { "$ref": "List.Fields.Files", "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "filedetails": { "$ref": "List.Item.File", "required": true } }, "type": "object" }, "type": "method" } |
Files.GetSources
Get the sources of the media windows
Permissions:
- ReadData
Parameters:
- Files.Media media
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- List.Items.Sources sources
JSON Schema Description |
---|
{ "description": "Get the sources of the media windows", "params": [ { "$ref": "Files.Media", "name": "media", "required": true }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "sources": { "$ref": "List.Items.Sources", "required": true } }, "type": "object" }, "type": "method" } |
Files.PrepareDownload
Provides a way to download a given file (e.g. providing an URL to the real file location)
Permissions:
- ReadData
Parameters:
- string path
Returns:
Type: object
Properties:
- any details (Transport specific details on how/from where to download the given file)
- string mode (Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol)
- string protocol
JSON Schema Description |
---|
{ "description": "Provides a way to download a given file (e.g. providing an URL to the real file location)", "params": [ { "name": "path", "required": true, "type": "string" } ], "permission": "ReadData", "returns": { "properties": { "details": { "description": "Transport specific details on how/from where to download the given file", "required": true, "type": "any" }, "mode": { "description": "Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol", "enums": [ "redirect", "direct" ], "required": true, "type": "string" }, "protocol": { "enums": [ "http" ], "required": true, "type": "string" } }, "type": "object" }, "type": "method" } |
Files.SetFileDetails
Update the given specific file with the given details
Permissions:
- UpdateData
Parameters:
- string file (Full path to the file)
- Files.Media media (File type to update correct database. Currently only "video" is supported.)
- [Optional.Integer playcount = None]
- [Optional.String lastplayed = None] (Setting a valid lastplayed without a playcount will force playcount to 1.)
- [mixed: null|Video.Resume resume = None]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Update the given specific file with the given details", "params": [ { "description": "Full path to the file", "name": "file", "required": true, "type": "string" }, { "$ref": "Files.Media", "description": "File type to update correct database. Currently only \"video\" is supported.", "name": "media", "required": true }, { "$ref": "Optional.Integer", "default": null, "name": "playcount" }, { "$ref": "Optional.String", "default": null, "description": "Setting a valid lastplayed without a playcount will force playcount to 1.", "name": "lastplayed" }, { "default": null, "name": "resume", "type": [ { "type": "null" }, { "$ref": "Video.Resume" } ] } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
GUI
GUI.ActivateWindow
Activates the given window
Permissions:
- ControlGUI
Parameters:
- GUI.Window window
- [array[string] parameters]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Activates the given window", "params": [ { "$ref": "GUI.Window", "name": "window", "required": true }, { "items": { "minLength": 1, "type": "string" }, "minItems": 1, "name": "parameters", "type": "array" } ], "permission": "ControlGUI", "returns": { "type": "string" }, "type": "method" } |
GUI.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- array[ GUI.Property.Name ] properties
Returns:
Type: GUI.Property.Value
JSON Schema Description |
---|
{ "description": "Retrieves the values of the given properties", "params": [ { "items": { "$ref": "GUI.Property.Name" }, "name": "properties", "required": true, "type": "array", "uniqueItems": true } ], "permission": "ReadData", "returns": { "$ref": "GUI.Property.Value" }, "type": "method" } |
GUI.GetStereoscopicModes
Returns the supported stereoscopic modes of the GUI
Permissions:
- ReadData
Returns:
Type: object
Properties:
- [array[ GUI.Stereoscopy.Mode ] stereoscopicmodes]
JSON Schema Description |
---|
{ "description": "Returns the supported stereoscopic modes of the GUI", "params": [], "permission": "ReadData", "returns": { "properties": { "stereoscopicmodes": { "items": { "$ref": "GUI.Stereoscopy.Mode" }, "type": "array", "uniqueItems": true } }, "type": "object" }, "type": "method" } |
GUI.SetFullscreen
Toggle fullscreen/GUI
Permissions:
- ControlGUI
Parameters:
- Global.Toggle fullscreen
Returns:
Type: boolean (Fullscreen state)
JSON Schema Description |
---|
{ "description": "Toggle fullscreen/GUI", "params": [ { "$ref": "Global.Toggle", "name": "fullscreen", "required": true } ], "permission": "ControlGUI", "returns": { "description": "Fullscreen state", "type": "boolean" }, "type": "method" } |
GUI.SetStereoscopicMode
Sets the stereoscopic mode of the GUI to the given mode
Permissions:
- ControlGUI
Parameters:
- string mode
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Sets the stereoscopic mode of the GUI to the given mode", "params": [ { "enums": [ "toggle", "tomono", "next", "previous", "select", "off", "split_vertical", "split_horizontal", "row_interleaved", "hardware_based", "anaglyph_cyan_red", "anaglyph_green_magenta", "monoscopic" ], "name": "mode", "required": true, "type": "string" } ], "permission": "ControlGUI", "returns": { "type": "string" }, "type": "method" } |
GUI.ShowNotification
Shows a GUI notification
Permissions:
- ControlGUI
Parameters:
- string title
- string message
- [mixed: string|string image = ""]
- [integer displaytime = 5000] (The time in milliseconds the notification will be visible)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Shows a GUI notification", "params": [ { "name": "title", "required": true, "type": "string" }, { "name": "message", "required": true, "type": "string" }, { "default": "", "name": "image", "type": [ { "enums": [ "info", "warning", "error" ], "type": "string" }, { "type": "string" } ] }, { "default": 5000, "description": "The time in milliseconds the notification will be visible", "minimum": 1500, "name": "displaytime", "type": "integer" } ], "permission": "ControlGUI", "returns": { "type": "string" }, "type": "method" } |
Input
Input.Back
Goes back in GUI
Permissions:
- Navigate
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Goes back in GUI", "params": [], "permission": "Navigate", "returns": { "type": "string" }, "type": "method" } |
Input.ButtonEvent
Send a button press event
Permissions:
- Navigate
Parameters:
- string button (Button name)
- string keymap (Keymap name (KB, XG, R1, or R2))
- [integer holdtime = 0] (Number of milliseconds to simulate button hold.)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Send a button press event", "params": [ { "description": "Button name", "name": "button", "required": true, "type": "string" }, { "description": "Keymap name (KB, XG, R1, or R2)", "enums": [ "KB", "XG", "R1", "R2" ], "name": "keymap", "required": true, "type": "string" }, { "default": 0, "description": "Number of milliseconds to simulate button hold.", "minimum": 0, "name": "holdtime", "type": "integer" } ], "permission": "Navigate", "returns": { "type": "string" }, "type": "method" } |
Input.ContextMenu
Shows the context menu
Permissions:
- Navigate
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Shows the context menu", "params": [], "permission": "Navigate", "returns": { "type": "string" }, "type": "method" } |
Input.Down
Navigate down in GUI
Permissions:
- Navigate
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Navigate down in GUI", "params": [], "permission": "Navigate", "returns": { "type": "string" }, "type": "method" } |
Input.ExecuteAction
Execute a specific action
Permissions:
- Navigate
Parameters:
- Input.Action action
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Execute a specific action", "params": [ { "$ref": "Input.Action", "name": "action", "required": true } ], "permission": "Navigate", "returns": { "type": "string" }, "type": "method" } |
Input.Home
Goes to home window in GUI
Permissions:
- Navigate
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Goes to home window in GUI", "params": [], "permission": "Navigate", "returns": { "type": "string" }, "type": "method" } |
Input.Info
Shows the information dialog
Permissions:
- Navigate
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Shows the information dialog", "params": [], "permission": "Navigate", "returns": { "type": "string" }, "type": "method" } |
Input.Left
Navigate left in GUI
Permissions:
- Navigate
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Navigate left in GUI", "params": [], "permission": "Navigate", "returns": { "type": "string" }, "type": "method" } |
Input.Right
Navigate right in GUI
Permissions:
- Navigate
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Navigate right in GUI", "params": [], "permission": "Navigate", "returns": { "type": "string" }, "type": "method" } |
Input.Select
Select current item in GUI
Permissions:
- Navigate
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Select current item in GUI", "params": [], "permission": "Navigate", "returns": { "type": "string" }, "type": "method" } |
Input.SendText
Send a generic (unicode) text
Permissions:
- Navigate
Parameters:
- string text (Unicode text)
- [boolean done = True] (Whether this is the whole input or not (closes an open input dialog if true).)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Send a generic (unicode) text", "params": [ { "description": "Unicode text", "name": "text", "required": true, "type": "string" }, { "default": true, "description": "Whether this is the whole input or not (closes an open input dialog if true).", "name": "done", "type": "boolean" } ], "permission": "Navigate", "returns": { "type": "string" }, "type": "method" } |
Input.ShowCodec
Show codec information of the playing item
Permissions:
- Navigate
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Show codec information of the playing item", "params": [], "permission": "Navigate", "returns": { "type": "string" }, "type": "method" } |
Input.ShowOSD
Show the on-screen display for the current player
Permissions:
- Navigate
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Show the on-screen display for the current player", "params": [], "permission": "Navigate", "returns": { "type": "string" }, "type": "method" } |
Input.ShowPlayerProcessInfo
Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...
Permissions:
- Navigate
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...", "params": [], "permission": "Navigate", "returns": { "type": "string" }, "type": "method" } |
Input.Up
Navigate up in GUI
Permissions:
- Navigate
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Navigate up in GUI", "params": [], "permission": "Navigate", "returns": { "type": "string" }, "type": "method" } |
JSONRPC
JSONRPC.GetConfiguration
Get client-specific configurations
Permissions:
- ReadData
Returns:
Type: Configuration
JSON Schema Description |
---|
{ "description": "Get client-specific configurations", "params": [], "permission": "ReadData", "returns": { "$ref": "Configuration" }, "type": "method" } |
JSONRPC.Introspect
Enumerates all actions and descriptions
Permissions:
- ReadData
Parameters:
- [boolean getdescriptions = True]
- [boolean getmetadata = False]
- [boolean filterbytransport = True]
- [object filter]
Returns:
Type: object
JSON Schema Description |
---|
{ "description": "Enumerates all actions and descriptions", "params": [ { "default": true, "name": "getdescriptions", "type": "boolean" }, { "default": false, "name": "getmetadata", "type": "boolean" }, { "default": true, "name": "filterbytransport", "type": "boolean" }, { "name": "filter", "properties": { "getreferences": { "default": true, "description": "Whether or not to print the schema for referenced types", "type": "boolean" }, "id": { "description": "Name of a namespace, method or type", "required": true, "type": "string" }, "type": { "description": "Type of the given name", "enums": [ "method", "namespace", "type", "notification" ], "required": true, "type": "string" } }, "type": "object" } ], "permission": "ReadData", "returns": { "additionalProperties": false, "type": "object" }, "type": "method" } |
JSONRPC.NotifyAll
Notify all other connected clients
Permissions:
- ReadData
Parameters:
- string sender
- string message
- [any data = None]
Returns:
Type: any
JSON Schema Description |
---|
{ "description": "Notify all other connected clients", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "message", "required": true, "type": "string" }, { "default": null, "name": "data", "type": "any" } ], "permission": "ReadData", "returns": { "type": "any" }, "type": "method" } |
JSONRPC.Permission
Retrieve the clients permissions
Permissions:
- ReadData
Returns:
Type: object
Properties:
- boolean controlgui
- boolean controlnotify
- boolean controlplayback
- boolean controlpower
- boolean controlpvr
- boolean controlsystem
- boolean executeaddon
- boolean manageaddon
- boolean navigate
- boolean readdata
- boolean removedata
- boolean updatedata
- boolean writefile
JSON Schema Description |
---|
{ "description": "Retrieve the clients permissions", "params": [], "permission": "ReadData", "returns": { "properties": { "controlgui": { "required": true, "type": "boolean" }, "controlnotify": { "required": true, "type": "boolean" }, "controlplayback": { "required": true, "type": "boolean" }, "controlpower": { "required": true, "type": "boolean" }, "controlpvr": { "required": true, "type": "boolean" }, "controlsystem": { "required": true, "type": "boolean" }, "executeaddon": { "required": true, "type": "boolean" }, "manageaddon": { "required": true, "type": "boolean" }, "navigate": { "required": true, "type": "boolean" }, "readdata": { "required": true, "type": "boolean" }, "removedata": { "required": true, "type": "boolean" }, "updatedata": { "required": true, "type": "boolean" }, "writefile": { "required": true, "type": "boolean" } }, "type": "object" }, "type": "method" } |
JSONRPC.Ping
Ping responder
Permissions:
- ReadData
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Ping responder", "params": [], "permission": "ReadData", "returns": { "type": "string" }, "type": "method" } |
JSONRPC.SetConfiguration
Change the client-specific configuration
Permissions:
- ControlNotify
Parameters:
- [object notifications]
Returns:
Type: Configuration
JSON Schema Description |
---|
{ "description": "Change the client-specific configuration", "params": [ { "name": "notifications", "properties": { "application": { "$ref": "Optional.Boolean", "default": null }, "audiolibrary": { "$ref": "Optional.Boolean", "default": null }, "gui": { "$ref": "Optional.Boolean", "default": null }, "input": { "$ref": "Optional.Boolean", "default": null }, "other": { "$ref": "Optional.Boolean", "default": null }, "player": { "$ref": "Optional.Boolean", "default": null }, "playlist": { "$ref": "Optional.Boolean", "default": null }, "system": { "$ref": "Optional.Boolean", "default": null }, "videolibrary": { "$ref": "Optional.Boolean", "default": null } }, "type": "object" } ], "permission": "ControlNotify", "returns": { "$ref": "Configuration" }, "type": "method" } |
JSONRPC.Version
Retrieve the JSON-RPC protocol version.
Permissions:
- ReadData
Returns:
Type: object
Properties:
- object version
JSON Schema Description |
---|
{ "description": "Retrieve the JSON-RPC protocol version.", "params": [], "permission": "ReadData", "returns": { "properties": { "version": { "properties": { "major": { "description": "Bumped on backwards incompatible changes to the API definition", "minimum": 0, "required": true, "type": "integer" }, "minor": { "description": "Bumped on backwards compatible additions/changes to the API definition", "minimum": 0, "required": true, "type": "integer" }, "patch": { "description": "Bumped on any changes to the internal implementation but not to the API definition", "minimum": 0, "required": true, "type": "integer" } }, "required": true, "type": "object" } }, "type": "object" }, "type": "method" } |
PVR
PVR.AddTimer
Adds a timer to record the given show one times or a timer rule to record all showings of the given show or adds a reminder timer or reminder timer rule
Permissions:
- ControlPVR
Parameters:
- Library.Id broadcastid (the broadcast id of the item to record)
- [boolean timerrule = False] (controls whether to create a timer rule or a onetime timer)
- [boolean reminder = False] (controls whether to create a reminder timer or a recording timer)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Adds a timer to record the given show one times or a timer rule to record all showings of the given show or adds a reminder timer or reminder timer rule", "params": [ { "$ref": "Library.Id", "description": "the broadcast id of the item to record", "name": "broadcastid", "required": true }, { "default": false, "description": "controls whether to create a timer rule or a onetime timer", "name": "timerrule", "type": "boolean" }, { "default": false, "description": "controls whether to create a reminder timer or a recording timer", "name": "reminder", "type": "boolean" } ], "permission": "ControlPVR", "returns": { "type": "string" }, "type": "method" } |
PVR.DeleteTimer
Deletes a onetime timer or a timer rule
Permissions:
- ControlPVR
Parameters:
- Library.Id timerid (the id of the onetime timer or timer rule to delete)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Deletes a onetime timer or a timer rule", "params": [ { "$ref": "Library.Id", "description": "the id of the onetime timer or timer rule to delete", "name": "timerid", "required": true } ], "permission": "ControlPVR", "returns": { "type": "string" }, "type": "method" } |
PVR.GetBroadcastDetails
Retrieves the details of a specific broadcast
Permissions:
- ReadData
Parameters:
- Library.Id broadcastid
- [PVR.Fields.Broadcast properties]
Returns:
Type: object
Properties:
- [PVR.Details.Broadcast broadcastdetails]
JSON Schema Description |
---|
{ "description": "Retrieves the details of a specific broadcast", "params": [ { "$ref": "Library.Id", "name": "broadcastid", "required": true }, { "$ref": "PVR.Fields.Broadcast", "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "broadcastdetails": { "$ref": "PVR.Details.Broadcast" } }, "type": "object" }, "type": "method" } |
PVR.GetBroadcastIsPlayable
Retrieves whether or not a broadcast is playable
Permissions:
- ReadData
Parameters:
- Library.Id broadcastid (the id of the broadcast to to check for playability)
Returns:
Type: boolean
JSON Schema Description |
---|
{ "description": "Retrieves whether or not a broadcast is playable", "params": [ { "$ref": "Library.Id", "description": "the id of the broadcast to to check for playability", "name": "broadcastid", "required": true } ], "permission": "ReadData", "returns": { "type": "boolean" }, "type": "method" } |
PVR.GetBroadcasts
Retrieves the program of a specific channel
Permissions:
- ReadData
Parameters:
- Library.Id channelid
- [PVR.Fields.Broadcast properties]
- [List.Limits limits]
Returns:
Type: object
Properties:
- array[ PVR.Details.Broadcast ] broadcasts
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Retrieves the program of a specific channel", "params": [ { "$ref": "Library.Id", "name": "channelid", "required": true }, { "$ref": "PVR.Fields.Broadcast", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" } ], "permission": "ReadData", "returns": { "properties": { "broadcasts": { "items": { "$ref": "PVR.Details.Broadcast" }, "required": true, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
PVR.GetChannelDetails
Retrieves the details of a specific channel
Permissions:
- ReadData
Parameters:
- Library.Id channelid
- [PVR.Fields.Channel properties]
Returns:
Type: object
Properties:
- [PVR.Details.Channel channeldetails]
JSON Schema Description |
---|
{ "description": "Retrieves the details of a specific channel", "params": [ { "$ref": "Library.Id", "name": "channelid", "required": true }, { "$ref": "PVR.Fields.Channel", "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "channeldetails": { "$ref": "PVR.Details.Channel" } }, "type": "object" }, "type": "method" } |
PVR.GetChannelGroupDetails
Retrieves the details of a specific channel group
Permissions:
- ReadData
Parameters:
- PVR.ChannelGroup.Id channelgroupid
- [object channels]
Returns:
Type: object
Properties:
- [PVR.Details.ChannelGroup.Extended channelgroupdetails]
JSON Schema Description |
---|
{ "description": "Retrieves the details of a specific channel group", "params": [ { "$ref": "PVR.ChannelGroup.Id", "name": "channelgroupid", "required": true }, { "name": "channels", "properties": { "limits": { "$ref": "List.Limits" }, "properties": { "$ref": "PVR.Fields.Channel" } }, "type": "object" } ], "permission": "ReadData", "returns": { "properties": { "channelgroupdetails": { "$ref": "PVR.Details.ChannelGroup.Extended" } }, "type": "object" }, "type": "method" } |
PVR.GetChannelGroups
Retrieves the channel groups for the specified type
Permissions:
- ReadData
Parameters:
- PVR.Channel.Type channeltype
- [List.Limits limits]
Returns:
Type: object
Properties:
- array[ PVR.Details.ChannelGroup ] channelgroups
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Retrieves the channel groups for the specified type", "params": [ { "$ref": "PVR.Channel.Type", "name": "channeltype", "required": true }, { "$ref": "List.Limits", "name": "limits" } ], "permission": "ReadData", "returns": { "properties": { "channelgroups": { "items": { "$ref": "PVR.Details.ChannelGroup" }, "required": true, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
PVR.GetChannels
Retrieves the channel list
Permissions:
- ReadData
Parameters:
- PVR.ChannelGroup.Id channelgroupid
- [PVR.Fields.Channel properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- array[ PVR.Details.Channel ] channels
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Retrieves the channel list", "params": [ { "$ref": "PVR.ChannelGroup.Id", "name": "channelgroupid", "required": true }, { "$ref": "PVR.Fields.Channel", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "channels": { "items": { "$ref": "PVR.Details.Channel" }, "required": true, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
PVR.GetClients
Retrieves the enabled PVR clients and their capabilities
Permissions:
- ReadData
Parameters:
- [List.Limits limits]
Returns:
Type: object
Properties:
- array[ PVR.Details.Client ] clients
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Retrieves the enabled PVR clients and their capabilities", "params": [ { "$ref": "List.Limits", "name": "limits" } ], "permission": "ReadData", "returns": { "properties": { "clients": { "items": { "$ref": "PVR.Details.Client" }, "required": true, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
PVR.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- array[ PVR.Property.Name ] properties
Returns:
Type: PVR.Property.Value
JSON Schema Description |
---|
{ "description": "Retrieves the values of the given properties", "params": [ { "items": { "$ref": "PVR.Property.Name" }, "name": "properties", "required": true, "type": "array", "uniqueItems": true } ], "permission": "ReadData", "returns": { "$ref": "PVR.Property.Value" }, "type": "method" } |
PVR.GetRecordingDetails
Retrieves the details of a specific recording
Permissions:
- ReadData
Parameters:
- Library.Id recordingid
- [PVR.Fields.Recording properties]
Returns:
Type: object
Properties:
- [PVR.Details.Recording recordingdetails]
JSON Schema Description |
---|
{ "description": "Retrieves the details of a specific recording", "params": [ { "$ref": "Library.Id", "name": "recordingid", "required": true }, { "$ref": "PVR.Fields.Recording", "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "recordingdetails": { "$ref": "PVR.Details.Recording" } }, "type": "object" }, "type": "method" } |
PVR.GetRecordings
Retrieves the recordings
Permissions:
- ReadData
Parameters:
- [PVR.Fields.Recording properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- array[ PVR.Details.Recording ] recordings
JSON Schema Description |
---|
{ "description": "Retrieves the recordings", "params": [ { "$ref": "PVR.Fields.Recording", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "recordings": { "items": { "$ref": "PVR.Details.Recording" }, "required": true, "type": "array" } }, "type": "object" }, "type": "method" } |
PVR.GetTimerDetails
Retrieves the details of a specific timer
Permissions:
- ReadData
Parameters:
- Library.Id timerid
- [PVR.Fields.Timer properties]
Returns:
Type: object
Properties:
- [PVR.Details.Timer timerdetails]
JSON Schema Description |
---|
{ "description": "Retrieves the details of a specific timer", "params": [ { "$ref": "Library.Id", "name": "timerid", "required": true }, { "$ref": "PVR.Fields.Timer", "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "timerdetails": { "$ref": "PVR.Details.Timer" } }, "type": "object" }, "type": "method" } |
PVR.GetTimers
Retrieves the timers
Permissions:
- ReadData
Parameters:
- [PVR.Fields.Timer properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- array[ PVR.Details.Timer ] timers
JSON Schema Description |
---|
{ "description": "Retrieves the timers", "params": [ { "$ref": "PVR.Fields.Timer", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "timers": { "items": { "$ref": "PVR.Details.Timer" }, "required": true, "type": "array" } }, "type": "object" }, "type": "method" } |
PVR.Record
Toggle recording of a channel
Permissions:
- ControlPVR
Parameters:
- [Global.Toggle record = toggle]
- [mixed: string|Library.Id channel = current]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Toggle recording of a channel", "params": [ { "$ref": "Global.Toggle", "default": "toggle", "name": "record" }, { "default": "current", "name": "channel", "type": [ { "enums": [ "current" ], "type": "string" }, { "$ref": "Library.Id" } ] } ], "permission": "ControlPVR", "returns": { "type": "string" }, "type": "method" } |
PVR.Scan
Starts a channel scan
Permissions:
- ControlPVR
Parameters:
- [Library.Id clientid = -1] (Specify a PVR client id to avoid UI dialog, optional in kodi 19, required in kodi 20)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Starts a channel scan", "params": [ { "$ref": "Library.Id", "default": -1, "description": "Specify a PVR client id to avoid UI dialog, optional in kodi 19, required in kodi 20", "name": "clientid" } ], "permission": "ControlPVR", "returns": { "type": "string" }, "type": "method" } |
PVR.ToggleTimer
Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created
Permissions:
- ControlPVR
Parameters:
- Library.Id broadcastid (the broadcast id of the item to toggle a onetime timer or time rule for)
- [boolean timerrule = False] (controls whether to create / delete a timer rule or a onetime timer)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created", "params": [ { "$ref": "Library.Id", "description": "the broadcast id of the item to toggle a onetime timer or time rule for", "name": "broadcastid", "required": true }, { "default": false, "description": "controls whether to create / delete a timer rule or a onetime timer", "name": "timerrule", "type": "boolean" } ], "permission": "ControlPVR", "returns": { "type": "string" }, "type": "method" } |
Player
Player.AddSubtitle
Add subtitle to the player
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- string subtitle (Local path or remote URL to the subtitle file to load)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Add subtitle to the player", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "description": "Local path or remote URL to the subtitle file to load", "name": "subtitle", "required": true, "type": "string" } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Player.GetActivePlayers
Returns all active players
Permissions:
- ReadData
Returns:
Type: array
JSON Schema Description |
---|
{ "description": "Returns all active players", "params": [], "permission": "ReadData", "returns": { "items": { "properties": { "playerid": { "$ref": "Player.Id", "required": true }, "playertype": { "enums": [ "internal", "external", "remote" ], "required": true, "type": "string" }, "type": { "$ref": "Player.Type", "required": true } }, "type": "object" }, "type": "array", "uniqueItems": true }, "type": "method" } |
Player.GetItem
Retrieves the currently played item
Permissions:
- ReadData
Parameters:
- Player.Id playerid
- [List.Fields.All properties]
Returns:
Type: object
Properties:
- List.Item.All item
JSON Schema Description |
---|
{ "description": "Retrieves the currently played item", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "$ref": "List.Fields.All", "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "item": { "$ref": "List.Item.All", "required": true } }, "type": "object" }, "type": "method" } |
Player.GetPlayers
Get a list of available players
Permissions:
- ReadData
Parameters:
- [string media = all]
Returns:
Type: array
JSON Schema Description |
---|
{ "description": "Get a list of available players", "params": [ { "default": "all", "enums": [ "all", "video", "audio" ], "name": "media", "type": "string" } ], "permission": "ReadData", "returns": { "items": { "properties": { "name": { "$ref": "Global.String.NotEmpty", "required": true }, "playsaudio": { "required": true, "type": "boolean" }, "playsvideo": { "required": true, "type": "boolean" }, "type": { "enums": [ "internal", "external", "remote" ], "required": true, "type": "string" } }, "type": "object" }, "type": "array", "uniqueItems": true }, "type": "method" } |
Player.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- Player.Id playerid
- array[ Player.Property.Name ] properties
Returns:
Type: Player.Property.Value
JSON Schema Description |
---|
{ "description": "Retrieves the values of the given properties", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "items": { "$ref": "Player.Property.Name" }, "name": "properties", "required": true, "type": "array", "uniqueItems": true } ], "permission": "ReadData", "returns": { "$ref": "Player.Property.Value" }, "type": "method" } |
Player.GetViewMode
Get view mode of video player
Permissions:
- ReadData
Returns:
Type: object
Properties:
- boolean nonlinearstretch
- number pixelratio
- number verticalshift
- Player.ViewMode viewmode
- number zoom
JSON Schema Description |
---|
{ "description": "Get view mode of video player", "params": [], "permission": "ReadData", "returns": { "properties": { "nonlinearstretch": { "required": true, "type": "boolean" }, "pixelratio": { "required": true, "type": "number" }, "verticalshift": { "required": true, "type": "number" }, "viewmode": { "$ref": "Player.ViewMode", "required": true }, "zoom": { "required": true, "type": "number" } }, "type": "object" }, "type": "method" } |
Player.GoTo
Go to previous/next/specific item in the playlist
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed: string|Playlist.Position to
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Go to previous/next/specific item in the playlist", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "name": "to", "required": true, "type": [ { "enums": [ "previous", "next" ], "type": "string" }, { "$ref": "Playlist.Position", "description": "position in playlist" } ] } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Player.Move
If picture is zoomed move viewport left/right/up/down otherwise skip previous/next
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- string direction
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "If picture is zoomed move viewport left/right/up/down otherwise skip previous/next", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "enums": [ "left", "right", "up", "down" ], "name": "direction", "required": true, "type": "string" } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Player.Open
Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.
Permissions:
- ControlPlayback
Parameters:
- [mixed: object|Playlist.Item|object|object|object|object|object item]
- [object options]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.", "params": [ { "name": "item", "type": [ { "additionalProperties": false, "properties": { "playlistid": { "$ref": "Playlist.Id", "required": true }, "position": { "$ref": "Playlist.Position", "default": 0 } }, "type": "object" }, { "$ref": "Playlist.Item" }, { "additionalProperties": false, "properties": { "path": { "required": true, "type": "string" }, "random": { "default": true, "description": "Deprecated, use the shuffled property of the options parameter instead", "type": "boolean" }, "recursive": { "default": true, "type": "boolean" } }, "type": "object" }, { "additionalProperties": false, "properties": { "partymode": { "default": "", "type": [ { "enums": [ "music", "video" ], "type": "string" }, { "description": "Path to a smartplaylist (*.xsp) file", "minLength": 5, "type": "string" } ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "broadcastid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "channelid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "recordingid": { "$ref": "Library.Id", "required": true } }, "type": "object" } ] }, { "additionalProperties": false, "name": "options", "properties": { "playername": { "default": null, "type": [ { "type": "null" }, { "enums": [ "default" ], "type": "string" }, { "description": "name of player", "minLength": 1, "type": "string" } ] }, "repeat": { "default": null, "type": [ { "type": "null" }, { "$ref": "Player.Repeat" } ] }, "resume": { "default": false, "type": [ { "description": "Whether to resume from the resume point or not", "type": "boolean" }, { "$ref": "Player.Position.Percentage", "description": "Percentage value to start from" }, { "$ref": "Player.Position.Time", "description": "Time to start from" } ] }, "shuffled": { "$ref": "Optional.Boolean", "default": null } }, "type": "object" } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Player.PlayPause
Pauses or unpause playback and returns the new state
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- [Global.Toggle play = toggle]
Returns:
Type: Player.Speed
JSON Schema Description |
---|
{ "description": "Pauses or unpause playback and returns the new state", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "$ref": "Global.Toggle", "default": "toggle", "name": "play" } ], "permission": "ControlPlayback", "returns": { "$ref": "Player.Speed" }, "type": "method" } |
Player.Rotate
Rotates current picture
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- [string value = clockwise]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Rotates current picture", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "default": "clockwise", "enums": [ "clockwise", "counterclockwise" ], "name": "value", "type": "string" } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Player.Seek
Seek through the playing item
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed: object|object|object|object value
Returns:
Type: object
Properties:
- [Player.Position.Percentage percentage]
- [Global.Time time] (A duration.)
- [Global.Time totaltime] (A duration.)
JSON Schema Description |
---|
{ "description": "Seek through the playing item", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "name": "value", "required": true, "type": [ { "additionalProperties": false, "properties": { "percentage": { "$ref": "Player.Position.Percentage", "description": "Percentage value to seek to", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "time": { "$ref": "Player.Position.Time", "description": "Time to seek to", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "step": { "description": "Seek by predefined jumps", "enums": [ "smallforward", "smallbackward", "bigforward", "bigbackward" ], "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "seconds": { "description": "Seek by the given number of seconds", "required": true, "type": "integer" } }, "type": "object" } ] } ], "permission": "ControlPlayback", "returns": { "properties": { "percentage": { "$ref": "Player.Position.Percentage", "default": 0.0 }, "time": { "$ref": "Global.Time", "description": "A duration." }, "totaltime": { "$ref": "Global.Time", "description": "A duration." } }, "type": "object" }, "type": "method" } |
Player.SetAudioStream
Set the audio stream played by the player
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed: string|integer stream
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Set the audio stream played by the player", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "name": "stream", "required": true, "type": [ { "enums": [ "previous", "next" ], "type": "string" }, { "description": "Index of the audio stream to play", "minimum": 0, "type": "integer" } ] } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Player.SetPartymode
Turn partymode on or off
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- Global.Toggle partymode
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Turn partymode on or off", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "$ref": "Global.Toggle", "name": "partymode", "required": true } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Player.SetRepeat
Set the repeat mode of the player
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed: Player.Repeat|string repeat
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Set the repeat mode of the player", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "name": "repeat", "required": true, "type": [ { "$ref": "Player.Repeat" }, { "enums": [ "cycle" ], "type": "string" } ] } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Player.SetShuffle
Shuffle/Unshuffle items in the player
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- Global.Toggle shuffle
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Shuffle/Unshuffle items in the player", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "$ref": "Global.Toggle", "name": "shuffle", "required": true } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Player.SetSpeed
Set the speed of the current playback
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed: integer|Global.IncrementDecrement speed
Returns:
Type: Player.Speed
JSON Schema Description |
---|
{ "description": "Set the speed of the current playback", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "name": "speed", "required": true, "type": [ { "enums": [ -32, -16, -8, -4, -2, -1, 0, 1, 2, 4, 8, 16, 32 ], "type": "integer" }, { "$ref": "Global.IncrementDecrement" } ] } ], "permission": "ControlPlayback", "returns": { "$ref": "Player.Speed" }, "type": "method" } |
Player.SetSubtitle
Set the subtitle displayed by the player
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed: string|integer subtitle
- [boolean enable = False] (Whether to enable subtitles to be displayed after setting the new subtitle)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Set the subtitle displayed by the player", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "name": "subtitle", "required": true, "type": [ { "enums": [ "previous", "next", "off", "on" ], "type": "string" }, { "description": "Index of the subtitle to display", "minimum": 0, "type": "integer" } ] }, { "default": false, "description": "Whether to enable subtitles to be displayed after setting the new subtitle", "name": "enable", "type": "boolean" } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Player.SetVideoStream
Set the video stream played by the player
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed: string|integer stream
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Set the video stream played by the player", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "name": "stream", "required": true, "type": [ { "enums": [ "previous", "next" ], "type": "string" }, { "description": "Index of the video stream to play", "minimum": 0, "type": "integer" } ] } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Player.SetViewMode
Set view mode of video player
Permissions:
- ControlPlayback
Parameters:
- mixed: Player.CustomViewMode|Player.ViewMode viewmode
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Set view mode of video player", "params": [ { "name": "viewmode", "required": true, "type": [ { "$ref": "Player.CustomViewMode", "description": "Custom view mode" }, { "$ref": "Player.ViewMode" } ] } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Player.Stop
Stops playback
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Stops playback", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Player.Zoom
Zoom current picture
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed: string|integer zoom
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Zoom current picture", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "name": "zoom", "required": true, "type": [ { "enums": [ "in", "out" ], "type": "string" }, { "description": "zoom level", "maximum": 10, "minimum": 1, "type": "integer" } ] } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Playlist
Playlist.Add
Add item(s) to playlist
Permissions:
- ControlPlayback
Parameters:
- Playlist.Id playlistid
- mixed: Playlist.Item|array item
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Add item(s) to playlist", "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "name": "item", "required": true, "type": [ { "$ref": "Playlist.Item" }, { "items": { "$ref": "Playlist.Item" }, "type": "array" } ] } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Playlist.Clear
Clear playlist
Permissions:
- ControlPlayback
Parameters:
- Playlist.Id playlistid
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Clear playlist", "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Playlist.GetItems
Get all items from playlist
Permissions:
- ReadData
Parameters:
- Playlist.Id playlistid
- [List.Fields.All properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- array[ List.Item.All ] items
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Get all items from playlist", "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "$ref": "List.Fields.All", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "items": { "items": { "$ref": "List.Item.All" }, "required": true, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
Playlist.GetPlaylists
Returns all existing playlists
Permissions:
- ReadData
Returns:
Type: array
JSON Schema Description |
---|
{ "description": "Returns all existing playlists", "params": [], "permission": "ReadData", "returns": { "items": { "properties": { "playlistid": { "$ref": "Playlist.Id", "required": true }, "type": { "$ref": "Playlist.Type", "required": true } }, "type": "object" }, "type": "array", "uniqueItems": true }, "type": "method" } |
Playlist.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- Playlist.Id playlistid
- array[ Playlist.Property.Name ] properties
Returns:
Type: Playlist.Property.Value
JSON Schema Description |
---|
{ "description": "Retrieves the values of the given properties", "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "items": { "$ref": "Playlist.Property.Name" }, "name": "properties", "required": true, "type": "array", "uniqueItems": true } ], "permission": "ReadData", "returns": { "$ref": "Playlist.Property.Value" }, "type": "method" } |
Playlist.Insert
Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).
Permissions:
- ControlPlayback
Parameters:
- Playlist.Id playlistid
- Playlist.Position position
- mixed: Playlist.Item|array item
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).", "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "$ref": "Playlist.Position", "name": "position", "required": true }, { "name": "item", "required": true, "type": [ { "$ref": "Playlist.Item" }, { "items": { "$ref": "Playlist.Item" }, "type": "array" } ] } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Playlist.Remove
Remove item from playlist. Does not work for picture playlists (aka slideshows).
Permissions:
- ControlPlayback
Parameters:
- Playlist.Id playlistid
- Playlist.Position position
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Remove item from playlist. Does not work for picture playlists (aka slideshows).", "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "$ref": "Playlist.Position", "name": "position", "required": true } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Playlist.Swap
Swap items in the playlist. Does not work for picture playlists (aka slideshows).
Permissions:
- ControlPlayback
Parameters:
- Playlist.Id playlistid
- Playlist.Position position1
- Playlist.Position position2
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Swap items in the playlist. Does not work for picture playlists (aka slideshows).", "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "$ref": "Playlist.Position", "name": "position1", "required": true }, { "$ref": "Playlist.Position", "name": "position2", "required": true } ], "permission": "ControlPlayback", "returns": { "type": "string" }, "type": "method" } |
Profiles
Profiles.GetCurrentProfile
Retrieve the current profile
Permissions:
- ReadData
Parameters:
- [Profiles.Fields.Profile properties]
Returns:
Type: Profiles.Details.Profile
JSON Schema Description |
---|
{ "description": "Retrieve the current profile", "params": [ { "$ref": "Profiles.Fields.Profile", "name": "properties" } ], "permission": "ReadData", "returns": { "$ref": "Profiles.Details.Profile" }, "type": "method" } |
Profiles.GetProfiles
Retrieve all profiles
Permissions:
- ReadData
Parameters:
- [Profiles.Fields.Profile properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- array[ Profiles.Details.Profile ] profiles
JSON Schema Description |
---|
{ "description": "Retrieve all profiles", "params": [ { "$ref": "Profiles.Fields.Profile", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "profiles": { "items": { "$ref": "Profiles.Details.Profile" }, "required": true, "type": "array" } }, "type": "object" }, "type": "method" } |
Profiles.LoadProfile
Load the specified profile
Permissions:
- Navigate
Parameters:
- string profile (Profile name)
- [boolean prompt = False] (Prompt for password)
- [Profiles.Password password]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Load the specified profile", "params": [ { "description": "Profile name", "name": "profile", "required": true, "type": "string" }, { "default": false, "description": "Prompt for password", "name": "prompt", "type": "boolean" }, { "$ref": "Profiles.Password", "name": "password" } ], "permission": "Navigate", "returns": { "type": "string" }, "type": "method" } |
Settings
Settings.GetCategories
Retrieves all setting categories
Permissions:
- ReadData
Parameters:
- [Setting.Level level = standard]
- [string section = ""]
- [string properties]
Returns:
Type: object
Properties:
- [array[ Setting.Details.Category ] categories]
JSON Schema Description |
---|
{ "description": "Retrieves all setting categories", "params": [ { "$ref": "Setting.Level", "default": "standard", "name": "level" }, { "default": "", "name": "section", "type": "string" }, { "extends": "Item.Fields.Base", "items": { "enums": [ "settings" ], "type": "string" }, "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "categories": { "items": { "$ref": "Setting.Details.Category" }, "type": "array" } }, "type": "object" }, "type": "method" } |
Settings.GetSections
Retrieves all setting sections
Permissions:
- ReadData
Parameters:
- [Setting.Level level = standard]
- [Setting.Level properties]
Returns:
Type: object
Properties:
- [array[ Setting.Details.Section ] sections]
JSON Schema Description |
---|
{ "description": "Retrieves all setting sections", "params": [ { "$ref": "Setting.Level", "default": "standard", "name": "level" }, { "extends": "Item.Fields.Base", "items": { "enums": [ "categories" ], "type": "string" }, "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "sections": { "items": { "$ref": "Setting.Details.Section" }, "type": "array" } }, "type": "object" }, "type": "method" } |
Settings.GetSettingValue
Retrieves the value of a setting
Permissions:
- ReadData
Parameters:
- string setting
Returns:
Type: object
Properties:
- Setting.Value.Extended value
JSON Schema Description |
---|
{ "description": "Retrieves the value of a setting", "params": [ { "minLength": 1, "name": "setting", "required": true, "type": "string" } ], "permission": "ReadData", "returns": { "properties": { "value": { "$ref": "Setting.Value.Extended", "required": true } }, "type": "object" }, "type": "method" } |
Settings.GetSettings
Retrieves all settings
Permissions:
- ReadData
Parameters:
- [Setting.Level level = standard]
- [mixed: object filter]
Returns:
Type: object
Properties:
- [array[ Setting.Details.Setting ] settings]
JSON Schema Description |
---|
{ "description": "Retrieves all settings", "params": [ { "$ref": "Setting.Level", "default": "standard", "name": "level" }, { "name": "filter", "type": [ { "additionalProperties": false, "properties": { "category": { "minLength": 1, "required": true, "type": "string" }, "section": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" } ] } ], "permission": "ReadData", "returns": { "properties": { "settings": { "items": { "$ref": "Setting.Details.Setting" }, "type": "array" } }, "type": "object" }, "type": "method" } |
Settings.ResetSettingValue
Resets the value of a setting
Permissions:
- ReadData
Parameters:
- string setting
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Resets the value of a setting", "params": [ { "minLength": 1, "name": "setting", "required": true, "type": "string" } ], "permission": "ReadData", "returns": { "type": "string" }, "type": "method" } |
Settings.SetSettingValue
Changes the value of a setting
Permissions:
- ReadData
Parameters:
- string setting
- Setting.Value.Extended value
Returns:
Type: boolean
JSON Schema Description |
---|
{ "description": "Changes the value of a setting", "params": [ { "minLength": 1, "name": "setting", "required": true, "type": "string" }, { "$ref": "Setting.Value.Extended", "name": "value", "required": true } ], "permission": "ReadData", "returns": { "type": "boolean" }, "type": "method" } |
System
System.EjectOpticalDrive
Ejects or closes the optical disc drive (if available)
Permissions:
- ControlSystem
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Ejects or closes the optical disc drive (if available)", "params": [], "permission": "ControlSystem", "returns": { "type": "string" }, "type": "method" } |
System.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- array[ System.Property.Name ] properties
Returns:
Type: System.Property.Value
JSON Schema Description |
---|
{ "description": "Retrieves the values of the given properties", "params": [ { "items": { "$ref": "System.Property.Name" }, "name": "properties", "required": true, "type": "array", "uniqueItems": true } ], "permission": "ReadData", "returns": { "$ref": "System.Property.Value" }, "type": "method" } |
System.Hibernate
Puts the system running Kodi into hibernate mode
Permissions:
- ControlPower
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Puts the system running Kodi into hibernate mode", "params": [], "permission": "ControlPower", "returns": { "type": "string" }, "type": "method" } |
System.Reboot
Reboots the system running Kodi
Permissions:
- ControlPower
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Reboots the system running Kodi", "params": [], "permission": "ControlPower", "returns": { "type": "string" }, "type": "method" } |
System.Shutdown
Shuts the system running Kodi down
Permissions:
- ControlPower
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Shuts the system running Kodi down", "params": [], "permission": "ControlPower", "returns": { "type": "string" }, "type": "method" } |
System.Suspend
Suspends the system running Kodi
Permissions:
- ControlPower
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Suspends the system running Kodi", "params": [], "permission": "ControlPower", "returns": { "type": "string" }, "type": "method" } |
Textures
Textures.GetTextures
Retrieve all textures
Permissions:
- ReadData
Parameters:
- [Textures.Fields.Texture properties]
- [List.Filter.Textures filter]
Returns:
Type: object
Properties:
- array[ Textures.Details.Texture ] textures
JSON Schema Description |
---|
{ "description": "Retrieve all textures", "params": [ { "$ref": "Textures.Fields.Texture", "name": "properties" }, { "$ref": "List.Filter.Textures", "name": "filter" } ], "permission": "ReadData", "returns": { "properties": { "textures": { "items": { "$ref": "Textures.Details.Texture" }, "required": true, "type": "array" } }, "type": "object" }, "type": "method" } |
Textures.RemoveTexture
Remove the specified texture
Permissions:
- RemoveData
Parameters:
- Library.Id textureid (Texture database identifier)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Remove the specified texture", "params": [ { "$ref": "Library.Id", "description": "Texture database identifier", "name": "textureid", "required": true } ], "permission": "RemoveData", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary
VideoLibrary.Clean
Cleans the video library for non-existent items
Permissions:
- RemoveData
Parameters:
- [boolean showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)
- [string content = video] (Content type to clean for)
- [string directory = ""] (Path to the directory to clean up; performs a global cleanup if not specified)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Cleans the video library for non-existent items", "params": [ { "default": true, "description": "Whether or not to show the progress bar or any other GUI dialog", "name": "showdialogs", "type": "boolean" }, { "default": "video", "description": "Content type to clean for", "enums": [ "video", "movies", "tvshows", "musicvideos" ], "name": "content", "type": "string" }, { "default": "", "description": "Path to the directory to clean up; performs a global cleanup if not specified", "name": "directory", "type": "string" } ], "permission": "RemoveData", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary.Export
Exports all items from the video library
Permissions:
- WriteFile
Parameters:
- [mixed: object|object options]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Exports all items from the video library", "params": [ { "name": "options", "type": [ { "additionalProperties": false, "properties": { "path": { "description": "Path to the directory to where the data should be exported", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "actorthumbs": { "default": false, "description": "Whether to export actor thumbnails", "type": "boolean" }, "images": { "default": false, "description": "Whether to export thumbnails and fanart images", "type": "boolean" }, "overwrite": { "default": false, "description": "Whether to overwrite existing exported files", "type": "boolean" } }, "type": "object" } ] } ], "permission": "WriteFile", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary.GetAvailableArt
Retrieve all potential art URLs for a media item by art type
Permissions:
- ReadData
Parameters:
- mixed: object|object|object|object|object|object item
- [string arttype = ""]
Returns:
Type: object
Properties:
- array availableart
JSON Schema Description |
---|
{ "description": "Retrieve all potential art URLs for a media item by art type", "params": [ { "name": "item", "required": true, "type": [ { "additionalProperties": false, "properties": { "episodeid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "tvshowid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "seasonid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "movieid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "setid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "musicvideoid": { "$ref": "Library.Id", "required": true } }, "type": "object" } ] }, { "default": "", "name": "arttype", "type": "string" } ], "permission": "ReadData", "returns": { "properties": { "availableart": { "items": { "properties": { "arttype": { "required": true, "type": "string" }, "previewurl": { "default": "", "description": "URL to a preview thumbnail of the image", "type": "string" }, "url": { "description": "URL to the original image", "required": true, "type": "string" } }, "type": "object" }, "required": true, "type": "array" } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetAvailableArtTypes
Retrieve a list of potential art types for a media item
Permissions:
- ReadData
Parameters:
- mixed: object|object|object|object|object|object item
Returns:
Type: object
Properties:
- array availablearttypes
JSON Schema Description |
---|
{ "description": "Retrieve a list of potential art types for a media item", "params": [ { "name": "item", "required": true, "type": [ { "additionalProperties": false, "properties": { "episodeid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "tvshowid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "seasonid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "movieid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "setid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "musicvideoid": { "$ref": "Library.Id", "required": true } }, "type": "object" } ] } ], "permission": "ReadData", "returns": { "properties": { "availablearttypes": { "items": { "type": "string" }, "required": true, "type": "array" } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetEpisodeDetails
Retrieve details about a specific tv show episode
Permissions:
- ReadData
Parameters:
- Library.Id episodeid
- [Video.Fields.Episode properties]
Returns:
Type: object
Properties:
- [Video.Details.Episode episodedetails]
JSON Schema Description |
---|
{ "description": "Retrieve details about a specific tv show episode", "params": [ { "$ref": "Library.Id", "name": "episodeid", "required": true }, { "$ref": "Video.Fields.Episode", "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "episodedetails": { "$ref": "Video.Details.Episode" } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetEpisodes
Retrieve all tv show episodes
Permissions:
- ReadData
Parameters:
- [Library.Id tvshowid = -1]
- [integer season = -1]
- [Video.Fields.Episode properties]
- [List.Limits limits]
- [List.Sort sort]
- [mixed: object|object|object|object|object|List.Filter.Episodes filter]
Returns:
Type: object
Properties:
- [array[ Video.Details.Episode ] episodes]
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Retrieve all tv show episodes", "params": [ { "$ref": "Library.Id", "default": -1, "name": "tvshowid" }, { "default": -1, "minimum": 0, "name": "season", "type": "integer" }, { "$ref": "Video.Fields.Episode", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "name": "filter", "type": [ { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "description": "Requires tvshowid to be set", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "description": "Requires tvshowid to be set", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "year": { "minimum": 0, "required": true, "type": "integer" } }, "type": "object" }, { "additionalProperties": false, "properties": { "actor": { "description": "Requires tvshowid to be set", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "director": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "$ref": "List.Filter.Episodes" } ] } ], "permission": "ReadData", "returns": { "properties": { "episodes": { "items": { "$ref": "Video.Details.Episode" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetGenres
Retrieve all genres
Permissions:
- ReadData
Parameters:
- string type
- [Library.Fields.Genre properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- array[ Library.Details.Genre ] genres
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Retrieve all genres", "params": [ { "enums": [ "movie", "tvshow", "musicvideo" ], "name": "type", "required": true, "type": "string" }, { "$ref": "Library.Fields.Genre", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "genres": { "items": { "$ref": "Library.Details.Genre" }, "required": true, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetInProgressTVShows
Retrieve all in progress tvshows
Permissions:
- ReadData
Parameters:
- [Video.Fields.TVShow properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [array[ Video.Details.TVShow ] tvshows]
JSON Schema Description |
---|
{ "description": "Retrieve all in progress tvshows", "params": [ { "$ref": "Video.Fields.TVShow", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "tvshows": { "items": { "$ref": "Video.Details.TVShow" }, "type": "array" } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetMovieDetails
Retrieve details about a specific movie
Permissions:
- ReadData
Parameters:
- Library.Id movieid
- [Video.Fields.Movie properties]
Returns:
Type: object
Properties:
- [Video.Details.Movie moviedetails]
JSON Schema Description |
---|
{ "description": "Retrieve details about a specific movie", "params": [ { "$ref": "Library.Id", "name": "movieid", "required": true }, { "$ref": "Video.Fields.Movie", "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "moviedetails": { "$ref": "Video.Details.Movie" } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetMovieSetDetails
Retrieve details about a specific movie set
Permissions:
- ReadData
Parameters:
- Library.Id setid
- [Video.Fields.MovieSet properties]
- [object movies]
Returns:
Type: object
Properties:
- [Video.Details.MovieSet.Extended setdetails]
JSON Schema Description |
---|
{ "description": "Retrieve details about a specific movie set", "params": [ { "$ref": "Library.Id", "name": "setid", "required": true }, { "$ref": "Video.Fields.MovieSet", "name": "properties" }, { "name": "movies", "properties": { "limits": { "$ref": "List.Limits" }, "properties": { "$ref": "Video.Fields.Movie" }, "sort": { "$ref": "List.Sort" } }, "type": "object" } ], "permission": "ReadData", "returns": { "properties": { "setdetails": { "$ref": "Video.Details.MovieSet.Extended" } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetMovieSets
Retrieve all movie sets
Permissions:
- ReadData
Parameters:
- [Video.Fields.MovieSet properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [array[ Video.Details.MovieSet ] sets]
JSON Schema Description |
---|
{ "description": "Retrieve all movie sets", "params": [ { "$ref": "Video.Fields.MovieSet", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "sets": { "items": { "$ref": "Video.Details.MovieSet" }, "type": "array" } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetMovies
Retrieve all movies
Permissions:
- ReadData
Parameters:
- [Video.Fields.Movie properties]
- [List.Limits limits]
- [List.Sort sort]
- [mixed: object|object|object|object|object|object|object|object|object|object|List.Filter.Movies filter]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [array[ Video.Details.Movie ] movies]
JSON Schema Description |
---|
{ "description": "Retrieve all movies", "params": [ { "$ref": "Video.Fields.Movie", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "name": "filter", "type": [ { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "year": { "minimum": 0, "required": true, "type": "integer" } }, "type": "object" }, { "additionalProperties": false, "properties": { "actor": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "director": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "studio": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "country": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "setid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "set": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "tag": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "$ref": "List.Filter.Movies" } ] } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "movies": { "items": { "$ref": "Video.Details.Movie" }, "type": "array" } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetMusicVideoDetails
Retrieve details about a specific music video
Permissions:
- ReadData
Parameters:
- Library.Id musicvideoid
- [Video.Fields.MusicVideo properties]
Returns:
Type: object
Properties:
- [Video.Details.MusicVideo musicvideodetails]
JSON Schema Description |
---|
{ "description": "Retrieve details about a specific music video", "params": [ { "$ref": "Library.Id", "name": "musicvideoid", "required": true }, { "$ref": "Video.Fields.MusicVideo", "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "musicvideodetails": { "$ref": "Video.Details.MusicVideo" } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetMusicVideos
Retrieve all music videos
Permissions:
- ReadData
Parameters:
- [Video.Fields.MusicVideo properties]
- [List.Limits limits]
- [List.Sort sort]
- [mixed: object|object|object|object|object|object|object|List.Filter.MusicVideos filter]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [array[ Video.Details.MusicVideo ] musicvideos]
JSON Schema Description |
---|
{ "description": "Retrieve all music videos", "params": [ { "$ref": "Video.Fields.MusicVideo", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "name": "filter", "type": [ { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "year": { "minimum": 0, "required": true, "type": "integer" } }, "type": "object" }, { "additionalProperties": false, "properties": { "director": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "studio": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "tag": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "$ref": "List.Filter.MusicVideos" } ] } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "musicvideos": { "items": { "$ref": "Video.Details.MusicVideo" }, "type": "array" } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetRecentlyAddedEpisodes
Retrieve all recently added tv episodes
Permissions:
- ReadData
Parameters:
- [Video.Fields.Episode properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- [array[ Video.Details.Episode ] episodes]
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "description": "Retrieve all recently added tv episodes", "params": [ { "$ref": "Video.Fields.Episode", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "episodes": { "items": { "$ref": "Video.Details.Episode" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetRecentlyAddedMovies
Retrieve all recently added movies
Permissions:
- ReadData
Parameters:
- [Video.Fields.Movie properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [array[ Video.Details.Movie ] movies]
JSON Schema Description |
---|
{ "description": "Retrieve all recently added movies", "params": [ { "$ref": "Video.Fields.Movie", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "movies": { "items": { "$ref": "Video.Details.Movie" }, "type": "array" } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetRecentlyAddedMusicVideos
Retrieve all recently added music videos
Permissions:
- ReadData
Parameters:
- [Video.Fields.MusicVideo properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [array[ Video.Details.MusicVideo ] musicvideos]
JSON Schema Description |
---|
{ "description": "Retrieve all recently added music videos", "params": [ { "$ref": "Video.Fields.MusicVideo", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "musicvideos": { "items": { "$ref": "Video.Details.MusicVideo" }, "type": "array" } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetSeasonDetails
Retrieve details about a specific tv show season
Permissions:
- ReadData
Parameters:
- Library.Id seasonid
- [Video.Fields.Season properties]
Returns:
Type: object
Properties:
- [Video.Details.Season seasondetails]
JSON Schema Description |
---|
{ "description": "Retrieve details about a specific tv show season", "params": [ { "$ref": "Library.Id", "name": "seasonid", "required": true }, { "$ref": "Video.Fields.Season", "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "seasondetails": { "$ref": "Video.Details.Season" } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetSeasons
Retrieve all tv seasons
Permissions:
- ReadData
Parameters:
- [Library.Id tvshowid = -1]
- [Video.Fields.Season properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [array[ Video.Details.Season ] seasons]
JSON Schema Description |
---|
{ "description": "Retrieve all tv seasons", "params": [ { "$ref": "Library.Id", "default": -1, "name": "tvshowid" }, { "$ref": "Video.Fields.Season", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "seasons": { "items": { "$ref": "Video.Details.Season" }, "type": "array" } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetTVShowDetails
Retrieve details about a specific tv show
Permissions:
- ReadData
Parameters:
- Library.Id tvshowid
- [Video.Fields.TVShow properties]
Returns:
Type: object
Properties:
- [Video.Details.TVShow tvshowdetails]
JSON Schema Description |
---|
{ "description": "Retrieve details about a specific tv show", "params": [ { "$ref": "Library.Id", "name": "tvshowid", "required": true }, { "$ref": "Video.Fields.TVShow", "name": "properties" } ], "permission": "ReadData", "returns": { "properties": { "tvshowdetails": { "$ref": "Video.Details.TVShow" } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetTVShows
Retrieve all tv shows
Permissions:
- ReadData
Parameters:
- [Video.Fields.TVShow properties]
- [List.Limits limits]
- [List.Sort sort]
- [mixed: object|object|object|object|object|object|List.Filter.TVShows filter]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [array[ Video.Details.TVShow ] tvshows]
JSON Schema Description |
---|
{ "description": "Retrieve all tv shows", "params": [ { "$ref": "Video.Fields.TVShow", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "name": "filter", "type": [ { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "year": { "minimum": 0, "required": true, "type": "integer" } }, "type": "object" }, { "additionalProperties": false, "properties": { "actor": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "studio": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "tag": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "$ref": "List.Filter.TVShows" } ] } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "tvshows": { "items": { "$ref": "Video.Details.TVShow" }, "type": "array" } }, "type": "object" }, "type": "method" } |
VideoLibrary.GetTags
Retrieve all tags
Permissions:
- ReadData
Parameters:
- string type
- [Library.Fields.Tag properties]
- [List.Limits limits]
- [List.Sort sort]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- array[ Library.Details.Tag ] tags
JSON Schema Description |
---|
{ "description": "Retrieve all tags", "params": [ { "enums": [ "movie", "tvshow", "musicvideo" ], "name": "type", "required": true, "type": "string" }, { "$ref": "Library.Fields.Tag", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" } ], "permission": "ReadData", "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "tags": { "items": { "$ref": "Library.Details.Tag" }, "required": true, "type": "array" } }, "type": "object" }, "type": "method" } |
VideoLibrary.RefreshEpisode
Refresh the given episode in the library
Permissions:
- UpdateData
Parameters:
- Library.Id episodeid
- [boolean ignorenfo = False] (Whether or not to ignore a local NFO if present.)
- [string title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Refresh the given episode in the library", "params": [ { "$ref": "Library.Id", "name": "episodeid", "required": true }, { "default": false, "description": "Whether or not to ignore a local NFO if present.", "name": "ignorenfo", "type": "boolean" }, { "default": "", "description": "Title to use for searching (instead of determining it from the item's filename/path).", "name": "title", "type": "string" } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary.RefreshMovie
Refresh the given movie in the library
Permissions:
- UpdateData
Parameters:
- Library.Id movieid
- [boolean ignorenfo = False] (Whether or not to ignore a local NFO if present.)
- [string title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Refresh the given movie in the library", "params": [ { "$ref": "Library.Id", "name": "movieid", "required": true }, { "default": false, "description": "Whether or not to ignore a local NFO if present.", "name": "ignorenfo", "type": "boolean" }, { "default": "", "description": "Title to use for searching (instead of determining it from the item's filename/path).", "name": "title", "type": "string" } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary.RefreshMusicVideo
Refresh the given music video in the library
Permissions:
- UpdateData
Parameters:
- Library.Id musicvideoid
- [boolean ignorenfo = False] (Whether or not to ignore a local NFO if present.)
- [string title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Refresh the given music video in the library", "params": [ { "$ref": "Library.Id", "name": "musicvideoid", "required": true }, { "default": false, "description": "Whether or not to ignore a local NFO if present.", "name": "ignorenfo", "type": "boolean" }, { "default": "", "description": "Title to use for searching (instead of determining it from the item's filename/path).", "name": "title", "type": "string" } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary.RefreshTVShow
Refresh the given tv show in the library
Permissions:
- UpdateData
Parameters:
- Library.Id tvshowid
- [boolean ignorenfo = False] (Whether or not to ignore a local NFO if present.)
- [boolean refreshepisodes = False] (Whether or not to refresh all episodes belonging to the TV show.)
- [string title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Refresh the given tv show in the library", "params": [ { "$ref": "Library.Id", "name": "tvshowid", "required": true }, { "default": false, "description": "Whether or not to ignore a local NFO if present.", "name": "ignorenfo", "type": "boolean" }, { "default": false, "description": "Whether or not to refresh all episodes belonging to the TV show.", "name": "refreshepisodes", "type": "boolean" }, { "default": "", "description": "Title to use for searching (instead of determining it from the item's filename/path).", "name": "title", "type": "string" } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary.RemoveEpisode
Removes the given episode from the library
Permissions:
- RemoveData
Parameters:
- Library.Id episodeid
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Removes the given episode from the library", "params": [ { "$ref": "Library.Id", "name": "episodeid", "required": true } ], "permission": "RemoveData", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary.RemoveMovie
Removes the given movie from the library
Permissions:
- RemoveData
Parameters:
- Library.Id movieid
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Removes the given movie from the library", "params": [ { "$ref": "Library.Id", "name": "movieid", "required": true } ], "permission": "RemoveData", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary.RemoveMusicVideo
Removes the given music video from the library
Permissions:
- RemoveData
Parameters:
- Library.Id musicvideoid
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Removes the given music video from the library", "params": [ { "$ref": "Library.Id", "name": "musicvideoid", "required": true } ], "permission": "RemoveData", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary.RemoveTVShow
Removes the given tv show from the library
Permissions:
- RemoveData
Parameters:
- Library.Id tvshowid
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Removes the given tv show from the library", "params": [ { "$ref": "Library.Id", "name": "tvshowid", "required": true } ], "permission": "RemoveData", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary.Scan
Scans the video sources for new library items
Permissions:
- UpdateData
Parameters:
- [string directory = ""]
- [boolean showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Scans the video sources for new library items", "params": [ { "default": "", "name": "directory", "type": "string" }, { "default": true, "description": "Whether or not to show the progress bar or any other GUI dialog", "name": "showdialogs", "type": "boolean" } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary.SetEpisodeDetails
Update the given episode with the given details
Permissions:
- UpdateData
Parameters:
- Library.Id episodeid
- [Optional.String title = None]
- [Optional.Integer playcount = None]
- [Optional.Integer runtime = None] (Runtime in seconds)
- [mixed: null|Array.String director = None]
- [Optional.String plot = None]
- [Optional.Number rating = None]
- [Optional.String votes = None]
- [Optional.String lastplayed = None]
- [mixed: null|Array.String writer = None]
- [Optional.String firstaired = None]
- [Optional.String productioncode = None]
- [Optional.Integer season = None]
- [Optional.Integer episode = None]
- [Optional.String originaltitle = None]
- [Optional.String thumbnail = None]
- [Optional.String fanart = None]
- [mixed: null|Media.Artwork.Set art = None]
- [mixed: null|Video.Resume resume = None]
- [Optional.Integer userrating = None]
- [Video.Ratings.Set ratings]
- [Optional.String dateadded = None]
- [mixed: null|Media.UniqueID.Set uniqueid = None]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Update the given episode with the given details", "params": [ { "$ref": "Library.Id", "name": "episodeid", "required": true }, { "$ref": "Optional.String", "default": null, "name": "title" }, { "$ref": "Optional.Integer", "default": null, "name": "playcount" }, { "$ref": "Optional.Integer", "default": null, "description": "Runtime in seconds", "name": "runtime" }, { "default": null, "name": "director", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "$ref": "Optional.String", "default": null, "name": "plot" }, { "$ref": "Optional.Number", "default": null, "name": "rating" }, { "$ref": "Optional.String", "default": null, "name": "votes" }, { "$ref": "Optional.String", "default": null, "name": "lastplayed" }, { "default": null, "name": "writer", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "$ref": "Optional.String", "default": null, "name": "firstaired" }, { "$ref": "Optional.String", "default": null, "name": "productioncode" }, { "$ref": "Optional.Integer", "default": null, "name": "season" }, { "$ref": "Optional.Integer", "default": null, "name": "episode" }, { "$ref": "Optional.String", "default": null, "name": "originaltitle" }, { "$ref": "Optional.String", "default": null, "name": "thumbnail" }, { "$ref": "Optional.String", "default": null, "name": "fanart" }, { "default": null, "name": "art", "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ] }, { "default": null, "name": "resume", "type": [ { "type": "null" }, { "$ref": "Video.Resume" } ] }, { "$ref": "Optional.Integer", "default": null, "name": "userrating" }, { "$ref": "Video.Ratings.Set", "name": "ratings" }, { "$ref": "Optional.String", "default": null, "name": "dateadded" }, { "default": null, "name": "uniqueid", "type": [ { "type": "null" }, { "$ref": "Media.UniqueID.Set" } ] } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary.SetMovieDetails
Update the given movie with the given details
Permissions:
- UpdateData
Parameters:
- Library.Id movieid
- [Optional.String title = None]
- [Optional.Integer playcount = None]
- [Optional.Integer runtime = None] (Runtime in seconds)
- [mixed: null|Array.String director = None]
- [mixed: null|Array.String studio = None]
- [Optional.Integer year = None] (linked with premiered. Overridden by premiered parameter)
- [Optional.String plot = None]
- [mixed: null|Array.String genre = None]
- [Optional.Number rating = None]
- [Optional.String mpaa = None]
- [Optional.String imdbnumber = None]
- [Optional.String votes = None]
- [Optional.String lastplayed = None]
- [Optional.String originaltitle = None]
- [Optional.String trailer = None]
- [Optional.String tagline = None]
- [Optional.String plotoutline = None]
- [mixed: null|Array.String writer = None]
- [mixed: null|Array.String country = None]
- [Optional.Integer top250 = None]
- [Optional.String sorttitle = None]
- [Optional.String set = None]
- [mixed: null|Array.String showlink = None]
- [Optional.String thumbnail = None]
- [Optional.String fanart = None]
- [mixed: null|Array.String tag = None]
- [mixed: null|Media.Artwork.Set art = None]
- [mixed: null|Video.Resume resume = None]
- [Optional.Integer userrating = None]
- [Video.Ratings.Set ratings]
- [Optional.String dateadded = None]
- [Optional.String premiered = None] (linked with year. Overrides year)
- [mixed: null|Media.UniqueID.Set uniqueid = None]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Update the given movie with the given details", "params": [ { "$ref": "Library.Id", "name": "movieid", "required": true }, { "$ref": "Optional.String", "default": null, "name": "title" }, { "$ref": "Optional.Integer", "default": null, "name": "playcount" }, { "$ref": "Optional.Integer", "default": null, "description": "Runtime in seconds", "name": "runtime" }, { "default": null, "name": "director", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "default": null, "name": "studio", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "$ref": "Optional.Integer", "default": null, "description": "linked with premiered. Overridden by premiered parameter", "name": "year" }, { "$ref": "Optional.String", "default": null, "name": "plot" }, { "default": null, "name": "genre", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "$ref": "Optional.Number", "default": null, "name": "rating" }, { "$ref": "Optional.String", "default": null, "name": "mpaa" }, { "$ref": "Optional.String", "default": null, "name": "imdbnumber" }, { "$ref": "Optional.String", "default": null, "name": "votes" }, { "$ref": "Optional.String", "default": null, "name": "lastplayed" }, { "$ref": "Optional.String", "default": null, "name": "originaltitle" }, { "$ref": "Optional.String", "default": null, "name": "trailer" }, { "$ref": "Optional.String", "default": null, "name": "tagline" }, { "$ref": "Optional.String", "default": null, "name": "plotoutline" }, { "default": null, "name": "writer", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "default": null, "name": "country", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "$ref": "Optional.Integer", "default": null, "name": "top250" }, { "$ref": "Optional.String", "default": null, "name": "sorttitle" }, { "$ref": "Optional.String", "default": null, "name": "set" }, { "default": null, "name": "showlink", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "$ref": "Optional.String", "default": null, "name": "thumbnail" }, { "$ref": "Optional.String", "default": null, "name": "fanart" }, { "default": null, "name": "tag", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "default": null, "name": "art", "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ] }, { "default": null, "name": "resume", "type": [ { "type": "null" }, { "$ref": "Video.Resume" } ] }, { "$ref": "Optional.Integer", "default": null, "name": "userrating" }, { "$ref": "Video.Ratings.Set", "name": "ratings" }, { "$ref": "Optional.String", "default": null, "name": "dateadded" }, { "$ref": "Optional.String", "default": null, "description": "linked with year. Overrides year", "name": "premiered" }, { "default": null, "name": "uniqueid", "type": [ { "type": "null" }, { "$ref": "Media.UniqueID.Set" } ] } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary.SetMovieSetDetails
Update the given movie set with the given details
Permissions:
- UpdateData
Parameters:
- Library.Id setid
- [Optional.String title = None]
- [mixed: null|Media.Artwork.Set art = None]
- [Optional.String plot = None]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Update the given movie set with the given details", "params": [ { "$ref": "Library.Id", "name": "setid", "required": true }, { "$ref": "Optional.String", "default": null, "name": "title" }, { "default": null, "name": "art", "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ] }, { "$ref": "Optional.String", "default": null, "name": "plot" } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary.SetMusicVideoDetails
Update the given music video with the given details
Permissions:
- UpdateData
Parameters:
- Library.Id musicvideoid
- [Optional.String title = None]
- [Optional.Integer playcount = None]
- [Optional.Integer runtime = None] (Runtime in seconds)
- [mixed: null|Array.String director = None]
- [mixed: null|Array.String studio = None]
- [Optional.Integer year = None] (linked with premiered. Overridden by premiered parameter)
- [Optional.String plot = None]
- [Optional.String album = None]
- [mixed: null|Array.String artist = None]
- [mixed: null|Array.String genre = None]
- [Optional.Integer track = None]
- [Optional.String lastplayed = None]
- [Optional.String thumbnail = None]
- [Optional.String fanart = None]
- [mixed: null|Array.String tag = None]
- [mixed: null|Media.Artwork.Set art = None]
- [mixed: null|Video.Resume resume = None]
- [Optional.Number rating = None]
- [Optional.Integer userrating = None]
- [Optional.String dateadded = None]
- [Optional.String premiered = None] (linked with year. Overrides year)
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Update the given music video with the given details", "params": [ { "$ref": "Library.Id", "name": "musicvideoid", "required": true }, { "$ref": "Optional.String", "default": null, "name": "title" }, { "$ref": "Optional.Integer", "default": null, "name": "playcount" }, { "$ref": "Optional.Integer", "default": null, "description": "Runtime in seconds", "name": "runtime" }, { "default": null, "name": "director", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "default": null, "name": "studio", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "$ref": "Optional.Integer", "default": null, "description": "linked with premiered. Overridden by premiered parameter", "name": "year" }, { "$ref": "Optional.String", "default": null, "name": "plot" }, { "$ref": "Optional.String", "default": null, "name": "album" }, { "default": null, "name": "artist", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "default": null, "name": "genre", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "$ref": "Optional.Integer", "default": null, "name": "track" }, { "$ref": "Optional.String", "default": null, "name": "lastplayed" }, { "$ref": "Optional.String", "default": null, "name": "thumbnail" }, { "$ref": "Optional.String", "default": null, "name": "fanart" }, { "default": null, "name": "tag", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "default": null, "name": "art", "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ] }, { "default": null, "name": "resume", "type": [ { "type": "null" }, { "$ref": "Video.Resume" } ] }, { "$ref": "Optional.Number", "default": null, "name": "rating" }, { "$ref": "Optional.Integer", "default": null, "name": "userrating" }, { "$ref": "Optional.String", "default": null, "name": "dateadded" }, { "$ref": "Optional.String", "default": null, "description": "linked with year. Overrides year", "name": "premiered" } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary.SetSeasonDetails
Update the given season with the given details
Permissions:
- UpdateData
Parameters:
- Library.Id seasonid
- [mixed: null|Media.Artwork.Set art = None]
- [Optional.Integer userrating = None]
- [Optional.String title = None]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Update the given season with the given details", "params": [ { "$ref": "Library.Id", "name": "seasonid", "required": true }, { "default": null, "name": "art", "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ] }, { "$ref": "Optional.Integer", "default": null, "name": "userrating" }, { "$ref": "Optional.String", "default": null, "name": "title" } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
VideoLibrary.SetTVShowDetails
Update the given tvshow with the given details
Permissions:
- UpdateData
Parameters:
- Library.Id tvshowid
- [Optional.String title = None]
- [Optional.Integer playcount = None]
- [mixed: null|Array.String studio = None]
- [Optional.String plot = None]
- [mixed: null|Array.String genre = None]
- [Optional.Number rating = None]
- [Optional.String mpaa = None]
- [Optional.String imdbnumber = None]
- [Optional.String premiered = None]
- [Optional.String votes = None]
- [Optional.String lastplayed = None]
- [Optional.String originaltitle = None]
- [Optional.String sorttitle = None]
- [Optional.String episodeguide = None]
- [Optional.String thumbnail = None]
- [Optional.String fanart = None]
- [mixed: null|Array.String tag = None]
- [mixed: null|Media.Artwork.Set art = None]
- [Optional.Integer userrating = None]
- [Video.Ratings.Set ratings]
- [Optional.String dateadded = None]
- [Optional.Integer runtime = None] (Runtime in seconds)
- [Optional.String status = None] (Valid values: 'returning series', 'in production', 'planned', 'cancelled', 'ended')
- [mixed: null|Media.UniqueID.Set uniqueid = None]
Returns:
Type: string
JSON Schema Description |
---|
{ "description": "Update the given tvshow with the given details", "params": [ { "$ref": "Library.Id", "name": "tvshowid", "required": true }, { "$ref": "Optional.String", "default": null, "name": "title" }, { "$ref": "Optional.Integer", "default": null, "name": "playcount" }, { "default": null, "name": "studio", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "$ref": "Optional.String", "default": null, "name": "plot" }, { "default": null, "name": "genre", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "$ref": "Optional.Number", "default": null, "name": "rating" }, { "$ref": "Optional.String", "default": null, "name": "mpaa" }, { "$ref": "Optional.String", "default": null, "name": "imdbnumber" }, { "$ref": "Optional.String", "default": null, "name": "premiered" }, { "$ref": "Optional.String", "default": null, "name": "votes" }, { "$ref": "Optional.String", "default": null, "name": "lastplayed" }, { "$ref": "Optional.String", "default": null, "name": "originaltitle" }, { "$ref": "Optional.String", "default": null, "name": "sorttitle" }, { "$ref": "Optional.String", "default": null, "name": "episodeguide" }, { "$ref": "Optional.String", "default": null, "name": "thumbnail" }, { "$ref": "Optional.String", "default": null, "name": "fanart" }, { "default": null, "name": "tag", "type": [ { "type": "null" }, { "$ref": "Array.String" } ] }, { "default": null, "name": "art", "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ] }, { "$ref": "Optional.Integer", "default": null, "name": "userrating" }, { "$ref": "Video.Ratings.Set", "name": "ratings" }, { "$ref": "Optional.String", "default": null, "name": "dateadded" }, { "$ref": "Optional.Integer", "default": null, "description": "Runtime in seconds", "name": "runtime" }, { "$ref": "Optional.String", "default": null, "description": "Valid values: 'returning series', 'in production', 'planned', 'cancelled', 'ended'", "name": "status" }, { "default": null, "name": "uniqueid", "type": [ { "type": "null" }, { "$ref": "Media.UniqueID.Set" } ] } ], "permission": "UpdateData", "returns": { "type": "string" }, "type": "method" } |
XBMC
XBMC.GetInfoBooleans
Retrieve info booleans about Kodi and the system
Permissions:
- ReadData
Parameters:
- array[string] booleans
Returns:
Type: object (Object containing key-value pairs of the retrieved info booleans)
JSON Schema Description |
---|
{ "description": "Retrieve info booleans about Kodi and the system", "params": [ { "items": { "type": "string" }, "minItems": 1, "name": "booleans", "required": true, "type": "array" } ], "permission": "ReadData", "returns": { "additionalProperties": { "default": "", "type": "string" }, "description": "Object containing key-value pairs of the retrieved info booleans", "type": "object" }, "type": "method" } |
XBMC.GetInfoLabels
Retrieve info labels about Kodi and the system
Permissions:
- ReadData
Parameters:
- array[string] labels (See http://kodi.wiki/view/InfoLabels for a list of possible info labels)
Returns:
Type: object (Object containing key-value pairs of the retrieved info labels)
JSON Schema Description |
---|
{ "description": "Retrieve info labels about Kodi and the system", "params": [ { "description": "See http://kodi.wiki/view/InfoLabels for a list of possible info labels", "items": { "type": "string" }, "minItems": 1, "name": "labels", "required": true, "type": "array" } ], "permission": "ReadData", "returns": { "additionalProperties": { "default": "", "type": "string" }, "description": "Object containing key-value pairs of the retrieved info labels", "type": "object" }, "type": "method" } |
Global Types
Addon
Addon.Content
Type: string
JSON Schema Description |
---|
{ "default": "unknown", "enums": [ "unknown", "video", "audio", "image", "executable" ], "id": "Addon.Content", "type": "string" } |
Addon.Details
Extends:
Properties:
- string addonid
- [string author]
- [mixed: boolean|string broken]
- [array dependencies]
- [mixed: boolean|string deprecated]
- [string description]
- [string disclaimer]
- [boolean enabled]
- [array extrainfo]
- [string fanart]
- [boolean installed]
- [string name]
- [string path]
- [integer rating]
- [string summary]
- [string thumbnail]
- Addon.Types type
- [string version]
JSON Schema Description |
---|
{ "extends": "Item.Details.Base", "id": "Addon.Details", "properties": { "addonid": { "required": true, "type": "string" }, "author": { "default": "", "type": "string" }, "broken": { "default": null, "type": [ { "type": "boolean" }, { "type": "string" } ] }, "dependencies": { "items": { "properties": { "addonid": { "required": true, "type": "string" }, "optional": { "required": true, "type": "boolean" }, "version": { "required": true, "type": "string" } }, "type": "object" }, "type": "array" }, "deprecated": { "default": null, "type": [ { "type": "boolean" }, { "type": "string" } ] }, "description": { "default": "", "type": "string" }, "disclaimer": { "default": "", "type": "string" }, "enabled": { "default": false, "type": "boolean" }, "extrainfo": { "items": { "properties": { "key": { "required": true, "type": "string" }, "value": { "required": true, "type": "string" } }, "type": "object" }, "type": "array" }, "fanart": { "default": "", "type": "string" }, "installed": { "default": false, "type": "boolean" }, "name": { "default": "", "type": "string" }, "path": { "default": "", "type": "string" }, "rating": { "default": 0, "type": "integer" }, "summary": { "default": "", "type": "string" }, "thumbnail": { "default": "", "type": "string" }, "type": { "$ref": "Addon.Types", "required": true }, "version": { "default": "", "type": "string" } } } |
Addon.Fields
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Addon.Fields", "items": { "enums": [ "name", "version", "summary", "description", "path", "author", "thumbnail", "disclaimer", "fanart", "dependencies", "broken", "extrainfo", "rating", "enabled", "installed", "deprecated" ], "type": "string" } } |
Addon.Types
Type: string
JSON Schema Description |
---|
{ "default": "unknown", "enums": [ "unknown", "xbmc.player.musicviz", "xbmc.gui.skin", "kodi.pvrclient", "kodi.inputstream", "kodi.gameclient", "kodi.peripheral", "xbmc.python.script", "xbmc.python.weather", "xbmc.subtitle.module", "xbmc.python.lyrics", "xbmc.metadata.scraper.albums", "xbmc.metadata.scraper.artists", "xbmc.metadata.scraper.movies", "xbmc.metadata.scraper.musicvideos", "xbmc.metadata.scraper.tvshows", "xbmc.ui.screensaver", "xbmc.python.pluginsource", "xbmc.addon.repository", "xbmc.webinterface", "xbmc.service", "kodi.audioencoder", "kodi.context.item", "kodi.audiodecoder", "kodi.resource.images", "kodi.resource.language", "kodi.resource.uisounds", "kodi.resource.games", "kodi.resource.font", "kodi.vfs", "kodi.imagedecoder", "xbmc.metadata.scraper.library", "xbmc.python.library", "xbmc.python.module", "kodi.game.controller", "", "xbmc.addon.video", "xbmc.addon.audio", "xbmc.addon.image", "xbmc.addon.executable", "kodi.addon.game" ], "id": "Addon.Types", "type": "string" } |
Application
Application.Property.Name
Type: string
JSON Schema Description |
---|
{ "default": "volume", "enums": [ "volume", "muted", "name", "version", "sorttokens", "language" ], "id": "Application.Property.Name", "type": "string" } |
Application.Property.Value
Type: object
Properties:
- [string language]
- [boolean muted]
- [string name]
- [Array.String sorttokens]
- [object version]
- [integer volume]
JSON Schema Description |
---|
{ "id": "Application.Property.Value", "properties": { "language": { "default": "", "description": "Current language code and region e.g. en_GB", "minLength": 1, "type": "string" }, "muted": { "default": false, "type": "boolean" }, "name": { "default": "", "minLength": 1, "type": "string" }, "sorttokens": { "$ref": "Array.String", "description": "Articles ignored during sorting when ignorearticle is enabled." }, "version": { "properties": { "major": { "minimum": 0, "required": true, "type": "integer" }, "minor": { "minimum": 0, "required": true, "type": "integer" }, "revision": { "default": null, "type": [ { "type": "string" }, { "type": "integer" } ] }, "tag": { "enums": [ "prealpha", "alpha", "beta", "releasecandidate", "stable" ], "required": true, "type": "string" }, "tagversion": { "default": "", "type": "string" } }, "type": "object" }, "volume": { "default": 0, "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } |
Array
Array.Integer
Type: array
JSON Schema Description |
---|
{ "id": "Array.Integer", "items": { "type": "integer" }, "type": "array" } |
Array.String
Type: array
JSON Schema Description |
---|
{ "id": "Array.String", "items": { "minLength": 1, "type": "string" }, "type": "array" } |
Audio
Audio.Album.ReleaseType
Type: string
JSON Schema Description |
---|
{ "default": "album", "enums": [ "album", "single" ], "id": "Audio.Album.ReleaseType", "type": "string" } |
Audio.Artist.Roles
Type: array
JSON Schema Description |
---|
{ "id": "Audio.Artist.Roles", "items": { "additionalProperties": false, "description": "The various roles contributed by an artist to one or more songs", "properties": { "role": { "required": true, "type": "string" }, "roleid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, "type": "array" } |
Audio.Contributors
Type: array
JSON Schema Description |
---|
{ "id": "Audio.Contributors", "items": { "additionalProperties": false, "description": "The artist and the role they contribute to a song", "properties": { "artistid": { "$ref": "Library.Id", "required": true }, "name": { "required": true, "type": "string" }, "role": { "required": true, "type": "string" }, "roleid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, "type": "array" } |
Audio.Details.Album
Extends:
Properties:
- [integer albumduration]
- Library.Id albumid
- [string albumlabel]
- [string albumstatus]
- [boolean compilation]
- [string description]
- [boolean isboxset]
- [string lastplayed]
- [Array.String mood]
- [string musicbrainzalbumid]
- [string musicbrainzreleasegroupid]
- [integer playcount]
- [Audio.Album.ReleaseType releasetype = album]
- [Audio.Details.Genres songgenres]
- [Array.Integer sourceid]
- [Array.String style]
- [Array.String theme]
- [integer totaldiscs]
- [string type]
JSON Schema Description |
---|
{ "extends": "Audio.Details.Media", "id": "Audio.Details.Album", "properties": { "albumduration": { "default": 0, "type": "integer" }, "albumid": { "$ref": "Library.Id", "required": true }, "albumlabel": { "default": "", "type": "string" }, "albumstatus": { "default": "", "type": "string" }, "compilation": { "default": false, "type": "boolean" }, "description": { "default": "", "type": "string" }, "isboxset": { "default": false, "type": "boolean" }, "lastplayed": { "default": "", "type": "string" }, "mood": { "$ref": "Array.String" }, "musicbrainzalbumid": { "default": "", "type": "string" }, "musicbrainzreleasegroupid": { "default": "", "type": "string" }, "playcount": { "default": 0, "type": "integer" }, "releasetype": { "$ref": "Audio.Album.ReleaseType", "default": "album" }, "songgenres": { "$ref": "Audio.Details.Genres" }, "sourceid": { "$ref": "Array.Integer" }, "style": { "$ref": "Array.String" }, "theme": { "$ref": "Array.String" }, "totaldiscs": { "default": 0, "type": "integer" }, "type": { "default": "", "type": "string" } } } |
Audio.Details.Artist
Extends:
Properties:
- string artist
- Library.Id artistid
- [string born]
- [boolean compilationartist]
- [string description]
- [string died]
- [string disambiguation]
- [string disbanded]
- [string formed]
- [string gender]
- [Array.String instrument]
- [boolean isalbumartist]
- [Array.String mood]
- [Array.String musicbrainzartistid]
- [Audio.Artist.Roles roles]
- [Audio.Details.Genres songgenres]
- [string sortname]
- [Array.Integer sourceid]
- [Array.String style]
- [string type]
- [Array.String yearsactive]
JSON Schema Description |
---|
{ "extends": "Audio.Details.Base", "id": "Audio.Details.Artist", "properties": { "artist": { "required": true, "type": "string" }, "artistid": { "$ref": "Library.Id", "required": true }, "born": { "default": "", "type": "string" }, "compilationartist": { "default": false, "type": "boolean" }, "description": { "default": "", "type": "string" }, "died": { "default": "", "type": "string" }, "disambiguation": { "default": "", "type": "string" }, "disbanded": { "default": "", "type": "string" }, "formed": { "default": "", "type": "string" }, "gender": { "default": "", "type": "string" }, "instrument": { "$ref": "Array.String" }, "isalbumartist": { "default": false, "type": "boolean" }, "mood": { "$ref": "Array.String" }, "musicbrainzartistid": { "$ref": "Array.String" }, "roles": { "$ref": "Audio.Artist.Roles" }, "songgenres": { "$ref": "Audio.Details.Genres" }, "sortname": { "default": "", "type": "string" }, "sourceid": { "$ref": "Array.Integer" }, "style": { "$ref": "Array.String" }, "type": { "default": "", "type": "string" }, "yearsactive": { "$ref": "Array.String" } } } |
Audio.Details.Base
Extends:
Properties:
- [Media.Artwork art]
- [string dateadded]
- [Array.String genre]
JSON Schema Description |
---|
{ "extends": "Media.Details.Base", "id": "Audio.Details.Base", "properties": { "art": { "$ref": "Media.Artwork" }, "dateadded": { "default": "", "type": "string" }, "genre": { "$ref": "Array.String" } } } |
Audio.Details.Genres
Type: array
JSON Schema Description |
---|
{ "id": "Audio.Details.Genres", "items": { "properties": { "genreid": { "$ref": "Library.Id", "required": true }, "title": { "default": "", "type": "string" } }, "type": "object" }, "type": "array" } |
Audio.Details.Media
Extends:
Properties:
- [Array.String artist]
- [Array.Integer artistid]
- [string displayartist]
- [Array.String musicbrainzalbumartistid]
- [string originaldate]
- [number rating]
- [string releasedate]
- [string sortartist]
- [string title]
- [integer userrating]
- [integer votes]
- [integer year]
JSON Schema Description |
---|
{ "extends": "Audio.Details.Base", "id": "Audio.Details.Media", "properties": { "artist": { "$ref": "Array.String" }, "artistid": { "$ref": "Array.Integer" }, "displayartist": { "default": "", "type": "string" }, "musicbrainzalbumartistid": { "$ref": "Array.String" }, "originaldate": { "default": "", "type": "string" }, "rating": { "default": 0.0, "type": "number" }, "releasedate": { "default": "", "type": "string" }, "sortartist": { "default": "", "type": "string" }, "title": { "default": "", "type": "string" }, "userrating": { "default": 0, "type": "integer" }, "votes": { "default": 0, "type": "integer" }, "year": { "default": 0, "type": "integer" } } } |
Audio.Details.Role
Extends:
Properties:
- Library.Id roleid
- [string title]
JSON Schema Description |
---|
{ "extends": "Item.Details.Base", "id": "Audio.Details.Role", "properties": { "roleid": { "$ref": "Library.Id", "required": true }, "title": { "default": "", "type": "string" } } } |
Audio.Details.Song
Extends:
Properties:
- [string album]
- [Array.String albumartist]
- [Array.Integer albumartistid]
- [Library.Id albumid = -1]
- [Audio.Album.ReleaseType albumreleasetype = album]
- [any bitrate]
- [any bpm]
- [any channels]
- [string comment]
- [Audio.Contributors contributors]
- [integer disc]
- [string disctitle]
- [string displaycomposer]
- [string displayconductor]
- [string displaylyricist]
- [string displayorchestra]
- [integer duration]
- [string file]
- [Array.Integer genreid]
- [string lastplayed]
- [string lyrics]
- [string mood]
- [Array.String musicbrainzartistid]
- [string musicbrainztrackid]
- [integer playcount]
- [any samplerate]
- Library.Id songid
- [Array.Integer sourceid]
- [integer track]
JSON Schema Description |
---|
{ "extends": "Audio.Details.Media", "id": "Audio.Details.Song", "properties": { "album": { "default": "", "type": "string" }, "albumartist": { "$ref": "Array.String" }, "albumartistid": { "$ref": "Array.Integer" }, "albumid": { "$ref": "Library.Id", "default": -1 }, "albumreleasetype": { "$ref": "Audio.Album.ReleaseType", "default": "album" }, "bitrate": { "default": null, "type": "any" }, "bpm": { "default": null, "type": "any" }, "channels": { "default": null, "type": "any" }, "comment": { "default": "", "type": "string" }, "contributors": { "$ref": "Audio.Contributors" }, "disc": { "default": 0, "type": "integer" }, "disctitle": { "default": "", "type": "string" }, "displaycomposer": { "default": "", "type": "string" }, "displayconductor": { "default": "", "type": "string" }, "displaylyricist": { "default": "", "type": "string" }, "displayorchestra": { "default": "", "type": "string" }, "duration": { "default": 0, "type": "integer" }, "file": { "default": "", "type": "string" }, "genreid": { "$ref": "Array.Integer" }, "lastplayed": { "default": "", "type": "string" }, "lyrics": { "default": "", "type": "string" }, "mood": { "default": "", "type": "string" }, "musicbrainzartistid": { "$ref": "Array.String" }, "musicbrainztrackid": { "default": "", "type": "string" }, "playcount": { "default": 0, "type": "integer" }, "samplerate": { "default": null, "type": "any" }, "songid": { "$ref": "Library.Id", "required": true }, "sourceid": { "$ref": "Array.Integer" }, "track": { "default": 0, "type": "integer" } } } |
Audio.Fields.Album
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Audio.Fields.Album", "items": { "description": "Requesting the songgenres, artistid and/or sourceid fields will result in increased response times", "enums": [ "title", "description", "artist", "genre", "theme", "mood", "style", "type", "albumlabel", "rating", "votes", "userrating", "year", "musicbrainzalbumid", "musicbrainzalbumartistid", "fanart", "thumbnail", "playcount", "artistid", "displayartist", "compilation", "releasetype", "dateadded", "sortartist", "musicbrainzreleasegroupid", "songgenres", "art", "lastplayed", "sourceid", "isboxset", "totaldiscs", "releasedate", "originaldate", "albumstatus", "datemodified", "datenew", "albumduration" ], "type": "string" } } |
Audio.Fields.Artist
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Audio.Fields.Artist", "items": { "description": "Requesting the (song)genreid/genre, roleid/role or sourceid fields will result in increased response times", "enums": [ "instrument", "style", "mood", "born", "formed", "description", "genre", "died", "disbanded", "yearsactive", "musicbrainzartistid", "fanart", "thumbnail", "compilationartist", "dateadded", "roles", "songgenres", "isalbumartist", "sortname", "type", "gender", "disambiguation", "art", "sourceid", "datemodified", "datenew" ], "type": "string" } } |
Audio.Fields.Role
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Audio.Fields.Role", "items": { "enums": [ "title" ], "type": "string" } } |
Audio.Fields.Song
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Audio.Fields.Song", "items": { "description": "Requesting the genreid, artistid, albumartistid and/or sourceid fields will result in increased response times", "enums": [ "title", "artist", "albumartist", "genre", "year", "rating", "album", "track", "duration", "comment", "lyrics", "musicbrainztrackid", "musicbrainzartistid", "musicbrainzalbumid", "musicbrainzalbumartistid", "playcount", "fanart", "thumbnail", "file", "albumid", "lastplayed", "disc", "genreid", "artistid", "displayartist", "albumartistid", "albumreleasetype", "dateadded", "votes", "userrating", "mood", "contributors", "displaycomposer", "displayconductor", "displayorchestra", "displaylyricist", "sortartist", "art", "sourceid", "disctitle", "releasedate", "originaldate", "bpm", "samplerate", "bitrate", "channels", "datemodified", "datenew" ], "type": "string" } } |
Audio.Property.Name
Type: string
JSON Schema Description |
---|
{ "default": "missingartistid", "enums": [ "missingartistid", "librarylastupdated", "librarylastcleaned", "artistlinksupdated", "songslastadded", "albumslastadded", "artistslastadded", "genreslastadded", "songsmodified", "albumsmodified", "artistsmodified" ], "id": "Audio.Property.Name", "type": "string" } |
Audio.Property.Value
Type: object
Properties:
- [string albumslastadded]
- [string albumsmodified]
- [string artistlinksupdated]
- [string artistslastadded]
- [string artistsmodified]
- [string genreslastadded]
- [string librarylastcleaned]
- [string librarylastupdated]
- [Library.Id missingartistid = -1]
- [string songslastadded]
- [string songsmodified]
JSON Schema Description |
---|
{ "id": "Audio.Property.Value", "properties": { "albumslastadded": { "default": "", "type": "string" }, "albumsmodified": { "default": "", "type": "string" }, "artistlinksupdated": { "default": "", "type": "string" }, "artistslastadded": { "default": "", "type": "string" }, "artistsmodified": { "default": "", "type": "string" }, "genreslastadded": { "default": "", "type": "string" }, "librarylastcleaned": { "default": "", "type": "string" }, "librarylastupdated": { "default": "", "type": "string" }, "missingartistid": { "$ref": "Library.Id", "default": -1 }, "songslastadded": { "default": "", "type": "string" }, "songsmodified": { "default": "", "type": "string" } }, "type": "object" } |
Configuration
Configuration
Type: object
Properties:
- Configuration.Notifications notifications
JSON Schema Description |
---|
{ "id": "Configuration", "properties": { "notifications": { "$ref": "Configuration.Notifications", "required": true } }, "required": true, "type": "object" } |
Configuration.Notifications
Type: object
Properties:
- boolean application
- boolean audiolibrary
- boolean gui
- boolean input
- boolean other
- boolean player
- boolean playlist
- boolean pvr
- boolean system
- boolean videolibrary
JSON Schema Description |
---|
{ "additionalProperties": false, "id": "Configuration.Notifications", "properties": { "application": { "required": true, "type": "boolean" }, "audiolibrary": { "required": true, "type": "boolean" }, "gui": { "required": true, "type": "boolean" }, "input": { "required": true, "type": "boolean" }, "other": { "required": true, "type": "boolean" }, "player": { "required": true, "type": "boolean" }, "playlist": { "required": true, "type": "boolean" }, "pvr": { "required": true, "type": "boolean" }, "system": { "required": true, "type": "boolean" }, "videolibrary": { "required": true, "type": "boolean" } }, "type": "object" } |
Favourite
Favourite.Details.Favourite
Type: object
Properties:
- [string path]
- [string thumbnail]
- string title
- Favourite.Type type
- [string window]
- [string windowparameter]
JSON Schema Description |
---|
{ "additionalProperties": false, "id": "Favourite.Details.Favourite", "properties": { "path": { "default": "", "type": "string" }, "thumbnail": { "default": "", "type": "string" }, "title": { "required": true, "type": "string" }, "type": { "$ref": "Favourite.Type", "required": true }, "window": { "default": "", "type": "string" }, "windowparameter": { "default": "", "type": "string" } }, "type": "object" } |
Favourite.Fields.Favourite
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Favourite.Fields.Favourite", "items": { "enums": [ "window", "windowparameter", "thumbnail", "path" ], "type": "string" } } |
Favourite.Type
Type: string
JSON Schema Description |
---|
{ "default": "media", "enums": [ "media", "window", "script", "androidapp", "unknown" ], "id": "Favourite.Type", "type": "string" } |
Files
Files.Media
Type: string
JSON Schema Description |
---|
{ "default": "video", "enums": [ "video", "music", "pictures", "files", "programs" ], "id": "Files.Media", "type": "string" } |
GUI
GUI.Property.Name
Type: string
JSON Schema Description |
---|
{ "default": "currentwindow", "enums": [ "currentwindow", "currentcontrol", "skin", "fullscreen", "stereoscopicmode" ], "id": "GUI.Property.Name", "type": "string" } |
GUI.Property.Value
Type: object
Properties:
- [object currentcontrol]
- [object currentwindow]
- [boolean fullscreen]
- [object skin]
- [GUI.Stereoscopy.Mode stereoscopicmode]
JSON Schema Description |
---|
{ "id": "GUI.Property.Value", "properties": { "currentcontrol": { "properties": { "label": { "required": true, "type": "string" } }, "type": "object" }, "currentwindow": { "properties": { "id": { "required": true, "type": "integer" }, "label": { "required": true, "type": "string" } }, "type": "object" }, "fullscreen": { "default": false, "type": "boolean" }, "skin": { "properties": { "id": { "minLength": 1, "required": true, "type": "string" }, "name": { "default": "", "type": "string" } }, "type": "object" }, "stereoscopicmode": { "$ref": "GUI.Stereoscopy.Mode" } }, "type": "object" } |
GUI.Stereoscopy.Mode
Type: object
Properties:
- string label
- string mode
JSON Schema Description |
---|
{ "id": "GUI.Stereoscopy.Mode", "properties": { "label": { "required": true, "type": "string" }, "mode": { "enums": [ "off", "split_vertical", "split_horizontal", "row_interleaved", "hardware_based", "anaglyph_cyan_red", "anaglyph_green_magenta", "anaglyph_yellow_blue", "monoscopic" ], "required": true, "type": "string" } }, "type": "object" } |
GUI.Window
Type: string
JSON Schema Description |
---|
{ "default": "addon", "enums": [ "addon", "addonbrowser", "addoninformation", "addonsettings", "appearancesettings", "busydialog", "busydialognocancel", "contentsettings", "contextmenu", "eventlog", "extendedprogressdialog", "favourites", "filebrowser", "filemanager", "fullscreengame", "fullscreeninfo", "fullscreenlivetv", "fullscreenlivetvinput", "fullscreenlivetvpreview", "fullscreenradio", "fullscreenradioinput", "fullscreenradiopreview", "fullscreenvideo", "gameadvancedsettings", "gamecontrollers", "gameosd", "gamepadinput", "games", "gamesettings", "gamestretchmode", "gamevideofilter", "gamevideorotation", "gamevolume", "home", "infoprovidersettings", "interfacesettings", "libexportsettings", "locksettings", "loginscreen", "mediafilter", "mediasettings", "mediasource", "movieinformation", "music", "musicinformation", "musicosd", "musicplaylist", "musicplaylisteditor", "networksetup", "notification", "numericinput", "okdialog", "osdaudiosettings", "osdcmssettings", "osdsubtitlesettings", "osdvideosettings", "peripheralsettings", "pictureinfo", "pictures", "playercontrols", "playerprocessinfo", "playersettings", "profiles", "profilesettings", "programs", "progressdialog", "pvrchannelguide", "pvrchannelmanager", "pvrchannelscan", "pvrgroupmanager", "pvrguidecontrols", "pvrguideinfo", "pvrguidesearch", "pvrosdchannels", "pvrosdguide", "pvrosdteletext", "pvrradiordsinfo", "pvrrecordinginfo", "pvrsettings", "pvrtimersetting", "pvrupdateprogress", "radiochannels", "radioguide", "radiorecordings", "radiosearch", "radiotimerrules", "radiotimers", "screencalibration", "screensaver", "seekbar", "selectdialog", "servicesettings", "settings", "shutdownmenu", "skinsettings", "sliderdialog", "slideshow", "smartplaylisteditor", "smartplaylistrule", "songinformation", "splash", "startup", "startwindow", "submenu", "subtitlesearch", "systeminfo", "systemsettings", "teletext", "textviewer", "tvchannels", "tvguide", "tvrecordings", "tvsearch", "tvtimerrules", "tvtimers", "videobookmarks", "videomenu", "videoosd", "videoplaylist", "videos", "videotimeseek", "virtualkeyboard", "visualisation", "visualisationpresetlist", "volumebar", "weather", "yesnodialog" ], "id": "GUI.Window", "type": "string" } |
Global
Global.IncrementDecrement
Type: string
JSON Schema Description |
---|
{ "default": "increment", "enums": [ "increment", "decrement" ], "id": "Global.IncrementDecrement", "type": "string" } |
Global.String.NotEmpty
Type: string
JSON Schema Description |
---|
{ "default": "", "id": "Global.String.NotEmpty", "minLength": 1, "type": "string" } |
Global.Time
Type: object
Properties:
- integer hours
- integer milliseconds
- integer minutes
- integer seconds
JSON Schema Description |
---|
{ "additionalProperties": false, "description": "A duration.", "id": "Global.Time", "properties": { "hours": { "minimum": 0, "required": true, "type": "integer" }, "milliseconds": { "maximum": 999, "minimum": 0, "required": true, "type": "integer" }, "minutes": { "maximum": 59, "minimum": 0, "required": true, "type": "integer" }, "seconds": { "maximum": 59, "minimum": 0, "required": true, "type": "integer" } }, "type": "object" } |
Global.Toggle
Type: mixed
JSON Schema Description |
---|
{ "default": null, "id": "Global.Toggle", "type": [ { "type": "boolean" }, { "enums": [ "toggle" ], "type": "string" } ] } |
Global.Weekday
Type: string
JSON Schema Description |
---|
{ "default": "monday", "enums": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "id": "Global.Weekday", "type": "string" } |
Input
Input.Action
Type: string
JSON Schema Description |
---|
{ "default": "analogfastforward", "enums": [ "analogfastforward", "analogmove", "analogmovexleft", "analogmovexright", "analogmoveydown", "analogmoveyup", "analogrewind", "analogseekback", "analogseekforward", "aspectratio", "audiodelay", "audiodelayminus", "audiodelayplus", "audionextlanguage", "audiotoggledigital", "back", "backspace", "bigstepback", "bigstepforward", "blue", "browsesubtitle", "channeldown", "channelnumberseparator", "channelup", "chapterorbigstepback", "chapterorbigstepforward", "close", "codecinfo", "contextmenu", "copy", "createbookmark", "createepisodebookmark", "cursorleft", "cursorright", "cyclesubtitle", "cycletonemapmethod", "decreasepar", "decreaserating", "decreasevisrating", "delete", "doubleclick", "down", "enter", "error", "fastforward", "filter", "filterclear", "filtersms2", "filtersms3", "filtersms4", "filtersms5", "filtersms6", "filtersms7", "filtersms8", "filtersms9", "firstpage", "fullscreen", "green", "guiprofile", "hdrtoggle", "highlight", "increasepar", "increaserating", "increasevisrating", "info", "jumpsms2", "jumpsms3", "jumpsms4", "jumpsms5", "jumpsms6", "jumpsms7", "jumpsms8", "jumpsms9", "lastpage", "left", "leftclick", "lockpreset", "longclick", "longpress", "menu", "middleclick", "mousedrag", "mousedragend", "mousemove", "move", "moveitemdown", "moveitemup", "mute", "nextcalibration", "nextchannelgroup", "nextletter", "nextpicture", "nextpreset", "nextresolution", "nextscene", "nextstereomode", "nextsubtitle", "noop", "number0", "number1", "number2", "number3", "number4", "number5", "number6", "number7", "number8", "number9", "osd", "pagedown", "pageup", "pangesture", "parentdir", "parentfolder", "pause", "play", "playerdebug", "playerdebugvideo", "playerprocessinfo", "playerprogramselect", "playerresolutionselect", "playlist", "playnext", "playpause", "playpvr", "playpvrradio", "playpvrtv", "previouschannelgroup", "previousmenu", "previouspicture", "previouspreset", "previousscene", "previousstereomode", "prevletter", "queue", "randompreset", "record", "red", "reloadkeymaps", "rename", "resetcalibration", "rewind", "right", "rightclick", "rotate", "rotateccw", "rotategesture", "scanitem", "screenshot", "scrolldown", "scrollup", "select", "setrating", "settingslevelchange", "settingsreset", "shift", "showpreset", "showsubtitles", "showtime", "showtimerrule", "showvideomenu", "skipnext", "skipprevious", "smallstepback", "stepback", "stepforward", "stereomode", "stereomodetomono", "stop", "subtitlealign", "subtitledelay", "subtitledelayminus", "subtitledelayplus", "subtitleshiftdown", "subtitleshiftup", "swipedown", "swipeleft", "swiperight", "swipeup", "switchplayer", "symbols", "tap", "togglecommskip", "togglefont", "togglefullscreen", "togglestereomode", "togglewatched", "up", "verticalshiftdown", "verticalshiftup", "videonextstream", "voicerecognizer", "volampdown", "volampup", "volumeamplification", "volumedown", "volumeup", "wheeldown", "wheelup", "yellow", "zoomgesture", "zoomin", "zoomlevel1", "zoomlevel2", "zoomlevel3", "zoomlevel4", "zoomlevel5", "zoomlevel6", "zoomlevel7", "zoomlevel8", "zoomlevel9", "zoomnormal", "zoomout" ], "id": "Input.Action", "type": "string" } |
Item
Item.CustomProperties
Type: object
JSON Schema Description |
---|
{ "additionalProperties": { "$ref": "Global.String.NotEmpty", "default": "" }, "id": "Item.CustomProperties", "type": "object" } |
Item.Details.Base
Type: object
Properties:
- string label
JSON Schema Description |
---|
{ "id": "Item.Details.Base", "properties": { "label": { "required": true, "type": "string" } }, "type": "object" } |
Item.Fields.Base
Type: array
JSON Schema Description |
---|
{ "id": "Item.Fields.Base", "items": { "type": "string" }, "type": "array", "uniqueItems": true } |
Library
Library.Details.Genre
Extends:
Properties:
- Library.Id genreid
- [Array.Integer sourceid]
- [string thumbnail]
- [string title]
JSON Schema Description |
---|
{ "extends": "Item.Details.Base", "id": "Library.Details.Genre", "properties": { "genreid": { "$ref": "Library.Id", "required": true }, "sourceid": { "$ref": "Array.Integer", "description": "The ids of sources with songs of the genre" }, "thumbnail": { "default": "", "type": "string" }, "title": { "default": "", "type": "string" } } } |
Library.Details.Source
Extends:
Properties:
- string file
- [Array.String paths]
- Library.Id sourceid
JSON Schema Description |
---|
{ "extends": "Item.Details.Base", "id": "Library.Details.Source", "properties": { "file": { "description": "The url encoded multipath string combining all paths of the source ", "required": true, "type": "string" }, "paths": { "$ref": "Array.String", "description": "The individual paths of the media source" }, "sourceid": { "$ref": "Library.Id", "required": true } } } |
Library.Details.Tag
Extends:
Properties:
- Library.Id tagid
- [string title]
JSON Schema Description |
---|
{ "extends": "Item.Details.Base", "id": "Library.Details.Tag", "properties": { "tagid": { "$ref": "Library.Id", "required": true }, "title": { "default": "", "type": "string" } } } |
Library.Fields.Genre
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Library.Fields.Genre", "items": { "enums": [ "title", "thumbnail", "sourceid" ], "type": "string" } } |
Library.Fields.Source
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Library.Fields.Source", "items": { "enums": [ "file", "paths" ], "type": "string" } } |
Library.Fields.Tag
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Library.Fields.Tag", "items": { "enums": [ "title" ], "type": "string" } } |
Library.Id
Type: integer
JSON Schema Description |
---|
{ "default": -1, "id": "Library.Id", "minimum": 1, "type": "integer" } |
List
List.Amount
Type: integer
JSON Schema Description |
---|
{ "default": -1, "id": "List.Amount", "minimum": 0, "type": "integer" } |
List.Fields.All
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "List.Fields.All", "items": { "enums": [ "title", "artist", "albumartist", "genre", "year", "rating", "album", "track", "duration", "comment", "lyrics", "musicbrainztrackid", "musicbrainzartistid", "musicbrainzalbumid", "musicbrainzalbumartistid", "playcount", "fanart", "director", "trailer", "tagline", "plot", "plotoutline", "originaltitle", "lastplayed", "writer", "studio", "mpaa", "cast", "country", "imdbnumber", "premiered", "productioncode", "runtime", "set", "showlink", "streamdetails", "top250", "votes", "firstaired", "season", "episode", "showtitle", "thumbnail", "file", "resume", "artistid", "albumid", "tvshowid", "setid", "watchedepisodes", "disc", "tag", "art", "genreid", "displayartist", "albumartistid", "description", "theme", "mood", "style", "albumlabel", "sorttitle", "episodeguide", "uniqueid", "dateadded", "channel", "channeltype", "hidden", "locked", "channelnumber", "subchannelnumber", "starttime", "endtime", "specialsortseason", "specialsortepisode", "compilation", "releasetype", "albumreleasetype", "contributors", "displaycomposer", "displayconductor", "displayorchestra", "displaylyricist", "userrating", "sortartist", "musicbrainzreleasegroupid", "mediapath", "dynpath", "isboxset", "totaldiscs", "disctitle", "releasedate", "originaldate", "bpm", "bitrate", "samplerate", "channels", "albumstatus", "datemodified", "datenew", "customproperties", "albumduration" ], "type": "string" } } |
List.Fields.Files
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "List.Fields.Files", "items": { "enums": [ "title", "artist", "albumartist", "genre", "year", "rating", "album", "track", "duration", "comment", "lyrics", "musicbrainztrackid", "musicbrainzartistid", "musicbrainzalbumid", "musicbrainzalbumartistid", "playcount", "fanart", "director", "trailer", "tagline", "plot", "plotoutline", "originaltitle", "lastplayed", "writer", "studio", "mpaa", "cast", "country", "imdbnumber", "premiered", "productioncode", "runtime", "set", "showlink", "streamdetails", "top250", "votes", "firstaired", "season", "episode", "showtitle", "thumbnail", "file", "resume", "artistid", "albumid", "tvshowid", "setid", "watchedepisodes", "disc", "tag", "art", "genreid", "displayartist", "albumartistid", "description", "theme", "mood", "style", "albumlabel", "sorttitle", "episodeguide", "uniqueid", "dateadded", "size", "lastmodified", "mimetype", "specialsortseason", "specialsortepisode", "sortartist", "musicbrainzreleasegroupid", "isboxset", "totaldiscs", "disctitle", "releasedate", "originaldate", "bpm", "bitrate", "samplerate", "channels", "datemodified", "datenew", "customproperties", "albumduration" ], "type": "string" } } |
List.Filter.Albums
Type: mixed
JSON Schema Description |
---|
{ "id": "List.Filter.Albums", "type": [ { "properties": { "and": { "items": { "$ref": "List.Filter.Albums" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "items": { "$ref": "List.Filter.Albums" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.Albums" } ] } |
List.Filter.Artists
Type: mixed
JSON Schema Description |
---|
{ "id": "List.Filter.Artists", "type": [ { "properties": { "and": { "items": { "$ref": "List.Filter.Artists" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "items": { "$ref": "List.Filter.Artists" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.Artists" } ] } |
List.Filter.Episodes
Type: mixed
JSON Schema Description |
---|
{ "id": "List.Filter.Episodes", "type": [ { "properties": { "and": { "items": { "$ref": "List.Filter.Episodes" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "items": { "$ref": "List.Filter.Episodes" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.Episodes" } ] } |
List.Filter.Fields.Albums
Type: string
JSON Schema Description |
---|
{ "default": "genre", "enums": [ "genre", "source", "album", "disctitle", "totaldiscs", "isboxset", "artist", "albumartist", "year", "originalyear", "albumduration", "review", "themes", "moods", "styles", "compilation", "type", "label", "rating", "userrating", "playcount", "lastplayed", "path", "albumstatus", "dateadded", "datemodified", "datenew", "playlist", "virtualfolder" ], "id": "List.Filter.Fields.Albums", "type": "string" } |
List.Filter.Fields.Artists
Type: string
JSON Schema Description |
---|
{ "default": "artist", "enums": [ "artist", "source", "genre", "moods", "styles", "instruments", "biography", "artisttype", "gender", "disambiguation", "born", "bandformed", "disbanded", "died", "role", "path", "dateadded", "datemodified", "datenew", "playlist", "virtualfolder" ], "id": "List.Filter.Fields.Artists", "type": "string" } |
List.Filter.Fields.Episodes
Type: string
JSON Schema Description |
---|
{ "default": "title", "enums": [ "title", "tvshow", "originaltitle", "plot", "votes", "rating", "userrating", "time", "writers", "airdate", "playcount", "lastplayed", "inprogress", "genre", "year", "director", "actor", "episode", "season", "filename", "path", "studio", "mpaarating", "dateadded", "tag", "videoresolution", "audiochannels", "audiocount", "subtitlecount", "videocodec", "audiocodec", "audiolanguage", "subtitlelanguage", "videoaspect", "playlist", "virtualfolder" ], "id": "List.Filter.Fields.Episodes", "type": "string" } |
List.Filter.Fields.Movies
Type: string
JSON Schema Description |
---|
{ "default": "title", "enums": [ "title", "originaltitle", "plot", "plotoutline", "tagline", "votes", "rating", "userrating", "time", "writers", "playcount", "lastplayed", "inprogress", "genre", "country", "year", "director", "actor", "mpaarating", "top250", "studio", "hastrailer", "filename", "path", "set", "tag", "dateadded", "videoresolution", "audiochannels", "audiocount", "subtitlecount", "videocodec", "audiocodec", "audiolanguage", "subtitlelanguage", "videoaspect", "playlist", "virtualfolder" ], "id": "List.Filter.Fields.Movies", "type": "string" } |
List.Filter.Fields.MusicVideos
Type: string
JSON Schema Description |
---|
{ "default": "title", "enums": [ "title", "genre", "album", "year", "artist", "filename", "path", "playcount", "lastplayed", "rating", "userrating", "time", "director", "studio", "plot", "tag", "dateadded", "videoresolution", "audiochannels", "audiocount", "subtitlecount", "videocodec", "audiocodec", "audiolanguage", "subtitlelanguage", "videoaspect", "playlist", "virtualfolder" ], "id": "List.Filter.Fields.MusicVideos", "type": "string" } |
List.Filter.Fields.Songs
Type: string
JSON Schema Description |
---|
{ "default": "genre", "enums": [ "genre", "source", "album", "disctitle", "artist", "albumartist", "title", "year", "originalyear", "time", "tracknumber", "filename", "path", "playcount", "lastplayed", "rating", "userrating", "comment", "moods", "bpm", "samplerate", "bitrate", "channels", "dateadded", "datemodified", "datenew", "playlist", "virtualfolder" ], "id": "List.Filter.Fields.Songs", "type": "string" } |
List.Filter.Fields.TVShows
Type: string
JSON Schema Description |
---|
{ "default": "title", "enums": [ "title", "originaltitle", "plot", "status", "votes", "rating", "userrating", "year", "genre", "director", "actor", "numepisodes", "numwatched", "playcount", "path", "studio", "mpaarating", "dateadded", "lastplayed", "inprogress", "tag", "playlist", "virtualfolder" ], "id": "List.Filter.Fields.TVShows", "type": "string" } |
List.Filter.Fields.Textures
Type: string
JSON Schema Description |
---|
{ "default": "textureid", "enums": [ "textureid", "url", "cachedurl", "lasthashcheck", "imagehash", "width", "height", "usecount", "lastused" ], "id": "List.Filter.Fields.Textures", "type": "string" } |
List.Filter.Movies
Type: mixed
JSON Schema Description |
---|
{ "id": "List.Filter.Movies", "type": [ { "properties": { "and": { "items": { "$ref": "List.Filter.Movies" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "items": { "$ref": "List.Filter.Movies" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.Movies" } ] } |
List.Filter.MusicVideos
Type: mixed
JSON Schema Description |
---|
{ "id": "List.Filter.MusicVideos", "type": [ { "properties": { "and": { "items": { "$ref": "List.Filter.MusicVideos" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "items": { "$ref": "List.Filter.MusicVideos" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.MusicVideos" } ] } |
List.Filter.Operators
Type: string
JSON Schema Description |
---|
{ "default": "contains", "enums": [ "contains", "doesnotcontain", "is", "isnot", "startswith", "endswith", "greaterthan", "lessthan", "after", "before", "inthelast", "notinthelast", "true", "false", "between" ], "id": "List.Filter.Operators", "type": "string" } |
List.Filter.Rule
Type: object
Properties:
- List.Filter.Operators operator
- mixed: string|array value
JSON Schema Description |
---|
{ "id": "List.Filter.Rule", "properties": { "operator": { "$ref": "List.Filter.Operators", "required": true }, "value": { "required": true, "type": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] } }, "type": "object" } |
List.Filter.Rule.Albums
Extends:
Properties:
JSON Schema Description |
---|
{ "extends": "List.Filter.Rule", "id": "List.Filter.Rule.Albums", "properties": { "field": { "$ref": "List.Filter.Fields.Albums", "required": true } } } |
List.Filter.Rule.Artists
Extends:
Properties:
JSON Schema Description |
---|
{ "extends": "List.Filter.Rule", "id": "List.Filter.Rule.Artists", "properties": { "field": { "$ref": "List.Filter.Fields.Artists", "required": true } } } |
List.Filter.Rule.Episodes
Extends:
Properties:
JSON Schema Description |
---|
{ "extends": "List.Filter.Rule", "id": "List.Filter.Rule.Episodes", "properties": { "field": { "$ref": "List.Filter.Fields.Episodes", "required": true } } } |
List.Filter.Rule.Movies
Extends:
Properties:
JSON Schema Description |
---|
{ "extends": "List.Filter.Rule", "id": "List.Filter.Rule.Movies", "properties": { "field": { "$ref": "List.Filter.Fields.Movies", "required": true } } } |
List.Filter.Rule.MusicVideos
Extends:
Properties:
JSON Schema Description |
---|
{ "extends": "List.Filter.Rule", "id": "List.Filter.Rule.MusicVideos", "properties": { "field": { "$ref": "List.Filter.Fields.MusicVideos", "required": true } } } |
List.Filter.Rule.Songs
Extends:
Properties:
- List.Filter.Fields.Songs field
JSON Schema Description |
---|
{ "extends": "List.Filter.Rule", "id": "List.Filter.Rule.Songs", "properties": { "field": { "$ref": "List.Filter.Fields.Songs", "required": true } } } |
List.Filter.Rule.TVShows
Extends:
Properties:
JSON Schema Description |
---|
{ "extends": "List.Filter.Rule", "id": "List.Filter.Rule.TVShows", "properties": { "field": { "$ref": "List.Filter.Fields.TVShows", "required": true } } } |
List.Filter.Rule.Textures
Extends:
Properties:
JSON Schema Description |
---|
{ "extends": "List.Filter.Rule", "id": "List.Filter.Rule.Textures", "properties": { "field": { "$ref": "List.Filter.Fields.Textures", "required": true } } } |
List.Filter.Songs
Type: mixed
JSON Schema Description |
---|
{ "id": "List.Filter.Songs", "type": [ { "properties": { "and": { "items": { "$ref": "List.Filter.Songs" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "items": { "$ref": "List.Filter.Songs" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.Songs" } ] } |
List.Filter.TVShows
Type: mixed
JSON Schema Description |
---|
{ "id": "List.Filter.TVShows", "type": [ { "properties": { "and": { "items": { "$ref": "List.Filter.TVShows" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "items": { "$ref": "List.Filter.TVShows" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.TVShows" } ] } |
List.Filter.Textures
Type: mixed
JSON Schema Description |
---|
{ "id": "List.Filter.Textures", "type": [ { "properties": { "and": { "items": { "$ref": "List.Filter.Textures" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "properties": { "or": { "items": { "$ref": "List.Filter.Textures" }, "minItems": 1, "required": true, "type": "array" } }, "type": "object" }, { "$ref": "List.Filter.Rule.Textures" } ] } |
List.Item.All
Extends:
Properties:
- [string channel]
- [integer channelnumber]
- [PVR.Channel.Type channeltype = tv]
- [string endtime]
- [boolean hidden]
- [boolean locked]
- [string starttime]
- [integer subchannelnumber]
JSON Schema Description |
---|
{ "extends": "List.Item.Base", "id": "List.Item.All", "properties": { "channel": { "default": "", "type": "string" }, "channelnumber": { "default": 0, "type": "integer" }, "channeltype": { "$ref": "PVR.Channel.Type", "default": "tv" }, "endtime": { "default": "", "type": "string" }, "hidden": { "default": false, "type": "boolean" }, "locked": { "default": false, "type": "boolean" }, "starttime": { "default": "", "type": "string" }, "subchannelnumber": { "default": 0, "type": "integer" } } } |
List.Item.Base
Extends:
Properties:
- [string album]
- [Array.String albumartist]
- [Array.Integer albumartistid]
- [Library.Id albumid = -1]
- [string albumlabel]
- [Audio.Album.ReleaseType albumreleasetype = album]
- [string albumstatus]
- [integer bitrate]
- [integer bpm]
- [Video.Cast cast]
- [integer channels]
- [string comment]
- [boolean compilation]
- [Audio.Contributors contributors]
- [Array.String country]
- [Item.CustomProperties customproperties]
- [string description]
- [integer disc]
- [string disctitle]
- [string displaycomposer]
- [string displayconductor]
- [string displaylyricist]
- [string displayorchestra]
- [integer duration]
- [string dynpath]
- [integer episode]
- [string episodeguide]
- [string firstaired]
- [Library.Id id = -1]
- [string imdbnumber]
- [boolean isboxset]
- [string lyrics]
- [string mediapath]
- [Array.String mood]
- [string mpaa]
- [Array.String musicbrainzartistid]
- [string musicbrainztrackid]
- [string originaldate]
- [string originaltitle]
- [string plotoutline]
- [string premiered]
- [string productioncode]
- [string releasedate]
- [Audio.Album.ReleaseType releasetype = album]
- [integer samplerate]
- [integer season]
- [string set]
- [Library.Id setid = -1]
- [Array.String showlink]
- [string showtitle]
- [string sorttitle]
- [integer specialsortepisode]
- [integer specialsortseason]
- [Array.String studio]
- [Array.String style]
- [Array.String tag]
- [string tagline]
- [Array.String theme]
- [integer top250]
- [integer totaldiscs]
- [integer track]
- [string trailer]
- [Library.Id tvshowid = -1]
- [string type = unknown]
- [Media.UniqueID uniqueid]
- [string votes]
- [integer watchedepisodes]
- [Array.String writer]
JSON Schema Description |
---|
{ "extends": [ "Video.Details.File", "Audio.Details.Media" ], "id": "List.Item.Base", "properties": { "album": { "default": "", "type": "string" }, "albumartist": { "$ref": "Array.String" }, "albumartistid": { "$ref": "Array.Integer" }, "albumid": { "$ref": "Library.Id", "default": -1 }, "albumlabel": { "default": "", "type": "string" }, "albumreleasetype": { "$ref": "Audio.Album.ReleaseType", "default": "album" }, "albumstatus": { "default": "", "type": "string" }, "bitrate": { "default": 0, "type": "integer" }, "bpm": { "default": 0, "type": "integer" }, "cast": { "$ref": "Video.Cast" }, "channels": { "default": 0, "type": "integer" }, "comment": { "default": "", "type": "string" }, "compilation": { "default": false, "type": "boolean" }, "contributors": { "$ref": "Audio.Contributors" }, "country": { "$ref": "Array.String" }, "customproperties": { "$ref": "Item.CustomProperties" }, "description": { "default": "", "type": "string" }, "disc": { "default": 0, "type": "integer" }, "disctitle": { "default": "", "type": "string" }, "displaycomposer": { "default": "", "type": "string" }, "displayconductor": { "default": "", "type": "string" }, "displaylyricist": { "default": "", "type": "string" }, "displayorchestra": { "default": "", "type": "string" }, "duration": { "default": 0, "type": "integer" }, "dynpath": { "default": "", "description": "An experimental property for debug purposes, often same as mediapath but when different gives the actual file playing that should also be in file property", "type": "string" }, "episode": { "default": 0, "type": "integer" }, "episodeguide": { "default": "", "type": "string" }, "firstaired": { "default": "", "type": "string" }, "id": { "$ref": "Library.Id", "default": -1 }, "imdbnumber": { "default": "", "type": "string" }, "isboxset": { "default": false, "type": "boolean" }, "lyrics": { "default": "", "type": "string" }, "mediapath": { "default": "", "description": "Media source path that identifies the item", "type": "string" }, "mood": { "$ref": "Array.String" }, "mpaa": { "default": "", "type": "string" }, "musicbrainzartistid": { "$ref": "Array.String" }, "musicbrainztrackid": { "default": "", "type": "string" }, "originaldate": { "default": "", "type": "string" }, "originaltitle": { "default": "", "type": "string" }, "plotoutline": { "default": "", "type": "string" }, "premiered": { "default": "", "type": "string" }, "productioncode": { "default": "", "type": "string" }, "releasedate": { "default": "", "type": "string" }, "releasetype": { "$ref": "Audio.Album.ReleaseType", "default": "album" }, "samplerate": { "default": 0, "type": "integer" }, "season": { "default": 0, "type": "integer" }, "set": { "default": "", "type": "string" }, "setid": { "$ref": "Library.Id", "default": -1 }, "showlink": { "$ref": "Array.String" }, "showtitle": { "default": "", "type": "string" }, "sorttitle": { "default": "", "type": "string" }, "specialsortepisode": { "default": 0, "type": "integer" }, "specialsortseason": { "default": 0, "type": "integer" }, "studio": { "$ref": "Array.String" }, "style": { "$ref": "Array.String" }, "tag": { "$ref": "Array.String" }, "tagline": { "default": "", "type": "string" }, "theme": { "$ref": "Array.String" }, "top250": { "default": 0, "type": "integer" }, "totaldiscs": { "default": 0, "type": "integer" }, "track": { "default": 0, "type": "integer" }, "trailer": { "default": "", "type": "string" }, "tvshowid": { "$ref": "Library.Id", "default": -1 }, "type": { "default": "unknown", "enums": [ "unknown", "movie", "episode", "musicvideo", "song", "picture", "channel" ], "type": "string" }, "uniqueid": { "$ref": "Media.UniqueID" }, "votes": { "default": "", "type": "string" }, "watchedepisodes": { "default": 0, "type": "integer" }, "writer": { "$ref": "Array.String" } } } |
List.Item.File
Extends:
Properties:
- string file
- string filetype
- [string lastmodified]
- [string mimetype]
- [integer size]
JSON Schema Description |
---|
{ "extends": "List.Item.Base", "id": "List.Item.File", "properties": { "file": { "required": true, "type": "string" }, "filetype": { "enums": [ "file", "directory" ], "required": true, "type": "string" }, "lastmodified": { "default": "", "type": "string" }, "mimetype": { "default": "", "type": "string" }, "size": { "default": 0, "description": "Size of the file in bytes", "type": "integer" } } } |
List.Items.Sources
Type: array
JSON Schema Description |
---|
{ "id": "List.Items.Sources", "items": { "extends": "Item.Details.Base", "properties": { "file": { "required": true, "type": "string" } } }, "type": "array" } |
List.Limits
Type: object
Properties:
- [List.Amount end = -1]
- [integer start]
JSON Schema Description |
---|
{ "additionalProperties": false, "id": "List.Limits", "properties": { "end": { "$ref": "List.Amount", "default": -1, "description": "Index of the last item to return" }, "start": { "default": 0, "description": "Index of the first item to return", "minimum": 0, "type": "integer" } }, "type": "object" } |
List.LimitsReturned
Type: object
Properties:
- [List.Amount end = -1]
- [integer start]
- integer total
JSON Schema Description |
---|
{ "additionalProperties": false, "id": "List.LimitsReturned", "properties": { "end": { "$ref": "List.Amount", "default": -1 }, "start": { "default": 0, "minimum": 0, "type": "integer" }, "total": { "minimum": 0, "required": true, "type": "integer" } }, "type": "object" } |
List.Sort
Type: object
Properties:
- [boolean ignorearticle]
- [string method = none]
- [string order = ascending]
- [boolean useartistsortname]
JSON Schema Description |
---|
{ "id": "List.Sort", "properties": { "ignorearticle": { "default": false, "type": "boolean" }, "method": { "default": "none", "enums": [ "none", "label", "date", "size", "file", "path", "drivetype", "title", "track", "time", "artist", "album", "albumtype", "genre", "country", "year", "rating", "userrating", "votes", "top250", "programcount", "playlist", "episode", "season", "totalepisodes", "watchedepisodes", "tvshowstatus", "tvshowtitle", "sorttitle", "productioncode", "mpaa", "studio", "dateadded", "lastplayed", "playcount", "listeners", "bitrate", "random", "totaldiscs", "originaldate", "bpm" ], "type": "string" }, "order": { "default": "ascending", "enums": [ "ascending", "descending" ], "type": "string" }, "useartistsortname": { "default": false, "type": "boolean" } }, "type": "object" } |
Media
Media.Artwork
Type: object
Properties:
- [Global.String.NotEmpty banner]
- [Global.String.NotEmpty fanart]
- [Global.String.NotEmpty poster]
- [Global.String.NotEmpty thumb]
JSON Schema Description |
---|
{ "additionalProperties": { "$ref": "Global.String.NotEmpty", "default": "" }, "id": "Media.Artwork", "properties": { "banner": { "$ref": "Global.String.NotEmpty", "default": "" }, "fanart": { "$ref": "Global.String.NotEmpty", "default": "" }, "poster": { "$ref": "Global.String.NotEmpty", "default": "" }, "thumb": { "$ref": "Global.String.NotEmpty", "default": "" } }, "type": "object" } |
Media.Artwork.Set
Type: object
Properties:
- [mixed: null|Global.String.NotEmpty banner]
- [mixed: null|Global.String.NotEmpty fanart]
- [mixed: null|Global.String.NotEmpty poster]
- [mixed: null|Global.String.NotEmpty thumb]
JSON Schema Description |
---|
{ "additionalProperties": { "default": null, "type": [ { "type": "null" }, { "$ref": "Global.String.NotEmpty" } ] }, "id": "Media.Artwork.Set", "properties": { "banner": { "default": "", "type": [ { "type": "null" }, { "$ref": "Global.String.NotEmpty" } ] }, "fanart": { "default": "", "type": [ { "type": "null" }, { "$ref": "Global.String.NotEmpty" } ] }, "poster": { "default": "", "type": [ { "type": "null" }, { "$ref": "Global.String.NotEmpty" } ] }, "thumb": { "default": "", "type": [ { "type": "null" }, { "$ref": "Global.String.NotEmpty" } ] } }, "type": "object" } |
Media.Details.Base
Extends:
Properties:
- [string fanart]
- [string thumbnail]
JSON Schema Description |
---|
{ "extends": "Item.Details.Base", "id": "Media.Details.Base", "properties": { "fanart": { "default": "", "type": "string" }, "thumbnail": { "default": "", "type": "string" } } } |
Media.UniqueID
Type: object
JSON Schema Description |
---|
{ "additionalProperties": { "$ref": "Global.String.NotEmpty", "default": "" }, "id": "Media.UniqueID", "type": "object" } |
Media.UniqueID.Set
Type: object
JSON Schema Description |
---|
{ "additionalProperties": { "default": null, "type": [ { "type": "null" }, { "$ref": "Global.String.NotEmpty" } ] }, "id": "Media.UniqueID.Set", "type": "object" } |
Notifications
Notifications.Item
Type: mixed
JSON Schema Description |
---|
{ "id": "Notifications.Item", "type": [ { "description": "An unknown item does not have any additional information.", "properties": { "type": { "$ref": "Notifications.Item.Type", "required": true } }, "type": "object" }, { "description": "An item known to the database has an identification.", "properties": { "id": { "$ref": "Library.Id", "required": true }, "type": { "$ref": "Notifications.Item.Type", "required": true } }, "type": "object" }, { "description": "A movie item has a title and may have a release year.", "properties": { "title": { "required": true, "type": "string" }, "type": { "$ref": "Notifications.Item.Type", "required": true }, "year": { "default": 0, "type": "integer" } }, "type": "object" }, { "description": "A tv episode has a title and may have an episode number, season number and the title of the show it belongs to.", "properties": { "episode": { "default": 0, "type": "integer" }, "season": { "default": 0, "type": "integer" }, "showtitle": { "default": "", "type": "string" }, "title": { "required": true, "type": "string" }, "type": { "$ref": "Notifications.Item.Type", "required": true } }, "type": "object" }, { "description": "A music video has a title and may have an album and an artist.", "properties": { "album": { "default": "", "type": "string" }, "artist": { "default": "", "type": "string" }, "title": { "required": true, "type": "string" }, "type": { "$ref": "Notifications.Item.Type", "required": true } }, "type": "object" }, { "description": "A song has a title and may have an album, an artist and a track number.", "properties": { "album": { "default": "", "type": "string" }, "artist": { "default": "", "type": "string" }, "title": { "required": true, "type": "string" }, "track": { "default": 0, "type": "integer" }, "type": { "$ref": "Notifications.Item.Type", "required": true } }, "type": "object" }, { "description": "A picture has a file path.", "properties": { "file": { "required": true, "type": "string" }, "type": { "$ref": "Notifications.Item.Type", "required": true } }, "type": "object" }, { "description": "A PVR channel is either a radio or tv channel and has a title.", "properties": { "channeltype": { "$ref": "PVR.Channel.Type", "required": true }, "id": { "$ref": "Library.Id", "required": true }, "title": { "required": true, "type": "string" }, "type": { "$ref": "Notifications.Item.Type", "required": true } }, "type": "object" } ] } |
Notifications.Item.Type
Type: string
JSON Schema Description |
---|
{ "default": "unknown", "enums": [ "unknown", "movie", "episode", "musicvideo", "song", "picture", "channel" ], "id": "Notifications.Item.Type", "type": "string" } |
Optional
Optional.Boolean
Type: mixed
JSON Schema Description |
---|
{ "default": null, "id": "Optional.Boolean", "type": [ { "type": "null" }, { "type": "boolean" } ] } |
Optional.Integer
Type: mixed
JSON Schema Description |
---|
{ "default": null, "id": "Optional.Integer", "type": [ { "type": "null" }, { "type": "integer" } ] } |
Optional.Number
Type: mixed
JSON Schema Description |
---|
{ "default": null, "id": "Optional.Number", "type": [ { "type": "null" }, { "type": "number" } ] } |
Optional.String
Type: mixed
JSON Schema Description |
---|
{ "default": null, "id": "Optional.String", "type": [ { "type": "null" }, { "type": "string" } ] } |
PVR
PVR.Channel.Type
Type: string
JSON Schema Description |
---|
{ "default": "tv", "enums": [ "tv", "radio" ], "id": "PVR.Channel.Type", "type": "string" } |
PVR.ChannelGroup.Id
Type: mixed
JSON Schema Description |
---|
{ "default": null, "id": "PVR.ChannelGroup.Id", "type": [ { "$ref": "Library.Id" }, { "enums": [ "alltv", "allradio" ], "type": "string" } ] } |
PVR.Details.Broadcast
Extends:
Properties:
- Library.Id broadcastid
- [string cast]
- [Library.Id clientid = -1]
- [string director]
- [string endtime]
- [string episodename]
- [integer episodenum]
- [integer episodepart]
- [string firstaired]
- [string genre]
- [boolean hasrecording]
- [boolean hasreminder]
- [boolean hastimer]
- [boolean hastimerrule]
- [integer imdbnumber]
- [boolean isactive]
- [boolean isplayable]
- [boolean isseries]
- [string originaltitle]
- [integer parentalrating]
- [string plot]
- [string plotoutline]
- [integer progress]
- [number progresspercentage]
- [integer rating]
- [string recording]
- [integer runtime]
- [string starttime]
- [string thumbnail]
- [string title]
- [boolean wasactive]
- [string writer]
- [integer year]
JSON Schema Description |
---|
{ "extends": "Item.Details.Base", "id": "PVR.Details.Broadcast", "properties": { "broadcastid": { "$ref": "Library.Id", "required": true }, "cast": { "default": "", "type": "string" }, "clientid": { "$ref": "Library.Id", "default": -1 }, "director": { "default": "", "type": "string" }, "endtime": { "default": "", "type": "string" }, "episodename": { "default": "", "type": "string" }, "episodenum": { "default": 0, "type": "integer" }, "episodepart": { "default": 0, "type": "integer" }, "firstaired": { "default": "", "type": "string" }, "genre": { "default": "", "type": "string" }, "hasrecording": { "default": false, "type": "boolean" }, "hasreminder": { "default": false, "type": "boolean" }, "hastimer": { "default": false, "type": "boolean" }, "hastimerrule": { "default": false, "type": "boolean" }, "imdbnumber": { "default": 0, "type": "integer" }, "isactive": { "default": false, "type": "boolean" }, "isplayable": { "default": false, "description": "Deprecated - Use GetBroadcastIsPlayable instead", "type": "boolean" }, "isseries": { "default": false, "type": "boolean" }, "originaltitle": { "default": "", "type": "string" }, "parentalrating": { "default": 0, "type": "integer" }, "plot": { "default": "", "type": "string" }, "plotoutline": { "default": "", "type": "string" }, "progress": { "default": 0, "type": "integer" }, "progresspercentage": { "default": 0.0, "type": "number" }, "rating": { "default": 0, "type": "integer" }, "recording": { "default": "", "type": "string" }, "runtime": { "default": 0, "type": "integer" }, "starttime": { "default": "", "type": "string" }, "thumbnail": { "default": "", "type": "string" }, "title": { "default": "", "type": "string" }, "wasactive": { "default": false, "type": "boolean" }, "writer": { "default": "", "type": "string" }, "year": { "default": 0, "type": "integer" } } } |
PVR.Details.Channel
Extends:
Properties:
- [PVR.Details.Broadcast broadcastnext]
- [PVR.Details.Broadcast broadcastnow]
- [string channel]
- Library.Id channelid
- [integer channelnumber]
- [PVR.Channel.Type channeltype = tv]
- [Library.Id clientid = -1]
- [boolean hasarchive]
- [boolean hidden]
- [string icon]
- [boolean isrecording]
- [string lastplayed]
- [boolean locked]
- [integer subchannelnumber]
- [string thumbnail]
- integer uniqueid
JSON Schema Description |
---|
{ "extends": "Item.Details.Base", "id": "PVR.Details.Channel", "properties": { "broadcastnext": { "$ref": "PVR.Details.Broadcast" }, "broadcastnow": { "$ref": "PVR.Details.Broadcast" }, "channel": { "default": "", "type": "string" }, "channelid": { "$ref": "Library.Id", "required": true }, "channelnumber": { "default": 0, "type": "integer" }, "channeltype": { "$ref": "PVR.Channel.Type", "default": "tv" }, "clientid": { "$ref": "Library.Id", "default": -1 }, "hasarchive": { "default": false, "type": "boolean" }, "hidden": { "default": false, "type": "boolean" }, "icon": { "default": "", "type": "string" }, "isrecording": { "default": false, "type": "boolean" }, "lastplayed": { "default": "", "type": "string" }, "locked": { "default": false, "type": "boolean" }, "subchannelnumber": { "default": 0, "type": "integer" }, "thumbnail": { "default": "", "type": "string" }, "uniqueid": { "required": true, "type": "integer" } } } |
PVR.Details.ChannelGroup
Extends:
Properties:
- Library.Id channelgroupid
- PVR.Channel.Type channeltype
JSON Schema Description |
---|
{ "extends": "Item.Details.Base", "id": "PVR.Details.ChannelGroup", "properties": { "channelgroupid": { "$ref": "Library.Id", "required": true }, "channeltype": { "$ref": "PVR.Channel.Type", "required": true } } } |
PVR.Details.ChannelGroup.Extended
Extends:
Properties:
- [array channels]
- List.LimitsReturned limits
JSON Schema Description |
---|
{ "extends": "PVR.Details.ChannelGroup", "id": "PVR.Details.ChannelGroup.Extended", "properties": { "channels": { "items": { "$ref": "PVR.Details.Channel" }, "type": "array" }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } |
PVR.Details.Client
Extends:
Properties:
- [string addonid]
- Library.Id clientid
- [boolean supportschannelgroups]
- [boolean supportschannelscan]
- [boolean supportsepg]
- [boolean supportsradio]
- [boolean supportsrecordings]
- [boolean supportstimers]
- [boolean supportstv]
JSON Schema Description |
---|
{ "extends": "Item.Details.Base", "id": "PVR.Details.Client", "properties": { "addonid": { "default": "", "type": "string" }, "clientid": { "$ref": "Library.Id", "required": true }, "supportschannelgroups": { "default": false, "type": "boolean" }, "supportschannelscan": { "default": false, "type": "boolean" }, "supportsepg": { "default": false, "type": "boolean" }, "supportsradio": { "default": false, "type": "boolean" }, "supportsrecordings": { "default": false, "type": "boolean" }, "supportstimers": { "default": false, "type": "boolean" }, "supportstv": { "default": false, "type": "boolean" } } } |
PVR.Details.Recording
Extends:
Properties:
- [Media.Artwork art]
- [string channel]
- [integer channeluid]
- [Library.Id clientid = -1]
- [string directory]
- [string endtime]
- [integer epgeventid]
- [integer episode]
- [string file]
- [string genre]
- [string icon]
- [boolean isdeleted]
- [integer lifetime]
- [integer playcount]
- [string plot]
- [string plotoutline]
- [boolean radio]
- Library.Id recordingid
- [Video.Resume resume]
- [integer runtime]
- [integer season]
- [string showtitle]
- [string starttime]
- [string streamurl]
- [string title]
JSON Schema Description |
---|
{ "extends": "Item.Details.Base", "id": "PVR.Details.Recording", "properties": { "art": { "$ref": "Media.Artwork" }, "channel": { "default": "", "type": "string" }, "channeluid": { "default": 0, "type": "integer" }, "clientid": { "$ref": "Library.Id", "default": -1 }, "directory": { "default": "", "type": "string" }, "endtime": { "default": "", "type": "string" }, "epgeventid": { "default": 0, "type": "integer" }, "episode": { "default": 0, "type": "integer" }, "file": { "default": "", "type": "string" }, "genre": { "default": "", "type": "string" }, "icon": { "default": "", "type": "string" }, "isdeleted": { "default": false, "type": "boolean" }, "lifetime": { "default": 0, "type": "integer" }, "playcount": { "default": 0, "type": "integer" }, "plot": { "default": "", "type": "string" }, "plotoutline": { "default": "", "type": "string" }, "radio": { "default": false, "type": "boolean" }, "recordingid": { "$ref": "Library.Id", "required": true }, "resume": { "$ref": "Video.Resume" }, "runtime": { "default": 0, "type": "integer" }, "season": { "default": 0, "type": "integer" }, "showtitle": { "default": "", "type": "string" }, "starttime": { "default": "", "type": "string" }, "streamurl": { "default": "", "type": "string" }, "title": { "default": "", "type": "string" } } } |
PVR.Details.Timer
Extends:
Properties:
- [Library.Id broadcastid = -1]
- [Library.Id channelid = -1]
- [Library.Id clientid = -1]
- [string directory]
- [boolean endanytime]
- [integer endmargin]
- [string endtime]
- [string epgsearchstring]
- [integer epguid]
- [string file]
- [string firstday]
- [boolean fulltextepgsearch]
- [boolean ismanual]
- [boolean isradio]
- [boolean isreadonly]
- [boolean isreminder]
- [boolean istimerrule]
- [integer lifetime]
- [integer maxrecordings]
- [integer preventduplicateepisodes]
- [integer priority]
- [integer recordinggroup]
- [integer runtime]
- [boolean startanytime]
- [integer startmargin]
- [string starttime]
- [PVR.TimerState state = unknown]
- [string summary]
- Library.Id timerid
- [string title]
- [array weekdays]
JSON Schema Description |
---|
{ "extends": "Item.Details.Base", "id": "PVR.Details.Timer", "properties": { "broadcastid": { "$ref": "Library.Id", "default": -1 }, "channelid": { "$ref": "Library.Id", "default": -1 }, "clientid": { "$ref": "Library.Id", "default": -1 }, "directory": { "default": "", "type": "string" }, "endanytime": { "default": false, "type": "boolean" }, "endmargin": { "default": 0, "type": "integer" }, "endtime": { "default": "", "type": "string" }, "epgsearchstring": { "default": "", "type": "string" }, "epguid": { "default": 0, "type": "integer" }, "file": { "default": "", "type": "string" }, "firstday": { "default": "", "type": "string" }, "fulltextepgsearch": { "default": false, "type": "boolean" }, "ismanual": { "default": false, "type": "boolean" }, "isradio": { "default": false, "type": "boolean" }, "isreadonly": { "default": false, "type": "boolean" }, "isreminder": { "default": false, "type": "boolean" }, "istimerrule": { "default": false, "type": "boolean" }, "lifetime": { "default": 0, "type": "integer" }, "maxrecordings": { "default": 0, "type": "integer" }, "preventduplicateepisodes": { "default": 0, "type": "integer" }, "priority": { "default": 0, "type": "integer" }, "recordinggroup": { "default": 0, "type": "integer" }, "runtime": { "default": 0, "type": "integer" }, "startanytime": { "default": false, "type": "boolean" }, "startmargin": { "default": 0, "type": "integer" }, "starttime": { "default": "", "type": "string" }, "state": { "$ref": "PVR.TimerState", "default": "unknown" }, "summary": { "default": "", "type": "string" }, "timerid": { "$ref": "Library.Id", "required": true }, "title": { "default": "", "type": "string" }, "weekdays": { "items": { "$ref": "Global.Weekday" }, "type": "array", "uniqueItems": true } } } |
PVR.Fields.Broadcast
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "PVR.Fields.Broadcast", "items": { "enums": [ "title", "plot", "plotoutline", "starttime", "endtime", "runtime", "progress", "progresspercentage", "genre", "episodename", "episodenum", "episodepart", "firstaired", "hastimer", "isactive", "parentalrating", "wasactive", "thumbnail", "rating", "originaltitle", "cast", "director", "writer", "year", "imdbnumber", "hastimerrule", "hasrecording", "recording", "isseries", "isplayable", "clientid", "hasreminder" ], "type": "string" } } |
PVR.Fields.Channel
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "PVR.Fields.Channel", "items": { "enums": [ "thumbnail", "channeltype", "hidden", "locked", "channel", "lastplayed", "broadcastnow", "broadcastnext", "uniqueid", "icon", "channelnumber", "subchannelnumber", "isrecording", "hasarchive", "clientid" ], "type": "string" } } |
PVR.Fields.Client
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "PVR.Fields.Client", "items": { "enums": [ "addonid", "supportstv", "supportsradio", "supportsepg", "supportsrecordings", "supportstimers", "supportschannelgroups", "supportschannelscan" ], "type": "string" } } |
PVR.Fields.Recording
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "PVR.Fields.Recording", "items": { "enums": [ "title", "plot", "plotoutline", "genre", "playcount", "resume", "channel", "starttime", "endtime", "runtime", "lifetime", "icon", "art", "streamurl", "file", "directory", "radio", "isdeleted", "epgeventid", "channeluid", "season", "episode", "showtitle", "clientid" ], "type": "string" } } |
PVR.Fields.Timer
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "PVR.Fields.Timer", "items": { "enums": [ "title", "summary", "channelid", "isradio", "istimerrule", "ismanual", "starttime", "endtime", "runtime", "lifetime", "firstday", "weekdays", "priority", "startmargin", "endmargin", "state", "file", "directory", "preventduplicateepisodes", "startanytime", "endanytime", "epgsearchstring", "fulltextepgsearch", "recordinggroup", "maxrecordings", "epguid", "isreadonly", "isreminder", "clientid", "broadcastid" ], "type": "string" } } |
PVR.Property.Name
Type: string
JSON Schema Description |
---|
{ "default": "available", "enums": [ "available", "recording", "scanning" ], "id": "PVR.Property.Name", "type": "string" } |
PVR.Property.Value
Type: object
Properties:
- [boolean available]
- [boolean recording]
- [boolean scanning]
JSON Schema Description |
---|
{ "id": "PVR.Property.Value", "properties": { "available": { "default": false, "type": "boolean" }, "recording": { "default": false, "type": "boolean" }, "scanning": { "default": false, "type": "boolean" } }, "type": "object" } |
PVR.TimerState
Type: string
JSON Schema Description |
---|
{ "default": "unknown", "enums": [ "unknown", "new", "scheduled", "recording", "completed", "aborted", "cancelled", "conflict_ok", "conflict_notok", "error", "disabled" ], "id": "PVR.TimerState", "type": "string" } |
Player
Player.Audio.Stream
Type: object
Properties:
- integer bitrate
- integer channels
- string codec
- integer index
- boolean isdefault
- boolean isimpaired
- boolean isoriginal
- string language
- string name
- integer samplerate
JSON Schema Description |
---|
{ "id": "Player.Audio.Stream", "properties": { "bitrate": { "required": true, "type": "integer" }, "channels": { "required": true, "type": "integer" }, "codec": { "required": true, "type": "string" }, "index": { "minimum": 0, "required": true, "type": "integer" }, "isdefault": { "required": true, "type": "boolean" }, "isimpaired": { "required": true, "type": "boolean" }, "isoriginal": { "required": true, "type": "boolean" }, "language": { "required": true, "type": "string" }, "name": { "required": true, "type": "string" }, "samplerate": { "required": true, "type": "integer" } }, "type": "object" } |
Player.CustomViewMode
Type: object
Properties:
- [mixed: string|Optional.Boolean nonlinearstretch]
- [mixed: string|Optional.Number pixelratio]
- [mixed: string|Optional.Number verticalshift]
- [mixed: string|Optional.Number zoom]
JSON Schema Description |
---|
{ "id": "Player.CustomViewMode", "properties": { "nonlinearstretch": { "default": null, "type": [ { "enums": [ "increase", "decrease" ], "type": "string" }, { "$ref": "Optional.Boolean", "description": "Flag to enable nonlinear stretch" } ] }, "pixelratio": { "default": null, "type": [ { "enums": [ "increase", "decrease" ], "type": "string" }, { "$ref": "Optional.Number", "description": "Pixel aspect ratio where 1.0 means square pixel" } ] }, "verticalshift": { "default": null, "type": [ { "enums": [ "increase", "decrease" ], "type": "string" }, { "$ref": "Optional.Number", "description": "Vertical shift 1.0 means shift to bottom" } ] }, "zoom": { "default": null, "type": [ { "enums": [ "increase", "decrease" ], "type": "string" }, { "$ref": "Optional.Number", "description": "Zoom where 1.0 means 100%" } ] } }, "required": true, "type": "object" } |
Player.Id
Type: integer
JSON Schema Description |
---|
{ "default": -1, "id": "Player.Id", "maximum": 2, "minimum": 0, "type": "integer" } |
Player.Notifications.Data
Type: object
Properties:
- Notifications.Item item
- Player.Notifications.Player player
JSON Schema Description |
---|
{ "id": "Player.Notifications.Data", "properties": { "item": { "$ref": "Notifications.Item", "required": true }, "player": { "$ref": "Player.Notifications.Player", "required": true } }, "type": "object" } |
Player.Notifications.Player
Type: object
Properties:
- Player.Id playerid
- [integer speed]
JSON Schema Description |
---|
{ "id": "Player.Notifications.Player", "properties": { "playerid": { "$ref": "Player.Id", "required": true }, "speed": { "default": 0, "type": "integer" } }, "type": "object" } |
Player.Notifications.Player.Seek
Extends:
Properties:
- [Global.Time seekoffset]
- [Global.Time time]
JSON Schema Description |
---|
{ "extends": "Player.Notifications.Player", "id": "Player.Notifications.Player.Seek", "properties": { "seekoffset": { "$ref": "Global.Time", "description": "A duration." }, "time": { "$ref": "Global.Time", "description": "A duration." } } } |
Player.Position.Percentage
Type: number
JSON Schema Description |
---|
{ "default": 0.0, "id": "Player.Position.Percentage", "maximum": 100.0, "minimum": 0.0, "type": "number" } |
Player.Position.Time
Type: object
Properties:
- [integer hours]
- [integer milliseconds]
- [integer minutes]
- [integer seconds]
JSON Schema Description |
---|
{ "additionalProperties": false, "description": "A position in duration.", "id": "Player.Position.Time", "properties": { "hours": { "default": 0, "minimum": 0, "type": "integer" }, "milliseconds": { "default": 0, "maximum": 999, "minimum": 0, "type": "integer" }, "minutes": { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, "seconds": { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" } }, "type": "object" } |
Player.Property.Name
Type: string
JSON Schema Description |
---|
{ "default": "type", "enums": [ "type", "partymode", "speed", "time", "percentage", "totaltime", "playlistid", "position", "repeat", "shuffled", "canseek", "canchangespeed", "canmove", "canzoom", "canrotate", "canshuffle", "canrepeat", "currentaudiostream", "audiostreams", "subtitleenabled", "currentsubtitle", "subtitles", "live", "currentvideostream", "videostreams", "cachepercentage" ], "id": "Player.Property.Name", "type": "string" } |
Player.Property.Value
Type: object
Properties:
- [array audiostreams]
- [Player.Position.Percentage cachepercentage]
- [boolean canchangespeed]
- [boolean canmove]
- [boolean canrepeat]
- [boolean canrotate]
- [boolean canseek]
- [boolean canshuffle]
- [boolean canzoom]
- [Player.Audio.Stream currentaudiostream]
- [Player.Subtitle currentsubtitle]
- [Player.Video.Stream currentvideostream]
- [boolean live]
- [boolean partymode]
- [Player.Position.Percentage percentage]
- [Playlist.Id playlistid = -1]
- [Playlist.Position position = -1]
- [Player.Repeat repeat = off]
- [boolean shuffled]
- [integer speed]
- [boolean subtitleenabled]
- [array subtitles]
- [Global.Time time]
- [Global.Time totaltime]
- [Player.Type type = video]
- [array videostreams]
JSON Schema Description |
---|
{ "id": "Player.Property.Value", "properties": { "audiostreams": { "items": { "$ref": "Player.Audio.Stream" }, "type": "array" }, "cachepercentage": { "$ref": "Player.Position.Percentage", "default": 0.0 }, "canchangespeed": { "default": false, "type": "boolean" }, "canmove": { "default": false, "type": "boolean" }, "canrepeat": { "default": false, "type": "boolean" }, "canrotate": { "default": false, "type": "boolean" }, "canseek": { "default": false, "type": "boolean" }, "canshuffle": { "default": false, "type": "boolean" }, "canzoom": { "default": false, "type": "boolean" }, "currentaudiostream": { "$ref": "Player.Audio.Stream" }, "currentsubtitle": { "$ref": "Player.Subtitle" }, "currentvideostream": { "$ref": "Player.Video.Stream" }, "live": { "default": false, "type": "boolean" }, "partymode": { "default": false, "type": "boolean" }, "percentage": { "$ref": "Player.Position.Percentage", "default": 0.0 }, "playlistid": { "$ref": "Playlist.Id", "default": -1 }, "position": { "$ref": "Playlist.Position", "default": -1 }, "repeat": { "$ref": "Player.Repeat", "default": "off" }, "shuffled": { "default": false, "type": "boolean" }, "speed": { "default": 0, "type": "integer" }, "subtitleenabled": { "default": false, "type": "boolean" }, "subtitles": { "items": { "$ref": "Player.Subtitle" }, "type": "array" }, "time": { "$ref": "Global.Time", "description": "A duration." }, "totaltime": { "$ref": "Global.Time", "description": "A duration." }, "type": { "$ref": "Player.Type", "default": "video" }, "videostreams": { "items": { "$ref": "Player.Video.Stream" }, "type": "array" } }, "type": "object" } |
Player.Repeat
Type: string
JSON Schema Description |
---|
{ "default": "off", "enums": [ "off", "one", "all" ], "id": "Player.Repeat", "type": "string" } |
Player.Speed
Type: object
Properties:
- [integer speed]
JSON Schema Description |
---|
{ "id": "Player.Speed", "properties": { "speed": { "default": 0, "type": "integer" } }, "required": true, "type": "object" } |
Player.Subtitle
Type: object
Properties:
- integer index
- boolean isdefault
- boolean isforced
- boolean isimpaired
- string language
- string name
JSON Schema Description |
---|
{ "id": "Player.Subtitle", "properties": { "index": { "minimum": 0, "required": true, "type": "integer" }, "isdefault": { "required": true, "type": "boolean" }, "isforced": { "required": true, "type": "boolean" }, "isimpaired": { "required": true, "type": "boolean" }, "language": { "required": true, "type": "string" }, "name": { "required": true, "type": "string" } }, "type": "object" } |
Player.Type
Type: string
JSON Schema Description |
---|
{ "default": "video", "enums": [ "video", "audio", "picture" ], "id": "Player.Type", "type": "string" } |
Player.Video.Stream
Type: object
Properties:
- string codec
- integer height
- integer index
- string language
- string name
- integer width
JSON Schema Description |
---|
{ "id": "Player.Video.Stream", "properties": { "codec": { "required": true, "type": "string" }, "height": { "required": true, "type": "integer" }, "index": { "minimum": 0, "required": true, "type": "integer" }, "language": { "required": true, "type": "string" }, "name": { "required": true, "type": "string" }, "width": { "required": true, "type": "integer" } }, "type": "object" } |
Player.ViewMode
Type: string
JSON Schema Description |
---|
{ "default": "normal", "enums": [ "normal", "zoom", "stretch4x3", "widezoom", "stretch16x9", "original", "stretch16x9nonlin", "zoom120width", "zoom110width" ], "id": "Player.ViewMode", "type": "string" } |
Playlist
Playlist.Id
Type: integer
JSON Schema Description |
---|
{ "default": -1, "id": "Playlist.Id", "maximum": 2, "minimum": 0, "type": "integer" } |
Playlist.Item
Type: mixed
JSON Schema Description |
---|
{ "id": "Playlist.Item", "type": [ { "additionalProperties": false, "properties": { "file": { "description": "Path to a file (not a directory) to be added to the playlist", "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "directory": { "required": true, "type": "string" }, "media": { "$ref": "Files.Media", "default": "files" }, "recursive": { "default": false, "type": "boolean" } }, "type": "object" }, { "additionalProperties": false, "properties": { "movieid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "episodeid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "musicvideoid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "albumid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "songid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "description": "Identification of a genre from the AudioLibrary", "required": true } }, "type": "object" } ] } |
Playlist.Position
Type: integer
JSON Schema Description |
---|
{ "default": -1, "id": "Playlist.Position", "minimum": 0, "type": "integer" } |
Playlist.Property.Name
Type: string
JSON Schema Description |
---|
{ "default": "type", "enums": [ "type", "size" ], "id": "Playlist.Property.Name", "type": "string" } |
Playlist.Property.Value
Type: object
Properties:
- [integer size]
- [Playlist.Type type = unknown]
JSON Schema Description |
---|
{ "id": "Playlist.Property.Value", "properties": { "size": { "default": 0, "minimum": 0, "type": "integer" }, "type": { "$ref": "Playlist.Type", "default": "unknown" } }, "type": "object" } |
Playlist.Type
Type: string
JSON Schema Description |
---|
{ "default": "unknown", "enums": [ "unknown", "video", "audio", "picture", "mixed" ], "id": "Playlist.Type", "type": "string" } |
Profiles
Profiles.Details.Profile
Extends:
Properties:
- [integer lockmode]
- [string thumbnail]
JSON Schema Description |
---|
{ "extends": "Item.Details.Base", "id": "Profiles.Details.Profile", "properties": { "lockmode": { "default": 0, "type": "integer" }, "thumbnail": { "default": "", "type": "string" } } } |
Profiles.Fields.Profile
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Profiles.Fields.Profile", "items": { "enums": [ "thumbnail", "lockmode" ], "type": "string" } } |
Profiles.Password
Type: object
Properties:
- [string encryption = md5]
- string value
JSON Schema Description |
---|
{ "id": "Profiles.Password", "properties": { "encryption": { "default": "md5", "description": "Password Encryption", "enums": [ "none", "md5" ], "type": "string" }, "value": { "description": "Password", "required": true, "type": "string" } }, "type": "object" } |
Setting
Setting.Details.Base
Type: object
Properties:
- [string help]
- string id
- string label
JSON Schema Description |
---|
{ "id": "Setting.Details.Base", "properties": { "help": { "default": "", "type": "string" }, "id": { "minLength": 1, "required": true, "type": "string" }, "label": { "required": true, "type": "string" } }, "type": "object" } |
Setting.Details.Category
Extends:
Properties:
- [array groups]
JSON Schema Description |
---|
{ "additionalProperties": false, "extends": "Setting.Details.Base", "id": "Setting.Details.Category", "properties": { "groups": { "items": { "$ref": "Setting.Details.Group" }, "minItems": 1, "type": "array", "uniqueItems": true } } } |
Setting.Details.Control
Type: mixed
JSON Schema Description |
---|
{ "id": "Setting.Details.Control", "type": [ { "$ref": "Setting.Details.ControlCheckmark" }, { "$ref": "Setting.Details.ControlSpinner" }, { "$ref": "Setting.Details.ControlEdit" }, { "$ref": "Setting.Details.ControlButton" }, { "$ref": "Setting.Details.ControlList" }, { "$ref": "Setting.Details.ControlSlider" }, { "$ref": "Setting.Details.ControlRange" }, { "$ref": "Setting.Details.ControlLabel" } ] } |
Setting.Details.ControlBase
Type: object
Properties:
- boolean delayed
- string format
- string type
JSON Schema Description |
---|
{ "id": "Setting.Details.ControlBase", "properties": { "delayed": { "required": true, "type": "boolean" }, "format": { "required": true, "type": "string" }, "type": { "required": true, "type": "string" } }, "type": "object" } |
Setting.Details.ControlButton
Extends:
Properties:
- string type
JSON Schema Description |
---|
{ "extends": "Setting.Details.ControlHeading", "id": "Setting.Details.ControlButton", "properties": { "type": { "enums": [ "button" ], "required": true, "type": "string" } } } |
Setting.Details.ControlCheckmark
Extends:
Properties:
- string format
- string type
JSON Schema Description |
---|
{ "extends": "Setting.Details.ControlBase", "id": "Setting.Details.ControlCheckmark", "properties": { "format": { "enums": [ "boolean" ], "required": true, "type": "string" }, "type": { "enums": [ "toggle" ], "required": true, "type": "string" } } } |
Setting.Details.ControlEdit
Extends:
Properties:
- boolean hidden
- string type
- boolean verifynewvalue
JSON Schema Description |
---|
{ "extends": "Setting.Details.ControlHeading", "id": "Setting.Details.ControlEdit", "properties": { "hidden": { "required": true, "type": "boolean" }, "type": { "enums": [ "edit" ], "required": true, "type": "string" }, "verifynewvalue": { "required": true, "type": "boolean" } } } |
Setting.Details.ControlHeading
Extends:
Properties:
- [string heading]
JSON Schema Description |
---|
{ "extends": "Setting.Details.ControlBase", "id": "Setting.Details.ControlHeading", "properties": { "heading": { "default": "", "type": "string" } } } |
Setting.Details.ControlLabel
Extends:
Properties:
- string format
- string type
JSON Schema Description |
---|
{ "extends": "Setting.Details.ControlBase", "id": "Setting.Details.ControlLabel", "properties": { "format": { "enums": [ "string" ], "required": true, "type": "string" }, "type": { "enums": [ "label" ], "required": true, "type": "string" } } } |
Setting.Details.ControlList
Extends:
Properties:
- boolean multiselect
- string type
JSON Schema Description |
---|
{ "extends": "Setting.Details.ControlHeading", "id": "Setting.Details.ControlList", "properties": { "multiselect": { "required": true, "type": "boolean" }, "type": { "enums": [ "list" ], "required": true, "type": "string" } } } |
Setting.Details.ControlRange
Extends:
Properties:
- string formatlabel
- string formatvalue
- string type
JSON Schema Description |
---|
{ "extends": "Setting.Details.ControlBase", "id": "Setting.Details.ControlRange", "properties": { "formatlabel": { "required": true, "type": "string" }, "formatvalue": { "required": true, "type": "string" }, "type": { "enums": [ "range" ], "required": true, "type": "string" } } } |
Setting.Details.ControlSlider
Extends:
Properties:
- string formatlabel
- boolean popup
- string type
JSON Schema Description |
---|
{ "extends": "Setting.Details.ControlHeading", "id": "Setting.Details.ControlSlider", "properties": { "formatlabel": { "required": true, "type": "string" }, "popup": { "required": true, "type": "boolean" }, "type": { "enums": [ "slider" ], "required": true, "type": "string" } } } |
Setting.Details.ControlSpinner
Extends:
Properties:
- [string formatlabel]
- [string minimumlabel]
- string type
JSON Schema Description |
---|
{ "extends": "Setting.Details.ControlBase", "id": "Setting.Details.ControlSpinner", "properties": { "formatlabel": { "default": "", "type": "string" }, "minimumlabel": { "default": "", "type": "string" }, "type": { "enums": [ "spinner" ], "required": true, "type": "string" } } } |
Setting.Details.Group
Type: object
Properties:
- string id
- [array settings]
JSON Schema Description |
---|
{ "additionalProperties": false, "id": "Setting.Details.Group", "properties": { "id": { "minLength": 1, "required": true, "type": "string" }, "settings": { "items": { "$ref": "Setting.Details.Setting" }, "minItems": 1, "type": "array", "uniqueItems": true } }, "type": "object" } |
Setting.Details.Section
Extends:
Properties:
- [array categories]
JSON Schema Description |
---|
{ "additionalProperties": false, "extends": "Setting.Details.Base", "id": "Setting.Details.Section", "properties": { "categories": { "items": { "$ref": "Setting.Details.Category" }, "minItems": 1, "type": "array", "uniqueItems": true } } } |
Setting.Details.Setting
Type: mixed
JSON Schema Description |
---|
{ "id": "Setting.Details.Setting", "type": [ { "$ref": "Setting.Details.SettingBool" }, { "$ref": "Setting.Details.SettingInt" }, { "$ref": "Setting.Details.SettingNumber" }, { "$ref": "Setting.Details.SettingString" }, { "$ref": "Setting.Details.SettingAction" }, { "$ref": "Setting.Details.SettingList" }, { "$ref": "Setting.Details.SettingPath" }, { "$ref": "Setting.Details.SettingAddon" }, { "$ref": "Setting.Details.SettingDate" }, { "$ref": "Setting.Details.SettingTime" } ] } |
Setting.Details.SettingAction
Extends:
Properties:
- string data
JSON Schema Description |
---|
{ "additionalProperties": false, "extends": "Setting.Details.SettingBase", "id": "Setting.Details.SettingAction", "properties": { "data": { "required": true, "type": "string" } } } |
Setting.Details.SettingAddon
Extends:
Properties:
- Addon.Types addontype
JSON Schema Description |
---|
{ "additionalProperties": false, "extends": "Setting.Details.SettingString", "id": "Setting.Details.SettingAddon", "properties": { "addontype": { "$ref": "Addon.Types", "required": true } } } |
Setting.Details.SettingBase
Extends:
Properties:
- [Setting.Details.Control control]
- boolean enabled
- Setting.Level level
- [string parent]
- Setting.Type type
JSON Schema Description |
---|
{ "additionalProperties": false, "extends": "Setting.Details.Base", "id": "Setting.Details.SettingBase", "properties": { "control": { "$ref": "Setting.Details.Control" }, "enabled": { "required": true, "type": "boolean" }, "level": { "$ref": "Setting.Level", "required": true }, "parent": { "default": "", "type": "string" }, "type": { "$ref": "Setting.Type", "required": true } } } |
Setting.Details.SettingBool
Extends:
Properties:
- boolean default
- boolean value
JSON Schema Description |
---|
{ "additionalProperties": false, "extends": "Setting.Details.SettingBase", "id": "Setting.Details.SettingBool", "properties": { "default": { "required": true, "type": "boolean" }, "value": { "required": true, "type": "boolean" } } } |
Setting.Details.SettingDate
Extends:
JSON Schema Description |
---|
{ "additionalProperties": false, "extends": "Setting.Details.SettingString", "id": "Setting.Details.SettingDate" } |
Setting.Details.SettingInt
Extends:
Properties:
- integer default
- [integer maximum]
- [integer minimum]
- [array options]
- [integer step]
- integer value
JSON Schema Description |
---|
{ "additionalProperties": false, "extends": "Setting.Details.SettingBase", "id": "Setting.Details.SettingInt", "properties": { "default": { "required": true, "type": "integer" }, "maximum": { "default": 0, "type": "integer" }, "minimum": { "default": 0, "type": "integer" }, "options": { "items": { "properties": { "label": { "required": true, "type": "string" }, "value": { "required": true, "type": "integer" } }, "type": "object" }, "type": "array" }, "step": { "default": 0, "type": "integer" }, "value": { "required": true, "type": "integer" } } } |
Setting.Details.SettingList
Extends:
Properties:
- Setting.Value.List default
- Setting.Details.Setting definition
- string delimiter
- Setting.Type elementtype
- [integer maximumitems]
- [integer minimumitems]
- Setting.Value.List value
JSON Schema Description |
---|
{ "additionalProperties": false, "extends": "Setting.Details.SettingBase", "id": "Setting.Details.SettingList", "properties": { "default": { "$ref": "Setting.Value.List", "required": true }, "definition": { "$ref": "Setting.Details.Setting", "required": true }, "delimiter": { "required": true, "type": "string" }, "elementtype": { "$ref": "Setting.Type", "required": true }, "maximumitems": { "default": 0, "type": "integer" }, "minimumitems": { "default": 0, "type": "integer" }, "value": { "$ref": "Setting.Value.List", "required": true } } } |
Setting.Details.SettingNumber
Extends:
Properties:
- number default
- number maximum
- number minimum
- number step
- number value
JSON Schema Description |
---|
{ "additionalProperties": false, "extends": "Setting.Details.SettingBase", "id": "Setting.Details.SettingNumber", "properties": { "default": { "required": true, "type": "number" }, "maximum": { "required": true, "type": "number" }, "minimum": { "required": true, "type": "number" }, "step": { "required": true, "type": "number" }, "value": { "required": true, "type": "number" } } } |
Setting.Details.SettingPath
Extends:
Properties:
- [array sources]
- boolean writable
JSON Schema Description |
---|
{ "additionalProperties": false, "extends": "Setting.Details.SettingString", "id": "Setting.Details.SettingPath", "properties": { "sources": { "items": { "type": "string" }, "type": "array" }, "writable": { "required": true, "type": "boolean" } } } |
Setting.Details.SettingString
Extends:
Properties:
- boolean allowempty
- string default
- [array options]
- string value
JSON Schema Description |
---|
{ "extends": "Setting.Details.SettingBase", "id": "Setting.Details.SettingString", "properties": { "allowempty": { "required": true, "type": "boolean" }, "default": { "required": true, "type": "string" }, "options": { "items": { "properties": { "label": { "required": true, "type": "string" }, "value": { "required": true, "type": "string" } }, "type": "object" }, "type": "array" }, "value": { "required": true, "type": "string" } } } |
Setting.Details.SettingTime
Extends:
JSON Schema Description |
---|
{ "additionalProperties": false, "extends": "Setting.Details.SettingString", "id": "Setting.Details.SettingTime" } |
Setting.Level
Type: string
JSON Schema Description |
---|
{ "default": "basic", "enums": [ "basic", "standard", "advanced", "expert" ], "id": "Setting.Level", "type": "string" } |
Setting.Type
Type: string
JSON Schema Description |
---|
{ "default": "boolean", "enums": [ "boolean", "integer", "number", "string", "action", "list", "path", "addon", "date", "time" ], "id": "Setting.Type", "type": "string" } |
Setting.Value
Type: mixed
JSON Schema Description |
---|
{ "default": null, "id": "Setting.Value", "type": [ { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "string" } ] } |
Setting.Value.Extended
Type: mixed
JSON Schema Description |
---|
{ "default": null, "id": "Setting.Value.Extended", "type": [ { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "string" }, { "$ref": "Setting.Value.List" } ] } |
Setting.Value.List
Type: array
JSON Schema Description |
---|
{ "id": "Setting.Value.List", "items": { "$ref": "Setting.Value" }, "type": "array" } |
System
System.Property.Name
Type: string
JSON Schema Description |
---|
{ "default": "canshutdown", "enums": [ "canshutdown", "cansuspend", "canhibernate", "canreboot" ], "id": "System.Property.Name", "type": "string" } |
System.Property.Value
Type: object
Properties:
- [boolean canhibernate]
- [boolean canreboot]
- [boolean canshutdown]
- [boolean cansuspend]
JSON Schema Description |
---|
{ "id": "System.Property.Value", "properties": { "canhibernate": { "default": false, "type": "boolean" }, "canreboot": { "default": false, "type": "boolean" }, "canshutdown": { "default": false, "type": "boolean" }, "cansuspend": { "default": false, "type": "boolean" } }, "type": "object" } |
Textures
Textures.Details.Size
Type: object
Properties:
- [integer height]
- [string lastused]
- [integer size]
- [integer usecount]
- [integer width]
JSON Schema Description |
---|
{ "id": "Textures.Details.Size", "properties": { "height": { "default": 0, "description": "Height of texture", "type": "integer" }, "lastused": { "default": "", "description": "Date of last use", "type": "string" }, "size": { "default": 0, "description": "Size of the texture (1 == largest)", "type": "integer" }, "usecount": { "default": 0, "description": "Number of uses", "type": "integer" }, "width": { "default": 0, "description": "Width of texture", "type": "integer" } }, "type": "object" } |
Textures.Details.Texture
Type: object
Properties:
- [string cachedurl]
- [string imagehash]
- [string lasthashcheck]
- [array sizes]
- [Library.Id textureid = -1]
- [string url]
JSON Schema Description |
---|
{ "id": "Textures.Details.Texture", "properties": { "cachedurl": { "default": "", "description": "Cached URL on disk", "type": "string" }, "imagehash": { "default": "", "description": "Hash of image", "type": "string" }, "lasthashcheck": { "default": "", "description": "Last time source was checked for changes", "type": "string" }, "sizes": { "items": { "$ref": "Textures.Details.Size" }, "type": "array" }, "textureid": { "$ref": "Library.Id", "default": -1 }, "url": { "default": "", "description": "Original source URL", "type": "string" } }, "type": "object" } |
Textures.Fields.Texture
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Textures.Fields.Texture", "items": { "enums": [ "url", "cachedurl", "lasthashcheck", "imagehash", "sizes" ], "type": "string" } } |
Video
Video.Cast
Type: array
JSON Schema Description |
---|
{ "id": "Video.Cast", "items": { "additionalProperties": false, "properties": { "name": { "required": true, "type": "string" }, "order": { "required": true, "type": "integer" }, "role": { "required": true, "type": "string" }, "thumbnail": { "default": "", "type": "string" } }, "type": "object" }, "type": "array" } |
Video.Details.Base
Extends:
Properties:
- [Media.Artwork art]
- [integer playcount]
JSON Schema Description |
---|
{ "extends": "Media.Details.Base", "id": "Video.Details.Base", "properties": { "art": { "$ref": "Media.Artwork" }, "playcount": { "default": 0, "type": "integer" } } } |
Video.Details.Episode
Extends:
Properties:
- [Video.Cast cast]
- [integer episode]
- Library.Id episodeid
- [string firstaired]
- [string originaltitle]
- [string productioncode]
- [number rating]
- [any ratings]
- [integer season]
- [Library.Id seasonid = -1]
- [string showtitle]
- [integer specialsortepisode]
- [integer specialsortseason]
- [Library.Id tvshowid = -1]
- [Media.UniqueID uniqueid]
- [integer userrating]
- [string votes]
- [Array.String writer]
JSON Schema Description |
---|
{ "extends": "Video.Details.File", "id": "Video.Details.Episode", "properties": { "cast": { "$ref": "Video.Cast" }, "episode": { "default": 0, "type": "integer" }, "episodeid": { "$ref": "Library.Id", "required": true }, "firstaired": { "default": "", "type": "string" }, "originaltitle": { "default": "", "type": "string" }, "productioncode": { "default": "", "type": "string" }, "rating": { "default": 0.0, "type": "number" }, "ratings": { "default": null, "type": "any" }, "season": { "default": 0, "type": "integer" }, "seasonid": { "$ref": "Library.Id", "default": -1 }, "showtitle": { "default": "", "type": "string" }, "specialsortepisode": { "default": 0, "type": "integer" }, "specialsortseason": { "default": 0, "type": "integer" }, "tvshowid": { "$ref": "Library.Id", "default": -1 }, "uniqueid": { "$ref": "Media.UniqueID" }, "userrating": { "default": 0, "type": "integer" }, "votes": { "default": "", "type": "string" }, "writer": { "$ref": "Array.String" } } } |
Video.Details.File
Extends:
Properties:
- [Array.String director]
- [Video.Resume resume]
- [integer runtime]
- [Video.Streams streamdetails]
JSON Schema Description |
---|
{ "extends": "Video.Details.Item", "id": "Video.Details.File", "properties": { "director": { "$ref": "Array.String" }, "resume": { "$ref": "Video.Resume" }, "runtime": { "default": 0, "description": "Runtime in seconds", "type": "integer" }, "streamdetails": { "$ref": "Video.Streams" } } } |
Video.Details.Item
Extends:
Properties:
- [string dateadded]
- [string file]
- [string lastplayed]
- [string plot]
JSON Schema Description |
---|
{ "extends": "Video.Details.Media", "id": "Video.Details.Item", "properties": { "dateadded": { "default": "", "type": "string" }, "file": { "default": "", "type": "string" }, "lastplayed": { "default": "", "type": "string" }, "plot": { "default": "", "type": "string" } } } |
Video.Details.Media
Extends:
Properties:
- [string title]
JSON Schema Description |
---|
{ "extends": "Video.Details.Base", "id": "Video.Details.Media", "properties": { "title": { "default": "", "type": "string" } } } |
Video.Details.Movie
Extends:
Properties:
- [Video.Cast cast]
- [Array.String country]
- [Array.String genre]
- [string imdbnumber]
- Library.Id movieid
- [string mpaa]
- [string originaltitle]
- [string plotoutline]
- [string premiered]
- [number rating]
- [any ratings]
- [string set]
- [Library.Id setid = -1]
- [Array.String showlink]
- [string sorttitle]
- [Array.String studio]
- [Array.String tag]
- [string tagline]
- [integer top250]
- [string trailer]
- [Media.UniqueID uniqueid]
- [integer userrating]
- [string votes]
- [Array.String writer]
- [integer year]
JSON Schema Description |
---|
{ "extends": "Video.Details.File", "id": "Video.Details.Movie", "properties": { "cast": { "$ref": "Video.Cast" }, "country": { "$ref": "Array.String" }, "genre": { "$ref": "Array.String" }, "imdbnumber": { "default": "", "type": "string" }, "movieid": { "$ref": "Library.Id", "required": true }, "mpaa": { "default": "", "type": "string" }, "originaltitle": { "default": "", "type": "string" }, "plotoutline": { "default": "", "type": "string" }, "premiered": { "default": "", "type": "string" }, "rating": { "default": 0.0, "type": "number" }, "ratings": { "default": null, "type": "any" }, "set": { "default": "", "type": "string" }, "setid": { "$ref": "Library.Id", "default": -1 }, "showlink": { "$ref": "Array.String" }, "sorttitle": { "default": "", "type": "string" }, "studio": { "$ref": "Array.String" }, "tag": { "$ref": "Array.String" }, "tagline": { "default": "", "type": "string" }, "top250": { "default": 0, "type": "integer" }, "trailer": { "default": "", "type": "string" }, "uniqueid": { "$ref": "Media.UniqueID" }, "userrating": { "default": 0, "type": "integer" }, "votes": { "default": "", "type": "string" }, "writer": { "$ref": "Array.String" }, "year": { "default": 0, "type": "integer" } } } |
Video.Details.MovieSet
Extends:
Properties:
- [string plot]
- Library.Id setid
JSON Schema Description |
---|
{ "extends": "Video.Details.Media", "id": "Video.Details.MovieSet", "properties": { "plot": { "default": "", "type": "string" }, "setid": { "$ref": "Library.Id", "required": true } } } |
Video.Details.MovieSet.Extended
Extends:
Properties:
- List.LimitsReturned limits
- [array movies]
JSON Schema Description |
---|
{ "extends": "Video.Details.MovieSet", "id": "Video.Details.MovieSet.Extended", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "movies": { "items": { "$ref": "Video.Details.Movie" }, "type": "array" } } } |
Video.Details.MusicVideo
Extends:
Properties:
- [string album]
- [Array.String artist]
- [Array.String genre]
- Library.Id musicvideoid
- [string premiered]
- [number rating]
- [Array.String studio]
- [Array.String tag]
- [integer track]
- [integer userrating]
- [integer year]
JSON Schema Description |
---|
{ "extends": "Video.Details.File", "id": "Video.Details.MusicVideo", "properties": { "album": { "default": "", "type": "string" }, "artist": { "$ref": "Array.String" }, "genre": { "$ref": "Array.String" }, "musicvideoid": { "$ref": "Library.Id", "required": true }, "premiered": { "default": "", "type": "string" }, "rating": { "default": 0.0, "type": "number" }, "studio": { "$ref": "Array.String" }, "tag": { "$ref": "Array.String" }, "track": { "default": 0, "type": "integer" }, "userrating": { "default": 0, "type": "integer" }, "year": { "default": 0, "type": "integer" } } } |
Video.Details.Season
Extends:
Properties:
- [integer episode]
- integer season
- Library.Id seasonid
- [string showtitle]
- [string title]
- [Library.Id tvshowid = -1]
- [integer userrating]
- [integer watchedepisodes]
JSON Schema Description |
---|
{ "extends": "Video.Details.Base", "id": "Video.Details.Season", "properties": { "episode": { "default": 0, "type": "integer" }, "season": { "required": true, "type": "integer" }, "seasonid": { "$ref": "Library.Id", "required": true }, "showtitle": { "default": "", "type": "string" }, "title": { "default": "", "type": "string" }, "tvshowid": { "$ref": "Library.Id", "default": -1 }, "userrating": { "default": 0, "type": "integer" }, "watchedepisodes": { "default": 0, "type": "integer" } } } |
Video.Details.TVShow
Extends:
Properties:
- [Video.Cast cast]
- [integer episode]
- [string episodeguide]
- [Array.String genre]
- [string imdbnumber]
- [string mpaa]
- [string originaltitle]
- [string premiered]
- [number rating]
- [any ratings]
- [integer runtime]
- [integer season]
- [string sorttitle]
- [string status]
- [Array.String studio]
- [Array.String tag]
- Library.Id tvshowid
- [Media.UniqueID uniqueid]
- [integer userrating]
- [string votes]
- [integer watchedepisodes]
- [integer year]
JSON Schema Description |
---|
{ "extends": "Video.Details.Item", "id": "Video.Details.TVShow", "properties": { "cast": { "$ref": "Video.Cast" }, "episode": { "default": 0, "type": "integer" }, "episodeguide": { "default": "", "type": "string" }, "genre": { "$ref": "Array.String" }, "imdbnumber": { "default": "", "type": "string" }, "mpaa": { "default": "", "type": "string" }, "originaltitle": { "default": "", "type": "string" }, "premiered": { "default": "", "type": "string" }, "rating": { "default": 0.0, "type": "number" }, "ratings": { "default": null, "type": "any" }, "runtime": { "default": 0, "description": "Runtime in seconds", "type": "integer" }, "season": { "default": 0, "type": "integer" }, "sorttitle": { "default": "", "type": "string" }, "status": { "default": "", "description": "Returns 'returning series', 'in production', 'planned', 'cancelled' or 'ended'", "type": "string" }, "studio": { "$ref": "Array.String" }, "tag": { "$ref": "Array.String" }, "tvshowid": { "$ref": "Library.Id", "required": true }, "uniqueid": { "$ref": "Media.UniqueID" }, "userrating": { "default": 0, "type": "integer" }, "votes": { "default": "", "type": "string" }, "watchedepisodes": { "default": 0, "type": "integer" }, "year": { "default": 0, "type": "integer" } } } |
Video.Fields.Episode
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Video.Fields.Episode", "items": { "description": "Requesting the cast, ratings, streamdetails, uniqueid and/or tag field will result in increased response times", "enums": [ "title", "plot", "votes", "rating", "writer", "firstaired", "playcount", "runtime", "director", "productioncode", "season", "episode", "originaltitle", "showtitle", "cast", "streamdetails", "lastplayed", "fanart", "thumbnail", "file", "resume", "tvshowid", "dateadded", "uniqueid", "art", "specialsortseason", "specialsortepisode", "userrating", "seasonid", "ratings" ], "type": "string" } } |
Video.Fields.Movie
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Video.Fields.Movie", "items": { "description": "Requesting the cast, ratings, showlink, streamdetails, uniqueid and/or tag field will result in increased response times", "enums": [ "title", "genre", "year", "rating", "director", "trailer", "tagline", "plot", "plotoutline", "originaltitle", "lastplayed", "playcount", "writer", "studio", "mpaa", "cast", "country", "imdbnumber", "runtime", "set", "showlink", "streamdetails", "top250", "votes", "fanart", "thumbnail", "file", "sorttitle", "resume", "setid", "dateadded", "tag", "art", "userrating", "ratings", "premiered", "uniqueid" ], "type": "string" } } |
Video.Fields.MovieSet
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Video.Fields.MovieSet", "items": { "enums": [ "title", "playcount", "fanart", "thumbnail", "art", "plot" ], "type": "string" } } |
Video.Fields.MusicVideo
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Video.Fields.MusicVideo", "items": { "description": "Requesting the streamdetails and/or tag field will result in increased response times", "enums": [ "title", "playcount", "runtime", "director", "studio", "year", "plot", "album", "artist", "genre", "track", "streamdetails", "lastplayed", "fanart", "thumbnail", "file", "resume", "dateadded", "tag", "art", "rating", "userrating", "premiered" ], "type": "string" } } |
Video.Fields.Season
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Video.Fields.Season", "items": { "enums": [ "season", "showtitle", "playcount", "episode", "fanart", "thumbnail", "tvshowid", "watchedepisodes", "art", "userrating", "title" ], "type": "string" } } |
Video.Fields.TVShow
Extends:
JSON Schema Description |
---|
{ "extends": "Item.Fields.Base", "id": "Video.Fields.TVShow", "items": { "description": "Requesting the cast, ratings, uniqueid and/or tag field will result in increased response times", "enums": [ "title", "genre", "year", "rating", "plot", "studio", "mpaa", "cast", "playcount", "episode", "imdbnumber", "premiered", "votes", "lastplayed", "fanart", "thumbnail", "file", "originaltitle", "sorttitle", "episodeguide", "season", "watchedepisodes", "dateadded", "tag", "art", "userrating", "ratings", "runtime", "uniqueid" ], "type": "string" } } |
Video.Rating
Type: object
Properties:
- [boolean default]
- number rating
- [integer votes]
JSON Schema Description |
---|
{ "id": "Video.Rating", "properties": { "default": { "default": false, "type": "boolean" }, "rating": { "required": true, "type": "number" }, "votes": { "default": 0, "type": "integer" } }, "type": "object" } |
Video.Ratings
Type: object
JSON Schema Description |
---|
{ "additionalProperties": { "$ref": "Video.Rating" }, "id": "Video.Ratings", "type": "object" } |
Video.Ratings.Set
Type: object
JSON Schema Description |
---|
{ "additionalProperties": { "default": null, "type": [ { "type": "null" }, { "$ref": "Video.Rating" } ] }, "id": "Video.Ratings.Set", "type": "object" } |
Video.Resume
Type: object
Properties:
- [number position]
- [number total]
JSON Schema Description |
---|
{ "additionalProperties": false, "id": "Video.Resume", "properties": { "position": { "default": 0.0, "minimum": 0.0, "type": "number" }, "total": { "default": 0.0, "minimum": 0.0, "type": "number" } }, "type": "object" } |
Video.Streams
Type: object
Properties:
- [array audio]
- [array subtitle]
- [array video]
JSON Schema Description |
---|
{ "additionalProperties": false, "id": "Video.Streams", "properties": { "audio": { "items": { "additionalProperties": false, "properties": { "channels": { "default": 0, "type": "integer" }, "codec": { "default": "", "type": "string" }, "language": { "default": "", "type": "string" } }, "type": "object" }, "minItems": 1, "type": "array" }, "subtitle": { "items": { "additionalProperties": false, "properties": { "language": { "default": "", "type": "string" } }, "type": "object" }, "minItems": 1, "type": "array" }, "video": { "items": { "additionalProperties": false, "properties": { "aspect": { "default": 0.0, "type": "number" }, "codec": { "default": "", "type": "string" }, "duration": { "default": 0, "type": "integer" }, "height": { "default": 0, "type": "integer" }, "width": { "default": 0, "type": "integer" } }, "type": "object" }, "minItems": 1, "type": "array" } }, "type": "object" } |
Notifications
Application
Application.OnVolumeChanged
The volume of the application has changed.
Parameters:
- string sender
- object data:
- boolean muted
- integer volume
JSON Schema Description |
---|
{ "description": "The volume of the application has changed.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "muted": { "required": true, "type": "boolean" }, "volume": { "maximum": 100, "minimum": 0, "required": true, "type": "integer" } }, "required": true, "type": "object" } ], "returns": null, "type": "notification" } |
AudioLibrary
AudioLibrary.OnCleanFinished
The audio library has been cleaned.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "The audio library has been cleaned.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
AudioLibrary.OnCleanStarted
An audio library clean operation has started.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "An audio library clean operation has started.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
AudioLibrary.OnExport
An audio library export has finished.
Parameters:
- string sender
- [object data]:
- [integer failcount = 0]
- [string file = ""]
JSON Schema Description |
---|
{ "description": "An audio library export has finished.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "failcount": { "default": 0, "minimum": 0, "required": false, "type": "integer" }, "file": { "default": "", "required": false, "type": "string" } }, "required": false, "type": "object" } ], "returns": null, "type": "notification" } |
AudioLibrary.OnRemove
An audio item has been removed.
Parameters:
- string sender
- object data:
- Library.Id id
- Optional.Boolean transaction
- Notifications.Library.Audio.Type type
JSON Schema Description |
---|
{ "description": "An audio item has been removed.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "id": { "$ref": "Library.Id", "required": true }, "transaction": { "$ref": "Optional.Boolean", "description": "True if the removal is being performed within a transaction." }, "type": { "$ref": "Notifications.Library.Audio.Type", "required": true } }, "required": true, "type": "object" } ], "returns": null, "type": "notification" } |
AudioLibrary.OnScanFinished
Scanning the audio library has been finished.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "Scanning the audio library has been finished.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
AudioLibrary.OnScanStarted
An audio library scan has started.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "An audio library scan has started.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
AudioLibrary.OnUpdate
An audio item has been updated.
Parameters:
- string sender
- object data:
- Optional.Boolean added
- Library.Id id
- Optional.Boolean transaction
- string type
JSON Schema Description |
---|
{ "description": "An audio item has been updated.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "added": { "$ref": "Optional.Boolean", "description": "True if the update is for a newly added item." }, "id": { "$ref": "Library.Id", "required": true }, "transaction": { "$ref": "Optional.Boolean", "description": "True if the update is being performed within a transaction." }, "type": { "enum": [ "song" ], "id": "Notifications.Library.Audio.Type", "required": true, "type": "string" } }, "required": true, "type": "object" } ], "returns": null, "type": "notification" } |
GUI
GUI.OnDPMSActivated
Energy saving/DPMS has been activated.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "Energy saving/DPMS has been activated.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
GUI.OnDPMSDeactivated
Energy saving/DPMS has been deactivated.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "Energy saving/DPMS has been deactivated.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
GUI.OnScreensaverActivated
The screensaver has been activated.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "The screensaver has been activated.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
GUI.OnScreensaverDeactivated
The screensaver has been deactivated.
Parameters:
- string sender
- object data:
- boolean shuttingdown
JSON Schema Description |
---|
{ "description": "The screensaver has been deactivated.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "shuttingdown": { "required": true, "type": "boolean" } }, "required": true, "type": "object" } ], "returns": null, "type": "notification" } |
Input
Input.OnInputFinished
The user has provided the requested input.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "The user has provided the requested input.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
Input.OnInputRequested
The user is requested to provide some information.
Parameters:
- string sender
- object data:
- string title
- string type
- string value
JSON Schema Description |
---|
{ "description": "The user is requested to provide some information.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "title": { "type": "string" }, "type": { "enum": [ "keyboard", "time", "date", "ip", "password", "numericpassword", "number", "seconds" ], "required": true, "type": "string" }, "value": { "required": true, "type": "string" } }, "required": true, "type": "object" } ], "returns": null, "type": "notification" } |
Player
Player.OnAVChange
Audio- or videostream has changed. If there is no ID available extra information will be provided.
Parameters:
- string sender
- Player.Notifications.Data data
JSON Schema Description |
---|
{ "description": "Audio- or videostream has changed. If there is no ID available extra information will be provided.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "$ref": "Player.Notifications.Data", "name": "data", "required": true } ], "returns": null, "type": "notification" } |
Player.OnAVStart
Playback of a media item has been started and first frame is available. If there is no ID available extra information will be provided.
Parameters:
- string sender
- Player.Notifications.Data data
JSON Schema Description |
---|
{ "description": "Playback of a media item has been started and first frame is available. If there is no ID available extra information will be provided.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "$ref": "Player.Notifications.Data", "name": "data", "required": true } ], "returns": null, "type": "notification" } |
Player.OnPause
Playback of a media item has been paused. If there is no ID available extra information will be provided.
Parameters:
- string sender
- Player.Notifications.Data data
JSON Schema Description |
---|
{ "description": "Playback of a media item has been paused. If there is no ID available extra information will be provided.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "$ref": "Player.Notifications.Data", "name": "data", "required": true } ], "returns": null, "type": "notification" } |
Player.OnPlay
Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.
Parameters:
- string sender
- Player.Notifications.Data data
JSON Schema Description |
---|
{ "description": "Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "$ref": "Player.Notifications.Data", "name": "data", "required": true } ], "returns": null, "type": "notification" } |
Player.OnPropertyChanged
A property of the playing items has changed.
Parameters:
- string sender
- object data:
- Player.Notifications.Player player
- Player.Property.Value property
JSON Schema Description |
---|
{ "description": "A property of the playing items has changed.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "player": { "$ref": "Player.Notifications.Player", "required": true }, "property": { "$ref": "Player.Property.Value" } }, "required": true, "type": "object" } ], "returns": null, "type": "notification" } |
Player.OnResume
Playback of a media item has been resumed. If there is no ID available extra information will be provided.
Parameters:
- string sender
- Player.Notifications.Data data
JSON Schema Description |
---|
{ "description": "Playback of a media item has been resumed. If there is no ID available extra information will be provided.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "$ref": "Player.Notifications.Data", "name": "data", "required": true } ], "returns": null, "type": "notification" } |
Player.OnSeek
The playback position has been changed. If there is no ID available extra information will be provided.
Parameters:
- string sender
- object data:
- Notifications.Item item
- Player.Notifications.Player.Seek player
JSON Schema Description |
---|
{ "description": "The playback position has been changed. If there is no ID available extra information will be provided.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "item": { "$ref": "Notifications.Item" }, "player": { "$ref": "Player.Notifications.Player.Seek", "required": true } }, "required": true, "type": "object" } ], "returns": null, "type": "notification" } |
Player.OnSpeedChanged
Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.
Parameters:
- string sender
- Player.Notifications.Data data
JSON Schema Description |
---|
{ "description": "Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "$ref": "Player.Notifications.Data", "name": "data", "required": true } ], "returns": null, "type": "notification" } |
Player.OnStop
Playback of a media item has been stopped. If there is no ID available extra information will be provided.
Parameters:
- string sender
- object data:
- boolean end
- Notifications.Item item
JSON Schema Description |
---|
{ "description": "Playback of a media item has been stopped. If there is no ID available extra information will be provided.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "end": { "description": "Whether the player has reached the end of the playable item(s) or not", "required": true, "type": "boolean" }, "item": { "$ref": "Notifications.Item" } }, "required": true, "type": "object" } ], "returns": null, "type": "notification" } |
Playlist
Playlist.OnAdd
A playlist item has been added.
Parameters:
- string sender
- object data:
- Notifications.Item item
- Playlist.Id playlistid
- Playlist.Position position
JSON Schema Description |
---|
{ "description": "A playlist item has been added.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "item": { "$ref": "Notifications.Item" }, "playlistid": { "$ref": "Playlist.Id", "required": true }, "position": { "$ref": "Playlist.Position" } }, "required": true, "type": "object" } ], "returns": null, "type": "notification" } |
Playlist.OnClear
A playlist item has been cleared.
Parameters:
- string sender
- object data:
- Playlist.Id playlistid
JSON Schema Description |
---|
{ "description": "A playlist item has been cleared.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "playlistid": { "$ref": "Playlist.Id", "required": true } }, "required": true, "type": "object" } ], "returns": null, "type": "notification" } |
Playlist.OnRemove
A playlist item has been removed.
Parameters:
- string sender
- object data:
- Playlist.Id playlistid
- Playlist.Position position
JSON Schema Description |
---|
{ "description": "A playlist item has been removed.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "playlistid": { "$ref": "Playlist.Id", "required": true }, "position": { "$ref": "Playlist.Position" } }, "required": true, "type": "object" } ], "returns": null, "type": "notification" } |
System
System.OnLowBattery
The system is on low battery.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "The system is on low battery.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
System.OnQuit
Kodi will be closed.
Parameters:
- string sender
- object data:
- integer exitcode
JSON Schema Description |
---|
{ "description": "Kodi will be closed.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "exitcode": { "minimum": 0, "required": true, "type": "integer" } }, "required": true, "type": "object" } ], "returns": null, "type": "notification" } |
System.OnRestart
The system will be restarted.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "The system will be restarted.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
System.OnSleep
The system will be suspended.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "The system will be suspended.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
System.OnWake
The system woke up from suspension.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "The system woke up from suspension.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
VideoLibrary
VideoLibrary.OnCleanFinished
The video library has been cleaned.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "The video library has been cleaned.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
VideoLibrary.OnCleanStarted
A video library clean operation has started.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "A video library clean operation has started.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
VideoLibrary.OnExport
A video library export has finished.
Parameters:
- string sender
- [object data]:
- [integer failcount = 0]
- [string file = ""]
- [string root = ""]
JSON Schema Description |
---|
{ "description": "A video library export has finished.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "failcount": { "default": 0, "minimum": 0, "required": false, "type": "integer" }, "file": { "default": "", "required": false, "type": "string" }, "root": { "default": "", "required": false, "type": "string" } }, "required": false, "type": "object" } ], "returns": null, "type": "notification" } |
VideoLibrary.OnRefresh
The video library has been refreshed and a home screen reload might be necessary.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "The video library has been refreshed and a home screen reload might be necessary.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
VideoLibrary.OnRemove
A video item has been removed.
Parameters:
- string sender
- object data:
- Library.Id id
- Optional.Boolean transaction
- Notifications.Library.Video.Type type
JSON Schema Description |
---|
{ "description": "A video item has been removed.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "id": { "$ref": "Library.Id", "required": true }, "transaction": { "$ref": "Optional.Boolean", "description": "True if the removal is being performed within a transaction." }, "type": { "$ref": "Notifications.Library.Video.Type", "required": true } }, "required": true, "type": "object" } ], "returns": null, "type": "notification" } |
VideoLibrary.OnScanFinished
Scanning the video library has been finished.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "Scanning the video library has been finished.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
VideoLibrary.OnScanStarted
A video library scan has started.
Parameters:
- string sender
- string data
JSON Schema Description |
---|
{ "description": "A video library scan has started.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "required": true, "type": "null" } ], "returns": null, "type": "notification" } |
VideoLibrary.OnUpdate
A video item has been updated.
Parameters:
- string sender
- object data:
- Optional.Boolean added
- Library.Id id
- integer playcount = -1
- Optional.Boolean transaction
- string type
JSON Schema Description |
---|
{ "description": "A video item has been updated.", "params": [ { "name": "sender", "required": true, "type": "string" }, { "name": "data", "properties": { "added": { "$ref": "Optional.Boolean", "description": "True if the update is for a newly added item." }, "id": { "$ref": "Library.Id", "required": true }, "playcount": { "default": -1, "minimum": 0, "type": "integer" }, "transaction": { "$ref": "Optional.Boolean", "description": "True if the update is being performed within a transaction." }, "type": { "enum": [ "movie", "tvshow", "episode", "musicvideo" ], "id": "Notifications.Library.Video.Type", "required": true, "type": "string" } }, "required": true, "type": "object" } ], "returns": null, "type": "notification" } |