User:Ncarthy: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
== Methods ==
=== Addons ===
==== Addons.ExecuteAddon ====
Executes the given addon with the given parameters (if possible)<br />
'''Permissions:'''
* ExecuteAddon
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid
# [ ''mixed'' params ]
# [ ''boolean'' wait = false ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Executes the given addon with the given parameters (if possible)",
  "permission": "ExecuteAddon",
  "type": "method",
  "params": [
    {
      "type": "string",
      "name": "addonid",
      "required": true
    },
    {
      "default": "",
      "type": [
        {
          "additionalProperties": {
            "default": "",
            "type": "string"
          },
          "type": "object"
        },
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "description": "URL path (must start with / or ?",
          "type": "string"
        }
      ],
      "name": "params"
    },
    {
      "default": "false",
      "type": "boolean",
      "name": "wait"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Addons.GetAddonDetails ====
Gets the details of a specific addon<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid
# [ ''[[#Addon.Fields|Addon.Fields]]'' 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:'''
* ''[[#Addon.Details|Addon.Details]]'' addon
* ''[[#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">{
  "description": "Gets the details of a specific addon",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "type": "string",
      "name": "addonid",
      "required": true
    },
    {
      "$ref": "Addon.Fields",
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "addon": {
        "$ref": "Addon.Details",
        "required": true
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== Addons.GetAddons ====
Gets all available addons<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Addon.Types|Addon.Types]]'' type = "unknown" ]
# [ ''[[#Addon.Content|Addon.Content]]'' content = "unknown"/* Content provided by the addon. Only considered for plugins and scripts. */ ]
# [ ''mixed'' enabled = "all" ]
# [ ''[[#Addon.Fields|Addon.Fields]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''mixed'' installed = true ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Addon.Details|Addon.Details]]''[] addons ]
* ''[[#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">{
  "description": "Gets all available addons",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "default": "unknown",
      "$ref": "Addon.Types",
      "name": "type"
    },
    {
      "default": "unknown",
      "description": "Content provided by the addon. Only considered for plugins and scripts.",
      "$ref": "Addon.Content",
      "name": "content"
    },
    {
      "default": "all",
      "type": [
        {
          "type": "boolean"
        },
        {
          "enums": [
            "all"
          ],
          "type": "string"
        }
      ],
      "name": "enabled"
    },
    {
      "$ref": "Addon.Fields",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "default": "true",
      "type": [
        {
          "type": "boolean"
        },
        {
          "enums": [
            "all"
          ],
          "type": "string"
        }
      ],
      "name": "installed"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "addons": {
        "items": {
          "$ref": "Addon.Details"
        },
        "type": "array"
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== Addons.SetAddonEnabled ====
Enables/Disables a specific addon<br />
'''Permissions:'''
* ManageAddon
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid
# ''[[#Global.Toggle|Global.Toggle]]'' enabled
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Enables/Disables a specific addon",
  "permission": "ManageAddon",
  "type": "method",
  "params": [
    {
      "type": "string",
      "name": "addonid",
      "required": true
    },
    {
      "$ref": "Global.Toggle",
      "name": "enabled",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
=== Application ===
==== Application.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Application.Property.Name|Application.Property.Name]]''[] 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:''' ''''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the values of the given properties",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "items": {
        "$ref": "Application.Property.Name"
      },
      "type": "array",
      "name": "properties",
      "required": true
    }
  ],
  "returns": {
    "$ref": "Application.Property.Value"
  }
}</syntaxhighlight>}}
==== Application.Quit ====
Quit application<br />
'''Permissions:'''
* ControlPower
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Quit application",
  "permission": "ControlPower",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Application.SetMute ====
