User:Ncarthy

Methods

Addons

Addons.ExecuteAddon

Executes the given addon with the given parameters (if possible)
Permissions:

• ExecuteAddon

Parameters:

1. string addonid
2. [ mixed params ]
3. [ boolean wait = false ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "default": "false", "type": "boolean", "name": "wait", "required": false } ], "returns": { "type": "string" } }

Addons.GetAddonDetails

Gets the details of a specific addon
Permissions:

• ReadData

Parameters:

1. string addonid
2. [ Addon.Fields properties ]

Returns:

Type: object
Properties:

• Addon.Details addon
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Gets the details of a specific addon", "permission": "ReadData", "type": "method", "params": [ { "type": "string", "name": "addonid", "required": true }, { "$ref": "Addon.Fields", "name": "properties", "required": false } ], "returns": { "type": "object", "properties": { "addon": { "$ref": "Addon.Details", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

Addons.GetAddons

Gets all available addons
Permissions:

• ReadData

Parameters:

1. [ Addon.Types type = "unknown" ]
2. [ Addon.Content content = "unknown" ]
3. [ mixed enabled = "all" ]
4. [ Addon.Fields properties ]
5. [ List.Limits limits ]
6. [ mixed installed = true ]

Returns:

Type: object
Properties:

• [ Addon.Details[] addons ]
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Gets all available addons", "permission": "ReadData", "type": "method", "params": [ { "default": "unknown", "$ref": "Addon.Types", "name": "type", "required": false }, { "default": "unknown", "description": "Content provided by the addon. Only considered for plugins and scripts.", "$ref": "Addon.Content", "name": "content", "required": false }, { "default": "all", "type": [ { "type": "boolean" }, { "enums": [ "all" ], "type": "string" } ], "name": "enabled", "required": false }, { "$ref": "Addon.Fields", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "default": "true", "type": [ { "type": "boolean" }, { "enums": [ "all" ], "type": "string" } ], "name": "installed", "required": false } ], "returns": { "type": "object", "properties": { "addons": { "items": { "$ref": "Addon.Details" }, "type": "array", "required": false }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

Addons.SetAddonEnabled

Enables/Disables a specific addon
Permissions:

• ManageAddon

Parameters:

1. string addonid
2. Global.Toggle enabled

Returns:

Type: string

JSON Schema Description
{ "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" } }

Application

Application.GetProperties

Retrieves the values of the given properties
Permissions:

• ReadData

Parameters:

1. Application.Property.Name[] properties

Returns:

Type: '

JSON Schema Description
{ "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" } }

Application.Quit

Quit application
Permissions:

• ControlPower

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Quit application", "permission": "ControlPower", "type": "method", "params": [], "returns": { "type": "string" } }

Application.SetMute

Toggle mute/unmute
Permissions:

• ControlPlayback

Parameters:

1. Global.Toggle mute

Returns:

Type: boolean

JSON Schema Description
{ "description": "Toggle mute/unmute", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Global.Toggle", "name": "mute", "required": true } ], "returns": { "type": "boolean", "description": "Mute state" } }

Application.SetVolume

Set the current volume
Permissions:

• ControlPlayback

Parameters:

1. mixed volume

Returns:

Type: integer

JSON Schema Description
{ "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" } }

AudioLibrary

AudioLibrary.Clean

Cleans the audio library from non-existent items
Permissions:

• RemoveData

Parameters:

1. [ boolean showdialogs = true ]

Returns:

Type: string

JSON Schema Description
{ "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", "required": false } ], "returns": { "type": "string" } }

AudioLibrary.Export

Exports all items from the audio library
Permissions:

• WriteFile

Parameters:

1. [ mixed options ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false } ], "returns": { "type": "string" } }

AudioLibrary.GetAlbumDetails

Retrieve details about a specific album
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• [ Audio.Details.Album albumdetails ]

JSON Schema Description
{ "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", "required": false } ], "returns": { "type": "object", "properties": { "albumdetails": { "$ref": "Audio.Details.Album", "required": false } } } }

AudioLibrary.GetAlbums

Retrieve all albums from specified artist (and role) or that has songs of the specified genre
Permissions:

• ReadData

Parameters:

1. [ Audio.Fields.Album properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]
4. [ mixed filter ]
5. [ boolean includesingles = false ]
6. [ boolean allroles = false ]

Returns:

Type: object
Properties:

• [ Audio.Details.Album[] albums ]
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve all albums from specified artist (and role) or that has songs of the specified genre", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Audio.Fields.Album", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false }, { "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", "required": false }, { "default": "false", "type": "boolean", "name": "includesingles", "required": false }, { "default": "false", "description": "Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.", "type": "boolean", "name": "allroles", "required": false } ], "returns": { "type": "object", "properties": { "albums": { "items": { "$ref": "Audio.Details.Album" }, "type": "array", "required": false }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

AudioLibrary.GetArtistDetails

Retrieve details about a specific artist
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• [ Audio.Details.Artist artistdetails ]

JSON Schema Description
{ "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", "required": false } ], "returns": { "type": "object", "properties": { "artistdetails": { "$ref": "Audio.Details.Artist", "required": false } } } }

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
Permissions:

• ReadData

Parameters:

1. [ Optional.Boolean albumartistsonly ]
2. [ Audio.Fields.Artist properties ]
3. [ List.Limits limits ]
4. [ List.Sort sort ]
5. [ mixed filter ]
6. [ boolean allroles = false ]

Returns:

Type: object
Properties:

• [ Audio.Details.Artist[] artists ]
• List.LimitsReturned limits

JSON Schema Description

{ "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", "required": false }, { "$ref": "Audio.Fields.Artist", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false }, { "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", "required": false }, { "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", "required": false } ], "returns": { "type": "object", "properties": { "artists": { "items": { "$ref": "Audio.Details.Artist" }, "type": "array", "required": false }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

AudioLibrary.GetGenres

Retrieve all genres
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• Library.Details.Genre[] genres
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve all genres", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Library.Fields.Genre", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "genres": { "items": { "$ref": "Library.Details.Genre" }, "type": "array", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

AudioLibrary.GetProperties

Retrieves the values of the music library properties
Permissions:

• ReadData

Parameters:

1. Audio.Property.Name[] properties

Returns:

Type: '

JSON Schema Description
{ "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" } }

AudioLibrary.GetRecentlyAddedAlbums

Retrieve recently added albums
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• [ Audio.Details.Album[] albums ]
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve recently added albums", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Audio.Fields.Album", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "albums": { "items": { "$ref": "Audio.Details.Album" }, "type": "array", "required": false }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

AudioLibrary.GetRecentlyAddedSongs

Retrieve recently added songs
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Audio.Details.Song[] songs ]

JSON Schema Description

{ "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", "required": false }, { "$ref": "Audio.Fields.Song", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "songs": { "items": { "$ref": "Audio.Details.Song" }, "type": "array", "required": false } } } }

AudioLibrary.GetRecentlyPlayedAlbums

Retrieve recently played albums
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• [ Audio.Details.Album[] albums ]
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve recently played albums", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Audio.Fields.Album", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "albums": { "items": { "$ref": "Audio.Details.Album" }, "type": "array", "required": false }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

AudioLibrary.GetRecentlyPlayedSongs

Retrieve recently played songs
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Audio.Details.Song[] songs ]

JSON Schema Description

{ "description": "Retrieve recently played songs", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Audio.Fields.Song", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "songs": { "items": { "$ref": "Audio.Details.Song" }, "type": "array", "required": false } } } }

AudioLibrary.GetRoles

Retrieve all contributor roles
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• Audio.Details.Role[] roles

JSON Schema Description

{ "description": "Retrieve all contributor roles", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Audio.Fields.Role", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "roles": { "items": { "$ref": "Audio.Details.Role" }, "type": "array", "required": true } } } }

AudioLibrary.GetSongDetails

Retrieve details about a specific song
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• [ Audio.Details.Song songdetails ]

JSON Schema Description
{ "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", "required": false } ], "returns": { "type": "object", "properties": { "songdetails": { "$ref": "Audio.Details.Song", "required": false } } } }

