Difference between revisions of "User:Ronie"

From Official Kodi Wiki
Jump to: navigation, search
Line 1: Line 1:
{{mininav|[[Development]]|[[JSON-RPC API]]}}
+
{{mininav|[[Development]]|[[JSON-RPC API]]}}Version 12 is the current development version of Kodi's JSON-RPC API and will be published with the release of v19.<br />This document has been updated to version 11.8.1. Recent changes are announced on the [https://forum.kodi.tv/forumdisplay.php?fid=174 forum]
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.
 
It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.
  
Line 199: Line 196:
 
</pre>
 
</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|<syntaxhighlight enclose="div">{
== Methods ==
 
=== Addons ===
 
==== Addons.ExecuteAddon ====
 
Executes the given addon with the given parameters (if possible)<br />
 
'''Permissions:'''
 
* ExecuteAddon
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' addonid<br />
 
# [''mixed: object|array|string'' params = ""]<br />
 
# [''boolean'' wait = False]<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Executes the given addon with the given parameters (if possible)",
 
   "description": "Executes the given addon with the given parameters (if possible)",
  "transport": "Response",
 
  "permission": "ExecuteAddon",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 
       "name": "addonid",
 
       "name": "addonid",
       "type": "string",
+
       "required": true,
       "required": true
+
       "type": "string"
 
     },
 
     },
 
     {
 
     {
 +
      "default": "",
 
       "name": "params",
 
       "name": "params",
 
       "type": [
 
       "type": [
 
         {
 
         {
          "type": "object",
 
 
           "additionalProperties": {
 
           "additionalProperties": {
 +
            "default": "",
 
             "type": "string"
 
             "type": "string"
           }
+
           },
 +
          "type": "object"
 
         },
 
         },
 
         {
 
         {
          "type": "array",
 
 
           "items": {
 
           "items": {
 
             "type": "string"
 
             "type": "string"
           }
+
           },
 +
          "type": "array"
 
         },
 
         },
 
         {
 
         {
          "type": "string",
+
           "description": "URL path (must start with / or ?",
           "description": "URL path (must start with / or ?"
+
          "type": "string"
 
         }
 
         }
       ],
+
       ]
      "default": ""
 
 
     },
 
     },
 
     {
 
     {
 +
      "default": false,
 
       "name": "wait",
 
       "name": "wait",
       "type": "boolean",
+
       "type": "boolean"
      "default": false
 
 
     }
 
     }
 
   ],
 
   ],
   "returns": "string"
+
  "permission": "ExecuteAddon",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "string"
==== Addons.GetAddonDetails ====
+
  },
Gets the details of a specific addon<br />
+
  "type": "method"
'''Permissions:'''
+
}</syntaxhighlight>}}==== Addons.GetAddonDetails ====Gets the details of a specific addon<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''string'' addonid<br /># [''[[#Addon.Fields|Addon.Fields]]'' properties]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# ''[[#Addon.Details|Addon.Details]]'' addon<br /># ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
* 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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Gets the details of a specific addon",
 
   "description": "Gets the details of a specific addon",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 
       "name": "addonid",
 
       "name": "addonid",
       "type": "string",
+
       "required": true,
       "required": true
+
       "type": "string"
 
     },
 
     },
 
     {
 
     {
       "name": "properties",
+
       "$ref": "Addon.Fields",
       "$ref": "Addon.Fields"
+
       "name": "properties"
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 +
      "addon": {
 +
        "$ref": "Addon.Details",
 +
        "required": true
 +
      },
 
       "limits": {
 
       "limits": {
 
         "$ref": "List.LimitsReturned",
 
         "$ref": "List.LimitsReturned",
        "required": true
 
      },
 
      "addon": {
 
        "$ref": "Addon.Details",
 
 
         "required": true
 
         "required": true
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== Addons.GetAddons ====
+
}</syntaxhighlight>}}==== Addons.GetAddons ====Gets all available addons<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># [''[[#Addon.Types|Addon.Types]]'' type = unknown]<br /># [''[[#Addon.Content|Addon.Content]]'' content = unknown] (Content provided by the addon. Only considered for plugins and scripts.)<br /># [''mixed: boolean|string'' enabled = all]<br /># [''[[#Addon.Fields|Addon.Fields]]'' properties]<br /># [''[[#List.Limits|List.Limits]]'' limits]<br /># [''mixed: boolean|string'' installed = True]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# [''array[[#Addon.Details|Addon.Details]]'' addons]<br /># ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Gets all available addons",
 
   "description": "Gets all available addons",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
       "name": "type",
+
       "$ref": "Addon.Types",
       "$ref": "Addon.Types"
+
      "default": "unknown",
 +
       "name": "type"
 
     },
 
     },
 
     {
 
     {
      "name": "content",
 
 
       "$ref": "Addon.Content",
 
       "$ref": "Addon.Content",
       "description": "Content provided by the addon. Only considered for plugins and scripts."
+
      "default": "unknown",
 +
       "description": "Content provided by the addon. Only considered for plugins and scripts.",
 +
      "name": "content"
 
     },
 
     },
 
     {
 
     {
 +
      "default": "all",
 
       "name": "enabled",
 
       "name": "enabled",
 
       "type": [
 
       "type": [
Line 350: Line 288:
 
         },
 
         },
 
         {
 
         {
           "type": "string",
+
           "enums": [
          "enum": [
 
 
             "all"
 
             "all"
           ]
+
           ],
 +
          "type": "string"
 
         }
 
         }
       ],
+
       ]
      "default": "all"
 
 
     },
 
     },
 
     {
 
     {
       "name": "properties",
+
       "$ref": "Addon.Fields",
       "$ref": "Addon.Fields"
+
       "name": "properties"
 
     },
 
     },
 
     {
 
     {
       "name": "limits",
+
       "$ref": "List.Limits",
       "$ref": "List.Limits"
+
       "name": "limits"
 
     },
 
     },
 
     {
 
     {
 +
      "default": true,
 
       "name": "installed",
 
       "name": "installed",
 
       "type": [
 
       "type": [
Line 373: Line 311:
 
         },
 
         },
 
         {
 
         {
           "type": "string",
+
           "enums": [
          "enum": [
 
 
             "all"
 
             "all"
           ]
+
           ],
 +
          "type": "string"
 
         }
 
         }
       ],
+
       ]
      "default": true
 
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 +
      "addons": {
 +
        "items": {
 +
          "$ref": "Addon.Details"
 +
        },
 +
        "type": "array"
 +
      },
 
       "limits": {
 
       "limits": {
 
         "$ref": "List.LimitsReturned",
 
         "$ref": "List.LimitsReturned",
 
         "required": true
 
         "required": true
      },
 
      "addons": {
 
        "type": "array",
 
        "items": {
 
          "$ref": "Addon.Details"
 
        }
 
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== Addons.SetAddonEnabled ====
+
}</syntaxhighlight>}}==== Addons.SetAddonEnabled ====Enables/Disables a specific addon<br />'''Permissions:'''* ManageAddon'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''string'' addonid<br /># ''[[#Global.Toggle|Global.Toggle]]'' enabled<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
Enables/Disables a specific addon<br />
 
'''Permissions:'''
 
* ManageAddon
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' addonid<br />
 
# ''[[#Global.Toggle|Global.Toggle]]'' enabled<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Enables/Disables a specific addon",
 
   "description": "Enables/Disables a specific addon",
  "transport": "Response",
 
  "permission": "ManageAddon",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 
       "name": "addonid",
 
       "name": "addonid",
       "type": "string",
+
       "required": true,
       "required": true
+
       "type": "string"
 
     },
 
     },
 
     {
 
     {
 +
      "$ref": "Global.Toggle",
 
       "name": "enabled",
 
       "name": "enabled",
      "$ref": "Global.Toggle",
 
 
       "required": true
 
       "required": true
 
     }
 
     }
 
   ],
 
   ],
   "returns": "string"
+
  "permission": "ManageAddon",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "string"
=== Application ===
+
  },
==== Application.GetProperties ====
+
  "type": "method"
