Archive:JSON-RPC API/v4: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
>Montellese
mNo edit summary
 
(40 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:JSON-RPC API v3 (pre Eden)}}
Version 4 is a stable version of XBMC's JSON-RPC API and is published with the release of Eden. It is a complete re-write and re-structuring of version 2 and therefore isn't backwards compatible to it. The main reason for this was the need to make this version fully compatible with all the functionality, features and requirements of the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]. This was a main concern during early development to make it easier for third party developers and applications to interact with XBMC's JSON-RPC API by using existing JSON-RPC libraries.
TODO
 
An rough and incomplete list of changes compared to version 2 can be found [[Archive:Eden_API_changes|here]]. A more complete and detailed list can be found in the [http://forum.kodi.tv/showthread.php?t=98551 forum].


{{TOC right}}
{{TOC right}}
==Documentation==
== JSON-RPC 2.0 compatibility ==
Starting with JSON-RPC API version 3 a new way of API documentation has been introduced. All methods and data types are described using [http://tools.ietf.org/html/draft-zyp-json-schema-03 JSON schema]. This provides third party developers with an always complete and up-to-date documentation by calling [[#JSONRPC.Introspect|JSONRPC.Introspect]] even during periods of heavy development. Furthermore the same method and data type specification that can be used by third party developers as a documentation is used by XBMC to check and verify method parameters and their values on every JSON-RPC request and allows to provide detailed error messages in case of a bad or missing parameter.
{| class="prettytable" style="margin-right: 0;"
!style="padding-left: 5px; width: 7em; text-align: left;"|Version
!style="padding-left: 10px; padding-right: 10px;"|Method calls
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(server-side)
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(client-side)
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-name
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-position
!style="padding-left: 10px; padding-right: 10px;"|Batch requests
|-
|style="padding-left: 5px;"|Version 4
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|}
 
== Documentation (JSON Schema) ==
Starting with JSON-RPC API version 3 a new way of API documentation has been introduced. All methods and data types are described using [http://tools.ietf.org/html/draft-zyp-json-schema-03 JSON Schema]. This provides third party developers with an always complete and up-to-date documentation by calling JSONRPC.Introspect even during periods of heavy development. Furthermore the same method and data type specification that can be used by third party developers as a documentation is used by XBMC to check and verify method parameters and their values on every JSON-RPC request and allows to provide detailed error messages in case of a bad or missing parameter.
 
=== Supported features of JSON Schema ===
<div style="float:left; margin-right:2em">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema
!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 type]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.2 properties]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.3 patternProperties]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.4 additionalProperties]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.5 items]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.6 additionalItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.7 required]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.8 dependencies]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.9 minimum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.10 maximum]
|{{yes}}
|-
|}
</div>
 
<div style="float:left; margin-right:2em">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema
 
!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
 
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.11 exclusiveMinimum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.12 exclusiveMaximum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.13 minItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.14 maxItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.15 uniqueItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.16 pattern]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.17 minLength]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.18 maxLength]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.19 enum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.20 default]
|{{yes}}
|-
|}
</div>
 
<div style="float:left;">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema


===Error message===
!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.21 title]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.22 description]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 format]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.24 divisibleBy]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.25 disallow]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.26 extends]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.27 id]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.28 $ref]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.29 $schema]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-6 Hyper Schema]
|{{no}}
|-
|}
</div>
<div style="clear:left;"></div>
 
== Error message ==
If XBMC detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is
If XBMC detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is
<source lang="javascript">
{|
|
<syntaxhighlight lang=json enclose="div">
{
{
   "type": "object",
   "type": "object",
Line 29: Line 171:
   }
   }
}
}
</source>
</syntaxhighlight>
|}


==Namespaces==
== Namespaces ==
The XBMC JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:
The XBMC JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:
{|
|
<pre>
<pre>
JSONRPC          A variety of standard JSONRPC calls
JSONRPC          A variety of standard JSONRPC calls
Line 43: Line 188:
Application      Application information and control
Application      Application information and control
System          System controls and information
System          System controls and information
XBMC            Dumping ground for very XBMC specific operations
XBMC            Dumping ground for very Kodi specific operations
</pre>
</pre>
|}


==Methods==
== Methods ==
===Application===
=== Application ===
====Application.GetProperties====
==== Application.GetProperties ====
Retrieves the values of the given properties<br />
Retrieves the values of the given properties<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''array'' properties
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Returns: '''<br />
# ''[[#Application.Property.Name|Application.Property.Name]]''[] properties
'''Type:''' ''[[#Application.Property.Value|Application.Property.Value]]''<br />
</div>
'''Optional:''' true
'''Returns:''' ''[[#Application.Property.Value|Application.Property.Value]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "$ref": "Application.Property.Value"
  },
  "params": [
    {
      "uniqueItems": true,
      "items": {
        "$ref": "Application.Property.Name"
      },
      "required": true,
      "type": "array",
      "name": "properties"
    }
  ],
  "description": "Retrieves the values of the given properties"
}</syntaxhighlight>}}


====Application.Quit====
==== Application.Quit ====
Quit application<br />
Quit application<br />
'''Permission:''' ControlPower<br />
'''Permissions:'''
* ControlPower
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Quit application"
}</syntaxhighlight>}}


====Application.SetVolume====
==== 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">
# ''mixed'' mute
</div>
'''Returns:''' ''boolean''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "boolean",
    "description": "Mute state"
  },
  "params": [
    {
      "required": true,
      "type": [
        {
          "type": "boolean"
        },
        {
          "enums": [
            "toggle"
          ],
          "type": "string"
        }
      ],
      "name": "mute"
    }
  ],
  "description": "Toggle mute/unmute"
}</syntaxhighlight>}}
 
==== Application.SetVolume ====
Set the current volume<br />
Set the current volume<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''  
'''Parameters:'''  
#''integer'' value
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Returns: '''<br />
# ''integer'' volume
'''Type:''' ''integer''<br />
</div>
'''Optional:''' true
'''Returns:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "minimum": 0,
    "type": "integer"
  },
  "params": [
    {
      "required": true,
      "minimum": 0,
      "type": "integer",
      "maximum": 100,
      "name": "volume"
    }
  ],
  "description": "Set the current volume"
}</syntaxhighlight>}}


====Application.ToggleMute====
=== AudioLibrary ===
Toggle mute/unmute<br />
==== AudioLibrary.Clean ====
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''integer''<br />
'''Optional:''' true
 
===AudioLibrary===
====AudioLibrary.Clean====
Cleans the audio library from non-existent items<br />
Cleans the audio library from non-existent items<br />
'''Permission:''' RemoveData<br />
'''Permissions:'''
* RemoveData
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Cleans the audio library from non-existent items"
}</syntaxhighlight>}}


====AudioLibrary.Export====
==== AudioLibrary.Export ====
Exports all items from the audio library<br />
Exports all items from the audio library<br />
'''Permission:''' WriteFile<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''  
'''Parameters:'''  
#[ ''boolean'' singlefile = True ]
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''boolean'' images = False ]
# [ ''mixed'' options ]
#[ ''boolean'' overwrite = False ]
</div>
#[ ''string'' path = "" ]
'''Returns:''' ''string''
'''Returns: '''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Type:''' ''string''<br />
  "returns": {
'''Optional:''' true
    "type": "string"
  },
  "params": [
    {
      "type": [
        {
          "additionalProperties": false,
          "type": "object",
          "properties": {
            "path": {
              "minLength": 1,
              "required": true,
              "type": "string",
              "description": "Path to the directory to where the data should be exported"
            }
          }
        },
        {
          "additionalProperties": false,
          "type": "object",
          "properties": {
            "images": {
              "default": false,
              "type": "boolean",
              "description": "Whether to export thumbnails and fanart images"
            },
            "overwrite": {
              "default": false,
              "type": "boolean",
              "description": "Whether to overwrite existing exported files"
            }
          }
        }
      ],
      "name": "options"
    }
  ],
  "description": "Exports all items from the audio library"
}</syntaxhighlight>}}


====AudioLibrary.GetAlbumDetails====
==== AudioLibrary.GetAlbumDetails ====
Retrieve details about a specific album<br />
Retrieve details about a specific album<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''[[#Library.Id|Library.Id]]'' albumid
<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]]'' fields ]
# ''[[#Library.Id|Library.Id]]'' albumid
'''Returns: '''<br />
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''[[#Audio.Details.Album|Audio.Details.Album]]'' albumdetails ]
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]'' albumdetails ]


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "albumdetails": {
        "$ref": "Audio.Details.Album"
      }
    }
  },
  "params": [
    {
      "required": true,
      "name": "albumid",
      "$ref": "Library.Id"
    },
    {
      "name": "properties",
      "$ref": "Audio.Fields.Album"
    }
  ],
  "description": "Retrieve details about a specific album"
}</syntaxhighlight>}}


====AudioLibrary.GetAlbums====
==== AudioLibrary.GetAlbums ====
Retrieve all albums from specified artist or genre<br />
Retrieve all albums from specified artist or genre<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#[ ''[[#Library.Id|Library.Id]]'' artistid = -1 ]
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#Library.Id|Library.Id]]'' genreid = -1 ]
# [ ''[[#Library.Id|Library.Id]]'' artistid = -1 ]
#[ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' fields ]
# [ ''[[#Library.Id|Library.Id]]'' genreid = -1 ]
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''array'' albums ]
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "albums": {
        "items": {
          "$ref": "Audio.Details.Album"
        },
        "type": "array"
      },
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      }
    }
  },
  "params": [
    {
      "default": -1,
      "name": "artistid",
      "$ref": "Library.Id"
    },
    {
      "default": -1,
      "name": "genreid",
      "$ref": "Library.Id"
    },
    {
      "name": "properties",
      "$ref": "Audio.Fields.Album"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Retrieve all albums from specified artist or genre"
}</syntaxhighlight>}}


====AudioLibrary.GetArtistDetails====
==== AudioLibrary.GetArtistDetails ====
Retrieve details about a specific artist<br />
Retrieve details about a specific artist<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''[[#Library.Id|Library.Id]]'' artistid
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' fields ]
# ''[[#Library.Id|Library.Id]]'' artistid
'''Returns: '''<br />
# [ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''[[#Audio.Details.Artist|Audio.Details.Artist]]'' artistdetails ]
* [ ''[[#Audio.Details.Artist|Audio.Details.Artist]]'' artistdetails ]


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "artistdetails": {
        "$ref": "Audio.Details.Artist"
      }
    }
  },
  "params": [
    {
      "required": true,
      "name": "artistid",
      "$ref": "Library.Id"
    },
    {
      "name": "properties",
      "$ref": "Audio.Fields.Artist"
    }
  ],
  "description": "Retrieve details about a specific artist"
}</syntaxhighlight>}}


====AudioLibrary.GetArtists====
==== AudioLibrary.GetArtists ====
Retrieve all artists<br />
Retrieve all artists<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#[ ''[[#Optional.Boolean|Optional.Boolean]]'' albumartistsonly = null ]
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#Library.Id|Library.Id]]'' genreid = -1 ]
# [ ''[[#Optional.Boolean|Optional.Boolean]]'' albumartistsonly = null ]
#[ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' fields ]
# [ ''[[#Library.Id|Library.Id]]'' genreid = -1 ]
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
*[ ''array'' artists ]
* [ ''[[#Audio.Details.Artist|Audio.Details.Artist]]''[] artists ]


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      },
      "artists": {
        "items": {
          "$ref": "Audio.Details.Artist"
        },
        "type": "array"
      }
    }
  },
  "params": [
    {
      "default": null,
      "description": "Whether or not to include artists only appearing in compilations. If the parameter is not passed or is passed as null the GUI setting will be used",
      "name": "albumartistsonly",
      "$ref": "Optional.Boolean"
    },
    {
      "default": -1,
      "name": "genreid",
      "$ref": "Library.Id"
    },
    {
      "name": "properties",
      "$ref": "Audio.Fields.Artist"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Retrieve all artists"
}</syntaxhighlight>}}


====AudioLibrary.GetGenres====
==== AudioLibrary.GetGenres ====
Retrieve all genres<br />
Retrieve all genres<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#[ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' fields ]
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''array'' genres
* ''[[#Library.Details.Genre|Library.Details.Genre]]''[] genres
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "genres": {
        "items": {
          "$ref": "Library.Details.Genre"
        },
        "required": true,
        "type": "array"
      },
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      }
    }
  },
  "params": [
    {
      "name": "properties",
      "$ref": "Library.Fields.Genre"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Retrieve all genres"
}</syntaxhighlight>}}


====AudioLibrary.GetRecentlyAddedAlbums====
==== AudioLibrary.GetRecentlyAddedAlbums ====
Retrieve recently added albums<br />
Retrieve recently added albums<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#[ ''[[#List.Amount|List.Amount]]'' albums = -1 ]
<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]]'' fields ]
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
'''Returns: '''<br />
</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 />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''array'' albums ]
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "albums": {
        "items": {
          "$ref": "Audio.Details.Album"
        },
        "type": "array"
      },
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      }
    }
  },
  "params": [
    {
      "name": "properties",
      "$ref": "Audio.Fields.Album"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Retrieve recently added albums"
}</syntaxhighlight>}}


====AudioLibrary.GetRecentlyAddedSongs====
==== AudioLibrary.GetRecentlyAddedSongs ====
Retrieve recently added songs<br />
Retrieve recently added songs<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#[ ''[[#List.Amount|List.Amount]]'' albums = -1 ]
<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]]'' fields ]
# [ ''[[#List.Amount|List.Amount]]'' albumlimit = -1 ]
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
*[ ''array'' songs ]
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ]


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      },
      "songs": {
        "items": {
          "$ref": "Audio.Details.Song"
        },
        "type": "array"
      }
    }
  },
  "params": [
    {
      "default": -1,
      "description": "The amount of recently added albums from which to return the songs",
      "name": "albumlimit",
      "$ref": "List.Amount"
    },
    {
      "name": "properties",
      "$ref": "Audio.Fields.Song"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Retrieve recently added songs"
}</syntaxhighlight>}}


====AudioLibrary.GetSongDetails====
==== AudioLibrary.GetSongDetails ====
Retrieve details about a specific song<br />
Retrieve details about a specific song<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''[[#Library.Id|Library.Id]]'' songid
<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]]'' fields ]
# ''[[#Library.Id|Library.Id]]'' songid
'''Returns: '''<br />
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''[[#Audio.Details.Song|Audio.Details.Song]]'' songdetails ]
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]'' songdetails ]


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "songdetails": {
        "$ref": "Audio.Details.Song"
      }
    }
  },
  "params": [
    {
      "required": true,
      "name": "songid",
      "$ref": "Library.Id"
    },
    {
      "name": "properties",
      "$ref": "Audio.Fields.Song"
    }
  ],
  "description": "Retrieve details about a specific song"
}</syntaxhighlight>}}


====AudioLibrary.GetSongs====
==== AudioLibrary.GetSongs ====
Retrieve all songs from specified album, artist or genre<br />
Retrieve all songs from specified album, artist or genre<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#[ ''[[#Library.Id|Library.Id]]'' artistid = -1 ]
<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 = -1 ]
# [ ''[[#Library.Id|Library.Id]]'' artistid = -1 ]
#[ ''[[#Library.Id|Library.Id]]'' genreid = -1 ]
# [ ''[[#Library.Id|Library.Id]]'' albumid = -1 ]
#[ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' fields ]
# [ ''[[#Library.Id|Library.Id]]'' genreid = -1 ]
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
*[ ''array'' songs ]
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ]


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      },
      "songs": {
        "items": {
          "$ref": "Audio.Details.Song"
        },
        "type": "array"
      }
    }
  },
  "params": [
    {
      "default": -1,
      "name": "artistid",
      "$ref": "Library.Id"
    },
    {
      "default": -1,
      "name": "albumid",
      "$ref": "Library.Id"
    },
    {
      "default": -1,
      "name": "genreid",
      "$ref": "Library.Id"
    },
    {
      "name": "properties",
      "$ref": "Audio.Fields.Song"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Retrieve all songs from specified album, artist or genre"
}</syntaxhighlight>}}


====AudioLibrary.Scan====
==== AudioLibrary.Scan ====
Scans the audio sources for new library items<br />
Scans the audio sources for new library items<br />
'''Permission:''' UpdateData<br />
'''Permissions:'''
'''Parameters:''' None
* UpdateData
<br />
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
===AudioPlayer===
====AudioPlayer.BigSkipBackward====
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlayer.BigSkipForward====
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlayer.Forward====
Forward current playback<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlayer.GetPercentage====
Retrieve current playback progress in percentage<br />
'''Permission:''' ReadData<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''number''<br />
'''Optional:''' true
 