AudioLibrary.GetSongs

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 ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Audio.Details.Song[] songs ]

JSON Schema Description

{ "description": "Retrieve all songs from specified album, artist or genre", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Audio.Fields.Song", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false }, { "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", "required": false }, { "default": "true", "type": "boolean", "name": "includesingles", "required": false }, { "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", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "songs": { "items": { "$ref": "Audio.Details.Song" }, "type": "array", "required": false } } } }

AudioLibrary.Scan

Scans the audio sources for new library items
Permissions:

• UpdateData

Parameters:

1. [ string directory ]
2. [ boolean showdialogs = true ]

Returns:

Type: string

JSON Schema Description

{ "description": "Scans the audio sources for new library items", "permission": "UpdateData", "type": "method", "params": [ { "default": "", "type": "string", "name": "directory", "required": false }, { "default": "true", "description": "Whether or not to show the progress bar or any other GUI dialog", "type": "boolean", "name": "showdialogs", "required": false } ], "returns": { "type": "string" } }

AudioLibrary.SetAlbumDetails

Update the given album with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id albumid
2. [ Optional.String title ]
3. [ mixed artist ]
4. [ Optional.String description ]
5. [ mixed genre ]
6. [ mixed theme ]
7. [ mixed mood ]
8. [ mixed style ]
9. [ Optional.String type ]
10. [ Optional.String albumlabel ]
11. [ Optional.Number rating ]
12. [ Optional.Integer year ]
13. [ Optional.Integer userrating ]
14. [ Optional.Integer votes ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "artist", "required": false }, { "$ref": "Optional.String", "name": "description", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "genre", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "theme", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "mood", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "style", "required": false }, { "$ref": "Optional.String", "name": "type", "required": false }, { "$ref": "Optional.String", "name": "albumlabel", "required": false }, { "$ref": "Optional.Number", "name": "rating", "required": false }, { "$ref": "Optional.Integer", "name": "year", "required": false }, { "$ref": "Optional.Integer", "name": "userrating", "required": false }, { "$ref": "Optional.Integer", "name": "votes", "required": false } ], "returns": { "type": "string" } }

AudioLibrary.SetArtistDetails

Update the given artist with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id artistid
2. [ Optional.String artist ]
3. [ mixed instrument ]
4. [ mixed style ]
5. [ mixed mood ]
6. [ Optional.String born ]
7. [ Optional.String formed ]
8. [ Optional.String description ]
9. [ mixed genre ]
10. [ Optional.String died ]
11. [ Optional.String disbanded ]
12. [ mixed yearsactive ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "instrument", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "style", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "mood", "required": false }, { "$ref": "Optional.String", "name": "born", "required": false }, { "$ref": "Optional.String", "name": "formed", "required": false }, { "$ref": "Optional.String", "name": "description", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "genre", "required": false }, { "$ref": "Optional.String", "name": "died", "required": false }, { "$ref": "Optional.String", "name": "disbanded", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "yearsactive", "required": false } ], "returns": { "type": "string" } }

AudioLibrary.SetSongDetails

Update the given song with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id songid
2. [ Optional.String title ]
3. [ mixed artist ]
4. [ mixed albumartist ]
5. [ mixed genre ]
6. [ Optional.Integer year ]
7. [ Optional.Number rating ]
8. [ Optional.String album ]
9. [ Optional.Integer track ]
10. [ Optional.Integer disc ]
11. [ Optional.Integer duration ]
12. [ Optional.String comment ]
13. [ Optional.String musicbrainztrackid ]
14. [ Optional.String musicbrainzartistid ]
15. [ Optional.String musicbrainzalbumid ]
16. [ Optional.String musicbrainzalbumartistid ]
17. [ Optional.Integer playcount ]
18. [ Optional.String lastplayed ]
19. [ Optional.Integer userrating ]
20. [ Optional.Integer votes ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "artist", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "albumartist", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "genre", "required": false }, { "$ref": "Optional.Integer", "name": "year", "required": false }, { "$ref": "Optional.Number", "name": "rating", "required": false }, { "$ref": "Optional.String", "name": "album", "required": false }, { "$ref": "Optional.Integer", "name": "track", "required": false }, { "$ref": "Optional.Integer", "name": "disc", "required": false }, { "$ref": "Optional.Integer", "name": "duration", "required": false }, { "$ref": "Optional.String", "name": "comment", "required": false }, { "$ref": "Optional.String", "name": "musicbrainztrackid", "required": false }, { "$ref": "Optional.String", "name": "musicbrainzartistid", "required": false }, { "$ref": "Optional.String", "name": "musicbrainzalbumid", "required": false }, { "$ref": "Optional.String", "name": "musicbrainzalbumartistid", "required": false }, { "$ref": "Optional.Integer", "name": "playcount", "required": false }, { "$ref": "Optional.String", "name": "lastplayed", "required": false }, { "$ref": "Optional.Integer", "name": "userrating", "required": false }, { "$ref": "Optional.Integer", "name": "votes", "required": false } ], "returns": { "type": "string" } }

Favourites

Favourites.AddFavourite

Add a favourite with the given details
Permissions:

• UpdateData

Parameters:

1. string title
2. Favourite.Type type
3. [ Optional.String path ]
4. [ Optional.String window ]
5. [ Optional.String windowparameter ]
6. [ Optional.String thumbnail ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "description": "Required for window favourite type", "$ref": "Optional.String", "name": "window", "required": false }, { "$ref": "Optional.String", "name": "windowparameter", "required": false }, { "$ref": "Optional.String", "name": "thumbnail", "required": false } ], "returns": { "type": "string" } }

Favourites.GetFavourites

Retrieve all favourites
Permissions:

• ReadData

Parameters:

1. [ mixed type ]
2. [ Favourite.Fields.Favourite properties ]

Returns:

Type: object
Properties:

• [ Favourite.Details.Favourite[] favourites ]
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve all favourites", "permission": "ReadData", "type": "method", "params": [ { "type": [ { "type": "null" }, { "$ref": "Favourite.Type" } ], "name": "type", "required": false }, { "$ref": "Favourite.Fields.Favourite", "name": "properties", "required": false } ], "returns": { "type": "object", "properties": { "favourites": { "items": { "$ref": "Favourite.Details.Favourite" }, "type": "array", "required": false }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

Files

Files.GetDirectory

Get the directories and files in the given directory
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• List.Item.File[] files
• List.LimitsReturned limits

JSON Schema Description

{ "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", "required": false }, { "$ref": "List.Fields.Files", "name": "properties", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false }, { "description": "Limits are applied after getting the directory content thus retrieval is not faster when they are applied.", "$ref": "List.Limits", "name": "limits", "required": false } ], "returns": { "type": "object", "properties": { "files": { "items": { "$ref": "List.Item.File" }, "type": "array", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

Files.GetFileDetails

Get details for a specific file
Permissions:

• ReadData

Parameters:

1. string file
2. [ Files.Media media = "files" ]
3. [ List.Fields.Files properties ]

Returns:

Type: object
Properties:

• List.Item.File filedetails

JSON Schema Description

{ "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", "required": false }, { "$ref": "List.Fields.Files", "name": "properties", "required": false } ], "returns": { "type": "object", "properties": { "filedetails": { "$ref": "List.Item.File", "required": true } } } }

Files.GetSources

Get the sources of the media windows
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• List.Items.Sources sources

JSON Schema Description

{ "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", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "sources": { "$ref": "List.Items.Sources", "required": true } } } }

Files.PrepareDownload

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

• ReadData

Parameters:

1. string path

Returns:

Type: object
Properties:

• mixed details
• string mode
• string protocol

JSON Schema Description