Toggle mute/unmute<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Global.Toggle|Global.Toggle]]'' mute
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Toggle mute/unmute",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Global.Toggle",
      "name": "mute",
      "required": true
    }
  ],
  "returns": {
    "type": "boolean",
    "description": "Mute state"
  }
}</syntaxhighlight>}}
==== Application.SetVolume ====
Set the current volume<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed'' volume
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''integer''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Set the current volume",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "type": [
        {
          "maximum": 100,
          "minimum": 0,
          "type": "integer"
        },
        {
          "$ref": "Global.IncrementDecrement"
        }
      ],
      "name": "volume",
      "required": true
    }
  ],
  "returns": {
    "type": "integer"
  }
}</syntaxhighlight>}}
=== AudioLibrary ===
==== AudioLibrary.Clean ====
Cleans the audio library from non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''boolean'' showdialogs = true/* Whether or not to show the progress bar or any other GUI dialog */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Cleans the audio library from non-existent items",
  "permission": "RemoveData",
  "type": "method",
  "params": [
    {
      "default": "true",
      "description": "Whether or not to show the progress bar or any other GUI dialog",
      "type": "boolean",
      "name": "showdialogs"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== AudioLibrary.Export ====
Exports all items from the audio library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed'' options ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Exports all items from the audio library",
  "permission": "WriteFile",
  "type": "method",
  "params": [
    {
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "path": {
              "description": "Path to the directory to where the data should be exported",
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "images": {
              "default": false,
              "description": "Whether to export thumbnails and fanart images",
              "type": "boolean"
            },
            "overwrite": {
              "default": false,
              "description": "Whether to overwrite existing exported files",
              "type": "boolean"
            }
          },
          "type": "object"
        }
      ],
      "name": "options"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== AudioLibrary.GetAlbumDetails ====
Retrieve details about a specific album<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' albumid
# [ ''[[#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 />
'''Properties:'''
* [ ''[[#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">{
  "description": "Retrieve details about a specific album",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "albumid",
      "required": true
    },
    {
      "$ref": "Audio.Fields.Album",
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "albumdetails": {
        "$ref": "Audio.Details.Album"
      }
    }
  }
}</syntaxhighlight>}}
==== AudioLibrary.GetAlbums ====
Retrieve all albums from specified artist (and role) or that has songs of the specified genre<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
# [ ''boolean'' includesingles = false ]
# [ ''boolean'' allroles = false/* Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value. */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
* ''[[#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">{
  "description": "Retrieve all albums from specified artist (and role) or that has songs of the specified genre",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Audio.Fields.Album",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    },
    {
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "genreid": {
              "$ref": "Library.Id",
              "description": "Song genre. Filter for existance of songs with this genre",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "genre": {
              "description": "Song genre. Filter for existance of songs with this genre",
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "artistid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "artistid": {
              "$ref": "Library.Id",
              "required": true
            },
            "roleid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "artistid": {
              "$ref": "Library.Id",
              "required": true
            },
            "role": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "artist": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "artist": {
              "minLength": 1,
              "required": true,
              "type": "string"
            },
            "roleid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "artist": {
              "minLength": 1,
              "required": true,
              "type": "string"
            },
            "role": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "$ref": "List.Filter.Albums"
        }
      ],
      "name": "filter"
    },
    {
      "default": "false",
      "type": "boolean",
      "name": "includesingles"
    },
    {
      "default": "false",
      "description": "Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.",
      "type": "boolean",
      "name": "allroles"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "albums": {
        "items": {
          "$ref": "Audio.Details.Album"
        },
        "type": "array"
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== AudioLibrary.GetArtistDetails ====
Retrieve details about a specific artist<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' artistid
# [ ''[[#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 />
'''Properties:'''
* [ ''[[#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">{
  "description": "Retrieve details about a specific artist",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "artistid",
      "required": true
    },
    {
      "$ref": "Audio.Fields.Artist",
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "artistdetails": {
        "$ref": "Audio.Details.Artist"
      }
    }
  }
}</syntaxhighlight>}}
==== AudioLibrary.GetArtists ====
Retrieve all artists. For backward compatibility by default this implicity does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Optional.Boolean|Optional.Boolean]]'' albumartistsonly/* Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used */ ]
# [ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
# [ ''boolean'' allroles = false/* Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value. */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Artist|Audio.Details.Artist]]''[] artists ]
* ''[[#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">{
  "description": "Retrieve all artists. For backward compatibility by default this implicity does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "description": "Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used",
      "$ref": "Optional.Boolean",
      "name": "albumartistsonly"
    },
    {
      "$ref": "Audio.Fields.Artist",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    },
    {
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "genreid": {
              "$ref": "Library.Id",
              "description": "Deprecated, use songgenreid. Filter for existance of songs with this genre",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "songgenreid": {
              "$ref": "Library.Id",
              "description": "Song genreid. Filter for existance of songs with this genre",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "roleid": {
              "$ref": "Library.Id",
              "required": true
            },
            "songgenreid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "role": {
              "minLength": 1,
              "required": true,
              "type": "string"
            },
            "songgenreid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "genre": {
              "description": "Deprecated, use songgenre. Filter for existance of songs with this genre",
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "songgenre": {
              "description": "Song genre. Filter for existance of songs with this genre",
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "roleid": {
              "$ref": "Library.Id",
              "required": true
            },
            "songgenre": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "role": {
              "minLength": 1,
              "required": true,
              "type": "string"
            },
            "songgenre": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "albumid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "album": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "songid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "roleid": {
              "$ref": "Library.Id",
              "required": true
            },
            "songid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "role": {
              "minLength": 1,
              "required": true,
              "type": "string"
            },
            "songid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "roleid": {
              "$ref": "Library.Id",
              "description": "Role contributed by artist. Overriden by allroles parameter",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "role": {
              "description": "Role contributed by artist. Overriden by allroles parameter",
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "$ref": "List.Filter.Artists"
        }
      ],
      "name": "filter"
    },
    {
      "default": "false",
      "description": "Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.",
      "type": "boolean",
      "name": "allroles"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "artists": {
        "items": {
          "$ref": "Audio.Details.Artist"
        },
        "type": "array"
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== AudioLibrary.GetGenres ====
Retrieve all genres<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* ''[[#Library.Details.Genre|Library.Details.Genre]]''[] genres
* ''[[#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">{
  "description": "Retrieve all genres",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Fields.Genre",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "genres": {
        "items": {
          "$ref": "Library.Details.Genre"
        },
        "type": "array",
        "required": true
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== AudioLibrary.GetProperties ====
Retrieves the values of the music library properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Audio.Property.Name|Audio.Property.Name]]''[] 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:''' ''''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the values of the music library properties",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "items": {
        "$ref": "Audio.Property.Name"
      },
      "type": "array",
      "name": "properties",
      "required": true
    }
  ],
  "returns": {
    "$ref": "Audio.Property.Value"
  }
}</syntaxhighlight>}}
==== AudioLibrary.GetRecentlyAddedAlbums ====
Retrieve recently added albums<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
* ''[[#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">{
  "description": "Retrieve recently added albums",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Audio.Fields.Album",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "albums": {
        "items": {
          "$ref": "Audio.Details.Album"
        },
        "type": "array"
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== AudioLibrary.GetRecentlyAddedSongs ====
Retrieve recently added songs<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#List.Amount|List.Amount]]'' albumlimit = "-1"/* The amount of recently added albums from which to return the songs */ ]
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#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">{
  "description": "Retrieve recently added songs",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "default": "-1",
      "description": "The amount of recently added albums from which to return the songs",
      "$ref": "List.Amount",
      "name": "albumlimit"
    },
    {
      "$ref": "Audio.Fields.Song",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "songs": {
        "items": {
          "$ref": "Audio.Details.Song"
        },
        "type": "array"
      }
    }
  }
}</syntaxhighlight>}}
==== AudioLibrary.GetRecentlyPlayedAlbums ====
Retrieve recently played albums<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
* ''[[#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">{
  "description": "Retrieve recently played albums",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Audio.Fields.Album",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "albums": {
        "items": {
          "$ref": "Audio.Details.Album"
        },
        "type": "array"
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== AudioLibrary.GetRecentlyPlayedSongs ====
Retrieve recently played songs<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#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">{
  "description": "Retrieve recently played songs",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Audio.Fields.Song",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "songs": {
        "items": {
          "$ref": "Audio.Details.Song"
        },
        "type": "array"
      }
    }
  }
}</syntaxhighlight>}}
==== AudioLibrary.GetRoles ====
Retrieve all contributor roles<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Role|Audio.Fields.Role]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#Audio.Details.Role|Audio.Details.Role]]''[] roles
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieve all contributor roles",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Audio.Fields.Role",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "roles": {
        "items": {
          "$ref": "Audio.Details.Role"
        },
        "type": "array",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== AudioLibrary.GetSongDetails ====
Retrieve details about a specific song<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' songid
# [ ''[[#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 />
'''Properties:'''
* [ ''[[#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">{
  "description": "Retrieve details about a specific song",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "songid",
      "required": true
    },
    {
      "$ref": "Audio.Fields.Song",
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "songdetails": {
        "$ref": "Audio.Details.Song"
      }
    }
  }
}</syntaxhighlight>}}
==== AudioLibrary.GetSongs ====
Retrieve all songs from specified album, artist or genre<br />
Retrieve all songs from specified album, artist or genre<br />
'''Permissions:'''
'''Permissions:'''
Line 1,360: Line 9:
# [ ''mixed'' filter ]
# [ ''mixed'' filter ]
# [ ''boolean'' includesingles = true ]
# [ ''boolean'' includesingles = true ]
# [ ''boolean'' allroles = false/* Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value. */ ]
# [ ''boolean'' allroles = false ''/*Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.*/'' ]
</div>
</div>
'''Returns:'''  
'''Returns:'''  
Line 1,544: Line 193:
         "type": "array"
         "type": "array"
       }
       }
    }
  }
}</syntaxhighlight>}}
==== AudioLibrary.Scan ====
Scans the audio sources for new library items<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''string'' directory ]
# [ ''boolean'' showdialogs = true/* Whether or not to show the progress bar or any other GUI dialog */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Scans the audio sources for new library items",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "default": "",
      "type": "string",
      "name": "directory"
    },
    {
      "default": "true",
      "description": "Whether or not to show the progress bar or any other GUI dialog",
      "type": "boolean",
      "name": "showdialogs"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== AudioLibrary.SetAlbumDetails ====
Update the given album with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' albumid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''mixed'' artist ]
# [ ''[[#Optional.String|Optional.String]]'' description ]
# [ ''mixed'' genre ]
# [ ''mixed'' theme ]
# [ ''mixed'' mood ]
# [ ''mixed'' style ]
# [ ''[[#Optional.String|Optional.String]]'' type ]
# [ ''[[#Optional.String|Optional.String]]'' albumlabel ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' votes ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Update the given album with the given details",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "albumid",
      "required": true
    },
    {
      "$ref": "Optional.String",
      "name": "title"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "artist"
    },
    {
      "$ref": "Optional.String",
      "name": "description"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "genre"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "theme"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "mood"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "style"
    },
    {
      "$ref": "Optional.String",
      "name": "type"
    },
    {
      "$ref": "Optional.String",
      "name": "albumlabel"
    },
    {
      "$ref": "Optional.Number",
      "name": "rating"
    },
    {
      "$ref": "Optional.Integer",
      "name": "year"
    },
    {
      "$ref": "Optional.Integer",
      "name": "userrating"
    },
    {
      "$ref": "Optional.Integer",
      "name": "votes"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== AudioLibrary.SetArtistDetails ====
Update the given artist with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' artistid
# [ ''[[#Optional.String|Optional.String]]'' artist ]
# [ ''mixed'' instrument ]
# [ ''mixed'' style ]
# [ ''mixed'' mood ]
# [ ''[[#Optional.String|Optional.String]]'' born ]
# [ ''[[#Optional.String|Optional.String]]'' formed ]
# [ ''[[#Optional.String|Optional.String]]'' description ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.String|Optional.String]]'' died ]
# [ ''[[#Optional.String|Optional.String]]'' disbanded ]
# [ ''mixed'' yearsactive ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Update the given artist with the given details",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "artistid",
      "required": true
    },
    {
      "$ref": "Optional.String",
      "name": "artist"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "instrument"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "style"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "mood"
    },
    {
      "$ref": "Optional.String",
      "name": "born"
    },
    {
      "$ref": "Optional.String",
      "name": "formed"
    },
    {
      "$ref": "Optional.String",
      "name": "description"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "genre"
    },
    {
      "$ref": "Optional.String",
      "name": "died"
    },
    {
      "$ref": "Optional.String",
      "name": "disbanded"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "yearsactive"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== AudioLibrary.SetSongDetails ====
Update the given song with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' songid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''mixed'' artist ]
# [ ''mixed'' albumartist ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.String|Optional.String]]'' album ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' track ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' disc ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' duration ]
# [ ''[[#Optional.String|Optional.String]]'' comment ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainztrackid ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainzartistid ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainzalbumid ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainzalbumartistid ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' votes ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Update the given song with the given details",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "songid",
      "required": true
    },
    {
      "$ref": "Optional.String",
      "name": "title"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "artist"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "albumartist"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "genre"
    },
    {
      "$ref": "Optional.Integer",
      "name": "year"
    },
    {
      "$ref": "Optional.Number",
      "name": "rating"
    },
    {
      "$ref": "Optional.String",
      "name": "album"
    },
    {
      "$ref": "Optional.Integer",
      "name": "track"
    },
    {
      "$ref": "Optional.Integer",
      "name": "disc"
    },
    {
      "$ref": "Optional.Integer",
      "name": "duration"
    },
    {
      "$ref": "Optional.String",
      "name": "comment"
    },
    {
      "$ref": "Optional.String",
      "name": "musicbrainztrackid"
    },
    {
      "$ref": "Optional.String",
      "name": "musicbrainzartistid"
    },
    {
      "$ref": "Optional.String",
      "name": "musicbrainzalbumid"
    },
    {
      "$ref": "Optional.String",
      "name": "musicbrainzalbumartistid"
    },
    {
      "$ref": "Optional.Integer",
      "name": "playcount"
    },
    {
      "$ref": "Optional.String",
      "name": "lastplayed"
    },
    {
      "$ref": "Optional.Integer",
      "name": "userrating"
    },
    {
      "$ref": "Optional.Integer",
      "name": "votes"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
=== Favourites ===
==== Favourites.AddFavourite ====
Add a favourite with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' title
# ''[[#Favourite.Type|Favourite.Type]]'' type
# [ ''[[#Optional.String|Optional.String]]'' path/* Required for media and script favourites types */ ]
# [ ''[[#Optional.String|Optional.String]]'' window/* Required for window favourite type */ ]
# [ ''[[#Optional.String|Optional.String]]'' windowparameter ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Add a favourite with the given details",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "type": "string",
      "name": "title",
      "required": true
    },
    {
      "$ref": "Favourite.Type",
      "name": "type",
      "required": true
    },
    {
      "description": "Required for media and script favourites types",
      "$ref": "Optional.String",
      "name": "path"
    },
    {
      "description": "Required for window favourite type",
      "$ref": "Optional.String",
      "name": "window"
    },
    {
      "$ref": "Optional.String",
      "name": "windowparameter"
    },
    {
      "$ref": "Optional.String",
      "name": "thumbnail"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Favourites.GetFavourites ====
Retrieve all favourites<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed'' type ]
# [ ''[[#Favourite.Fields.Favourite|Favourite.Fields.Favourite]]'' 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:'''
* [ ''[[#Favourite.Details.Favourite|Favourite.Details.Favourite]]''[] favourites ]
* ''[[#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">{
  "description": "Retrieve all favourites",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Favourite.Type"
        }
      ],
      "name": "type"
    },
    {
      "$ref": "Favourite.Fields.Favourite",
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "favourites": {
        "items": {
          "$ref": "Favourite.Details.Favourite"
        },
        "type": "array"
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
=== Files ===
==== Files.GetDirectory ====
Get the directories and files in the given directory<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' directory
# [ ''[[#Files.Media|Files.Media]]'' media = "files" ]
# [ ''[[#List.Fields.Files|List.Fields.Files]]'' properties ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits/* Limits are applied after getting the directory content thus retrieval is not faster when they are applied. */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.Item.File|List.Item.File]]''[] 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">{
  "description": "Get the directories and files in the given directory",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "type": "string",
      "name": "directory",
      "required": true
    },
    {
      "default": "files",
      "$ref": "Files.Media",
      "name": "media"
    },
    {
      "$ref": "List.Fields.Files",
      "name": "properties"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    },
    {
      "description": "Limits are applied after getting the directory content thus retrieval is not faster when they are applied.",
      "$ref": "List.Limits",
      "name": "limits"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "files": {
        "items": {
          "$ref": "List.Item.File"
        },
        "type": "array",
        "required": true
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== Files.GetFileDetails ====
Get details for a specific file<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file/* Full path to the file */
# [ ''[[#Files.Media|Files.Media]]'' media = "files" ]
# [ ''[[#List.Fields.Files|List.Fields.Files]]'' 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:'''
* ''[[#List.Item.File|List.Item.File]]'' filedetails
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Get details for a specific file",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "description": "Full path to the file",
      "type": "string",
      "name": "file",
      "required": true
    },
    {
      "default": "files",
      "$ref": "Files.Media",
      "name": "media"
    },
    {
      "$ref": "List.Fields.Files",
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "filedetails": {
        "$ref": "List.Item.File",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== Files.GetSources ====
Get the sources of the media windows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Files.Media|Files.Media]]'' media
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.Items.Sources|List.Items.Sources]]'' sources
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Get the sources of the media windows",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Files.Media",
      "name": "media",
      "required": true
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "sources": {
        "$ref": "List.Items.Sources",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== Files.PrepareDownload ====
Provides a way to download a given file (e.g. providing an URL to the real file location)<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' path
</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:'''
* ''mixed'' /* Transport specific details on how/from where to download the given file */details
* ''string'' /* Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol */mode
* ''string'' protocol
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Provides a way to download a given file (e.g. providing an URL to the real file location)",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "type": "string",
      "name": "path",
      "required": true
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "details": {
        "description": "Transport specific details on how/from where to download the given file",
        "type": "any",
        "required": true
      },
      "mode": {
        "description": "Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol",
        "type": "string",
        "required": true
      },
      "protocol": {
        "type": "string",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== Files.SetFileDetails ====
Update the given specific file with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file/* Full path to the file */
# ''[[#Files.Media|Files.Media]]'' media/* File type to update correct database. Currently only "video" is supported. */
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed/* Setting a valid lastplayed without a playcount will force playcount to 1. */ ]
# [ ''mixed'' resume ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Update the given specific file with the given details",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "description": "Full path to the file",
      "type": "string",
      "name": "file",
      "required": true
    },
    {
      "description": "File type to update correct database. Currently only \"video\" is supported.",
      "$ref": "Files.Media",
      "name": "media",
      "required": true
    },
    {
      "$ref": "Optional.Integer",
      "name": "playcount"
    },
    {
      "description": "Setting a valid lastplayed without a playcount will force playcount to 1.",
      "$ref": "Optional.String",
      "name": "lastplayed"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Video.Resume"
        }
      ],
      "name": "resume"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
=== GUI ===
==== GUI.ActivateWindow ====
Activates the given window<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#GUI.Window|GUI.Window]]'' window
# [ ''[[#|]]''[] parameters ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Activates the given window",
  "permission": "ControlGUI",
  "type": "method",
  "params": [
    {
      "$ref": "GUI.Window",
      "name": "window",
      "required": true
    },
    {
      "items": {},
      "type": "array",
      "name": "parameters"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== GUI.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#GUI.Property.Name|GUI.Property.Name]]''[] 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:''' ''''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the values of the given properties",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "items": {
        "$ref": "GUI.Property.Name"
      },
      "type": "array",
      "name": "properties",
      "required": true
    }
  ],
  "returns": {
    "$ref": "GUI.Property.Value"
  }
}</syntaxhighlight>}}
==== GUI.GetStereoscopicModes ====
Returns the supported stereoscopic modes of the GUI<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<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:'''
* [ ''[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]''[] stereoscopicmodes ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Returns the supported stereoscopic modes of the GUI",
  "permission": "ReadData",
  "type": "method",
  "params": [],
  "returns": {
    "type": "object",
    "properties": {
      "stereoscopicmodes": {
        "items": {
          "$ref": "GUI.Stereoscopy.Mode"
        },
        "type": "array"
      }
    }
  }
}</syntaxhighlight>}}
==== GUI.SetFullscreen ====
Toggle fullscreen/GUI<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Global.Toggle|Global.Toggle]]'' fullscreen
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Toggle fullscreen/GUI",
  "permission": "ControlGUI",
  "type": "method",
  "params": [
    {
      "$ref": "Global.Toggle",
      "name": "fullscreen",
      "required": true
    }
  ],
  "returns": {
    "type": "boolean",
    "description": "Fullscreen state"
  }
}</syntaxhighlight>}}
==== GUI.SetStereoscopicMode ====
Sets the stereoscopic mode of the GUI to the given mode<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' mode
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Sets the stereoscopic mode of the GUI to the given mode",
  "permission": "ControlGUI",
  "type": "method",
  "params": [
    {
      "type": "string",
      "name": "mode",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== GUI.ShowNotification ====
Shows a GUI notification<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' title
# ''string'' message
# [ ''mixed'' image ]
# [ ''integer'' displaytime = "5000"/* The time in milliseconds the notification will be visible */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Shows a GUI notification",
  "permission": "ControlGUI",
  "type": "method",
  "params": [
    {
      "type": "string",
      "name": "title",
      "required": true
    },
    {
      "type": "string",
      "name": "message",
      "required": true
    },
    {
      "default": "",
      "type": [
        {
          "enums": [
            "info",
            "warning",
            "error"
          ],
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "name": "image"
    },
    {
      "default": "5000",
      "description": "The time in milliseconds the notification will be visible",
      "type": "integer",
      "name": "displaytime"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
=== Input ===
==== Input.Back ====
Goes back in GUI<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Goes back in GUI",
  "permission": "Navigate",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Input.ContextMenu ====
Shows the context menu<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Shows the context menu",
  "permission": "Navigate",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Input.Down ====
Navigate down in GUI<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Navigate down in GUI",
  "permission": "Navigate",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Input.ExecuteAction ====
Execute a specific action<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Input.Action|Input.Action]]'' action
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Execute a specific action",
  "permission": "Navigate",
  "type": "method",
  "params": [
    {
      "$ref": "Input.Action",
      "name": "action",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Input.Home ====
Goes to home window in GUI<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Goes to home window in GUI",
  "permission": "Navigate",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Input.Info ====
Shows the information dialog<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Shows the information dialog",
  "permission": "Navigate",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Input.Left ====
Navigate left in GUI<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Navigate left in GUI",
  "permission": "Navigate",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Input.Right ====
Navigate right in GUI<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Navigate right in GUI",
  "permission": "Navigate",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Input.Select ====
Select current item in GUI<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Select current item in GUI",
  "permission": "Navigate",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Input.SendText ====
Send a generic (unicode) text<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' text/* Unicode text */
# [ ''boolean'' done = true/* Whether this is the whole input or not (closes an open input dialog if true). */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Send a generic (unicode) text",
  "permission": "Navigate",
  "type": "method",
  "params": [
    {
      "description": "Unicode text",
      "type": "string",
      "name": "text",
      "required": true
    },
    {
      "default": "true",
      "description": "Whether this is the whole input or not (closes an open input dialog if true).",
      "type": "boolean",
      "name": "done"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Input.ShowCodec ====
Show codec information of the playing item<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Show codec information of the playing item",
  "permission": "Navigate",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Input.ShowOSD ====
Show the on-screen display for the current player<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Show the on-screen display for the current player",
  "permission": "Navigate",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Input.ShowPlayerProcessInfo ====
Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...",
  "permission": "Navigate",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Input.Up ====
Navigate up in GUI<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Navigate up in GUI",
  "permission": "Navigate",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
=== JSONRPC ===
==== JSONRPC.Introspect ====
Enumerates all actions and descriptions<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''boolean'' getdescriptions = true ]
# [ ''boolean'' getmetadata = false ]
# [ ''boolean'' filterbytransport = true ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Enumerates all actions and descriptions",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "default": "true",
      "type": "boolean",
      "name": "getdescriptions"
    },
    {
      "default": "false",
      "type": "boolean",
      "name": "getmetadata"
    },
    {
      "default": "true",
      "type": "boolean",
      "name": "filterbytransport"
    },
    {
      "type": "object",
      "name": "filter"
    }
  ],
  "returns": {
    "type": "object",
    "additionalProperties": false
  }
}</syntaxhighlight>}}
==== JSONRPC.NotifyAll ====
Notify all other connected clients<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' message
# [ ''mixed'' data ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''any''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Notify all other connected clients",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "type": "string",
      "name": "sender",
      "required": true
    },
    {
      "type": "string",
      "name": "message",
      "required": true
    },
    {
      "type": "any",
      "name": "data"
    }
  ],
  "returns": {
    "type": "any"
  }
}</syntaxhighlight>}}
==== JSONRPC.Permission ====
Retrieve the clients permissions<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''boolean'' controlgui
* ''boolean'' controlnotify
* ''boolean'' controlplayback
* ''boolean'' controlpower
* ''boolean'' controlpvr
* ''boolean'' controlsystem
* ''boolean'' executeaddon
* ''boolean'' manageaddon
* ''boolean'' navigate
* ''boolean'' readdata
* ''boolean'' removedata
* ''boolean'' updatedata
* ''boolean'' writefile
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieve the clients permissions",
  "permission": "ReadData",
  "type": "method",
  "params": [],
  "returns": {
    "type": "object",
    "properties": {
      "controlgui": {
        "type": "boolean",
        "required": true
      },
      "controlnotify": {
        "type": "boolean",
        "required": true
      },
      "controlplayback": {
        "type": "boolean",
        "required": true
      },
      "controlpower": {
        "type": "boolean",
        "required": true
      },
      "controlpvr": {
        "type": "boolean",
        "required": true
      },
      "controlsystem": {
        "type": "boolean",
        "required": true
      },
      "executeaddon": {
        "type": "boolean",
        "required": true
      },
      "manageaddon": {
        "type": "boolean",
        "required": true
      },
      "navigate": {
        "type": "boolean",
        "required": true
      },
      "readdata": {
        "type": "boolean",
        "required": true
      },
      "removedata": {
        "type": "boolean",
        "required": true
      },
      "updatedata": {
        "type": "boolean",
        "required": true
      },
      "writefile": {
        "type": "boolean",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== JSONRPC.Ping ====
Ping responder<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Ping responder",
  "permission": "ReadData",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== JSONRPC.Version ====
Retrieve the JSON-RPC protocol version.<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<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:'''
* ''mixed'' version
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieve the JSON-RPC protocol version.",
  "permission": "ReadData",
  "type": "method",
  "params": [],
  "returns": {
    "type": "object",
    "properties": {
      "version": {
        "type": "object",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
=== Player ===
==== Player.GetActivePlayers ====
Returns all active players<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Returns all active players",
  "permission": "ReadData",
  "type": "method",
  "params": [],
  "returns": {
    "type": "array"
  }
}</syntaxhighlight>}}
==== Player.GetItem ====
Retrieves the currently played item<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# [ ''[[#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:'''
* ''[[#List.Item.All|List.Item.All]]'' item
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the currently played item",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "$ref": "List.Fields.All",
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "item": {
        "$ref": "List.Item.All",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== Player.GetPlayers ====
Get a list of available players<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''string'' media = "all" ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Get a list of available players",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "default": "all",
      "type": "string",
      "name": "media"
    }
  ],
  "returns": {
    "type": "array"
  }
}</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:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the values of the given properties",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "items": {
        "$ref": "Player.Property.Name"
      },
      "type": "array",
      "name": "properties",
      "required": true
    }
  ],
  "returns": {
    "$ref": "Player.Property.Value"
  }
}</syntaxhighlight>}}
==== Player.GoTo ====
Go to previous/next/specific item in the playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' to
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Go to previous/next/specific item in the playlist",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "type": [
        {
          "enums": [
            "previous",
            "next"
          ],
          "type": "string"
        },
        {
          "$ref": "Playlist.Position",
          "description": "position in playlist"
        }
      ],
      "name": "to",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Player.Move ====
