Difference between revisions of "User:Ronie"

From Official Kodi Wiki
Jump to: navigation, search
(Replaced content with "File:ronie.jpg")
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{mininav|[[Development]]|[[JSON-RPC API]]}}
+
[[File:ronie.jpg]]
Version 12 is the current development version of Kodi's JSON-RPC API and will be published with the release of v19 (Matrix).<br />
 
This document has been updated to version 11.8.1. Recent changes are announced on the [https://forum.kodi.tv/showthread.php?tid=352779 forum]
 
 
 
It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.
 
 
 
 
 
{{TOC right}}
 
== JSON-RPC 2.0 compatibility ==
 
{| class="prettytable" style="margin-right: 0;"
 
!style="padding-left: 5px; width: 7em; text-align: left;"|Version
 
!style="padding-left: 10px; padding-right: 10px;"|Method calls
 
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(server-side)
 
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(client-side)
 
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-name
 
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-position
 
!style="padding-left: 10px; padding-right: 10px;"|Batch requests
 
|-
 
|style="padding-left: 5px;"|Version 6
 
|{{yes}}
 
|{{yes}}
 
|{{yes}}
 
|{{yes}}
 
|{{yes}}
 
|{{yes}}
 
|-
 
|}
 
 
 
== Documentation (JSON Schema) ==
 
=== Supported features of JSON Schema ===
 
<div style="float:left; margin-right:2em">
 
{| class="prettytable" style="margin-right: 0;"
 
!style="width: 10em; text-align: left;"|Schema
 
!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 type]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.2 properties]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.3 patternProperties]
 
|{{no}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.4 additionalProperties]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.5 items]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.6 additionalItems]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.7 required]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.8 dependencies]
 
|{{no}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.9 minimum]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.10 maximum]
 
|{{yes}}
 
|-
 
|}
 
</div>
 
 
 
<div style="float:left; margin-right:2em">
 
{| class="prettytable" style="margin-right: 0;"
 
!style="width: 10em; text-align: left;"|Schema
 
 
 
!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
 
 
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.11 exclusiveMinimum]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.12 exclusiveMaximum]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.13 minItems]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.14 maxItems]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.15 uniqueItems]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.16 pattern]
 
|{{no}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.17 minLength]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.18 maxLength]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.19 enum]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.20 default]
 
|{{yes}}
 
|-
 
|}
 
</div>
 
 
 
<div style="float:left;">
 
{| class="prettytable" style="margin-right: 0;"
 
!style="width: 10em; text-align: left;"|Schema
 
 
 
!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.21 title]
 
|{{no}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.22 description]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 format]
 
|{{no}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.24 divisibleBy]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.25 disallow]
 
|{{no}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.26 extends]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.27 id]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.28 $ref]
 
|{{yes}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.29 $schema]
 
|{{no}}
 
|-
 
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-6 Hyper Schema]
 
|{{no}}
 
|-
 
|}
 
</div>
 
<div style="clear:left;"></div>
 
 
 
== Error message ==
 
If Kodi detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is
 
{|
 
|
 
 
 
{
 
  "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:
 
{|
 
|
 
<pre>
 
Addons          List, enable and execute addons
 
Application      Application information and control
 
AudioLibrary    Audio Library information
 
Favourites      Favourites GetFavourites and AddFavourite
 
Files            Shares information & filesystem listings
 
GUI              Window properties and activation
 
Input            Allows limited navigation within Kodi
 
JSONRPC          A variety of standard JSONRPC calls
 
Player          Manages all available players
 
Playlist        Playlist modification
 
Profiles        Support for Profiles operations to xbmc.
 
PVR              Live TV control
 
Settings        Allows manipulation of Kodi settings.
 
System          System controls and information
 
Textures        Supplies GetTextures and RemoveTexture. Textures are images.
 
VideoLibrary    Video Library information
 
XBMC            Dumping ground for very Kodi specific operations
 
</pre>
 
|}
 
 
 
== Methods ==
 
=== Addons ===
 
==== Addons.ExecuteAddon ====
 
Executes the given addon with the given parameters (if possible)<br />
 
'''Permissions:'''
 
* ExecuteAddon
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' addonid<br />
 
# [''mixed: object|array|string'' params = ""]<br />
 
# [''boolean'' wait = False]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Executes the given addon with the given parameters (if possible)",
 
  "transport": "Response",
 
  "permission": "ExecuteAddon",
 
  "params": [
 
    {
 
      "name": "addonid",
 
      "type": "string",
 
      "required": true
 
    },
 
    {
 
      "name": "params",
 
      "type": [
 
        {
 
          "type": "object",
 
          "additionalProperties": {
 
            "type": "string"
 
          }
 
        },
 
        {
 
          "type": "array",
 
          "items": {
 
            "type": "string"
 
          }
 
        },
 
        {
 
          "type": "string",
 
          "description": "URL path (must start with / or ?"
 
        }
 
      ],
 
      "default": ""
 
    },
 
    {
 
      "name": "wait",
 
      "type": "boolean",
 
      "default": false
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== Addons.GetAddonDetails ====
 
Gets the details of a specific addon<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' addonid<br />
 
# [''[[#Addon.Fields|Addon.Fields]]'' properties]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# ''[[#Addon.Details|Addon.Details]]'' addon<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Gets the details of a specific addon",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "addonid",
 
      "type": "string",
 
      "required": true
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "Addon.Fields"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "addon": {
 
        "$ref": "Addon.Details",
 
        "required": true
 
      }
 
    }
 
  }
 
}
 
}}
 
==== Addons.GetAddons ====
 
Gets all available addons<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#Addon.Types|Addon.Types]]'' type]<br />
 
# [''[[#Addon.Content|Addon.Content]]'' content] (Content provided by the addon. Only considered for plugins and scripts.)<br />
 
# [''mixed: boolean|string'' enabled = all]<br />
 
# [''[[#Addon.Fields|Addon.Fields]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
# [''mixed: boolean|string'' installed = True]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# [''array[[#Addon.Details|Addon.Details]]'' addons]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Gets all available addons",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "type",
 
      "$ref": "Addon.Types"
 
    },
 
    {
 
      "name": "content",
 
      "$ref": "Addon.Content",
 
      "description": "Content provided by the addon. Only considered for plugins and scripts."
 
    },
 
    {
 
      "name": "enabled",
 
      "type": [
 
        {
 
          "type": "boolean"
 
        },
 
        {
 
          "type": "string",
 
          "enum": [
 
            "all"
 
          ]
 
        }
 
      ],
 
      "default": "all"
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "Addon.Fields"
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    },
 
    {
 
      "name": "installed",
 
      "type": [
 
        {
 
          "type": "boolean"
 
        },
 
        {
 
          "type": "string",
 
          "enum": [
 
            "all"
 
          ]
 
        }
 
      ],
 
      "default": true
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "addons": {
 
        "type": "array",
 
        "items": {
 
          "$ref": "Addon.Details"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== Addons.SetAddonEnabled ====
 
Enables/Disables a specific addon<br />
 
'''Permissions:'''
 
* ManageAddon
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' addonid<br />
 
# ''[[#Global.Toggle|Global.Toggle]]'' enabled<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Enables/Disables a specific addon",
 
  "transport": "Response",
 
  "permission": "ManageAddon",
 
  "params": [
 
    {
 
      "name": "addonid",
 
      "type": "string",
 
      "required": true
 
    },
 
    {
 
      "name": "enabled",
 
      "$ref": "Global.Toggle",
 
      "required": true
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
=== Application ===
 
==== Application.GetProperties ====
 
Retrieves the values of the given properties<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''array'' properties<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''[[#Application.Property.Value|Application.Property.Value]]''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieves the values of the given properties",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "properties",
 
      "type": "array",
 
      "uniqueItems": true,
 
      "required": true,
 
      "items": {
 
        "$ref": "Application.Property.Name"
 
      }
 
    }
 
  ],
 
  "returns": {
 
    "$ref": "Application.Property.Value",
 
    "required": true
 
  }
 
}
 
}}
 
==== Application.Quit ====
 
Quit application<br />
 
'''Permissions:'''
 
* ControlPower
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Quit application",
 
  "transport": "Response",
 
  "permission": "ControlPower",
 
  "params": [],
 
  "returns": "string"
 
}
 
}}
 
==== Application.SetMute ====
 
Toggle mute/unmute<br />
 
'''Permissions:'''
 
* ControlPlayback
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Global.Toggle|Global.Toggle]]'' mute<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''boolean (Mute state)''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Toggle mute/unmute",
 
  "transport": "Response",
 
  "permission": "ControlPlayback",
 
  "params": [
 
    {
 
      "name": "mute",
 
      "required": true,
 
      "$ref": "Global.Toggle"
 
    }
 
  ],
 
  "returns": {
 
    "type": "boolean",
 
    "description": "Mute state"
 
  }
 
}
 
}}
 
==== Application.SetVolume ====
 
Set the current volume<br />
 
'''Permissions:'''
 