{ "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 } } } }

Files.SetFileDetails

Update the given specific file with the given details
Permissions:

• UpdateData

Parameters:

1. string file
2. Files.Media media
3. [ Optional.Integer playcount ]
4. [ Optional.String lastplayed ]
5. [ mixed resume ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "description": "Setting a valid lastplayed without a playcount will force playcount to 1.", "$ref": "Optional.String", "name": "lastplayed", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Video.Resume" } ], "name": "resume", "required": false } ], "returns": { "type": "string" } }

GUI

GUI.ActivateWindow

Activates the given window
Permissions:

• ControlGUI

Parameters:

1. GUI.Window window
2. [ [[#|]][] parameters ]

Returns:

Type: string

JSON Schema Description
{ "description": "Activates the given window", "permission": "ControlGUI", "type": "method", "params": [ { "$ref": "GUI.Window", "name": "window", "required": true }, { "items": {}, "type": "array", "name": "parameters", "required": false } ], "returns": { "type": "string" } }

GUI.GetProperties

Retrieves the values of the given properties
Permissions:

• ReadData

Parameters:

1. GUI.Property.Name[] properties

Returns:

Type: '

JSON Schema Description
{ "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" } }

GUI.GetStereoscopicModes

Returns the supported stereoscopic modes of the GUI
Permissions:

• ReadData

Parameters:

Returns:

Type: object
Properties:

• [ GUI.Stereoscopy.Mode[] stereoscopicmodes ]

JSON Schema Description
{ "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", "required": false } } } }

GUI.SetFullscreen

Toggle fullscreen/GUI
Permissions:

• ControlGUI

Parameters:

1. Global.Toggle fullscreen

Returns:

Type: boolean

JSON Schema Description
{ "description": "Toggle fullscreen/GUI", "permission": "ControlGUI", "type": "method", "params": [ { "$ref": "Global.Toggle", "name": "fullscreen", "required": true } ], "returns": { "type": "boolean", "description": "Fullscreen state" } }

GUI.SetStereoscopicMode

Sets the stereoscopic mode of the GUI to the given mode
Permissions:

• ControlGUI

Parameters:

1. string mode

Returns:

Type: string

JSON Schema Description
{ "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" } }

GUI.ShowNotification

Shows a GUI notification
Permissions:

• ControlGUI

Parameters:

1. string title
2. string message
3. [ mixed image ]
4. [ integer displaytime = "5000" ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "default": "5000", "description": "The time in milliseconds the notification will be visible", "type": "integer", "name": "displaytime", "required": false } ], "returns": { "type": "string" } }

Input

Input.Back

Goes back in GUI
Permissions:

• Navigate

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Goes back in GUI", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.ContextMenu

Shows the context menu
Permissions:

• Navigate

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Shows the context menu", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.Down

Navigate down in GUI
Permissions:

• Navigate

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Navigate down in GUI", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.ExecuteAction

Execute a specific action
Permissions:

• Navigate

Parameters:

1. Input.Action action

Returns:

Type: string

JSON Schema Description
{ "description": "Execute a specific action", "permission": "Navigate", "type": "method", "params": [ { "$ref": "Input.Action", "name": "action", "required": true } ], "returns": { "type": "string" } }

Input.Home

Goes to home window in GUI
Permissions:

• Navigate

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Goes to home window in GUI", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.Info

Shows the information dialog
Permissions:

• Navigate

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Shows the information dialog", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.Left

Navigate left in GUI
Permissions:

• Navigate

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Navigate left in GUI", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.Right

Navigate right in GUI
Permissions:

• Navigate

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Navigate right in GUI", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.Select

Select current item in GUI
Permissions:

• Navigate

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Select current item in GUI", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.SendText

Send a generic (unicode) text
Permissions:

• Navigate

Parameters:

1. string text
2. [ boolean done = true ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false } ], "returns": { "type": "string" } }

Input.ShowCodec

Show codec information of the playing item
Permissions:

• Navigate

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Show codec information of the playing item", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.ShowOSD

Show the on-screen display for the current player
Permissions:

• Navigate

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Show the on-screen display for the current player", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

Input.ShowPlayerProcessInfo

Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...
Permissions:

• Navigate

Parameters:

Returns:

Type: string

JSON Schema Description
{ "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" } }

Input.Up

Navigate up in GUI
Permissions:

• Navigate

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Navigate up in GUI", "permission": "Navigate", "type": "method", "params": [], "returns": { "type": "string" } }

JSONRPC

JSONRPC.Introspect

Enumerates all actions and descriptions
Permissions:

• ReadData

Parameters:

1. [ boolean getdescriptions = true ]
2. [ boolean getmetadata = false ]
3. [ boolean filterbytransport = true ]
4. [ mixed filter ]

Returns:

Type: object

JSON Schema Description

{ "description": "Enumerates all actions and descriptions", "permission": "ReadData", "type": "method", "params": [ { "default": "true", "type": "boolean", "name": "getdescriptions", "required": false }, { "default": "false", "type": "boolean", "name": "getmetadata", "required": false }, { "default": "true", "type": "boolean", "name": "filterbytransport", "required": false }, { "type": "object", "name": "filter", "required": false } ], "returns": { "type": "object", "additionalProperties": false } }

JSONRPC.NotifyAll

Notify all other connected clients
Permissions:

• ReadData

Parameters:

1. string sender
2. string message
3. [ mixed data ]

Returns:

Type: any

JSON Schema Description
{ "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", "required": false } ], "returns": { "type": "any" } }

JSONRPC.Permission

Retrieve the clients permissions
Permissions:

• ReadData

Parameters:

Returns:

Type: object
Properties:

• boolean controlgui
• boolean controlnotify
• boolean controlplayback
• boolean controlpower
• boolean controlpvr
• boolean controlsystem
• boolean executeaddon
• boolean manageaddon
• boolean navigate
• boolean readdata
• boolean removedata
• boolean updatedata
• boolean writefile

JSON Schema Description

{ "description": "Retrieve the clients permissions", "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 } } } }

JSONRPC.Ping

Ping responder
Permissions:

• ReadData

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Ping responder", "permission": "ReadData", "type": "method", "params": [], "returns": { "type": "string" } }

JSONRPC.Version

Retrieve the JSON-RPC protocol version.
Permissions:

• ReadData

Parameters:

Returns:

Type: object
Properties:

• mixed version

JSON Schema Description
{ "description": "Retrieve the JSON-RPC protocol version.", "permission": "ReadData", "type": "method", "params": [], "returns": { "type": "object", "properties": { "version": { "type": "object", "required": true } } } }

Player

Player.GetActivePlayers

Returns all active players
Permissions:

• ReadData

Parameters:

Returns:

Type: array

JSON Schema Description
{ "description": "Returns all active players", "permission": "ReadData", "type": "method", "params": [], "returns": { "type": "array" } }

Player.GetItem

Retrieves the currently played item
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• List.Item.All item

JSON Schema Description
{ "description": "Retrieves the currently played item", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "$ref": "List.Fields.All", "name": "properties", "required": false } ], "returns": { "type": "object", "properties": { "item": { "$ref": "List.Item.All", "required": true } } } }

Player.GetPlayers

Get a list of available players
Permissions:

• ReadData

Parameters:

1. [ string media = "all" ]

Returns:

Type: array

JSON Schema Description
{ "description": "Get a list of available players", "permission": "ReadData", "type": "method", "params": [ { "default": "all", "type": "string", "name": "media", "required": false } ], "returns": { "type": "array" } }

Player.GetProperties

Retrieves the values of the given properties
Permissions:

• ReadData

Parameters:

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

Returns:

Type: '

JSON Schema Description
{ "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" } }

Player.GoTo

Go to previous/next/specific item in the playlist
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. mixed to

Returns:

Type: string

JSON Schema Description

{ "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" } }

Player.Move

If picture is zoomed move viewport left/right/up/down otherwise skip previous/next
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. string direction

Returns:

Type: string

JSON Schema Description
{ "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" } }

Player.Open

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

• ControlPlayback

Parameters:

1. [ mixed item ]
2. [ mixed options ]

Returns:

Type: string

JSON Schema Description

{ "description": "Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.", "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", "required": false }, { "type": "object", "name": "options", "required": false } ], "returns": { "type": "string" } }