If picture is zoomed move viewport left/right/up/down otherwise skip previous/next<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''string'' direction
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "If picture is zoomed move viewport left/right/up/down otherwise skip previous/next",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "type": "string",
      "name": "direction",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</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 ]
# [ ''mixed'' options ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "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.",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "playlistid": {
              "$ref": "Playlist.Id",
              "required": true
            },
            "position": {
              "$ref": "Playlist.Position",
              "default": 0
            }
          },
          "type": "object"
        },
        {
          "$ref": "Playlist.Item"
        },
        {
          "additionalProperties": false,
          "properties": {
            "path": {
              "required": true,
              "type": "string"
            },
            "random": {
              "default": true,
              "description": "Deprecated, use the shuffled property of the options parameter instead",
              "type": "boolean"
            },
            "recursive": {
              "default": true,
              "type": "boolean"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "partymode": {
              "default": "",
              "type": [
                {
                  "enums": [
                    "music",
                    "video"
                  ],
                  "type": "string"
                },
                {
                  "description": "Path to a smartplaylist (*.xsp) file",
                  "minLength": 5,
                  "type": "string"
                }
              ]
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "channelid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "recordingid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        }
      ],
      "name": "item"
    },
    {
      "type": "object",
      "name": "options"
    }
  ],
  "returns": {
    "type": "string"
  }
}</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
# [ ''[[#Global.Toggle|Global.Toggle]]'' play = "toggle" ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Pauses or unpause playback and returns the new state",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "default": "toggle",
      "$ref": "Global.Toggle",
      "name": "play"
    }
  ],
  "returns": {
    "$ref": "Player.Speed"
  }
}</syntaxhighlight>}}
==== Player.Rotate ====
Rotates current picture<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# [ ''string'' value = "clockwise" ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Rotates current picture",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "default": "clockwise",
      "type": "string",
      "name": "value"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Player.Seek ====