* ControlPlayback
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''mixed: integer|[[#Global.IncrementDecrement|Global.IncrementDecrement]]'' volume<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''integer''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Set the current volume",
 
  "transport": "Response",
 
  "permission": "ControlPlayback",
 
  "params": [
 
    {
 
      "name": "volume",
 
      "type": [
 
        {
 
          "type": "integer",
 
          "minimum": 0,
 
          "maximum": 100,
 
          "required": true
 
        },
 
        {
 
          "$ref": "Global.IncrementDecrement",
 
          "required": true
 
        }
 
      ],
 
      "required": true
 
    }
 
  ],
 
  "returns": "integer"
 
}
 
}}
 
=== AudioLibrary ===
 
==== AudioLibrary.Clean ====
 
Cleans the audio library from non-existent items<br />
 
'''Permissions:'''
 
* RemoveData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Cleans the audio library from non-existent items",
 
  "transport": "Response",
 
  "permission": "RemoveData",
 
  "params": [
 
    {
 
      "name": "showdialogs",
 
      "type": "boolean",
 
      "default": true,
 
      "description": "Whether or not to show the progress bar or any other GUI dialog"
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== AudioLibrary.Export ====
 
Exports all items from the audio library<br />
 
'''Permissions:'''
 
* WriteFile
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''mixed: object|object'' options]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Exports all items from the audio library",
 
  "transport": "Response",
 
  "permission": "WriteFile",
 
  "params": [
 
    {
 
      "name": "options",
 
      "type": [
 
        {
 
          "type": "object",
 
          "required": true,
 
          "additionalProperties": false,
 
          "properties": {
 
            "path": {
 
              "type": "string",
 
              "required": true,
 
              "minLength": 1,
 
              "description": "Path to the directory to where the data should be exported"
 
            }
 
          }
 
        },
 
        {
 
          "type": "object",
 
          "required": true,
 
          "additionalProperties": false,
 
          "properties": {
 
            "overwrite": {
 
              "type": "boolean",
 
              "default": false,
 
              "description": "Whether to overwrite existing exported files"
 
            },
 
            "images": {
 
              "type": "boolean",
 
              "default": false,
 
              "description": "Whether to export thumbnails and fanart images"
 
            }
 
          }
 
        }
 
      ]
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== AudioLibrary.GetAlbumDetails ====
 
Retrieve details about a specific album<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' albumid<br />
 
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# [''[[#Audio.Details.Album|Audio.Details.Album]]'' albumdetails]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieve details about a specific album",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "albumid",
 
      "$ref": "Library.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "Audio.Fields.Album"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "albumdetails": {
 
        "$ref": "Audio.Details.Album"
 
      }
 
    }
 
  }
 
}
 
}}
 
==== AudioLibrary.GetAlbums ====
 
Retrieve all albums from specified artist (and role) or that has songs of the specified genre<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
# [''mixed: object|object|object|object|object|object|object|object|[[#List.Filter.Albums|List.Filter.Albums]]'' filter]<br />
 
# [''boolean'' includesingles = False]<br />
 
# [''boolean'' allroles = False] (Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.)<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# [''array[[#Audio.Details.Album|Audio.Details.Album]]'' albums]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieve all albums from specified artist (and role) or that has songs of the specified genre",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "properties",
 
      "$ref": "Audio.Fields.Album"
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    },
 
    {
 
      "name": "sort",
 
      "$ref": "List.Sort"
 
    },
 
    {
 
      "name": "filter",
 
      "type": [
 
        {
 
          "type": "object",
 
          "properties": {
 
            "genreid": {
 
              "$ref": "Library.Id",
 
              "required": true,
 
              "description": "Song genre. Filter for existence of songs with this genre"
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "genre": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true,
 
              "description": "Song genre. Filter for existence of songs with this genre"
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "artistid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "artistid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            },
 
            "roleid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "artistid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            },
 
            "role": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "artist": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "artist": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            },
 
            "roleid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "artist": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            },
 
            "role": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "$ref": "List.Filter.Albums"
 
        }
 
      ]
 
    },
 
    {
 
      "name": "includesingles",
 
      "type": "boolean",
 
      "default": false
 
    },
 
    {
 
      "name": "allroles",
 
      "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."
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "albums": {
 
        "type": "array",
 
        "items": {
 
          "$ref": "Audio.Details.Album"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== AudioLibrary.GetArtistDetails ====
 
Retrieve details about a specific artist<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' artistid<br />
 
# [''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# [''[[#Audio.Details.Artist|Audio.Details.Artist]]'' artistdetails]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieve details about a specific artist",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "artistid",
 
      "$ref": "Library.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "Audio.Fields.Artist"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "artistdetails": {
 
        "$ref": "Audio.Details.Artist"
 
      }
 
    }
 
  }
 
}
 
}}
 
==== AudioLibrary.GetArtists ====
 
Retrieve all artists. For backward compatibility by default this implicity does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#Optional.Boolean|Optional.Boolean]]'' albumartistsonly] (Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used)<br />
 
# [''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
# [''mixed: object|object|object|object|object|object|object|object|object|object|object|object|object|object|object|[[#List.Filter.Artists|List.Filter.Artists]]'' filter]<br />
 