Player.PlayPause

Pauses or unpause playback and returns the new state
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. [ Global.Toggle play = "toggle" ]

Returns:

Type: '

JSON Schema Description
{ "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", "required": false } ], "returns": { "$ref": "Player.Speed" } }

Player.Rotate

Rotates current picture
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. [ string value = "clockwise" ]

Returns:

Type: string

JSON Schema Description
{ "description": "Rotates current picture", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true }, { "default": "clockwise", "type": "string", "name": "value", "required": false } ], "returns": { "type": "string" } }

Player.Seek

Seek through the playing item
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. mixed value

Returns:

Type: object
Properties:

• [ Player.Position.Percentage = "0"percentage ]
• [ Global.Time time ]
• [ Global.Time totaltime ]

JSON Schema Description

{ "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", "required": false }, "time": { "$ref": "Global.Time", "required": false }, "totaltime": { "$ref": "Global.Time", "required": false } } } }

Player.SetAudioStream

Set the audio stream played by the player
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. mixed stream

Returns:

Type: string

JSON Schema Description

{ "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" } }

Player.SetPartymode

Turn partymode on or off
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. Global.Toggle partymode

Returns:

Type: string

JSON Schema Description
{ "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" } }

Player.SetRepeat

Set the repeat mode of the player
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. mixed repeat

Returns:

Type: string

JSON Schema Description
{ "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" } }

Player.SetShuffle

Shuffle/Unshuffle items in the player
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. Global.Toggle shuffle

Returns:

Type: string

JSON Schema Description
{ "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" } }

Player.SetSpeed

Set the speed of the current playback
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. mixed speed

Returns:

Type: '

JSON Schema Description

{ "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" } }

Player.SetSubtitle

Set the subtitle displayed by the player
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. mixed subtitle
3. [ boolean enable = false ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false } ], "returns": { "type": "string" } }

Player.SetVideoStream

Set the video stream played by the player
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. mixed stream

Returns:

Type: string

JSON Schema Description

{ "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" } }

Player.Stop

Stops playback
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid

Returns:

Type: string

JSON Schema Description
{ "description": "Stops playback", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Player.Id", "name": "playerid", "required": true } ], "returns": { "type": "string" } }

Player.Zoom

Zoom current picture
Permissions:

• ControlPlayback

Parameters:

1. Player.Id playerid
2. mixed zoom

Returns:

Type: string

JSON Schema Description
{ "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" } }

Playlist

Playlist.Add

Add item(s) to playlist
Permissions:

• ControlPlayback

Parameters:

1. Playlist.Id playlistid
2. mixed item

Returns:

Type: string

JSON Schema Description
{ "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" } }

Playlist.Clear

Clear playlist
Permissions:

• ControlPlayback

Parameters:

1. Playlist.Id playlistid

Returns:

Type: string

JSON Schema Description
{ "description": "Clear playlist", "permission": "ControlPlayback", "type": "method", "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true } ], "returns": { "type": "string" } }

Playlist.GetItems

Get all items from playlist
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• List.Item.All[] items
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Get all items from playlist", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Playlist.Id", "name": "playlistid", "required": true }, { "$ref": "List.Fields.All", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "items": { "items": { "$ref": "List.Item.All" }, "type": "array", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

Playlist.GetPlaylists

Returns all existing playlists
Permissions:

• ReadData

Parameters:

Returns:

Type: array

JSON Schema Description
{ "description": "Returns all existing playlists", "permission": "ReadData", "type": "method", "params": [], "returns": { "type": "array" } }

Playlist.GetProperties

Retrieves the values of the given properties
Permissions:

• ReadData

Parameters:

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

Returns:

Type: '

JSON Schema Description
{ "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" } }

Playlist.Insert

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

• ControlPlayback

Parameters:

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

Returns:

Type: string

JSON Schema Description

{ "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" } }

Playlist.Remove

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

• ControlPlayback

Parameters:

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

Returns:

Type: string

JSON Schema Description
{ "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" } }

Playlist.Swap

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

• ControlPlayback

Parameters:

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

Returns:

Type: string

JSON Schema Description

{ "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" } }

Profiles

Profiles.GetCurrentProfile

Retrieve the current profile
Permissions:

• ReadData

Parameters:

1. [ Profiles.Fields.Profile properties ]

Returns:

Type: '

JSON Schema Description
{ "description": "Retrieve the current profile", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Profiles.Fields.Profile", "name": "properties", "required": false } ], "returns": { "$ref": "Profiles.Details.Profile" } }

Profiles.GetProfiles

Retrieve all profiles
Permissions:

• ReadData

Parameters:

1. [ Profiles.Fields.Profile properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• Profiles.Details.Profile[] profiles

JSON Schema Description

{ "description": "Retrieve all profiles", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Profiles.Fields.Profile", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "profiles": { "items": { "$ref": "Profiles.Details.Profile" }, "type": "array", "required": true } } } }

Profiles.LoadProfile

Load the specified profile
Permissions:

• Navigate

Parameters:

1. string profile
2. [ boolean prompt = false ]
3. [ Profiles.Password password ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "$ref": "Profiles.Password", "name": "password", "required": false } ], "returns": { "type": "string" } }

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
Permissions:

• ControlPVR

Parameters:

1. Library.Id broadcastid
2. [ boolean timerrule = false ]

Returns:

Type: string

JSON Schema Description

{ "description": "Adds a timer to record the given show one times or a timer rule to record all showings of the given show", "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", "required": false } ], "returns": { "type": "string" } }

PVR.DeleteTimer

Deletes a onetime timer or a timer rule
Permissions:

• ControlPVR

Parameters:

1. Library.Id timerid

Returns:

Type: string

JSON Schema Description
{ "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" } }

PVR.GetBroadcastDetails

Retrieves the details of a specific broadcast
Permissions:

• ReadData

Parameters:

1. Library.Id broadcastid
2. [ PVR.Fields.Broadcast properties ]

Returns:

Type: object
Properties:

• [ PVR.Details.Broadcast broadcastdetails ]

JSON Schema Description
{ "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", "required": false } ], "returns": { "type": "object", "properties": { "broadcastdetails": { "$ref": "PVR.Details.Broadcast", "required": false } } } }

PVR.GetBroadcasts

Retrieves the program of a specific channel
Permissions:

• ReadData

Parameters:

1. Library.Id channelid
2. [ PVR.Fields.Broadcast properties ]
3. [ List.Limits limits ]

Returns:

Type: object
Properties:

• PVR.Details.Broadcast[] broadcasts
• List.LimitsReturned limits

JSON Schema Description

{ "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", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false } ], "returns": { "type": "object", "properties": { "broadcasts": { "items": { "$ref": "PVR.Details.Broadcast" }, "type": "array", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

PVR.GetChannelDetails

Retrieves the details of a specific channel
Permissions:

• ReadData

Parameters:

1. Library.Id channelid
2. [ PVR.Fields.Channel properties ]

Returns:

Type: object
Properties:

• [ PVR.Details.Channel channeldetails ]

JSON Schema Description
{ "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", "required": false } ], "returns": { "type": "object", "properties": { "channeldetails": { "$ref": "PVR.Details.Channel", "required": false } } } }

PVR.GetChannelGroupDetails

Retrieves the details of a specific channel group
Permissions:

• ReadData

Parameters:

1. PVR.ChannelGroup.Id channelgroupid
2. [ mixed channels ]

Returns:

Type: object
Properties:

• [ PVR.Details.ChannelGroup.Extended channelgroupdetails ]

JSON Schema Description

{ "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", "required": false } ], "returns": { "type": "object", "properties": { "channelgroupdetails": { "$ref": "PVR.Details.ChannelGroup.Extended", "required": false } } } }

PVR.GetChannelGroups

Retrieves the channel groups for the specified type
Permissions:

• ReadData

Parameters:

1. PVR.Channel.Type channeltype
2. [ List.Limits limits ]

Returns:

Type: object
Properties:

• PVR.Details.ChannelGroup[] channelgroups
• List.LimitsReturned limits

JSON Schema Description

{ "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", "required": false } ], "returns": { "type": "object", "properties": { "channelgroups": { "items": { "$ref": "PVR.Details.ChannelGroup" }, "type": "array", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

PVR.GetChannels

Retrieves the channel list
Permissions:

• ReadData

Parameters:

1. PVR.ChannelGroup.Id channelgroupid
2. [ PVR.Fields.Channel properties ]
3. [ List.Limits limits ]

Returns:

Type: object
Properties:

• PVR.Details.Channel[] channels
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieves the channel list", "permission": "ReadData", "type": "method", "params": [ { "$ref": "PVR.ChannelGroup.Id", "name": "channelgroupid", "required": true }, { "$ref": "PVR.Fields.Channel", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false } ], "returns": { "type": "object", "properties": { "channels": { "items": { "$ref": "PVR.Details.Channel" }, "type": "array", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

PVR.GetProperties

Retrieves the values of the given properties
Permissions:

• ReadData

Parameters:

1. PVR.Property.Name[] properties

Returns:

Type: '

JSON Schema Description
{ "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" } }

PVR.GetRecordingDetails

Retrieves the details of a specific recording
Permissions:

• ReadData

Parameters:

1. Library.Id recordingid
2. [ PVR.Fields.Recording properties ]

Returns:

Type: object
Properties:

• [ PVR.Details.Recording recordingdetails ]

JSON Schema Description
{ "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", "required": false } ], "returns": { "type": "object", "properties": { "recordingdetails": { "$ref": "PVR.Details.Recording", "required": false } } } }

PVR.GetRecordings

Retrieves the recordings
Permissions:

• ReadData

Parameters:

1. [ PVR.Fields.Recording properties ]
2. [ List.Limits limits ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• PVR.Details.Recording[] recordings

JSON Schema Description

{ "description": "Retrieves the recordings", "permission": "ReadData", "type": "method", "params": [ { "$ref": "PVR.Fields.Recording", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "recordings": { "items": { "$ref": "PVR.Details.Recording" }, "type": "array", "required": true } } } }

PVR.GetTimerDetails

Retrieves the details of a specific timer
Permissions:

• ReadData

Parameters:

1. Library.Id timerid
2. [ PVR.Fields.Timer properties ]

Returns:

Type: object
Properties:

• [ PVR.Details.Timer timerdetails ]

JSON Schema Description
{ "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", "required": false } ], "returns": { "type": "object", "properties": { "timerdetails": { "$ref": "PVR.Details.Timer", "required": false } } } }

PVR.GetTimers

Retrieves the timers
Permissions:

• ReadData

Parameters:

1. [ PVR.Fields.Timer properties ]
2. [ List.Limits limits ]

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• PVR.Details.Timer[] timers

JSON Schema Description

{ "description": "Retrieves the timers", "permission": "ReadData", "type": "method", "params": [ { "$ref": "PVR.Fields.Timer", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "timers": { "items": { "$ref": "PVR.Details.Timer" }, "type": "array", "required": true } } } }

PVR.Record

Toggle recording of a channel
Permissions:

• ControlPVR

Parameters:

1. [ Global.Toggle record = "toggle" ]
2. [ mixed channel = "current" ]

Returns:

Type: string

JSON Schema Description
{ "description": "Toggle recording of a channel", "permission": "ControlPVR", "type": "method", "params": [ { "default": "toggle", "$ref": "Global.Toggle", "name": "record", "required": false }, { "default": "current", "type": [ { "enums": [ "current" ], "type": "string" }, { "$ref": "Library.Id" } ], "name": "channel", "required": false } ], "returns": { "type": "string" } }

PVR.Scan

Starts a channel scan
Permissions:

• ControlPVR

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Starts a channel scan", "permission": "ControlPVR", "type": "method", "params": [], "returns": { "type": "string" } }

PVR.ToggleTimer

Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created
Permissions:

• ControlPVR

Parameters:

1. Library.Id broadcastid
2. [ boolean timerrule = false ]

Returns:

Type: string

JSON Schema Description

{ "description": "Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created", "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", "required": false } ], "returns": { "type": "string" } }

Settings

Settings.GetCategories

Retrieves all setting categories
Permissions:

• ReadData

Parameters:

1. [ Setting.Level level = "standard" ]
2. [ string section ]
3. [ mixed properties ]

Returns:

Type: object
Properties:

• [ Setting.Details.Category[] categories ]

JSON Schema Description

{ "description": "Retrieves all setting categories", "permission": "ReadData", "type": "method", "params": [ { "default": "standard", "$ref": "Setting.Level", "name": "level", "required": false }, { "default": "", "type": "string", "name": "section", "required": false }, { "items": {}, "name": "properties", "required": false } ], "returns": { "type": "object", "properties": { "categories": { "items": { "$ref": "Setting.Details.Category" }, "type": "array", "required": false } } } }

Settings.GetSections

Retrieves all setting sections
Permissions:

• ReadData

Parameters:

1. [ Setting.Level level = "standard" ]
2. [ mixed properties ]

Returns:

Type: object
Properties:

• [ Setting.Details.Section[] sections ]

JSON Schema Description

{ "description": "Retrieves all setting sections", "permission": "ReadData", "type": "method", "params": [ { "default": "standard", "$ref": "Setting.Level", "name": "level", "required": false }, { "items": {}, "name": "properties", "required": false } ], "returns": { "type": "object", "properties": { "sections": { "items": { "$ref": "Setting.Details.Section" }, "type": "array", "required": false } } } }

Settings.GetSettings

Retrieves all settings
Permissions:

• ReadData

Parameters:

1. [ Setting.Level level = "standard" ]
2. [ mixed filter ]

Returns:

Type: object
Properties:

• [ Setting.Details.Setting[] settings ]

JSON Schema Description