Retrieves the values of the given properties<br />
+
}</syntaxhighlight>}}=== Application ======= Application.GetProperties ====Retrieves the values of the given properties<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''array'' properties<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''[[#Application.Property.Value|Application.Property.Value]]''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
'''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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Retrieves the values of the given properties",
 
   "description": "Retrieves the values of the given properties",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "items": {
 +
        "$ref": "Application.Property.Name"
 +
      },
 
       "name": "properties",
 
       "name": "properties",
 +
      "required": true,
 
       "type": "array",
 
       "type": "array",
       "uniqueItems": true,
+
       "uniqueItems": true
      "required": true,
 
      "items": {
 
        "$ref": "Application.Property.Name"
 
      }
 
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
     "$ref": "Application.Property.Value",
+
     "$ref": "Application.Property.Value"
    "required": true
+
  },
  }
+
  "type": "method"
}
+
}</syntaxhighlight>}}==== Application.Quit ====Quit application<br />'''Permissions:'''* ControlPower'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
</syntaxhighlight>}}
 
==== Application.Quit ====
 
Quit application<br />
 
'''Permissions:'''
 
* ControlPower
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Quit application",
 
   "description": "Quit application",
   "transport": "Response",
+
   "params": [],
 
   "permission": "ControlPower",
 
   "permission": "ControlPower",
   "params": [],
+
   "returns": {
   "returns": "string"
+
    "type": "string"
}
+
  },
</syntaxhighlight>}}
+
   "type": "method"
==== Application.SetMute ====
+
}</syntaxhighlight>}}==== Application.SetMute ====Toggle mute/unmute<br />'''Permissions:'''* ControlPlayback'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''[[#Global.Toggle|Global.Toggle]]'' mute<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''boolean (Mute state)''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
Toggle mute/unmute<br />
 
'''Permissions:'''
 
* ControlPlayback
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Global.Toggle|Global.Toggle]]'' mute<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''boolean (Mute state)''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Toggle mute/unmute",
 
   "description": "Toggle mute/unmute",
  "transport": "Response",
 
  "permission": "ControlPlayback",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "$ref": "Global.Toggle",
 
       "name": "mute",
 
       "name": "mute",
       "required": true,
+
       "required": true
      "$ref": "Global.Toggle"
 
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ControlPlayback",
 
   "returns": {
 
   "returns": {
     "type": "boolean",
+
     "description": "Mute state",
     "description": "Mute state"
+
     "type": "boolean"
   }
+
   },
}
+
  "type": "method"
</syntaxhighlight>}}
+
}</syntaxhighlight>}}==== Application.SetVolume ====Set the current volume<br />'''Permissions:'''* ControlPlayback'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''mixed: integer|[[#Global.IncrementDecrement|Global.IncrementDecrement]]'' volume<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''integer''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
==== Application.SetVolume ====
 
Set the current volume<br />
 
'''Permissions:'''
 
* ControlPlayback
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''mixed: integer|[[#Global.IncrementDecrement|Global.IncrementDecrement]]'' volume<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''integer''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Set the current volume",
 
   "description": "Set the current volume",
  "transport": "Response",
 
  "permission": "ControlPlayback",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 
       "name": "volume",
 
       "name": "volume",
 +
      "required": true,
 
       "type": [
 
       "type": [
 
         {
 
         {
           "type": "integer",
+
           "maximum": 100,
 
           "minimum": 0,
 
           "minimum": 0,
           "maximum": 100,
+
           "type": "integer"
          "required": true
 
 
         },
 
         },
 
         {
 
         {
           "$ref": "Global.IncrementDecrement",
+
           "$ref": "Global.IncrementDecrement"
          "required": true
 
 
         }
 
         }
       ],
+
       ]
      "required": true
 
 
     }
 
     }
 
   ],
 
   ],
   "returns": "integer"
+
  "permission": "ControlPlayback",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "integer"
=== AudioLibrary ===
+
  },
==== AudioLibrary.Clean ====
+
  "type": "method"
Cleans the audio library from non-existent items<br />
+
}</syntaxhighlight>}}=== AudioLibrary ======= AudioLibrary.Clean ====Cleans the audio library from non-existent items<br />'''Permissions:'''* RemoveData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
'''Permissions:'''
 
* RemoveData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Cleans the audio library from non-existent items",
 
   "description": "Cleans the audio library from non-existent items",
  "transport": "Response",
 
  "permission": "RemoveData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "default": true,
 +
      "description": "Whether or not to show the progress bar or any other GUI dialog",
 
       "name": "showdialogs",
 
       "name": "showdialogs",
       "type": "boolean",
+
       "type": "boolean"
      "default": true,
 
      "description": "Whether or not to show the progress bar or any other GUI dialog"
 
 
     }
 
     }
 
   ],
 
   ],
   "returns": "string"
+
  "permission": "RemoveData",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "string"
==== AudioLibrary.Export ====
+
  },
Exports all items from the audio library<br />
+
  "type": "method"
'''Permissions:'''
+
}</syntaxhighlight>}}==== AudioLibrary.Export ====Exports all items from the audio library<br />'''Permissions:'''* WriteFile'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># [''mixed: object|object'' options]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
* WriteFile
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''mixed: object|object'' options]<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Exports all items from the audio library",
 
   "description": "Exports all items from the audio library",
  "transport": "Response",
 
  "permission": "WriteFile",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
Line 610: Line 441:
 
       "type": [
 
       "type": [
 
         {
 
         {
          "type": "object",
 
          "required": true,
 
 
           "additionalProperties": false,
 
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "path": {
 
             "path": {
               "type": "string",
+
               "description": "Path to the directory to where the data should be exported",
 +
              "minLength": 1,
 
               "required": true,
 
               "required": true,
               "minLength": 1,
+
               "type": "string"
              "description": "Path to the directory to where the data should be exported"
 
 
             }
 
             }
           }
+
           },
 +
          "type": "object"
 
         },
 
         },
 
         {
 
         {
          "type": "object",
 
          "required": true,
 
 
           "additionalProperties": false,
 
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
             "overwrite": {
+
             "images": {
              "type": "boolean",
 
 
               "default": false,
 
               "default": false,
               "description": "Whether to overwrite existing exported files"
+
               "description": "Whether to export thumbnails and fanart images",
 +
              "type": "boolean"
 
             },
 
             },
             "images": {
+
             "overwrite": {
              "type": "boolean",
 
 
               "default": false,
 
               "default": false,
               "description": "Whether to export thumbnails and fanart images"
+
               "description": "Whether to overwrite existing exported files",
 +
              "type": "boolean"
 
             }
 
             }
           }
+
           },
 +
          "type": "object"
 
         }
 
         }
 
       ]
 
       ]
 
     }
 
     }
 
   ],
 
   ],
   "returns": "string"
+
  "permission": "WriteFile",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "string"
==== AudioLibrary.GetAlbumDetails ====
+
  },
Retrieve details about a specific album<br />
+
  "type": "method"
'''Permissions:'''
+
}</syntaxhighlight>}}==== AudioLibrary.GetAlbumDetails ====Retrieve details about a specific album<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''[[#Library.Id|Library.Id]]'' albumid<br /># [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# [''[[#Audio.Details.Album|Audio.Details.Album]]'' albumdetails]<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' albumid<br />
 
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# [''[[#Audio.Details.Album|Audio.Details.Album]]'' albumdetails]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Retrieve details about a specific album",
 
   "description": "Retrieve details about a specific album",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "$ref": "Library.Id",
 
       "name": "albumid",
 
       "name": "albumid",
      "$ref": "Library.Id",
 
 
       "required": true
 
       "required": true
 
     },
 
     },
 
     {
 
     {
       "name": "properties",
+
       "$ref": "Audio.Fields.Album",
       "$ref": "Audio.Fields.Album"
+
       "name": "properties"
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 
       "albumdetails": {
 
       "albumdetails": {
 
         "$ref": "Audio.Details.Album"
 
         "$ref": "Audio.Details.Album"
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== AudioLibrary.GetAlbums ====
+
}</syntaxhighlight>}}==== AudioLibrary.GetAlbums ====Retrieve all albums from specified artist (and role) or that has songs of the specified genre<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br /># [''[[#List.Limits|List.Limits]]'' limits]<br /># [''[[#List.Sort|List.Sort]]'' sort]<br /># [''mixed: object|object|object|object|object|object|object|object|[[#List.Filter.Albums|List.Filter.Albums]]'' filter]<br /># [''boolean'' includesingles = False]<br /># [''boolean'' allroles = False] (Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.)<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# [''array[[#Audio.Details.Album|Audio.Details.Album]]'' albums]<br /># ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Retrieve all albums from specified artist (and role) or that has songs of the specified genre",
 
   "description": "Retrieve all albums from specified artist (and role) or that has songs of the specified genre",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
       "name": "properties",
+
       "$ref": "Audio.Fields.Album",
       "$ref": "Audio.Fields.Album"
+
       "name": "properties"
 
     },
 
     },
 
     {
 
     {
       "name": "limits",
+
       "$ref": "List.Limits",
       "$ref": "List.Limits"
+
       "name": "limits"
 
     },
 
     },
 
     {
 
     {
       "name": "sort",
+
       "$ref": "List.Sort",
       "$ref": "List.Sort"
+
       "name": "sort"
 
     },
 
     },
 
     {
 
     {
Line 730: Line 518:
 
       "type": [
 
       "type": [
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "genreid": {
 
             "genreid": {
 
               "$ref": "Library.Id",
 
               "$ref": "Library.Id",
              "required": true,
+
               "description": "Song genre. Filter for existence of songs with this genre",
               "description": "Song genre. Filter for existence of songs with this genre"
+
              "required": true
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "genre": {
 
             "genre": {
               "type": "string",
+
               "description": "Song genre. Filter for existence of songs with this genre",
 
               "minLength": 1,
 
               "minLength": 1,
 
               "required": true,
 
               "required": true,
               "description": "Song genre. Filter for existence of songs with this genre"
+
               "type": "string"
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "artistid": {
 
             "artistid": {
Line 760: Line 548:
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "artistid": {
 
             "artistid": {
Line 774: Line 562:
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "artistid": {
 
             "artistid": {
Line 784: Line 572:
 
             },
 
             },
 
             "role": {
 
             "role": {
              "type": "string",
 
 
               "minLength": 1,
 
               "minLength": 1,
               "required": true
+
               "required": true,
 +
              "type": "string"
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "artist": {
 
             "artist": {
              "type": "string",
 
 
               "minLength": 1,
 
               "minLength": 1,
               "required": true
+
               "required": true,
 +
              "type": "string"
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "artist": {
 
             "artist": {
              "type": "string",
 
 
               "minLength": 1,
 
               "minLength": 1,
               "required": true
+
               "required": true,
 +
              "type": "string"
 
             },
 
             },
 
             "roleid": {
 
             "roleid": {
Line 815: Line 603:
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "artist": {
 
             "artist": {
              "type": "string",
 
 
               "minLength": 1,
 
               "minLength": 1,
               "required": true
+
               "required": true,
 +
              "type": "string"
 
             },
 
             },
 
             "role": {
 
             "role": {
              "type": "string",
 
 
               "minLength": 1,
 
               "minLength": 1,
               "required": true
+
               "required": true,
 +
              "type": "string"
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
Line 839: Line 627:
 
     },
 
     },
 
     {
 
     {
 +
      "default": false,
 
       "name": "includesingles",
 
       "name": "includesingles",
       "type": "boolean",
+
       "type": "boolean"
      "default": false
 
 
     },
 
     },
 
     {
 
     {
 +
      "default": false,
 +
      "description": "Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.",
 
       "name": "allroles",
 
       "name": "allroles",
       "type": "boolean",
+
       "type": "boolean"
      "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."
 
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 +
      "albums": {
 +
        "items": {
 +
          "$ref": "Audio.Details.Album"
 +
        },
 +
        "type": "array"
 +
      },
 
       "limits": {
 
       "limits": {
 
         "$ref": "List.LimitsReturned",
 
         "$ref": "List.LimitsReturned",
 
         "required": true
 
         "required": true
      },
 
      "albums": {
 
        "type": "array",
 
        "items": {
 
          "$ref": "Audio.Details.Album"
 
        }
 
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== AudioLibrary.GetArtistDetails ====
+
}</syntaxhighlight>}}==== AudioLibrary.GetArtistDetails ====Retrieve details about a specific artist<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''[[#Library.Id|Library.Id]]'' artistid<br /># [''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# [''[[#Audio.Details.Artist|Audio.Details.Artist]]'' artistdetails]<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
Retrieve details about a specific artist<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' artistid<br />
 
# [''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties]<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# [''[[#Audio.Details.Artist|Audio.Details.Artist]]'' artistdetails]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Retrieve details about a specific artist",
 
   "description": "Retrieve details about a specific artist",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "$ref": "Library.Id",
 
       "name": "artistid",
 
       "name": "artistid",
      "$ref": "Library.Id",
 
 
       "required": true
 
       "required": true
 
     },
 
     },
 
     {
 
     {
       "name": "properties",
+
       "$ref": "Audio.Fields.Artist",
       "$ref": "Audio.Fields.Artist"
+
       "name": "properties"
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 
       "artistdetails": {
 
       "artistdetails": {
 
         "$ref": "Audio.Details.Artist"
 
         "$ref": "Audio.Details.Artist"
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== AudioLibrary.GetArtists ====
+
}</syntaxhighlight>}}==== AudioLibrary.GetArtists ====Retrieve all artists. For backward compatibility by default this implicity does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># [''[[#Optional.Boolean|Optional.Boolean]]'' albumartistsonly = None] (Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used)<br /># [''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties]<br /># [''[[#List.Limits|List.Limits]]'' limits]<br /># [''[[#List.Sort|List.Sort]]'' sort]<br /># [''mixed: object|object|object|object|object|object|object|object|object|object|object|object|object|object|object|[[#List.Filter.Artists|List.Filter.Artists]]'' filter]<br /># [''boolean'' allroles = False] (Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.)<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# [''array[[#Audio.Details.Artist|Audio.Details.Artist]]'' artists]<br /># ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
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|<syntaxhighlight enclose="div">
 
{
 
  "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",
 
   "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": [
 
   "params": [
 
     {
 
     {
      "name": "albumartistsonly",
 
 
       "$ref": "Optional.Boolean",
 
       "$ref": "Optional.Boolean",
       "description": "Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used"
+
      "default": null,
 +
       "description": "Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used",
 +
      "name": "albumartistsonly"
 
     },
 
     },
 
     {
 
     {
       "name": "properties",
+
       "$ref": "Audio.Fields.Artist",
       "$ref": "Audio.Fields.Artist"
+
       "name": "properties"
 
     },
 
     },
 
     {
 
     {
       "name": "limits",
+
       "$ref": "List.Limits",
       "$ref": "List.Limits"
+
       "name": "limits"
 
     },
 
     },
 
     {
 
     {
       "name": "sort",
+
       "$ref": "List.Sort",
       "$ref": "List.Sort"
+
       "name": "sort"
 
     },
 
     },
 
     {
 
     {
Line 957: Line 703:
 
       "type": [
 
       "type": [
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "genreid": {
 
             "genreid": {
 
               "$ref": "Library.Id",
 
               "$ref": "Library.Id",
              "required": true,
+
               "description": "Deprecated, use songgenreid. Filter for existence of songs with this genre",
               "description": "Deprecated, use songgenreid. Filter for existence of songs with this genre"
+
              "required": true
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "songgenreid": {
 
             "songgenreid": {
 
               "$ref": "Library.Id",
 
               "$ref": "Library.Id",
              "required": true,
+
               "description": "Song genreid. Filter for existence of songs with this genre",
               "description": "Song genreid. Filter for existence of songs with this genre"
+
              "required": true
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
             "songgenreid": {
+
             "roleid": {
 
               "$ref": "Library.Id",
 
               "$ref": "Library.Id",
 
               "required": true
 
               "required": true
 
             },
 
             },
             "roleid": {
+
             "songgenreid": {
 
               "$ref": "Library.Id",
 
               "$ref": "Library.Id",
 
               "required": true
 
               "required": true
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 +
            "role": {
 +
              "minLength": 1,
 +
              "required": true,
 +
              "type": "string"
 +
            },
 
             "songgenreid": {
 
             "songgenreid": {
 
               "$ref": "Library.Id",
 
               "$ref": "Library.Id",
              "required": true
 
            },
 
            "role": {
 
              "type": "string",
 
              "minLength": 1,
 
 
               "required": true
 
               "required": true
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "genre": {
 
             "genre": {
               "type": "string",
+
               "description": "Deprecated, use songgenre. Filter for existence of songs with this genre",
 
               "minLength": 1,
 
               "minLength": 1,
 
               "required": true,
 
               "required": true,
               "description": "Deprecated, use songgenre. Filter for existence of songs with this genre"
+
               "type": "string"
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "songgenre": {
 
             "songgenre": {
               "type": "string",
+
               "description": "Song genre. Filter for existence of songs with this genre",
 
               "minLength": 1,
 
               "minLength": 1,
 
               "required": true,
 
               "required": true,
               "description": "Song genre. Filter for existence of songs with this genre"
+
               "type": "string"
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
            "songgenre": {
 
              "type": "string",
 
              "minLength": 1,
 
              "required": true
 
            },
 
 
             "roleid": {
 
             "roleid": {
 
               "$ref": "Library.Id",
 
               "$ref": "Library.Id",
 
               "required": true
 
               "required": true
 +
            },
 +
            "songgenre": {
 +
              "minLength": 1,
 +
              "required": true,
 +
              "type": "string"
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
             "songgenre": {
+
             "role": {
              "type": "string",
 
 
               "minLength": 1,
 
               "minLength": 1,
               "required": true
+
               "required": true,
 +
              "type": "string"
 
             },
 
             },
             "role": {
+
             "songgenre": {
              "type": "string",
 
 
               "minLength": 1,
 
               "minLength": 1,
               "required": true
+
               "required": true,
 +
              "type": "string"
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "albumid": {
 
             "albumid": {
Line 1,070: Line 816:
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "album": {
 
             "album": {
              "type": "string",
 
 
               "minLength": 1,
 
               "minLength": 1,
               "required": true
+
               "required": true,
 +
              "type": "string"
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "songid": {
 
             "songid": {
Line 1,091: Line 837:
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
             "songid": {
+
             "roleid": {
 
               "$ref": "Library.Id",
 
               "$ref": "Library.Id",
 
               "required": true
 
               "required": true
 
             },
 
             },
             "roleid": {
+
             "songid": {
 
               "$ref": "Library.Id",
 
               "$ref": "Library.Id",
 
               "required": true
 
               "required": true
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 +
            "role": {
 +
              "minLength": 1,
 +
              "required": true,
 +
              "type": "string"
 +
            },
 
             "songid": {
 
             "songid": {
 
               "$ref": "Library.Id",
 
               "$ref": "Library.Id",
 
               "required": true
 
               "required": true
            },
+
             }
            "role": {
+
           },
              "type": "string",
+
           "type": "object"
              "minLength": 1,
 
              "required": true
 
             }
 
           },
 
           "additionalProperties": false
 
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "roleid": {
 
             "roleid": {
 
               "$ref": "Library.Id",
 
               "$ref": "Library.Id",
              "required": true,
+
               "description": "Role contributed by artist. Overridden by allroles parameter",
               "description": "Role contributed by artist. Overridden by allroles parameter"
+
              "required": true
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "role": {
 
             "role": {
               "type": "string",
+
               "description": "Role contributed by artist. Overridden by allroles parameter",
 
               "minLength": 1,
 
               "minLength": 1,
 
               "required": true,
 
               "required": true,
               "description": "Role contributed by artist. Overridden by allroles parameter"
+
               "type": "string"
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
Line 1,151: Line 897:
 
     },
 
     },
 
     {
 
     {
 +
      "default": false,
 +
      "description": "Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.",
 
       "name": "allroles",
 
       "name": "allroles",
       "type": "boolean",
+
       "type": "boolean"
      "default": false,
 
      "description": "Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value."
 
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 +
      "artists": {
 +
        "items": {
 +
          "$ref": "Audio.Details.Artist"
 +
        },
 +
        "type": "array"
 +
      },
 
       "limits": {
 
       "limits": {
 
         "$ref": "List.LimitsReturned",
 
         "$ref": "List.LimitsReturned",
 
         "required": true
 
         "required": true
      },
 
      "artists": {
 
        "type": "array",
 
        "items": {
 
          "$ref": "Audio.Details.Artist"
 
        }
 
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== AudioLibrary.GetGenres ====
+
}</syntaxhighlight>}}==== AudioLibrary.GetGenres ====Retrieve all genres<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># [''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties]<br /># [''[[#List.Limits|List.Limits]]'' limits]<br /># [''[[#List.Sort|List.Sort]]'' sort]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# ''array[[#Library.Details.Genre|Library.Details.Genre]]'' genres<br /># ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Retrieve all genres",
 
   "description": "Retrieve all genres",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
       "name": "properties",
+
       "$ref": "Library.Fields.Genre",
       "$ref": "Library.Fields.Genre"
+
       "name": "properties"
 
     },
 
     },
 
     {
 
     {
       "name": "limits",
+
       "$ref": "List.Limits",
       "$ref": "List.Limits"
+
       "name": "limits"
 
     },
 
     },
 
     {
 
     {
       "name": "sort",
+
       "$ref": "List.Sort",
       "$ref": "List.Sort"
+
       "name": "sort"
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 +
      "genres": {
 +
        "items": {
 +
          "$ref": "Library.Details.Genre"
 +
        },
 +
        "required": true,
 +
        "type": "array"
 +
      },
 
       "limits": {
 
       "limits": {
 
         "$ref": "List.LimitsReturned",
 
         "$ref": "List.LimitsReturned",
 
         "required": true
 
         "required": true
      },
 
      "genres": {
 
        "type": "array",
 
        "required": true,
 
        "items": {
 
          "$ref": "Library.Details.Genre"
 
        }
 
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== AudioLibrary.GetProperties ====
+
}</syntaxhighlight>}}==== AudioLibrary.GetProperties ====Retrieves the values of the music library properties<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''array'' properties<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''[[#Audio.Property.Value|Audio.Property.Value]]''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Retrieves the values of the music library properties",
 
   "description": "Retrieves the values of the music library properties",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "items": {
 +
        "$ref": "Audio.Property.Name"
 +
      },
 
       "name": "properties",
 
       "name": "properties",
 +
      "required": true,
 
       "type": "array",
 
       "type": "array",
       "uniqueItems": true,
+
       "uniqueItems": true
      "required": true,
 
      "items": {
 
        "$ref": "Audio.Property.Name"
 
      }
 
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
     "$ref": "Audio.Property.Value",
+
     "$ref": "Audio.Property.Value"
    "required": true
+
  },
  }
+
  "type": "method"
}
+
}</syntaxhighlight>}}==== AudioLibrary.GetRecentlyAddedAlbums ====Retrieve recently added albums<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br /># [''[[#List.Limits|List.Limits]]'' limits]<br /># [''[[#List.Sort|List.Sort]]'' sort]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# [''array[[#Audio.Details.Album|Audio.Details.Album]]'' albums]<br /># ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
</syntaxhighlight>}}
 
==== AudioLibrary.GetRecentlyAddedAlbums ====
 
Retrieve recently added albums<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Retrieve recently added albums",
 
   "description": "Retrieve recently added albums",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
       "name": "properties",
+
       "$ref": "Audio.Fields.Album",
       "$ref": "Audio.Fields.Album"
+
       "name": "properties"
 
     },
 
     },
 
     {
 
     {
       "name": "limits",
+
       "$ref": "List.Limits",
       "$ref": "List.Limits"
+
       "name": "limits"
 
     },
 
     },
 
     {
 
     {
       "name": "sort",
+
       "$ref": "List.Sort",
       "$ref": "List.Sort"
+
       "name": "sort"
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 +
      "albums": {
 +
        "items": {
 +
          "$ref": "Audio.Details.Album"
 +
        },
 +
        "type": "array"
 +
      },
 
       "limits": {
 
       "limits": {
 
         "$ref": "List.LimitsReturned",
 
         "$ref": "List.LimitsReturned",
 
         "required": true
 
         "required": true
      },
 
      "albums": {
 
        "type": "array",
 
        "items": {
 
          "$ref": "Audio.Details.Album"
 
        }
 
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== AudioLibrary.GetRecentlyAddedSongs ====
+
}</syntaxhighlight>}}==== AudioLibrary.GetRecentlyAddedSongs ====Retrieve recently added songs<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># [''[[#List.Amount|List.Amount]]'' albumlimit = -1] (The amount of recently added albums from which to return the songs)<br /># [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br /># [''[[#List.Limits|List.Limits]]'' limits]<br /># [''[[#List.Sort|List.Sort]]'' sort]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /># [''array[[#Audio.Details.Song|Audio.Details.Song]]'' songs]<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Retrieve recently added songs",
 
   "description": "Retrieve recently added songs",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
      "name": "albumlimit",
 
 
       "$ref": "List.Amount",
 
       "$ref": "List.Amount",
       "description": "The amount of recently added albums from which to return the songs"
+
      "default": -1,
 +
       "description": "The amount of recently added albums from which to return the songs",
 +
      "name": "albumlimit"
 
     },
 
     },
 
     {
 
     {
       "name": "properties",
+
       "$ref": "Audio.Fields.Song",
       "$ref": "Audio.Fields.Song"
+
       "name": "properties"
 
     },
 
     },
 
     {
 
     {
       "name": "limits",
+
       "$ref": "List.Limits",
       "$ref": "List.Limits"
+
       "name": "limits"
 
     },
 
     },
 
     {
 
     {
       "name": "sort",
+
       "$ref": "List.Sort",
       "$ref": "List.Sort"
+
       "name": "sort"
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 
       "limits": {
 
       "limits": {
Line 1,369: Line 1,035:
 
       },
 
       },
 
       "songs": {
 
       "songs": {
        "type": "array",
 
 
         "items": {
 
         "items": {
 
           "$ref": "Audio.Details.Song"
 
           "$ref": "Audio.Details.Song"
         }
+
         },
 +
        "type": "array"
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== AudioLibrary.GetRecentlyPlayedAlbums ====
+
}</syntaxhighlight>}}==== AudioLibrary.GetRecentlyPlayedAlbums ====Retrieve recently played albums<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br /># [''[[#List.Limits|List.Limits]]'' limits]<br /># [''[[#List.Sort|List.Sort]]'' sort]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# [''array[[#Audio.Details.Album|Audio.Details.Album]]'' albums]<br /># ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Retrieve recently played albums",
 
   "description": "Retrieve recently played albums",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
       "name": "properties",
+
       "$ref": "Audio.Fields.Album",
       "$ref": "Audio.Fields.Album"
+
       "name": "properties"
 
     },
 
     },
 
     {
 
     {
       "name": "limits",
+
       "$ref": "List.Limits",
       "$ref": "List.Limits"
+
       "name": "limits"
 
     },
 
     },
 
     {
 
     {
       "name": "sort",
+
       "$ref": "List.Sort",
       "$ref": "List.Sort"
+
       "name": "sort"
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 +
      "albums": {
 +
        "items": {
 +
          "$ref": "Audio.Details.Album"
 +
        },
 +
        "type": "array"
 +
      },
 
       "limits": {
 
       "limits": {
 
         "$ref": "List.LimitsReturned",
 
         "$ref": "List.LimitsReturned",
 
         "required": true
 
         "required": true
      },
 
      "albums": {
 
        "type": "array",
 
        "items": {
 
          "$ref": "Audio.Details.Album"
 
        }
 
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== AudioLibrary.GetRecentlyPlayedSongs ====
+
}</syntaxhighlight>}}==== AudioLibrary.GetRecentlyPlayedSongs ====Retrieve recently played songs<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br /># [''[[#List.Limits|List.Limits]]'' limits]<br /># [''[[#List.Sort|List.Sort]]'' sort]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /># [''array[[#Audio.Details.Song|Audio.Details.Song]]'' songs]<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
Retrieve recently played songs<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# [''array[[#Audio.Details.Song|Audio.Details.Song]]'' songs]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Retrieve recently played songs",
 
   "description": "Retrieve recently played songs",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
       "name": "properties",
+
       "$ref": "Audio.Fields.Song",
       "$ref": "Audio.Fields.Song"
+
       "name": "properties"
 
     },
 
     },
 
     {
 
     {
       "name": "limits",
+
       "$ref": "List.Limits",
       "$ref": "List.Limits"
+
       "name": "limits"
 
     },
 
     },
 
     {
 
     {
       "name": "sort",
+
       "$ref": "List.Sort",
       "$ref": "List.Sort"
+
       "name": "sort"
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 
       "limits": {
 
       "limits": {
Line 1,477: Line 1,101:
 
       },
 
       },
 
       "songs": {
 
       "songs": {
        "type": "array",
 
 
         "items": {
 
         "items": {
 
           "$ref": "Audio.Details.Song"
 
           "$ref": "Audio.Details.Song"
         }
+
         },
 +
        "type": "array"
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== AudioLibrary.GetRoles ====
+
}</syntaxhighlight>}}==== AudioLibrary.GetRoles ====Retrieve all contributor roles<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># [''[[#Audio.Fields.Role|Audio.Fields.Role]]'' properties]<br /># [''[[#List.Limits|List.Limits]]'' limits]<br /># [''[[#List.Sort|List.Sort]]'' sort]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /># ''array[[#Audio.Details.Role|Audio.Details.Role]]'' roles<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
Retrieve all contributor roles<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#Audio.Fields.Role|Audio.Fields.Role]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# ''array[[#Audio.Details.Role|Audio.Details.Role]]'' roles<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Retrieve all contributor roles",
 
   "description": "Retrieve all contributor roles",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
       "name": "properties",
+
       "$ref": "Audio.Fields.Role",
       "$ref": "Audio.Fields.Role"
+
       "name": "properties"
 
     },
 
     },
 
     {
 
     {
       "name": "limits",
+
       "$ref": "List.Limits",
       "$ref": "List.Limits"
+
       "name": "limits"
 
     },
 
     },
 
     {
 
     {
       "name": "sort",
+
       "$ref": "List.Sort",
       "$ref": "List.Sort"
+
       "name": "sort"
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 
       "limits": {
 
       "limits": {
Line 1,531: Line 1,134:
 
       },
 
       },
 
       "roles": {
 
       "roles": {
        "type": "array",
 
        "required": true,
 
 
         "items": {
 
         "items": {
 
           "$ref": "Audio.Details.Role"
 
           "$ref": "Audio.Details.Role"
         }
+
         },
 +
        "required": true,
 +
        "type": "array"
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== AudioLibrary.GetSongDetails ====
+
}</syntaxhighlight>}}==== AudioLibrary.GetSongDetails ====Retrieve details about a specific song<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''[[#Library.Id|Library.Id]]'' songid<br /># [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# [''[[#Audio.Details.Song|Audio.Details.Song]]'' songdetails]<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
Retrieve details about a specific song<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' songid<br />
 
# [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# [''[[#Audio.Details.Song|Audio.Details.Song]]'' songdetails]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Retrieve details about a specific song",
 
   "description": "Retrieve details about a specific song",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "$ref": "Library.Id",
 
       "name": "songid",
 
       "name": "songid",
      "$ref": "Library.Id",
 
 
       "required": true
 
       "required": true
 
     },
 
     },
 
     {
 
     {
       "name": "properties",
+
       "$ref": "Audio.Fields.Song",
       "$ref": "Audio.Fields.Song"
+
       "name": "properties"
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 
       "songdetails": {
 
       "songdetails": {
 
         "$ref": "Audio.Details.Song"
 
         "$ref": "Audio.Details.Song"
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== AudioLibrary.GetSongs ====
+
}</syntaxhighlight>}}==== AudioLibrary.GetSongs ====Retrieve all songs from specified album, artist or genre<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br /># [''[[#List.Limits|List.Limits]]'' limits]<br /># [''[[#List.Sort|List.Sort]]'' sort]<br /># [''mixed: object|object|object|object|object|object|object|object|object|object|[[#List.Filter.Songs|List.Filter.Songs]]'' filter]<br /># [''boolean'' includesingles = True] (Only songs from albums are returned when false, but 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|<syntaxhighlight enclose="div">{
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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Retrieve all songs from specified album, artist or genre",
 
   "description": "Retrieve all songs from specified album, artist or genre",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
       "name": "properties",
+
       "$ref": "Audio.Fields.Song",
       "$ref": "Audio.Fields.Song"
+
       "name": "properties"
 
     },
 
     },
 
     {
 
     {
       "name": "limits",
+
       "$ref": "List.Limits",
       "$ref": "List.Limits"
+
       "name": "limits"
 
     },
 
     },
 
     {
 
     {
       "name": "sort",
+
       "$ref": "List.Sort",
       "$ref": "List.Sort"
+
       "name": "sort"
 
     },
 
     },
 
     {
 
     {
Line 1,627: Line 1,186:
 
       "type": [
 
       "type": [
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "genreid": {
 
             "genreid": {
 
               "$ref": "Library.Id",
 
               "$ref": "Library.Id",
              "required": true,
+
               "description": "Song genre. Filter for existence of songs with this genre",
               "description": "Song genre. Filter for existence of songs with this genre"
+
              "required": true
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "genre": {
 
             "genre": {
               "type": "string",
+
               "description": "Song genre. Filter for existence of songs with this genre",
 
               "minLength": 1,
 
               "minLength": 1,
 
               "required": true,
 
               "required": true,
               "description": "Song genre. Filter for existence of songs with this genre"
+
               "type": "string"
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "artistid": {
 
             "artistid": {
Line 1,657: Line 1,216:
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "artistid": {
 
             "artistid": {
Line 1,671: Line 1,230:
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "artistid": {
 
             "artistid": {
Line 1,681: Line 1,240:
 
             },
 
             },
 
             "role": {
 
             "role": {
              "type": "string",
 
 
               "minLength": 1,
 
               "minLength": 1,
               "required": true
+
               "required": true,
 +
              "type": "string"
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "artist": {
 
             "artist": {
              "type": "string",
 
 
               "minLength": 1,
 
               "minLength": 1,
               "required": true
+
               "required": true,
 +
              "type": "string"
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "artist": {
 
             "artist": {
              "type": "string",
 
 
               "minLength": 1,
 
               "minLength": 1,
               "required": true
+
               "required": true,
 +
              "type": "string"
 
             },
 
             },
 
             "roleid": {
 
             "roleid": {
Line 1,712: Line 1,271:
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "artist": {
 
             "artist": {
              "type": "string",
 
 
               "minLength": 1,
 
               "minLength": 1,
               "required": true
+
               "required": true,
 +
              "type": "string"
 
             },
 
             },
 
             "role": {
 
             "role": {
              "type": "string",
 
 
               "minLength": 1,
 
               "minLength": 1,
               "required": true
+
               "required": true,
 +
              "type": "string"
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "albumid": {
 
             "albumid": {
Line 1,738: Line 1,297:
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
           "type": "object",
+
           "additionalProperties": false,
 
           "properties": {
 
           "properties": {
 
             "album": {
 
             "album": {
              "type": "string",
 
 
               "minLength": 1,
 
               "minLength": 1,
               "required": true
+
               "required": true,
 +
              "type": "string"
 
             }
 
             }
 
           },
 
           },
           "additionalProperties": false
+
           "type": "object"
 
         },
 
         },
 
         {
 
         {
Line 1,757: Line 1,316:
 
     },
 
     },
 
     {
 
     {
 +
      "default": true,
 +
      "description": "Only songs from albums are returned when false, but overidden when singlesonly parameter is true",
 
       "name": "includesingles",
 
       "name": "includesingles",
       "type": "boolean",
+
       "type": "boolean"
      "default": true,
 
      "description": "Only songs from albums are returned when false, but overidden when singlesonly parameter is true"
 
 
     },
 
     },
 
     {
 
     {
 +
      "default": false,
 +
      "description": "Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.",
 
       "name": "allroles",
 
       "name": "allroles",
       "type": "boolean",
+
       "type": "boolean"
      "default": false,
 
      "description": "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."
 
 
     },
 
     },
 
     {
 
     {
 +
      "default": false,
 +
      "description": "Only singles are returned when true, and overides includesingles parameter",
 
       "name": "singlesonly",
 
       "name": "singlesonly",
       "type": "boolean",
+
       "type": "boolean"
      "default": false,
 
      "description": "Only singles are returned when true, and overides includesingles parameter"
 
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 
       "limits": {
 
       "limits": {
Line 1,783: Line 1,342:
 
       },
 
       },
 
       "songs": {
 
       "songs": {
        "type": "array",
 
 
         "items": {
 
         "items": {
 
           "$ref": "Audio.Details.Song"
 
           "$ref": "Audio.Details.Song"
         }
+
         },
 +
        "type": "array"
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== AudioLibrary.GetSources ====
+
}</syntaxhighlight>}}==== AudioLibrary.GetSources ====Get all music sources, including unique ID<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># [''[[#Library.Fields.Source|Library.Fields.Source]]'' properties]<br /># [''[[#List.Limits|List.Limits]]'' limits]<br /># [''[[#List.Sort|List.Sort]]'' sort]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /># ''array[[#Library.Details.Source|Library.Details.Source]]'' sources<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
Get all music sources, including unique ID<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''[[#Library.Fields.Source|Library.Fields.Source]]'' properties]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# ''array[[#Library.Details.Source|Library.Details.Source]]'' sources<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Get all music sources, including unique ID",
 
   "description": "Get all music sources, including unique ID",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
       "name": "properties",
+
       "$ref": "Library.Fields.Source",
       "$ref": "Library.Fields.Source"
+
       "name": "properties"
 
     },
 
     },
 
     {
 
     {
       "name": "limits",
+
       "$ref": "List.Limits",
       "$ref": "List.Limits"
+
       "name": "limits"
 
     },
 
     },
 
     {
 
     {
       "name": "sort",
+
       "$ref": "List.Sort",
       "$ref": "List.Sort"
+
       "name": "sort"
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 
       "limits": {
 
       "limits": {
Line 1,837: Line 1,375:
 
       },
 
       },
 
       "sources": {
 
       "sources": {
        "type": "array",
 
        "required": true,
 
 
         "items": {
 
         "items": {
 
           "$ref": "Library.Details.Source"
 
           "$ref": "Library.Details.Source"
         }
+
         },
 +
        "required": true,
 +
        "type": "array"
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== AudioLibrary.Scan ====
+
}</syntaxhighlight>}}==== AudioLibrary.Scan ====Scans the audio sources for new library items<br />'''Permissions:'''* UpdateData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># [''string'' directory = ""]<br /># [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
Scans the audio sources for new library items<br />
 
'''Permissions:'''
 
* UpdateData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''string'' directory = ""]<br />
 
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Scans the audio sources for new library items",
 
   "description": "Scans the audio sources for new library items",
  "transport": "Response",
 
  "permission": "UpdateData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "default": "",
 
       "name": "directory",
 
       "name": "directory",
       "type": "string",
+
       "type": "string"
      "default": ""
 
 
     },
 
     },
 
     {
 
     {
 +
      "default": true,
 +
      "description": "Whether or not to show the progress bar or any other GUI dialog",
 
       "name": "showdialogs",
 
       "name": "showdialogs",
       "type": "boolean",
+
       "type": "boolean"
      "default": true,
 
      "description": "Whether or not to show the progress bar or any other GUI dialog"
 
 
     }
 
     }
 
   ],
 
   ],
  "returns": "string"
 
}
 
</syntaxhighlight>}}
 
==== AudioLibrary.SetAlbumDetails ====
 
Update the given album with the given details<br />
 
'''Permissions:'''
 
* UpdateData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Library.Id|Library.Id]]'' albumid<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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
  "description": "Update the given album with the given details",
 
  "transport": "Response",
 
 
   "permission": "UpdateData",
 
   "permission": "UpdateData",
   "params": [
+
  "returns": {
 +
    "type": "string"
 +
  },
 +
  "type": "method"
 +
}</syntaxhighlight>}}==== AudioLibrary.SetAlbumDetails ====Update the given album with the given details<br />'''Permissions:'''* UpdateData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''[[#Library.Id|Library.Id]]'' albumid<br /># [''[[#Optional.String|Optional.String]]'' title = None]<br /># [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br /># [''[[#Optional.String|Optional.String]]'' description = None]<br /># [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br /># [''mixed: null|[[#Array.String|Array.String]]'' theme = None]<br /># [''mixed: null|[[#Array.String|Array.String]]'' mood = None]<br /># [''mixed: null|[[#Array.String|Array.String]]'' style = None]<br /># [''[[#Optional.String|Optional.String]]'' type = None]<br /># [''[[#Optional.String|Optional.String]]'' albumlabel = None]<br /># [''[[#Optional.Number|Optional.Number]]'' rating = None]<br /># [''[[#Optional.Integer|Optional.Integer]]'' year = None]<br /># [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br /># [''[[#Optional.Integer|Optional.Integer]]'' votes = None]<br /># [''[[#Optional.String|Optional.String]]'' musicbrainzalbumid = None]<br /># [''[[#Optional.String|Optional.String]]'' musicbrainzreleasegroupid = None]<br /># [''[[#Optional.String|Optional.String]]'' sortartist = None]<br /># [''[[#Optional.String|Optional.String]]'' displayartist = None]<br /># [''mixed: null|[[#Array.String|Array.String]]'' musicbrainzalbumartistid = None]<br /># [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /># [''[[#Optional.Boolean|Optional.Boolean]]'' isboxset = None]<br /># [''[[#Optional.String|Optional.String]]'' releasedate = None]<br /># [''[[#Optional.String|Optional.String]]'' originaldate = None]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
 +
  "description": "Update the given album with the given details",
 +
   "params": [
 
     {
 
     {
 +
      "$ref": "Library.Id",
 
       "name": "albumid",
 
       "name": "albumid",
      "$ref": "Library.Id",
 
 
       "required": true
 
       "required": true
 
     },
 
     },
 
     {
 
     {
       "name": "title",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "title"
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "artist",
 
       "name": "artist",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Array.String",
+
           "type": "null"
           "required": true
+
        },
 +
        {
 +
           "$ref": "Array.String"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     },
 
     },
 
     {
 
     {
       "name": "description",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "description"
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "genre",
 
       "name": "genre",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Array.String",
+
           "type": "null"
           "required": true
+
        },
 +
        {
 +
           "$ref": "Array.String"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "theme",
 
       "name": "theme",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Array.String",
+
           "type": "null"
           "required": true
+
        },
 +
        {
 +
           "$ref": "Array.String"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "mood",
 
       "name": "mood",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Array.String",
+
           "type": "null"
           "required": true
+
        },
 +
        {
 +
           "$ref": "Array.String"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "style",
 
       "name": "style",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Array.String",
+
           "type": "null"
           "required": true
+
        },
 +
        {
 +
           "$ref": "Array.String"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     },
 
     },
 
     {
 
     {
       "name": "type",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "type"
 
     },
 
     },
 
     {
 
     {
       "name": "albumlabel",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "albumlabel"
 
     },
 
     },
 
     {
 
     {
       "name": "rating",
+
       "$ref": "Optional.Number",
       "$ref": "Optional.Number"
+
      "default": null,
 +
       "name": "rating"
 
     },
 
     },
 
     {
 
     {
       "name": "year",
+
       "$ref": "Optional.Integer",
       "$ref": "Optional.Integer"
+
      "default": null,
 +
       "name": "year"
 
     },
 
     },
 
     {
 
     {
       "name": "userrating",
+
       "$ref": "Optional.Integer",
       "$ref": "Optional.Integer"
+
      "default": null,
 +
       "name": "userrating"
 
     },
 
     },
 
     {
 
     {
       "name": "votes",
+
       "$ref": "Optional.Integer",
       "$ref": "Optional.Integer"
+
      "default": null,
 +
       "name": "votes"
 
     },
 
     },
 
     {
 
     {
       "name": "musicbrainzalbumid",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "musicbrainzalbumid"
 
     },
 
     },
 
     {
 
     {
       "name": "musicbrainzreleasegroupid",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "musicbrainzreleasegroupid"
 
     },
 
     },
 
     {
 
     {
       "name": "sortartist",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "sortartist"
 
     },
 
     },
 
     {
 
     {
       "name": "displayartist",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "displayartist"
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "musicbrainzalbumartistid",
 
       "name": "musicbrainzalbumartistid",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Array.String",
+
           "type": "null"
           "required": true
+
        },
 +
        {
 +
           "$ref": "Array.String"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "art",
 
       "name": "art",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Media.Artwork.Set",
+
          "type": "null"
          "required": true
+
        },
 +
        {
 +
           "$ref": "Media.Artwork.Set"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     },
 
     },
 
     {
 
     {
       "name": "isboxset",
+
       "$ref": "Optional.Boolean",
       "$ref": "Optional.Boolean"
+
      "default": null,
 +
       "name": "isboxset"
 
     },
 
     },
 
     {
 
     {
       "name": "releasedate",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "releasedate"
 
     },
 
     },
 
     {
 
     {
       "name": "originaldate",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "originaldate"
 
     }
 
     }
 
   ],
 
   ],
   "returns": "string"
+
  "permission": "UpdateData",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "string"
==== AudioLibrary.SetArtistDetails ====
+
  },
Update the given artist with the given details<br />
+
  "type": "method"
'''Permissions:'''
+
}</syntaxhighlight>}}==== AudioLibrary.SetArtistDetails ====Update the given artist with the given details<br />'''Permissions:'''* UpdateData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''[[#Library.Id|Library.Id]]'' artistid<br /># [''[[#Optional.String|Optional.String]]'' artist = None]<br /># [''mixed: null|[[#Array.String|Array.String]]'' instrument = None]<br /># [''mixed: null|[[#Array.String|Array.String]]'' style = None]<br /># [''mixed: null|[[#Array.String|Array.String]]'' mood = None]<br /># [''[[#Optional.String|Optional.String]]'' born = None]<br /># [''[[#Optional.String|Optional.String]]'' formed = None]<br /># [''[[#Optional.String|Optional.String]]'' description = None]<br /># [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br /># [''[[#Optional.String|Optional.String]]'' died = None]<br /># [''[[#Optional.String|Optional.String]]'' disbanded = None]<br /># [''mixed: null|[[#Array.String|Array.String]]'' yearsactive = None]<br /># [''[[#Optional.String|Optional.String]]'' musicbrainzartistid = None]<br /># [''[[#Optional.String|Optional.String]]'' sortname = None]<br /># [''[[#Optional.String|Optional.String]]'' type = None]<br /># [''[[#Optional.String|Optional.String]]'' gender = None]<br /># [''[[#Optional.String|Optional.String]]'' disambiguation = None]<br /># [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
* 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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Update the given artist with the given details",
 
   "description": "Update the given artist with the given details",
  "transport": "Response",
 
  "permission": "UpdateData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "$ref": "Library.Id",
 
       "name": "artistid",
 
       "name": "artistid",
      "$ref": "Library.Id",
 
 
       "required": true
 
       "required": true
 
     },
 
     },
 
     {
 
     {
       "name": "artist",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "artist"
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "instrument",
 
       "name": "instrument",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Array.String",
+
           "type": "null"
           "required": true
+
        },
 +
        {
 +
           "$ref": "Array.String"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "style",
 
       "name": "style",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Array.String",
+
           "type": "null"
           "required": true
+
        },
 +
        {
 +
           "$ref": "Array.String"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "mood",
 
       "name": "mood",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Array.String",
+
           "type": "null"
           "required": true
+
        },
 +
        {
 +
           "$ref": "Array.String"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     },
 
     },
 
     {
 
     {
       "name": "born",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "born"
 
     },
 
     },
 
     {
 
     {
       "name": "formed",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "formed"
 
     },
 
     },
 
     {
 
     {
       "name": "description",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "description"
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "genre",
 
       "name": "genre",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Array.String",
+
           "type": "null"
           "required": true
+
        },
 +
        {
 +
           "$ref": "Array.String"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     },
 
     },
 
     {
 
     {
       "name": "died",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "died"
 
     },
 
     },
 
     {
 
     {
       "name": "disbanded",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "disbanded"
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "yearsactive",
 
       "name": "yearsactive",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Array.String",
+
           "type": "null"
           "required": true
+
        },
 +
        {
 +
           "$ref": "Array.String"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     },
 
     },
 
     {
 
     {
       "name": "musicbrainzartistid",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "musicbrainzartistid"
 
     },
 
     },
 
     {
 
     {
       "name": "sortname",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "sortname"
 
     },
 
     },
 
     {
 
     {
       "name": "type",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "type"
 
     },
 
     },
 
     {
 
     {
       "name": "gender",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "gender"
 
     },
 
     },
 
     {
 
     {
       "name": "disambiguation",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "disambiguation"
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "art",
 
       "name": "art",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Media.Artwork.Set",
+
          "type": "null"
          "required": true
+
        },
 +
        {
 +
           "$ref": "Media.Artwork.Set"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     }
 
     }
 
   ],
 
   ],
   "returns": "string"
+
  "permission": "UpdateData",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "string"
==== AudioLibrary.SetSongDetails ====
+
  },
Update the given song with the given details<br />
+
  "type": "method"
'''Permissions:'''
+
}</syntaxhighlight>}}==== AudioLibrary.SetSongDetails ====Update the given song with the given details<br />'''Permissions:'''* UpdateData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''[[#Library.Id|Library.Id]]'' songid<br /># [''[[#Optional.String|Optional.String]]'' title = None]<br /># [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br /># [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br /># [''[[#Optional.Integer|Optional.Integer]]'' year = None]<br /># [''[[#Optional.Number|Optional.Number]]'' rating = None]<br /># [''[[#Optional.Integer|Optional.Integer]]'' track = None]<br /># [''[[#Optional.Integer|Optional.Integer]]'' disc = None]<br /># [''[[#Optional.Integer|Optional.Integer]]'' duration = None]<br /># [''[[#Optional.String|Optional.String]]'' comment = None]<br /># [''[[#Optional.String|Optional.String]]'' musicbrainztrackid = None]<br /># [''[[#Optional.String|Optional.String]]'' musicbrainzartistid = None]<br /># [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br /># [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br /># [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br /># [''[[#Optional.Integer|Optional.Integer]]'' votes = None]<br /># [''[[#Optional.String|Optional.String]]'' displayartist = None]<br /># [''[[#Optional.String|Optional.String]]'' sortartist = None]<br /># [''[[#Optional.String|Optional.String]]'' mood = None]<br /># [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br /># [''[[#Optional.String|Optional.String]]'' disctitle = None]<br /># [''[[#Optional.String|Optional.String]]'' releasedate = None]<br /># [''[[#Optional.String|Optional.String]]'' originaldate = None]<br /># [''[[#Optional.Integer|Optional.Integer]]'' bpm = None]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
* 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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Update the given song with the given details",
 
   "description": "Update the given song with the given details",
  "transport": "Response",
 
  "permission": "UpdateData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "$ref": "Library.Id",
 
       "name": "songid",
 
       "name": "songid",
      "$ref": "Library.Id",
 
 
       "required": true
 
       "required": true
 
     },
 
     },
 
     {
 
     {
       "name": "title",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "title"
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "artist",
 
       "name": "artist",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Array.String",
+
           "type": "null"
           "required": true
+
        },
 +
        {
 +
           "$ref": "Array.String"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "genre",
 
       "name": "genre",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Array.String",
+
           "type": "null"
           "required": true
+
        },
 +
        {
 +
           "$ref": "Array.String"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     },
 
     },
 
     {
 
     {
       "name": "year",
+
       "$ref": "Optional.Integer",
       "$ref": "Optional.Integer"
+
      "default": null,
 +
       "name": "year"
 
     },
 
     },
 
     {
 
     {
       "name": "rating",
+
       "$ref": "Optional.Number",
       "$ref": "Optional.Number"
+
      "default": null,
 +
       "name": "rating"
 
     },
 
     },
 
     {
 
     {
       "name": "track",
+
       "$ref": "Optional.Integer",
       "$ref": "Optional.Integer"
+
      "default": null,
 +
       "name": "track"
 
     },
 
     },
 
     {
 
     {
       "name": "disc",
+
       "$ref": "Optional.Integer",
       "$ref": "Optional.Integer"
+
      "default": null,
 +
       "name": "disc"
 
     },
 
     },
 
     {
 
     {
       "name": "duration",
+
       "$ref": "Optional.Integer",
       "$ref": "Optional.Integer"
+
      "default": null,
 +
       "name": "duration"
 
     },
 
     },
 
     {
 
     {
       "name": "comment",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "comment"
 
     },
 
     },
 
     {
 
     {
       "name": "musicbrainztrackid",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "musicbrainztrackid"
 
     },
 
     },
 
     {
 
     {
       "name": "musicbrainzartistid",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "musicbrainzartistid"
 
     },
 
     },
 
     {
 
     {
       "name": "playcount",
+
       "$ref": "Optional.Integer",
       "$ref": "Optional.Integer"
+
      "default": null,
 +
       "name": "playcount"
 
     },
 
     },
 
     {
 
     {
       "name": "lastplayed",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "lastplayed"
 
     },
 
     },
 
     {
 
     {
       "name": "userrating",
+
       "$ref": "Optional.Integer",
       "$ref": "Optional.Integer"
+
      "default": null,
 +
       "name": "userrating"
 
     },
 
     },
 
     {
 
     {
       "name": "votes",
+
       "$ref": "Optional.Integer",
       "$ref": "Optional.Integer"
+
      "default": null,
 +
       "name": "votes"
 
     },
 
     },
 
     {
 
     {
       "name": "displayartist",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "displayartist"
 
     },
 
     },
 
     {
 
     {
       "name": "sortartist",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "sortartist"
 
     },
 
     },
 
     {
 
     {
       "name": "mood",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "mood"
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "art",
 
       "name": "art",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Media.Artwork.Set",
+
          "type": "null"
          "required": true
+
        },
 +
        {
 +
           "$ref": "Media.Artwork.Set"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     },
 
     },
 
     {
 
     {
       "name": "disctitle",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "disctitle"
 
     },
 
     },
 
     {
 
     {
       "name": "releasedate",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "releasedate"
 
     },
 
     },
 
     {
 
     {
       "name": "originaldate",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "originaldate"
 
     },
 
     },
 
     {
 
     {
       "name": "bpm",
+
       "$ref": "Optional.Integer",
       "$ref": "Optional.Integer"
+
      "default": null,
 +
       "name": "bpm"
 
     }
 
     }
 
   ],
 
   ],
   "returns": "string"
+
  "permission": "UpdateData",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "string"
=== Favourites ===
+
  },
==== Favourites.AddFavourite ====
+
  "type": "method"
Add a favourite with the given details<br />
+
}</syntaxhighlight>}}=== Favourites ======= Favourites.AddFavourite ====Add a favourite with the given details<br />'''Permissions:'''* UpdateData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''string'' title<br /># ''[[#Favourite.Type|Favourite.Type]]'' type<br /># [''[[#Optional.String|Optional.String]]'' path = None] (Required for media, script and androidapp favourites types)<br /># [''[[#Optional.String|Optional.String]]'' window = None] (Required for window favourite type)<br /># [''[[#Optional.String|Optional.String]]'' windowparameter = None]<br /># [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
'''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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Add a favourite with the given details",
 
   "description": "Add a favourite with the given details",
  "transport": "Response",
 
  "permission": "UpdateData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 
       "name": "title",
 
       "name": "title",
       "type": "string",
+
       "required": true,
       "required": true
+
       "type": "string"
 
     },
 
     },
 
     {
 
     {
 +
      "$ref": "Favourite.Type",
 
       "name": "type",
 
       "name": "type",
      "$ref": "Favourite.Type",
 
 
       "required": true
 
       "required": true
 
     },
 
     },
 
     {
 
     {
      "name": "path",
 
 
       "$ref": "Optional.String",
 
       "$ref": "Optional.String",
       "description": "Required for media, script and androidapp favourites types"
+
      "default": null,
 +
       "description": "Required for media, script and androidapp favourites types",
 +
      "name": "path"
 
     },
 
     },
 
     {
 
     {
      "name": "window",
 
 
       "$ref": "Optional.String",
 
       "$ref": "Optional.String",
       "description": "Required for window favourite type"
+
      "default": null,
 +
       "description": "Required for window favourite type",
 +
      "name": "window"
 
     },
 
     },
 
     {
 
     {
       "name": "windowparameter",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "windowparameter"
 
     },
 
     },
 
     {
 
     {
       "name": "thumbnail",
+
       "$ref": "Optional.String",
       "$ref": "Optional.String"
+
      "default": null,
 +
       "name": "thumbnail"
 
     }
 
     }
 
   ],
 
   ],
   "returns": "string"