Seek through the playing item<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''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:'''
* [ ''[[#Player.Position.Percentage|Player.Position.Percentage]]''  = "0"percentage ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
* [ ''[[#Global.Time|Global.Time]]'' totaltime ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Seek through the playing item",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "type": [
        {
          "$ref": "Player.Position.Percentage",
          "description": "Percentage value to seek to"
        },
        {
          "$ref": "Player.Position.Time",
          "description": "Time to seek to"
        },
        {
          "description": "Seek by predefined jumps",
          "enums": [
            "smallforward",
            "smallbackward",
            "bigforward",
            "bigbackward"
          ],
          "type": "string"
        },
        {
          "additionalProperties": false,
          "properties": {
            "percentage": {
              "$ref": "Player.Position.Percentage",
              "description": "Percentage value to seek to",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "time": {
              "$ref": "Player.Position.Time",
              "description": "Time to seek to",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "step": {
              "description": "Seek by predefined jumps",
              "enums": [
                "smallforward",
                "smallbackward",
                "bigforward",
                "bigbackward"
              ],
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "seconds": {
              "description": "Seek by the given number of seconds",
              "required": true,
              "type": "integer"
            }
          },
          "type": "object"
        }
      ],
      "name": "value",
      "required": true
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "percentage": {
        "default": "0",
        "$ref": "Player.Position.Percentage"
      },
      "time": {
        "$ref": "Global.Time"
      },
      "totaltime": {
        "$ref": "Global.Time"
      }
    }
  }
}</syntaxhighlight>}}
==== Player.SetAudioStream ====
Set the audio stream played by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' stream
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Set the audio stream played by the player",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "type": [
        {
          "enums": [
            "previous",
            "next"
          ],
          "type": "string"
        },
        {
          "description": "Index of the audio stream to play",
          "minimum": 0,
          "type": "integer"
        }
      ],
      "name": "stream",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Player.SetPartymode ====
Turn partymode on or off<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''[[#Global.Toggle|Global.Toggle]]'' partymode
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Turn partymode on or off",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "$ref": "Global.Toggle",
      "name": "partymode",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Player.SetRepeat ====
Set the repeat mode of the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' repeat
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Set the repeat mode of the player",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "type": [
        {
          "$ref": "Player.Repeat"
        },
        {
          "enums": [
            "cycle"
          ],
          "type": "string"
        }
      ],
      "name": "repeat",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Player.SetShuffle ====
Shuffle/Unshuffle items in the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''[[#Global.Toggle|Global.Toggle]]'' shuffle
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Shuffle/Unshuffle items in the player",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "$ref": "Global.Toggle",
      "name": "shuffle",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Player.SetSpeed ====
Set the speed of the current playback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' speed
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Set the speed of the current playback",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "type": [
        {
          "enums": [
            -32,
            -16,
            -8,
            -4,
            -2,
            -1,
            0,
            1,
            2,
            4,
            8,
            16,
            32
          ],
          "type": "integer"
        },
        {
          "$ref": "Global.IncrementDecrement"
        }
      ],
      "name": "speed",
      "required": true
    }
  ],
  "returns": {
    "$ref": "Player.Speed"
  }
}</syntaxhighlight>}}
==== Player.SetSubtitle ====
Set the subtitle displayed by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' subtitle
# [ ''boolean'' enable = false/* Whether to enable subtitles to be displayed after setting the new subtitle */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Set the subtitle displayed by the player",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "type": [
        {
          "enums": [
            "previous",
            "next",
            "off",
            "on"
          ],
          "type": "string"
        },
        {
          "description": "Index of the subtitle to display",
          "minimum": 0,
          "type": "integer"
        }
      ],
      "name": "subtitle",
      "required": true
    },
    {
      "default": "false",
      "description": "Whether to enable subtitles to be displayed after setting the new subtitle",
      "type": "boolean",
      "name": "enable"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Player.SetVideoStream ====
Set the video stream played by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' stream
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Set the video stream played by the player",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "type": [
        {
          "enums": [
            "previous",
            "next"
          ],
          "type": "string"
        },
        {
          "description": "Index of the video stream to play",
          "minimum": 0,
          "type": "integer"
        }
      ],
      "name": "stream",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Player.Stop ====
Stops playback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Stops playback",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Player.Zoom ====
Zoom current picture<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' zoom
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Zoom current picture",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Player.Id",
      "name": "playerid",
      "required": true
    },
    {
      "type": [
        {
          "enums": [
            "in",
            "out"
          ],
          "type": "string"
        },
        {
          "description": "zoom level",
          "maximum": 10,
          "minimum": 1,
          "type": "integer"
        }
      ],
      "name": "zoom",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</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
# ''mixed'' item
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Add item(s) to playlist",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Playlist.Id",
      "name": "playlistid",
      "required": true
    },
    {
      "type": [
        {
          "$ref": "Playlist.Item"
        },
        {
          "items": {
            "$ref": "Playlist.Item"
          },
          "type": "array"
        }
      ],
      "name": "item",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Playlist.Clear ====
Clear playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Clear playlist",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Playlist.Id",
      "name": "playlistid",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Playlist.GetItems ====
Get all items from playlist<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# [ ''[[#List.Fields.All|List.Fields.All]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* ''[[#List.Item.All|List.Item.All]]''[] items
* ''[[#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">{
  "description": "Get all items from playlist",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Playlist.Id",
      "name": "playlistid",
      "required": true
    },
    {
      "$ref": "List.Fields.All",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "items": {
        "items": {
          "$ref": "List.Item.All"
        },
        "type": "array",
        "required": true
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== Playlist.GetPlaylists ====
Returns all existing playlists<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Returns all existing playlists",
  "permission": "ReadData",
  "type": "method",
  "params": [],
  "returns": {
    "type": "array"
  }
}</syntaxhighlight>}}
==== Playlist.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Property.Name|Playlist.Property.Name]]''[] 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:''' ''''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the values of the given properties",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Playlist.Id",
      "name": "playlistid",
      "required": true
    },
    {
      "items": {
        "$ref": "Playlist.Property.Name"
      },
      "type": "array",
      "name": "properties",
      "required": true
    }
  ],
  "returns": {
    "$ref": "Playlist.Property.Value"
  }
}</syntaxhighlight>}}
==== Playlist.Insert ====
Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Position|Playlist.Position]]'' position
# ''mixed'' item
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Playlist.Id",
      "name": "playlistid",
      "required": true
    },
    {
      "$ref": "Playlist.Position",
      "name": "position",
      "required": true
    },
    {
      "type": [
        {
          "$ref": "Playlist.Item"
        },
        {
          "items": {
            "$ref": "Playlist.Item"
          },
          "type": "array"
        }
      ],
      "name": "item",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Playlist.Remove ====
Remove item from playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Position|Playlist.Position]]'' position
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Remove item from playlist. Does not work for picture playlists (aka slideshows).",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Playlist.Id",
      "name": "playlistid",
      "required": true
    },
    {
      "$ref": "Playlist.Position",
      "name": "position",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Playlist.Swap ====
Swap items in the playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Position|Playlist.Position]]'' position1
# ''[[#Playlist.Position|Playlist.Position]]'' position2
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Swap items in the playlist. Does not work for picture playlists (aka slideshows).",
  "permission": "ControlPlayback",
  "type": "method",
  "params": [
    {
      "$ref": "Playlist.Id",
      "name": "playlistid",
      "required": true
    },
    {
      "$ref": "Playlist.Position",
      "name": "position1",
      "required": true
    },
    {
      "$ref": "Playlist.Position",
      "name": "position2",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
=== Profiles ===
==== Profiles.GetCurrentProfile ====
Retrieve the current profile<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Profiles.Fields.Profile|Profiles.Fields.Profile]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieve the current profile",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Profiles.Fields.Profile",
      "name": "properties"
    }
  ],
  "returns": {
    "$ref": "Profiles.Details.Profile"
  }
}</syntaxhighlight>}}
==== Profiles.GetProfiles ====
Retrieve all profiles<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Profiles.Fields.Profile|Profiles.Fields.Profile]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#Profiles.Details.Profile|Profiles.Details.Profile]]''[] profiles
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieve all profiles",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Profiles.Fields.Profile",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "profiles": {
        "items": {
          "$ref": "Profiles.Details.Profile"
        },
        "type": "array",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== Profiles.LoadProfile ====
Load the specified profile<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' profile/* Profile name */
# [ ''boolean'' prompt = false/* Prompt for password */ ]
# [ ''[[#Profiles.Password|Profiles.Password]]'' password ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Load the specified profile",
  "permission": "Navigate",
  "type": "method",
  "params": [
    {
      "description": "Profile name",
      "type": "string",
      "name": "profile",
      "required": true
    },
    {
      "default": "false",
      "description": "Prompt for password",
      "type": "boolean",
      "name": "prompt"
    },
    {
      "$ref": "Profiles.Password",
      "name": "password"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
=== PVR ===
==== PVR.AddTimer ====
Adds a timer to record the given show one times or a timer rule to record all showings of the given show<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid/* the broadcast id of the item to record */
# [ ''boolean'' timerrule = false/* controls whether to create a timer rule or a onetime timer */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Adds a timer to record the given show one times or a timer rule to record all showings of the given show",
  "permission": "ControlPVR",
  "type": "method",
  "params": [
    {
      "description": "the broadcast id of the item to record",
      "$ref": "Library.Id",
      "name": "broadcastid",
      "required": true
    },
    {
      "default": "false",
      "description": "controls whether to create a timer rule or a onetime timer",
      "type": "boolean",
      "name": "timerrule"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== PVR.DeleteTimer ====
Deletes a onetime timer or a timer rule<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' timerid/* the id of the onetime timer or timer rule to delete */
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Deletes a onetime timer or a timer rule",
  "permission": "ControlPVR",
  "type": "method",
  "params": [
    {
      "description": "the id of the onetime timer or timer rule to delete",
      "$ref": "Library.Id",
      "name": "timerid",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== PVR.GetBroadcastDetails ====
Retrieves the details of a specific broadcast<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid
# [ ''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' 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:'''
* [ ''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the details of a specific broadcast",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "broadcastid",
      "required": true
    },
    {
      "$ref": "PVR.Fields.Broadcast",
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "broadcastdetails": {
        "$ref": "PVR.Details.Broadcast"
      }
    }
  }
}</syntaxhighlight>}}
==== PVR.GetBroadcasts ====
Retrieves the program of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid
# [ ''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]''[] broadcasts
* ''[[#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">{
  "description": "Retrieves the program of a specific channel",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "channelid",
      "required": true
    },
    {
      "$ref": "PVR.Fields.Broadcast",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "broadcasts": {
        "items": {
          "$ref": "PVR.Details.Broadcast"
        },
        "type": "array",
        "required": true
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== PVR.GetChannelDetails ====
Retrieves the details of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid
# [ ''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' 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:'''
* [ ''[[#PVR.Details.Channel|PVR.Details.Channel]]'' channeldetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the details of a specific channel",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "channelid",
      "required": true
    },
    {
      "$ref": "PVR.Fields.Channel",
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "channeldetails": {
        "$ref": "PVR.Details.Channel"
      }
    }
  }
}</syntaxhighlight>}}
==== PVR.GetChannelGroupDetails ====
Retrieves the details of a specific channel group<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.ChannelGroup.Id|PVR.ChannelGroup.Id]]'' channelgroupid
# [ ''mixed'' channels ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.ChannelGroup.Extended|PVR.Details.ChannelGroup.Extended]]'' channelgroupdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the details of a specific channel group",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "PVR.ChannelGroup.Id",
      "name": "channelgroupid",
      "required": true
    },
    {
      "type": "object",
      "name": "channels"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "channelgroupdetails": {
        "$ref": "PVR.Details.ChannelGroup.Extended"
      }
    }
  }
}</syntaxhighlight>}}
==== PVR.GetChannelGroups ====
Retrieves the channel groups for the specified type<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]''[] channelgroups
* ''[[#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">{
  "description": "Retrieves the channel groups for the specified type",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "PVR.Channel.Type",
      "name": "channeltype",
      "required": true
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "channelgroups": {
        "items": {
          "$ref": "PVR.Details.ChannelGroup"
        },
        "type": "array",
        "required": true
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== PVR.GetChannels ====
Retrieves the channel list<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.ChannelGroup.Id|PVR.ChannelGroup.Id]]'' channelgroupid
# [ ''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#PVR.Details.Channel|PVR.Details.Channel]]''[] channels
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the channel list",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "PVR.ChannelGroup.Id",
      "name": "channelgroupid",
      "required": true
    },
    {
      "$ref": "PVR.Fields.Channel",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "channels": {
        "items": {
          "$ref": "PVR.Details.Channel"
        },
        "type": "array",
        "required": true
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== PVR.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.Property.Name|PVR.Property.Name]]''[] 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:''' ''''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the values of the given properties",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "items": {
        "$ref": "PVR.Property.Name"
      },
      "type": "array",
      "name": "properties",
      "required": true
    }
  ],
  "returns": {
    "$ref": "PVR.Property.Value"
  }
}</syntaxhighlight>}}
==== PVR.GetRecordingDetails ====
Retrieves the details of a specific recording<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' recordingid
# [ ''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' 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:'''
* [ ''[[#PVR.Details.Recording|PVR.Details.Recording]]'' recordingdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the details of a specific recording",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "recordingid",
      "required": true
    },
    {
      "$ref": "PVR.Fields.Recording",
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "recordingdetails": {
        "$ref": "PVR.Details.Recording"
      }
    }
  }
}</syntaxhighlight>}}
==== PVR.GetRecordings ====
Retrieves the recordings<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#PVR.Details.Recording|PVR.Details.Recording]]''[] recordings
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the recordings",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "PVR.Fields.Recording",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "recordings": {
        "items": {
          "$ref": "PVR.Details.Recording"
        },
        "type": "array",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== PVR.GetTimerDetails ====