====AudioPlayer.GetTime====
Retrieves the current and total time of the currently playing file<br />
'''Permission:''' ReadData<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''[[#Player.TimeValues|Player.TimeValues]]''<br />
'''Optional:''' true
 
====AudioPlayer.PlayPause====
Pauses or unpause playback and returns the new state<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''[[#Player.State|Player.State]]''<br />
'''Optional:''' true
 
====AudioPlayer.Rewind====
Rewind current playback<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlayer.SeekPercentage====
Seek to a specific percentage<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:'''
#''[[#Player.SeekPercentage|Player.SeekPercentage]]'' value
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlayer.SeekTime====
Seek to a specific time<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:'''
#''[[#Player.SeekTime|Player.SeekTime]]'' value
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlayer.SkipNext====
Skips to next item on the playlist<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlayer.SkipPrevious====
Skips to previous item on the playlist<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlayer.SmallSkipBackward====
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlayer.SmallSkipForward====
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlayer.State====
Returns playback state of the audio player (if it is active)<br />
'''Permission:''' ReadData<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''[[#Player.State.Extended|Player.State.Extended]]''<br />
'''Optional:''' true
 
====AudioPlayer.Stop====
Stops playback<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Scans the audio sources for new library items"
}</syntaxhighlight>}}


===AudioPlaylist===
=== Files ===
====AudioPlaylist.Add====
==== Files.Download ====
Add item(s) to playlist<br />
Provides a way to download a given file (e.g. providing an URL to the real file location)<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''[[#Playlist.Audio.Item|Playlist.Audio.Item]]'' item
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Returns: '''<br />
# ''string'' path
'''Type:''' ''string''<br />
</div>
'''Optional:''' true
'''Returns:'''  
 
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
====AudioPlaylist.Clear====
Clear playlist<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlaylist.GetItems====
Get all items from playlist<br />
'''Permission:''' ReadData<br />
'''Parameters:'''
#[ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' fields ]
#[ ''[[#List.Limits|List.Limits]]'' limits ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
'''Returns: '''<br />
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''[[#List.Items.Audio|List.Items.Audio]]'' items
* ''string'' path
*[ ''[[#Playlist.State|Playlist.State]]'' state ]
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "path": {
        "required": true,
        "type": "string"
      }
    }
  },
  "params": [
    {
      "required": true,
      "type": "string",
      "name": "path"
    }
  ],
  "description": "Provides a way to download a given file (e.g. providing an URL to the real file location)"
}</syntaxhighlight>}}


====AudioPlaylist.Insert====
==== Files.GetDirectory ====
Insert item(s) into playlist<br />
Get the directories and files in the given directory<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''[[#Playlist.Item.Position|Playlist.Item.Position]]'' index
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''[[#Playlist.Audio.Item|Playlist.Audio.Item]]'' item
# ''string'' directory
'''Returns: '''<br />
# [ ''[[#Files.Media|Files.Media]]'' media = "files" ]
'''Type:''' ''string''<br />
# [ ''[[#List.Fields.All|List.Fields.All]]'' properties ]
'''Optional:''' true
# [ ''[[#List.Sort|List.Sort]]'' sort ]
 
</div>
====AudioPlaylist.Play====
'''Returns:'''  
Play current or a specific item<br />
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Permission:''' ControlPlayback<br />
'''Parameters:'''
#[ ''[[#Playlist.Item.Position|Playlist.Item.Position]]'' item = -1 ]
#[ ''[[#Library.Id|Library.Id]]'' songid = -1 ]
'''Returns: '''<br />
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''boolean'' success
* ''[[#List.Item.File|List.Item.File]]''[] files
 
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
 
====AudioPlaylist.Remove====
Remove item from playlist<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:'''
#''[[#Playlist.Item.Position|Playlist.Item.Position]]'' item
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlaylist.Repeat====
Set the repeat mode of the playlist<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:'''
#''[[#Playlist.Repeat|Playlist.Repeat]]'' state
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlaylist.Shuffle====
Shuffle playlist<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlaylist.SkipNext====
Skip current item and play next item<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlaylist.SkipPrevious====
Skip current item and play previous item<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlaylist.State====
Provides information about the current state of the playlist<br />
'''Permission:''' ReadData<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''[[#Playlist.State|Playlist.State]]''<br />
'''Optional:''' true
 
====AudioPlaylist.Swap====
Swap items in the playlist<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:'''
#''[[#Playlist.Item.Position|Playlist.Item.Position]]'' item1
#''[[#Playlist.Item.Position|Playlist.Item.Position]]'' item2
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====AudioPlaylist.UnShuffle====
Unshuffle playlist<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
===Files===
====Files.Download====
Takes a XBMC internal path to a file (e.g. special://masterprofile/Thumbnails/Music/e/ec96cd54.tbn) and returns the URL where the file can be downloaded (e. g.  http://192.168.1.2:8080/vfs/special://masterprofile/Thumbnails/Music/e/ec96cd54.tbn).
 
'''Permission:''' ReadData<br />
'''Parameters:'''
#''string'' path
'''Returns: '''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
*''string'' path
 
====Files.GetDirectory====
'''Permission:''' ReadData<br />
'''Parameters:'''
#''string'' directory
#[ ''[[#Files.Media|Files.Media]]'' media = "files" ]
#[ ''[[#List.Fields.All|List.Fields.All]]'' fields ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
'''Returns: '''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
*''[[#List.Items.Files|List.Items.Files]]'' files
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "files": {
        "items": {
          "$ref": "List.Item.File"
        },
        "required": true,
        "type": "array"
      },
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      }
    }
  },
  "params": [
    {
      "required": true,
      "type": "string",
      "name": "directory"
    },
    {
      "default": "files",
      "name": "media",
      "$ref": "Files.Media"
    },
    {
      "name": "properties",
      "$ref": "List.Fields.All"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Get the directories and files in the given directory"
}</syntaxhighlight>}}


====Files.GetSources====
==== Files.GetSources ====
Get the sources of the media windows<br />
Get the sources of the media windows<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''[[#Files.Media|Files.Media]]'' media
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# ''[[#Files.Media|Files.Media]]'' media
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''[[#List.Items.Shares|List.Items.Shares]]'' shares
* ''[[#List.Items.Sources|List.Items.Sources]]'' sources
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "sources": {
        "required": true,
        "$ref": "List.Items.Sources"
      },
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      }
    }
  },
  "params": [
    {
      "required": true,
      "name": "media",
      "$ref": "Files.Media"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Get the sources of the media windows"
}</syntaxhighlight>}}


===Input===
=== Input ===
====Input.Back====
==== Input.Back ====
Goes back in GUI<br />
Goes back in GUI<br />
'''Permission:''' Navigate<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Goes back in GUI"
}</syntaxhighlight>}}


====Input.Down====
==== Input.Down ====
Navigate down in GUI<br />
Navigate down in GUI<br />
'''Permission:''' Navigate<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Navigate down in GUI"
}</syntaxhighlight>}}


====Input.Home====
==== Input.Home ====
Goes to home window in GUI<br />
Goes to home window in GUI<br />
'''Permission:''' Navigate<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Goes to home window in GUI"
}</syntaxhighlight>}}


====Input.Left====
==== Input.Left ====
Navigate left in GUI<br />
Navigate left in GUI<br />
'''Permission:''' Navigate<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Navigate left in GUI"
}</syntaxhighlight>}}


====Input.Right====
==== Input.Right ====
Navigate right in GUI<br />
Navigate right in GUI<br />
'''Permission:''' Navigate<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Navigate right in GUI"
}</syntaxhighlight>}}


====Input.Select====
==== Input.Select ====
Select current item in GUI<br />
Select current item in GUI<br />
'''Permission:''' Navigate<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Select current item in GUI"
}</syntaxhighlight>}}


====Input.Up====
==== Input.Up ====
Navigate up in GUI<br />
Navigate up in GUI<br />
'''Permission:''' Navigate<br />
'''Permissions:'''
* Navigate
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Navigate up in GUI"
}</syntaxhighlight>}}


===JSONRPC===
=== JSONRPC ===
====JSONRPC.GetConfiguration====
==== JSONRPC.Introspect ====
Get client-specific configurations<br />
'''Permission:''' ReadData<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''[[#Configuration|Configuration]]''<br />
'''Optional:''' true
 
====JSONRPC.Introspect====
Enumerates all actions and descriptions<br />
Enumerates all actions and descriptions<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#[ ''boolean'' getdescriptions = True ]
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''boolean'' getmetadata = False ]
# [ ''boolean'' getdescriptions = True ]
#[ ''boolean'' filterbytransport = True ]
# [ ''boolean'' getmetadata = False ]
#[ ''object'' filter ]<br />
# [ ''boolean'' filterbytransport = True ]
# [ ''object'' filter ]<br />
'''Properties:'''
'''Properties:'''
*''string'' type
* ''string'' type
*''string'' id
* ''string'' id
*[ ''boolean'' getreferences = True ]
* [ ''boolean'' getreferences = True ]


'''Returns: '''<br />
</div>
'''Type:''' ''object''<br />
'''Returns:'''  
'''Optional:''' true
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object"
  },
  "params": [
    {
      "default": true,
      "type": "boolean",
      "name": "getdescriptions"
    },
    {
      "default": false,
      "type": "boolean",
      "name": "getmetadata"
    },
    {
      "default": true,
      "type": "boolean",
      "name": "filterbytransport"
    },
    {
      "type": "object",
      "name": "filter",
      "properties": {
        "type": {
          "enums": [
            "method",
            "namespace",
            "type",
            "notification"
          ],
          "type": "string",
          "description": "Type of the given name",
          "required": true
        },
        "id": {
          "required": true,
          "type": "string",
          "description": "Name of a namespace, method or type"
        },
        "getreferences": {
          "default": true,
          "type": "boolean",
          "description": "Whether or not to print the schema for referenced types"
        }
      }
    }
  ],
  "description": "Enumerates all actions and descriptions"
}</syntaxhighlight>}}


====JSONRPC.NotifyAll====
==== JSONRPC.NotifyAll ====
Notify all other connected clients<br />
Notify all other connected clients<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''string'' sender
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''string'' message
# ''string'' sender
#[ ''any'' data = null ]
# ''string'' message
'''Returns: '''<br />
# [ ''any'' data = null ]
'''Type:''' ''any''<br />
</div>
'''Optional:''' true
'''Returns:''' ''any''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "any"
  },
  "params": [
    {
      "required": true,
      "type": "string",
      "name": "sender"
    },
    {
      "required": true,
      "type": "string",
      "name": "message"
    },
    {
      "default": null,
      "type": "any",
      "name": "data"
    }
  ],
  "description": "Notify all other connected clients"
}</syntaxhighlight>}}


====JSONRPC.Permission====
==== JSONRPC.Permission ====
Retrieve the clients permissions<br />
Retrieve the clients permissions<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''boolean'' removedata
* ''boolean'' navigate
*''boolean'' controlplayback
* ''boolean'' removedata
*''boolean'' readdata
* ''boolean'' controlplayback
*''boolean'' updatedata
* ''boolean'' readdata
*''boolean'' writefile
* ''boolean'' updatedata
*''boolean'' controlnotify
* ''boolean'' writefile
*''boolean'' controlpower
* ''boolean'' controlnotify
* ''boolean'' controlpower


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "navigate": {
        "required": true,
        "type": "boolean"
      },
      "removedata": {
        "required": true,
        "type": "boolean"
      },
      "controlplayback": {
        "required": true,
        "type": "boolean"
      },
      "readdata": {
        "required": true,
        "type": "boolean"
      },
      "updatedata": {
        "required": true,
        "type": "boolean"
      },
      "writefile": {
        "required": true,
        "type": "boolean"
      },
      "controlnotify": {
        "required": true,
        "type": "boolean"
      },
      "controlpower": {
        "required": true,
        "type": "boolean"
      }
    }
  },
  "params": [],
  "description": "Retrieve the clients permissions"
}</syntaxhighlight>}}


====JSONRPC.Ping====
==== JSONRPC.Ping ====
Ping responder<br />
Ping responder<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Ping responder"
}</syntaxhighlight>}}


====JSONRPC.SetConfiguration====
==== JSONRPC.Version ====
Change the client-specific configuration<br />
Retrieve the jsonrpc protocol version<br />
'''Permission:''' ControlNotify<br />
'''Permissions:'''
* ReadData
'''Parameters:''' None
<br />
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Retrieve the jsonrpc protocol version"
}</syntaxhighlight>}}
 
=== Player ===
==== Player.GetActivePlayers ====
Returns all active players<br />
'''Permissions:'''
* ReadData
'''Parameters:''' None
<br />
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "uniqueItems": true,
    "items": {
      "type": "object",
      "properties": {
        "playerid": {
          "required": true,
          "$ref": "Player.Id"
        },
        "type": {
          "required": true,
          "$ref": "Player.Type"
        }
      }
    },
    "type": "array"
  },
  "params": [],
  "description": "Returns all active players"
}</syntaxhighlight>}}
 
==== Player.GetItem ====
Retrieves the currently played item<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#[ ''object'' notifications ]<br />
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# [ ''[[#List.Fields.All|List.Fields.All]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
'''Properties:'''
*[ ''[[#Optional.Boolean|Optional.Boolean]]'' gui = null ]
* ''[[#List.Item.All|List.Item.All]]'' item
*[ ''[[#Optional.Boolean|Optional.Boolean]]'' system = null ]
 
*[ ''[[#Optional.Boolean|Optional.Boolean]]'' player = null ]
</div>
*[ ''[[#Optional.Boolean|Optional.Boolean]]'' audiolibrary = null ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*[ ''[[#Optional.Boolean|Optional.Boolean]]'' other = null ]
  "returns": {
*[ ''[[#Optional.Boolean|Optional.Boolean]]'' videolibrary = null ]
    "type": "object",
    "properties": {
      "item": {
        "required": true,
        "$ref": "List.Item.All"
      }
    }
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    },
    {
      "name": "properties",
      "$ref": "List.Fields.All"
    }
  ],
  "description": "Retrieves the currently played item"
}</syntaxhighlight>}}
 
==== Player.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''[[#Player.Property.Name|Player.Property.Name]]''[] properties
</div>
'''Returns:''' ''[[#Player.Property.Value|Player.Property.Value]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "$ref": "Player.Property.Value"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    },
    {
      "uniqueItems": true,
      "items": {
        "$ref": "Player.Property.Name"
      },
      "required": true,
      "type": "array",
      "name": "properties"
    }
  ],
  "description": "Retrieves the values of the given properties"
}</syntaxhighlight>}}
 
==== Player.GoNext ====
Go to next item on the playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    }
  ],
  "description": "Go to next item on the playlist"
}</syntaxhighlight>}}


'''Returns: '''<br />
==== Player.GoPrevious ====
'''Type:''' ''[[#Configuration|Configuration]]''<br />
Go to previous item on the playlist<br />
'''Optional:''' true
'''Permissions:'''
* ControlPlayback
'''Parameters:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    }
  ],
  "description": "Go to previous item on the playlist"
}</syntaxhighlight>}}


====JSONRPC.Version====
==== Player.GoTo ====
Retrieve the jsonrpc protocol version<br />
Go to item at the given position in the playlist<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
'''Parameters:''' None
* ControlPlayback
<br />
'''Parameters:'''  
'''Returns: '''<br />
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
# ''[[#Player.Id|Player.Id]]'' playerid
'''Optional:''' true
# ''[[#Playlist.Position|Playlist.Position]]'' position
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    },
    {
      "required": true,
      "name": "position",
      "$ref": "Playlist.Position"
    }
  ],
  "description": "Go to item at the given position in the playlist"
}</syntaxhighlight>}}


===PicturePlayer===
==== Player.MoveDown ====
====PicturePlayer.MoveDown====
If picture is zoomed move viewport down<br />
If picture is zoomed move viewport down<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
'''Parameters:''' None
* ControlPlayback
<br />
'''Parameters:'''  
'''Returns: '''<br />
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
# ''[[#Player.Id|Player.Id]]'' playerid
'''Optional:''' true
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    }
  ],
  "description": "If picture is zoomed move viewport down"
}</syntaxhighlight>}}


====PicturePlayer.MoveLeft====
==== Player.MoveLeft ====
If picture is zoomed move viewport left otherwise skip previous<br />
If picture is zoomed move viewport left otherwise skip previous<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
'''Parameters:''' None
* ControlPlayback
<br />
'''Parameters:'''  
'''Returns: '''<br />
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
# ''[[#Player.Id|Player.Id]]'' playerid
'''Optional:''' true
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    }
  ],
  "description": "If picture is zoomed move viewport left otherwise skip previous"
}</syntaxhighlight>}}


====PicturePlayer.MoveRight====
==== Player.MoveRight ====
If picture is zoomed move viewport right otherwise skip next<br />
If picture is zoomed move viewport right otherwise skip next<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
'''Parameters:''' None
* ControlPlayback
<br />
'''Parameters:'''  
'''Returns: '''<br />
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
# ''[[#Player.Id|Player.Id]]'' playerid
'''Optional:''' true
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    }
  ],
  "description": "If picture is zoomed move viewport right otherwise skip next"
}</syntaxhighlight>}}


====PicturePlayer.MoveUp====
==== Player.MoveUp ====
If picture is zoomed move viewport up<br />
If picture is zoomed move viewport up<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
'''Parameters:''' None
* ControlPlayback
<br />
'''Parameters:'''
'''Returns: '''<br />
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
# ''[[#Player.Id|Player.Id]]'' playerid
'''Optional:''' true
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    }
  ],
  "description": "If picture is zoomed move viewport up"
}</syntaxhighlight>}}
 
==== Player.Open ====
Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed'' item ]
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "type": [
        {
          "additionalProperties": false,
          "type": "object",
          "properties": {
            "position": {
              "default": 0,
              "$ref": "Playlist.Position"
            },
            "playlistid": {
              "required": true,
              "$ref": "Playlist.Id"
            }
          }
        },
        {
          "$ref": "Playlist.Item"
        },
        {
          "additionalProperties": false,
          "type": "object",
          "properties": {
            "path": {
              "required": true,
              "type": "string"
            },
            "random": {
              "default": true,
              "type": "boolean"
            },
            "recursive": {
              "default": true,
              "type": "boolean"
            }
          }
        }
      ],
      "name": "item"
    }
  ],
  "description": "Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database."
}</syntaxhighlight>}}
 
==== Player.PlayPause ====
Pauses or unpause playback and returns the new state<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
</div>
'''Returns:''' ''[[#Player.Speed|Player.Speed]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "$ref": "Player.Speed"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    }
  ],
  "description": "Pauses or unpause playback and returns the new state"
}</syntaxhighlight>}}


====PicturePlayer.PlayPause====
==== Player.Repeat ====
Pauses or unpause slideshow<br />
Set the repeat mode of the player<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
'''Parameters:''' None
* ControlPlayback
<br />
'''Parameters:'''  
'''Returns: '''<br />
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
# ''[[#Player.Id|Player.Id]]'' playerid
'''Optional:''' true
# ''[[#Player.Repeat|Player.Repeat]]'' state
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    },
    {
      "required": true,
      "name": "state",
      "$ref": "Player.Repeat"
    }
  ],
  "description": "Set the repeat mode of the player"
}</syntaxhighlight>}}


====PicturePlayer.Rotate====
==== Player.Rotate ====
Rotates current picture<br />
Rotates current picture<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
'''Parameters:''' None
* ControlPlayback
<br />
'''Parameters:'''  
'''Returns: '''<br />
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
# ''[[#Player.Id|Player.Id]]'' playerid
'''Optional:''' true
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    }
  ],
  "description": "Rotates current picture"
}</syntaxhighlight>}}


====PicturePlayer.SkipNext====
==== Player.Seek ====
Skips to next picture in the slideshow<br />
Seek through the playing item<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
'''Parameters:''' None
* ControlPlayback
<br />
'''Parameters:'''
'''Returns: '''<br />
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
# ''[[#Player.Id|Player.Id]]'' playerid
'''Optional:''' true
# ''mixed'' value
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Global.Time|Global.Time]]'' totaltime ]
* [ ''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage = 0 ]
* [ ''[[#Global.Time|Global.Time]]'' time ]


====PicturePlayer.SkipPrevious====
</div>
Skips to previous picture in the slideshow<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Permission:''' ControlPlayback<br />
  "returns": {
'''Parameters:''' None
    "type": "object",
<br />
    "properties": {
'''Returns: '''<br />
      "totaltime": {
'''Type:''' ''string''<br />
        "$ref": "Global.Time"
'''Optional:''' true
      },
      "percentage": {
        "default": 0,
        "$ref": "Player.Position.Percentage"
      },
      "time": {
        "$ref": "Global.Time"
      }
    }
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    },
    {
      "required": true,
      "type": [
        {
          "description": "Percentage value to seek to",
          "$ref": "Player.Position.Percentage"
        },
        {
          "additionalProperties": false,
          "type": "object",
          "description": "Time to seek to",
          "properties": {
            "hours": {
              "default": 0,
              "minimum": 0,
              "type": "integer",
              "maximum": 23
            },
            "seconds": {
              "default": 0,
              "minimum": 0,
              "type": "integer",
              "maximum": 59
            },
            "minutes": {
              "default": 0,
              "minimum": 0,
              "type": "integer",
              "maximum": 59
            },
            "milliseconds": {
              "default": 0,
              "minimum": 0,
              "type": "integer",
              "maximum": 999
            }
          }
        },
        {
          "enums": [
            "smallforward",
            "smallbackward",
            "bigforward",
            "bigbackward"
          ],
          "type": "string",
          "description": "Seek by predefined jumps"
        }
      ],
      "name": "value"
    }
  ],
  "description": "Seek through the playing item"
}</syntaxhighlight>}}


====PicturePlayer.Stop====
==== Player.SetAudioStream ====
Stops slideshow<br />
Set the audio stream played by the player<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
'''Parameters:''' None
* ControlPlayback
<br />
'''Parameters:'''  
'''Returns: '''<br />
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
# ''[[#Player.Id|Player.Id]]'' playerid
'''Optional:''' true
# ''mixed'' stream
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    },
    {
      "required": true,
      "type": [
        {
          "enums": [
            "previous",
            "next"
          ],
          "type": "string"
        },
        {
          "minimum": 0,
          "type": "integer",
          "description": "Index of the audio stream to play"
        }
      ],
      "name": "stream"
    }
  ],
  "description": "Set the audio stream played by the player"
}</syntaxhighlight>}}


====PicturePlayer.Zoom====
==== Player.SetSpeed ====
Zooms current picture<br />
Set the speed of the current playback<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''  
'''Parameters:'''  
#''integer'' value
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Returns: '''<br />
# ''[[#Player.Id|Player.Id]]'' playerid
'''Type:''' ''string''<br />
# ''mixed'' speed
'''Optional:''' true
</div>
'''Returns:''' ''[[#Player.Speed|Player.Speed]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "$ref": "Player.Speed"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    },
    {
      "enums": [
        -32,
        -16,
        -8,
        -4,
        -2,
        -1,
        0,
        1,
        2,
        4,
        8,
        16,
        32,
        "increment",
        "decrement"
      ],
      "type": [
        {
          "minimum": 0,
          "type": "integer"
        },
        {
          "type": "string"
        }
      ],
      "name": "speed",
      "required": true
    }
  ],
  "description": "Set the speed of the current playback"
}</syntaxhighlight>}}


====PicturePlayer.ZoomIn====
==== Player.SetSubtitle ====
Zoom in once<br />
Set the subtitle displayed by the player<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
'''Parameters:''' None
* ControlPlayback
<br />
'''Parameters:'''  
'''Returns: '''<br />
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
# ''[[#Player.Id|Player.Id]]'' playerid
'''Optional:''' true
# ''mixed'' subtitle
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    },
    {
      "required": true,
      "type": [
        {
          "enums": [
            "previous",
            "next",
            "off",
            "on"
          ],
          "type": "string"
        },
        {
          "minimum": 0,
          "type": "integer",
          "description": "Index of the subtitle to display"
        }
      ],
      "name": "subtitle"
    }
  ],
  "description": "Set the subtitle displayed by the player"
}</syntaxhighlight>}}


====PicturePlayer.ZoomOut====
==== Player.Shuffle ====
Zoom out once<br />
Shuffle items in the player<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
'''Parameters:''' None
* ControlPlayback
<br />
'''Parameters:'''  
'''Returns: '''<br />
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
# ''[[#Player.Id|Player.Id]]'' playerid
'''Optional:''' true
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    }
  ],
  "description": "Shuffle items in the player"
}</syntaxhighlight>}}


===Player===
==== Player.Stop ====
====Player.GetActivePlayers====
Stops playback<br />
Returns all active players<br />
'''Permissions:'''
'''Permission:''' ReadData<br />
* ControlPlayback
'''Parameters:''' None
'''Parameters:'''  
<br />
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Returns: '''<br />
# ''[[#Player.Id|Player.Id]]'' playerid
'''Type:''' ''object''<br />
</div>
'''Optional:''' true<br />
'''Returns:''' ''string''
'''Properties:'''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*''boolean'' picture
  "returns": {
*''boolean'' audio
    "type": "string"
*''boolean'' video
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    }
  ],
  "description": "Stops playback"
}</syntaxhighlight>}}


==== Player.UnShuffle ====
Unshuffle items in the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    }
  ],
  "description": "Unshuffle items in the player"
}</syntaxhighlight>}}


===Playlist===
==== Player.Zoom ====
====Playlist.Add====
Zooms current picture<br />
Add items to the playlist<br />
'''Permissions:'''
'''Permission:''' ControlPlayback<br />
* ControlPlayback
'''Parameters:'''  
'''Parameters:'''  
#''[[#Playlist.Id|Playlist.Id]]'' playlist
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''[[#Playlist.Id|Playlist.Id]]'' items
# ''[[#Player.Id|Player.Id]]'' playerid
'''Returns: '''<br />
# ''integer'' value
'''Type:''' ''string''<br />
</div>
'''Optional:''' true
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    },
    {
      "description": "Zoom level",
      "required": true,
      "maximum": 10,
      "minimum": 1,
      "type": "integer",
      "name": "value"
    }
  ],
  "description": "Zooms current picture"
}</syntaxhighlight>}}


====Playlist.Clear====
==== Player.ZoomIn ====
Clear playlist<br />
Zoom in once<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''  
'''Parameters:'''  
#''[[#Playlist.Id|Playlist.Id]]'' playlist
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Returns: '''<br />
# ''[[#Player.Id|Player.Id]]'' playerid
'''Type:''' ''string''<br />
</div>
'''Optional:''' true
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    }
  ],
  "description": "Zoom in once"
}</syntaxhighlight>}}


====Playlist.Create====
==== Player.ZoomOut ====
Creates a virtual playlist from a given one from a file<br />
Zoom out once<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''  
'''Parameters:'''  
#''[[#Playlist.Id|Playlist.Id]]'' playlist
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Returns: '''<br />
# ''[[#Player.Id|Player.Id]]'' playerid
'''Type:''' ''object''<br />
</div>
'''Optional:''' true<br />
'''Returns:''' ''string''
'''Properties:'''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*''string'' playlistid
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playerid",
      "$ref": "Player.Id"
    }
  ],
  "description": "Zoom out once"
}</syntaxhighlight>}}


=== Playlist ===
==== Playlist.Add ====
Add item(s) to playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Item|Playlist.Item]]'' item
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playlistid",
      "$ref": "Playlist.Id"
    },
    {
      "required": true,
      "name": "item",
      "$ref": "Playlist.Item"
    }
  ],
  "description": "Add item(s) to playlist"
}</syntaxhighlight>}}


====Playlist.Destroy====
==== Playlist.Clear ====
Destroys a virtual playlist<br />
Clear playlist<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''  
'''Parameters:'''  
#''string'' playlistid
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Returns: '''<br />
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
'''Type:''' ''string''<br />
</div>
'''Optional:''' true
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playlistid",
      "$ref": "Playlist.Id"
    }
  ],
  "description": "Clear playlist"
}</syntaxhighlight>}}


====Playlist.GetItems====
==== Playlist.GetItems ====
Retrieve items in the playlist<br />
Get all items from playlist<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''[[#Playlist.Id|Playlist.Id]]'' playlist
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#List.Fields.All|List.Fields.All]]'' fields ]
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Fields.All|List.Fields.All]]'' properties ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''[[#List.Items.All|List.Items.All]]'' items
* ''[[#List.Item.All|List.Item.All]]''[] items
*[ ''string'' name = "" ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "items": {
        "items": {
          "$ref": "List.Item.All"
        },
        "required": true,
        "type": "array"
      },
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      }
    }
  },
  "params": [
    {
      "required": true,
      "name": "playlistid",
      "$ref": "Playlist.Id"
    },
    {
      "name": "properties",
      "$ref": "List.Fields.All"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Get all items from playlist"
}</syntaxhighlight>}}


====Playlist.Remove====
==== Playlist.GetPlaylists ====
Remove item from the playlist<br />
Returns all existing playlists<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
* ReadData
'''Parameters:''' None
<br />
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "uniqueItems": true,
    "items": {
      "type": "object",
      "properties": {
        "playlistid": {
          "required": true,
          "$ref": "Playlist.Id"
        },
        "type": {
          "required": true,
          "$ref": "Playlist.Type"
        }
      }
    },
    "type": "array"
  },
  "params": [],
  "description": "Returns all existing playlists"
}</syntaxhighlight>}}
 