+
  "permission": "UpdateData",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "string"
==== Favourites.GetFavourites ====
+
  },
Retrieve all favourites<br />
+
  "type": "method"
'''Permissions:'''
+
}</syntaxhighlight>}}==== Favourites.GetFavourites ====Retrieve all favourites<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># [''mixed: null|[[#Favourite.Type|Favourite.Type]]'' type = None]<br /># [''[[#Favourite.Fields.Favourite|Favourite.Fields.Favourite]]'' properties]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# [''array[[#Favourite.Details.Favourite|Favourite.Details.Favourite]]'' favourites]<br /># ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
* 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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Retrieve all favourites",
 
   "description": "Retrieve all favourites",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "default": null,
 
       "name": "type",
 
       "name": "type",
 
       "type": [
 
       "type": [
         "null",
+
         {
 +
          "type": "null"
 +
        },
 
         {
 
         {
 
           "$ref": "Favourite.Type"
 
           "$ref": "Favourite.Type"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     },
 
     },
 
     {
 
     {
       "name": "properties",
+
       "$ref": "Favourite.Fields.Favourite",
       "$ref": "Favourite.Fields.Favourite"
+
       "name": "properties"
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 +
      "favourites": {
 +
        "items": {
 +
          "$ref": "Favourite.Details.Favourite"
 +
        },
 +
        "type": "array"
 +
      },
 
       "limits": {
 
       "limits": {
 
         "$ref": "List.LimitsReturned",
 
         "$ref": "List.LimitsReturned",
 
         "required": true
 
         "required": true
      },
 
      "favourites": {
 
        "type": "array",
 
        "items": {
 
          "$ref": "Favourite.Details.Favourite"
 
        }
 
 
       }
 
       }
     }
+
     },
  }
+
     "type": "object"
}
+
   },