# [''boolean'' allroles = False] (Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.)<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# [''array[[#Audio.Details.Artist|Audio.Details.Artist]]'' artists]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieve all artists. For backward compatibility by default this implicity does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "albumartistsonly",
 
      "$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"
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "Audio.Fields.Artist"
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    },
 
    {
 
      "name": "sort",
 
      "$ref": "List.Sort"
 
    },
 
    {
 
      "name": "filter",
 
      "type": [
 
        {
 
          "type": "object",
 
          "properties": {
 
            "genreid": {
 
              "$ref": "Library.Id",
 
              "required": true,
 
              "description": "Deprecated, use songgenreid. Filter for existence of songs with this genre"
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "songgenreid": {
 
              "$ref": "Library.Id",
 
              "required": true,
 
              "description": "Song genreid. Filter for existence of songs with this genre"
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "songgenreid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            },
 
            "roleid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "songgenreid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            },
 
            "role": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "genre": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true,
 
              "description": "Deprecated, use songgenre. Filter for existence of songs with this genre"
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "songgenre": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true,
 
              "description": "Song genre. Filter for existence of songs with this genre"
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "songgenre": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            },
 
            "roleid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "songgenre": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            },
 
            "role": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "albumid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "album": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "songid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "songid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            },
 
            "roleid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "songid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            },
 
            "role": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "roleid": {
 
              "$ref": "Library.Id",
 
              "required": true,
 
              "description": "Role contributed by artist. Overridden by allroles parameter"
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "role": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true,
 
              "description": "Role contributed by artist. Overridden by allroles parameter"
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "$ref": "List.Filter.Artists"
 
        }
 
      ]
 
    },
 
    {
 
      "name": "allroles",
 
      "type": "boolean",
 
      "default": false,
 
      "description": "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": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "artists": {
 
        "type": "array",
 
        "items": {
 
          "$ref": "Audio.Details.Artist"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== AudioLibrary.GetGenres ====
 
Retrieve all genres<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# ''array[[#Library.Details.Genre|Library.Details.Genre]]'' genres<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieve all genres",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "properties",
 
      "$ref": "Library.Fields.Genre"
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    },
 
    {
 
      "name": "sort",
 
      "$ref": "List.Sort"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "genres": {
 
        "type": "array",
 
        "required": true,
 
        "items": {
 
          "$ref": "Library.Details.Genre"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== AudioLibrary.GetProperties ====
 
Retrieves the values of the music library properties<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''array'' properties<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''[[#Audio.Property.Value|Audio.Property.Value]]''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieves the values of the music library properties",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "properties",
 
      "type": "array",
 
      "uniqueItems": true,
 
      "required": true,
 
      "items": {
 
        "$ref": "Audio.Property.Name"
 
      }
 
    }
 
  ],
 
  "returns": {
 
    "$ref": "Audio.Property.Value",
 
    "required": true
 
  }
 
}
 
}}
 
==== AudioLibrary.GetRecentlyAddedAlbums ====
 
Retrieve recently added albums<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# [''array[[#Audio.Details.Album|Audio.Details.Album]]'' albums]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieve recently added albums",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "properties",
 
      "$ref": "Audio.Fields.Album"
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    },
 
    {
 
      "name": "sort",
 
      "$ref": "List.Sort"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "albums": {
 
        "type": "array",
 
        "items": {
 
          "$ref": "Audio.Details.Album"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== AudioLibrary.GetRecentlyAddedSongs ====
 
Retrieve recently added songs<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#List.Amount|List.Amount]]'' albumlimit] (The amount of recently added albums from which to return the songs)<br />
 
# [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# [''array[[#Audio.Details.Song|Audio.Details.Song]]'' songs]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieve recently added songs",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "albumlimit",
 
      "$ref": "List.Amount",
 
      "description": "The amount of recently added albums from which to return the songs"
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "Audio.Fields.Song"
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    },
 
    {
 
      "name": "sort",
 
      "$ref": "List.Sort"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "songs": {
 
        "type": "array",
 
        "items": {
 
          "$ref": "Audio.Details.Song"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== AudioLibrary.GetRecentlyPlayedAlbums ====
 
Retrieve recently played albums<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# [''array[[#Audio.Details.Album|Audio.Details.Album]]'' albums]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieve recently played albums",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "properties",
 
      "$ref": "Audio.Fields.Album"
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    },
 
    {
 
      "name": "sort",
 
      "$ref": "List.Sort"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "albums": {
 
        "type": "array",
 
        "items": {
 
          "$ref": "Audio.Details.Album"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== AudioLibrary.GetRecentlyPlayedSongs ====
 
Retrieve recently played songs<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# [''array[[#Audio.Details.Song|Audio.Details.Song]]'' songs]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieve recently played songs",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "properties",
 
      "$ref": "Audio.Fields.Song"
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    },
 
    {
 
      "name": "sort",
 
      "$ref": "List.Sort"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "songs": {
 
        "type": "array",
 
        "items": {
 
          "$ref": "Audio.Details.Song"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== AudioLibrary.GetRoles ====
 
Retrieve all contributor roles<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#Audio.Fields.Role|Audio.Fields.Role]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# ''array[[#Audio.Details.Role|Audio.Details.Role]]'' roles<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieve all contributor roles",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "properties",
 
      "$ref": "Audio.Fields.Role"
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    },
 
    {
 
      "name": "sort",
 
      "$ref": "List.Sort"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "roles": {
 
        "type": "array",
 
        "required": true,
 
        "items": {
 
          "$ref": "Audio.Details.Role"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== 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|
 
{
 
  "type": "method",
 
  "description": "Retrieve details about a specific song",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "songid",
 
      "$ref": "Library.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "Audio.Fields.Song"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "songdetails": {
 
        "$ref": "Audio.Details.Song"
 
      }
 
    }
 
  }
 
}
 
}}
 
==== 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 overidden 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 overides 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|
 
{
 
  "type": "method",
 
  "description": "Retrieve all songs from specified album, artist or genre",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "properties",
 
      "$ref": "Audio.Fields.Song"
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    },
 
    {
 
      "name": "sort",
 
      "$ref": "List.Sort"
 
    },
 
    {
 
      "name": "filter",
 
      "type": [
 
        {
 
          "type": "object",
 
          "properties": {
 
            "genreid": {
 
              "$ref": "Library.Id",
 
              "required": true,
 
              "description": "Song genre. Filter for existence of songs with this genre"
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "genre": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true,
 
              "description": "Song genre. Filter for existence of songs with this genre"
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "artistid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "artistid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            },
 
            "roleid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "artistid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            },
 
            "role": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "artist": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "artist": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            },
 
            "roleid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "artist": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            },
 
            "role": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "albumid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "type": "object",
 
          "properties": {
 
            "album": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            }
 
          },
 
          "additionalProperties": false
 
        },
 
        {
 
          "$ref": "List.Filter.Songs"
 
        }
 
      ]
 
    },
 
    {
 
      "name": "includesingles",
 
      "type": "boolean",
 
      "default": true,
 
      "description": "Only songs from albums are returned when false, but overidden when singlesonly parameter is true"
 
    },
 
    {
 
      "name": "allroles",
 
      "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": "singlesonly",
 
      "type": "boolean",
 
      "default": false,
 
      "description": "Only singles are returned when true, and overides includesingles parameter"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "songs": {
 
        "type": "array",
 
        "items": {
 
          "$ref": "Audio.Details.Song"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== AudioLibrary.GetSources ====
 
Get all music sources, including unique ID<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#Library.Fields.Source|Library.Fields.Source]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# ''array[[#Library.Details.Source|Library.Details.Source]]'' sources<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Get all music sources, including unique ID",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "properties",
 
      "$ref": "Library.Fields.Source"
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    },
 
    {
 
      "name": "sort",
 
      "$ref": "List.Sort"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "sources": {
 
        "type": "array",
 
        "required": true,
 
        "items": {
 
          "$ref": "Library.Details.Source"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== AudioLibrary.Scan ====
 
Scans the audio sources for new library items<br />
 
'''Permissions:'''
 
* UpdateData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''string'' directory = ""]<br />
 
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Scans the audio sources for new library items",
 
  "transport": "Response",
 
  "permission": "UpdateData",
 
  "params": [
 
    {
 
      "name": "directory",
 
      "type": "string",
 
      "default": ""
 
    },
 
    {
 
      "name": "showdialogs",
 
      "type": "boolean",
 
      "default": true,
 
      "description": "Whether or not to show the progress bar or any other GUI dialog"
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== AudioLibrary.SetAlbumDetails ====
 
Update the given album with the given details<br />
 
'''Permissions:'''
 
* UpdateData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' albumid<br />
 
# [''[[#Optional.String|Optional.String]]'' title]<br />
 
# [''mixed: [[#Array.String|Array.String]]'' artist = None]<br />
 
# [''[[#Optional.String|Optional.String]]'' description]<br />
 
# [''mixed: [[#Array.String|Array.String]]'' genre = None]<br />
 
# [''mixed: [[#Array.String|Array.String]]'' theme = None]<br />
 
# [''mixed: [[#Array.String|Array.String]]'' mood = None]<br />
 
# [''mixed: [[#Array.String|Array.String]]'' style = None]<br />
 
# [''[[#Optional.String|Optional.String]]'' type]<br />
 
# [''[[#Optional.String|Optional.String]]'' albumlabel]<br />
 
# [''[[#Optional.Number|Optional.Number]]'' rating]<br />
 
# [''[[#Optional.Integer|Optional.Integer]]'' year]<br />
 
# [''[[#Optional.Integer|Optional.Integer]]'' userrating]<br />
 
# [''[[#Optional.Integer|Optional.Integer]]'' votes]<br />
 
# [''[[#Optional.String|Optional.String]]'' musicbrainzalbumid]<br />
 
# [''[[#Optional.String|Optional.String]]'' musicbrainzreleasegroupid]<br />
 
# [''[[#Optional.String|Optional.String]]'' sortartist]<br />
 
# [''[[#Optional.String|Optional.String]]'' displayartist]<br />
 
# [''mixed: [[#Array.String|Array.String]]'' musicbrainzalbumartistid = None]<br />
 
# [''mixed: [[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
 
# [''[[#Optional.Boolean|Optional.Boolean]]'' isboxset]<br />
 
# [''[[#Optional.String|Optional.String]]'' releasedate]<br />
 
# [''[[#Optional.String|Optional.String]]'' originaldate]<br />
 
</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|
 
{
 
  "type": "method",
 
  "description": "Update the given album with the given details",
 
  "transport": "Response",
 
  "permission": "UpdateData",
 
  "params": [
 
    {
 
      "name": "albumid",
 
      "$ref": "Library.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "title",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "artist",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Array.String",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    },
 
    {
 
      "name": "description",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "genre",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Array.String",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    },
 
    {
 
      "name": "theme",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Array.String",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    },
 
    {
 
      "name": "mood",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Array.String",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    },
 
    {
 
      "name": "style",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Array.String",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    },
 
    {
 
      "name": "type",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "albumlabel",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "rating",
 
      "$ref": "Optional.Number"
 
    },
 
    {
 
      "name": "year",
 
      "$ref": "Optional.Integer"
 
    },
 
    {
 
      "name": "userrating",
 
      "$ref": "Optional.Integer"
 
    },
 
    {
 
      "name": "votes",
 
      "$ref": "Optional.Integer"
 
    },
 
    {
 
      "name": "musicbrainzalbumid",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "musicbrainzreleasegroupid",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "sortartist",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "displayartist",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "musicbrainzalbumartistid",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Array.String",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    },
 
    {
 
      "name": "art",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Media.Artwork.Set",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    },
 
    {
 
      "name": "isboxset",
 
      "$ref": "Optional.Boolean"
 
    },
 
    {
 
      "name": "releasedate",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "originaldate",
 
      "$ref": "Optional.String"
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== AudioLibrary.SetArtistDetails ====
 
Update the given artist with the given details<br />
 
'''Permissions:'''
 
* UpdateData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' artistid<br />
 
# [''[[#Optional.String|Optional.String]]'' artist]<br />
 
# [''mixed: [[#Array.String|Array.String]]'' instrument = None]<br />
 
# [''mixed: [[#Array.String|Array.String]]'' style = None]<br />
 
# [''mixed: [[#Array.String|Array.String]]'' mood = None]<br />
 
# [''[[#Optional.String|Optional.String]]'' born]<br />
 
# [''[[#Optional.String|Optional.String]]'' formed]<br />
 
# [''[[#Optional.String|Optional.String]]'' description]<br />
 
# [''mixed: [[#Array.String|Array.String]]'' genre = None]<br />
 
# [''[[#Optional.String|Optional.String]]'' died]<br />
 
# [''[[#Optional.String|Optional.String]]'' disbanded]<br />
 
# [''mixed: [[#Array.String|Array.String]]'' yearsactive = None]<br />
 
# [''[[#Optional.String|Optional.String]]'' musicbrainzartistid]<br />
 
# [''[[#Optional.String|Optional.String]]'' sortname]<br />
 
# [''[[#Optional.String|Optional.String]]'' type]<br />
 
# [''[[#Optional.String|Optional.String]]'' gender]<br />
 
# [''[[#Optional.String|Optional.String]]'' disambiguation]<br />
 
# [''mixed: [[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Update the given artist with the given details",
 
  "transport": "Response",
 
  "permission": "UpdateData",
 
  "params": [
 
    {
 
      "name": "artistid",
 
      "$ref": "Library.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "artist",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "instrument",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Array.String",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    },
 
    {
 
      "name": "style",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Array.String",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    },
 
    {
 
      "name": "mood",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Array.String",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    },
 
    {
 
      "name": "born",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "formed",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "description",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "genre",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Array.String",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    },
 
    {
 
      "name": "died",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "disbanded",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "yearsactive",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Array.String",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    },
 
    {
 
      "name": "musicbrainzartistid",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "sortname",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "type",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "gender",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "disambiguation",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "art",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Media.Artwork.Set",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== AudioLibrary.SetSongDetails ====
 
Update the given song with the given details<br />
 
'''Permissions:'''
 
* UpdateData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' songid<br />
 
# [''[[#Optional.String|Optional.String]]'' title]<br />
 
# [''mixed: [[#Array.String|Array.String]]'' artist = None]<br />
 
# [''mixed: [[#Array.String|Array.String]]'' genre = None]<br />
 
# [''[[#Optional.Integer|Optional.Integer]]'' year]<br />
 
# [''[[#Optional.Number|Optional.Number]]'' rating]<br />
 
# [''[[#Optional.Integer|Optional.Integer]]'' track]<br />
 
# [''[[#Optional.Integer|Optional.Integer]]'' disc]<br />
 
# [''[[#Optional.Integer|Optional.Integer]]'' duration]<br />
 
# [''[[#Optional.String|Optional.String]]'' comment]<br />
 
# [''[[#Optional.String|Optional.String]]'' musicbrainztrackid]<br />
 
# [''[[#Optional.String|Optional.String]]'' musicbrainzartistid]<br />
 
# [''[[#Optional.Integer|Optional.Integer]]'' playcount]<br />
 
# [''[[#Optional.String|Optional.String]]'' lastplayed]<br />
 
# [''[[#Optional.Integer|Optional.Integer]]'' userrating]<br />
 
# [''[[#Optional.Integer|Optional.Integer]]'' votes]<br />
 
# [''[[#Optional.String|Optional.String]]'' displayartist]<br />
 
# [''[[#Optional.String|Optional.String]]'' sortartist]<br />
 
# [''[[#Optional.String|Optional.String]]'' mood]<br />
 
# [''mixed: [[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
 
# [''[[#Optional.String|Optional.String]]'' disctitle]<br />
 
# [''[[#Optional.String|Optional.String]]'' releasedate]<br />
 
# [''[[#Optional.String|Optional.String]]'' originaldate]<br />
 
# [''[[#Optional.Integer|Optional.Integer]]'' bpm]<br />
 
</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|
 
{
 
  "type": "method",
 
  "description": "Update the given song with the given details",
 
  "transport": "Response",
 
  "permission": "UpdateData",
 
  "params": [
 
    {
 
      "name": "songid",
 
      "$ref": "Library.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "title",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "artist",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Array.String",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    },
 
    {
 
      "name": "genre",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Array.String",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    },
 
    {
 
      "name": "year",
 
      "$ref": "Optional.Integer"
 
    },
 
    {
 
      "name": "rating",
 
      "$ref": "Optional.Number"
 
    },
 
    {
 
      "name": "track",
 
      "$ref": "Optional.Integer"
 
    },
 
    {
 
      "name": "disc",
 
      "$ref": "Optional.Integer"
 
    },
 
    {
 
      "name": "duration",
 
      "$ref": "Optional.Integer"
 
    },
 
    {
 
      "name": "comment",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "musicbrainztrackid",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "musicbrainzartistid",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "playcount",
 
      "$ref": "Optional.Integer"
 
    },
 
    {
 
      "name": "lastplayed",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "userrating",
 
      "$ref": "Optional.Integer"
 
    },
 
    {
 
      "name": "votes",
 
      "$ref": "Optional.Integer"
 
    },
 
    {
 
      "name": "displayartist",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "sortartist",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "mood",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "art",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Media.Artwork.Set",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    },
 
    {
 
      "name": "disctitle",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "releasedate",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "originaldate",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "bpm",
 
      "$ref": "Optional.Integer"
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
=== Favourites ===
 
==== Favourites.AddFavourite ====
 
Add a favourite with the given details<br />
 
'''Permissions:'''
 
* UpdateData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' title<br />
 
# ''[[#Favourite.Type|Favourite.Type]]'' type<br />
 
# [''[[#Optional.String|Optional.String]]'' path] (Required for media, script and androidapp favourites types)<br />
 
# [''[[#Optional.String|Optional.String]]'' window] (Required for window favourite type)<br />
 
# [''[[#Optional.String|Optional.String]]'' windowparameter]<br />
 
# [''[[#Optional.String|Optional.String]]'' thumbnail]<br />
 
</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|
 
{
 
  "type": "method",
 
  "description": "Add a favourite with the given details",
 
  "transport": "Response",
 
  "permission": "UpdateData",
 
  "params": [
 
    {
 
      "name": "title",
 
      "type": "string",
 
      "required": true
 
    },
 
    {
 
      "name": "type",
 
      "$ref": "Favourite.Type",
 
      "required": true
 
    },
 
    {
 
      "name": "path",
 
      "$ref": "Optional.String",
 
      "description": "Required for media, script and androidapp favourites types"
 
    },
 
    {
 
      "name": "window",
 
      "$ref": "Optional.String",
 
      "description": "Required for window favourite type"
 
    },
 
    {
 
      "name": "windowparameter",
 
      "$ref": "Optional.String"
 
    },
 
    {
 
      "name": "thumbnail",
 
      "$ref": "Optional.String"
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== Favourites.GetFavourites ====
 
Retrieve all favourites<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''mixed: [[#Favourite.Type|Favourite.Type]]'' type = None]<br />
 
# [''[[#Favourite.Fields.Favourite|Favourite.Fields.Favourite]]'' properties]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# [''array[[#Favourite.Details.Favourite|Favourite.Details.Favourite]]'' favourites]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieve all favourites",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "type",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Favourite.Type"
 
        }
 
      ],
 
      "default": null
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "Favourite.Fields.Favourite"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "favourites": {
 
        "type": "array",
 
        "items": {
 
          "$ref": "Favourite.Details.Favourite"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
=== Files ===
 
==== Files.Download ====
 
Downloads the given file<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' path<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''any''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Downloads the given file",
 
  "transport": [
 
    "Response",
 
    "FileDownloadDirect"
 
  ],
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "path",
 
      "type": "string",
 
      "required": true
 
    }
 
  ],
 
  "returns": {
 
    "type": "any",
 
    "required": true
 
  }
 
}
 
}}
 
==== Files.GetDirectory ====
 
Get the directories and files in the given directory<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' directory<br />
 
# [''[[#Files.Media|Files.Media]]'' media = files]<br />
 
# [''[[#List.Fields.Files|List.Fields.Files]]'' properties]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits] (Limits are applied after getting the directory content thus retrieval is not faster when they are applied.)<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# ''array[[#List.Item.File|List.Item.File]]'' files<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Get the directories and files in the given directory",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "directory",
 
      "type": "string",
 
      "required": true
 
    },
 
    {
 
      "name": "media",
 
      "$ref": "Files.Media",
 
      "default": "files"
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "List.Fields.Files"
 
    },
 
    {
 
      "name": "sort",
 
      "$ref": "List.Sort"
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits",
 
      "description": "Limits are applied after getting the directory content thus retrieval is not faster when they are applied."
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "files": {
 
        "type": "array",
 
        "items": {
 
          "$ref": "List.Item.File"
 
        },
 
        "required": true
 
      }
 
    }
 
  }
 
}
 
}}
 
==== Files.GetFileDetails ====
 
Get details for a specific file<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' file (Full path to the file)<br />
 
# [''[[#Files.Media|Files.Media]]'' media = files]<br />
 
# [''[[#List.Fields.Files|List.Fields.Files]]'' properties]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.Item.File|List.Item.File]]'' filedetails<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Get details for a specific file",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "file",
 
      "type": "string",
 
      "required": true,
 
      "description": "Full path to the file"
 
    },
 
    {
 
      "name": "media",
 
      "$ref": "Files.Media",
 
      "default": "files"
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "List.Fields.Files"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "filedetails": {
 
        "$ref": "List.Item.File",
 
        "required": true
 
      }
 
    }
 
  }
 
}
 
}}
 
==== Files.GetSources ====
 
Get the sources of the media windows<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Files.Media|Files.Media]]'' media<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# ''[[#List.Items.Sources|List.Items.Sources]]'' sources<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Get the sources of the media windows",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "media",
 
      "$ref": "Files.Media",
 
      "required": true
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    },
 
    {
 
      "name": "sort",
 
      "$ref": "List.Sort"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "sources": {
 
        "$ref": "List.Items.Sources",
 
        "required": true
 
      }
 
    }
 
  }
 
}
 
}}
 
==== Files.PrepareDownload ====
 
Provides a way to download a given file (e.g. providing an URL to the real file location)<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' path<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''string'' protocol<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 />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Provides a way to download a given file (e.g. providing an URL to the real file location)",
 
  "transport": [
 
    "Response",
 
    "FileDownloadRedirect"
 
  ],
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "path",
 
      "type": "string",
 
      "required": true
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "protocol": {
 
        "type": "string",
 
        "enum": [
 
          "http"
 
        ],
 
        "required": true
 
      },
 
      "details": {
 
        "type": "any",
 
        "required": true,
 
        "description": "Transport specific details on how/from where to download the given file"
 
      },
 
      "mode": {
 
        "type": "string",
 
        "enum": [
 
          "redirect",
 
          "direct"
 
        ],
 
        "required": true,
 
        "description": "Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol"
 
      }
 
    }
 
  }
 
}
 
}}
 
==== Files.SetFileDetails ====
 
Update the given specific file with the given details<br />
 
'''Permissions:'''
 
* UpdateData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' file (Full path to the file)<br />
 
# ''[[#Files.Media|Files.Media]]'' media (File type to update correct database. Currently only "video" is supported.)<br />
 
# [''[[#Optional.Integer|Optional.Integer]]'' playcount]<br />
 
# [''[[#Optional.String|Optional.String]]'' lastplayed] (Setting a valid lastplayed without a playcount will force playcount to 1.)<br />
 
# [''mixed: [[#Video.Resume|Video.Resume]]'' resume = None]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Update the given specific file with the given details",
 
  "transport": "Response",
 
  "permission": "UpdateData",
 
  "params": [
 
    {
 
      "name": "file",
 
      "type": "string",
 
      "required": true,
 
      "description": "Full path to the file"
 
    },
 
    {
 
      "name": "media",
 
      "$ref": "Files.Media",
 
      "required": true,
 
      "description": "File type to update correct database. Currently only \"video\" is supported."
 
    },
 
    {
 
      "name": "playcount",
 
      "$ref": "Optional.Integer"
 
    },
 
    {
 
      "name": "lastplayed",
 
      "$ref": "Optional.String",
 
      "description": "Setting a valid lastplayed without a playcount will force playcount to 1."
 
    },
 
    {
 
      "name": "resume",
 
      "type": [
 
        "null",
 
        {
 
          "$ref": "Video.Resume",
 
          "required": true
 
        }
 
      ],
 
      "default": null
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
=== GUI ===
 
==== GUI.ActivateWindow ====
 
Activates the given window<br />
 
'''Permissions:'''
 
* ControlGUI
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#GUI.Window|GUI.Window]]'' window<br />
 
# [''array'' parameters]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Activates the given window",
 
  "transport": "Response",
 
  "permission": "ControlGUI",
 
  "params": [
 
    {
 
      "name": "window",
 
      "$ref": "GUI.Window",
 
      "required": true
 
    },
 
    {
 
      "name": "parameters",
 
      "type": "array",
 
      "items": {
 
        "type": "string",
 
        "minLength": 1,
 
        "required": true
 
      },
 
      "minItems": 1
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== GUI.GetProperties ====
 
Retrieves the values of the given properties<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''array'' properties<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''[[#GUI.Property.Value|GUI.Property.Value]]''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieves the values of the given properties",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "properties",
 
      "type": "array",
 
      "uniqueItems": true,
 
      "required": true,
 
      "items": {
 
        "$ref": "GUI.Property.Name"
 
      }
 
    }
 
  ],
 
  "returns": {
 
    "$ref": "GUI.Property.Value",
 
    "required": true
 
  }
 
}
 
}}
 
==== GUI.GetStereoscopicModes ====
 
Returns the supported stereoscopic modes of the GUI<br />
 
'''Permissions:'''
 
* ReadData
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# [''array[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]'' stereoscopicmodes]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Returns the supported stereoscopic modes of the GUI",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "stereoscopicmodes": {
 
        "type": "array",
 
        "uniqueItems": true,
 
        "items": {
 
          "$ref": "GUI.Stereoscopy.Mode"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== GUI.SetFullscreen ====
 
Toggle fullscreen/GUI<br />
 
'''Permissions:'''
 
* ControlGUI
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Global.Toggle|Global.Toggle]]'' fullscreen<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''boolean (Fullscreen state)''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Toggle fullscreen/GUI",
 
  "transport": "Response",
 
  "permission": "ControlGUI",
 
  "params": [
 
    {
 
      "name": "fullscreen",
 
      "required": true,
 
      "$ref": "Global.Toggle"
 
    }
 
  ],
 
  "returns": {
 
    "type": "boolean",
 
    "description": "Fullscreen state"
 
  }
 
}
 
}}
 
==== GUI.SetStereoscopicMode ====
 
Sets the stereoscopic mode of the GUI to the given mode<br />
 
'''Permissions:'''
 
* ControlGUI
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' mode<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Sets the stereoscopic mode of the GUI to the given mode",
 
  "transport": "Response",
 
  "permission": "ControlGUI",
 
  "params": [
 
    {
 
      "name": "mode",
 
      "type": "string",
 
      "enum": [
 
        "toggle",
 
        "tomono",
 
        "next",
 
        "previous",
 
        "select",
 
        "off",
 
        "split_vertical",
 
        "split_horizontal",
 
        "row_interleaved",
 
        "hardware_based",
 
        "anaglyph_cyan_red",
 
        "anaglyph_green_magenta",
 
        "monoscopic"
 
      ],
 
      "required": true
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== GUI.ShowNotification ====
 
Shows a GUI notification<br />
 
'''Permissions:'''
 
* ControlGUI
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' title<br />
 
# ''string'' message<br />
 
# [''mixed: string|string'' image = ""]<br />
 
# [''integer'' displaytime = 5000] (The time in milliseconds the notification will be visible)<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Shows a GUI notification",
 
  "transport": "Response",
 
  "permission": "ControlGUI",
 
  "params": [
 
    {
 
      "name": "title",
 
      "type": "string",
 
      "required": true
 
    },
 
    {
 
      "name": "message",
 
      "type": "string",
 
      "required": true
 
    },
 
    {
 
      "name": "image",
 
      "type": [
 
        {
 
          "type": "string",
 
          "required": true,
 
          "enum": [
 
            "info",
 
            "warning",
 
            "error"
 
          ]
 
        },
 
        {
 
          "type": "string",
 
          "required": true
 
        }
 
      ],
 
      "default": ""
 
    },
 
    {
 
      "name": "displaytime",
 
      "type": "integer",
 
      "minimum": 1500,
 
      "default": 5000,
 
      "description": "The time in milliseconds the notification will be visible"
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
=== Input ===
 
==== Input.Back ====
 
Goes back in GUI<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Goes back in GUI",
 
  "transport": "Response",
 
  "permission": "Navigate",
 
  "params": [],
 
  "returns": "string"
 
}
 
}}
 
==== Input.ButtonEvent ====
 
Send a button press event<br />
 
'''Permissions:'''
 
* Navigate
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' button (Button name)<br />
 
# ''string'' keymap (Keymap name (KB, XG, R1, or R2))<br />
 
# ''integer'' holdtime = 0 (Number of milliseconds to simulate button hold.)<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Send a button press event",
 
  "transport": "Response",
 
  "permission": "Navigate",
 
  "params": [
 
    {
 
      "name": "button",
 
      "type": "string",
 
      "required": true,
 
      "description": "Button name"
 
    },
 
    {
 
      "name": "keymap",
 
      "type": "string",
 
      "required": true,
 
      "description": "Keymap name (KB, XG, R1, or R2)",
 
      "enum": [
 
        "KB",
 
        "XG",
 
        "R1",
 
        "R2"
 
      ]
 
    },
 
    {
 
      "name": "holdtime",
 
      "type": "integer",
 
      "required": false,
 
      "minimum": 0,
 
      "default": 0,
 
      "description": "Number of milliseconds to simulate button hold."
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== Input.ContextMenu ====
 
Shows the context menu<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Shows the context menu",
 
  "transport": "Response",
 
  "permission": "Navigate",
 
  "params": [],
 
  "returns": "string"
 
}
 
}}
 
==== Input.Down ====
 
Navigate down in GUI<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Navigate down in GUI",
 
  "transport": "Response",
 
  "permission": "Navigate",
 
  "params": [],
 
  "returns": "string"
 
}
 
}}
 
==== Input.ExecuteAction ====
 
Execute a specific action<br />
 
'''Permissions:'''
 
* Navigate
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Input.Action|Input.Action]]'' action<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Execute a specific action",
 
  "transport": "Response",
 
  "permission": "Navigate",
 
  "params": [
 
    {
 
      "name": "action",
 
      "$ref": "Input.Action",
 
      "required": true
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== Input.Home ====
 
Goes to home window in GUI<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Goes to home window in GUI",
 
  "transport": "Response",
 
  "permission": "Navigate",
 
  "params": [],
 
  "returns": "string"
 
}
 
}}
 
==== Input.Info ====
 
Shows the information dialog<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Shows the information dialog",
 
  "transport": "Response",
 
  "permission": "Navigate",
 
  "params": [],
 
  "returns": "string"
 
}
 
}}
 