{ "description": "Retrieves all settings", "permission": "ReadData", "type": "method", "params": [ { "default": "standard", "$ref": "Setting.Level", "name": "level", "required": false }, { "type": [ { "additionalProperties": false, "properties": { "category": { "minLength": 1, "required": true, "type": "string" }, "section": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" } ], "name": "filter", "required": false } ], "returns": { "type": "object", "properties": { "settings": { "items": { "$ref": "Setting.Details.Setting" }, "type": "array", "required": false } } } }

Settings.GetSettingValue

Retrieves the value of a setting
Permissions:

• ReadData

Parameters:

1. string setting

Returns:

Type: object
Properties:

• Setting.Value.Extended value

JSON Schema Description
{ "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 } } } }

Settings.ResetSettingValue

Resets the value of a setting
Permissions:

• ReadData

Parameters:

1. string setting

Returns:

Type: string

JSON Schema Description
{ "description": "Resets the value of a setting", "permission": "ReadData", "type": "method", "params": [ { "type": "string", "name": "setting", "required": true } ], "returns": { "type": "string" } }

Settings.SetSettingValue

Changes the value of a setting
Permissions:

• ReadData

Parameters:

1. string setting
2. Setting.Value.Extended value

Returns:

Type: boolean

JSON Schema Description
{ "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" } }

System

System.EjectOpticalDrive

Ejects or closes the optical disc drive (if available)
Permissions:

• ControlSystem

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Ejects or closes the optical disc drive (if available)", "permission": "ControlSystem", "type": "method", "params": [], "returns": { "type": "string" } }

System.GetProperties

Retrieves the values of the given properties
Permissions:

• ReadData

Parameters:

1. System.Property.Name[] properties

Returns:

Type: '

JSON Schema Description
{ "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" } }

System.Hibernate

Puts the system running Kodi into hibernate mode
Permissions:

• ControlPower

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Puts the system running Kodi into hibernate mode", "permission": "ControlPower", "type": "method", "params": [], "returns": { "type": "string" } }

System.Reboot

Reboots the system running Kodi
Permissions:

• ControlPower

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Reboots the system running Kodi", "permission": "ControlPower", "type": "method", "params": [], "returns": { "type": "string" } }

System.Shutdown

Shuts the system running Kodi down
Permissions:

• ControlPower

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Shuts the system running Kodi down", "permission": "ControlPower", "type": "method", "params": [], "returns": { "type": "string" } }

System.Suspend

Suspends the system running Kodi
Permissions:

• ControlPower

Parameters:

Returns:

Type: string

JSON Schema Description
{ "description": "Suspends the system running Kodi", "permission": "ControlPower", "type": "method", "params": [], "returns": { "type": "string" } }

Textures

Textures.GetTextures

Retrieve all textures
Permissions:

• ReadData

Parameters:

1. [ Textures.Fields.Texture properties ]
2. [ List.Filter.Textures filter ]

Returns:

Type: object
Properties:

• Textures.Details.Texture[] textures

JSON Schema Description

{ "description": "Retrieve all textures", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Textures.Fields.Texture", "name": "properties", "required": false }, { "$ref": "List.Filter.Textures", "name": "filter", "required": false } ], "returns": { "type": "object", "properties": { "textures": { "items": { "$ref": "Textures.Details.Texture" }, "type": "array", "required": true } } } }

Textures.RemoveTexture

Remove the specified texture
Permissions:

• RemoveData

Parameters:

1. Library.Id textureid

Returns:

Type: string

JSON Schema Description
{ "description": "Remove the specified texture", "permission": "RemoveData", "type": "method", "params": [ { "description": "Texture database identifier", "$ref": "Library.Id", "name": "textureid", "required": true } ], "returns": { "type": "string" } }

VideoLibrary

VideoLibrary.Clean

Cleans the video library from non-existent items
Permissions:

• RemoveData

Parameters:

1. [ boolean showdialogs = true ]

Returns:

Type: string

JSON Schema Description
{ "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", "required": false } ], "returns": { "type": "string" } }

VideoLibrary.Export

Exports all items from the video library
Permissions:

• WriteFile

Parameters:

1. [ mixed options ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false } ], "returns": { "type": "string" } }

VideoLibrary.GetEpisodeDetails

Retrieve details about a specific tv show episode
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• [ Video.Details.Episode episodedetails ]

JSON Schema Description
{ "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", "required": false } ], "returns": { "type": "object", "properties": { "episodedetails": { "$ref": "Video.Details.Episode", "required": false } } } }

VideoLibrary.GetEpisodes

Retrieve all tv show episodes
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• [ Video.Details.Episode[] episodes ]
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve all tv show episodes", "permission": "ReadData", "type": "method", "params": [ { "default": "-1", "$ref": "Library.Id", "name": "tvshowid", "required": false }, { "default": "-1", "type": "integer", "name": "season", "required": false }, { "$ref": "Video.Fields.Episode", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false }, { "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", "required": false } ], "returns": { "type": "object", "properties": { "episodes": { "items": { "$ref": "Video.Details.Episode" }, "type": "array", "required": false }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

VideoLibrary.GetGenres

Retrieve all genres
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• Library.Details.Genre[] genres
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve all genres", "permission": "ReadData", "type": "method", "params": [ { "type": "string", "name": "type", "required": true }, { "$ref": "Library.Fields.Genre", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "genres": { "items": { "$ref": "Library.Details.Genre" }, "type": "array", "required": true }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

VideoLibrary.GetInProgressTVShows

Retrieve all in progress tvshows
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Video.Details.TVShow[] tvshows ]

JSON Schema Description

{ "description": "Retrieve all in progress tvshows", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Video.Fields.TVShow", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "tvshows": { "items": { "$ref": "Video.Details.TVShow" }, "type": "array", "required": false } } } }

VideoLibrary.GetMovieDetails

Retrieve details about a specific movie
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• [ Video.Details.Movie moviedetails ]

JSON Schema Description
{ "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", "required": false } ], "returns": { "type": "object", "properties": { "moviedetails": { "$ref": "Video.Details.Movie", "required": false } } } }

VideoLibrary.GetMovies

Retrieve all movies
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Video.Details.Movie[] movies ]

JSON Schema Description

{ "description": "Retrieve all movies", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Video.Fields.Movie", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false }, { "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", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "movies": { "items": { "$ref": "Video.Details.Movie" }, "type": "array", "required": false } } } }

VideoLibrary.GetMovieSetDetails

Retrieve details about a specific movie set
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• [ Video.Details.MovieSet.Extended setdetails ]

JSON Schema Description

{ "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", "required": false }, { "type": "object", "name": "movies", "required": false } ], "returns": { "type": "object", "properties": { "setdetails": { "$ref": "Video.Details.MovieSet.Extended", "required": false } } } }

VideoLibrary.GetMovieSets

Retrieve all movie sets
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Video.Details.MovieSet[] sets ]

JSON Schema Description

{ "description": "Retrieve all movie sets", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Video.Fields.MovieSet", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "sets": { "items": { "$ref": "Video.Details.MovieSet" }, "type": "array", "required": false } } } }

VideoLibrary.GetMusicVideoDetails

Retrieve details about a specific music video
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• [ Video.Details.MusicVideo musicvideodetails ]

JSON Schema Description

{ "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", "required": false } ], "returns": { "type": "object", "properties": { "musicvideodetails": { "$ref": "Video.Details.MusicVideo", "required": false } } } }

VideoLibrary.GetMusicVideos

Retrieve all music videos
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Video.Details.MusicVideo[] musicvideos ]

JSON Schema Description

{ "description": "Retrieve all music videos", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Video.Fields.MusicVideo", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false }, { "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", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "musicvideos": { "items": { "$ref": "Video.Details.MusicVideo" }, "type": "array", "required": false } } } }

VideoLibrary.GetRecentlyAddedEpisodes

Retrieve all recently added tv episodes
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• [ Video.Details.Episode[] episodes ]
• List.LimitsReturned limits

JSON Schema Description

{ "description": "Retrieve all recently added tv episodes", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Video.Fields.Episode", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "episodes": { "items": { "$ref": "Video.Details.Episode" }, "type": "array", "required": false }, "limits": { "$ref": "List.LimitsReturned", "required": true } } } }

VideoLibrary.GetRecentlyAddedMovies

Retrieve all recently added movies
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Video.Details.Movie[] movies ]

JSON Schema Description

{ "description": "Retrieve all recently added movies", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Video.Fields.Movie", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "movies": { "items": { "$ref": "Video.Details.Movie" }, "type": "array", "required": false } } } }

VideoLibrary.GetRecentlyAddedMusicVideos

Retrieve all recently added music videos
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Video.Details.MusicVideo[] musicvideos ]

JSON Schema Description

{ "description": "Retrieve all recently added music videos", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Video.Fields.MusicVideo", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "musicvideos": { "items": { "$ref": "Video.Details.MusicVideo" }, "type": "array", "required": false } } } }

VideoLibrary.GetSeasonDetails

Retrieve details about a specific tv show season
Permissions:

• ReadData

Parameters:

1. Library.Id seasonid
2. [ Video.Fields.Season properties ]

Returns:

Type: object
Properties:

• [ Video.Details.Season seasondetails ]

JSON Schema Description
{ "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", "required": false } ], "returns": { "type": "object", "properties": { "seasondetails": { "$ref": "Video.Details.Season", "required": false } } } }

VideoLibrary.GetSeasons

Retrieve all tv seasons
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Video.Details.Season[] seasons ]

JSON Schema Description

{ "description": "Retrieve all tv seasons", "permission": "ReadData", "type": "method", "params": [ { "default": "-1", "$ref": "Library.Id", "name": "tvshowid", "required": false }, { "$ref": "Video.Fields.Season", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "seasons": { "items": { "$ref": "Video.Details.Season" }, "type": "array", "required": false } } } }

VideoLibrary.GetTags

Retrieve all tags
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• Library.Details.Tag[] tags

JSON Schema Description