==== Playlist.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''[[#Playlist.Id|Playlist.Id]]'' playlist
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''['string', 'integer']'' item
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
'''Returns: '''<br />
# ''[[#Playlist.Property.Name|Playlist.Property.Name]]''[] properties
'''Type:''' ''string''<br />
</div>
'''Optional:''' true
'''Returns:''' ''[[#Playlist.Property.Value|Playlist.Property.Value]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "$ref": "Playlist.Property.Value"
  },
  "params": [
    {
      "required": true,
      "name": "playlistid",
      "$ref": "Playlist.Id"
    },
    {
      "uniqueItems": true,
      "items": {
        "$ref": "Playlist.Property.Name"
      },
      "required": true,
      "type": "array",
      "name": "properties"
    }
  ],
  "description": "Retrieves the values of the given properties"
}</syntaxhighlight>}}


====Playlist.Shuffle====
==== Playlist.Insert ====
Shuffle playlist<br />
Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''  
'''Parameters:'''  
#''[[#Playlist.Id|Playlist.Id]]'' playlist
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Returns: '''<br />
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
'''Type:''' ''string''<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position
'''Optional:''' true
# ''[[#Playlist.Item|Playlist.Item]]'' item
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playlistid",
      "$ref": "Playlist.Id"
    },
    {
      "required": true,
      "name": "position",
      "$ref": "Playlist.Position"
    },
    {
      "required": true,
      "name": "item",
      "$ref": "Playlist.Item"
    }
  ],
  "description": "Insert item(s) into playlist. Does not work for picture playlists (aka slideshows)."
}</syntaxhighlight>}}


====Playlist.Swap====
==== Playlist.Remove ====
Swap items in the playlist<br />
Remove item from playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''  
'''Parameters:'''  
#''[[#Playlist.Id|Playlist.Id]]'' playlist
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''[[#Playlist.Item.Position|Playlist.Item.Position]]'' item1
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
#''[[#Playlist.Item.Position|Playlist.Item.Position]]'' item2
# ''[[#Playlist.Position|Playlist.Position]]'' position
'''Returns: '''<br />
</div>
'''Type:''' ''string''<br />
'''Returns:''' ''string''
'''Optional:''' true
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playlistid",
      "$ref": "Playlist.Id"
    },
    {
      "required": true,
      "name": "position",
      "$ref": "Playlist.Position"
    }
  ],
  "description": "Remove item from playlist. Does not work for picture playlists (aka slideshows)."
}</syntaxhighlight>}}


====Playlist.UnShuffle====
==== Playlist.Swap ====
Unshuffle playlist<br />
Swap items in the playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permission:''' ControlPlayback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''  
'''Parameters:'''  
#''[[#Playlist.Id|Playlist.Id]]'' playlist
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Returns: '''<br />
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
'''Type:''' ''string''<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position1
'''Optional:''' true
# ''[[#Playlist.Position|Playlist.Position]]'' position2
</div>
'''Returns:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "string"
  },
  "params": [
    {
      "required": true,
      "name": "playlistid",
      "$ref": "Playlist.Id"
    },
    {
      "required": true,
      "name": "position1",
      "$ref": "Playlist.Position"
    },
    {
      "required": true,
      "name": "position2",
      "$ref": "Playlist.Position"
    }
  ],
  "description": "Swap items in the playlist. Does not work for picture playlists (aka slideshows)."
}</syntaxhighlight>}}


===System===
=== System ===
====System.GetProperties====
==== System.GetProperties ====
Retrieves the values of the given properties<br />
Retrieves the values of the given properties<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''array'' properties
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Returns: '''<br />
# ''[[#System.Property.Name|System.Property.Name]]''[] properties
'''Type:''' ''[[#System.Property.Value|System.Property.Value]]''<br />
</div>
'''Optional:''' true
'''Returns:''' ''[[#System.Property.Value|System.Property.Value]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "$ref": "System.Property.Value"
  },
  "params": [
    {
      "uniqueItems": true,
      "items": {
        "$ref": "System.Property.Name"
      },
      "required": true,
      "type": "array",
      "name": "properties"
    }
  ],
  "description": "Retrieves the values of the given properties"
}</syntaxhighlight>}}


====System.Hibernate====
==== System.Hibernate ====
Puts the system running XBMC into hibernate mode<br />
Puts the system running XBMC into hibernate mode<br />
'''Permission:''' ControlPower<br />
'''Permissions:'''
* ControlPower
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Puts the system running Kodi into hibernate mode"
}</syntaxhighlight>}}


====System.Reboot====
==== System.Reboot ====
Reboots the system running XBMC<br />
Reboots the system running XBMC<br />
'''Permission:''' ControlPower<br />
'''Permissions:'''
* ControlPower
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Reboots the system running XBMC"
}</syntaxhighlight>}}


====System.Shutdown====
==== System.Shutdown ====
Shuts the system running XBMC down<br />
Shuts the system running XBMC down<br />
'''Permission:''' ControlPower<br />
'''Permissions:'''
* ControlPower
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Shuts the system running Kodi down"
}</syntaxhighlight>}}


====System.Suspend====
==== System.Suspend ====
Suspends the system running XBMC<br />
Suspends the system running XBMC<br />
'''Permission:''' ControlPower<br />
'''Permissions:'''
* ControlPower
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Suspends the system running XBMC"
}</syntaxhighlight>}}


===VideoLibrary===
=== VideoLibrary ===
====VideoLibrary.Clean====
==== VideoLibrary.Clean ====
Cleans the video library from non-existent items<br />
Cleans the video library from non-existent items<br />
'''Permission:''' RemoveData<br />
'''Permissions:'''
* RemoveData
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Cleans the video library from non-existent items"
}</syntaxhighlight>}}


====VideoLibrary.Export====
==== VideoLibrary.Export ====
Exports all items from the video library<br />
Exports all items from the video library<br />
'''Permission:''' WriteFile<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''  
'''Parameters:'''  
#[ ''boolean'' singlefile = True ]
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''boolean'' images = False ]
# [ ''mixed'' options ]
#[ ''boolean'' actorthumbs = False ]
</div>
#[ ''boolean'' overwrite = False ]
'''Returns:''' ''string''
#[ ''string'' path = "" ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Returns: '''<br />
  "returns": {
'''Type:''' ''string''<br />
    "type": "string"
'''Optional:''' true
  },
  "params": [
    {
      "type": [
        {
          "additionalProperties": false,
          "type": "object",
          "properties": {
            "path": {
              "minLength": 1,
              "required": true,
              "type": "string",
              "description": "Path to the directory to where the data should be exported"
            }
          }
        },
        {
          "additionalProperties": false,
          "type": "object",
          "properties": {
            "images": {
              "default": false,
              "type": "boolean",
              "description": "Whether to export thumbnails and fanart images"
            },
            "overwrite": {
              "default": false,
              "type": "boolean",
              "description": "Whether to overwrite existing exported files"
            },
            "actorthumbs": {
              "default": false,
              "type": "boolean",
              "description": "Whether to export actor thumbnails"
            }
          }
        }
      ],
      "name": "options"
    }
  ],
  "description": "Exports all items from the video library"
}</syntaxhighlight>}}


====VideoLibrary.GetEpisodeDetails====
==== VideoLibrary.GetEpisodeDetails ====
Retrieve details about a specific tv show episode<br />
Retrieve details about a specific tv show episode<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''[[#Library.Id|Library.Id]]'' episodeid
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' fields ]
# ''[[#Library.Id|Library.Id]]'' episodeid
'''Returns: '''<br />
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''[[#Video.Details.Episode|Video.Details.Episode]]'' episodedetails ]
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]'' episodedetails ]


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "episodedetails": {
        "$ref": "Video.Details.Episode"
      }
    }
  },
  "params": [
    {
      "required": true,
      "name": "episodeid",
      "$ref": "Library.Id"
    },
    {
      "name": "properties",
      "$ref": "Video.Fields.Episode"
    }
  ],
  "description": "Retrieve details about a specific tv show episode"
}</syntaxhighlight>}}


====VideoLibrary.GetEpisodes====
==== VideoLibrary.GetEpisodes ====
Retrieve all tv show episodes<br />
Retrieve all tv show episodes<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#[ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ]
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''integer'' season = -1 ]
# [ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ]
#[ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' fields ]
# [ ''integer'' season = -1 ]
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''array'' episodes ]
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]''[] episodes ]
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "episodes": {
        "items": {
          "$ref": "Video.Details.Episode"
        },
        "type": "array"
      },
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      }
    }
  },
  "params": [
    {
      "default": -1,
      "name": "tvshowid",
      "$ref": "Library.Id"
    },
    {
      "default": -1,
      "minimum": 0,
      "type": "integer",
      "name": "season"
    },
    {
      "name": "properties",
      "$ref": "Video.Fields.Episode"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Retrieve all tv show episodes"
}</syntaxhighlight>}}


====VideoLibrary.GetGenres====
==== VideoLibrary.GetGenres ====
Retrieve all genres<br />
Retrieve all genres<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''string'' type
<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]]'' fields ]
# ''string'' type
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''array'' genres
* ''[[#Library.Details.Genre|Library.Details.Genre]]''[] genres
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "genres": {
        "items": {
          "$ref": "Library.Details.Genre"
        },
        "required": true,
        "type": "array"
      },
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      }
    }
  },
  "params": [
    {
      "enums": [
        "movie",
        "tvshow",
        "musicvideo"
      ],
      "type": "string",
      "name": "type",
      "required": true
    },
    {
      "name": "properties",
      "$ref": "Library.Fields.Genre"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Retrieve all genres"
}</syntaxhighlight>}}


====VideoLibrary.GetMovieDetails====
==== VideoLibrary.GetMovieDetails ====
Retrieve details about a specific movie<br />
Retrieve details about a specific movie<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''[[#Library.Id|Library.Id]]'' movieid
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' fields ]
# ''[[#Library.Id|Library.Id]]'' movieid
'''Returns: '''<br />
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''[[#Video.Details.Movie|Video.Details.Movie]]'' moviedetails ]
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]'' moviedetails ]


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "moviedetails": {
        "$ref": "Video.Details.Movie"
      }
    }
  },
  "params": [
    {
      "required": true,
      "name": "movieid",
      "$ref": "Library.Id"
    },
    {
      "name": "properties",
      "$ref": "Video.Fields.Movie"
    }
  ],
  "description": "Retrieve details about a specific movie"
}</syntaxhighlight>}}


====VideoLibrary.GetMovieSetDetails====
==== VideoLibrary.GetMovieSetDetails ====
Retrieve details about a specific movie set<br />
Retrieve details about a specific movie set<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''[[#Library.Id|Library.Id]]'' setid
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' fields ]
# ''[[#Library.Id|Library.Id]]'' setid
#[ ''object'' movies ]<br />
# [ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties ]
# [ ''object'' movies ]<br />
'''Properties:'''
'''Properties:'''
*[ ''[[#List.Sort|List.Sort]]'' sort ]
* [ ''[[#List.Sort|List.Sort]]'' sort ]
*[ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' fields ]
* [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
*[ ''[[#List.Limits|List.Limits]]'' limits ]
* [ ''[[#List.Limits|List.Limits]]'' limits ]


'''Returns: '''<br />
</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 />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''[[#Video.Details.MovieSet.Extended|Video.Details.MovieSet.Extended]]'' setdetails ]
* [ ''[[#Video.Details.MovieSet.Extended|Video.Details.MovieSet.Extended]]'' setdetails ]


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "setdetails": {
        "$ref": "Video.Details.MovieSet.Extended"
      }
    }
  },
  "params": [
    {
      "required": true,
      "name": "setid",
      "$ref": "Library.Id"
    },
    {
      "name": "properties",
      "$ref": "Video.Fields.MovieSet"
    },
    {
      "type": "object",
      "name": "movies",
      "properties": {
        "sort": {
          "$ref": "List.Sort"
        },
        "properties": {
          "$ref": "Video.Fields.Movie"
        },
        "limits": {
          "$ref": "List.Limits"
        }
      }
    }
  ],
  "description": "Retrieve details about a specific movie set"
}</syntaxhighlight>}}


====VideoLibrary.GetMovieSets====
==== VideoLibrary.GetMovieSets ====
Retrieve all movie sets<br />
Retrieve all movie sets<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#[ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' fields ]
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
*[ ''array'' sets ]
* [ ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''[] sets ]


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      },
      "sets": {
        "items": {
          "$ref": "Video.Details.MovieSet"
        },
        "type": "array"
      }
    }
  },
  "params": [
    {
      "name": "properties",
      "$ref": "Video.Fields.MovieSet"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Retrieve all movie sets"
}</syntaxhighlight>}}


====VideoLibrary.GetMovies====
==== VideoLibrary.GetMovies ====
Retrieve all movies<br />
Retrieve all movies<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#[ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' fields ]
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''array'' movies ]
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "movies": {
        "items": {
          "$ref": "Video.Details.Movie"
        },
        "type": "array"
      },
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      }
    }
  },
  "params": [
    {
      "name": "properties",
      "$ref": "Video.Fields.Movie"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Retrieve all movies"
}</syntaxhighlight>}}


====VideoLibrary.GetMusicVideoDetails====
==== VideoLibrary.GetMusicVideoDetails ====
Retrieve details about a specific music video<br />
Retrieve details about a specific music video<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''[[#Library.Id|Library.Id]]'' musicvideoid
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' fields ]
# ''[[#Library.Id|Library.Id]]'' musicvideoid
'''Returns: '''<br />
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]'' musicvideodetails ]
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]'' musicvideodetails ]


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "musicvideodetails": {
        "$ref": "Video.Details.MusicVideo"
      }
    }
  },
  "params": [
    {
      "required": true,
      "name": "musicvideoid",
      "$ref": "Library.Id"
    },
    {
      "name": "properties",
      "$ref": "Video.Fields.MusicVideo"
    }
  ],
  "description": "Retrieve details about a specific music video"
}</syntaxhighlight>}}


====VideoLibrary.GetMusicVideos====
==== VideoLibrary.GetMusicVideos ====
Retrieve all music videos<br />
Retrieve all music videos<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#[ ''[[#Library.Id|Library.Id]]'' artistid = -1 ]
<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 = -1 ]
# [ ''[[#Library.Id|Library.Id]]'' artistid = -1 ]
#[ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' fields ]
# [ ''[[#Library.Id|Library.Id]]'' albumid = -1 ]
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''array'' musicvideos ]
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]''[] musicvideos ]
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "musicvideos": {
        "items": {
          "$ref": "Video.Details.MusicVideo"
        },
        "type": "array"
      },
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      }
    }
  },
  "params": [
    {
      "default": -1,
      "name": "artistid",
      "$ref": "Library.Id"
    },
    {
      "default": -1,
      "name": "albumid",
      "$ref": "Library.Id"
    },
    {
      "name": "properties",
      "$ref": "Video.Fields.MusicVideo"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Retrieve all music videos"
}</syntaxhighlight>}}


====VideoLibrary.GetRecentlyAddedEpisodes====
==== VideoLibrary.GetRecentlyAddedEpisodes ====
Retrieve all recently added tv episodes<br />
Retrieve all recently added tv episodes<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#[ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' fields ]
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''array'' episodes ]
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]''[] episodes ]
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "episodes": {
        "items": {
          "$ref": "Video.Details.Episode"
        },
        "type": "array"
      },
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      }
    }
  },
  "params": [
    {
      "name": "properties",
      "$ref": "Video.Fields.Episode"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Retrieve all recently added tv episodes"
}</syntaxhighlight>}}


====VideoLibrary.GetRecentlyAddedMovies====
==== VideoLibrary.GetRecentlyAddedMovies ====
Retrieve all recently added movies<br />
Retrieve all recently added movies<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#[ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' fields ]
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''array'' movies ]
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "movies": {
        "items": {
          "$ref": "Video.Details.Movie"
        },
        "type": "array"
      },
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      }
    }
  },
  "params": [
    {
      "name": "properties",
      "$ref": "Video.Fields.Movie"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Retrieve all recently added movies"
}</syntaxhighlight>}}


====VideoLibrary.GetRecentlyAddedMusicVideos====
==== VideoLibrary.GetRecentlyAddedMusicVideos ====
Retrieve all recently added music videos<br />
Retrieve all recently added music videos<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#[ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' fields ]
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''array'' musicvideos ]
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]''[] musicvideos ]
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "musicvideos": {
        "items": {
          "$ref": "Video.Details.MusicVideo"
        },
        "type": "array"
      },
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      }
    }
  },
  "params": [
    {
      "name": "properties",
      "$ref": "Video.Fields.MusicVideo"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Retrieve all recently added music videos"
}</syntaxhighlight>}}


====VideoLibrary.GetSeasons====
==== VideoLibrary.GetSeasons ====
Retrieve all tv seasons<br />
Retrieve all tv seasons<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''[[#Library.Id|Library.Id]]'' tvshowid
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#Video.Fields.Season|Video.Fields.Season]]'' fields ]
# ''[[#Library.Id|Library.Id]]'' tvshowid
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#Video.Fields.Season|Video.Fields.Season]]'' properties ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''array'' seasons ]
* [ ''[[#Video.Details.Season|Video.Details.Season]]''[] seasons ]
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "seasons": {
        "items": {
          "$ref": "Video.Details.Season"
        },
        "type": "array"
      },
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      }
    }
  },
  "params": [
    {
      "required": true,
      "name": "tvshowid",
      "$ref": "Library.Id"
    },
    {
      "name": "properties",
      "$ref": "Video.Fields.Season"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Retrieve all tv seasons"
}</syntaxhighlight>}}


====VideoLibrary.GetTVShowDetails====
==== VideoLibrary.GetTVShowDetails ====
Retrieve details about a specific tv show<br />
Retrieve details about a specific tv show<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#''[[#Library.Id|Library.Id]]'' tvshowid
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' fields ]
# ''[[#Library.Id|Library.Id]]'' tvshowid
'''Returns: '''<br />
# [ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''[[#Video.Details.TVShow|Video.Details.TVShow]]'' tvshowdetails ]
* [ ''[[#Video.Details.TVShow|Video.Details.TVShow]]'' tvshowdetails ]


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "tvshowdetails": {
        "$ref": "Video.Details.TVShow"
      }
    }
  },
  "params": [
    {
      "required": true,
      "name": "tvshowid",
      "$ref": "Library.Id"
    },
    {
      "name": "properties",
      "$ref": "Video.Fields.TVShow"
    }
  ],
  "description": "Retrieve details about a specific tv show"
}</syntaxhighlight>}}


====VideoLibrary.GetTVShows====
==== VideoLibrary.GetTVShows ====
Retrieve all tv shows<br />
Retrieve all tv shows<br />
'''Permission:''' ReadData<br />
'''Permissions:'''
* ReadData
'''Parameters:'''  
'''Parameters:'''  
#[ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' fields ]
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#[ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
'''Returns: '''<br />
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
*[ ''array'' tvshows ]
* [ ''[[#Video.Details.TVShow|Video.Details.TVShow]]''[] tvshows ]


</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "required": true,
        "$ref": "List.LimitsReturned"
      },
      "tvshows": {
        "items": {
          "$ref": "Video.Details.TVShow"
        },
        "type": "array"
      }
    }
  },
  "params": [
    {
      "name": "properties",
      "$ref": "Video.Fields.TVShow"
    },
    {
      "name": "limits",
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "$ref": "List.Sort"
    }
  ],
  "description": "Retrieve all tv shows"
}</syntaxhighlight>}}


====VideoLibrary.Scan====
==== VideoLibrary.Scan ====
Scans the video sources for new library items<br />
Scans the video sources for new library items<br />
'''Permission:''' UpdateData<br />
'''Permissions:'''
* UpdateData
'''Parameters:''' None
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Returns:''' ''string''
'''Type:''' ''string''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "returns": {
    "type": "string"
  },
  "params": [],
  "description": "Scans the video sources for new library items"
}</syntaxhighlight>}}


===VideoPlayer===
=== XBMC ===
====VideoPlayer.BigSkipBackward====
==== XBMC.GetInfoBooleans ====
'''Permission:''' ControlPlayback<br />
Retrieve info booleans about XBMC and the system<br />
'''Parameters:''' None
'''Permissions:'''
<br />
* ReadData
'''Returns: '''<br />
'''Parameters:'''  
'''Type:''' ''string''<br />
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Optional:''' true
# ''array''[1..X] booleans
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "description": "List of key-value pairs of the retrieved info booleans"
  },
  "params": [
    {
      "minItems": 1,
      "items": {
        "type": "string"
      },
      "required": true,
      "type": "array",
      "name": "booleans"
    }
  ],
  "description": "Retrieve info booleans about Kodi and the system"
}</syntaxhighlight>}}


====VideoPlayer.BigSkipForward====
==== XBMC.GetInfoLabels ====
'''Permission:''' ControlPlayback<br />
Retrieve info labels about XBMC and the system<br />
'''Parameters:''' None
'''Permissions:'''
<br />
* ReadData
'''Returns: '''<br />
'''Parameters:'''  
'''Type:''' ''string''<br />
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Optional:''' true
# ''array''[1..X] labels
</div>
'''Returns:'''  
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "returns": {
    "type": "object",
    "description": "List of key-value pairs of the retrieved info labels"
  },
  "params": [
    {
      "description": "See http://wiki.xbmc.org/index.php?title=InfoLabels for a list of possible info labels",
      "minItems": 1,
      "items": {
        "type": "string"
      },
      "required": true,
      "type": "array",
      "name": "labels"
    }
  ],
  "description": "Retrieve info labels about Kodi and the system"
}</syntaxhighlight>}}


====VideoPlayer.Forward====
Forward current playback<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true


====VideoPlayer.GetPercentage====
== Global types ==
Retrieve current playback progress in percentage<br />
=== Application ===
'''Permission:''' ReadData<br />
==== Application.Property.Name ====
'''Parameters:''' None
'''Type:''' ''string''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
<br />
  "default": "volume",
'''Returns: '''<br />
  "enums": [
'''Type:''' ''number''<br />
    "volume",
'''Optional:''' true
    "muted",
    "name",
    "version"
  ],
  "type": "string",
  "id": "Application.Property.Name"
}</syntaxhighlight>}}


====VideoPlayer.GetTime====
==== Application.Property.Value ====
Retrieves the current and total time of the currently playing file<br />
'''Type:''' ''object''<br />
'''Permission:''' ReadData<br />
'''Properties:'''
'''Parameters:''' None
* [ ''boolean'' muted = False ]
<br />
* [ ''integer'' volume = 0 ]
'''Returns: '''<br />
* [ ''object'' version ]<br />
'''Type:''' ''[[#Player.TimeValues|Player.TimeValues]]''<br />
'''Properties:'''
'''Optional:''' true
** ''integer'' major
** ''string'' tag
** ''integer'' minor
** [ ''mixed'' revision = null ]


====VideoPlayer.PlayPause====
* [ ''string'' name = "" ]
Pauses or unpause playback and returns the new state<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Permission:''' ControlPlayback<br />
  "type": "object",