==== Input.Left ====
 
Navigate left in GUI<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Navigate left in GUI",
 
  "transport": "Response",
 
  "permission": "Navigate",
 
  "params": [],
 
  "returns": "string"
 
}
 
}}
 
==== Input.Right ====
 
Navigate right in GUI<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Navigate right in GUI",
 
  "transport": "Response",
 
  "permission": "Navigate",
 
  "params": [],
 
  "returns": "string"
 
}
 
}}
 
==== Input.Select ====
 
Select current item in GUI<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Select current item in GUI",
 
  "transport": "Response",
 
  "permission": "Navigate",
 
  "params": [],
 
  "returns": "string"
 
}
 
}}
 
==== Input.SendText ====
 
Send a generic (unicode) text<br />
 
'''Permissions:'''
 
* Navigate
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' text (Unicode text)<br />
 
# [''boolean'' done = True] (Whether this is the whole input or not (closes an open input dialog if true).)<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Send a generic (unicode) text",
 
  "transport": "Response",
 
  "permission": "Navigate",
 
  "params": [
 
    {
 
      "name": "text",
 
      "type": "string",
 
      "required": true,
 
      "description": "Unicode text"
 
    },
 
    {
 
      "name": "done",
 
      "type": "boolean",
 
      "default": true,
 
      "description": "Whether this is the whole input or not (closes an open input dialog if true)."
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== Input.ShowCodec ====
 
Show codec information of the playing item<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Show codec information of the playing item",
 
  "transport": "Response",
 
  "permission": "Navigate",
 
  "params": [],
 
  "returns": "string"
 
}
 
}}
 