{ "description": "Retrieve all tags", "permission": "ReadData", "type": "method", "params": [ { "type": "string", "name": "type", "required": true }, { "$ref": "Library.Fields.Tag", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "tags": { "items": { "$ref": "Library.Details.Tag" }, "type": "array", "required": true } } } }

VideoLibrary.GetTVShowDetails

Retrieve details about a specific tv show
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• [ Video.Details.TVShow tvshowdetails ]

JSON Schema Description
{ "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", "required": false } ], "returns": { "type": "object", "properties": { "tvshowdetails": { "$ref": "Video.Details.TVShow", "required": false } } } }

VideoLibrary.GetTVShows

Retrieve all tv shows
Permissions:

• ReadData

Parameters:

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

Returns:

Type: object
Properties:

• List.LimitsReturned limits
• [ Video.Details.TVShow[] tvshows ]

JSON Schema Description

{ "description": "Retrieve all tv shows", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Video.Fields.TVShow", "name": "properties", "required": false }, { "$ref": "List.Limits", "name": "limits", "required": false }, { "$ref": "List.Sort", "name": "sort", "required": false }, { "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", "required": false } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "tvshows": { "items": { "$ref": "Video.Details.TVShow" }, "type": "array", "required": false } } } }

VideoLibrary.RefreshEpisode

Refresh the given episode in the library
Permissions:

• UpdateData

Parameters:

1. Library.Id episodeid
2. [ boolean ignorenfo = false ]
3. [ string title ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "default": "", "description": "Title to use for searching (instead of determining it from the item's filename/path).", "type": "string", "name": "title", "required": false } ], "returns": { "type": "string" } }

VideoLibrary.RefreshMovie

Refresh the given movie in the library
Permissions:

• UpdateData

Parameters:

1. Library.Id movieid
2. [ boolean ignorenfo = false ]
3. [ string title ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "default": "", "description": "Title to use for searching (instead of determining it from the item's filename/path).", "type": "string", "name": "title", "required": false } ], "returns": { "type": "string" } }

VideoLibrary.RefreshMusicVideo

Refresh the given music video in the library
Permissions:

• UpdateData

Parameters:

1. Library.Id musicvideoid
2. [ boolean ignorenfo = false ]
3. [ string title ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "default": "", "description": "Title to use for searching (instead of determining it from the item's filename/path).", "type": "string", "name": "title", "required": false } ], "returns": { "type": "string" } }

VideoLibrary.RefreshTVShow

Refresh the given tv show in the library
Permissions:

• UpdateData

Parameters:

1. Library.Id tvshowid
2. [ boolean ignorenfo = false ]
3. [ boolean refreshepisodes = false ]
4. [ string title ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "default": "false", "description": "Whether or not to refresh all episodes belonging to the TV show.", "type": "boolean", "name": "refreshepisodes", "required": false }, { "default": "", "description": "Title to use for searching (instead of determining it from the item's filename/path).", "type": "string", "name": "title", "required": false } ], "returns": { "type": "string" } }

VideoLibrary.RemoveEpisode

Removes the given episode from the library
Permissions:

• RemoveData

Parameters:

1. Library.Id episodeid

Returns:

Type: string

JSON Schema Description
{ "description": "Removes the given episode from the library", "permission": "RemoveData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "episodeid", "required": true } ], "returns": { "type": "string" } }

VideoLibrary.RemoveMovie

Removes the given movie from the library
Permissions:

• RemoveData

Parameters:

1. Library.Id movieid

Returns:

Type: string

JSON Schema Description
{ "description": "Removes the given movie from the library", "permission": "RemoveData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "movieid", "required": true } ], "returns": { "type": "string" } }

VideoLibrary.RemoveMusicVideo

Removes the given music video from the library
Permissions:

• RemoveData

Parameters:

1. Library.Id musicvideoid

Returns:

Type: string

JSON Schema Description
{ "description": "Removes the given music video from the library", "permission": "RemoveData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "musicvideoid", "required": true } ], "returns": { "type": "string" } }

VideoLibrary.RemoveTVShow

Removes the given tv show from the library
Permissions:

• RemoveData

Parameters:

1. Library.Id tvshowid

Returns:

Type: string

JSON Schema Description
{ "description": "Removes the given tv show from the library", "permission": "RemoveData", "type": "method", "params": [ { "$ref": "Library.Id", "name": "tvshowid", "required": true } ], "returns": { "type": "string" } }

VideoLibrary.Scan

Scans the video sources for new library items
Permissions:

• UpdateData

Parameters:

1. [ string directory ]
2. [ boolean showdialogs = true ]

Returns:

Type: string

JSON Schema Description

{ "description": "Scans the video sources for new library items", "permission": "UpdateData", "type": "method", "params": [ { "default": "", "type": "string", "name": "directory", "required": false }, { "default": "true", "description": "Whether or not to show the progress bar or any other GUI dialog", "type": "boolean", "name": "showdialogs", "required": false } ], "returns": { "type": "string" } }

VideoLibrary.SetEpisodeDetails

Update the given episode with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id episodeid
2. [ Optional.String title ]
3. [ Optional.Integer playcount ]
4. [ Optional.Integer runtime ]
5. [ mixed director ]
6. [ Optional.String plot ]
7. [ Optional.Number rating ]
8. [ Optional.String votes ]
9. [ Optional.String lastplayed ]
10. [ mixed writer ]
11. [ Optional.String firstaired ]
12. [ Optional.String productioncode ]
13. [ Optional.Integer season ]
14. [ Optional.Integer episode ]
15. [ Optional.String originaltitle ]
16. [ Optional.String thumbnail ]
17. [ Optional.String fanart ]
18. [ mixed art ]
19. [ mixed resume ]
20. [ Optional.Integer userrating ]
21. [ Video.Ratings.Set ratings ]
22. [ Optional.String dateadded ]
23. [ mixed uniqueid ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "$ref": "Optional.Integer", "name": "playcount", "required": false }, { "description": "Runtime in seconds", "$ref": "Optional.Integer", "name": "runtime", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "director", "required": false }, { "$ref": "Optional.String", "name": "plot", "required": false }, { "$ref": "Optional.Number", "name": "rating", "required": false }, { "$ref": "Optional.String", "name": "votes", "required": false }, { "$ref": "Optional.String", "name": "lastplayed", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "writer", "required": false }, { "$ref": "Optional.String", "name": "firstaired", "required": false }, { "$ref": "Optional.String", "name": "productioncode", "required": false }, { "$ref": "Optional.Integer", "name": "season", "required": false }, { "$ref": "Optional.Integer", "name": "episode", "required": false }, { "$ref": "Optional.String", "name": "originaltitle", "required": false }, { "$ref": "Optional.String", "name": "thumbnail", "required": false }, { "$ref": "Optional.String", "name": "fanart", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ], "name": "art", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Video.Resume" } ], "name": "resume", "required": false }, { "$ref": "Optional.Integer", "name": "userrating", "required": false }, { "$ref": "Video.Ratings.Set", "name": "ratings", "required": false }, { "$ref": "Optional.String", "name": "dateadded", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Media.UniqueID.Set" } ], "name": "uniqueid", "required": false } ], "returns": { "type": "string" } }

VideoLibrary.SetMovieDetails