Retrieves the details of a specific timer<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' timerid
# [ ''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' 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:'''
* [ ''[[#PVR.Details.Timer|PVR.Details.Timer]]'' timerdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the details of a specific timer",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "timerid",
      "required": true
    },
    {
      "$ref": "PVR.Fields.Timer",
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "timerdetails": {
        "$ref": "PVR.Details.Timer"
      }
    }
  }
}</syntaxhighlight>}}
==== PVR.GetTimers ====
Retrieves the timers<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#PVR.Details.Timer|PVR.Details.Timer]]''[] timers
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the timers",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "PVR.Fields.Timer",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "timers": {
        "items": {
          "$ref": "PVR.Details.Timer"
        },
        "type": "array",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== PVR.Record ====
Toggle recording of a channel<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Global.Toggle|Global.Toggle]]'' record = "toggle" ]
# [ ''mixed'' channel = "current" ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Toggle recording of a channel",
  "permission": "ControlPVR",
  "type": "method",
  "params": [
    {
      "default": "toggle",
      "$ref": "Global.Toggle",
      "name": "record"
    },
    {
      "default": "current",
      "type": [
        {
          "enums": [
            "current"
          ],
          "type": "string"
        },
        {
          "$ref": "Library.Id"
        }
      ],
      "name": "channel"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== PVR.Scan ====
Starts a channel scan<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Starts a channel scan",
  "permission": "ControlPVR",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== PVR.ToggleTimer ====
Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid/* the broadcast id of the item to toggle a onetime timer or time rule for */
# [ ''boolean'' timerrule = false/* controls whether to create / delete a timer rule or a onetime timer */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created",
  "permission": "ControlPVR",
  "type": "method",
  "params": [
    {
      "description": "the broadcast id of the item to toggle a onetime timer or time rule for",
      "$ref": "Library.Id",
      "name": "broadcastid",
      "required": true
    },
    {
      "default": "false",
      "description": "controls whether to create / delete a timer rule or a onetime timer",
      "type": "boolean",
      "name": "timerrule"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
=== Settings ===
==== Settings.GetCategories ====
Retrieves all setting categories<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Setting.Level|Setting.Level]]'' level = "standard" ]
# [ ''string'' section ]
# [ ''mixed'' 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:'''
* [ ''[[#Setting.Details.Category|Setting.Details.Category]]''[] categories ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves all setting categories",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "default": "standard",
      "$ref": "Setting.Level",
      "name": "level"
    },
    {
      "default": "",
      "type": "string",
      "name": "section"
    },
    {
      "items": {},
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "categories": {
        "items": {
          "$ref": "Setting.Details.Category"
        },
        "type": "array"
      }
    }
  }
}</syntaxhighlight>}}
==== Settings.GetSections ====
Retrieves all setting sections<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Setting.Level|Setting.Level]]'' level = "standard" ]
# [ ''mixed'' 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:'''
* [ ''[[#Setting.Details.Section|Setting.Details.Section]]''[] sections ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves all setting sections",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "default": "standard",
      "$ref": "Setting.Level",
      "name": "level"
    },
    {
      "items": {},
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "sections": {
        "items": {
          "$ref": "Setting.Details.Section"
        },
        "type": "array"
      }
    }
  }
}</syntaxhighlight>}}
==== Settings.GetSettings ====
Retrieves all settings<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Setting.Level|Setting.Level]]'' level = "standard" ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Setting.Details.Setting|Setting.Details.Setting]]''[] settings ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves all settings",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "default": "standard",
      "$ref": "Setting.Level",
      "name": "level"
    },
    {
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "category": {
              "minLength": 1,
              "required": true,
              "type": "string"
            },
            "section": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        }
      ],
      "name": "filter"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "settings": {
        "items": {
          "$ref": "Setting.Details.Setting"
        },
        "type": "array"
      }
    }
  }
}</syntaxhighlight>}}
==== Settings.GetSettingValue ====
Retrieves the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the value of a setting",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "type": "string",
      "name": "setting",
      "required": true
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "value": {
        "$ref": "Setting.Value.Extended",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== Settings.ResetSettingValue ====
Resets the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Resets the value of a setting",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "type": "string",
      "name": "setting",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== Settings.SetSettingValue ====
Changes the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting
# ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' 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:''' ''boolean''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Changes the value of a setting",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "type": "string",
      "name": "setting",
      "required": true
    },
    {
      "$ref": "Setting.Value.Extended",
      "name": "value",
      "required": true
    }
  ],
  "returns": {
    "type": "boolean"
  }
}</syntaxhighlight>}}
=== System ===
==== System.EjectOpticalDrive ====
Ejects or closes the optical disc drive (if available)<br />
'''Permissions:'''
* ControlSystem
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Ejects or closes the optical disc drive (if available)",
  "permission": "ControlSystem",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== System.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#System.Property.Name|System.Property.Name]]''[] 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:''' ''''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieves the values of the given properties",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "items": {
        "$ref": "System.Property.Name"
      },
      "type": "array",
      "name": "properties",
      "required": true
    }
  ],
  "returns": {
    "$ref": "System.Property.Value"
  }
}</syntaxhighlight>}}
==== System.Hibernate ====
Puts the system running Kodi into hibernate mode<br />
'''Permissions:'''
* ControlPower
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Puts the system running Kodi into hibernate mode",
  "permission": "ControlPower",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== System.Reboot ====