==== Input.ShowOSD ====
 
Show the on-screen display for the current player<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Show the on-screen display for the current player",
 
  "transport": "Response",
 
  "permission": "Navigate",
 
  "params": [],
 
  "returns": "string"
 
}
 
}}
 
==== Input.ShowPlayerProcessInfo ====
 
Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...",
 
  "transport": "Response",
 
  "permission": "Navigate",
 
  "params": [],
 
  "returns": "string"
 
}
 
}}
 
==== Input.Up ====
 
Navigate up in GUI<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Navigate up in GUI",
 
  "transport": "Response",
 
  "permission": "Navigate",
 
  "params": [],
 
  "returns": "string"
 
}
 
}}
 
=== JSONRPC ===
 
==== JSONRPC.GetConfiguration ====
 
Get client-specific configurations<br />
 
'''Permissions:'''
 
* ReadData
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''[[#Configuration|Configuration]]''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Get client-specific configurations",
 
  "transport": "Announcing",
 
  "permission": "ReadData",
 
  "params": [],
 
  "returns": {
 
    "$ref": "Configuration"
 
  }
 
}
 
}}
 
==== JSONRPC.Introspect ====
 
Enumerates all actions and descriptions<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''boolean'' getdescriptions = True]<br />
 
# [''boolean'' getmetadata = False]<br />
 