</syntaxhighlight>}}
+
   "type": "method"
=== Files ===
+
}</syntaxhighlight>}}=== Files ======= Files.GetDirectory ====Get the directories and files in the given directory<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''string'' directory<br /># [''[[#Files.Media|Files.Media]]'' media = files]<br /># [''[[#List.Fields.Files|List.Fields.Files]]'' properties]<br /># [''[[#List.Sort|List.Sort]]'' sort]<br /># [''[[#List.Limits|List.Limits]]'' limits] (Limits are applied after getting the directory content thus retrieval is not faster when they are applied.)<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# ''array[[#List.Item.File|List.Item.File]]'' files<br /># ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
==== Files.Download ====
 
Downloads the given file<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' path<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''any''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
  "description": "Downloads the given file",
 
  "transport": [
 
     "Response",
 
    "FileDownloadDirect"
 
  ],
 
  "permission": "ReadData",
 
   "params": [
 
    {
 
      "name": "path",
 
      "type": "string",
 
      "required": true
 
    }
 
  ],
 
   "returns": {
 
    "type": "any",
 
    "required": true
 
  }
 
}
 
</syntaxhighlight>}}
 
==== Files.GetDirectory ====
 
Get the directories and files in the given directory<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' directory<br />
 
# [''[[#Files.Media|Files.Media]]'' media = files]<br />
 