'''Parameters:''' None
  "id": "Application.Property.Value",
<br />
  "properties": {
'''Returns: '''<br />
    "muted": {
'''Type:''' ''[[#Player.State|Player.State]]''<br />
      "default": false,
'''Optional:''' true
      "type": "boolean"
    },
    "volume": {
      "default": 0,
      "type": "integer"
    },
    "version": {
      "type": "object",
      "properties": {
        "major": {
          "minimum": 0,
          "type": "integer",
          "required": true
        },
        "tag": {
          "enums": [
            "prealpha",
            "alpha",
            "beta",
            "releasecandidate",
            "stable"
          ],
          "type": "string",
          "required": true
        },
        "minor": {
          "minimum": 0,
          "type": "integer",
          "required": true
        },
        "revision": {
          "default": null,
          "type": [
            {
              "type": "string"
            },
            {
              "minimum": 0,
              "type": "integer"
            }
          ]
        }
      }
    },
    "name": {
      "default": "",
      "minLength": 1,
      "type": "string"
    }
  }
}</syntaxhighlight>}}


====VideoPlayer.Rewind====
=== Array ===
Rewind current playback<br />
==== Array.Integer ====
'''Permission:''' ControlPlayback<br />
'''Type:''' ''array''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Parameters:''' None
  "items": {
<br />
    "type": "integer"
'''Returns: '''<br />
  },
'''Type:''' ''string''<br />
  "type": "array",
'''Optional:''' true
  "id": "Array.Integer"
}</syntaxhighlight>}}


====VideoPlayer.SeekPercentage====
==== Array.String ====
Seek to a specific percentage<br />
'''Type:''' ''array''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Permission:''' ControlPlayback<br />
  "items": {
'''Parameters:'''
    "minLength": 1,
#''[[#Player.SeekPercentage|Player.SeekPercentage]]'' value
    "type": "string"
'''Returns: '''<br />
  },
'''Type:''' ''string''<br />
  "type": "array",
'''Optional:''' true
  "id": "Array.String"
}</syntaxhighlight>}}


====VideoPlayer.SeekTime====
=== Audio ===
Seek to a specific time<br />
==== Audio.Details.Album ====
'''Permission:''' ControlPlayback<br />
'''Extends:'''
'''Parameters:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
#''[[#Player.SeekTime|Player.SeekTime]]'' value
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====VideoPlayer.SkipNext====
Skips to next item on the playlist<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Properties:'''
'''Type:''' ''string''<br />
* [ ''string'' style = "" ]
'''Optional:''' true
* [ ''string'' mood = "" ]
* [ ''string'' albumlabel = "" ]
* [ ''string'' theme = "" ]
* ''[[#Library.Id|Library.Id]]'' albumid
* [ ''[[#Library.Id|Library.Id]]'' artistid = -1 ]
* [ ''string'' type = "" ]
* [ ''string'' description = "" ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "extends": "Audio.Details.Media",
  "id": "Audio.Details.Album",
  "properties": {
    "style": {
      "default": "",
      "type": "string"
    },
    "mood": {
      "default": "",
      "type": "string"
    },
    "albumlabel": {
      "default": "",
      "type": "string"
    },
    "theme": {
      "default": "",
      "type": "string"
    },
    "albumid": {
      "required": true,
      "$ref": "Library.Id"
    },
    "artistid": {
      "default": -1,
      "$ref": "Library.Id"
    },
    "type": {
      "default": "",
      "type": "string"
    },
    "description": {
      "default": "",
      "type": "string"
    }
  }
}</syntaxhighlight>}}


====VideoPlayer.SkipPrevious====
==== Audio.Details.Artist ====
Skips to previous item on the playlist<br />
'''Extends:'''
'''Permission:''' ControlPlayback<br />
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Properties:'''
'''Type:''' ''string''<br />
* [ ''string'' style = "" ]
'''Optional:''' true
* [ ''string'' description = "" ]
* [ ''string'' musicbrainzartistid = "" ]
* ''string'' artist
* [ ''string'' formed = "" ]
* [ ''string'' disbanded = "" ]
* [ ''string'' born = "" ]
* ''[[#Library.Id|Library.Id]]'' artistid
* [ ''string'' yearsactive = "" ]
* [ ''string'' instrument = "" ]
* [ ''string'' died = "" ]
* [ ''string'' mood = "" ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "extends": "Audio.Details.Base",
  "id": "Audio.Details.Artist",
  "properties": {
    "style": {
      "default": "",
      "type": "string"
    },
    "description": {
      "default": "",
      "type": "string"
    },
    "musicbrainzartistid": {
      "default": "",
      "type": "string"
    },
    "artist": {
      "required": true,
      "type": "string"
    },
    "formed": {
      "default": "",
      "type": "string"
    },
    "disbanded": {
      "default": "",
      "type": "string"
    },
    "born": {
      "default": "",
      "type": "string"
    },
    "artistid": {
      "required": true,
      "$ref": "Library.Id"
    },
    "yearsactive": {
      "default": "",
      "type": "string"
    },
    "instrument": {
      "default": "",
      "type": "string"
    },
    "died": {
      "default": "",
      "type": "string"
    },
    "mood": {
      "default": "",
      "type": "string"
    }
  }
}</syntaxhighlight>}}


====VideoPlayer.SmallSkipBackward====
==== Audio.Details.Base ====
'''Permission:''' ControlPlayback<br />
'''Extends:'''
'''Parameters:''' None
* ''[[#Media.Details.Base|Media.Details.Base]]''
<br />
<br />
'''Returns: '''<br />
'''Properties:'''
'''Type:''' ''string''<br />
* [ ''string'' genre = "" ]
'''Optional:''' true
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "extends": "Media.Details.Base",
  "id": "Audio.Details.Base",
  "properties": {
    "genre": {
      "default": "",
      "type": "string"
    }
  }
}</syntaxhighlight>}}


====VideoPlayer.SmallSkipForward====
==== Audio.Details.Media ====
'''Permission:''' ControlPlayback<br />
'''Extends:'''
'''Parameters:''' None
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
<br />
<br />
'''Returns: '''<br />
'''Properties:'''
'''Type:''' ''string''<br />
* [ ''integer'' rating = 0 ]
'''Optional:''' true
* [ ''string'' title = "" ]
* [ ''string'' artist = "" ]
* [ ''string'' musicbrainzalbumartistid = "" ]
* [ ''integer'' year = 0 ]
* [ ''string'' musicbrainzalbumid = "" ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "extends": "Audio.Details.Base",
  "id": "Audio.Details.Media",
  "properties": {
    "rating": {
      "default": 0,
      "type": "integer"
    },
    "title": {
      "default": "",
      "type": "string"
    },
    "artist": {
      "default": "",
      "type": "string"
    },
    "musicbrainzalbumartistid": {
      "default": "",
      "type": "string"
    },
    "year": {
      "default": 0,
      "type": "integer"
    },
    "musicbrainzalbumid": {
      "default": "",
      "type": "string"
    }
  }
}</syntaxhighlight>}}


====VideoPlayer.State====
==== Audio.Details.Song ====
Returns playback state of the video player (if it is active)<br />
'''Extends:'''
'''Permission:''' ReadData<br />
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Parameters:''' None
<br />
<br />
'''Returns: '''<br />
'''Properties:'''
'''Type:''' ''[[#Player.State.Extended|Player.State.Extended]]''<br />
* [ ''string'' album = "" ]
'''Optional:''' true
* [ ''string'' comment = "" ]
* ''[[#Library.Id|Library.Id]]'' songid
* [ ''string'' musicbrainzartistid = "" ]
* [ ''string'' lyrics = "" ]
* [ ''integer'' track = 0 ]
* [ ''string'' musicbrainztrackid = "" ]
* [ ''[[#Library.Id|Library.Id]]'' albumid = -1 ]
* [ ''[[#Library.Id|Library.Id]]'' artistid = -1 ]
* [ ''string'' albumartist = "" ]
* [ ''string'' file = "" ]
* [ ''integer'' duration = 0 ]
* [ ''integer'' playcount = 0 ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "extends": "Audio.Details.Media",
  "id": "Audio.Details.Song",
  "properties": {
    "album": {
      "default": "",
      "type": "string"
    },
    "comment": {
      "default": "",
      "type": "string"
    },
    "songid": {
      "required": true,
      "$ref": "Library.Id"
    },
    "musicbrainzartistid": {
      "default": "",
      "type": "string"
    },
    "lyrics": {
      "default": "",
      "type": "string"
    },
    "track": {
      "default": 0,
      "type": "integer"
    },
    "musicbrainztrackid": {
      "default": "",
      "type": "string"
    },
    "albumid": {
      "default": -1,
      "$ref": "Library.Id"
    },
    "artistid": {
      "default": -1,
      "$ref": "Library.Id"
    },
    "albumartist": {
      "default": "",
      "type": "string"
    },
    "file": {
      "default": "",
      "type": "string"
    },
    "duration": {
      "default": 0,
      "type": "integer"
    },
    "playcount": {
      "default": 0,
      "type": "integer"
    }
  }
}</syntaxhighlight>}}


====VideoPlayer.Stop====
==== Audio.Fields.Album ====
Stops playback<br />
'''Extends:'''
'''Permission:''' ControlPlayback<br />
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
'''Parameters:''' None
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
<br />
  "items": {
'''Returns: '''<br />
    "enums": [
'''Type:''' ''string''<br />
      "title",
'''Optional:''' true
      "description",
      "artist",
      "genre",
      "theme",
      "mood",
      "style",
      "type",
      "albumlabel",
      "rating",
      "year",
      "musicbrainzalbumid",
      "musicbrainzalbumartistid",
      "fanart",
      "thumbnail",
      "artistid"
    ],
    "type": "string"
  },
  "extends": "Item.Fields.Base",
  "id": "Audio.Fields.Album"
}</syntaxhighlight>}}


===VideoPlaylist===
==== Audio.Fields.Artist ====
====VideoPlaylist.Add====
'''Extends:'''
Add item(s) to playlist<br />
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
'''Permission:''' ControlPlayback<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Parameters:'''  
  "items": {
#''[[#Playlist.Video.Item|Playlist.Video.Item]]'' item
    "enums": [
'''Returns: '''<br />
      "instrument",
'''Type:''' ''string''<br />
      "style",
'''Optional:''' true
      "mood",
      "born",
      "formed",
      "description",
      "genre",
      "died",
      "disbanded",
      "yearsactive",
      "musicbrainzartistid",
      "fanart",
      "thumbnail"
    ],
    "type": "string"
  },
  "extends": "Item.Fields.Base",
  "id": "Audio.Fields.Artist"
}</syntaxhighlight>}}


====VideoPlaylist.Clear====
==== Audio.Fields.Song ====
Clear playlist<br />
'''Extends:'''
'''Permission:''' ControlPlayback<br />
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
'''Parameters:''' None
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
<br />
  "items": {
'''Returns: '''<br />
    "enums": [
'''Type:''' ''string''<br />
      "title",
'''Optional:''' true
      "artist",
      "albumartist",
      "genre",
      "year",
      "rating",
      "album",
      "track",
      "duration",
      "comment",
      "lyrics",
      "musicbrainztrackid",
      "musicbrainzartistid",
      "musicbrainzalbumid",
      "musicbrainzalbumartistid",
      "playcount",
      "fanart",
      "thumbnail",
      "file",
      "artistid",
      "albumid"
    ],
    "type": "string"
  },
  "extends": "Item.Fields.Base",
  "id": "Audio.Fields.Song"
}</syntaxhighlight>}}


====VideoPlaylist.GetItems====
=== Configuration ===
Get all items from playlist<br />
==== Configuration ====
'''Permission:''' ReadData<br />
'''Parameters:'''
#[ ''[[#List.Fields.Video|List.Fields.Video]]'' fields ]
#[ ''[[#List.Limits|List.Limits]]'' limits ]
#[ ''[[#List.Sort|List.Sort]]'' sort ]
'''Returns: '''<br />
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''[[#List.Items.Video|List.Items.Video]]'' items
* ''[[#Configuration.Notifications|Configuration.Notifications]]'' notifications
*[ ''[[#Playlist.State|Playlist.State]]'' state ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
  "required": true,
  "type": "object",
  "id": "Configuration",
  "properties": {
    "notifications": {
      "required": true,
      "$ref": "Configuration.Notifications"
    }
  }
}</syntaxhighlight>}}


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


====VideoPlaylist.Insert====
=== Files ===
Insert item(s) into playlist<br />
==== Files.Media ====
'''Permission:''' ControlPlayback<br />
'''Type:''' ''string''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Parameters:'''
  "default": "video",
#''[[#Playlist.Item.Position|Playlist.Item.Position]]'' index
  "enums": [
#''[[#Playlist.Video.Item|Playlist.Video.Item]]'' item
    "video",
'''Returns: '''<br />
    "music",
'''Type:''' ''string''<br />
    "pictures",
'''Optional:''' true
    "files",
    "programs"
  ],
  "type": "string",
  "id": "Files.Media"
}</syntaxhighlight>}}


====VideoPlaylist.Play====
=== Global ===
Play current or a specific item<br />
==== Global.Time ====
'''Permission:''' ControlPlayback<br />
'''Parameters:'''
#[ ''[[#Playlist.Item.Position|Playlist.Item.Position]]'' item = -1 ]
'''Returns: '''<br />
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''boolean'' success
* ''integer'' hours
* ''integer'' seconds
* ''integer'' minutes
* ''integer'' milliseconds
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "additionalProperties": false,
  "type": "object",
  "id": "Global.Time",
  "properties": {
    "hours": {
      "minimum": 0,
      "type": "integer",
      "maximum": 23,
      "required": true
    },
    "seconds": {
      "minimum": 0,
      "type": "integer",
      "maximum": 59,
      "required": true
    },
    "minutes": {
      "minimum": 0,
      "type": "integer",
      "maximum": 59,
      "required": true
    },
    "milliseconds": {
      "minimum": 0,
      "type": "integer",
      "maximum": 999,
      "required": true
    }
  }
}</syntaxhighlight>}}


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


====VideoPlaylist.Remove====
==== Item.Fields.Base ====
Remove item from playlist<br />
'''Type:''' ''array''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Permission:''' ControlPlayback<br />
  "uniqueItems": true,
'''Parameters:'''
  "items": {
#''[[#Playlist.Item.Position|Playlist.Item.Position]]'' item
    "type": "string"
'''Returns: '''<br />
  },
'''Type:''' ''string''<br />
  "type": "array",
'''Optional:''' true
  "id": "Item.Fields.Base"
 
}</syntaxhighlight>}}
====VideoPlaylist.Repeat====
Set the repeat mode of the playlist<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:'''
#''[[#Playlist.Repeat|Playlist.Repeat]]'' state
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true


====VideoPlaylist.Shuffle====
=== Library ===
Shuffle playlist<br />
==== Library.Details.Genre ====
'''Permission:''' ControlPlayback<br />
'''Extends:'''
'''Parameters:''' None
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
<br />
'''Returns: '''<br />
'''Properties:'''
'''Type:''' ''string''<br />
* ''[[#Library.Id|Library.Id]]'' genreid
'''Optional:''' true
* [ ''string'' thumbnail = "" ]
* [ ''string'' title = "" ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "extends": "Item.Details.Base",
  "id": "Library.Details.Genre",
  "properties": {
    "genreid": {
      "required": true,
      "$ref": "Library.Id"
    },
    "thumbnail": {
      "default": "",
      "type": "string"
    },
    "title": {
      "default": "",
      "type": "string"
    }
  }
}</syntaxhighlight>}}


====VideoPlaylist.SkipNext====
==== Library.Fields.Genre ====
Skip current item and play next item<br />
'''Extends:'''
'''Permission:''' ControlPlayback<br />
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
'''Parameters:''' None
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
<br />
  "items": {
'''Returns: '''<br />
    "enums": [
'''Type:''' ''string''<br />
      "title",
'''Optional:''' true
      "thumbnail"
    ],
    "type": "string"
  },
  "extends": "Item.Fields.Base",
  "id": "Library.Fields.Genre"
}</syntaxhighlight>}}


====VideoPlaylist.SkipPrevious====
==== Library.Id ====
Skip current item and play previous item<br />
'''Type:''' ''integer''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Permission:''' ControlPlayback<br />
  "default": -1,
'''Parameters:''' None
  "minimum": 1,
<br />
  "type": "integer",
'''Returns: '''<br />
  "id": "Library.Id"
'''Type:''' ''string''<br />
}</syntaxhighlight>}}
'''Optional:''' true


====VideoPlaylist.State====
=== List ===
Provides information about the current state of the playlist<br />
==== List.Amount ====
'''Permission:''' ReadData<br />
'''Type:''' ''integer''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Parameters:''' None
  "default": -1,
<br />
  "minimum": 0,
'''Returns: '''<br />
  "type": "integer",
'''Type:''' ''[[#Playlist.State|Playlist.State]]''<br />
  "id": "List.Amount"
'''Optional:''' true
}</syntaxhighlight>}}


====VideoPlaylist.Swap====
==== List.Fields.All ====
Swap items in the playlist<br />
'''Extends:'''
'''Permission:''' ControlPlayback<br />
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
'''Parameters:'''  
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
#''[[#Playlist.Item.Position|Playlist.Item.Position]]'' item1
  "items": {
#''[[#Playlist.Item.Position|Playlist.Item.Position]]'' item2
    "enums": [
'''Returns: '''<br />
      "title",
'''Type:''' ''string''<br />
      "artist",
'''Optional:''' true
      "albumartist",
      "genre",
      "year",
      "rating",
      "album",
      "track",
      "duration",
      "comment",
      "lyrics",
      "musicbrainztrackid",
      "musicbrainzartistid",
      "musicbrainzalbumid",
      "musicbrainzalbumartistid",
      "playcount",
      "fanart",
      "director",
      "trailer",
      "tagline",
      "plot",
      "plotoutline",
      "originaltitle",
      "lastplayed",
      "writer",
      "studio",
      "mpaa",
      "cast",
      "country",
      "imdbnumber",
      "premiered",
      "productioncode",
      "runtime",
      "set",
      "showlink",
      "streamdetails",
      "top250",
      "votes",
      "firstaired",
      "season",
      "episode",
      "showtitle",
      "thumbnail",
      "file",
      "resume",
      "artistid",
      "albumid",
      "tvshowid",
      "setid"
    ],
    "type": "string"
  },
  "extends": "Item.Fields.Base",
  "id": "List.Fields.All"
}</syntaxhighlight>}}