Update the given movie with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id movieid
2. [ Optional.String title ]
3. [ Optional.Integer playcount ]
4. [ Optional.Integer runtime ]
5. [ mixed director ]
6. [ mixed studio ]
7. [ Optional.Integer year ]
8. [ Optional.String plot ]
9. [ mixed genre ]
10. [ Optional.Number rating ]
11. [ Optional.String mpaa ]
12. [ Optional.String imdbnumber ]
13. [ Optional.String votes ]
14. [ Optional.String lastplayed ]
15. [ Optional.String originaltitle ]
16. [ Optional.String trailer ]
17. [ Optional.String tagline ]
18. [ Optional.String plotoutline ]
19. [ mixed writer ]
20. [ mixed country ]
21. [ Optional.Integer top250 ]
22. [ Optional.String sorttitle ]
23. [ Optional.String set ]
24. [ mixed showlink ]
25. [ Optional.String thumbnail ]
26. [ Optional.String fanart ]
27. [ mixed tag ]
28. [ mixed art ]
29. [ mixed resume ]
30. [ Optional.Integer userrating ]
31. [ Video.Ratings.Set ratings ]
32. [ Optional.String dateadded ]
33. [ Optional.String premiered ]
34. [ mixed uniqueid ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "$ref": "Optional.Integer", "name": "playcount", "required": false }, { "description": "Runtime in seconds", "$ref": "Optional.Integer", "name": "runtime", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "director", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "studio", "required": false }, { "description": "linked with premiered. Overridden by premiered parameter", "$ref": "Optional.Integer", "name": "year", "required": false }, { "$ref": "Optional.String", "name": "plot", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "genre", "required": false }, { "$ref": "Optional.Number", "name": "rating", "required": false }, { "$ref": "Optional.String", "name": "mpaa", "required": false }, { "$ref": "Optional.String", "name": "imdbnumber", "required": false }, { "$ref": "Optional.String", "name": "votes", "required": false }, { "$ref": "Optional.String", "name": "lastplayed", "required": false }, { "$ref": "Optional.String", "name": "originaltitle", "required": false }, { "$ref": "Optional.String", "name": "trailer", "required": false }, { "$ref": "Optional.String", "name": "tagline", "required": false }, { "$ref": "Optional.String", "name": "plotoutline", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "writer", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "country", "required": false }, { "$ref": "Optional.Integer", "name": "top250", "required": false }, { "$ref": "Optional.String", "name": "sorttitle", "required": false }, { "$ref": "Optional.String", "name": "set", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "showlink", "required": false }, { "$ref": "Optional.String", "name": "thumbnail", "required": false }, { "$ref": "Optional.String", "name": "fanart", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "tag", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ], "name": "art", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Video.Resume" } ], "name": "resume", "required": false }, { "$ref": "Optional.Integer", "name": "userrating", "required": false }, { "$ref": "Video.Ratings.Set", "name": "ratings", "required": false }, { "$ref": "Optional.String", "name": "dateadded", "required": false }, { "description": "linked with year. Overriedes year", "$ref": "Optional.String", "name": "premiered", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Media.UniqueID.Set" } ], "name": "uniqueid", "required": false } ], "returns": { "type": "string" } }

VideoLibrary.SetMovieSetDetails

Update the given movie set with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id setid
2. [ Optional.String title ]
3. [ mixed art ]

Returns:

Type: string

JSON Schema Description
{ "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", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ], "name": "art", "required": false } ], "returns": { "type": "string" } }

VideoLibrary.SetMusicVideoDetails

Update the given music video with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id musicvideoid
2. [ Optional.String title ]
3. [ Optional.Integer playcount ]
4. [ Optional.Integer runtime ]
5. [ mixed director ]
6. [ mixed studio ]
7. [ Optional.Integer year ]
8. [ Optional.String plot ]
9. [ Optional.String album ]
10. [ mixed artist ]
11. [ mixed genre ]
12. [ Optional.Integer track ]
13. [ Optional.String lastplayed ]
14. [ Optional.String thumbnail ]
15. [ Optional.String fanart ]
16. [ mixed tag ]
17. [ mixed art ]
18. [ mixed resume ]
19. [ Optional.Number rating ]
20. [ Optional.Integer userrating ]
21. [ Optional.String dateadded ]
22. [ Optional.String premiered ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "$ref": "Optional.Integer", "name": "playcount", "required": false }, { "description": "Runtime in seconds", "$ref": "Optional.Integer", "name": "runtime", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "director", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "studio", "required": false }, { "description": "linked with premiered. Overridden by premiered parameter", "$ref": "Optional.Integer", "name": "year", "required": false }, { "$ref": "Optional.String", "name": "plot", "required": false }, { "$ref": "Optional.String", "name": "album", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "artist", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "genre", "required": false }, { "$ref": "Optional.Integer", "name": "track", "required": false }, { "$ref": "Optional.String", "name": "lastplayed", "required": false }, { "$ref": "Optional.String", "name": "thumbnail", "required": false }, { "$ref": "Optional.String", "name": "fanart", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "tag", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ], "name": "art", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Video.Resume" } ], "name": "resume", "required": false }, { "$ref": "Optional.Number", "name": "rating", "required": false }, { "$ref": "Optional.Integer", "name": "userrating", "required": false }, { "$ref": "Optional.String", "name": "dateadded", "required": false }, { "description": "linked with year. Overriedes year", "$ref": "Optional.String", "name": "premiered", "required": false } ], "returns": { "type": "string" } }

VideoLibrary.SetSeasonDetails

Update the given season with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id seasonid
2. [ mixed art ]
3. [ Optional.Integer userrating ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "$ref": "Optional.Integer", "name": "userrating", "required": false } ], "returns": { "type": "string" } }

VideoLibrary.SetTVShowDetails

Update the given tvshow with the given details
Permissions:

• UpdateData

Parameters:

1. Library.Id tvshowid
2. [ Optional.String title ]
3. [ Optional.Integer playcount ]
4. [ mixed studio ]
5. [ Optional.String plot ]
6. [ mixed genre ]
7. [ Optional.Number rating ]
8. [ Optional.String mpaa ]
9. [ Optional.String imdbnumber ]
10. [ Optional.String premiered ]
11. [ Optional.String votes ]
12. [ Optional.String lastplayed ]
13. [ Optional.String originaltitle ]
14. [ Optional.String sorttitle ]
15. [ Optional.String episodeguide ]
16. [ Optional.String thumbnail ]
17. [ Optional.String fanart ]
18. [ mixed tag ]
19. [ mixed art ]
20. [ Optional.Integer userrating ]
21. [ Video.Ratings.Set ratings ]
22. [ Optional.String dateadded ]
23. [ Optional.Integer runtime ]
24. [ Optional.String status ]
25. [ mixed uniqueid ]

Returns:

Type: string

JSON Schema Description

{ "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", "required": false }, { "$ref": "Optional.Integer", "name": "playcount", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "studio", "required": false }, { "$ref": "Optional.String", "name": "plot", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "genre", "required": false }, { "$ref": "Optional.Number", "name": "rating", "required": false }, { "$ref": "Optional.String", "name": "mpaa", "required": false }, { "$ref": "Optional.String", "name": "imdbnumber", "required": false }, { "$ref": "Optional.String", "name": "premiered", "required": false }, { "$ref": "Optional.String", "name": "votes", "required": false }, { "$ref": "Optional.String", "name": "lastplayed", "required": false }, { "$ref": "Optional.String", "name": "originaltitle", "required": false }, { "$ref": "Optional.String", "name": "sorttitle", "required": false }, { "$ref": "Optional.String", "name": "episodeguide", "required": false }, { "$ref": "Optional.String", "name": "thumbnail", "required": false }, { "$ref": "Optional.String", "name": "fanart", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Array.String" } ], "name": "tag", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Media.Artwork.Set" } ], "name": "art", "required": false }, { "$ref": "Optional.Integer", "name": "userrating", "required": false }, { "$ref": "Video.Ratings.Set", "name": "ratings", "required": false }, { "$ref": "Optional.String", "name": "dateadded", "required": false }, { "description": "Runtime in seconds", "$ref": "Optional.Integer", "name": "runtime", "required": false }, { "$ref": "Optional.String", "name": "status", "required": false }, { "type": [ { "type": "null" }, { "$ref": "Media.UniqueID.Set" } ], "name": "uniqueid", "required": false } ], "returns": { "type": "string" } }

XBMC

XBMC.GetInfoBooleans

Retrieve info booleans about Kodi and the system
Permissions:

• ReadData

Parameters:

1. [[#|]][] booleans

Returns:

Type: object

JSON Schema Description
{ "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" } } }

XBMC.GetInfoLabels

Retrieve info labels about Kodi and the system
Permissions:

• ReadData

Parameters:

1. [[#|]][] labels

Returns:

Type: object

JSON Schema Description

{ "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" } } }