# [''[[#List.Fields.Files|List.Fields.Files]]'' properties]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
# [''[[#List.Limits|List.Limits]]'' limits] (Limits are applied after getting the directory content thus retrieval is not faster when they are applied.)<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Get the directories and files in the given directory",
 
   "description": "Get the directories and files in the given directory",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 
       "name": "directory",
 
       "name": "directory",
       "type": "string",
+
       "required": true,
       "required": true
+
       "type": "string"
 
     },
 
     },
 
     {
 
     {
      "name": "media",
 
 
       "$ref": "Files.Media",
 
       "$ref": "Files.Media",
       "default": "files"
+
       "default": "files",
 +
      "name": "media"
 
     },
 
     },
 
     {
 
     {
       "name": "properties",
+
       "$ref": "List.Fields.Files",
       "$ref": "List.Fields.Files"
+
       "name": "properties"
 
     },
 
     },
 
     {
 
     {
       "name": "sort",
+
       "$ref": "List.Sort",
       "$ref": "List.Sort"
+
       "name": "sort"
 
     },
 
     },
 
     {
 
     {
      "name": "limits",
 
 
       "$ref": "List.Limits",
 
       "$ref": "List.Limits",
       "description": "Limits are applied after getting the directory content thus retrieval is not faster when they are applied."
+
       "description": "Limits are applied after getting the directory content thus retrieval is not faster when they are applied.",
 +
      "name": "limits"
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
      "limits": {
 
        "$ref": "List.LimitsReturned",
 
        "required": true
 
      },
 
 
       "files": {
 
       "files": {
        "type": "array",
 
 
         "items": {
 
         "items": {
 
           "$ref": "List.Item.File"
 
           "$ref": "List.Item.File"
 
         },
 
         },
 +
        "required": true,
 +
        "type": "array"
 +
      },
 +
      "limits": {
 +
        "$ref": "List.LimitsReturned",
 
         "required": true
 
         "required": true
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== Files.GetFileDetails ====
+
}</syntaxhighlight>}}==== Files.GetFileDetails ====Get details for a specific file<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''string'' file (Full path to the file)<br /># [''[[#Files.Media|Files.Media]]'' media = files]<br /># [''[[#List.Fields.Files|List.Fields.Files]]'' properties]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# ''[[#List.Item.File|List.Item.File]]'' filedetails<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
Get details for a specific file<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' file (Full path to the file)<br />
 
# [''[[#Files.Media|Files.Media]]'' media = files]<br />
 
# [''[[#List.Fields.Files|List.Fields.Files]]'' properties]<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.Item.File|List.Item.File]]'' filedetails<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Get details for a specific file",
 
   "description": "Get details for a specific file",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "description": "Full path to the file",
 
       "name": "file",
 
       "name": "file",
      "type": "string",
 
 
       "required": true,
 
       "required": true,
       "description": "Full path to the file"
+
       "type": "string"
 
     },
 
     },
 
     {
 
     {
      "name": "media",
 
 
       "$ref": "Files.Media",
 
       "$ref": "Files.Media",
       "default": "files"
+
       "default": "files",
 +
      "name": "media"
 
     },
 
     },
 
     {
 
     {
       "name": "properties",
+
       "$ref": "List.Fields.Files",
       "$ref": "List.Fields.Files"
+
       "name": "properties"
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 
       "filedetails": {
 
       "filedetails": {
Line 2,649: Line 2,018:
 
         "required": true
 
         "required": true
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== Files.GetSources ====
+
}</syntaxhighlight>}}==== Files.GetSources ====Get the sources of the media windows<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''[[#Files.Media|Files.Media]]'' media<br /># [''[[#List.Limits|List.Limits]]'' limits]<br /># [''[[#List.Sort|List.Sort]]'' sort]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br /># ''[[#List.Items.Sources|List.Items.Sources]]'' sources<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
Get the sources of the media windows<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Files.Media|Files.Media]]'' media<br />
 
# [''[[#List.Limits|List.Limits]]'' limits]<br />
 
# [''[[#List.Sort|List.Sort]]'' sort]<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
 
# ''[[#List.Items.Sources|List.Items.Sources]]'' sources<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Get the sources of the media windows",
 
   "description": "Get the sources of the media windows",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "$ref": "Files.Media",
 
       "name": "media",
 
       "name": "media",
      "$ref": "Files.Media",
 
 
       "required": true
 
       "required": true
 
     },
 
     },
 
     {
 
     {
       "name": "limits",
+
       "$ref": "List.Limits",
       "$ref": "List.Limits"
+
       "name": "limits"
 
     },
 
     },
 
     {
 
     {
       "name": "sort",
+
       "$ref": "List.Sort",
       "$ref": "List.Sort"
+
       "name": "sort"
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 
       "limits": {
 
       "limits": {
Line 2,702: Line 2,050:
 
         "required": true
 
         "required": true
 
       }
 
       }
     }
+
     },
  }