Reboots the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Reboots the system running Kodi",
  "permission": "ControlPower",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== System.Shutdown ====
Shuts the system running Kodi down<br />
'''Permissions:'''
* ControlPower
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Shuts the system running Kodi down",
  "permission": "ControlPower",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== System.Suspend ====
Suspends the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Suspends the system running Kodi",
  "permission": "ControlPower",
  "type": "method",
  "params": [],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
=== Textures ===
==== Textures.GetTextures ====
Retrieve all textures<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Textures.Fields.Texture|Textures.Fields.Texture]]'' properties ]
# [ ''[[#List.Filter.Textures|List.Filter.Textures]]'' filter ]
</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:'''
* ''[[#Textures.Details.Texture|Textures.Details.Texture]]''[] textures
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieve all textures",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Textures.Fields.Texture",
      "name": "properties"
    },
    {
      "$ref": "List.Filter.Textures",
      "name": "filter"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "textures": {
        "items": {
          "$ref": "Textures.Details.Texture"
        },
        "type": "array",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== Textures.RemoveTexture ====
Remove the specified texture<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' textureid/* Texture database identifier */
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Remove the specified texture",
  "permission": "RemoveData",
  "type": "method",
  "params": [
    {
      "description": "Texture database identifier",
      "$ref": "Library.Id",
      "name": "textureid",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
=== VideoLibrary ===
==== VideoLibrary.Clean ====
Cleans the video library from non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''boolean'' showdialogs = true/* Whether or not to show the progress bar or any other GUI dialog */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Cleans the video library from non-existent items",
  "permission": "RemoveData",
  "type": "method",
  "params": [
    {
      "default": "true",
      "description": "Whether or not to show the progress bar or any other GUI dialog",
      "type": "boolean",
      "name": "showdialogs"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== VideoLibrary.Export ====
Exports all items from the video library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed'' options ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Exports all items from the video library",
  "permission": "WriteFile",
  "type": "method",
  "params": [
    {
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "path": {
              "description": "Path to the directory to where the data should be exported",
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "actorthumbs": {
              "default": false,
              "description": "Whether to export actor thumbnails",
              "type": "boolean"
            },
            "images": {
              "default": false,
              "description": "Whether to export thumbnails and fanart images",
              "type": "boolean"
            },
            "overwrite": {
              "default": false,
              "description": "Whether to overwrite existing exported files",
              "type": "boolean"
            }
          },
          "type": "object"
        }
      ],
      "name": "options"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetEpisodeDetails ====
Retrieve details about a specific tv show episode<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
# [ ''[[#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 />
'''Properties:'''
* [ ''[[#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">{
  "description": "Retrieve details about a specific tv show episode",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "episodeid",
      "required": true
    },
    {
      "$ref": "Video.Fields.Episode",
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "episodedetails": {
        "$ref": "Video.Details.Episode"
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetEpisodes ====
Retrieve all tv show episodes<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
# [ ''integer'' season = "-1" ]
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]''[] episodes ]
* ''[[#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">{
  "description": "Retrieve all tv show episodes",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "default": "-1",
      "$ref": "Library.Id",
      "name": "tvshowid"
    },
    {
      "default": "-1",
      "type": "integer",
      "name": "season"
    },
    {
      "$ref": "Video.Fields.Episode",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    },
    {
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "genreid": {
              "$ref": "Library.Id",
              "description": "Requires tvshowid to be set",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "genre": {
              "description": "Requires tvshowid to be set",
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "year": {
              "minimum": 0,
              "required": true,
              "type": "integer"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "actor": {
              "description": "Requires tvshowid to be set",
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "director": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "$ref": "List.Filter.Episodes"
        }
      ],
      "name": "filter"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "episodes": {
        "items": {
          "$ref": "Video.Details.Episode"
        },
        "type": "array"
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetGenres ====
Retrieve all genres<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' type
# [ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* ''[[#Library.Details.Genre|Library.Details.Genre]]''[] genres
* ''[[#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">{
  "description": "Retrieve all genres",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "type": "string",
      "name": "type",
      "required": true
    },
    {
      "$ref": "Library.Fields.Genre",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "genres": {
        "items": {
          "$ref": "Library.Details.Genre"
        },
        "type": "array",
        "required": true
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetInProgressTVShows ====
Retrieve all in progress tvshows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#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">{
  "description": "Retrieve all in progress tvshows",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Video.Fields.TVShow",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "tvshows": {
        "items": {
          "$ref": "Video.Details.TVShow"
        },
        "type": "array"
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetMovieDetails ====
Retrieve details about a specific movie<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
# [ ''[[#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 />
'''Properties:'''
* [ ''[[#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">{
  "description": "Retrieve details about a specific movie",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "movieid",
      "required": true
    },
    {
      "$ref": "Video.Fields.Movie",
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "moviedetails": {
        "$ref": "Video.Details.Movie"
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetMovies ====
Retrieve all movies<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieve all movies",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Video.Fields.Movie",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    },
    {
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "genreid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "genre": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "year": {
              "minimum": 0,
              "required": true,
              "type": "integer"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "actor": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "director": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "studio": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "country": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "setid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "set": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "tag": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "$ref": "List.Filter.Movies"
        }
      ],
      "name": "filter"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "movies": {
        "items": {
          "$ref": "Video.Details.Movie"
        },
        "type": "array"
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetMovieSetDetails ====
Retrieve details about a specific movie set<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' setid
# [ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties ]
# [ ''mixed'' movies ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.MovieSet.Extended|Video.Details.MovieSet.Extended]]'' setdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieve details about a specific movie set",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "setid",
      "required": true
    },
    {
      "$ref": "Video.Fields.MovieSet",
      "name": "properties"
    },
    {
      "type": "object",
      "name": "movies"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "setdetails": {
        "$ref": "Video.Details.MovieSet.Extended"
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetMovieSets ====
Retrieve all movie sets<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#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">{
  "description": "Retrieve all movie sets",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Video.Fields.MovieSet",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "sets": {
        "items": {
          "$ref": "Video.Details.MovieSet"
        },
        "type": "array"
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetMusicVideoDetails ====
Retrieve details about a specific music video<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
# [ ''[[#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 />
'''Properties:'''
* [ ''[[#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">{
  "description": "Retrieve details about a specific music video",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "musicvideoid",
      "required": true
    },
    {
      "$ref": "Video.Fields.MusicVideo",
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "musicvideodetails": {
        "$ref": "Video.Details.MusicVideo"
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetMusicVideos ====
Retrieve all music videos<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]''[] musicvideos ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieve all music videos",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Video.Fields.MusicVideo",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    },
    {
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "artist": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "genreid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "genre": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "year": {
              "minimum": 0,
              "required": true,
              "type": "integer"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "director": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "studio": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "tag": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "$ref": "List.Filter.MusicVideos"
        }
      ],
      "name": "filter"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "musicvideos": {
        "items": {
          "$ref": "Video.Details.MusicVideo"
        },
        "type": "array"
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetRecentlyAddedEpisodes ====
Retrieve all recently added tv episodes<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]''[] episodes ]
* ''[[#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">{
  "description": "Retrieve all recently added tv episodes",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Video.Fields.Episode",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "episodes": {
        "items": {
          "$ref": "Video.Details.Episode"
        },
        "type": "array"
      },
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetRecentlyAddedMovies ====
Retrieve all recently added movies<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieve all recently added movies",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Video.Fields.Movie",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "movies": {
        "items": {
          "$ref": "Video.Details.Movie"
        },
        "type": "array"
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetRecentlyAddedMusicVideos ====
Retrieve all recently added music videos<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]''[] musicvideos ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieve all recently added music videos",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Video.Fields.MusicVideo",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "musicvideos": {
        "items": {
          "$ref": "Video.Details.MusicVideo"
        },
        "type": "array"
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetSeasonDetails ====
Retrieve details about a specific tv show season<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' seasonid
# [ ''[[#Video.Fields.Season|Video.Fields.Season]]'' 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:'''
* [ ''[[#Video.Details.Season|Video.Details.Season]]'' seasondetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieve details about a specific tv show season",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "seasonid",
      "required": true
    },
    {
      "$ref": "Video.Fields.Season",
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "seasondetails": {
        "$ref": "Video.Details.Season"
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetSeasons ====
Retrieve all tv seasons<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
# [ ''[[#Video.Fields.Season|Video.Fields.Season]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Season|Video.Details.Season]]''[] seasons ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieve all tv seasons",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "default": "-1",
      "$ref": "Library.Id",
      "name": "tvshowid"
    },
    {
      "$ref": "Video.Fields.Season",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "seasons": {
        "items": {
          "$ref": "Video.Details.Season"
        },
        "type": "array"
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetTags ====
Retrieve all tags<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' type
# [ ''[[#Library.Fields.Tag|Library.Fields.Tag]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#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 />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#Library.Details.Tag|Library.Details.Tag]]''[] tags
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieve all tags",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "type": "string",
      "name": "type",
      "required": true
    },
    {
      "$ref": "Library.Fields.Tag",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "tags": {
        "items": {
          "$ref": "Library.Details.Tag"
        },
        "type": "array",
        "required": true
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetTVShowDetails ====
Retrieve details about a specific tv show<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
# [ ''[[#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 />
'''Properties:'''
* [ ''[[#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">{
  "description": "Retrieve details about a specific tv show",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "tvshowid",
      "required": true
    },
    {
      "$ref": "Video.Fields.TVShow",
      "name": "properties"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "tvshowdetails": {
        "$ref": "Video.Details.TVShow"
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.GetTVShows ====
Retrieve all tv shows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#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">{
  "description": "Retrieve all tv shows",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Video.Fields.TVShow",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    },
    {
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "genreid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "genre": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "year": {
              "minimum": 0,
              "required": true,
              "type": "integer"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "actor": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "studio": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "tag": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "$ref": "List.Filter.TVShows"
        }
      ],
      "name": "filter"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "tvshows": {
        "items": {
          "$ref": "Video.Details.TVShow"
        },
        "type": "array"
      }
    }
  }
}</syntaxhighlight>}}
==== VideoLibrary.RefreshEpisode ====
Refresh the given episode in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
# [ ''boolean'' ignorenfo = false/* Whether or not to ignore a local NFO if present. */ ]
# [ ''string'' title/* Title to use for searching (instead of determining it from the item's filename/path). */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Refresh the given episode in the library",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "episodeid",
      "required": true
    },
    {
      "default": "false",
      "description": "Whether or not to ignore a local NFO if present.",
      "type": "boolean",
      "name": "ignorenfo"
    },
    {
      "default": "",
      "description": "Title to use for searching (instead of determining it from the item's filename/path).",
      "type": "string",
      "name": "title"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== VideoLibrary.RefreshMovie ====
Refresh the given movie in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
# [ ''boolean'' ignorenfo = false/* Whether or not to ignore a local NFO if present. */ ]
# [ ''string'' title/* Title to use for searching (instead of determining it from the item's filename/path). */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Refresh the given movie in the library",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "movieid",
      "required": true
    },
    {
      "default": "false",
      "description": "Whether or not to ignore a local NFO if present.",
      "type": "boolean",
      "name": "ignorenfo"
    },
    {
      "default": "",
      "description": "Title to use for searching (instead of determining it from the item's filename/path).",
      "type": "string",
      "name": "title"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== VideoLibrary.RefreshMusicVideo ====
Refresh the given music video in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
# [ ''boolean'' ignorenfo = false/* Whether or not to ignore a local NFO if present. */ ]
# [ ''string'' title/* Title to use for searching (instead of determining it from the item's filename/path). */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Refresh the given music video in the library",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "musicvideoid",
      "required": true
    },
    {
      "default": "false",
      "description": "Whether or not to ignore a local NFO if present.",
      "type": "boolean",
      "name": "ignorenfo"
    },
    {
      "default": "",
      "description": "Title to use for searching (instead of determining it from the item's filename/path).",
      "type": "string",
      "name": "title"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== VideoLibrary.RefreshTVShow ====
Refresh the given tv show in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
# [ ''boolean'' ignorenfo = false/* Whether or not to ignore a local NFO if present. */ ]
# [ ''boolean'' refreshepisodes = false/* Whether or not to refresh all episodes belonging to the TV show. */ ]
# [ ''string'' title/* Title to use for searching (instead of determining it from the item's filename/path). */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Refresh the given tv show in the library",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "tvshowid",
      "required": true
    },
    {
      "default": "false",
      "description": "Whether or not to ignore a local NFO if present.",
      "type": "boolean",
      "name": "ignorenfo"
    },
    {
      "default": "false",
      "description": "Whether or not to refresh all episodes belonging to the TV show.",
      "type": "boolean",
      "name": "refreshepisodes"
    },
    {
      "default": "",
      "description": "Title to use for searching (instead of determining it from the item's filename/path).",
      "type": "string",
      "name": "title"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== VideoLibrary.RemoveEpisode ====
Removes the given episode from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Removes the given episode from the library",
  "permission": "RemoveData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "episodeid",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== VideoLibrary.RemoveMovie ====
Removes the given movie from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Removes the given movie from the library",
  "permission": "RemoveData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "movieid",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== VideoLibrary.RemoveMusicVideo ====
Removes the given music video from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Removes the given music video from the library",
  "permission": "RemoveData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "musicvideoid",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== VideoLibrary.RemoveTVShow ====
Removes the given tv show from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Removes the given tv show from the library",
  "permission": "RemoveData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "tvshowid",
      "required": true
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== VideoLibrary.Scan ====
Scans the video sources for new library items<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''string'' directory ]
# [ ''boolean'' showdialogs = true/* Whether or not to show the progress bar or any other GUI dialog */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Scans the video sources for new library items",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "default": "",
      "type": "string",
      "name": "directory"
    },
    {
      "default": "true",
      "description": "Whether or not to show the progress bar or any other GUI dialog",
      "type": "boolean",
      "name": "showdialogs"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== VideoLibrary.SetEpisodeDetails ====
Update the given episode with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime/* Runtime in seconds */ ]
# [ ''mixed'' director ]
# [ ''[[#Optional.String|Optional.String]]'' plot ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.String|Optional.String]]'' votes ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''mixed'' writer ]
# [ ''[[#Optional.String|Optional.String]]'' firstaired ]
# [ ''[[#Optional.String|Optional.String]]'' productioncode ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' season ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' episode ]
# [ ''[[#Optional.String|Optional.String]]'' originaltitle ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
# [ ''[[#Optional.String|Optional.String]]'' fanart ]
# [ ''mixed'' art ]
# [ ''mixed'' resume ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings ]
# [ ''[[#Optional.String|Optional.String]]'' dateadded ]
# [ ''mixed'' uniqueid ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Update the given episode with the given details",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "episodeid",
      "required": true
    },
    {
      "$ref": "Optional.String",
      "name": "title"
    },
    {
      "$ref": "Optional.Integer",
      "name": "playcount"
    },
    {
      "description": "Runtime in seconds",
      "$ref": "Optional.Integer",
      "name": "runtime"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "director"
    },
    {
      "$ref": "Optional.String",
      "name": "plot"
    },
    {
      "$ref": "Optional.Number",
      "name": "rating"
    },
    {
      "$ref": "Optional.String",
      "name": "votes"
    },
    {
      "$ref": "Optional.String",
      "name": "lastplayed"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "writer"
    },
    {
      "$ref": "Optional.String",
      "name": "firstaired"
    },
    {
      "$ref": "Optional.String",
      "name": "productioncode"
    },
    {
      "$ref": "Optional.Integer",
      "name": "season"
    },
    {
      "$ref": "Optional.Integer",
      "name": "episode"
    },
    {
      "$ref": "Optional.String",
      "name": "originaltitle"
    },
    {
      "$ref": "Optional.String",
      "name": "thumbnail"
    },
    {
      "$ref": "Optional.String",
      "name": "fanart"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Media.Artwork.Set"
        }
      ],
      "name": "art"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Video.Resume"
        }
      ],
      "name": "resume"
    },
    {
      "$ref": "Optional.Integer",
      "name": "userrating"
    },
    {
      "$ref": "Video.Ratings.Set",
      "name": "ratings"
    },
    {
      "$ref": "Optional.String",
      "name": "dateadded"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Media.UniqueID.Set"
        }
      ],
      "name": "uniqueid"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== VideoLibrary.SetMovieDetails ====