====VideoPlaylist.UnShuffle====
==== List.Item.All ====
Unshuffle playlist<br />
'''Extends:'''
'''Permission:''' ControlPlayback<br />
* ''[[#Video.Details.File|Video.Details.File]]''
'''Parameters:''' None
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
<br />
<br />
'''Returns: '''<br />
'''Properties:'''
'''Type:''' ''string''<br />
* [ ''string'' comment = "" ]
'''Optional:''' true
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ]
* [ ''[[#Array.String|Array.String]]'' set ]
* [ ''string'' lyrics = "" ]
* [ ''string'' albumartist = "" ]
* [ ''integer'' duration = 0 ]
* [ ''[[#Array.Integer|Array.Integer]]'' setid ]
* [ ''[[#Library.Id|Library.Id]]'' id = -1 ]
* [ ''string'' album = "" ]
* [ ''string'' votes = "" ]
* [ ''string'' mpaa = "" ]
* [ ''string'' writer = "" ]
* [ ''[[#Library.Id|Library.Id]]'' albumid = -1 ]
* [ ''string'' type = "unknown" ]
* [ ''string'' plotoutline = "" ]
* [ ''integer'' track = 0 ]
* [ ''integer'' season = 0 ]
* [ ''string'' musicbrainztrackid = "" ]
* [ ''string'' imdbnumber = "" ]
* [ ''string'' studio = "" ]
* [ ''string'' showlink = "" ]
* [ ''string'' showtitle = "" ]
* [ ''integer'' episode = 0 ]
* [ ''string'' musicbrainzartistid = "" ]
* [ ''string'' productioncode = "" ]
* [ ''string'' country = "" ]
* [ ''string'' premiered = "" ]
* [ ''string'' originaltitle = "" ]
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''[[#Library.Id|Library.Id]]'' artistid = -1 ]
* [ ''string'' firstaired = "" ]
* [ ''string'' tagline = "" ]
* [ ''integer'' top250 = 0 ]
* [ ''string'' trailer = "" ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "extends": [
    "Video.Details.File",
    "Audio.Details.Media"
  ],
  "id": "List.Item.All",
  "properties": {
    "comment": {
      "default": "",
      "type": "string"
    },
    "tvshowid": {
      "default": -1,
      "$ref": "Library.Id"
    },
    "set": {
      "$ref": "Array.String"
    },
    "lyrics": {
      "default": "",
      "type": "string"
    },
    "albumartist": {
      "default": "",
      "type": "string"
    },
    "duration": {
      "default": 0,
      "type": "integer"
    },
    "setid": {
      "$ref": "Array.Integer"
    },
    "id": {
      "default": -1,
      "$ref": "Library.Id"
    },
    "album": {
      "default": "",
      "type": "string"
    },
    "votes": {
      "default": "",
      "type": "string"
    },
    "mpaa": {
      "default": "",
      "type": "string"
    },
    "writer": {
      "default": "",
      "type": "string"
    },
    "albumid": {
      "default": -1,
      "$ref": "Library.Id"
    },
    "type": {
      "default": "unknown",
      "enums": [
        "unknown",
        "movie",
        "episode",
        "musicvideo",
        "song",
        "picture"
      ],
      "type": "string"
    },
    "plotoutline": {
      "default": "",
      "type": "string"
    },
    "track": {
      "default": 0,
      "type": "integer"
    },
    "season": {
      "default": 0,
      "type": "integer"
    },
    "musicbrainztrackid": {
      "default": "",
      "type": "string"
    },
    "imdbnumber": {
      "default": "",
      "type": "string"
    },
    "studio": {
      "default": "",
      "type": "string"
    },
    "showlink": {
      "default": "",
      "type": "string"
    },
    "showtitle": {
      "default": "",
      "type": "string"
    },
    "episode": {
      "default": 0,
      "type": "integer"
    },
    "musicbrainzartistid": {
      "default": "",
      "type": "string"
    },
    "productioncode": {
      "default": "",
      "type": "string"
    },
    "country": {
      "default": "",
      "type": "string"
    },
    "premiered": {
      "default": "",
      "type": "string"
    },
    "originaltitle": {
      "default": "",
      "type": "string"
    },
    "cast": {
      "$ref": "Video.Cast"
    },
    "artistid": {
      "default": -1,
      "$ref": "Library.Id"
    },
    "firstaired": {
      "default": "",
      "type": "string"
    },
    "tagline": {
      "default": "",
      "type": "string"
    },
    "top250": {
      "default": 0,
      "type": "integer"
    },
    "trailer": {
      "default": "",
      "type": "string"
    }
  }
}</syntaxhighlight>}}


===XBMC===
==== List.Item.File ====
====XBMC.GetInfoBooleans====
'''Extends:'''
Retrieve info booleans about XBMC and the system<br />
* ''[[#List.Item.All|List.Item.All]]''
'''Permission:''' ReadData<br />
<br />
'''Parameters:'''  
'''Properties:'''
#''array'' booleans
* ''string'' filetype
'''Returns: '''<br />
* ''string'' file
'''Type:''' ''object''<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Optional:''' true
  "extends": "List.Item.All",
  "id": "List.Item.File",
  "properties": {
    "filetype": {
      "enums": [
        "file",
        "directory"
      ],
      "type": "string",
      "required": true
    },
    "file": {
      "required": true,
      "type": "string"
    }
  }
}</syntaxhighlight>}}


====XBMC.GetInfoLabels====
==== List.Items.Sources ====
Retrieve info labels about XBMC and the system<br />
'''Type:''' ''array''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
'''Permission:''' ReadData<br />
  "items": {
'''Parameters:'''
    "extends": "Item.Details.Base",
#''array'' labels
    "properties": {
'''Returns: '''<br />
      "file": {
'''Type:''' ''object''<br />
        "required": true,
'''Optional:''' true
        "type": "string"
      }
    }
  },
  "type": "array",
  "id": "List.Items.Sources"
}</syntaxhighlight>}}


====XBMC.Play====
==== List.Limits ====
Starts playback of the given file<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:'''
#''string'' file
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
====XBMC.StartSlideshow====
Starts slideshow with the images from the given directory<br />
'''Permission:''' ControlPlayback<br />
'''Parameters:'''
#''string'' directory
#[ ''boolean'' random = True ]
#[ ''boolean'' recursive = True ]
'''Returns: '''<br />
'''Type:''' ''string''<br />
'''Optional:''' true
 
 
==Global types==
===Application===
====Application.Property.Name====
'''Type:''' ''string''<br />
'''Optional:''' true<br />
'''Default:''' "volume"
====Application.Property.Value====
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''boolean'' muted = False ]
* [ ''integer'' start = 0 ]
*[ ''integer'' volume = 0 ]
* [ ''integer'' end = -1 ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "additionalProperties": false,
  "type": "object",
  "id": "List.Limits",
  "properties": {
    "start": {
      "default": 0,
      "minimum": 0,
      "type": "integer"
    },
    "end": {
      "default": -1,
      "minimum": 0,
      "type": "integer"
    }
  }
}</syntaxhighlight>}}


===Array===
==== List.LimitsReturned ====
====Array.Integer====
'''Type:''' ''array''<br />
'''Optional:''' true
====Array.String====
'''Type:''' ''array''<br />
'''Optional:''' true
===Audio===
====Audio.Details.Album====
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''integer'' rating = 0 ]
* [ ''integer'' start = 0 ]
*[ ''string'' style = "" ]
* ''integer'' total
*[ ''string'' theme = "" ]
* [ ''integer'' end = -1 ]
*[ ''string'' description = "" ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*[ ''string'' artist = "" ]
  "additionalProperties": false,
*[ ''string'' fanart = "" ]
  "type": "object",
*[ ''string'' albumlabel = "" ]
  "id": "List.LimitsReturned",
*[ ''string'' thumbnail = "" ]
  "properties": {
*[ ''string'' musicbrainzalbumartistid = "" ]
    "start": {
*''string'' label
      "default": 0,
*''[[#Library.Id|Library.Id]]'' albumid
      "minimum": 0,
*[ ''[[#Library.Id|Library.Id]]'' artistid = -1 ]
      "type": "integer"
*[ ''integer'' year = 0 ]
    },
*[ ''string'' genre = "" ]
    "total": {
*[ ''string'' title = "" ]
      "minimum": 0,
*[ ''string'' type = "" ]
      "type": "integer",
*[ ''string'' musicbrainzalbumid = "" ]
      "required": true
*[ ''string'' mood = "" ]
    },
    "end": {
      "default": -1,
      "minimum": 0,
      "type": "integer"
    }
  }
}</syntaxhighlight>}}


====Audio.Details.Artist====
==== List.Sort ====
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''string'' style = "" ]
* [ ''string'' order = "ascending" ]
*[ ''string'' description = "" ]
* [ ''boolean'' ignorearticle = False ]
*[ ''string'' musicbrainzartistid = "" ]
* [ ''string'' method = "none" ]
*''string'' artist
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*[ ''string'' fanart = "" ]
  "type": "object",
*[ ''string'' formed = "" ]
  "id": "List.Sort",
*[ ''string'' disbanded = "" ]
  "properties": {
*[ ''string'' born = "" ]
    "order": {
*''[[#Library.Id|Library.Id]]'' artistid
      "default": "ascending",
*[ ''string'' yearsactive = "" ]
      "enums": [
*[ ''string'' instrument = "" ]
        "ascending",
*[ ''string'' genre = "" ]
        "descending"
*''string'' label
      ],
*[ ''string'' thumbnail = "" ]
      "type": "string"
*[ ''string'' died = "" ]
    },
*[ ''string'' mood = "" ]
    "ignorearticle": {
      "default": false,
      "type": "boolean"
    },
    "method": {
      "default": "none",
      "enums": [
        "none",
        "label",
        "date",
        "size",
        "file",
        "drivetype",
        "track",
        "duration",
        "title",
        "artist",
        "album",
        "genre",
        "year",
        "videorating",
        "programcount",
        "playlist",
        "episode",
        "videotitle",
        "sorttitle",
        "productioncode",
        "songrating",
        "mpaarating",
        "videoruntime",
        "studio",
        "fullpath",
        "lastplayed",
        "unsorted",
        "max"
      ],
      "type": "string"
    }
  }
}</syntaxhighlight>}}


====Audio.Details.Song====
=== Media ===
'''Type:''' ''object''<br />
==== Media.Details.Base ====
'''Optional:''' true<br />
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
'''Properties:'''
*[ ''string'' comment = "" ]
* [ ''string'' fanart = "" ]
*[ ''integer'' rating = 0 ]
* [ ''string'' thumbnail = "" ]
*[ ''string'' lyrics = "" ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*[ ''string'' albumartist = "" ]
  "extends": "Item.Details.Base",
*[ ''string'' file = "" ]
  "id": "Media.Details.Base",
*[ ''integer'' year = 0 ]
  "properties": {
*[ ''integer'' duration = 0 ]
    "fanart": {
*[ ''string'' musicbrainzalbumid = "" ]
      "default": "",
*[ ''string'' album = "" ]
      "type": "string"
*[ ''string'' title = "" ]
    },
*[ ''string'' fanart = "" ]
    "thumbnail": {
*[ ''[[#Library.Id|Library.Id]]'' artistid = -1 ]
      "default": "",
*''string'' label
      "type": "string"
*[ ''[[#Library.Id|Library.Id]]'' albumid = -1 ]
    }
*[ ''string'' thumbnail = "" ]
  }
*''[[#Library.Id|Library.Id]]'' songid
}</syntaxhighlight>}}
*[ ''integer'' track = 0 ]
*[ ''string'' musicbrainztrackid = "" ]
*[ ''string'' genre = "" ]
*[ ''string'' musicbrainzartistid = "" ]
*[ ''string'' artist = "" ]
*[ ''string'' musicbrainzalbumartistid = "" ]
*[ ''integer'' playcount = 0 ]


====Audio.Fields.Album====
=== Optional ===
'''Type:''' ''array''<br />
==== Optional.Boolean ====
'''Optional:''' true
'''Type:''' ''mixed''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
====Audio.Fields.Artist====
  "default": null,
'''Type:''' ''array''<br />
  "type": [
'''Optional:''' true
    {
====Audio.Fields.Song====
      "type": "null"
'''Type:''' ''array''<br />
    },
'''Optional:''' true
    {
===Configuration===
      "type": "boolean"
====Configuration====
    }
  ],
  "id": "Optional.Boolean"
}</syntaxhighlight>}}
 
=== Player ===
==== Player.Audio.Stream ====
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' false<br />
'''Properties:'''
'''Properties:'''
*''[[#Configuration.Notifications|Configuration.Notifications]]'' notifications
* ''integer'' index
* ''string'' name
* ''string'' language
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "type": "object",
  "id": "Player.Audio.Stream",
  "properties": {
    "index": {
      "minimum": 0,
      "type": "integer",
      "required": true
    },
    "name": {
      "required": true,
      "type": "string"
    },
    "language": {
      "required": true,
      "type": "string"
    }
  }
}</syntaxhighlight>}}


====Configuration.Notifications====
==== Player.Audio.Stream.Extended ====
'''Type:''' ''object''<br />
'''Extends:'''
'''Optional:''' true<br />
* ''[[#Player.Audio.Stream|Player.Audio.Stream]]''
<br />
'''Properties:'''
'''Properties:'''
*''boolean'' gui
* ''integer'' channels
*''boolean'' system
* ''string'' codec
*''boolean'' player
* ''integer'' bitrate
*''boolean'' audiolibrary
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*''boolean'' other
  "extends": "Player.Audio.Stream",
*''boolean'' videolibrary
  "id": "Player.Audio.Stream.Extended",
  "properties": {
    "channels": {
      "required": true,
      "type": "integer"
    },
    "codec": {
      "required": true,
      "type": "string"
    },
    "bitrate": {
      "required": true,
      "type": "integer"
    }
  }
}</syntaxhighlight>}}
 
==== Player.Id ====
'''Type:''' ''integer''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "default": -1,
  "minimum": 0,
  "type": "integer",
  "id": "Player.Id",
  "maximum": 2
}</syntaxhighlight>}}


===Files===
==== Player.Notifications.Data ====
====Files.Media====
'''Type:''' ''string''<br />
'''Optional:''' true<br />
'''Default:''' "video"
===Global===
====Global.Time====
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''integer'' hours
* ''[[#Player.Notifications.Item|Player.Notifications.Item]]'' item
*''integer'' seconds
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
*''integer'' minutes
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*''integer'' milliseconds
  "type": "object",
  "id": "Player.Notifications.Data",
  "properties": {
    "item": {
      "required": true,
      "$ref": "Player.Notifications.Item"
    },
    "player": {
      "required": true,
      "$ref": "Player.Notifications.Player"
    }
  }
}</syntaxhighlight>}}


===Library===
==== Player.Notifications.Item ====
====Library.Details.Genre====
'''Type:''' ''mixed''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "type": [
    {
      "type": "object",
      "description": "An unknown item does not have any additional information.",
      "properties": {
        "type": {
          "required": true,
          "$ref": "Player.Notifications.Item.Type"
        }
      }
    },
    {
      "type": "object",
      "description": "An item known to the database has an identification.",
      "properties": {
        "type": {
          "required": true,
          "$ref": "Player.Notifications.Item.Type"
        },
        "id": {
          "required": true,
          "$ref": "Library.Id"
        }
      }
    },
    {
      "type": "object",
      "description": "A movie item has a title and may have a release year.",
      "properties": {
        "year": {
          "default": 0,
          "type": "integer"
        },
        "type": {
          "required": true,
          "$ref": "Player.Notifications.Item.Type"
        },
        "title": {
          "required": true,
          "type": "string"
        }
      }
    },
    {
      "type": "object",
      "description": "A tv episode has a title and may have an episode number, season number and the title of the show it belongs to.",
      "properties": {
        "season": {
          "default": 0,
          "type": "integer"
        },
        "type": {
          "required": true,
          "$ref": "Player.Notifications.Item.Type"
        },
        "episode": {
          "default": 0,
          "type": "integer"
        },
        "showtitle": {
          "default": "",
          "type": "string"
        },
        "title": {
          "required": true,
          "type": "string"
        }
      }
    },
    {
      "type": "object",
      "description": "A music video has a title and may have an album and an artist.",
      "properties": {
        "album": {
          "default": "",
          "type": "string"
        },
        "title": {
          "required": true,
          "type": "string"
        },
        "type": {
          "required": true,
          "$ref": "Player.Notifications.Item.Type"
        },
        "artist": {
          "default": "",
          "type": "string"
        }
      }
    },
    {
      "type": "object",
      "description": "A song has a title and may have an album, an artist and a track number.",
      "properties": {
        "album": {
          "default": "",
          "type": "string"
        },
        "track": {
          "default": 0,
          "type": "integer"
        },
        "title": {
          "required": true,
          "type": "string"
        },
        "type": {
          "required": true,
          "$ref": "Player.Notifications.Item.Type"
        },
        "artist": {
          "default": "",
          "type": "string"
        }
      }
    }
  ],
  "id": "Player.Notifications.Item"
}</syntaxhighlight>}}
 
==== Player.Notifications.Item.Type ====
'''Type:''' ''string''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "default": "unknown",
  "enums": [
    "unknown",
    "movie",
    "episode",
    "musicvideo",
    "song"
  ],
  "type": "string",
  "id": "Player.Notifications.Item.Type"
}</syntaxhighlight>}}
 
==== Player.Notifications.Player ====
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''[[#Library.Id|Library.Id]]'' genreid
* ''[[#Player.Id|Player.Id]]'' playerid
*[ ''string'' title = "" ]
* [ ''integer'' speed = 0 ]
*[ ''string'' thumbnail = "" ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*''string'' label
  "type": "object",
  "id": "Player.Notifications.Player",
  "properties": {
    "playerid": {
      "required": true,
      "$ref": "Player.Id"
    },
    "speed": {
      "default": 0,
      "type": "integer"
    }
  }
}</syntaxhighlight>}}


====Library.Fields.Genre====
==== Player.Notifications.Player.Seek ====
'''Type:''' ''array''<br />
'''Extends:'''
'''Optional:''' true
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]''
====Library.Id====
<br />
'''Type:''' ''integer''<br />
'''Optional:''' true<br />
'''Default:''' -1
===List===
====List.Amount====
'''Type:''' ''integer''<br />
'''Optional:''' true<br />
'''Default:''' -1
====List.Fields.All====
'''Type:''' ''array''<br />
'''Optional:''' true
====List.Fields.Video====
'''Type:''' ''array''<br />
'''Optional:''' true
====List.Items.All====
'''Type:''' ''array''<br />
'''Optional:''' true
====List.Items.Audio====
'''Type:''' ''array''<br />
'''Optional:''' true
====List.Items.Files====
'''Type:''' ''array''<br />
'''Optional:''' true
====List.Items.Shares====
'''Type:''' ''array''<br />
'''Optional:''' true
====List.Items.Video====
'''Type:''' ''array''<br />
'''Optional:''' true
====List.Limits====
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''integer'' start = 0 ]
* [ ''[[#Global.Time|Global.Time]]'' seekoffset ]
*[ ''integer'' end = -1 ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "extends": "Player.Notifications.Player",
  "id": "Player.Notifications.Player.Seek",
  "properties": {
    "seekoffset": {
      "$ref": "Global.Time"
    },
    "time": {
      "$ref": "Global.Time"
    }
  }
}</syntaxhighlight>}}
 
==== Player.Position.Percentage ====
'''Type:''' ''number''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "default": 0,
  "minimum": 0,
  "type": "number",
  "id": "Player.Position.Percentage",
  "maximum": 100
}</syntaxhighlight>}}
 
==== Player.Property.Name ====
'''Type:''' ''string''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "default": "type",
  "enums": [
    "type",
    "partymode",
    "speed",
    "time",
    "percentage",
    "totaltime",
    "playlistid",
    "position",
    "repeat",
    "shuffled",
    "canseek",
    "canchangespeed",
    "canmove",
    "canzoom",
    "canrotate",
    "canshuffle",
    "canrepeat",
    "currentaudiostream",
    "audiostreams",
    "subtitleenabled",
    "currentsubtitle",
    "subtitles"
  ],
  "type": "string",
  "id": "Player.Property.Name"
}</syntaxhighlight>}}


====List.LimitsReturned====
==== Player.Property.Value ====
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''integer'' start
* [ ''boolean'' canrotate = False ]
*''integer'' total
* [ ''boolean'' canrepeat = False ]
*''integer'' end
* [ ''integer'' speed = 0 ]
* [ ''boolean'' canshuffle = False ]
* [ ''boolean'' shuffled = False ]
* [ ''boolean'' canmove = False ]
* [ ''boolean'' subtitleenabled = False ]
* [ ''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage = 0 ]
* [ ''[[#Player.Type|Player.Type]]'' type = "video" ]
* [ ''[[#Player.Repeat|Player.Repeat]]'' repeat = "off" ]
* [ ''boolean'' canseek = False ]
* [ ''[[#Player.Subtitle|Player.Subtitle]]'' currentsubtitle ]
* [ ''[[#Player.Subtitle|Player.Subtitle]]''[] subtitles ]
* [ ''[[#Global.Time|Global.Time]]'' totaltime ]
* [ ''boolean'' canzoom = False ]
* [ ''[[#Player.Audio.Stream.Extended|Player.Audio.Stream.Extended]]'' currentaudiostream ]
* [ ''[[#Playlist.Id|Playlist.Id]]'' playlistid = -1 ]
* [ ''[[#Player.Audio.Stream.Extended|Player.Audio.Stream.Extended]]''[] audiostreams ]
* [ ''boolean'' partymode = False ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
* [ ''[[#Playlist.Position|Playlist.Position]]'' position = -1 ]
* [ ''boolean'' canchangespeed = False ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "type": "object",
  "id": "Player.Property.Value",
  "properties": {
    "canrotate": {
      "default": false,
      "type": "boolean"
    },
    "canrepeat": {
      "default": false,
      "type": "boolean"
    },
    "speed": {
      "default": 0,
      "type": "integer"
    },
    "canshuffle": {
      "default": false,
      "type": "boolean"
    },
    "shuffled": {
      "default": false,
      "type": "boolean"
    },
    "canmove": {
      "default": false,
      "type": "boolean"
    },
    "subtitleenabled": {
      "default": false,
      "type": "boolean"
    },
    "percentage": {
      "default": 0,
      "$ref": "Player.Position.Percentage"
    },
    "type": {
      "default": "video",
      "$ref": "Player.Type"
    },
    "repeat": {
      "default": "off",
      "$ref": "Player.Repeat"
    },
    "canseek": {
      "default": false,
      "type": "boolean"
    },
    "currentsubtitle": {
      "$ref": "Player.Subtitle"
    },
    "subtitles": {
      "items": {
        "$ref": "Player.Subtitle"
      },
      "type": "array"
    },
    "totaltime": {
      "$ref": "Global.Time"
    },
    "canzoom": {
      "default": false,
      "type": "boolean"
    },
    "currentaudiostream": {
      "$ref": "Player.Audio.Stream.Extended"
    },
    "playlistid": {
      "default": -1,
      "$ref": "Playlist.Id"
    },
    "audiostreams": {
      "items": {
        "$ref": "Player.Audio.Stream.Extended"
      },
      "type": "array"
    },
    "partymode": {
      "default": false,
      "type": "boolean"
    },
    "time": {
      "$ref": "Global.Time"
    },
    "position": {
      "default": -1,
      "$ref": "Playlist.Position"
    },
    "canchangespeed": {
      "default": false,
      "type": "boolean"
    }
  }
}</syntaxhighlight>}}


====List.Sort====
==== Player.Repeat ====
'''Type:''' ''string''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "default": "off",
  "enums": [
    "off",
    "one",
    "all"
  ],
  "type": "string",
  "id": "Player.Repeat"
}</syntaxhighlight>}}
 
==== Player.Speed ====
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''string'' order = "ascending" ]
* [ ''integer'' speed = 0 ]
*[ ''boolean'' ignorearticle = False ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*[ ''string'' method = "none" ]
  "required": true,
  "type": "object",
  "id": "Player.Speed",
  "properties": {
    "speed": {
      "default": 0,
      "type": "integer"
    }
  }
}</syntaxhighlight>}}


===Optional===
==== Player.Subtitle ====
====Optional.Boolean====
'''Type:''' ''['null', 'boolean']''<br />
'''Optional:''' true<br />
'''Default:''' null
===Player===
====Player.SeekPercentage====
'''Type:''' ''number''<br />
'''Optional:''' true<br />
'''Default:''' 0
====Player.SeekTime====
'''Type:''' ''integer''<br />
'''Optional:''' true<br />
'''Default:''' 0
====Player.State====
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''boolean'' paused
* ''integer'' index
*''boolean'' playing
* ''string'' name
* ''string'' language
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "type": "object",
  "id": "Player.Subtitle",
  "properties": {
    "index": {
      "minimum": 0,
      "type": "integer",
      "required": true
    },
    "name": {
      "required": true,
      "type": "string"
    },
    "language": {
      "required": true,
      "type": "string"
    }
  }
}</syntaxhighlight>}}
 
==== Player.Type ====
'''Type:''' ''string''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "default": "video",
  "enums": [
    "video",
    "audio",
    "picture"
  ],
  "type": "string",
  "id": "Player.Type"
}</syntaxhighlight>}}


====Player.State.Extended====
=== Playlist ===
==== Playlist.Id ====
'''Type:''' ''integer''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "default": -1,
  "minimum": 0,
  "type": "integer",
  "id": "Playlist.Id",
  "maximum": 2
}</syntaxhighlight>}}
 
==== Playlist.Item ====
'''Type:''' ''mixed''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "type": [
    {
      "additionalProperties": false,
      "type": "object",
      "properties": {
        "file": {
          "required": true,
          "type": "string",
          "description": "Path to a file (not a directory) to be added to the playlist"
        }
      }
    },
    {
      "additionalProperties": false,
      "type": "object",
      "properties": {
        "directory": {
          "required": true,
          "type": "string"
        }
      }
    },
    {
      "additionalProperties": false,
      "type": "object",
      "properties": {
        "movieid": {
          "required": true,
          "$ref": "Library.Id"
        }
      }
    },
    {
      "additionalProperties": false,
      "type": "object",
      "properties": {
        "episodeid": {
          "required": true,
          "$ref": "Library.Id"
        }
      }
    },
    {
      "additionalProperties": false,
      "type": "object",
      "properties": {
        "musicvideoid": {
          "required": true,
          "$ref": "Library.Id"
        }
      }
    },
    {
      "additionalProperties": false,
      "type": "object",
      "properties": {
        "artistid": {
          "required": true,
          "$ref": "Library.Id"
        }
      }
    },
    {
      "additionalProperties": false,
      "type": "object",
      "properties": {
        "albumid": {
          "required": true,
          "$ref": "Library.Id"
        }
      }
    },
    {
      "additionalProperties": false,
      "type": "object",
      "properties": {
        "songid": {
          "required": true,
          "$ref": "Library.Id"
        }
      }
    },
    {
      "additionalProperties": false,
      "type": "object",
      "properties": {
        "genreid": {
          "required": true,
          "description": "Identification of a genre from the AudioLibrary",
          "$ref": "Library.Id"
        }
      }
    }
  ],
  "id": "Playlist.Item"
}</syntaxhighlight>}}
 
==== Playlist.Position ====
'''Type:''' ''integer''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "default": -1,
  "minimum": 0,
  "type": "integer",
  "id": "Playlist.Position"
}</syntaxhighlight>}}
 
==== Playlist.Property.Name ====
'''Type:''' ''string''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "default": "type",
  "enums": [
    "type",
    "size"
  ],
  "type": "string",
  "id": "Playlist.Property.Name"
}</syntaxhighlight>}}
 
==== Playlist.Property.Value ====
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''boolean'' paused
* [ ''[[#Playlist.Type|Playlist.Type]]'' type = "unknown" ]
*''boolean'' partymode
* [ ''integer'' size = 0 ]
*''boolean'' playing
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "type": "object",
  "id": "Playlist.Property.Value",
  "properties": {
    "type": {
      "default": "unknown",
      "$ref": "Playlist.Type"
    },
    "size": {
      "default": 0,
      "minimum": 0,
      "type": "integer"
    }
  }
}</syntaxhighlight>}}


====Player.TimeValues====
==== Playlist.Type ====
'''Type:''' ''string''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "default": "unknown",
  "enums": [
    "unknown",
    "video",
    "audio",
    "picture",
    "mixed"
  ],
  "type": "string",
  "id": "Playlist.Type"
}</syntaxhighlight>}}
 