+
     "type": "object"
}
+
   },
</syntaxhighlight>}}
+
   "type": "method"
==== Files.PrepareDownload ====
+
}</syntaxhighlight>}}==== Files.SetFileDetails ====Update the given specific file with the given details<br />'''Permissions:'''* UpdateData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''string'' file (Full path to the file)<br /># ''[[#Files.Media|Files.Media]]'' media (File type to update correct database. Currently only "video" is supported.)<br /># [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br /># [''[[#Optional.String|Optional.String]]'' lastplayed = None] (Setting a valid lastplayed without a playcount will force playcount to 1.)<br /># [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
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|<syntaxhighlight enclose="div">
 
{
 
  "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"
 
      }
 
    }
 
  }
 
}
 
</syntaxhighlight>}}
 
==== Files.SetFileDetails ====
 
Update the given specific file with the given details<br />
 
'''Permissions:'''
 
* UpdateData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' file (Full path to the file)<br />
 
# ''[[#Files.Media|Files.Media]]'' media (File type to update correct database. Currently only "video" is supported.)<br />
 
# [''[[#Optional.Integer|Optional.Integer]]'' playcount]<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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Update the given specific file with the given details",
 
   "description": "Update the given specific file with the given details",
  "transport": "Response",
 
  "permission": "UpdateData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "description": "Full path to the file",
 
       "name": "file",
 
       "name": "file",
      "type": "string",
 
 
       "required": true,
 
       "required": true,
       "description": "Full path to the file"
+
       "type": "string"
 
     },
 
     },
 
     {
 
     {
 +
      "$ref": "Files.Media",
 +
      "description": "File type to update correct database. Currently only \"video\" is supported.",
 
       "name": "media",
 
       "name": "media",
      "$ref": "Files.Media",
+
       "required": true
       "required": true,
 
      "description": "File type to update correct database. Currently only \"video\" is supported."
 
 
     },
 
     },
 
     {
 
     {
       "name": "playcount",
+
       "$ref": "Optional.Integer",
       "$ref": "Optional.Integer"
+
      "default": null,
 +
       "name": "playcount"
 
     },
 
     },
 
     {
 
     {
      "name": "lastplayed",
 
 
       "$ref": "Optional.String",
 
       "$ref": "Optional.String",
       "description": "Setting a valid lastplayed without a playcount will force playcount to 1."
+
      "default": null,
 +
       "description": "Setting a valid lastplayed without a playcount will force playcount to 1.",
 +
      "name": "lastplayed"
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "resume",
 
       "name": "resume",
 
       "type": [
 
       "type": [
        "null",
 
 
         {
 
         {
           "$ref": "Video.Resume",
+
           "type": "null"
           "required": true
+
        },
 +
        {
 +
           "$ref": "Video.Resume"
 
         }
 
         }
       ],
+
       ]
      "default": null
 
 
     }
 
     }
 
   ],
 
   ],
   "returns": "string"
+
  "permission": "UpdateData",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "string"
=== GUI ===
+
  },
==== GUI.ActivateWindow ====
+
  "type": "method"