# [''boolean'' filterbytransport = True]<br />
 
# [''object'' filter]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Enumerates all actions and descriptions",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "getdescriptions",
 
      "type": "boolean",
 
      "default": true
 
    },
 
    {
 
      "name": "getmetadata",
 
      "type": "boolean",
 
      "default": false
 
    },
 
    {
 
      "name": "filterbytransport",
 
      "type": "boolean",
 
      "default": true
 
    },
 
    {
 
      "name": "filter",
 
      "type": "object",
 
      "properties": {
 
        "id": {
 
          "type": "string",
 
          "required": true,
 
          "description": "Name of a namespace, method or type"
 
        },
 
        "type": {
 
          "type": "string",
 
          "required": true,
 
          "enum": [
 
            "method",
 
            "namespace",
 
            "type",
 
            "notification"
 
          ],
 
          "description": "Type of the given name"
 
        },
 
        "getreferences": {
 
          "type": "boolean",
 
          "default": true,
 
          "description": "Whether or not to print the schema for referenced types"
 
        }
 
      }
 
    }
 
  ],
 
  "returns": "object"
 
}
 
}}
 
==== JSONRPC.NotifyAll ====
 
Notify all other connected clients<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' sender<br />
 
# ''string'' message<br />
 
# [''any'' data = None]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''any''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Notify all other connected clients",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "sender",
 
      "type": "string",
 
      "required": true
 
    },
 
    {
 
      "name": "message",
 
      "type": "string",
 
      "required": true
 
    },
 
    {
 
      "name": "data",
 
      "type": "any",
 
      "default": null
 
    }
 
  ],
 
  "returns": "any"
 
}
 
}}
 
==== JSONRPC.Permission ====
 
Retrieve the clients permissions<br />
 
'''Permissions:'''
 
* ReadData
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''boolean'' ReadData<br />
 
# ''boolean'' ControlPlayback<br />
 
# ''boolean'' ControlNotify<br />
 
# ''boolean'' ControlPower<br />
 
# ''boolean'' UpdateData<br />
 
# ''boolean'' RemoveData<br />
 
# ''boolean'' Navigate<br />
 
# ''boolean'' WriteFile<br />
 
# ''boolean'' ControlSystem<br />
 
# ''boolean'' ControlGUI<br />
 
# ''boolean'' ManageAddon<br />
 
# ''boolean'' ExecuteAddon<br />
 
# ''boolean'' ControlPVR<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieve the clients permissions",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "ReadData": {
 
        "type": "boolean",
 
        "required": true
 
      },
 
      "ControlPlayback": {
 
        "type": "boolean",
 
        "required": true
 
      },
 
      "ControlNotify": {
 
        "type": "boolean",
 
        "required": true
 
      },
 
      "ControlPower": {
 
        "type": "boolean",
 
        "required": true
 
      },
 
      "UpdateData": {
 
        "type": "boolean",
 
        "required": true
 
      },
 
      "RemoveData": {
 
        "type": "boolean",
 
        "required": true
 
      },
 
      "Navigate": {
 
        "type": "boolean",
 
        "required": true
 
      },
 
      "WriteFile": {
 
        "type": "boolean",
 
        "required": true
 
      },
 
      "ControlSystem": {
 
        "type": "boolean",
 
        "required": true
 
      },
 
      "ControlGUI": {
 
        "type": "boolean",
 
        "required": true
 
      },
 
      "ManageAddon": {
 
        "type": "boolean",
 
        "required": true
 
      },
 
      "ExecuteAddon": {
 
        "type": "boolean",
 
        "required": true
 
      },
 
      "ControlPVR": {
 
        "type": "boolean",
 
        "required": true
 
      }
 
    }
 
  }
 
}
 
}}
 
==== JSONRPC.Ping ====
 
Ping responder<br />
 
'''Permissions:'''
 
* ReadData
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Ping responder",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [],
 
  "returns": "string"
 
}
 
}}
 
==== JSONRPC.SetConfiguration ====
 
Change the client-specific configuration<br />
 
'''Permissions:'''
 
* ControlNotify
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''object'' notifications]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''[[#Configuration|Configuration]]''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Change the client-specific configuration",
 
  "transport": "Announcing",
 
  "permission": "ControlNotify",
 
  "params": [
 
    {
 
      "name": "notifications",
 
      "type": "object",
 
      "properties": {
 
        "Player": {
 
          "$ref": "Optional.Boolean"
 
        },
 
        "Playlist": {
 
          "$ref": "Optional.Boolean"
 
        },
 
        "GUI": {
 
          "$ref": "Optional.Boolean"
 
        },
 
        "System": {
 
          "$ref": "Optional.Boolean"
 
        },
 
        "AudioLibrary": {
 
          "$ref": "Optional.Boolean"
 
        },
 
        "VideoLibrary": {
 
          "$ref": "Optional.Boolean"
 
        },
 
        "Application": {
 
          "$ref": "Optional.Boolean"
 
        },
 
        "Input": {
 
          "$ref": "Optional.Boolean"
 
        },
 
        "Other": {
 
          "$ref": "Optional.Boolean"
 
        }
 
      }
 
    }
 
  ],
 
  "returns": {
 
    "$ref": "Configuration"
 
  }
 
}
 
}}
 
==== JSONRPC.Version ====
 
Retrieve the JSON-RPC protocol version.<br />
 
'''Permissions:'''
 
* ReadData
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''object'' version<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieve the JSON-RPC protocol version.",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "version": {
 
        "type": "object",
 
        "required": true,
 
        "properties": {
 
          "major": {
 
            "type": "integer",
 
            "minimum": 0,
 
            "required": true,
 
            "description": "Bumped on backwards incompatible changes to the API definition"
 
          },
 
          "minor": {
 
            "type": "integer",
 
            "minimum": 0,
 
            "required": true,
 
            "description": "Bumped on backwards compatible additions/changes to the API definition"
 
          },
 
          "patch": {
 
            "type": "integer",
 
            "minimum": 0,
 
            "required": true,
 
            "description": "Bumped on any changes to the internal implementation but not to the API definition"
 
          }
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
=== PVR ===
 
==== PVR.AddTimer ====
 
Adds a timer to record the given show one times or a timer rule to record all showings of the given show<br />
 
'''Permissions:'''
 
* ControlPVR
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' broadcastid (the broadcast id of the item to record)<br />
 
# [''boolean'' timerrule = False] (controls whether to create a timer rule or a onetime timer)<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Adds a timer to record the given show one times or a timer rule to record all showings of the given show",
 
  "transport": "Response",
 
  "permission": "ControlPVR",
 
  "params": [
 
    {
 
      "name": "broadcastid",
 
      "$ref": "Library.Id",
 
      "required": true,
 
      "description": "the broadcast id of the item to record"
 
    },
 
    {
 
      "name": "timerrule",
 
      "type": "boolean",
 
      "default": false,
 
      "description": "controls whether to create a timer rule or a onetime timer"
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== PVR.DeleteTimer ====
 
Deletes a onetime timer or a timer rule<br />
 
'''Permissions:'''
 
* ControlPVR
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' timerid (the id of the onetime timer or timer rule to delete)<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Deletes a onetime timer or a timer rule",
 
  "transport": "Response",
 
  "permission": "ControlPVR",
 
  "params": [
 
    {
 
      "name": "timerid",
 
      "$ref": "Library.Id",
 
      "required": true,
 
      "description": "the id of the onetime timer or timer rule to delete"
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== PVR.GetBroadcastDetails ====
 
Retrieves the details of a specific broadcast<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' broadcastid<br />
 
# [''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# [''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastdetails]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieves the details of a specific broadcast",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "broadcastid",
 
      "$ref": "Library.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "PVR.Fields.Broadcast"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "broadcastdetails": {
 
        "$ref": "PVR.Details.Broadcast"
 
      }
 
    }
 
  }
 
}
 
}}
 