Update the given movie with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime/* Runtime in seconds */ ]
# [ ''mixed'' director ]
# [ ''mixed'' studio ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year/* linked with premiered. Overridden by premiered parameter */ ]
# [ ''[[#Optional.String|Optional.String]]'' plot ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.String|Optional.String]]'' mpaa ]
# [ ''[[#Optional.String|Optional.String]]'' imdbnumber ]
# [ ''[[#Optional.String|Optional.String]]'' votes ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''[[#Optional.String|Optional.String]]'' originaltitle ]
# [ ''[[#Optional.String|Optional.String]]'' trailer ]
# [ ''[[#Optional.String|Optional.String]]'' tagline ]
# [ ''[[#Optional.String|Optional.String]]'' plotoutline ]
# [ ''mixed'' writer ]
# [ ''mixed'' country ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' top250 ]
# [ ''[[#Optional.String|Optional.String]]'' sorttitle ]
# [ ''[[#Optional.String|Optional.String]]'' set ]
# [ ''mixed'' showlink ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
# [ ''[[#Optional.String|Optional.String]]'' fanart ]
# [ ''mixed'' tag ]
# [ ''mixed'' art ]
# [ ''mixed'' resume ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings ]
# [ ''[[#Optional.String|Optional.String]]'' dateadded ]
# [ ''[[#Optional.String|Optional.String]]'' premiered/* linked with year. Overriedes year */ ]
# [ ''mixed'' uniqueid ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Update the given movie with the given details",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "movieid",
      "required": true
    },
    {
      "$ref": "Optional.String",
      "name": "title"
    },
    {
      "$ref": "Optional.Integer",
      "name": "playcount"
    },
    {
      "description": "Runtime in seconds",
      "$ref": "Optional.Integer",
      "name": "runtime"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "director"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "studio"
    },
    {
      "description": "linked with premiered. Overridden by premiered parameter",
      "$ref": "Optional.Integer",
      "name": "year"
    },
    {
      "$ref": "Optional.String",
      "name": "plot"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "genre"
    },
    {
      "$ref": "Optional.Number",
      "name": "rating"
    },
    {
      "$ref": "Optional.String",
      "name": "mpaa"
    },
    {
      "$ref": "Optional.String",
      "name": "imdbnumber"
    },
    {
      "$ref": "Optional.String",
      "name": "votes"
    },
    {
      "$ref": "Optional.String",
      "name": "lastplayed"
    },
    {
      "$ref": "Optional.String",
      "name": "originaltitle"
    },
    {
      "$ref": "Optional.String",
      "name": "trailer"
    },
    {
      "$ref": "Optional.String",
      "name": "tagline"
    },
    {
      "$ref": "Optional.String",
      "name": "plotoutline"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "writer"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "country"
    },
    {
      "$ref": "Optional.Integer",
      "name": "top250"
    },
    {
      "$ref": "Optional.String",
      "name": "sorttitle"
    },
    {
      "$ref": "Optional.String",
      "name": "set"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "showlink"
    },
    {
      "$ref": "Optional.String",
      "name": "thumbnail"
    },
    {
      "$ref": "Optional.String",
      "name": "fanart"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "tag"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Media.Artwork.Set"
        }
      ],
      "name": "art"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Video.Resume"
        }
      ],
      "name": "resume"
    },
    {
      "$ref": "Optional.Integer",
      "name": "userrating"
    },
    {
      "$ref": "Video.Ratings.Set",
      "name": "ratings"
    },
    {
      "$ref": "Optional.String",
      "name": "dateadded"
    },
    {
      "description": "linked with year. Overriedes year",
      "$ref": "Optional.String",
      "name": "premiered"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Media.UniqueID.Set"
        }
      ],
      "name": "uniqueid"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== VideoLibrary.SetMovieSetDetails ====