Activates the given window<br />
+
}</syntaxhighlight>}}=== GUI ======= GUI.ActivateWindow ====Activates the given window<br />'''Permissions:'''* ControlGUI'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''[[#GUI.Window|GUI.Window]]'' window<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|<syntaxhighlight enclose="div">{
'''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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Activates the given window",
 
   "description": "Activates the given window",
  "transport": "Response",
 
  "permission": "ControlGUI",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "$ref": "GUI.Window",
 
       "name": "window",
 
       "name": "window",
      "$ref": "GUI.Window",
 
 
       "required": true
 
       "required": true
 
     },
 
     },
 
     {
 
     {
      "name": "parameters",
 
      "type": "array",
 
 
       "items": {
 
       "items": {
        "type": "string",
 
 
         "minLength": 1,
 
         "minLength": 1,
         "required": true
+
         "type": "string"
 
       },
 
       },
       "minItems": 1
+
       "minItems": 1,
 +
      "name": "parameters",
 +
      "type": "array"
 
     }
 
     }
 
   ],
 
   ],
   "returns": "string"
+
  "permission": "ControlGUI",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "string"
==== GUI.GetProperties ====
+
  },
Retrieves the values of the given properties<br />
+
  "type": "method"
'''Permissions:'''
+
}</syntaxhighlight>}}==== GUI.GetProperties ====Retrieves the values of the given properties<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''array'' properties<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''[[#GUI.Property.Value|GUI.Property.Value]]''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
* 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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Retrieves the values of the given properties",
 
   "description": "Retrieves the values of the given properties",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "items": {
 +
        "$ref": "GUI.Property.Name"
 +
      },
 
       "name": "properties",
 
       "name": "properties",
 +
      "required": true,
 
       "type": "array",
 
       "type": "array",
       "uniqueItems": true,
+
       "uniqueItems": true
      "required": true,
 
      "items": {
 
        "$ref": "GUI.Property.Name"
 
      }
 
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ReadData",
 
   "returns": {
 
   "returns": {
     "$ref": "GUI.Property.Value",
+
     "$ref": "GUI.Property.Value"
    "required": true
+
  },
  }
+
  "type": "method"
}
+
}</syntaxhighlight>}}==== GUI.GetStereoscopicModes ====Returns the supported stereoscopic modes of the GUI<br />'''Permissions:'''* ReadData'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# [''array[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]'' stereoscopicmodes]<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
</syntaxhighlight>}}
 
==== GUI.GetStereoscopicModes ====
 
Returns the supported stereoscopic modes of the GUI<br />
 
'''Permissions:'''
 
* ReadData
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# [''array[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]'' stereoscopicmodes]<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Returns the supported stereoscopic modes of the GUI",
 
   "description": "Returns the supported stereoscopic modes of the GUI",
   "transport": "Response",
+
   "params": [],
 
   "permission": "ReadData",
 
   "permission": "ReadData",
  "params": [],
 
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 
       "stereoscopicmodes": {
 
       "stereoscopicmodes": {
        "type": "array",
 
        "uniqueItems": true,
 
 
         "items": {
 
         "items": {
 
           "$ref": "GUI.Stereoscopy.Mode"
 
           "$ref": "GUI.Stereoscopy.Mode"
         }
+
         },
 +
        "type": "array",
 +
        "uniqueItems": true
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== GUI.SetFullscreen ====
+
}</syntaxhighlight>}}==== GUI.SetFullscreen ====Toggle fullscreen/GUI<br />'''Permissions:'''* ControlGUI'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''[[#Global.Toggle|Global.Toggle]]'' fullscreen<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''boolean (Fullscreen state)''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
Toggle fullscreen/GUI<br />
 
'''Permissions:'''
 
* ControlGUI
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Global.Toggle|Global.Toggle]]'' fullscreen<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''boolean (Fullscreen state)''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Toggle fullscreen/GUI",
 
   "description": "Toggle fullscreen/GUI",
  "transport": "Response",
 
  "permission": "ControlGUI",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "$ref": "Global.Toggle",
 
       "name": "fullscreen",
 
       "name": "fullscreen",
       "required": true,
+
       "required": true
      "$ref": "Global.Toggle"
 
 
     }
 
     }
 
   ],
 
   ],
 +
  "permission": "ControlGUI",
 
   "returns": {
 
   "returns": {
     "type": "boolean",
+
     "description": "Fullscreen state",
     "description": "Fullscreen state"
+
     "type": "boolean"
   }
+
   },
}
+
  "type": "method"
</syntaxhighlight>}}
+
}</syntaxhighlight>}}==== GUI.SetStereoscopicMode ====Sets the stereoscopic mode of the GUI to the given mode<br />'''Permissions:'''* ControlGUI'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''string'' mode<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
==== GUI.SetStereoscopicMode ====
 
Sets the stereoscopic mode of the GUI to the given mode<br />
 
'''Permissions:'''
 
* ControlGUI
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' mode<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Sets the stereoscopic mode of the GUI to the given mode",
 
   "description": "Sets the stereoscopic mode of the GUI to the given mode",
  "transport": "Response",
 
  "permission": "ControlGUI",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
       "name": "mode",
+
       "enums": [
      "type": "string",
 
      "enum": [
 
 
         "toggle",
 
         "toggle",
 
         "tomono",
 
         "tomono",
Line 2,999: Line 2,190:
 
         "monoscopic"
 
         "monoscopic"
 
       ],
 
       ],
       "required": true
+
      "name": "mode",
 +
       "required": true,
 +
      "type": "string"
 
     }
 
     }
 
   ],
 
   ],
   "returns": "string"
+
  "permission": "ControlGUI",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "string"
==== GUI.ShowNotification ====
+
  },
Shows a GUI notification<br />
+
  "type": "method"
'''Permissions:'''
+
}</syntaxhighlight>}}==== GUI.ShowNotification ====Shows a GUI notification<br />'''Permissions:'''* ControlGUI'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''string'' title<br /># ''string'' message<br /># [''mixed: string|string'' image = ""]<br /># [''integer'' displaytime = 5000] (The time in milliseconds the notification will be visible)<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
* ControlGUI
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' title<br />
 
# ''string'' message<br />
 
# [''mixed: string|string'' image = ""]<br />
 
# [''integer'' displaytime = 5000] (The time in milliseconds the notification will be visible)<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Shows a GUI notification",
 
   "description": "Shows a GUI notification",
  "transport": "Response",
 
  "permission": "ControlGUI",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 
       "name": "title",
 
       "name": "title",
       "type": "string",
+
       "required": true,
       "required": true
+
       "type": "string"
 
     },
 
     },
 
     {
 
     {
 
       "name": "message",
 
       "name": "message",
       "type": "string",
+
       "required": true,
       "required": true
+
       "type": "string"
 
     },
 
     },
 
     {
 
     {
 +
      "default": "",
 
       "name": "image",
 
       "name": "image",
 
       "type": [
 
       "type": [
 
         {
 
         {
           "type": "string",
+
           "enums": [
          "required": true,
 
          "enum": [
 
 
             "info",
 
             "info",
 
             "warning",
 
             "warning",
 
             "error"
 
             "error"
           ]
+
           ],
 +
          "type": "string"
 
         },
 
         },
 
         {
 
         {
           "type": "string",
+
           "type": "string"
          "required": true
 
 
         }
 
         }
       ],
+
       ]
      "default": ""
 
 
     },
 
     },
 
     {
 
     {
 +
      "default": 5000,
 +
      "description": "The time in milliseconds the notification will be visible",
 +
      "minimum": 1500,
 
       "name": "displaytime",
 
       "name": "displaytime",
       "type": "integer",
+
       "type": "integer"
      "minimum": 1500,
 
      "default": 5000,
 
      "description": "The time in milliseconds the notification will be visible"
 
 
     }
 
     }
 
   ],
 
   ],
   "returns": "string"
+
  "permission": "ControlGUI",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "string"
=== Input ===
+
  },
==== Input.Back ====
+
  "type": "method"
Goes back in GUI<br />
+
}</syntaxhighlight>}}=== Input ======= Input.Back ====Goes back in GUI<br />'''Permissions:'''* Navigate'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
'''Permissions:'''
 
* Navigate
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Goes back in GUI",
 
   "description": "Goes back in GUI",
   "transport": "Response",
+
   "params": [],
 
   "permission": "Navigate",
 
   "permission": "Navigate",
   "params": [],
+
   "returns": {
   "returns": "string"
+
    "type": "string"
}
+
  },
</syntaxhighlight>}}
+
   "type": "method"
==== Input.ButtonEvent ====
+
}</syntaxhighlight>}}==== Input.ButtonEvent ====Send a button press event<br />'''Permissions:'''* Navigate'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''string'' button (Button name)<br /># ''string'' keymap (Keymap name (KB, XG, R1, or R2))<br /># [''integer'' holdtime = 0] (Number of milliseconds to simulate button hold.)<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
Send a button press event<br />
 
'''Permissions:'''
 
* Navigate
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' button (Button name)<br />
 
# ''string'' keymap (Keymap name (KB, XG, R1, or R2))<br />
 
# ''integer'' holdtime = 0 (Number of milliseconds to simulate button hold.)<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Send a button press event",
 
   "description": "Send a button press event",
  "transport": "Response",
 
  "permission": "Navigate",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "description": "Button name",
 
       "name": "button",
 
       "name": "button",
      "type": "string",
 
 
       "required": true,
 
       "required": true,
       "description": "Button name"
+
       "type": "string"
 
     },
 
     },
 
     {
 
     {
      "name": "keymap",
 
      "type": "string",
 
      "required": true,
 
 
       "description": "Keymap name (KB, XG, R1, or R2)",
 
       "description": "Keymap name (KB, XG, R1, or R2)",
       "enum": [
+
       "enums": [
 
         "KB",
 
         "KB",
 
         "XG",
 
         "XG",
 
         "R1",
 
         "R1",
 
         "R2"
 
         "R2"
       ]
+
       ],
 +
      "name": "keymap",
 +
      "required": true,
 +
      "type": "string"
 
     },
 
     },
 
     {
 
     {
 +
      "default": 0,
 +
      "description": "Number of milliseconds to simulate button hold.",
 +
      "minimum": 0,
 
       "name": "holdtime",
 
       "name": "holdtime",
       "type": "integer",
+
       "type": "integer"
      "required": false,
 
      "minimum": 0,
 
      "default": 0,
 
      "description": "Number of milliseconds to simulate button hold."
 
 
     }
 
     }
 
   ],
 
   ],
   "returns": "string"
+
  "permission": "Navigate",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "string"
==== Input.ContextMenu ====
+
  },
Shows the context menu<br />
+
  "type": "method"
'''Permissions:'''
+
}</syntaxhighlight>}}==== Input.ContextMenu ====Shows the context menu<br />'''Permissions:'''* Navigate'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
* Navigate
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Shows the context menu",
 
   "description": "Shows the context menu",
   "transport": "Response",
+
   "params": [],
 
   "permission": "Navigate",
 
   "permission": "Navigate",
   "params": [],
+
   "returns": {
   "returns": "string"
+
    "type": "string"
}
+
  },
</syntaxhighlight>}}
+
   "type": "method"
==== Input.Down ====
+
}</syntaxhighlight>}}==== Input.Down ====Navigate down in GUI<br />'''Permissions:'''* Navigate'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
Navigate down in GUI<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Navigate down in GUI",
 
   "description": "Navigate down in GUI",
   "transport": "Response",
+
   "params": [],
 
   "permission": "Navigate",
 
   "permission": "Navigate",
   "params": [],
+
   "returns": {
   "returns": "string"
+
    "type": "string"
}
+
  },
</syntaxhighlight>}}
+
   "type": "method"
==== Input.ExecuteAction ====
+
}</syntaxhighlight>}}==== Input.ExecuteAction ====Execute a specific action<br />'''Permissions:'''* Navigate'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''[[#Input.Action|Input.Action]]'' action<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
Execute a specific action<br />
 
'''Permissions:'''
 
* Navigate
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''[[#Input.Action|Input.Action]]'' action<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Execute a specific action",
 
   "description": "Execute a specific action",
  "transport": "Response",
 
  "permission": "Navigate",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "$ref": "Input.Action",
 
       "name": "action",
 
       "name": "action",
      "$ref": "Input.Action",
 
 
       "required": true
 
       "required": true
 
     }
 
     }
 
   ],
 
   ],
   "returns": "string"
+
  "permission": "Navigate",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "string"
==== Input.Home ====
+
  },
Goes to home window in GUI<br />
+
  "type": "method"
'''Permissions:'''
+
}</syntaxhighlight>}}==== Input.Home ====Goes to home window in GUI<br />'''Permissions:'''* Navigate'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
* Navigate
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Goes to home window in GUI",
 
   "description": "Goes to home window in GUI",
   "transport": "Response",
+
   "params": [],
 
   "permission": "Navigate",
 
   "permission": "Navigate",
 +
  "returns": {
 +
    "type": "string"
 +
  },
 +
  "type": "method"
 +
}</syntaxhighlight>}}==== Input.Info ====Shows the information dialog<br />'''Permissions:'''* Navigate'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
 +
  "description": "Shows the information dialog",
 
   "params": [],
 
   "params": [],
  "returns": "string"
 
}
 
</syntaxhighlight>}}
 
==== Input.Info ====
 
Shows the information dialog<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
  "description": "Shows the information dialog",
 
  "transport": "Response",
 
 
   "permission": "Navigate",
 
   "permission": "Navigate",
 +
  "returns": {
 +
    "type": "string"
 +
  },
 +
  "type": "method"
 +
}</syntaxhighlight>}}==== Input.Left ====Navigate left in GUI<br />'''Permissions:'''* Navigate'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
 +
  "description": "Navigate left in GUI",
 
   "params": [],
 
   "params": [],
  "returns": "string"
 
}
 
</syntaxhighlight>}}
 
==== Input.Left ====
 
Navigate left in GUI<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
  "description": "Navigate left in GUI",
 
  "transport": "Response",
 
 
   "permission": "Navigate",
 
   "permission": "Navigate",
 +
  "returns": {
 +
    "type": "string"
 +
  },
 +
  "type": "method"
 +
}</syntaxhighlight>}}==== Input.Right ====Navigate right in GUI<br />'''Permissions:'''* Navigate'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
 +
  "description": "Navigate right in GUI",
 
   "params": [],
 
   "params": [],
  "returns": "string"
 
}
 
</syntaxhighlight>}}
 
==== Input.Right ====
 
Navigate right in GUI<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
  "description": "Navigate right in GUI",
 
  "transport": "Response",
 
 
   "permission": "Navigate",
 
   "permission": "Navigate",
 +
  "returns": {
 +
    "type": "string"
 +
  },
 +
  "type": "method"
 +
}</syntaxhighlight>}}==== Input.Select ====Select current item in GUI<br />'''Permissions:'''* Navigate'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
 +
  "description": "Select current item in GUI",
 
   "params": [],
 
   "params": [],
  "returns": "string"
 
}
 
</syntaxhighlight>}}
 
==== Input.Select ====
 
Select current item in GUI<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
  "description": "Select current item in GUI",
 
  "transport": "Response",
 
 
   "permission": "Navigate",
 
   "permission": "Navigate",
   "params": [],
+
   "returns": {
   "returns": "string"
+
    "type": "string"
}
+
  },
</syntaxhighlight>}}
+
   "type": "method"
==== Input.SendText ====
+
}</syntaxhighlight>}}==== Input.SendText ====Send a generic (unicode) text<br />'''Permissions:'''* Navigate'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''string'' text (Unicode text)<br /># [''boolean'' done = True] (Whether this is the whole input or not (closes an open input dialog if true).)<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
Send a generic (unicode) text<br />
 
'''Permissions:'''
 
* Navigate
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' text (Unicode text)<br />
 
# [''boolean'' done = True] (Whether this is the whole input or not (closes an open input dialog if true).)<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Send a generic (unicode) text",
 
   "description": "Send a generic (unicode) text",
  "transport": "Response",
 
  "permission": "Navigate",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "description": "Unicode text",
 
       "name": "text",
 
       "name": "text",
      "type": "string",
 
 
       "required": true,
 
       "required": true,
       "description": "Unicode text"
+
       "type": "string"
 
     },
 
     },
 
     {
 
     {
 +
      "default": true,
 +
      "description": "Whether this is the whole input or not (closes an open input dialog if true).",
 
       "name": "done",
 
       "name": "done",
       "type": "boolean",
+
       "type": "boolean"
      "default": true,
 
      "description": "Whether this is the whole input or not (closes an open input dialog if true)."
 
 
     }
 
     }
 
   ],
 
   ],
   "returns": "string"
+
  "permission": "Navigate",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "string"
==== Input.ShowCodec ====
+
  },
Show codec information of the playing item<br />
+
  "type": "method"
'''Permissions:'''
+
}</syntaxhighlight>}}==== Input.ShowCodec ====Show codec information of the playing item<br />'''Permissions:'''* Navigate'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
* Navigate
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Show codec information of the playing item",
 
   "description": "Show codec information of the playing item",
   "transport": "Response",
+
   "params": [],
 
   "permission": "Navigate",
 
   "permission": "Navigate",
 +
  "returns": {
 +
    "type": "string"
 +
  },
 +
  "type": "method"
 +
}</syntaxhighlight>}}==== Input.ShowOSD ====Show the on-screen display for the current player<br />'''Permissions:'''* Navigate'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
 +
  "description": "Show the on-screen display for the current player",
 
   "params": [],
 
   "params": [],
  "returns": "string"
 
}
 
</syntaxhighlight>}}
 
==== Input.ShowOSD ====
 
Show the on-screen display for the current player<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
  "description": "Show the on-screen display for the current player",
 
  "transport": "Response",
 
 
   "permission": "Navigate",
 
   "permission": "Navigate",
 +
  "returns": {
 +
    "type": "string"
 +
  },
 +
  "type": "method"
 +
}</syntaxhighlight>}}==== Input.ShowPlayerProcessInfo ====Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...<br />'''Permissions:'''* Navigate'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
 +
  "description": "Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...",
 
   "params": [],
 
   "params": [],
  "returns": "string"
 
}
 
</syntaxhighlight>}}
 
==== Input.ShowPlayerProcessInfo ====
 
Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
  "description": "Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...",
 
  "transport": "Response",
 
 
   "permission": "Navigate",
 
   "permission": "Navigate",
 +
  "returns": {
 +
    "type": "string"
 +
  },
 +
  "type": "method"
 +
}</syntaxhighlight>}}==== Input.Up ====Navigate up in GUI<br />'''Permissions:'''* Navigate'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
 +
  "description": "Navigate up in GUI",
 
   "params": [],
 
   "params": [],
  "returns": "string"
 
}
 
</syntaxhighlight>}}
 
==== Input.Up ====
 
Navigate up in GUI<br />
 
'''Permissions:'''
 
* Navigate
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
  "description": "Navigate up in GUI",
 
  "transport": "Response",
 
 
   "permission": "Navigate",
 
   "permission": "Navigate",
  "params": [],
 
  "returns": "string"
 
}
 
</syntaxhighlight>}}
 
=== JSONRPC ===
 
==== JSONRPC.GetConfiguration ====
 
Get client-specific configurations<br />
 
'''Permissions:'''
 
* ReadData
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''[[#Configuration|Configuration]]''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
  "description": "Get client-specific configurations",
 
  "transport": "Announcing",
 
  "permission": "ReadData",
 
  "params": [],
 
 
   "returns": {
 
   "returns": {
     "$ref": "Configuration"
+
     "type": "string"
   }
+
   },
}
+
  "type": "method"
</syntaxhighlight>}}
+
}</syntaxhighlight>}}=== JSONRPC ======= JSONRPC.Introspect ====Enumerates all actions and descriptions<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># [''boolean'' getdescriptions = True]<br /># [''boolean'' getmetadata = False]<br /># [''boolean'' filterbytransport = True]<br /># [''object'' filter]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
==== JSONRPC.Introspect ====
 
Enumerates all actions and descriptions<br />
 
'''Permissions:'''
 
* ReadData
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''boolean'' getdescriptions = True]<br />
 
# [''boolean'' getmetadata = False]<br />
 
# [''boolean'' filterbytransport = True]<br />
 
# [''object'' filter]<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Enumerates all actions and descriptions",
 
   "description": "Enumerates all actions and descriptions",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 +
      "default": true,
 
       "name": "getdescriptions",
 
       "name": "getdescriptions",
       "type": "boolean",
+
       "type": "boolean"
      "default": true
 
 
     },
 
     },
 
     {
 
     {
 +
      "default": false,
 
       "name": "getmetadata",
 
       "name": "getmetadata",
       "type": "boolean",
+
       "type": "boolean"
      "default": false
 
 
     },
 
     },
 
     {
 
     {
 +
      "default": true,
 
       "name": "filterbytransport",
 
       "name": "filterbytransport",
       "type": "boolean",
+
       "type": "boolean"
      "default": true
 
 
     },
 
     },
 
     {
 
     {
 
       "name": "filter",
 
       "name": "filter",
      "type": "object",
 
 
       "properties": {
 
       "properties": {
 +
        "getreferences": {
 +
          "default": true,
 +
          "description": "Whether or not to print the schema for referenced types",
 +
          "type": "boolean"
 +
        },
 
         "id": {
 
         "id": {
           "type": "string",
+
           "description": "Name of a namespace, method or type",
 
           "required": true,
 
           "required": true,
           "description": "Name of a namespace, method or type"
+
           "type": "string"
 
         },
 
         },
 
         "type": {
 
         "type": {
           "type": "string",
+
           "description": "Type of the given name",
           "required": true,
+
           "enums": [
          "enum": [
 
 
             "method",
 
             "method",
 
             "namespace",
 
             "namespace",
Line 3,475: Line 2,447:
 
             "notification"
 
             "notification"
 
           ],
 
           ],
           "description": "Type of the given name"
+
           "required": true,
        },
+
           "type": "string"
        "getreferences": {
 
           "type": "boolean",
 
          "default": true,
 
          "description": "Whether or not to print the schema for referenced types"
 
 
         }
 
         }
       }
+
       },
 +
      "type": "object"
 
     }
 
     }
 
   ],
 
   ],
   "returns": "object"
+
  "permission": "ReadData",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "additionalProperties": false,
==== JSONRPC.NotifyAll ====
+
    "type": "object"
Notify all other connected clients<br />
+
  },
'''Permissions:'''
+
  "type": "method"
* ReadData
+
}</syntaxhighlight>}}==== JSONRPC.NotifyAll ====Notify all other connected clients<br />'''Permissions:'''* ReadData'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''string'' sender<br /># ''string'' message<br /># [''any'' data = None]<br /></div>'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''any''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# ''string'' sender<br />
 
# ''string'' message<br />
 
# [''any'' data = None]<br />
 
</div>
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''any''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Notify all other connected clients",
 
   "description": "Notify all other connected clients",
  "transport": "Response",
 
  "permission": "ReadData",
 
 
   "params": [
 
   "params": [
 
     {
 
     {
 
       "name": "sender",
 
       "name": "sender",
       "type": "string",
+
       "required": true,
       "required": true
+
       "type": "string"
 
     },
 
     },
 
     {
 
     {
 
       "name": "message",
 
       "name": "message",
       "type": "string",
+
       "required": true,
       "required": true
+
       "type": "string"
 
     },
 
     },
 
     {
 
     {
 +
      "default": null,
 
       "name": "data",
 
       "name": "data",
       "type": "any",
+
       "type": "any"
      "default": null
 
 
     }
 
     }
 
   ],
 
   ],
   "returns": "any"
+
  "permission": "ReadData",
}
+
   "returns": {
</syntaxhighlight>}}
+
    "type": "any"
==== JSONRPC.Permission ====
+
  },
Retrieve the clients permissions<br />
+
  "type": "method"
'''Permissions:'''
+
}</syntaxhighlight>}}==== JSONRPC.Permission ====Retrieve the clients permissions<br />'''Permissions:'''* ReadData'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# ''boolean'' controlgui<br /># ''boolean'' controlnotify<br /># ''boolean'' controlplayback<br /># ''boolean'' controlpower<br /># ''boolean'' controlpvr<br /># ''boolean'' controlsystem<br /># ''boolean'' executeaddon<br /># ''boolean'' manageaddon<br /># ''boolean'' navigate<br /># ''boolean'' readdata<br /># ''boolean'' removedata<br /># ''boolean'' updatedata<br /># ''boolean'' writefile<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
* 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|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Retrieve the clients permissions",
 
   "description": "Retrieve the clients permissions",
   "transport": "Response",
+
   "params": [],
 
   "permission": "ReadData",
 
   "permission": "ReadData",
  "params": [],
 
 
   "returns": {
 
   "returns": {
    "type": "object",
 
 
     "properties": {
 
     "properties": {
       "ReadData": {
+
       "controlgui": {
         "type": "boolean",
+
         "required": true,
         "required": true
+
         "type": "boolean"
 
       },
 
       },
       "ControlPlayback": {
+
       "controlnotify": {
         "type": "boolean",
+
         "required": true,
         "required": true
+
         "type": "boolean"
 
       },
 
       },
       "ControlNotify": {
+
       "controlplayback": {
         "type": "boolean",
+
         "required": true,
         "required": true
+
         "type": "boolean"
 
       },
 
       },
       "ControlPower": {
+
       "controlpower": {
         "type": "boolean",
+
         "required": true,
         "required": true
+
         "type": "boolean"
 
       },
 
       },
       "UpdateData": {
+
       "controlpvr": {
         "type": "boolean",
+
         "required": true,
         "required": true
+
         "type": "boolean"
 
       },
 
       },
       "RemoveData": {
+
       "controlsystem": {
         "type": "boolean",
+
         "required": true,
         "required": true
+
         "type": "boolean"
 
       },
 
       },
       "Navigate": {
+
       "executeaddon": {
         "type": "boolean",
+
         "required": true,
         "required": true
+
         "type": "boolean"
 
       },
 
       },
       "WriteFile": {
+
       "manageaddon": {
         "type": "boolean",
+
         "required": true,
         "required": true
+
         "type": "boolean"
 
       },
 
       },
       "ControlSystem": {
+
       "navigate": {
         "type": "boolean",
+
         "required": true,
         "required": true
+
         "type": "boolean"
 
       },
 
       },
       "ControlGUI": {
+
       "readdata": {
         "type": "boolean",
+
         "required": true,
         "required": true
+
         "type": "boolean"
 
       },
 
       },
       "ManageAddon": {
+
       "removedata": {
         "type": "boolean",
+
         "required": true,
         "required": true
+
         "type": "boolean"
 
       },
 
       },
       "ExecuteAddon": {
+
       "updatedata": {
         "type": "boolean",
+
         "required": true,
         "required": true
+
         "type": "boolean"
 
       },
 
       },
       "ControlPVR": {
+
       "writefile": {
         "type": "boolean",
+
         "required": true,
         "required": true
+
         "type": "boolean"
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
==== JSONRPC.Ping ====
+
}</syntaxhighlight>}}==== JSONRPC.Ping ====Ping responder<br />'''Permissions:'''* ReadData'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''string''<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
Ping responder<br />
 
'''Permissions:'''
 
* ReadData
 
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''string''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
 
   "description": "Ping responder",
 
   "description": "Ping responder",
   "transport": "Response",
+
   "params": [],
 
   "permission": "ReadData",
 
   "permission": "ReadData",
 +
  "returns": {
 +
    "type": "string"
 +
  },
 +
  "type": "method"
 +
}</syntaxhighlight>}}==== JSONRPC.Version ====Retrieve the JSON-RPC protocol version.<br />'''Permissions:'''* ReadData'''Returns:''' <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">'''Type:''' ''object''<br />'''Properties:'''# ''object'' version<br /></div>{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">{
 +
  "description": "Retrieve the JSON-RPC protocol version.",
 
   "params": [],
 
   "params": [],
  "returns": "string"
+
   "permission": "ReadData",
}
+
   "returns": {
</syntaxhighlight>}}
 
==== JSONRPC.SetConfiguration ====
 
Change the client-specific configuration<br />
 
'''Permissions:'''
 
* ControlNotify
 
'''Parameters:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
# [''object'' notifications]<br />
 