=== System ===
==== System.Property.Name ====
'''Type:''' ''string''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "default": "canshutdown",
  "enums": [
    "canshutdown",
    "cansuspend",
    "canhibernate",
    "canreboot"
  ],
  "type": "string",
  "id": "System.Property.Name"
}</syntaxhighlight>}}
 
==== System.Property.Value ====
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''boolean'' paused
* [ ''boolean'' canreboot = False ]
*''[[#Global.Time|Global.Time]]'' total
* [ ''boolean'' cansuspend = False ]
*''boolean'' playing
* [ ''boolean'' canhibernate = False ]
*''[[#Global.Time|Global.Time]]'' time
* [ ''boolean'' canshutdown = False ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "type": "object",
  "id": "System.Property.Value",
  "properties": {
    "canreboot": {
      "default": false,
      "type": "boolean"
    },
    "cansuspend": {
      "default": false,
      "type": "boolean"
    },
    "canhibernate": {
      "default": false,
      "type": "boolean"
    },
    "canshutdown": {
      "default": false,
      "type": "boolean"
    }
  }
}</syntaxhighlight>}}
 
=== Video ===
==== Video.Cast ====
'''Type:''' ''array''{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "items": {
    "additionalProperties": false,
    "type": "object",
    "properties": {
      "role": {
        "required": true,
        "type": "string"
      },
      "name": {
        "required": true,
        "type": "string"
      },
      "thumbnail": {
        "default": "",
        "type": "string"
      }
    }
  },
  "type": "array",
  "id": "Video.Cast"
}</syntaxhighlight>}}