Update the given movie set with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' setid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''mixed'' art ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Update the given movie set with the given details",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "setid",
      "required": true
    },
    {
      "$ref": "Optional.String",
      "name": "title"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Media.Artwork.Set"
        }
      ],
      "name": "art"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== VideoLibrary.SetMusicVideoDetails ====
Update the given music video with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime/* Runtime in seconds */ ]
# [ ''mixed'' director ]
# [ ''mixed'' studio ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year/* linked with premiered. Overridden by premiered parameter */ ]
# [ ''[[#Optional.String|Optional.String]]'' plot ]
# [ ''[[#Optional.String|Optional.String]]'' album ]
# [ ''mixed'' artist ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' track ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
# [ ''[[#Optional.String|Optional.String]]'' fanart ]
# [ ''mixed'' tag ]
# [ ''mixed'' art ]
# [ ''mixed'' resume ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Optional.String|Optional.String]]'' dateadded ]
# [ ''[[#Optional.String|Optional.String]]'' premiered/* linked with year. Overriedes year */ ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Update the given music video with the given details",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "musicvideoid",
      "required": true
    },
    {
      "$ref": "Optional.String",
      "name": "title"
    },
    {
      "$ref": "Optional.Integer",
      "name": "playcount"
    },
    {
      "description": "Runtime in seconds",
      "$ref": "Optional.Integer",
      "name": "runtime"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "director"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "studio"
    },
    {
      "description": "linked with premiered. Overridden by premiered parameter",
      "$ref": "Optional.Integer",
      "name": "year"
    },
    {
      "$ref": "Optional.String",
      "name": "plot"
    },
    {
      "$ref": "Optional.String",
      "name": "album"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "artist"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "genre"
    },
    {
      "$ref": "Optional.Integer",
      "name": "track"
    },
    {
      "$ref": "Optional.String",
      "name": "lastplayed"
    },
    {
      "$ref": "Optional.String",
      "name": "thumbnail"
    },
    {
      "$ref": "Optional.String",
      "name": "fanart"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "tag"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Media.Artwork.Set"
        }
      ],
      "name": "art"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Video.Resume"
        }
      ],
      "name": "resume"
    },
    {
      "$ref": "Optional.Number",
      "name": "rating"
    },
    {
      "$ref": "Optional.Integer",
      "name": "userrating"
    },
    {
      "$ref": "Optional.String",
      "name": "dateadded"
    },
    {
      "description": "linked with year. Overriedes year",
      "$ref": "Optional.String",
      "name": "premiered"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== VideoLibrary.SetSeasonDetails ====
Update the given season with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' seasonid
# [ ''mixed'' art ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Update the given season with the given details",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "seasonid",
      "required": true
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Media.Artwork.Set"
        }
      ],
      "name": "art"
    },
    {
      "$ref": "Optional.Integer",
      "name": "userrating"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
==== VideoLibrary.SetTVShowDetails ====
Update the given tvshow with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''mixed'' studio ]
# [ ''[[#Optional.String|Optional.String]]'' plot ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.String|Optional.String]]'' mpaa ]
# [ ''[[#Optional.String|Optional.String]]'' imdbnumber ]
# [ ''[[#Optional.String|Optional.String]]'' premiered ]
# [ ''[[#Optional.String|Optional.String]]'' votes ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''[[#Optional.String|Optional.String]]'' originaltitle ]
# [ ''[[#Optional.String|Optional.String]]'' sorttitle ]
# [ ''[[#Optional.String|Optional.String]]'' episodeguide ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
# [ ''[[#Optional.String|Optional.String]]'' fanart ]
# [ ''mixed'' tag ]
# [ ''mixed'' art ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings ]
# [ ''[[#Optional.String|Optional.String]]'' dateadded ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime/* Runtime in seconds */ ]
# [ ''[[#Optional.String|Optional.String]]'' status ]
# [ ''mixed'' uniqueid ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Update the given tvshow with the given details",
  "permission": "UpdateData",
  "type": "method",
  "params": [
    {
      "$ref": "Library.Id",
      "name": "tvshowid",
      "required": true
    },
    {
      "$ref": "Optional.String",
      "name": "title"
    },
    {
      "$ref": "Optional.Integer",
      "name": "playcount"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "studio"
    },
    {
      "$ref": "Optional.String",
      "name": "plot"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "genre"
    },
    {
      "$ref": "Optional.Number",
      "name": "rating"
    },
    {
      "$ref": "Optional.String",
      "name": "mpaa"
    },
    {
      "$ref": "Optional.String",
      "name": "imdbnumber"
    },
    {
      "$ref": "Optional.String",
      "name": "premiered"
    },
    {
      "$ref": "Optional.String",
      "name": "votes"
    },
    {
      "$ref": "Optional.String",
      "name": "lastplayed"
    },
    {
      "$ref": "Optional.String",
      "name": "originaltitle"
    },
    {
      "$ref": "Optional.String",
      "name": "sorttitle"
    },
    {
      "$ref": "Optional.String",
      "name": "episodeguide"
    },
    {
      "$ref": "Optional.String",
      "name": "thumbnail"
    },
    {
      "$ref": "Optional.String",
      "name": "fanart"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Array.String"
        }
      ],
      "name": "tag"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Media.Artwork.Set"
        }
      ],
      "name": "art"
    },
    {
      "$ref": "Optional.Integer",
      "name": "userrating"
    },
    {
      "$ref": "Video.Ratings.Set",
      "name": "ratings"
    },
    {
      "$ref": "Optional.String",
      "name": "dateadded"
    },
    {
      "description": "Runtime in seconds",
      "$ref": "Optional.Integer",
      "name": "runtime"
    },
    {
      "$ref": "Optional.String",
      "name": "status"
    },
    {
      "type": [
        {
          "type": "null"
        },
        {
          "$ref": "Media.UniqueID.Set"
        }
      ],
      "name": "uniqueid"
    }
  ],
  "returns": {
    "type": "string"
  }
}</syntaxhighlight>}}
=== XBMC ===
==== XBMC.GetInfoBooleans ====
Retrieve info booleans about Kodi and the system<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#|]]''[] 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''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieve info booleans about Kodi and the system",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "items": {},
      "type": "array",
      "name": "booleans",
      "required": true
    }
  ],
  "returns": {
    "type": "object",
    "description": "Object containing key-value pairs of the retrieved info booleans",
    "additionalProperties": {
      "default": "",
      "type": "string"
    }
  }
}</syntaxhighlight>}}
==== XBMC.GetInfoLabels ====
Retrieve info labels about Kodi and the system<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#|]]''[] labels/* See http://kodi.wiki/view/InfoLabels for a list of possible info 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''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
  "description": "Retrieve info labels about Kodi and the system",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "description": "See http://kodi.wiki/view/InfoLabels for a list of possible info labels",
      "items": {},
      "type": "array",
      "name": "labels",
      "required": true
    }
  ],
  "returns": {
    "type": "object",
    "description": "Object containing key-value pairs of the retrieved info labels",
    "additionalProperties": {
      "default": "",
      "type": "string"
     }
     }
   }
   }
}</syntaxhighlight>}}
}</syntaxhighlight>}}

Revision as of 10:58, 19 February 2017

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

  • ReadData

Parameters:

  1. [ Audio.Fields.Song properties ]
  2. [ List.Limits limits ]
  3. [ List.Sort sort ]
  4. [ mixed filter ]
  5. [ boolean includesingles = true ]
  6. [ boolean allroles = false /*Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.*/ ]

Returns:

Type: object
Properties:

JSON Schema Description 
{
  "description": "Retrieve all songs from specified album, artist or genre",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "$ref": "Audio.Fields.Song",
      "name": "properties"
    },
    {
      "$ref": "List.Limits",
      "name": "limits"
    },
    {
      "$ref": "List.Sort",
      "name": "sort"
    },
    {
      "type": [
        {
          "additionalProperties": false,
          "properties": {
            "genreid": {
              "$ref": "Library.Id",
              "description": "Song genre. Filter for existance of songs with this genre",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "genre": {
              "description": "Song genre. Filter for existance of songs with this genre",
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "artistid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "artistid": {
              "$ref": "Library.Id",
              "required": true
            },
            "roleid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "artistid": {
              "$ref": "Library.Id",
              "required": true
            },
            "role": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "artist": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "artist": {
              "minLength": 1,
              "required": true,
              "type": "string"
            },
            "roleid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "artist": {
              "minLength": 1,
              "required": true,
              "type": "string"
            },
            "role": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "albumid": {
              "$ref": "Library.Id",
              "required": true
            }
          },
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "album": {
              "minLength": 1,
              "required": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        {
          "$ref": "List.Filter.Songs"
        }
      ],
      "name": "filter"
    },
    {
      "default": "true",
      "type": "boolean",
      "name": "includesingles"
    },
    {
      "default": "false",
      "description": "Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.",
      "type": "boolean",
      "name": "allroles"
    }
  ],
  "returns": {
    "type": "object",
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "songs": {
        "items": {
          "$ref": "Audio.Details.Song"
        },
        "type": "array"
      }
    }
  }
}
Retrieved from "https://kodi.wiki/index.php?title=User:Ncarthy&oldid=128683"