</div>
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''[[#Configuration|Configuration]]''<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "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"
 
  }
 
}
 
</syntaxhighlight>}}
 
==== JSONRPC.Version ====
 
Retrieve the JSON-RPC protocol version.<br />
 
'''Permissions:'''
 
* ReadData
 
'''Returns:'''
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
 
'''Type:''' ''object''<br />
 
'''Properties:'''
 
# ''object'' version<br />
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight enclose="div">
 
{
 
  "type": "method",
 
  "description": "Retrieve the JSON-RPC protocol version.",
 
  "transport": "Response",
 
   "permission": "ReadData",
 
  "params": [],
 
   "returns": {
 
    "type": "object",
 
 
     "properties": {
 
     "properties": {
 
       "version": {
 
       "version": {
        "type": "object",
 
        "required": true,
 
 
         "properties": {
 
         "properties": {
 
           "major": {
 
           "major": {
             "type": "integer",
+
             "description": "Bumped on backwards incompatible changes to the API definition",
 
             "minimum": 0,
 
             "minimum": 0,
 
             "required": true,
 
             "required": true,
             "description": "Bumped on backwards incompatible changes to the API definition"
+
             "type": "integer"
 
           },
 
           },
 
           "minor": {
 
           "minor": {
             "type": "integer",
+
             "description": "Bumped on backwards compatible additions/changes to the API definition",
 
             "minimum": 0,
 
             "minimum": 0,
 
             "required": true,
 
             "required": true,
             "description": "Bumped on backwards compatible additions/changes to the API definition"
+
             "type": "integer"
 
           },
 
           },
 
           "patch": {
 
           "patch": {
             "type": "integer",
+
             "description": "Bumped on any changes to the internal implementation but not to the API definition",
 
             "minimum": 0,
 
             "minimum": 0,
 
             "required": true,
 
             "required": true,
             "description": "Bumped on any changes to the internal implementation but not to the API definition"
+
             "type": "integer"
 
           }
 
           }
         }
+
         },
 +
        "required": true,
 +
        "type": "object"
 
       }
 
       }
     }
+
     },
   }
+
    "type": "object"
}
+
   },
</syntaxhighlight>}}
+
  "type": "method"
=== PVR ===
+
}</syntaxhighlight>}}=== PVR ======= PVR.AddTimer ====Adds a timer to record the given show one times or a timer rule to record all showings of the given show<br />'''Permissions:'''* ControlPVR'''Parameters:'''<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"># ''[[#Library.Id|Library.Id]]'' broadcastid (the broadcast id of the item to record)<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|<syntaxhighlight enclose="div">{
==== 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|<syntaxhighlight enclose="div">
 
{
 
  "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",
 
   "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": [
 
   "params": [
 
     {
 
     {
 +
      "$ref": "Library.Id",
 +
      "description": "the broadcast id of the item to record",
 
       "name": "broadcastid",
 
       "name": "broadcastid",
      "$ref": "Library.Id",
+
       "required": true
       "required": true,
 
      "description": "the broadcast id of the item to record"
 
 
     },
 
     },
 
     {
 
     {
 +
      "default": false,
 +
      "description&qu