===Playlist===
==== Video.Details.Base ====
====Playlist.Audio.Item====
'''Extends:'''
'''Type:''' ''object''<br />
* ''[[#Media.Details.Base|Media.Details.Base]]''
'''Optional:''' true<br />
<br />
'''Properties:'''
'''Properties:'''
*[ ''[[#Playlist.Id|Playlist.Id]]'' playlist ]
* [ ''integer'' playcount = 0 ]
*[ ''[[#Library.Id|Library.Id]]'' songid = -1 ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*[ ''[[#Library.Id|Library.Id]]'' albumid = -1 ]
  "extends": "Media.Details.Base",
*[ ''[[#Library.Id|Library.Id]]'' artistid = -1 ]
  "id": "Video.Details.Base",
*[ ''string'' file = "" ]
  "properties": {
*[ ''string'' directory = "" ]
    "playcount": {
*[ ''[[#Library.Id|Library.Id]]'' genreid = -1 ]
      "default": 0,
      "type": "integer"
    }
  }
}</syntaxhighlight>}}


====Playlist.Id====
==== Video.Details.Episode ====
'''Type:''' ''object''<br />
'''Extends:'''
'''Optional:''' true<br />
* ''[[#Video.Details.File|Video.Details.File]]''
<br />
'''Properties:'''
'''Properties:'''
*[ ''string'' id = "" ]
* [ ''number'' rating = 0 ]
*[ ''string'' file = "" ]
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ]
* [ ''string'' votes = "" ]
* [ ''integer'' episode = 0 ]
* [ ''string'' productioncode = "" ]
* [ ''integer'' season = 0 ]
* [ ''string'' writer = "" ]
* ''[[#Library.Id|Library.Id]]'' episodeid
* [ ''string'' originaltitle = "" ]
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''string'' firstaired = "" ]
* [ ''string'' showtitle = "" ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "extends": "Video.Details.File",
  "id": "Video.Details.Episode",
  "properties": {
    "rating": {
      "default": 0,
      "type": "number"
    },
    "tvshowid": {
      "default": -1,
      "$ref": "Library.Id"
    },
    "votes": {
      "default": "",
      "type": "string"
    },
    "episode": {
      "default": 0,
      "type": "integer"
    },
    "productioncode": {
      "default": "",
      "type": "string"
    },
    "season": {
      "default": 0,
      "type": "integer"
    },
    "writer": {
      "default": "",
      "type": "string"
    },
    "episodeid": {
      "required": true,
      "$ref": "Library.Id"
    },
    "originaltitle": {
      "default": "",
      "type": "string"
    },
    "cast": {
      "$ref": "Video.Cast"
    },
    "firstaired": {
      "default": "",
      "type": "string"
    },
    "showtitle": {
      "default": "",
      "type": "string"
    }
  }
}</syntaxhighlight>}}


====Playlist.Item.Position====
==== Video.Details.File ====
'''Type:''' ''integer''<br />
'''Extends:'''
'''Optional:''' true<br />
* ''[[#Video.Details.Item|Video.Details.Item]]''
'''Default:''' -1
<br />
====Playlist.Repeat====
'''Type:''' ''string''<br />
'''Optional:''' true<br />
'''Default:''' "off"
====Playlist.State====
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*''integer'' current
* [ ''string'' director = "" ]
*''boolean'' paused
* [ ''[[#Video.Streams|Video.Streams]]'' streamdetails ]
*''[[#Playlist.Repeat|Playlist.Repeat]]'' repeat
* [ ''string'' runtime = "" ]
*''boolean'' playing
* [ ''[[#Video.Resume|Video.Resume]]'' resume ]
*''boolean'' shuffled
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "extends": "Video.Details.Item",
  "id": "Video.Details.File",
  "properties": {
    "director": {
      "default": "",
      "type": "string"
    },
    "streamdetails": {
      "$ref": "Video.Streams"
    },
    "runtime": {
      "default": "",
      "type": "string"
    },
    "resume": {
      "$ref": "Video.Resume"
    }
  }
}</syntaxhighlight>}}


====Playlist.Video.Item====
==== Video.Details.Item ====
'''Type:''' ''object''<br />
'''Extends:'''
'''Optional:''' true<br />
* ''[[#Video.Details.Media|Video.Details.Media]]''
<br />
'''Properties:'''
'''Properties:'''
*[ ''[[#Playlist.Id|Playlist.Id]]'' playlist ]
* [ ''string'' plot = "" ]
*[ ''[[#Library.Id|Library.Id]]'' movieid = -1 ]
* [ ''string'' lastplayed = "" ]
*[ ''[[#Library.Id|Library.Id]]'' episodeid = -1 ]
* [ ''string'' file = "" ]
*[ ''string'' file = "" ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*[ ''string'' directory = "" ]
  "extends": "Video.Details.Media",
*[ ''[[#Library.Id|Library.Id]]'' musicvideoid = -1 ]
  "id": "Video.Details.Item",
  "properties": {
    "plot": {
      "default": "",
      "type": "string"
    },
    "lastplayed": {
      "default": "",
      "type": "string"
    },
    "file": {
      "default": "",
      "type": "string"
    }
  }
}</syntaxhighlight>}}


===System===
==== Video.Details.Media ====
====System.Property.Name====
'''Extends:'''
'''Type:''' ''string''<br />
* ''[[#Video.Details.Base|Video.Details.Base]]''
'''Optional:''' true<br />
<br />
'''Default:''' "canshutdown"
====System.Property.Value====
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''boolean'' canreboot = False ]
* [ ''string'' title = "" ]
*[ ''boolean'' cansuspend = False ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*[ ''boolean'' canhibernate = False ]
  "extends": "Video.Details.Base",
*[ ''boolean'' canshutdown = False ]
  "id": "Video.Details.Media",
  "properties": {
    "title": {
      "default": "",
      "type": "string"
    }
  }
}</syntaxhighlight>}}


===Video===
==== Video.Details.Movie ====
====Video.Cast====
'''Extends:'''
'''Type:''' ''array''<br />
* ''[[#Video.Details.File|Video.Details.File]]''
'''Optional:''' true
<br />
====Video.Details.Episode====
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''number'' rating = 0 ]
* [ ''number'' rating = 0 ]
*[ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ]
* [ ''[[#Array.String|Array.String]]'' set ]
*[ ''string'' file = "" ]
* [ ''integer'' year = 0 ]
*[ ''string'' plot = "" ]
* [ ''[[#Array.Integer|Array.Integer]]'' setid ]
*[ ''string'' votes = "" ]
* [ ''string'' votes = "" ]
*[ ''string'' title = "" ]
* [ ''string'' tagline = "" ]
*[ ''string'' fanart = "" ]
* [ ''string'' writer = "" ]
*[ ''string'' writer = "" ]
* [ ''string'' plotoutline = "" ]
*''string'' label
* [ ''string'' sorttitle = "" ]
*[ ''string'' thumbnail = "" ]
* [ ''string'' imdbnumber = "" ]
*[ ''[[#Video.Streams|Video.Streams]]'' streamdetails ]
* [ ''string'' studio = "" ]
*[ ''[[#Video.Resume|Video.Resume]]'' resume ]
* [ ''string'' showlink = "" ]
*[ ''integer'' season = 0 ]
* [ ''string'' genre = "" ]
*[ ''string'' director = "" ]
* ''[[#Library.Id|Library.Id]]'' movieid
*[ ''string'' showtitle = "" ]
* [ ''string'' productioncode = "" ]
*[ ''integer'' episode = 0 ]
* [ ''string'' country = "" ]
*[ ''string'' productioncode = "" ]
* [ ''string'' premiered = "" ]
*[ ''string'' lastplayed = "" ]
* [ ''string'' originaltitle = "" ]
*''[[#Library.Id|Library.Id]]'' episodeid
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
*[ ''string'' originaltitle = "" ]
* [ ''string'' mpaa = "" ]
*[ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''integer'' top250 = 0 ]
*[ ''string'' firstaired = "" ]
* [ ''string'' trailer = "" ]
*[ ''integer'' playcount = 0 ]
* [ ''array''  streamdetails = "" ]
*[ ''string'' runtime = "" ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "extends": "Video.Details.File",
  "id": "Video.Details.Movie",
  "properties": {
    "rating": {
      "default": 0,
      "type": "number"
    },
    "set": {
      "$ref": "Array.String"
    },
    "year": {
      "default": 0,
      "type": "integer"
    },
    "setid": {
      "$ref": "Array.Integer"
    },
    "votes": {
      "default": "",
      "type": "string"
    },
    "tagline": {
      "default": "",
      "type": "string"
    },
    "writer": {
      "default": "",
      "type": "string"
    },
    "plotoutline": {
      "default": "",
      "type": "string"
    },
    "sorttitle": {
      "default": "",
      "type": "string"
    },
    "imdbnumber": {
      "default": "",
      "type": "string"
    },
    "studio": {
      "default": "",
      "type": "string"
    },
    "showlink": {
      "default": "",
      "type": "string"
    },
    "genre": {
      "default": "",
      "type": "string"
    },
    "movieid": {
      "required": true,
      "$ref": "Library.Id"
    },
    "productioncode": {
      "default": "",
      "type": "string"
    },
    "country": {
      "default": "",
      "type": "string"
    },
    "premiered": {
      "default": "",
      "type": "string"
    },
    "originaltitle": {
      "default": "",
      "type": "string"
    },
    "cast": {
      "$ref": "Video.Cast"
    },
    "mpaa": {
      "default": "",
      "type": "string"
    },
    "top250": {
      "default": 0,
      "type": "integer"
    },
    "trailer": {
      "default": "",
      "type": "string"
    }
  }
}</syntaxhighlight>}}


====Video.Details.Movie====
==== Video.Details.MovieSet ====
'''Type:''' ''object''<br />
'''Extends:'''
'''Optional:''' true<br />
* ''[[#Video.Details.Media|Video.Details.Media]]''
<br />
'''Properties:'''
'''Properties:'''
*[ ''number'' rating = 0 ]
* ''[[#Library.Id|Library.Id]]'' setid
*[ ''[[#Array.String|Array.String]]'' set ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*[ ''string'' tagline = "" ]
  "extends": "Video.Details.Media",
*[ ''string'' file = "" ]
  "id": "Video.Details.MovieSet",
*[ ''integer'' year = 0 ]
  "properties": {
*[ ''[[#Array.Integer|Array.Integer]]'' setid ]
    "setid": {
*[ ''string'' plot = "" ]
      "required": true,
*[ ''string'' votes = "" ]
      "$ref": "Library.Id"
*[ ''string'' title = "" ]
    }
*[ ''string'' fanart = "" ]
  }
*[ ''string'' mpaa = "" ]
}</syntaxhighlight>}}
*[ ''string'' writer = "" ]
*''string'' label
*[ ''string'' thumbnail = "" ]
*[ ''[[#Video.Streams|Video.Streams]]'' streamdetails ]
*[ ''string'' plotoutline = "" ]
*[ ''[[#Video.Resume|Video.Resume]]'' resume ]
*[ ''string'' director = "" ]
*[ ''string'' imdbnumber = "" ]
*[ ''string'' studio = "" ]
*[ ''string'' showlink = "" ]
*[ ''string'' genre = "" ]
*''[[#Library.Id|Library.Id]]'' movieid
*[ ''string'' productioncode = "" ]
*[ ''string'' country = "" ]
*[ ''string'' lastplayed = "" ]
*[ ''string'' premiered = "" ]
*[ ''string'' originaltitle = "" ]
*[ ''[[#Video.Cast|Video.Cast]]'' cast ]
*[ ''string'' sorttitle = "" ]
*[ ''integer'' playcount = 0 ]
*[ ''string'' runtime = "" ]
*[ ''integer'' top250 = 0 ]
*[ ''string'' trailer = "" ]


====Video.Details.MovieSet====
==== Video.Details.MovieSet.Extended ====
'''Type:''' ''object''<br />
'''Extends:'''
'''Optional:''' true<br />
* ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''
<br />
'''Properties:'''
'''Properties:'''
*[ ''string'' title = "" ]
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]
*[ ''string'' fanart = "" ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*''string'' label
  "extends": "Video.Details.MovieSet",
*[ ''integer'' playcount = 0 ]
  "id": "Video.Details.MovieSet.Extended",
*[ ''string'' thumbnail = "" ]
  "properties": {
*''[[#Library.Id|Library.Id]]'' setid
    "movies": {
      "items": {
        "$ref": "Video.Details.Movie"
      },
      "type": "array"
    }
  }
}</syntaxhighlight>}}


====Video.Details.MovieSet.Extended====
==== Video.Details.MusicVideo ====
'''Type:''' ''object''<br />
'''Extends:'''
'''Optional:''' true<br />
* ''[[#Video.Details.File|Video.Details.File]]''
<br />
'''Properties:'''
'''Properties:'''
*[ ''string'' title = "" ]
* [ ''string'' album = "" ]
*[ ''string'' fanart = "" ]
* [ ''string'' artist = "" ]
*''string'' label
* [ ''integer'' track = 0 ]
*[ ''array'' movies ]
* [ ''string'' studio = "" ]
*[ ''integer'' playcount = 0 ]
* [ ''integer'' year = 0 ]
*[ ''string'' thumbnail = "" ]
* [ ''string'' genre = "" ]
*''[[#Library.Id|Library.Id]]'' setid
* ''[[#Library.Id|Library.Id]]'' musicvideoid
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "extends": "Video.Details.File",
  "id": "Video.Details.MusicVideo",
  "properties": {
    "album": {
      "default": "",
      "type": "string"
    },
    "artist": {
      "default": "",
      "type": "string"
    },
    "track": {
      "default": 0,
      "type": "integer"
    },
    "studio": {
      "default": "",
      "type": "string"
    },
    "year": {
      "default": 0,
      "type": "integer"
    },
    "genre": {
      "default": "",
      "type": "string"
    },
    "musicvideoid": {
      "required": true,
      "$ref": "Library.Id"
    }
  }
}</syntaxhighlight>}}


====Video.Details.MusicVideo====
==== Video.Details.Season ====
'''Type:''' ''object''<br />
'''Extends:'''
'''Optional:''' true<br />
* ''[[#Video.Details.Base|Video.Details.Base]]''
<br />
'''Properties:'''
'''Properties:'''
*[ ''string'' album = "" ]
* ''integer'' season
*[ ''string'' plot = "" ]
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ]
*[ ''string'' artist = "" ]
* [ ''integer'' episode = 0 ]
*[ ''string'' fanart = "" ]
* [ ''string'' showtitle = "" ]
*[ ''string'' lastplayed = "" ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*[ ''integer'' year = 0 ]
  "extends": "Video.Details.Base",
*[ ''[[#Video.Resume|Video.Resume]]'' resume ]
  "id": "Video.Details.Season",
*''string'' label
  "properties": {
*[ ''string'' director = "" ]
    "season": {
*[ ''string'' thumbnail = "" ]
      "required": true,
*[ ''string'' studio = "" ]
      "type": "integer"
*[ ''string'' file = "" ]
    },
*[ ''integer'' track = 0 ]
    "tvshowid": {
*[ ''string'' genre = "" ]
      "default": -1,
*[ ''string'' title = "" ]
      "$ref": "Library.Id"
*[ ''integer'' playcount = 0 ]
    },
*[ ''string'' runtime = "" ]
    "episode": {
*''[[#Library.Id|Library.Id]]'' musicvideoid
      "default": 0,
*[ ''[[#Video.Streams|Video.Streams]]'' streamdetails ]
      "type": "integer"
    },
    "showtitle": {
      "default": "",
      "type": "string"
    }
  }
}</syntaxhighlight>}}


====Video.Details.Season====
==== Video.Details.TVShow ====
'''Type:''' ''object''<br />
'''Extends:'''
'''Optional:''' true<br />
* ''[[#Video.Details.Item|Video.Details.Item]]''
<br />
'''Properties:'''
'''Properties:'''
*[ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ]
* [ ''string'' episodeguide = "" ]
*[ ''integer'' episode = 0 ]
* ''[[#Library.Id|Library.Id]]'' tvshowid
*[ ''string'' fanart = "" ]
* [ ''integer'' episode = 0 ]
*''integer'' season
* [ ''string'' imdbnumber = "" ]
*''string'' label
* [ ''number'' rating = 0 ]
*[ ''integer'' playcount = 0 ]
* [ ''string'' mpaa = "" ]
*[ ''string'' thumbnail = "" ]
* [ ''integer'' year = 0 ]
*[ ''string'' showtitle = "" ]
* [ ''string'' votes = "" ]
* [ ''string'' premiered = "" ]
* [ ''string'' originaltitle = "" ]
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''string'' studio = "" ]
* [ ''string'' sorttitle = "" ]
* [ ''string'' genre = "" ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "extends": "Video.Details.Item",
  "id": "Video.Details.TVShow",
  "properties": {
    "episodeguide": {
      "default": "",
      "type": "string"
    },
    "tvshowid": {
      "required": true,
      "$ref": "Library.Id"
    },
    "episode": {
      "default": 0,
      "type": "integer"
    },
    "imdbnumber": {
      "default": "",
      "type": "string"
    },
    "rating": {
      "default": 0,
      "type": "number"
    },
    "mpaa": {
      "default": "",
      "type": "string"
    },
    "year": {
      "default": 0,
      "type": "integer"
    },
    "votes": {
      "default": "",
      "type": "string"
    },
    "premiered": {
      "default": "",
      "type": "string"
    },
    "originaltitle": {
      "default": "",
      "type": "string"
    },
    "cast": {
      "$ref": "Video.Cast"
    },
    "studio": {
      "default": "",
      "type": "string"
    },
    "sorttitle": {
      "default": "",
      "type": "string"
    },
    "genre": {
      "default": "",
      "type": "string"
    }
  }
}</syntaxhighlight>}}


====Video.Details.TVShow====
==== Video.Fields.Episode ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "items": {
    "enums": [
      "title",
      "plot",
      "votes",
      "rating",
      "writer",
      "firstaired",
      "playcount",
      "runtime",
      "director",
      "productioncode",
      "season",
      "episode",
      "originaltitle",
      "showtitle",
      "cast",
      "streamdetails",
      "lastplayed",
      "fanart",
      "thumbnail",
      "file",
      "resume",
      "tvshowid"
    ],
    "type": "string",
    "description": "Requesting the cast and/or resume field will result in increased response times"
  },
  "extends": "Item.Fields.Base",
  "id": "Video.Fields.Episode"
}</syntaxhighlight>}}
 
==== Video.Fields.Movie ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "items": {
    "enums": [
      "title",
      "genre",
      "year",
      "rating",
      "director",
      "trailer",
      "tagline",
      "plot",
      "plotoutline",
      "originaltitle",
      "lastplayed",
      "playcount",
      "writer",
      "studio",
      "mpaa",
      "cast",
      "country",
      "imdbnumber",
      "premiered",
      "productioncode",
      "runtime",
      "set",
      "showlink",
      "streamdetails",
      "top250",
      "votes",
      "fanart",
      "thumbnail",
      "file",
      "sorttitle",
      "resume",
      "setid"
    ],
    "type": "string",
    "description": "Requesting the cast, set, showling and/or resume field will result in increased response times"
  },
  "extends": "Item.Fields.Base",
  "id": "Video.Fields.Movie"
}</syntaxhighlight>}}
 
==== Video.Fields.MovieSet ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "items": {
    "enums": [
      "title",
      "playcount",
      "fanart",
      "thumbnail"
    ],
    "type": "string"
  },
  "extends": "Item.Fields.Base",
  "id": "Video.Fields.MovieSet"
}</syntaxhighlight>}}
 
==== Video.Fields.MusicVideo ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "items": {
    "enums": [
      "title",
      "playcount",
      "runtime",
      "director",
      "studio",
      "year",
      "plot",
      "album",
      "artist",
      "genre",
      "track",
      "streamdetails",
      "lastplayed",
      "fanart",
      "thumbnail",
      "file",
      "resume"
    ],
    "type": "string",
    "description": "Requesting the resume field will result in increased response times"
  },
  "extends": "Item.Fields.Base",
  "id": "Video.Fields.MusicVideo"
}</syntaxhighlight>}}
 
==== Video.Fields.Season ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "items": {
    "enums": [
      "season",
      "showtitle",
      "playcount",
      "episode",
      "fanart",
      "thumbnail",
      "tvshowid"
    ],
    "type": "string"
  },
  "extends": "Item.Fields.Base",
  "id": "Video.Fields.Season"
}</syntaxhighlight>}}
 
==== Video.Fields.TVShow ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "items": {
    "enums": [
      "title",
      "genre",
      "year",
      "rating",
      "plot",
      "studio",
      "mpaa",
      "cast",
      "playcount",
      "episode",
      "imdbnumber",
      "premiered",
      "votes",
      "lastplayed",
      "fanart",
      "thumbnail",
      "file",
      "originaltitle",
      "sorttitle",
      "episodeguide"
    ],
    "type": "string",
    "description": "Requesting the cast field will result in increased response times"
  },
  "extends": "Item.Fields.Base",
  "id": "Video.Fields.TVShow"
}</syntaxhighlight>}}
 
==== Video.Resume ====
'''Type:''' ''object''<br />
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
'''Properties:'''
*[ ''string'' episodeguide = "" ]
* [ ''number'' position = 0 ]
*''[[#Library.Id|Library.Id]]'' tvshowid
* [ ''number'' total = 0 ]
*[ ''number'' rating = 0 ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*[ ''string'' file = "" ]
  "additionalProperties": false,
*[ ''integer'' year = 0 ]
  "type": "object",
*[ ''string'' plot = "" ]
  "id": "Video.Resume",
*[ ''string'' votes = "" ]
  "properties": {
*[ ''string'' title = "" ]
    "position": {
*[ ''string'' fanart = "" ]
      "default": 0,
*[ ''string'' mpaa = "" ]
      "minimum": 0,
*''string'' label
      "type": "number"
*[ ''string'' thumbnail = "" ]
    },
*[ ''string'' imdbnumber = "" ]
    "total": {
*[ ''string'' studio = "" ]
      "default": 0,
*[ ''string'' genre = "" ]
      "minimum": 0,
*[ ''integer'' episode = 0 ]
      "type": "number"
*[ ''string'' lastplayed = "" ]
    }
*[ ''string'' premiered = "" ]
  }
*[ ''string'' originaltitle = "" ]
}</syntaxhighlight>}}
*[ ''[[#Video.Cast|Video.Cast]]'' cast ]
*[ ''string'' sorttitle = "" ]
*[ ''integer'' playcount = 0 ]


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


====Video.Streams====
'''Type:''' ''object''<br />
'''Optional:''' true<br />
'''Properties:'''
*[ ''array'' video ]
*[ ''array'' audio ]
*[ ''array'' subtitle ]


==Notifications==
== Notifications ==
===AudioLibrary===
=== AudioLibrary ===
====AudioLibrary.OnRemove====
==== AudioLibrary.OnRemove ====
An audio item has been removed.<br />
An audio item has been removed.<br />
'''Parameters:'''  
'''Parameters:'''  
#''string'' sender
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''object'' data<br />
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
'''Properties:'''
*''[[#Notifications.Library.Audio.Type|Notifications.Library.Audio.Type]]'' type
* ''[[#Notifications.Library.Audio.Type|Notifications.Library.Audio.Type]]'' type
*''[[#Library.Id|Library.Id]]'' id
* ''[[#Library.Id|Library.Id]]'' id
'''Returns: '''null
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "params": [
    {
      "required": true,
      "type": "string",
      "name": "sender"
    },
    {
      "required": true,
      "type": "object",
      "name": "data",
      "properties": {
        "type": {
          "required": true,
          "$ref": "Notifications.Library.Audio.Type"
        },
        "id": {
          "required": true,
          "$ref": "Library.Id"
        }
      }
    }
  ],
  "description": "An audio item has been removed."
}</syntaxhighlight>}}


====AudioLibrary.OnUpdate====
==== AudioLibrary.OnUpdate ====
An audio item has been updated.<br />
An audio item has been updated.<br />
'''Parameters:'''  
'''Parameters:'''  
#''string'' sender
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''object'' data<br />
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
'''Properties:'''
*''string'' type
* ''string'' type
*''[[#Library.Id|Library.Id]]'' id
* ''[[#Library.Id|Library.Id]]'' id
'''Returns: '''null


===Player===
</div>
====Player.OnPause====
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "params": [
    {
      "required": true,
      "type": "string",
      "name": "sender"
    },
    {
      "required": true,
      "type": "object",
      "name": "data",
      "properties": {
        "type": {
          "enum": [
            "song"
          ],
          "type": "string",
          "id": "Notifications.Library.Audio.Type",
          "required": true
        },
        "id": {
          "required": true,
          "$ref": "Library.Id"
        }
      }
    }
  ],
  "description": "An audio item has been updated."
}</syntaxhighlight>}}
 
=== Player ===
==== Player.OnPause ====
Playback of a media item has been paused. If there is no ID available extra information will be provided.<br />
Playback of a media item has been paused. If there is no ID available extra information will be provided.<br />
'''Parameters:'''  
'''Parameters:'''  
#''string'' sender
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''object'' data<br />
# ''string'' sender
'''Properties:'''
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
*[ ''string'' album ]
</div>
*[ ''integer'' episode ]
 
*[ ''string'' artist ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*[ ''integer'' track ]
  "params": [
*[ ''integer'' season ]
    {
*[ ''string'' title ]
      "required": true,
*[ ''integer'' year ]
      "type": "string",
*''[[#Notifications.Player.Type|Notifications.Player.Type]]'' type
      "name": "sender"
*[ ''[[#Library.Id|Library.Id]]'' id ]
    },
*[ ''string'' showtitle ]
    {
'''Returns: '''null
      "required": true,
      "name": "data",
      "$ref": "Player.Notifications.Data"
    }
  ],
  "description": "Playback of a media item has been paused. If there is no ID available extra information will be provided."
}</syntaxhighlight>}}


====Player.OnPlay====
==== Player.OnPlay ====
Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.<br />
Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''  
'''Parameters:'''  
#''string'' sender
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''object'' data<br />
# ''string'' sender
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "params": [
    {
      "required": true,
      "type": "string",
      "name": "sender"
    },
    {
      "required": true,
      "name": "data",
      "$ref": "Player.Notifications.Data"
    }
  ],
  "description": "Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided."
}</syntaxhighlight>}}
 
==== Player.OnSeek ====
The playback position has been changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
'''Properties:'''
*[ ''string'' album ]
* [ ''[[#Player.Notifications.Item|Player.Notifications.Item]]'' item ]
*[ ''integer'' episode ]
* ''[[#Player.Notifications.Player.Seek|Player.Notifications.Player.Seek]]'' player
*[ ''string'' artist ]
 
*[ ''integer'' track ]
</div>
*[ ''integer'' season ]
 
*[ ''string'' title ]
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
*[ ''integer'' year ]
  "params": [
*''string'' type
    {
*''integer'' speed
      "required": true,
*[ ''[[#Library.Id|Library.Id]]'' id ]
      "type": "string",
*[ ''string'' showtitle ]
      "name": "sender"
'''Returns: '''null
    },
    {
      "required": true,
      "type": "object",
      "name": "data",
      "properties": {
        "item": {
          "$ref": "Player.Notifications.Item"
        },
        "player": {
          "required": true,
          "$ref": "Player.Notifications.Player.Seek"
        }
      }
    }
  ],
  "description": "The playback position has been changed. If there is no ID available extra information will be provided."
}</syntaxhighlight>}}


====Player.OnSeek====
==== Player.OnSpeedChanged ====
The playback position has been changed.<br />
Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''  
'''Parameters:'''  
#''string'' sender
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''object'' data<br />
# ''string'' sender
'''Properties:'''
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
*''integer'' seekoffset
</div>
*''integer'' time
 
'''Returns: '''null
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "params": [
    {
      "required": true,
      "type": "string",
      "name": "sender"
    },
    {
      "required": true,
      "name": "data",
      "$ref": "Player.Notifications.Data"
    }
  ],
  "description": "Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided."
}</syntaxhighlight>}}


====Player.OnStop====
==== Player.OnStop ====
Playback of a media item has been stopped. If there is no ID available extra information will be provided.<br />
Playback of a media item has been stopped. If there is no ID available extra information will be provided.<br />
'''Parameters:'''  
'''Parameters:'''  
#''string'' sender
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''object'' data<br />
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
'''Properties:'''
*[ ''string'' album ]
* [ ''[[#Player.Notifications.Item|Player.Notifications.Item]]'' item ]
*[ ''integer'' episode ]
*[ ''string'' artist ]
*[ ''integer'' track ]
*[ ''integer'' season ]
*[ ''string'' title ]
*[ ''integer'' year ]
*[ ''[[#Notifications.Player.Type|Notifications.Player.Type]]'' type ]
*[ ''[[#Library.Id|Library.Id]]'' id ]
*[ ''string'' showtitle ]
'''Returns: '''null


===System===
</div>
====System.OnLowBattery====
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "params": [
    {
      "required": true,
      "type": "string",
      "name": "sender"
    },
    {
      "required": true,
      "type": "object",
      "name": "data",
      "properties": {
        "item": {
          "$ref": "Player.Notifications.Item"
        }
      }
    }
  ],
  "description": "Playback of a media item has been stopped. If there is no ID available extra information will be provided."
}</syntaxhighlight>}}
 
=== System ===
==== System.OnLowBattery ====
The system is on low battery.<br />
The system is on low battery.<br />
'''Parameters:'''  
'''Parameters:'''  
#''string'' sender
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''null'' data
# ''string'' sender
'''Returns: '''null
# ''null'' data
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "params": [
    {
      "required": true,
      "type": "string",
      "name": "sender"
    },
    {
      "required": true,
      "type": "null",
      "name": "data"
    }
  ],
  "description": "The system is on low battery."
}</syntaxhighlight>}}


====System.OnQuit====
==== System.OnQuit ====
XBMC will be closed.<br />
XBMC will be closed.<br />
'''Parameters:'''  
'''Parameters:'''  
#''string'' sender
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''null'' data
# ''string'' sender
'''Returns: '''null
# ''null'' data
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "params": [
    {
      "required": true,
      "type": "string",
      "name": "sender"
    },
    {
      "required": true,
      "type": "null",
      "name": "data"
    }
  ],
  "description": "XBMC will be closed."
}</syntaxhighlight>}}


====System.OnRestart====
==== System.OnRestart ====
The system will be restarted.<br />
The system will be restarted.<br />
'''Parameters:'''  
'''Parameters:'''  
#''string'' sender
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''null'' data
# ''string'' sender
'''Returns: '''null
# ''null'' data
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "params": [
    {
      "required": true,
      "type": "string",
      "name": "sender"
    },
    {
      "required": true,
      "type": "null",
      "name": "data"
    }
  ],
  "description": "The system will be restarted."
}</syntaxhighlight>}}


====System.OnSleep====
==== System.OnSleep ====
The system will be suspended.<br />
The system will be suspended.<br />
'''Parameters:'''  
'''Parameters:'''  
#''string'' sender
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''null'' data
# ''string'' sender
'''Returns: '''null
# ''null'' data
</div>


====System.OnWake====
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "params": [
    {
      "required": true,
      "type": "string",
      "name": "sender"
    },
    {
      "required": true,
      "type": "null",
      "name": "data"
    }
  ],
  "description": "The system will be suspended."
}</syntaxhighlight>}}
 
==== System.OnWake ====
The system woke up from suspension.<br />
The system woke up from suspension.<br />
'''Parameters:'''  
'''Parameters:'''  
#''string'' sender
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''null'' data
# ''string'' sender
'''Returns: '''null
# ''null'' data
</div>


===VideoLibrary===
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
====VideoLibrary.OnRemove====
  "params": [
    {
      "required": true,
      "type": "string",
      "name": "sender"
    },
    {
      "required": true,
      "type": "null",
      "name": "data"
    }
  ],
  "description": "The system woke up from suspension."
}</syntaxhighlight>}}
 
=== VideoLibrary ===
==== VideoLibrary.OnRemove ====
A video item has been removed.<br />
A video item has been removed.<br />
'''Parameters:'''  
'''Parameters:'''  
#''string'' sender
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''object'' data<br />
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
'''Properties:'''
*''[[#Notifications.Library.Video.Type|Notifications.Library.Video.Type]]'' type
* ''[[#Notifications.Library.Video.Type|Notifications.Library.Video.Type]]'' type
*''[[#Library.Id|Library.Id]]'' id
* ''[[#Library.Id|Library.Id]]'' id
'''Returns: '''null
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "params": [
    {
      "required": true,
      "type": "string",
      "name": "sender"
    },
    {
      "required": true,
      "type": "object",
      "name": "data",
      "properties": {
        "type": {
          "required": true,
          "$ref": "Notifications.Library.Video.Type"
        },
        "id": {
          "required": true,
          "$ref": "Library.Id"
        }
      }
    }
  ],
  "description": "A video item has been removed."
}</syntaxhighlight>}}


====VideoLibrary.OnUpdate====
==== VideoLibrary.OnUpdate ====
A video item has been updated.<br />
A video item has been updated.<br />
'''Parameters:'''  
'''Parameters:'''  
#''string'' sender
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
#''object'' data<br />
# ''string'' sender
# ''object'' data<br />
'''Properties:'''
'''Properties:'''
*[ ''integer'' playcount = -1 ]
* [ ''integer'' playcount = -1 ]
*''string'' type
* ''string'' type
*''[[#Library.Id|Library.Id]]'' id
* ''[[#Library.Id|Library.Id]]'' id
'''Returns: '''null
 
</div>
 
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "params": [
    {
      "required": true,
      "type": "string",
      "name": "sender"
    },
    {
      "required": true,
      "type": "object",
      "name": "data",
      "properties": {
        "playcount": {
          "default": -1,
          "minimum": 0,
          "type": "integer"
        },
        "type": {
          "enum": [
            "movie",
            "tvshow",
            "episode",
            "musicvideo"
          ],
          "type": "string",
          "id": "Notifications.Library.Video.Type",
          "required": true
        },
        "id": {
          "required": true,
          "$ref": "Library.Id"
        }
      }
    }
  ],
  "description": "A video item has been updated."
}</syntaxhighlight>}}
 


==See also==
== External links ==
*[[JSON-RPC API]]
* [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]
*[[JSON-RPC API/v2|JSON-RPC API v2 (Dharma)]]
* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]


==External links==
[[Category:JSON-RPC]]
*[http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]
*[http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]

Latest revision as of 23:33, 27 August 2020

Version 4 is a stable version of XBMC's JSON-RPC API and is published with the release of Eden. It is a complete re-write and re-structuring of version 2 and therefore isn't backwards compatible to it. The main reason for this was the need to make this version fully compatible with all the functionality, features and requirements of the JSON-RPC 2.0 specification. This was a main concern during early development to make it easier for third party developers and applications to interact with XBMC's JSON-RPC API by using existing JSON-RPC libraries.

An rough and incomplete list of changes compared to version 2 can be found here. A more complete and detailed list can be found in the forum.

JSON-RPC 2.0 compatibility

Version Method calls Notifications
(server-side)
Notifications
(client-side)
Parameters
by-name
Parameters
by-position
Batch requests
Version 4 Yes Yes Yes Yes Yes Yes

Documentation (JSON Schema)

Starting with JSON-RPC API version 3 a new way of API documentation has been introduced. All methods and data types are described using JSON Schema. This provides third party developers with an always complete and up-to-date documentation by calling JSONRPC.Introspect even during periods of heavy development. Furthermore the same method and data type specification that can be used by third party developers as a documentation is used by XBMC to check and verify method parameters and their values on every JSON-RPC request and allows to provide detailed error messages in case of a bad or missing parameter.

Supported features of JSON Schema

Schema IETF Draft 03
type Yes
properties Yes
patternProperties No
additionalProperties Yes
items Yes
additionalItems Yes
required Yes
dependencies No
minimum Yes
maximum Yes
Schema IETF Draft 03
exclusiveMinimum Yes
exclusiveMaximum Yes
minItems Yes
maxItems Yes
uniqueItems Yes
pattern No
minLength Yes
maxLength Yes
enum Yes
default Yes
Schema IETF Draft 03
title No
description Yes
format No
divisibleBy Yes
disallow No
extends Yes
id Yes
$ref Yes
$schema No
Hyper Schema No

Error message

If XBMC detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is

{
  "type": "object",
  "properties": {
    "code": { "type": "integer", "required": true },
    "message": { "type": "string", "required": true },
    "data": { "type": "object",
      "properties": {
        "method": { "type": "string", "required": true },
        "stack": { "type": "object", "id": "Error.Stack",
          "properties": {
            "name": { "type": "string", "required": true },
            "type": { "type": "string", "required": true },
            "message": { "type": "string", "required": true },
            "property": { "$ref": "Error.Stack" }
          }
        }
      }
    }
  }
}

Namespaces

The XBMC JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:

JSONRPC          A variety of standard JSONRPC calls
Player           Manages all available players
Playlist         Playlist modification
Files            Shares information
AudioLibrary     Audio Library information
VideoLibrary     Video Library information
Input            Allows limited navigation within XBMC
Application      Application information and control
System           System controls and information
XBMC             Dumping ground for very Kodi specific operations

Methods

Application

Application.GetProperties

Retrieves the values of the given properties
Permissions:

  • ReadData

Parameters:

  1. Application.Property.Name[] properties

Returns: Application.Property.Value

Application.Quit

Quit application
Permissions:

  • ControlPower

Parameters: None
Returns: string

Application.SetMute

Toggle mute/unmute
Permissions:

  • ControlPlayback

Parameters:

  1. mixed mute

Returns: boolean

Application.SetVolume

Set the current volume
Permissions:

  • ControlPlayback

Parameters:

  1. integer volume

Returns: integer

AudioLibrary

AudioLibrary.Clean

Cleans the audio library from non-existent items
Permissions:

  • RemoveData

Parameters: None
Returns: string

AudioLibrary.Export

Exports all items from the audio library
Permissions:

  • WriteFile

Parameters:

  1. [ mixed options ]

Returns: string

AudioLibrary.GetAlbumDetails

Retrieve details about a specific album
Permissions:

  • ReadData

Parameters:

  1. Library.Id albumid
  2. [ Audio.Fields.Album properties ]

Returns:

Type: object
Properties:

AudioLibrary.GetAlbums

Retrieve all albums from specified artist or genre
Permissions:

  • ReadData

Parameters:

  1. [ Library.Id artistid = -1 ]
  2. [ Library.Id genreid = -1 ]
  3. [ Audio.Fields.Album properties ]
  4. [ List.Limits limits ]
  5. [ List.Sort sort ]

Returns:

Type: object
Properties:

AudioLibrary.GetArtistDetails

Retrieve details about a specific artist
Permissions:

  • ReadData

Parameters:

  1. Library.Id artistid
  2. [ Audio.Fields.Artist properties ]

Returns:

Type: object
Properties:

AudioLibrary.GetArtists

Retrieve all artists
Permissions:

  • ReadData

Parameters:

  1. [ Optional.Boolean albumartistsonly = null ]
  2. [ Library.Id genreid = -1 ]
  3. [ Audio.Fields.Artist properties ]
  4. [ List.Limits limits ]
  5. [ List.Sort sort ]

Returns:

Type: object
Properties:

AudioLibrary.GetGenres

Retrieve all genres
Permissions:

  • ReadData

Parameters:

  1. [ Library.Fields.Genre properties ]
  2. [ List.Limits limits ]
  3. [ List.Sort sort ]

Returns:

Type: object
Properties:

AudioLibrary.GetRecentlyAddedAlbums

Retrieve recently added albums
Permissions:

  • ReadData

Parameters:

  1. [ Audio.Fields.Album properties ]
  2. [ List.Limits limits ]
  3. [ List.Sort sort ]

Returns:

Type: object
Properties:

AudioLibrary.GetRecentlyAddedSongs

Retrieve recently added songs
Permissions:

  • ReadData

Parameters:

  1. [ List.Amount albumlimit = -1 ]
  2. [ Audio.Fields.Song properties ]
  3. [ List.Limits limits ]
  4. [ List.Sort sort ]

Returns:

Type: object
Properties:

AudioLibrary.GetSongDetails

Retrieve details about a specific song
Permissions:

  • ReadData

Parameters:

  1. Library.Id songid
  2. [ Audio.Fields.Song properties ]

Returns:

Type: object
Properties:

AudioLibrary.GetSongs

Retrieve all songs from specified album, artist or genre
Permissions:

  • ReadData

Parameters:

  1. [ Library.Id artistid = -1 ]
  2. [ Library.Id albumid = -1 ]
  3. [ Library.Id genreid = -1 ]
  4. [ Audio.Fields.Song properties ]
  5. [ List.Limits limits ]
  6. [ List.Sort sort ]

Returns:

Type: object
Properties:

AudioLibrary.Scan

Scans the audio sources for new library items
Permissions:

  • UpdateData

Parameters: None
Returns: string

Files

Files.Download

Provides a way to download a given file (e.g. providing an URL to the real file location)
Permissions:

  • ReadData

Parameters:

  1. string path

Returns:

Type: object
Properties:

  • string path

Files.GetDirectory

Get the directories and files in the given directory
Permissions:

  • ReadData

Parameters:

  1. string directory
  2. [ Files.Media media = "files" ]
  3. [ List.Fields.All properties ]
  4. [ List.Sort sort ]

Returns:

Type: object
Properties:

Files.GetSources

Get the sources of the media windows
Permissions:

  • ReadData

Parameters:

  1. Files.Media media
  2. [ List.Limits limits ]
  3. [ List.Sort sort ]

Returns:

Type: object
Properties:

Input

Input.Back

Goes back in GUI
Permissions:

  • Navigate

Parameters: None
Returns: string

Input.Down

Navigate down in GUI
Permissions:

  • Navigate

Parameters: None
Returns: string

Input.Home

Goes to home window in GUI
Permissions:

  • Navigate

Parameters: None
Returns: string

Input.Left

Navigate left in GUI
Permissions:

  • Navigate

Parameters: None
Returns: string

Input.Right

Navigate right in GUI
Permissions:

  • Navigate

Parameters: None
Returns: string

Input.Select

Select current item in GUI
Permissions:

  • Navigate

Parameters: None
Returns: string

Input.Up

Navigate up in GUI
Permissions:

  • Navigate

Parameters: None
Returns: string

JSONRPC

JSONRPC.Introspect

Enumerates all actions and descriptions
Permissions:

  • ReadData

Parameters:

  1. [ boolean getdescriptions = True ]
  2. [ boolean getmetadata = False ]
  3. [ boolean filterbytransport = True ]
  4. [ object filter ]

Properties:

  • string type
  • string id
  • [ boolean getreferences = True ]

Returns:

Type: object

JSONRPC.NotifyAll

Notify all other connected clients
Permissions:

  • ReadData

Parameters:

  1. string sender
  2. string message
  3. [ any data = null ]

Returns: any

JSONRPC.Permission

Retrieve the clients permissions
Permissions:

  • ReadData

Parameters: None
Returns:

Type: object
Properties:

  • boolean navigate
  • boolean removedata
  • boolean controlplayback
  • boolean readdata
  • boolean updatedata
  • boolean writefile
  • boolean controlnotify
  • boolean controlpower

JSONRPC.Ping

Ping responder
Permissions:

  • ReadData

Parameters: None
Returns: string

JSONRPC.Version

Retrieve the jsonrpc protocol version
Permissions:

  • ReadData

Parameters: None
Returns: string

Player

Player.GetActivePlayers

Returns all active players
Permissions:

  • ReadData

Parameters: None
Returns:

Type: array

Player.GetItem

Retrieves the currently played item
Permissions:

  • ReadData

Parameters:

  1. Player.Id playerid
  2. [ List.Fields.All properties ]

Returns:

Type: object
Properties:

Player.GetProperties

Retrieves the values of the given properties
Permissions:

  • ReadData

Parameters:

  1. Player.Id playerid
  2. Player.Property.Name[] properties

Returns: Player.Property.Value

Player.GoNext

Go to next item on the playlist
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid

Returns: string

Player.GoPrevious

Go to previous item on the playlist
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid

Returns: string

Player.GoTo

Go to item at the given position in the playlist
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid
  2. Playlist.Position position

Returns: string

Player.MoveDown

If picture is zoomed move viewport down
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid

Returns: string

Player.MoveLeft

If picture is zoomed move viewport left otherwise skip previous
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid

Returns: string

Player.MoveRight

If picture is zoomed move viewport right otherwise skip next
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid

Returns: string

Player.MoveUp

If picture is zoomed move viewport up
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid

Returns: string

Player.Open

Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.
Permissions:

  • ControlPlayback

Parameters:

  1. [ mixed item ]

Returns: string

Player.PlayPause

Pauses or unpause playback and returns the new state
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid

Returns: Player.Speed

Player.Repeat

Set the repeat mode of the player
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid
  2. Player.Repeat state

Returns: string

Player.Rotate

Rotates current picture
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid

Returns: string

Player.Seek

Seek through the playing item
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid
  2. mixed value

Returns:

Type: object
Properties:

Player.SetAudioStream

Set the audio stream played by the player
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid
  2. mixed stream

Returns: string

Player.SetSpeed

Set the speed of the current playback
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid
  2. mixed speed

Returns: Player.Speed

Player.SetSubtitle

Set the subtitle displayed by the player
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid
  2. mixed subtitle

Returns: string

Player.Shuffle

Shuffle items in the player
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid

Returns: string

Player.Stop

Stops playback
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid

Returns: string

Player.UnShuffle

Unshuffle items in the player
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid

Returns: string

Player.Zoom

Zooms current picture
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid
  2. integer value

Returns: string

Player.ZoomIn

Zoom in once
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid

Returns: string

Player.ZoomOut

Zoom out once
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid

Returns: string

Playlist

Playlist.Add

Add item(s) to playlist
Permissions:

  • ControlPlayback

Parameters:

  1. Playlist.Id playlistid
  2. Playlist.Item item

Returns: string

Playlist.Clear

Clear playlist
Permissions:

  • ControlPlayback

Parameters:

  1. Playlist.Id playlistid

Returns: string

Playlist.GetItems

Get all items from playlist
Permissions:

  • ReadData

Parameters:

  1. Playlist.Id playlistid
  2. [ List.Fields.All properties ]
  3. [ List.Limits limits ]
  4. [ List.Sort sort ]

Returns:

Type: object
Properties:

Playlist.GetPlaylists

Returns all existing playlists
Permissions:

  • ReadData

Parameters: None
Returns:

Type: array

Playlist.GetProperties

Retrieves the values of the given properties
Permissions:

  • ReadData

Parameters:

  1. Playlist.Id playlistid
  2. Playlist.Property.Name[] properties

Returns: Playlist.Property.Value

Playlist.Insert

Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).
Permissions:

  • ControlPlayback

Parameters:

  1. Playlist.Id playlistid
  2. Playlist.Position position
  3. Playlist.Item item

Returns: string

Playlist.Remove

Remove item from playlist. Does not work for picture playlists (aka slideshows).
Permissions:

  • ControlPlayback

Parameters:

  1. Playlist.Id playlistid
  2. Playlist.Position position

Returns: string

Playlist.Swap

Swap items in the playlist. Does not work for picture playlists (aka slideshows).
Permissions:

  • ControlPlayback

Parameters:

  1. Playlist.Id playlistid
  2. Playlist.Position position1
  3. Playlist.Position position2

Returns: string

System

System.GetProperties

Retrieves the values of the given properties
Permissions:

  • ReadData

Parameters:

  1. System.Property.Name[] properties

Returns: System.Property.Value

System.Hibernate

Puts the system running XBMC into hibernate mode
Permissions:

  • ControlPower

Parameters: None
Returns: string

System.Reboot

Reboots the system running XBMC
Permissions:

  • ControlPower

Parameters: None
Returns: string

System.Shutdown

Shuts the system running XBMC down
Permissions:

  • ControlPower

Parameters: None
Returns: string

System.Suspend

Suspends the system running XBMC
Permissions:

  • ControlPower

Parameters: None
Returns: string

VideoLibrary

VideoLibrary.Clean

Cleans the video library from non-existent items
Permissions:

  • RemoveData

Parameters: None
Returns: string

VideoLibrary.Export

Exports all items from the video library
Permissions:

  • WriteFile

Parameters:

  1. [ mixed options ]

Returns: string

VideoLibrary.GetEpisodeDetails

Retrieve details about a specific tv show episode
Permissions:

  • ReadData

Parameters:

  1. Library.Id episodeid
  2. [ Video.Fields.Episode properties ]

Returns:

Type: object
Properties:

VideoLibrary.GetEpisodes

Retrieve all tv show episodes
Permissions:

  • ReadData

Parameters:

  1. [ Library.Id tvshowid = -1 ]
  2. [ integer season = -1 ]
  3. [ Video.Fields.Episode properties ]
  4. [ List.Limits limits ]
  5. [ List.Sort sort ]

Returns:

Type: object
Properties:

VideoLibrary.GetGenres

Retrieve all genres
Permissions:

  • ReadData

Parameters:

  1. string type
  2. [ Library.Fields.Genre properties ]
  3. [ List.Limits limits ]
  4. [ List.Sort sort ]

Returns:

Type: object
Properties:

VideoLibrary.GetMovieDetails

Retrieve details about a specific movie
Permissions:

  • ReadData

Parameters:

  1. Library.Id movieid
  2. [ Video.Fields.Movie properties ]

Returns:

Type: object
Properties:

VideoLibrary.GetMovieSetDetails

Retrieve details about a specific movie set
Permissions:

  • ReadData

Parameters:

  1. Library.Id setid
  2. [ Video.Fields.MovieSet properties ]
  3. [ object movies ]

Properties:

Returns:

Type: object
Properties:

VideoLibrary.GetMovieSets

Retrieve all movie sets
Permissions:

  • ReadData

Parameters:

  1. [ Video.Fields.MovieSet properties ]
  2. [ List.Limits limits ]
  3. [ List.Sort sort ]

Returns:

Type: object
Properties:

VideoLibrary.GetMovies

Retrieve all movies
Permissions:

  • ReadData

Parameters:

  1. [ Video.Fields.Movie properties ]
  2. [ List.Limits limits ]
  3. [ List.Sort sort ]

Returns:

Type: object
Properties:

VideoLibrary.GetMusicVideoDetails

Retrieve details about a specific music video
Permissions:

  • ReadData

Parameters:

  1. Library.Id musicvideoid
  2. [ Video.Fields.MusicVideo properties ]

Returns:

Type: object
Properties:

VideoLibrary.GetMusicVideos

Retrieve all music videos
Permissions:

  • ReadData

Parameters:

  1. [ Library.Id artistid = -1 ]
  2. [ Library.Id albumid = -1 ]
  3. [ Video.Fields.MusicVideo properties ]
  4. [ List.Limits limits ]
  5. [ List.Sort sort ]

Returns:

Type: object
Properties:

VideoLibrary.GetRecentlyAddedEpisodes

Retrieve all recently added tv episodes
Permissions:

  • ReadData

Parameters:

  1. [ Video.Fields.Episode properties ]
  2. [ List.Limits limits ]
  3. [ List.Sort sort ]

Returns:

Type: object
Properties:

VideoLibrary.GetRecentlyAddedMovies

Retrieve all recently added movies
Permissions:

  • ReadData

Parameters:

  1. [ Video.Fields.Movie properties ]
  2. [ List.Limits limits ]
  3. [ List.Sort sort ]

Returns:

Type: object
Properties:

VideoLibrary.GetRecentlyAddedMusicVideos

Retrieve all recently added music videos
Permissions:

  • ReadData

Parameters:

  1. [ Video.Fields.MusicVideo properties ]
  2. [ List.Limits limits ]
  3. [ List.Sort sort ]

Returns:

Type: object
Properties:

VideoLibrary.GetSeasons

Retrieve all tv seasons
Permissions:

  • ReadData

Parameters:

  1. Library.Id tvshowid
  2. [ Video.Fields.Season properties ]
  3. [ List.Limits limits ]
  4. [ List.Sort sort ]

Returns:

Type: object
Properties:

VideoLibrary.GetTVShowDetails

Retrieve details about a specific tv show
Permissions:

  • ReadData

Parameters:

  1. Library.Id tvshowid
  2. [ Video.Fields.TVShow properties ]

Returns:

Type: object
Properties:

VideoLibrary.GetTVShows

Retrieve all tv shows
Permissions:

  • ReadData

Parameters:

  1. [ Video.Fields.TVShow properties ]
  2. [ List.Limits limits ]
  3. [ List.Sort sort ]

Returns:

Type: object
Properties:

VideoLibrary.Scan

Scans the video sources for new library items
Permissions:

  • UpdateData

Parameters: None
Returns: string

XBMC

XBMC.GetInfoBooleans

Retrieve info booleans about XBMC and the system
Permissions:

  • ReadData

Parameters:

  1. array[1..X] booleans

Returns:

Type: object

XBMC.GetInfoLabels

Retrieve info labels about XBMC and the system
Permissions:

  • ReadData

Parameters:

  1. array[1..X] labels

Returns:

Type: object


Global types

Application

Application.Property.Name

Type: string

Application.Property.Value

Type: object
Properties:

  • [ boolean muted = False ]
  • [ integer volume = 0 ]
  • [ object version ]

Properties:

    • integer major
    • string tag
    • integer minor
    • [ mixed revision = null ]
  • [ string name = "" ]

Array

Array.Integer

Type: array

Array.String

Type: array

Audio

Audio.Details.Album

Extends:


Properties:

  • [ string style = "" ]
  • [ string mood = "" ]
  • [ string albumlabel = "" ]
  • [ string theme = "" ]
  • Library.Id albumid
  • [ Library.Id artistid = -1 ]
  • [ string type = "" ]
  • [ string description = "" ]

Audio.Details.Artist

Extends:


Properties:

  • [ string style = "" ]
  • [ string description = "" ]
  • [ string musicbrainzartistid = "" ]
  • string artist
  • [ string formed = "" ]
  • [ string disbanded = "" ]
  • [ string born = "" ]
  • Library.Id artistid
  • [ string yearsactive = "" ]
  • [ string instrument = "" ]
  • [ string died = "" ]
  • [ string mood = "" ]

Audio.Details.Base

Extends:


Properties:

  • [ string genre = "" ]

Audio.Details.Media

Extends:


Properties:

  • [ integer rating = 0 ]
  • [ string title = "" ]
  • [ string artist = "" ]
  • [ string musicbrainzalbumartistid = "" ]
  • [ integer year = 0 ]
  • [ string musicbrainzalbumid = "" ]

Audio.Details.Song

Extends:


Properties:

  • [ string album = "" ]
  • [ string comment = "" ]
  • Library.Id songid
  • [ string musicbrainzartistid = "" ]
  • [ string lyrics = "" ]
  • [ integer track = 0 ]
  • [ string musicbrainztrackid = "" ]
  • [ Library.Id albumid = -1 ]
  • [ Library.Id artistid = -1 ]
  • [ string albumartist = "" ]
  • [ string file = "" ]
  • [ integer duration = 0 ]
  • [ integer playcount = 0 ]

Audio.Fields.Album

Extends:

Audio.Fields.Artist

Extends:

Audio.Fields.Song

Extends:

Configuration

Configuration

Type: object
Properties:

Configuration.Notifications

Type: object
Properties:

  • boolean gui
  • boolean system
  • boolean player
  • boolean audiolibrary
  • boolean other
  • boolean videolibrary

Files

Files.Media

Type: string

Global

Global.Time

Type: object
Properties:

  • integer hours
  • integer seconds
  • integer minutes
  • integer milliseconds

Item

Item.Details.Base

Type: object
Properties:

  • string label

Item.Fields.Base

Type: array

Library

Library.Details.Genre

Extends:


Properties:

  • Library.Id genreid
  • [ string thumbnail = "" ]
  • [ string title = "" ]

Library.Fields.Genre

Extends:

Library.Id

Type: integer

List

List.Amount

Type: integer

List.Fields.All

Extends:

List.Item.All

Extends:


Properties:

  • [ string comment = "" ]
  • [ Library.Id tvshowid = -1 ]
  • [ Array.String set ]
  • [ string lyrics = "" ]
  • [ string albumartist = "" ]
  • [ integer duration = 0 ]
  • [ Array.Integer setid ]
  • [ Library.Id id = -1 ]
  • [ string album = "" ]
  • [ string votes = "" ]
  • [ string mpaa = "" ]
  • [ string writer = "" ]
  • [ Library.Id albumid = -1 ]
  • [ string type = "unknown" ]
  • [ string plotoutline = "" ]
  • [ integer track = 0 ]
  • [ integer season = 0 ]
  • [ string musicbrainztrackid = "" ]
  • [ string imdbnumber = "" ]
  • [ string studio = "" ]
  • [ string showlink = "" ]
  • [ string showtitle = "" ]
  • [ integer episode = 0 ]
  • [ string musicbrainzartistid = "" ]
  • [ string productioncode = "" ]
  • [ string country = "" ]
  • [ string premiered = "" ]
  • [ string originaltitle = "" ]
  • [ Video.Cast cast ]
  • [ Library.Id artistid = -1 ]
  • [ string firstaired = "" ]
  • [ string tagline = "" ]
  • [ integer top250 = 0 ]
  • [ string trailer = "" ]

List.Item.File

Extends:


Properties:

  • string filetype
  • string file

List.Items.Sources

Type: array

List.Limits

Type: object
Properties:

  • [ integer start = 0 ]
  • [ integer end = -1 ]

List.LimitsReturned

Type: object
Properties:

  • [ integer start = 0 ]
  • integer total
  • [ integer end = -1 ]

List.Sort

Type: object
Properties:

  • [ string order = "ascending" ]
  • [ boolean ignorearticle = False ]
  • [ string method = "none" ]

Media

Media.Details.Base

Extends:


Properties:

  • [ string fanart = "" ]
  • [ string thumbnail = "" ]

Optional

Optional.Boolean

Type: mixed

Player

Player.Audio.Stream

Type: object
Properties:

  • integer index
  • string name
  • string language

Player.Audio.Stream.Extended

Extends:


Properties:

  • integer channels
  • string codec
  • integer bitrate

Player.Id

Type: integer

Player.Notifications.Data

Type: object
Properties:

Player.Notifications.Item

Type: mixed

Player.Notifications.Item.Type

Type: string

Player.Notifications.Player

Type: object
Properties:

Player.Notifications.Player.Seek

Extends:


Properties:

Player.Position.Percentage

Type: number

Player.Property.Name

Type: string

Player.Property.Value

Type: object
Properties:

Player.Repeat

Type: string

Player.Speed

Type: object
Properties:

  • [ integer speed = 0 ]

Player.Subtitle

Type: object
Properties:

  • integer index
  • string name
  • string language

Player.Type

Type: string

Playlist

Playlist.Id

Type: integer

Playlist.Item

Type: mixed

Playlist.Position

Type: integer

Playlist.Property.Name

Type: string

Playlist.Property.Value

Type: object
Properties:

Playlist.Type

Type: string

System

System.Property.Name

Type: string

System.Property.Value

Type: object
Properties:

  • [ boolean canreboot = False ]
  • [ boolean cansuspend = False ]
  • [ boolean canhibernate = False ]
  • [ boolean canshutdown = False ]

Video

Video.Cast

Type: array

Video.Details.Base

Extends:


Properties:

  • [ integer playcount = 0 ]

Video.Details.Episode

Extends:


Properties:

  • [ number rating = 0 ]
  • [ Library.Id tvshowid = -1 ]
  • [ string votes = "" ]
  • [ integer episode = 0 ]
  • [ string productioncode = "" ]
  • [ integer season = 0 ]
  • [ string writer = "" ]
  • Library.Id episodeid
  • [ string originaltitle = "" ]
  • [ Video.Cast cast ]
  • [ string firstaired = "" ]
  • [ string showtitle = "" ]

Video.Details.File

Extends:


Properties:

Video.Details.Item

Extends:


Properties:

  • [ string plot = "" ]
  • [ string lastplayed = "" ]
  • [ string file = "" ]

Video.Details.Media

Extends:


Properties:

  • [ string title = "" ]

Video.Details.Movie

Extends:


Properties:

  • [ number rating = 0 ]
  • [ Array.String set ]
  • [ integer year = 0 ]
  • [ Array.Integer setid ]
  • [ string votes = "" ]
  • [ string tagline = "" ]
  • [ string writer = "" ]
  • [ string plotoutline = "" ]
  • [ string sorttitle = "" ]
  • [ string imdbnumber = "" ]
  • [ string studio = "" ]
  • [ string showlink = "" ]
  • [ string genre = "" ]
  • Library.Id movieid
  • [ string productioncode = "" ]
  • [ string country = "" ]
  • [ string premiered = "" ]
  • [ string originaltitle = "" ]
  • [ Video.Cast cast ]
  • [ string mpaa = "" ]
  • [ integer top250 = 0 ]
  • [ string trailer = "" ]
  • [ array streamdetails = "" ]

Video.Details.MovieSet

Extends:


Properties:

Video.Details.MovieSet.Extended

Extends:


Properties:

Video.Details.MusicVideo

Extends:


Properties:

  • [ string album = "" ]
  • [ string artist = "" ]
  • [ integer track = 0 ]
  • [ string studio = "" ]
  • [ integer year = 0 ]
  • [ string genre = "" ]
  • Library.Id musicvideoid

Video.Details.Season

Extends:


Properties:

  • integer season
  • [ Library.Id tvshowid = -1 ]
  • [ integer episode = 0 ]
  • [ string showtitle = "" ]

Video.Details.TVShow

Extends:


Properties:

  • [ string episodeguide = "" ]
  • Library.Id tvshowid
  • [ integer episode = 0 ]
  • [ string imdbnumber = "" ]
  • [ number rating = 0 ]
  • [ string mpaa = "" ]
  • [ integer year = 0 ]
  • [ string votes = "" ]
  • [ string premiered = "" ]
  • [ string originaltitle = "" ]
  • [ Video.Cast cast ]
  • [ string studio = "" ]
  • [ string sorttitle = "" ]
  • [ string genre = "" ]

Video.Fields.Episode

Extends:

Video.Fields.Movie

Extends:

Video.Fields.MovieSet

Extends:

Video.Fields.MusicVideo

Extends:

Video.Fields.Season

Extends:

Video.Fields.TVShow

Extends:

Video.Resume

Type: object
Properties:

  • [ number position = 0 ]
  • [ number total = 0 ]

Video.Streams

Type: object
Properties:

  • [ array[1..X] video ]
  • [ array[1..X] audio ]
  • [ array[1..X] subtitle ]


Notifications

AudioLibrary

AudioLibrary.OnRemove

An audio item has been removed.
Parameters:

  1. string sender
  2. object data

Properties:

AudioLibrary.OnUpdate

An audio item has been updated.
Parameters:

  1. string sender
  2. object data

Properties:

Player

Player.OnPause

Playback of a media item has been paused. If there is no ID available extra information will be provided.
Parameters:

  1. string sender
  2. Player.Notifications.Data data

Player.OnPlay

Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.
Parameters:

  1. string sender
  2. Player.Notifications.Data data

Player.OnSeek

The playback position has been changed. If there is no ID available extra information will be provided.
Parameters:

  1. string sender
  2. object data

Properties:

Player.OnSpeedChanged

Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.
Parameters:

  1. string sender
  2. Player.Notifications.Data data

Player.OnStop

Playback of a media item has been stopped. If there is no ID available extra information will be provided.
Parameters:

  1. string sender
  2. object data

Properties:

System

System.OnLowBattery

The system is on low battery.
Parameters:

  1. string sender
  2. null data

System.OnQuit

XBMC will be closed.
Parameters:

  1. string sender
  2. null data

System.OnRestart

The system will be restarted.
Parameters:

  1. string sender
  2. null data

System.OnSleep

The system will be suspended.
Parameters:

  1. string sender
  2. null data

System.OnWake

The system woke up from suspension.
Parameters:

  1. string sender
  2. null data

VideoLibrary

VideoLibrary.OnRemove

A video item has been removed.
Parameters:

  1. string sender
  2. object data

Properties:

VideoLibrary.OnUpdate

A video item has been updated.
Parameters:

  1. string sender
  2. object data

Properties:

  • [ integer playcount = -1 ]
  • string type
  • Library.Id id


External links