==== PVR.GetBroadcasts ====
 
Retrieves the program of a specific channel<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' channelid<br />
 
# [''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# ''array[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcasts<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieves the program of a specific channel",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "channelid",
 
      "$ref": "Library.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "PVR.Fields.Broadcast"
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "broadcasts": {
 
        "type": "array",
 
        "required": true,
 
        "items": {
 
          "$ref": "PVR.Details.Broadcast"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== PVR.GetChannelDetails ====
 
Retrieves the details of a specific channel<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' channelid<br />
 
# [''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# [''[[#PVR.Details.Channel|PVR.Details.Channel]]'' channeldetails]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieves the details of a specific channel",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "channelid",
 
      "$ref": "Library.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "PVR.Fields.Channel"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "channeldetails": {
 
        "$ref": "PVR.Details.Channel"
 
      }
 
    }
 
  }
 
}
 
}}
 
==== PVR.GetChannelGroupDetails ====
 
Retrieves the details of a specific channel group<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#PVR.ChannelGroup.Id|PVR.ChannelGroup.Id]]'' channelgroupid<br />
 
# [''object'' channels]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# [''[[#PVR.Details.ChannelGroup.Extended|PVR.Details.ChannelGroup.Extended]]'' channelgroupdetails]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieves the details of a specific channel group",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "channelgroupid",
 
      "$ref": "PVR.ChannelGroup.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "channels",
 
      "type": "object",
 
      "properties": {
 
        "properties": {
 
          "$ref": "PVR.Fields.Channel"
 
        },
 
        "limits": {
 
          "$ref": "List.Limits"
 
        }
 
      }
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "channelgroupdetails": {
 
        "$ref": "PVR.Details.ChannelGroup.Extended"
 
      }
 
    }
 
  }
 
}
 
}}
 
==== PVR.GetChannelGroups ====
 
Retrieves the channel groups for the specified type<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# ''array[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]'' channelgroups<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieves the channel groups for the specified type",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "channeltype",
 
      "$ref": "PVR.Channel.Type",
 
      "required": true
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "channelgroups": {
 
        "type": "array",
 
        "required": true,
 
        "items": {
 
          "$ref": "PVR.Details.ChannelGroup"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== PVR.GetChannels ====
 
Retrieves the channel list<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#PVR.ChannelGroup.Id|PVR.ChannelGroup.Id]]'' channelgroupid<br />
 
# [''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# ''array[[#PVR.Details.Channel|PVR.Details.Channel]]'' channels<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieves the channel list",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "channelgroupid",
 
      "$ref": "PVR.ChannelGroup.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "PVR.Fields.Channel"
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "channels": {
 
        "type": "array",
 
        "required": true,
 
        "items": {
 
          "$ref": "PVR.Details.Channel"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== 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'' 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|
 
{
 
  "type": "method",
 
  "description": "Retrieves the values of the given properties",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "properties",
 
      "type": "array",
 
      "uniqueItems": true,
 
      "required": true,
 
      "items": {
 
        "$ref": "PVR.Property.Name"
 
      }
 
    }
 
  ],
 
  "returns": {
 
    "$ref": "PVR.Property.Value",
 
    "required": true
 
  }
 
}
 
}}
 
==== PVR.GetRecordingDetails ====
 
Retrieves the details of a specific recording<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' recordingid<br />
 
# [''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# [''[[#PVR.Details.Recording|PVR.Details.Recording]]'' recordingdetails]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieves the details of a specific recording",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "recordingid",
 
      "$ref": "Library.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "PVR.Fields.Recording"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "recordingdetails": {
 
        "$ref": "PVR.Details.Recording"
 
      }
 
    }
 
  }
 
}
 
}}
 
==== PVR.GetRecordings ====
 
Retrieves the recordings<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# ''array[[#PVR.Details.Recording|PVR.Details.Recording]]'' recordings<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieves the recordings",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "properties",
 
      "$ref": "PVR.Fields.Recording"
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "recordings": {
 
        "type": "array",
 
        "required": true,
 
        "items": {
 
          "$ref": "PVR.Details.Recording"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== PVR.GetTimerDetails ====
 
Retrieves the details of a specific timer<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' timerid<br />
 
# [''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# [''[[#PVR.Details.Timer|PVR.Details.Timer]]'' timerdetails]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieves the details of a specific timer",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "timerid",
 
      "$ref": "Library.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "PVR.Fields.Timer"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "timerdetails": {
 
        "$ref": "PVR.Details.Timer"
 
      }
 
    }
 
  }
 
}
 
}}
 
==== PVR.GetTimers ====
 
Retrieves the timers<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# ''array[[#PVR.Details.Timer|PVR.Details.Timer]]'' timers<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieves the timers",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "properties",
 
      "$ref": "PVR.Fields.Timer"
 
    },
 
    {
 
      "name": "limits",
 
      "$ref": "List.Limits"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
      "timers": {
 
        "type": "array",
 
        "required": true,
 
        "items": {
 
          "$ref": "PVR.Details.Timer"
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== PVR.Record ====
 
Toggle recording of a channel<br />
 
'''Permissions:'''
 
* ControlPVR
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#Global.Toggle|Global.Toggle]]'' record = toggle]<br />
 
# [''mixed: string|[[#Library.Id|Library.Id]]'' channel = current]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Toggle recording of a channel",
 
  "transport": "Response",
 
  "permission": "ControlPVR",
 
  "params": [
 
    {
 
      "name": "record",
 
      "$ref": "Global.Toggle",
 
      "default": "toggle"
 
    },
 
    {
 
      "name": "channel",
 
      "type": [
 
        {
 
          "type": "string",
 
          "enum": [
 
            "current"
 
          ],
 
          "required": true
 
        },
 
        {
 
          "$ref": "Library.Id",
 
          "required": true
 
        }
 
      ],
 
      "default": "current"
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== PVR.Scan ====
 
Starts a channel scan<br />
 
'''Permissions:'''
 
* ControlPVR
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Starts a channel scan",
 
  "transport": "Response",
 
  "permission": "ControlPVR",
 
  "params": [],
 
  "returns": "string"
 
}
 
}}
 
==== PVR.ToggleTimer ====
 
Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created<br />
 
'''Permissions:'''
 
* ControlPVR
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' broadcastid (the broadcast id of the item to toggle a onetime timer or time rule for)<br />
 
# [''boolean'' timerrule = False] (controls whether to create / delete a timer rule or a onetime timer)<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "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",
 
  "transport": "Response",
 
  "permission": "ControlPVR",
 
  "params": [
 
    {
 
      "name": "broadcastid",
 
      "$ref": "Library.Id",
 
      "required": true,
 
      "description": "the broadcast id of the item to toggle a onetime timer or time rule for"
 
    },
 
    {
 
      "name": "timerrule",
 
      "type": "boolean",
 
      "default": false,
 
      "description": "controls whether to create / delete a timer rule or a onetime timer"
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
=== Player ===
 
==== Player.GetActivePlayers ====
 
Returns all active players<br />
 
'''Permissions:'''
 
* ReadData
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''array''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Returns all active players",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [],
 
  "returns": {
 
    "type": "array",
 
    "uniqueItems": true,
 
    "items": {
 
      "type": "object",
 
      "properties": {
 
        "playerid": {
 
          "$ref": "Player.Id",
 
          "required": true
 
        },
 
        "type": {
 
          "$ref": "Player.Type",
 
          "required": true
 
        },
 
        "playertype": {
 
          "type": "string",
 
          "enum": [
 
            "internal",
 
            "external",
 
            "remote"
 
          ],
 
          "required": true
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== Player.GetItem ====
 
Retrieves the currently played item<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Player.Id|Player.Id]]'' playerid<br />
 
# [''[[#List.Fields.All|List.Fields.All]]'' properties]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.Item.All|List.Item.All]]'' item<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieves the currently played item",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "playerid",
 
      "$ref": "Player.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "properties",
 
      "$ref": "List.Fields.All"
 
    }
 
  ],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "item": {
 
        "$ref": "List.Item.All",
 
        "required": true
 
      }
 
    }
 
  }
 
}
 
}}
 
==== Player.GetPlayers ====
 
Get a list of available players<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''string'' media = all]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''array''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Get a list of available players",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "media",
 
      "type": "string",
 
      "enum": [
 
        "all",
 
        "video",
 
        "audio"
 
      ],
 
      "default": "all"
 
    }
 
  ],
 
  "returns": {
 
    "type": "array",
 
    "uniqueItems": true,
 
    "items": {
 
      "type": "object",
 
      "properties": {
 
        "name": {
 
          "$ref": "Global.String.NotEmpty",
 
          "required": true
 
        },
 
        "type": {
 
          "type": "string",
 
          "enum": [
 
            "internal",
 
            "external",
 
            "remote"
 
          ],
 
          "required": true
 
        },
 
        "playsvideo": {
 
          "type": "boolean",
 
          "required": true
 
        },
 
        "playsaudio": {
 
          "type": "boolean",
 
          "required": true
 
        }
 
      }
 
    }
 
  }
 
}
 
}}
 
==== Player.GetProperties ====
 
Retrieves the values of the given properties<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Player.Id|Player.Id]]'' playerid<br />
 
# ''array'' properties<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''[[#Player.Property.Value|Player.Property.Value]]''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Retrieves the values of the given properties",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [
 
    {
 
      "name": "playerid",
 
      "$ref": "Player.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "properties",
 
      "type": "array",
 
      "uniqueItems": true,
 
      "required": true,
 
      "items": {
 
        "$ref": "Player.Property.Name"
 
      }
 
    }
 
  ],
 
  "returns": {
 
    "$ref": "Player.Property.Value",
 
    "required": true
 
  }
 
}
 
}}
 
==== Player.GetViewMode ====
 
Get view mode of video player<br />
 
'''Permissions:'''
 
* ReadData
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#Player.ViewMode|Player.ViewMode]]'' viewmode<br />
 
# ''number'' zoom<br />
 
# ''number'' pixelratio<br />
 
# ''number'' verticalshift<br />
 
# ''boolean'' nonlinearstretch<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Get view mode of video player",
 
  "transport": "Response",
 
  "permission": "ReadData",
 
  "params": [],
 
  "returns": {
 
    "type": "object",
 
    "properties": {
 
      "viewmode": {
 
        "$ref": "Player.ViewMode",
 
        "required": true
 
      },
 
      "zoom": {
 
        "type": "number",
 
        "required": true
 
      },
 
      "pixelratio": {
 
        "type": "number",
 
        "required": true
 
      },
 
      "verticalshift": {
 
        "type": "number",
 
        "required": true
 
      },
 
      "nonlinearstretch": {
 
        "type": "boolean",
 
        "required": true
 
      }
 
    }
 
  }
 
}
 
}}
 
==== Player.GoTo ====
 
Go to previous/next/specific item in the playlist<br />
 
'''Permissions:'''
 
* ControlPlayback
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Player.Id|Player.Id]]'' playerid<br />
 
# ''mixed: string|[[#Playlist.Position|Playlist.Position]]'' to<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Go to previous/next/specific item in the playlist",
 
  "transport": "Response",
 
  "permission": "ControlPlayback",
 
  "params": [
 
    {
 
      "name": "playerid",
 
      "$ref": "Player.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "to",
 
      "type": [
 
        {
 
          "type": "string",
 
          "enum": [
 
            "previous",
 
            "next"
 
          ],
 
          "required": true
 
        },
 
        {
 
          "$ref": "Playlist.Position",
 
          "description": "position in playlist",
 
          "required": true
 
        }
 
      ],
 
      "required": true
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== Player.Move ====
 
If picture is zoomed move viewport left/right/up/down otherwise skip previous/next<br />
 
'''Permissions:'''
 
* ControlPlayback
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Player.Id|Player.Id]]'' playerid<br />
 
# ''string'' direction<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "If picture is zoomed move viewport left/right/up/down otherwise skip previous/next",
 
  "transport": "Response",
 
  "permission": "ControlPlayback",
 
  "params": [
 
    {
 
      "name": "playerid",
 
      "$ref": "Player.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "direction",
 
      "type": "string",
 
      "enum": [
 
        "left",
 
        "right",
 
        "up",
 
        "down"
 
      ],
 
      "required": true
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== Player.Open ====
 
Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.<br />
 
'''Permissions:'''
 
* ControlPlayback
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''mixed: object|[[#Playlist.Item|Playlist.Item]]|object|object|object|object'' item]<br />
 
# [''object'' options]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "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.",
 
  "transport": "Response",
 
  "permission": "ControlPlayback",
 
  "params": [
 
    {
 
      "name": "item",
 
      "type": [
 
        {
 
          "type": "object",
 
          "required": true,
 
          "additionalProperties": false,
 
          "properties": {
 
            "playlistid": {
 
              "$ref": "Playlist.Id",
 
              "required": true
 
            },
 
            "position": {
 
              "$ref": "Playlist.Position",
 
              "default": 0
 
            }
 
          }
 
        },
 
        {
 
          "$ref": "Playlist.Item",
 
          "required": true
 
        },
 
        {
 
          "type": "object",
 
          "required": true,
 
          "additionalProperties": false,
 
          "properties": {
 
            "path": {
 
              "type": "string",
 
              "required": true
 
            },
 
            "random": {
 
              "type": "boolean",
 
              "default": true,
 
              "description": "Deprecated, use the shuffled property of the options parameter instead"
 
            },
 
            "recursive": {
 
              "type": "boolean",
 
              "default": true
 
            }
 
          }
 
        },
 
        {
 
          "type": "object",
 
          "required": true,
 
          "additionalProperties": false,
 
          "properties": {
 
            "partymode": {
 
              "type": [
 
                {
 
                  "type": "string",
 
                  "required": true,
 
                  "enum": [
 
                    "music",
 
                    "video"
 
                  ]
 
                },
 
                {
 
                  "type": "string",
 
                  "required": true,
 
                  "minLength": 5,
 
                  "description": "Path to a smartplaylist (*.xsp) file"
 
                }
 
              ]
 
            }
 
          }
 
        },
 
        {
 
          "type": "object",
 
          "required": true,
 
          "additionalProperties": false,
 
          "properties": {
 
            "channelid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            }
 
          }
 
        },
 
        {
 
          "type": "object",
 
          "required": true,
 
          "additionalProperties": false,
 
          "properties": {
 
            "recordingid": {
 
              "$ref": "Library.Id",
 
              "required": true
 
            }
 
          }
 
        }
 
      ]
 
    },
 
    {
 
      "name": "options",
 
      "type": "object",
 
      "additionalProperties": false,
 
      "properties": {
 
        "playername": {
 
          "type": [
 
            "null",
 
            {
 
              "type": "string",
 
              "enum": [
 
                "default"
 
              ],
 
              "required": true
 
            },
 
            {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true,
 
              "description": "name of player"
 
            }
 
          ],
 
          "default": null
 
        },
 
        "shuffled": {
 
          "$ref": "Optional.Boolean"
 
        },
 
        "repeat": {
 
          "type": [
 
            "null",
 
            {
 
              "$ref": "Player.Repeat",
 
              "required": true
 
            }
 
          ],
 
          "default": null
 
        },
 
        "resume": {
 
          "type": [
 
            {
 
              "type": "boolean",
 
              "required": true,
 
              "description": "Whether to resume from the resume point or not"
 
            },
 
            {
 
              "$ref": "Player.Position.Percentage",
 
              "required": true,
 
              "description": "Percentage value to start from"
 
            },
 
            {
 
              "$ref": "Player.Position.Time",
 
              "required": true,
 
              "description": "Time to start from"
 
            }
 
          ],
 
          "default": false
 
        }
 
      }
 
    }
 
  ],
 
  "returns": "string"
 
}
 
}}
 
==== Player.PlayPause ====
 
Pauses or unpause playback and returns the new state<br />
 
'''Permissions:'''
 
* ControlPlayback
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Player.Id|Player.Id]]'' playerid<br />
 
# [''[[#Global.Toggle|Global.Toggle]]'' play = toggle]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Pauses or unpause playback and returns the new state",
 
  "transport": "Response",
 
  "permission": "ControlPlayback",
 
  "params": [
 
    {
 
      "name": "playerid",
 
      "$ref": "Player.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "play",
 
      "$ref": "Global.Toggle",
 
      "default": "toggle"
 
    }
 
  ],
 
  "returns": {
 
    "$ref": "Player.Speed"
 
  }
 
}
 
}}
 
==== Player.Rotate ====
 
Rotates current picture<br />
 
'''Permissions:'''
 
* ControlPlayback
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Player.Id|Player.Id]]'' playerid<br />
 
# [''string'' value = clockwise]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|
 
{
 
  "type": "method",
 
  "description": "Rotates current picture",
 
  "transport": "Response",
 
  "permission": "ControlPlayback",
 
  "params": [
 
    {
 
      "name": "playerid",
 
      "$ref": "Player.Id",
 
      "required": true
 
    },
 
    {
 
      "name": "value",
 
      "type": "string",
 
      "enum": [
 
        "clockwise",
 
        "counterclockwise"
 
      ],
 
      "default": "clockwise"