User:Ronie: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 7: Line 7:




= JSON-RPC 2.0 compatibility =
JSON-RPC 2.0 compatibility  
{| class="prettytable" style="margin-right: 0;"
{| class="prettytable" style="margin-right: 0;"
!style="padding-left: 5px; width: 7em; text-align: left;"|Version
!style="padding-left: 5px; width: 7em; text-align: left;"|Version
Line 27: Line 27:
|}
|}


= Documentation (JSON Schema) =
Documentation (JSON Schema)  
= Supported features of JSON Schema =
Supported features of JSON Schema  
<div style="float:left; margin-right:2em">
<div style="float:left; margin-right:2em">
{| class="prettytable" style="margin-right: 0;"
{| class="prettytable" style="margin-right: 0;"
Line 147: Line 147:
<div style="clear:left;"></div>
<div style="clear:left;"></div>


= Error message =
Error message  
If Kodi detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is
If Kodi detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is
{|
{|
Line 175: Line 175:
|}
|}


= Namespaces =
Namespaces  
The Kodi JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:
The Kodi JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:
{|
{|
Line 200: Line 200:
|}
|}


= Methods =
Methods  
= Addons =
Addons  
= Addons.ExecuteAddon =
Addons.ExecuteAddon  
Executes the given addon with the given parameters (if possible)<br />
Executes the given addon with the given parameters (if possible)<br />
'''Permissions:'''
'''Permissions:'''
Line 259: Line 259:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Addons.GetAddonDetails =
Addons.GetAddonDetails  
Gets the details of a specific addon<br />
Gets the details of a specific addon<br />
'''Permissions:'''
'''Permissions:'''
Line 307: Line 307:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Addons.GetAddons =
Addons.GetAddons  
Gets all available addons<br />
Gets all available addons<br />
'''Permissions:'''
'''Permissions:'''
Line 399: Line 399:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Addons.SetAddonEnabled =
Addons.SetAddonEnabled  
Enables/Disables a specific addon<br />
Enables/Disables a specific addon<br />
'''Permissions:'''
'''Permissions:'''
Line 433: Line 433:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Application =
Application  
= Application.GetProperties =
Application.GetProperties  
Retrieves the values of the given properties<br />
Retrieves the values of the given properties<br />
'''Permissions:'''
'''Permissions:'''
Line 469: Line 469:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Application.Quit =
Application.Quit  
Quit application<br />
Quit application<br />
'''Permissions:'''
'''Permissions:'''
Line 487: Line 487:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Application.SetMute =
Application.SetMute  
Toggle mute/unmute<br />
Toggle mute/unmute<br />
'''Permissions:'''
'''Permissions:'''
Line 518: Line 518:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Application.SetVolume =
Application.SetVolume  
Set the current volume<br />
Set the current volume<br />
'''Permissions:'''
'''Permissions:'''
Line 557: Line 557:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary =
AudioLibrary  
= AudioLibrary.Clean =
AudioLibrary.Clean  
Cleans the audio library from non-existent items<br />
Cleans the audio library from non-existent items<br />
'''Permissions:'''
'''Permissions:'''
Line 587: Line 587:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.Export =
AudioLibrary.Export  
Exports all items from the audio library<br />
Exports all items from the audio library<br />
'''Permissions:'''
'''Permissions:'''
Line 645: Line 645:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.GetAlbumDetails =
AudioLibrary.GetAlbumDetails  
Retrieve details about a specific album<br />
Retrieve details about a specific album<br />
'''Permissions:'''
'''Permissions:'''
Line 687: Line 687:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.GetAlbums =
AudioLibrary.GetAlbums  
Retrieve all albums from specified artist (and role) or that has songs of the specified genre<br />
Retrieve all albums from specified artist (and role) or that has songs of the specified genre<br />
'''Permissions:'''
'''Permissions:'''
Line 867: Line 867:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.GetArtistDetails =
AudioLibrary.GetArtistDetails  
Retrieve details about a specific artist<br />
Retrieve details about a specific artist<br />
'''Permissions:'''
'''Permissions:'''
Line 909: Line 909:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.GetArtists =
AudioLibrary.GetArtists  
Retrieve all artists. For backward compatibility by default this implicity does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true<br />
Retrieve all artists. For backward compatibility by default this implicity does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true<br />
'''Permissions:'''
'''Permissions:'''
Line 1,174: Line 1,174:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.GetGenres =
AudioLibrary.GetGenres  
Retrieve all genres<br />
Retrieve all genres<br />
'''Permissions:'''
'''Permissions:'''
Line 1,229: Line 1,229:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.GetProperties =
AudioLibrary.GetProperties  
Retrieves the values of the music library properties<br />
Retrieves the values of the music library properties<br />
'''Permissions:'''
'''Permissions:'''
Line 1,264: Line 1,264:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.GetRecentlyAddedAlbums =
AudioLibrary.GetRecentlyAddedAlbums  
Retrieve recently added albums<br />
Retrieve recently added albums<br />
'''Permissions:'''
'''Permissions:'''
Line 1,318: Line 1,318:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.GetRecentlyAddedSongs =
AudioLibrary.GetRecentlyAddedSongs  
Retrieve recently added songs<br />
Retrieve recently added songs<br />
'''Permissions:'''
'''Permissions:'''
Line 1,378: Line 1,378:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.GetRecentlyPlayedAlbums =
AudioLibrary.GetRecentlyPlayedAlbums  
Retrieve recently played albums<br />
Retrieve recently played albums<br />
'''Permissions:'''
'''Permissions:'''
Line 1,432: Line 1,432:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.GetRecentlyPlayedSongs =
AudioLibrary.GetRecentlyPlayedSongs  
Retrieve recently played songs<br />
Retrieve recently played songs<br />
'''Permissions:'''
'''Permissions:'''
Line 1,486: Line 1,486:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.GetRoles =
AudioLibrary.GetRoles  
Retrieve all contributor roles<br />
Retrieve all contributor roles<br />
'''Permissions:'''
'''Permissions:'''
Line 1,541: Line 1,541:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.GetSongDetails =
AudioLibrary.GetSongDetails  
Retrieve details about a specific song<br />
Retrieve details about a specific song<br />
'''Permissions:'''
'''Permissions:'''
Line 1,583: Line 1,583:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.GetSongs =
AudioLibrary.GetSongs  
Retrieve all songs from specified album, artist or genre<br />
Retrieve all songs from specified album, artist or genre<br />
'''Permissions:'''
'''Permissions:'''
Line 1,792: Line 1,792:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.GetSources =
AudioLibrary.GetSources  
Get all music sources, including unique ID<br />
Get all music sources, including unique ID<br />
'''Permissions:'''
'''Permissions:'''
Line 1,847: Line 1,847:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.Scan =
AudioLibrary.Scan  
Scans the audio sources for new library items<br />
Scans the audio sources for new library items<br />
'''Permissions:'''
'''Permissions:'''
Line 1,882: Line 1,882:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.SetAlbumDetails =
AudioLibrary.SetAlbumDetails  
Update the given album with the given details<br />
Update the given album with the given details<br />
'''Permissions:'''
'''Permissions:'''
Line 2,069: Line 2,069:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.SetArtistDetails =
AudioLibrary.SetArtistDetails  
Update the given artist with the given details<br />
Update the given artist with the given details<br />
'''Permissions:'''
'''Permissions:'''
Line 2,224: Line 2,224:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.SetSongDetails =
AudioLibrary.SetSongDetails  
Update the given song with the given details<br />
Update the given song with the given details<br />
'''Permissions:'''
'''Permissions:'''
Line 2,388: Line 2,388:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Favourites =
Favourites  
= Favourites.AddFavourite =
Favourites.AddFavourite  
Add a favourite with the given details<br />
Add a favourite with the given details<br />
'''Permissions:'''
'''Permissions:'''
Line 2,445: Line 2,445:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Favourites.GetFavourites =
Favourites.GetFavourites  
Retrieve all favourites<br />
Retrieve all favourites<br />
'''Permissions:'''
'''Permissions:'''
Line 2,500: Line 2,500:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Files =
Files  
= Files.Download =
Files.Download  
Downloads the given file<br />
Downloads the given file<br />
'''Permissions:'''
'''Permissions:'''
Line 2,535: Line 2,535:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Files.GetDirectory =
Files.GetDirectory  
Get the directories and files in the given directory<br />
Get the directories and files in the given directory<br />
'''Permissions:'''
'''Permissions:'''
Line 2,603: Line 2,603:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Files.GetFileDetails =
Files.GetFileDetails  
Get details for a specific file<br />
Get details for a specific file<br />
'''Permissions:'''
'''Permissions:'''
Line 2,653: Line 2,653:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Files.GetSources =
Files.GetSources  
Get the sources of the media windows<br />
Get the sources of the media windows<br />
'''Permissions:'''
'''Permissions:'''
Line 2,706: Line 2,706:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Files.PrepareDownload =
Files.PrepareDownload  
Provides a way to download a given file (e.g. providing an URL to the real file location)<br />
Provides a way to download a given file (e.g. providing an URL to the real file location)<br />
'''Permissions:'''
'''Permissions:'''
Line 2,766: Line 2,766:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Files.SetFileDetails =
Files.SetFileDetails  
Update the given specific file with the given details<br />
Update the given specific file with the given details<br />
'''Permissions:'''
'''Permissions:'''
Line 2,825: Line 2,825:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= GUI =
GUI  
= GUI.ActivateWindow =
GUI.ActivateWindow  
Activates the given window<br />
Activates the given window<br />
'''Permissions:'''
'''Permissions:'''
Line 2,865: Line 2,865:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= GUI.GetProperties =
GUI.GetProperties  
Retrieves the values of the given properties<br />
Retrieves the values of the given properties<br />
'''Permissions:'''
'''Permissions:'''
Line 2,900: Line 2,900:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= GUI.GetStereoscopicModes =
GUI.GetStereoscopicModes  
Returns the supported stereoscopic modes of the GUI<br />
Returns the supported stereoscopic modes of the GUI<br />
'''Permissions:'''
'''Permissions:'''
Line 2,931: Line 2,931:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= GUI.SetFullscreen =
GUI.SetFullscreen  
Toggle fullscreen/GUI<br />
Toggle fullscreen/GUI<br />
'''Permissions:'''
'''Permissions:'''
Line 2,962: Line 2,962:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= GUI.SetStereoscopicMode =
GUI.SetStereoscopicMode  
Sets the stereoscopic mode of the GUI to the given mode<br />
Sets the stereoscopic mode of the GUI to the given mode<br />
'''Permissions:'''
'''Permissions:'''
Line 3,005: Line 3,005:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= GUI.ShowNotification =
GUI.ShowNotification  
Shows a GUI notification<br />
Shows a GUI notification<br />
'''Permissions:'''
'''Permissions:'''
Line 3,067: Line 3,067:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input =
Input  
= Input.Back =
Input.Back  
Goes back in GUI<br />
Goes back in GUI<br />
'''Permissions:'''
'''Permissions:'''
Line 3,086: Line 3,086:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input.ButtonEvent =
Input.ButtonEvent  
Send a button press event<br />
Send a button press event<br />
'''Permissions:'''
'''Permissions:'''
Line 3,137: Line 3,137:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input.ContextMenu =
Input.ContextMenu  
Shows the context menu<br />
Shows the context menu<br />
'''Permissions:'''
'''Permissions:'''
Line 3,155: Line 3,155:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input.Down =
Input.Down  
Navigate down in GUI<br />
Navigate down in GUI<br />
'''Permissions:'''
'''Permissions:'''
Line 3,173: Line 3,173:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input.ExecuteAction =
Input.ExecuteAction  
Execute a specific action<br />
Execute a specific action<br />
'''Permissions:'''
'''Permissions:'''
Line 3,201: Line 3,201:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input.Home =
Input.Home  
Goes to home window in GUI<br />
Goes to home window in GUI<br />
'''Permissions:'''
'''Permissions:'''
Line 3,219: Line 3,219:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input.Info =
Input.Info  
Shows the information dialog<br />
Shows the information dialog<br />
'''Permissions:'''
'''Permissions:'''
Line 3,237: Line 3,237:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input.Left =
Input.Left  
Navigate left in GUI<br />
Navigate left in GUI<br />
'''Permissions:'''
'''Permissions:'''
Line 3,255: Line 3,255:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input.Right =
Input.Right  
Navigate right in GUI<br />
Navigate right in GUI<br />
'''Permissions:'''
'''Permissions:'''
Line 3,273: Line 3,273:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input.Select =
Input.Select  
Select current item in GUI<br />
Select current item in GUI<br />
'''Permissions:'''
'''Permissions:'''
Line 3,291: Line 3,291:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input.SendText =
Input.SendText  
Send a generic (unicode) text<br />
Send a generic (unicode) text<br />
'''Permissions:'''
'''Permissions:'''
Line 3,327: Line 3,327:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input.ShowCodec =
Input.ShowCodec  
Show codec information of the playing item<br />
Show codec information of the playing item<br />
'''Permissions:'''
'''Permissions:'''
Line 3,345: Line 3,345:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input.ShowOSD =
Input.ShowOSD  
Show the on-screen display for the current player<br />
Show the on-screen display for the current player<br />
'''Permissions:'''
'''Permissions:'''
Line 3,363: Line 3,363:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input.ShowPlayerProcessInfo =
Input.ShowPlayerProcessInfo  
Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...<br />
Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...<br />
'''Permissions:'''
'''Permissions:'''
Line 3,381: Line 3,381:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input.Up =
Input.Up  
Navigate up in GUI<br />
Navigate up in GUI<br />
'''Permissions:'''
'''Permissions:'''
Line 3,399: Line 3,399:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= JSONRPC =
JSONRPC  
= JSONRPC.GetConfiguration =
JSONRPC.GetConfiguration  
Get client-specific configurations<br />
Get client-specific configurations<br />
'''Permissions:'''
'''Permissions:'''
Line 3,420: Line 3,420:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= JSONRPC.Introspect =
JSONRPC.Introspect  
Enumerates all actions and descriptions<br />
Enumerates all actions and descriptions<br />
'''Permissions:'''
'''Permissions:'''
Line 3,488: Line 3,488:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= JSONRPC.NotifyAll =
JSONRPC.NotifyAll  
Notify all other connected clients<br />
Notify all other connected clients<br />
'''Permissions:'''
'''Permissions:'''
Line 3,528: Line 3,528:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= JSONRPC.Permission =
JSONRPC.Permission  
Retrieve the clients permissions<br />
Retrieve the clients permissions<br />
'''Permissions:'''
'''Permissions:'''
Line 3,616: Line 3,616:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= JSONRPC.Ping =
JSONRPC.Ping  
Ping responder<br />
Ping responder<br />
'''Permissions:'''
'''Permissions:'''
Line 3,634: Line 3,634:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= JSONRPC.SetConfiguration =
JSONRPC.SetConfiguration  
Change the client-specific configuration<br />
Change the client-specific configuration<br />
'''Permissions:'''
'''Permissions:'''
Line 3,692: Line 3,692:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= JSONRPC.Version =
JSONRPC.Version  
Retrieve the JSON-RPC protocol version.<br />
Retrieve the JSON-RPC protocol version.<br />
'''Permissions:'''
'''Permissions:'''
Line 3,740: Line 3,740:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR =
PVR  
= PVR.AddTimer =
PVR.AddTimer  
Adds a timer to record the given show one times or a timer rule to record all showings of the given show<br />
Adds a timer to record the given show one times or a timer rule to record all showings of the given show<br />
'''Permissions:'''
'''Permissions:'''
Line 3,777: Line 3,777:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.DeleteTimer =
PVR.DeleteTimer  
Deletes a onetime timer or a timer rule<br />
Deletes a onetime timer or a timer rule<br />
'''Permissions:'''
'''Permissions:'''
Line 3,806: Line 3,806:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.GetBroadcastDetails =
PVR.GetBroadcastDetails  
Retrieves the details of a specific broadcast<br />
Retrieves the details of a specific broadcast<br />
'''Permissions:'''
'''Permissions:'''
Line 3,848: Line 3,848:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.GetBroadcasts =
PVR.GetBroadcasts  
Retrieves the program of a specific channel<br />
Retrieves the program of a specific channel<br />
'''Permissions:'''
'''Permissions:'''
Line 3,904: Line 3,904:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.GetChannelDetails =
PVR.GetChannelDetails  
Retrieves the details of a specific channel<br />
Retrieves the details of a specific channel<br />
'''Permissions:'''
'''Permissions:'''
Line 3,946: Line 3,946:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.GetChannelGroupDetails =
PVR.GetChannelGroupDetails  
Retrieves the details of a specific channel group<br />
Retrieves the details of a specific channel group<br />
'''Permissions:'''
'''Permissions:'''
Line 3,996: Line 3,996:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.GetChannelGroups =
PVR.GetChannelGroups  
Retrieves the channel groups for the specified type<br />
Retrieves the channel groups for the specified type<br />
'''Permissions:'''
'''Permissions:'''
Line 4,047: Line 4,047:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.GetChannels =
PVR.GetChannels  
Retrieves the channel list<br />
Retrieves the channel list<br />
'''Permissions:'''
'''Permissions:'''
Line 4,103: Line 4,103:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.GetProperties =
PVR.GetProperties  
Retrieves the values of the given properties<br />
Retrieves the values of the given properties<br />
'''Permissions:'''
'''Permissions:'''
Line 4,138: Line 4,138:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.GetRecordingDetails =
PVR.GetRecordingDetails  
Retrieves the details of a specific recording<br />
Retrieves the details of a specific recording<br />
'''Permissions:'''
'''Permissions:'''
Line 4,180: Line 4,180:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.GetRecordings =
PVR.GetRecordings  
Retrieves the recordings<br />
Retrieves the recordings<br />
'''Permissions:'''
'''Permissions:'''
Line 4,230: Line 4,230:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.GetTimerDetails =
PVR.GetTimerDetails  
Retrieves the details of a specific timer<br />
Retrieves the details of a specific timer<br />
'''Permissions:'''
'''Permissions:'''
Line 4,272: Line 4,272:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.GetTimers =
PVR.GetTimers  
Retrieves the timers<br />
Retrieves the timers<br />
'''Permissions:'''
'''Permissions:'''
Line 4,322: Line 4,322:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.Record =
PVR.Record  
Toggle recording of a channel<br />
Toggle recording of a channel<br />
'''Permissions:'''
'''Permissions:'''
Line 4,368: Line 4,368:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.Scan =
PVR.Scan  
Starts a channel scan<br />
Starts a channel scan<br />
'''Permissions:'''
'''Permissions:'''
Line 4,386: Line 4,386:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.ToggleTimer =
PVR.ToggleTimer  
Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created<br />
Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created<br />
'''Permissions:'''
'''Permissions:'''
Line 4,422: Line 4,422:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player =
Player  
= Player.GetActivePlayers =
Player.GetActivePlayers  
Returns all active players<br />
Returns all active players<br />
'''Permissions:'''
'''Permissions:'''
Line 4,466: Line 4,466:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.GetItem =
Player.GetItem  
Retrieves the currently played item<br />
Retrieves the currently played item<br />
'''Permissions:'''
'''Permissions:'''
Line 4,509: Line 4,509:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.GetPlayers =
Player.GetPlayers  
Get a list of available players<br />
Get a list of available players<br />
'''Permissions:'''
'''Permissions:'''
Line 4,571: Line 4,571:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.GetProperties =
Player.GetProperties  
Retrieves the values of the given properties<br />
Retrieves the values of the given properties<br />
'''Permissions:'''
'''Permissions:'''
Line 4,612: Line 4,612:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.GetViewMode =
Player.GetViewMode  
Get view mode of video player<br />
Get view mode of video player<br />
'''Permissions:'''
'''Permissions:'''
Line 4,660: Line 4,660:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.GoTo =
Player.GoTo  
Go to previous/next/specific item in the playlist<br />
Go to previous/next/specific item in the playlist<br />
'''Permissions:'''
'''Permissions:'''
Line 4,708: Line 4,708:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Move =
Player.Move  
If picture is zoomed move viewport left/right/up/down otherwise skip previous/next<br />
If picture is zoomed move viewport left/right/up/down otherwise skip previous/next<br />
'''Permissions:'''
'''Permissions:'''
Line 4,748: Line 4,748:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Open =
Player.Open  
Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.<br />
Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.<br />
'''Permissions:'''
'''Permissions:'''
Line 4,922: Line 4,922:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.PlayPause =
Player.PlayPause  
Pauses or unpause playback and returns the new state<br />
Pauses or unpause playback and returns the new state<br />
'''Permissions:'''
'''Permissions:'''
Line 4,958: Line 4,958:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Rotate =
Player.Rotate  
Rotates current picture<br />
Rotates current picture<br />
'''Permissions:'''
'''Permissions:'''
Line 4,996: Line 4,996:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Seek =
Player.Seek  
Seek through the playing item<br />
Seek through the playing item<br />
'''Permissions:'''
'''Permissions:'''
Line 5,102: Line 5,102:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.SetAudioStream =
Player.SetAudioStream  
Set the audio stream played by the player<br />
Set the audio stream played by the player<br />
'''Permissions:'''
'''Permissions:'''
Line 5,149: Line 5,149:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.SetPartymode =
Player.SetPartymode  
Turn partymode on or off<br />
Turn partymode on or off<br />
'''Permissions:'''
'''Permissions:'''
Line 5,183: Line 5,183:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.SetRepeat =
Player.SetRepeat  
Set the repeat mode of the player<br />
Set the repeat mode of the player<br />
'''Permissions:'''
'''Permissions:'''
Line 5,229: Line 5,229:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.SetShuffle =
Player.SetShuffle  
Shuffle/Unshuffle items in the player<br />
Shuffle/Unshuffle items in the player<br />
'''Permissions:'''
'''Permissions:'''
Line 5,263: Line 5,263:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.SetSpeed =
Player.SetSpeed  
Set the speed of the current playback<br />
Set the speed of the current playback<br />
'''Permissions:'''
'''Permissions:'''
Line 5,323: Line 5,323:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.SetSubtitle =
Player.SetSubtitle  
Set the subtitle displayed by the player<br />
Set the subtitle displayed by the player<br />
'''Permissions:'''
'''Permissions:'''
Line 5,379: Line 5,379:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.SetVideoStream =
Player.SetVideoStream  
Set the video stream played by the player<br />
Set the video stream played by the player<br />
'''Permissions:'''
'''Permissions:'''
Line 5,426: Line 5,426:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.SetViewMode =
Player.SetViewMode  
Set view mode of video player<br />
Set view mode of video player<br />
'''Permissions:'''
'''Permissions:'''
Line 5,465: Line 5,465:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Stop =
Player.Stop  
Stops playback<br />
Stops playback<br />
'''Permissions:'''
'''Permissions:'''
Line 5,493: Line 5,493:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Zoom =
Player.Zoom  
Zoom current picture<br />
Zoom current picture<br />
'''Permissions:'''
'''Permissions:'''
Line 5,543: Line 5,543:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist =
Playlist  
= Playlist.Add =
Playlist.Add  
Add item(s) to playlist<br />
Add item(s) to playlist<br />
'''Permissions:'''
'''Permissions:'''
Line 5,590: Line 5,590:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist.Clear =
Playlist.Clear  
Clear playlist<br />
Clear playlist<br />
'''Permissions:'''
'''Permissions:'''
Line 5,618: Line 5,618:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist.GetItems =
Playlist.GetItems  
Get all items from playlist<br />
Get all items from playlist<br />
'''Permissions:'''
'''Permissions:'''
Line 5,679: Line 5,679:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist.GetPlaylists =
Playlist.GetPlaylists  
Returns all existing playlists<br />
Returns all existing playlists<br />
'''Permissions:'''
'''Permissions:'''
Line 5,713: Line 5,713:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist.GetProperties =
Playlist.GetProperties  
Retrieves the values of the given properties<br />
Retrieves the values of the given properties<br />
'''Permissions:'''
'''Permissions:'''
Line 5,754: Line 5,754:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist.Insert =
Playlist.Insert  
Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).<br />
Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
'''Permissions:'''
Line 5,806: Line 5,806:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist.Remove =
Playlist.Remove  
Remove item from playlist. Does not work for picture playlists (aka slideshows).<br />
Remove item from playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
'''Permissions:'''
Line 5,840: Line 5,840:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist.Swap =
Playlist.Swap  
Swap items in the playlist. Does not work for picture playlists (aka slideshows).<br />
Swap items in the playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
'''Permissions:'''
Line 5,880: Line 5,880:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Profiles =
Profiles  
= Profiles.GetCurrentProfile =
Profiles.GetCurrentProfile  
Retrieve the current profile<br />
Retrieve the current profile<br />
'''Permissions:'''
'''Permissions:'''
Line 5,911: Line 5,911:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Profiles.GetProfiles =
Profiles.GetProfiles  
Retrieve all profiles<br />
Retrieve all profiles<br />
'''Permissions:'''
'''Permissions:'''
Line 5,966: Line 5,966:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Profiles.LoadProfile =
Profiles.LoadProfile  
Load the specified profile<br />
Load the specified profile<br />
'''Permissions:'''
'''Permissions:'''
Line 6,006: Line 6,006:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Settings =
Settings  
= Settings.GetCategories =
Settings.GetCategories  
Retrieves all setting categories<br />
Retrieves all setting categories<br />
'''Permissions:'''
'''Permissions:'''
Line 6,064: Line 6,064:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Settings.GetSections =
Settings.GetSections  
Retrieves all setting sections<br />
Retrieves all setting sections<br />
'''Permissions:'''
'''Permissions:'''
Line 6,115: Line 6,115:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Settings.GetSettingValue =
Settings.GetSettingValue  
Retrieves the value of a setting<br />
Retrieves the value of a setting<br />
'''Permissions:'''
'''Permissions:'''
Line 6,154: Line 6,154:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Settings.GetSettings =
Settings.GetSettings  
Retrieves all settings<br />
Retrieves all settings<br />
'''Permissions:'''
'''Permissions:'''
Line 6,218: Line 6,218:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Settings.ResetSettingValue =
Settings.ResetSettingValue  
Resets the value of a setting<br />
Resets the value of a setting<br />
'''Permissions:'''
'''Permissions:'''
Line 6,247: Line 6,247:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Settings.SetSettingValue =
Settings.SetSettingValue  
Changes the value of a setting<br />
Changes the value of a setting<br />
'''Permissions:'''
'''Permissions:'''
Line 6,282: Line 6,282:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= System =
System  
= System.EjectOpticalDrive =
System.EjectOpticalDrive  
Ejects or closes the optical disc drive (if available)<br />
Ejects or closes the optical disc drive (if available)<br />
'''Permissions:'''
'''Permissions:'''
Line 6,301: Line 6,301:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= System.GetProperties =
System.GetProperties  
Retrieves the values of the given properties<br />
Retrieves the values of the given properties<br />
'''Permissions:'''
'''Permissions:'''
Line 6,336: Line 6,336:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= System.Hibernate =
System.Hibernate  
Puts the system running Kodi into hibernate mode<br />
Puts the system running Kodi into hibernate mode<br />
'''Permissions:'''
'''Permissions:'''
Line 6,354: Line 6,354:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= System.Reboot =
System.Reboot  
Reboots the system running Kodi<br />
Reboots the system running Kodi<br />
'''Permissions:'''
'''Permissions:'''
Line 6,372: Line 6,372:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= System.Shutdown =
System.Shutdown  
Shuts the system running Kodi down<br />
Shuts the system running Kodi down<br />
'''Permissions:'''
'''Permissions:'''
Line 6,390: Line 6,390:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= System.Suspend =
System.Suspend  
Suspends the system running Kodi<br />
Suspends the system running Kodi<br />
'''Permissions:'''
'''Permissions:'''
Line 6,408: Line 6,408:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Textures =
Textures  
= Textures.GetTextures =
Textures.GetTextures  
Retrieve all textures<br />
Retrieve all textures<br />
'''Permissions:'''
'''Permissions:'''
Line 6,454: Line 6,454:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Textures.RemoveTexture =
Textures.RemoveTexture  
Remove the specified texture<br />
Remove the specified texture<br />
'''Permissions:'''
'''Permissions:'''
Line 6,483: Line 6,483:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary =
VideoLibrary  
= VideoLibrary.Clean =
VideoLibrary.Clean  
Cleans the video library for non-existent items<br />
Cleans the video library for non-existent items<br />
'''Permissions:'''
'''Permissions:'''
Line 6,526: Line 6,526:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.Export =
VideoLibrary.Export  
Exports all items from the video library<br />
Exports all items from the video library<br />
'''Permissions:'''
'''Permissions:'''
Line 6,589: Line 6,589:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetEpisodeDetails =
VideoLibrary.GetEpisodeDetails  
Retrieve details about a specific tv show episode<br />
Retrieve details about a specific tv show episode<br />
'''Permissions:'''
'''Permissions:'''
Line 6,631: Line 6,631:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetEpisodes =
VideoLibrary.GetEpisodes  
Retrieve all tv show episodes<br />
Retrieve all tv show episodes<br />
'''Permissions:'''
'''Permissions:'''
Line 6,763: Line 6,763:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetGenres =
VideoLibrary.GetGenres  
Retrieve all genres<br />
Retrieve all genres<br />
'''Permissions:'''
'''Permissions:'''
Line 6,829: Line 6,829:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetInProgressTVShows =
VideoLibrary.GetInProgressTVShows  
Retrieve all in progress tvshows<br />
Retrieve all in progress tvshows<br />
'''Permissions:'''
'''Permissions:'''
Line 6,883: Line 6,883:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetMovieDetails =
VideoLibrary.GetMovieDetails  
Retrieve details about a specific movie<br />
Retrieve details about a specific movie<br />
'''Permissions:'''
'''Permissions:'''
Line 6,925: Line 6,925:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetMovieSetDetails =
VideoLibrary.GetMovieSetDetails  
Retrieve details about a specific movie set<br />
Retrieve details about a specific movie set<br />
'''Permissions:'''
'''Permissions:'''
Line 6,983: Line 6,983:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetMovieSets =
VideoLibrary.GetMovieSets  
Retrieve all movie sets<br />
Retrieve all movie sets<br />
'''Permissions:'''
'''Permissions:'''
Line 7,037: Line 7,037:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetMovies =
VideoLibrary.GetMovies  
Retrieve all movies<br />
Retrieve all movies<br />
'''Permissions:'''
'''Permissions:'''
Line 7,208: Line 7,208:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetMusicVideoDetails =
VideoLibrary.GetMusicVideoDetails  
Retrieve details about a specific music video<br />
Retrieve details about a specific music video<br />
'''Permissions:'''
'''Permissions:'''
Line 7,250: Line 7,250:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetMusicVideos =
VideoLibrary.GetMusicVideos  
Retrieve all music videos<br />
Retrieve all music videos<br />
'''Permissions:'''
'''Permissions:'''
Line 7,389: Line 7,389:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetRecentlyAddedEpisodes =
VideoLibrary.GetRecentlyAddedEpisodes  
Retrieve all recently added tv episodes<br />
Retrieve all recently added tv episodes<br />
'''Permissions:'''
'''Permissions:'''
Line 7,443: Line 7,443:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetRecentlyAddedMovies =
VideoLibrary.GetRecentlyAddedMovies  
Retrieve all recently added movies<br />
Retrieve all recently added movies<br />
'''Permissions:'''
'''Permissions:'''
Line 7,497: Line 7,497:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetRecentlyAddedMusicVideos =
VideoLibrary.GetRecentlyAddedMusicVideos  
Retrieve all recently added music videos<br />
Retrieve all recently added music videos<br />
'''Permissions:'''
'''Permissions:'''
Line 7,551: Line 7,551:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetSeasonDetails =
VideoLibrary.GetSeasonDetails  
Retrieve details about a specific tv show season<br />
Retrieve details about a specific tv show season<br />
'''Permissions:'''
'''Permissions:'''
Line 7,593: Line 7,593:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetSeasons =
VideoLibrary.GetSeasons  
Retrieve all tv seasons<br />
Retrieve all tv seasons<br />
'''Permissions:'''
'''Permissions:'''
Line 7,652: Line 7,652:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetTVShowDetails =
VideoLibrary.GetTVShowDetails  
Retrieve details about a specific tv show<br />
Retrieve details about a specific tv show<br />
'''Permissions:'''
'''Permissions:'''
Line 7,694: Line 7,694:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetTVShows =
VideoLibrary.GetTVShows  
Retrieve all tv shows<br />
Retrieve all tv shows<br />
'''Permissions:'''
'''Permissions:'''
Line 7,822: Line 7,822:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.GetTags =
VideoLibrary.GetTags  
Retrieve all tags<br />
Retrieve all tags<br />
'''Permissions:'''
'''Permissions:'''
Line 7,888: Line 7,888:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.RefreshEpisode =
VideoLibrary.RefreshEpisode  
Refresh the given episode in the library<br />
Refresh the given episode in the library<br />
'''Permissions:'''
'''Permissions:'''
Line 7,932: Line 7,932:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.RefreshMovie =
VideoLibrary.RefreshMovie  
Refresh the given movie in the library<br />
Refresh the given movie in the library<br />
'''Permissions:'''
'''Permissions:'''
Line 7,976: Line 7,976:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.RefreshMusicVideo =
VideoLibrary.RefreshMusicVideo  
Refresh the given music video in the library<br />
Refresh the given music video in the library<br />
'''Permissions:'''
'''Permissions:'''
Line 8,020: Line 8,020:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.RefreshTVShow =
VideoLibrary.RefreshTVShow  
Refresh the given tv show in the library<br />
Refresh the given tv show in the library<br />
'''Permissions:'''
'''Permissions:'''
Line 8,072: Line 8,072:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.RemoveEpisode =
VideoLibrary.RemoveEpisode  
Removes the given episode from the library<br />
Removes the given episode from the library<br />
'''Permissions:'''
'''Permissions:'''
Line 8,100: Line 8,100:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.RemoveMovie =
VideoLibrary.RemoveMovie  
Removes the given movie from the library<br />
Removes the given movie from the library<br />
'''Permissions:'''
'''Permissions:'''
Line 8,128: Line 8,128:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.RemoveMusicVideo =
VideoLibrary.RemoveMusicVideo  
Removes the given music video from the library<br />
Removes the given music video from the library<br />
'''Permissions:'''
'''Permissions:'''
Line 8,156: Line 8,156:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.RemoveTVShow =
VideoLibrary.RemoveTVShow  
Removes the given tv show from the library<br />
Removes the given tv show from the library<br />
'''Permissions:'''
'''Permissions:'''
Line 8,184: Line 8,184:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.Scan =
VideoLibrary.Scan  
Scans the video sources for new library items<br />
Scans the video sources for new library items<br />
'''Permissions:'''
'''Permissions:'''
Line 8,219: Line 8,219:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.SetEpisodeDetails =
VideoLibrary.SetEpisodeDetails  
Update the given episode with the given details<br />
Update the given episode with the given details<br />
'''Permissions:'''
'''Permissions:'''
Line 8,393: Line 8,393:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.SetMovieDetails =
VideoLibrary.SetMovieDetails  
Update the given movie with the given details<br />
Update the given movie with the given details<br />
'''Permissions:'''
'''Permissions:'''
Line 8,659: Line 8,659:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.SetMovieSetDetails =
VideoLibrary.SetMovieSetDetails  
Update the given movie set with the given details<br />
Update the given movie set with the given details<br />
'''Permissions:'''
'''Permissions:'''
Line 8,709: Line 8,709:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.SetMusicVideoDetails =
VideoLibrary.SetMusicVideoDetails  
Update the given music video with the given details<br />
Update the given music video with the given details<br />
'''Permissions:'''
'''Permissions:'''
Line 8,893: Line 8,893:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.SetSeasonDetails =
VideoLibrary.SetSeasonDetails  
Update the given season with the given details<br />
Update the given season with the given details<br />
'''Permissions:'''
'''Permissions:'''
Line 8,943: Line 8,943:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.SetTVShowDetails =
VideoLibrary.SetTVShowDetails  
Update the given tvshow with the given details<br />
Update the given tvshow with the given details<br />
'''Permissions:'''
'''Permissions:'''
Line 9,128: Line 9,128:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= XBMC =
XBMC  
= XBMC.GetInfoBooleans =
XBMC.GetInfoBooleans  
Retrieve info booleans about Kodi and the system<br />
Retrieve info booleans about Kodi and the system<br />
'''Permissions:'''
'''Permissions:'''
Line 9,167: Line 9,167:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= XBMC.GetInfoLabels =
XBMC.GetInfoLabels  
Retrieve info labels about Kodi and the system<br />
Retrieve info labels about Kodi and the system<br />
'''Permissions:'''
'''Permissions:'''
Line 9,206: Line 9,206:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Global Types =
Global Types  
= Addon =
Addon  
= Addon.Content =
Addon.Content  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 9,224: Line 9,224:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Addon.Details =
Addon.Details  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
* ''[[#Item.Details.Base|Item.Details.Base]]''
Line 9,340: Line 9,340:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Addon.Fields =
Addon.Fields  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 9,368: Line 9,368:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Application =
Application  
= Application.Property.Name =
Application.Property.Name  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 9,386: Line 9,386:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Application.Property.Value =
Application.Property.Value  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 9,461: Line 9,461:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Array =
Array  
= Array.Integer =
Array.Integer  
'''Type:''' ''array''
'''Type:''' ''array''
<br />
<br />
Line 9,473: Line 9,473:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Array.String =
Array.String  
'''Type:''' ''array''
'''Type:''' ''array''
<br />
<br />
Line 9,485: Line 9,485:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Audio =
Audio  
= Audio.Album.ReleaseType =
Audio.Album.ReleaseType  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 9,499: Line 9,499:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Audio.Artist.Roles =
Audio.Artist.Roles  
'''Type:''' ''array''
'''Type:''' ''array''
<br />
<br />
Line 9,522: Line 9,522:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Audio.Contributors =
Audio.Contributors  
'''Type:''' ''array''
'''Type:''' ''array''
<br />
<br />
Line 9,553: Line 9,553:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Audio.Details.Album =
Audio.Details.Album  
'''Extends:'''
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
Line 9,635: Line 9,635:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Audio.Details.Artist =
Audio.Details.Artist  
'''Extends:'''
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
Line 9,734: Line 9,734:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Audio.Details.Base =
Audio.Details.Base  
'''Extends:'''
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
* ''[[#Media.Details.Base|Media.Details.Base]]''
Line 9,759: Line 9,759:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Audio.Details.Genres =
Audio.Details.Genres  
'''Type:''' ''array''
'''Type:''' ''array''
<br />
<br />
Line 9,779: Line 9,779:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Audio.Details.Media =
Audio.Details.Media  
'''Extends:'''
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
Line 9,840: Line 9,840:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Audio.Details.Role =
Audio.Details.Role  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
* ''[[#Item.Details.Base|Item.Details.Base]]''
Line 9,862: Line 9,862:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Audio.Details.Song =
Audio.Details.Song  
'''Extends:'''
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
Line 9,992: Line 9,992:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Audio.Fields.Album =
Audio.Fields.Album  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 10,039: Line 10,039:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Audio.Fields.Artist =
Audio.Fields.Artist  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 10,077: Line 10,077:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Audio.Fields.Role =
Audio.Fields.Role  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 10,091: Line 10,091:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Audio.Fields.Song =
Audio.Fields.Song  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 10,151: Line 10,151:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Audio.Property.Name =
Audio.Property.Name  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 10,163: Line 10,163:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Audio.Property.Value =
Audio.Property.Value  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 10,184: Line 10,184:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Configuration =
Configuration  
= Configuration =
Configuration  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 10,204: Line 10,204:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Configuration.Notifications =
Configuration.Notifications  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 10,268: Line 10,268:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Favourite =
Favourite  
= Favourite.Details.Favourite =
Favourite.Details.Favourite  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 10,309: Line 10,309:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Favourite.Fields.Favourite =
Favourite.Fields.Favourite  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 10,326: Line 10,326:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Favourite.Type =
Favourite.Type  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 10,341: Line 10,341:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Files =
Files  
= Files.Media =
Files.Media  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 10,357: Line 10,357:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= GUI =
GUI  
= GUI.Property.Name =
GUI.Property.Name  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 10,373: Line 10,373:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= GUI.Property.Value =
GUI.Property.Value  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 10,432: Line 10,432:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= GUI.Stereoscopy.Mode =
GUI.Stereoscopy.Mode  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 10,466: Line 10,466:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Global =
Global  
= Global.IncrementDecrement =
Global.IncrementDecrement  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 10,479: Line 10,479:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Global.String.NotEmpty =
Global.String.NotEmpty  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 10,488: Line 10,488:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Global.Time =
Global.Time  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 10,530: Line 10,530:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Global.Toggle =
Global.Toggle  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 10,550: Line 10,550:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Global.Weekday =
Global.Weekday  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 10,567: Line 10,567:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Item =
Item  
= Item.Details.Base =
Item.Details.Base  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 10,586: Line 10,586:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Item.Fields.Base =
Item.Fields.Base  
'''Type:''' ''array''
'''Type:''' ''array''
<br />
<br />
Line 10,598: Line 10,598:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Library =
Library  
= Library.Details.Genre =
Library.Details.Genre  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
* ''[[#Item.Details.Base|Item.Details.Base]]''
Line 10,630: Line 10,630:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Library.Details.Source =
Library.Details.Source  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
* ''[[#Item.Details.Base|Item.Details.Base]]''
Line 10,659: Line 10,659:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Library.Details.Tag =
Library.Details.Tag  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
* ''[[#Item.Details.Base|Item.Details.Base]]''
Line 10,681: Line 10,681:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Library.Fields.Genre =
Library.Fields.Genre  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 10,697: Line 10,697:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Library.Fields.Source =
Library.Fields.Source  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 10,712: Line 10,712:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Library.Fields.Tag =
Library.Fields.Tag  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 10,726: Line 10,726:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Library.Id =
Library.Id  
'''Type:''' ''integer''
'''Type:''' ''integer''
<br />
<br />
Line 10,736: Line 10,736:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List =
List  
= List.Amount =
List.Amount  
'''Type:''' ''integer''
'''Type:''' ''integer''
<br />
<br />
Line 10,747: Line 10,747:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Fields.All =
List.Fields.All  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 10,857: Line 10,857:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Fields.Files =
List.Fields.Files  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 10,951: Line 10,951:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.Albums =
List.Filter.Albums  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 10,989: Line 10,989:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.Artists =
List.Filter.Artists  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 11,027: Line 11,027:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.Episodes =
List.Filter.Episodes  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 11,065: Line 11,065:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.Movies =
List.Filter.Movies  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 11,103: Line 11,103:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.MusicVideos =
List.Filter.MusicVideos  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 11,141: Line 11,141:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.Rule =
List.Filter.Rule  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 11,176: Line 11,176:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.Rule.Albums =
List.Filter.Rule.Albums  
'''Extends:'''
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
Line 11,194: Line 11,194:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.Rule.Artists =
List.Filter.Rule.Artists  
'''Extends:'''
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
Line 11,212: Line 11,212:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.Rule.Episodes =
List.Filter.Rule.Episodes  
'''Extends:'''
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
Line 11,230: Line 11,230:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.Rule.Movies =
List.Filter.Rule.Movies  
'''Extends:'''
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
Line 11,248: Line 11,248:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.Rule.MusicVideos =
List.Filter.Rule.MusicVideos  
'''Extends:'''
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
Line 11,266: Line 11,266:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.Rule.Songs =
List.Filter.Rule.Songs  
'''Extends:'''
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
Line 11,284: Line 11,284:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.Rule.TVShows =
List.Filter.Rule.TVShows  
'''Extends:'''
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
Line 11,302: Line 11,302:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.Rule.Textures =
List.Filter.Rule.Textures  
'''Extends:'''
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
Line 11,320: Line 11,320:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.Songs =
List.Filter.Songs  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 11,358: Line 11,358:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.TVShows =
List.Filter.TVShows  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 11,396: Line 11,396:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Filter.Textures =
List.Filter.Textures  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 11,434: Line 11,434:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Item.All =
List.Item.All  
'''Extends:'''
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
* ''[[#List.Item.Base|List.Item.Base]]''
Line 11,475: Line 11,475:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Item.Base =
List.Item.Base  
'''Extends:'''
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
* ''[[#Video.Details.File|Video.Details.File]]''
Line 11,767: Line 11,767:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Item.File =
List.Item.File  
'''Extends:'''
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
* ''[[#List.Item.Base|List.Item.Base]]''
Line 11,807: Line 11,807:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Items.Sources =
List.Items.Sources  
'''Type:''' ''array''
'''Type:''' ''array''
<br />
<br />
Line 11,824: Line 11,824:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Limits =
List.Limits  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 11,850: Line 11,850:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.LimitsReturned =
List.LimitsReturned  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 11,880: Line 11,880:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= List.Sort =
List.Sort  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 11,960: Line 11,960:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Media =
Media  
= Media.Artwork =
Media.Artwork  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 11,993: Line 11,993:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Media.Artwork.Set =
Media.Artwork.Set  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 12,059: Line 12,059:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Media.Details.Base =
Media.Details.Base  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
* ''[[#Item.Details.Base|Item.Details.Base]]''
Line 12,080: Line 12,080:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Media.UniqueID =
Media.UniqueID  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 12,091: Line 12,091:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Media.UniqueID.Set =
Media.UniqueID.Set  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 12,108: Line 12,108:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Notifications =
Notifications  
= Notifications.Item =
Notifications.Item  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 12,261: Line 12,261:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Notifications.Item.Type =
Notifications.Item.Type  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 12,278: Line 12,278:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Optional =
Optional  
= Optional.Boolean =
Optional.Boolean  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 12,291: Line 12,291:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Optional.Integer =
Optional.Integer  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 12,303: Line 12,303:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Optional.Number =
Optional.Number  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 12,315: Line 12,315:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Optional.String =
Optional.String  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 12,327: Line 12,327:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR =
PVR  
= PVR.Channel.Type =
PVR.Channel.Type  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 12,340: Line 12,340:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.ChannelGroup.Id =
PVR.ChannelGroup.Id  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 12,361: Line 12,361:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.Details.Broadcast =
PVR.Details.Broadcast  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
* ''[[#Item.Details.Base|Item.Details.Base]]''
Line 12,499: Line 12,499:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.Details.Channel =
PVR.Details.Channel  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
* ''[[#Item.Details.Base|Item.Details.Base]]''
Line 12,574: Line 12,574:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.Details.ChannelGroup =
PVR.Details.ChannelGroup  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
* ''[[#Item.Details.Base|Item.Details.Base]]''
Line 12,597: Line 12,597:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.Details.ChannelGroup.Extended =
PVR.Details.ChannelGroup.Extended  
'''Extends:'''
'''Extends:'''
* ''[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]''
* ''[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]''
Line 12,622: Line 12,622:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.Details.Recording =
PVR.Details.Recording  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
* ''[[#Item.Details.Base|Item.Details.Base]]''
Line 12,732: Line 12,732:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.Details.Timer =
PVR.Details.Timer  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
* ''[[#Item.Details.Base|Item.Details.Base]]''
Line 12,862: Line 12,862:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.Fields.Broadcast =
PVR.Fields.Broadcast  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 12,905: Line 12,905:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.Fields.Channel =
PVR.Fields.Channel  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 12,932: Line 12,932:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.Fields.Recording =
PVR.Fields.Recording  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 12,968: Line 12,968:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.Fields.Timer =
PVR.Fields.Timer  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 13,008: Line 13,008:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.Property.Name =
PVR.Property.Name  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 13,021: Line 13,021:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.Property.Value =
PVR.Property.Value  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 13,046: Line 13,046:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= PVR.TimerState =
PVR.TimerState  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 13,067: Line 13,067:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player =
Player  
= Player.Audio.Stream =
Player.Audio.Stream  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 13,132: Line 13,132:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.CustomViewMode =
Player.CustomViewMode  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 13,224: Line 13,224:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Id =
Player.Id  
'''Type:''' ''integer''
'''Type:''' ''integer''
<br />
<br />
Line 13,235: Line 13,235:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Notifications.Data =
Player.Notifications.Data  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 13,258: Line 13,258:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Notifications.Player =
Player.Notifications.Player  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 13,280: Line 13,280:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Notifications.Player.Seek =
Player.Notifications.Player.Seek  
'''Extends:'''
'''Extends:'''
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]''
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]''
Line 13,301: Line 13,301:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Position.Percentage =
Player.Position.Percentage  
'''Type:''' ''number''
'''Type:''' ''number''
<br />
<br />
Line 13,311: Line 13,311:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Position.Time =
Player.Position.Time  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 13,353: Line 13,353:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Property.Name =
Player.Property.Name  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 13,388: Line 13,388:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Property.Value =
Player.Property.Value  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 13,510: Line 13,510:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Repeat =
Player.Repeat  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 13,523: Line 13,523:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Speed =
Player.Speed  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 13,541: Line 13,541:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Subtitle =
Player.Subtitle  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 13,585: Line 13,585:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Type =
Player.Type  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 13,598: Line 13,598:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.Video.Stream =
Player.Video.Stream  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 13,642: Line 13,642:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.ViewMode =
Player.ViewMode  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 13,661: Line 13,661:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist =
Playlist  
= Playlist.Id =
Playlist.Id  
'''Type:''' ''integer''
'''Type:''' ''integer''
<br />
<br />
Line 13,673: Line 13,673:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist.Item =
Playlist.Item  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 13,782: Line 13,782:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist.Position =
Playlist.Position  
'''Type:''' ''integer''
'''Type:''' ''integer''
<br />
<br />
Line 13,792: Line 13,792:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist.Property.Name =
Playlist.Property.Name  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 13,804: Line 13,804:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist.Property.Value =
Playlist.Property.Value  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 13,826: Line 13,826:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist.Type =
Playlist.Type  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 13,841: Line 13,841:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Profiles =
Profiles  
= Profiles.Details.Profile =
Profiles.Details.Profile  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
* ''[[#Item.Details.Base|Item.Details.Base]]''
Line 13,863: Line 13,863:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Profiles.Fields.Profile =
Profiles.Fields.Profile  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 13,878: Line 13,878:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Profiles.Password =
Profiles.Password  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 13,907: Line 13,907:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting =
Setting  
= Setting.Details.Base =
Setting.Details.Base  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 13,936: Line 13,936:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.Category =
Setting.Details.Category  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
Line 13,959: Line 13,959:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.Control =
Setting.Details.Control  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 14,000: Line 14,000:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.ControlBase =
Setting.Details.ControlBase  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 14,028: Line 14,028:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.ControlButton =
Setting.Details.ControlButton  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
Line 14,049: Line 14,049:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.ControlCheckmark =
Setting.Details.ControlCheckmark  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
Line 14,078: Line 14,078:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.ControlEdit =
Setting.Details.ControlEdit  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
Line 14,109: Line 14,109:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.ControlHeading =
Setting.Details.ControlHeading  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
Line 14,126: Line 14,126:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.ControlLabel =
Setting.Details.ControlLabel  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
Line 14,155: Line 14,155:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.ControlList =
Setting.Details.ControlList  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
Line 14,181: Line 14,181:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.ControlRange =
Setting.Details.ControlRange  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
Line 14,212: Line 14,212:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.ControlSlider =
Setting.Details.ControlSlider  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
Line 14,243: Line 14,243:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.ControlSpinner =
Setting.Details.ControlSpinner  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
Line 14,272: Line 14,272:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.Group =
Setting.Details.Group  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 14,301: Line 14,301:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.Section =
Setting.Details.Section  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
Line 14,324: Line 14,324:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.Setting =
Setting.Details.Setting  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 14,373: Line 14,373:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.SettingAction =
Setting.Details.SettingAction  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
Line 14,392: Line 14,392:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.SettingAddon =
Setting.Details.SettingAddon  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
Line 14,411: Line 14,411:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.SettingBase =
Setting.Details.SettingBase  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
Line 14,448: Line 14,448:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.SettingBool =
Setting.Details.SettingBool  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
Line 14,472: Line 14,472:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.SettingDate =
Setting.Details.SettingDate  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
Line 14,481: Line 14,481:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.SettingInt =
Setting.Details.SettingInt  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
Line 14,534: Line 14,534:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.SettingList =
Setting.Details.SettingList  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
Line 14,581: Line 14,581:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.SettingNumber =
Setting.Details.SettingNumber  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
Line 14,620: Line 14,620:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.SettingPath =
Setting.Details.SettingPath  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
Line 14,646: Line 14,646:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.SettingString =
Setting.Details.SettingString  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
Line 14,691: Line 14,691:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Details.SettingTime =
Setting.Details.SettingTime  
'''Extends:'''
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
Line 14,700: Line 14,700:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Level =
Setting.Level  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 14,714: Line 14,714:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Type =
Setting.Type  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 14,734: Line 14,734:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Value =
Setting.Value  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 14,759: Line 14,759:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Value.Extended =
Setting.Value.Extended  
'''Type:''' ''mixed''
'''Type:''' ''mixed''
<br />
<br />
Line 14,788: Line 14,788:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Setting.Value.List =
Setting.Value.List  
'''Type:''' ''array''
'''Type:''' ''array''
<br />
<br />
Line 14,799: Line 14,799:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= System =
System  
= System.Property.Name =
System.Property.Name  
'''Type:''' ''string''
'''Type:''' ''string''
<br />
<br />
Line 14,814: Line 14,814:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= System.Property.Value =
System.Property.Value  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 14,843: Line 14,843:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Textures =
Textures  
= Textures.Details.Size =
Textures.Details.Size  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 14,861: Line 14,861:
     "size": {
     "size": {
       "type": "integer",
       "type": "integer",
       "description": "Size of the texture (1 = largest)"
       "description": "Size of the texture (1 largest)"
     },
     },
     "width": {
     "width": {
Line 14,882: Line 14,882:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Textures.Details.Texture =
Textures.Details.Texture  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 14,927: Line 14,927:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Textures.Fields.Texture =
Textures.Fields.Texture  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 14,945: Line 14,945:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video =
Video  
= Video.Cast =
Video.Cast  
'''Type:''' ''array''
'''Type:''' ''array''
<br />
<br />
Line 14,975: Line 14,975:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Details.Base =
Video.Details.Base  
'''Extends:'''
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
* ''[[#Media.Details.Base|Media.Details.Base]]''
Line 14,996: Line 14,996:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Details.Episode =
Video.Details.Episode  
'''Extends:'''
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
* ''[[#Video.Details.File|Video.Details.File]]''
Line 15,082: Line 15,082:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Details.File =
Video.Details.File  
'''Extends:'''
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
* ''[[#Video.Details.Item|Video.Details.Item]]''
Line 15,112: Line 15,112:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Details.Item =
Video.Details.Item  
'''Extends:'''
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
* ''[[#Video.Details.Media|Video.Details.Media]]''
Line 15,141: Line 15,141:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Details.Media =
Video.Details.Media  
'''Extends:'''
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
* ''[[#Video.Details.Base|Video.Details.Base]]''
Line 15,158: Line 15,158:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Details.Movie =
Video.Details.Movie  
'''Extends:'''
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
* ''[[#Video.Details.File|Video.Details.File]]''
Line 15,272: Line 15,272:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Details.MovieSet =
Video.Details.MovieSet  
'''Extends:'''
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
* ''[[#Video.Details.Media|Video.Details.Media]]''
Line 15,294: Line 15,294:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Details.MovieSet.Extended =
Video.Details.MovieSet.Extended  
'''Extends:'''
'''Extends:'''
* ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''
* ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''
Line 15,319: Line 15,319:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Details.MusicVideo =
Video.Details.MusicVideo  
'''Extends:'''
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
* ''[[#Video.Details.File|Video.Details.File]]''
Line 15,377: Line 15,377:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Details.Season =
Video.Details.Season  
'''Extends:'''
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
* ''[[#Video.Details.Base|Video.Details.Base]]''
Line 15,424: Line 15,424:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Details.TVShow =
Video.Details.TVShow  
'''Extends:'''
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
* ''[[#Video.Details.Item|Video.Details.Item]]''
Line 15,528: Line 15,528:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Fields.Episode =
Video.Fields.Episode  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 15,572: Line 15,572:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Fields.Movie =
Video.Fields.Movie  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 15,623: Line 15,623:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Fields.MovieSet =
Video.Fields.MovieSet  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 15,642: Line 15,642:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Fields.MusicVideo =
Video.Fields.MusicVideo  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 15,679: Line 15,679:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Fields.Season =
Video.Fields.Season  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 15,703: Line 15,703:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Fields.TVShow =
Video.Fields.TVShow  
'''Extends:'''
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
Line 15,746: Line 15,746:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Rating =
Video.Rating  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 15,772: Line 15,772:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Ratings =
Video.Ratings  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 15,783: Line 15,783:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Ratings.Set =
Video.Ratings.Set  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 15,800: Line 15,800:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Resume =
Video.Resume  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 15,824: Line 15,824:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Video.Streams =
Video.Streams  
'''Type:''' ''object''
'''Type:''' ''object''
<br />
<br />
Line 15,898: Line 15,898:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Notifications =
Notifications  
= Application =
Application  
= Application.OnVolumeChanged =
Application.OnVolumeChanged  
The volume of the application has changed.<br />
The volume of the application has changed.<br />
'''Parameters:'''
'''Parameters:'''
Line 15,940: Line 15,940:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary =
AudioLibrary  
= AudioLibrary.OnCleanFinished =
AudioLibrary.OnCleanFinished  
The audio library has been cleaned.<br />
The audio library has been cleaned.<br />
'''Parameters:'''
'''Parameters:'''
Line 15,967: Line 15,967:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.OnCleanStarted =
AudioLibrary.OnCleanStarted  
An audio library clean operation has started.<br />
An audio library clean operation has started.<br />
'''Parameters:'''
'''Parameters:'''
Line 15,993: Line 15,993:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.OnExport =
AudioLibrary.OnExport  
An audio library export has finished.<br />
An audio library export has finished.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,034: Line 16,034:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.OnRemove =
AudioLibrary.OnRemove  
An audio item has been removed.<br />
An audio item has been removed.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,077: Line 16,077:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.OnScanFinished =
AudioLibrary.OnScanFinished  
Scanning the audio library has been finished.<br />
Scanning the audio library has been finished.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,103: Line 16,103:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.OnScanStarted =
AudioLibrary.OnScanStarted  
An audio library scan has started.<br />
An audio library scan has started.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,129: Line 16,129:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= AudioLibrary.OnUpdate =
AudioLibrary.OnUpdate  
An audio item has been updated.<br />
An audio item has been updated.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,181: Line 16,181:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= GUI =
GUI  
= GUI.OnDPMSActivated =
GUI.OnDPMSActivated  
Energy saving/DPMS has been activated.<br />
Energy saving/DPMS has been activated.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,208: Line 16,208:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= GUI.OnDPMSDeactivated =
GUI.OnDPMSDeactivated  
Energy saving/DPMS has been deactivated.<br />
Energy saving/DPMS has been deactivated.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,234: Line 16,234:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= GUI.OnScreensaverActivated =
GUI.OnScreensaverActivated  
The screensaver has been activated.<br />
The screensaver has been activated.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,260: Line 16,260:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= GUI.OnScreensaverDeactivated =
GUI.OnScreensaverDeactivated  
The screensaver has been deactivated.<br />
The screensaver has been deactivated.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,293: Line 16,293:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input =
Input  
= Input.OnInputFinished =
Input.OnInputFinished  
The user has provided the requested input.<br />
The user has provided the requested input.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,320: Line 16,320:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Input.OnInputRequested =
Input.OnInputRequested  
The user is requested to provide some information.<br />
The user is requested to provide some information.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,372: Line 16,372:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player =
Player  
= Player.OnAVChange =
Player.OnAVChange  
Audio- or videostream has changed. If there is no ID available extra information will be provided.<br />
Audio- or videostream has changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,399: Line 16,399:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.OnAVStart =
Player.OnAVStart  
Playback of a media item has been started and first frame is available. If there is no ID available extra information will be provided.<br />
Playback of a media item has been started and first frame is available. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,425: Line 16,425:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.OnPause =
Player.OnPause  
Playback of a media item has been paused. If there is no ID available extra information will be provided.<br />
Playback of a media item has been paused. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,451: Line 16,451:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.OnPlay =
Player.OnPlay  
Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.<br />
Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,477: Line 16,477:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.OnPropertyChanged =
Player.OnPropertyChanged  
A property of the playing items has changed.<br />
A property of the playing items has changed.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,514: Line 16,514:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.OnResume =
Player.OnResume  
Playback of a media item has been resumed. If there is no ID available extra information will be provided.<br />
Playback of a media item has been resumed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,540: Line 16,540:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.OnSeek =
Player.OnSeek  
The playback position has been changed. If there is no ID available extra information will be provided.<br />
The playback position has been changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,577: Line 16,577:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.OnSpeedChanged =
Player.OnSpeedChanged  
Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.<br />
Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,603: Line 16,603:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Player.OnStop =
Player.OnStop  
Playback of a media item has been stopped. If there is no ID available extra information will be provided.<br />
Playback of a media item has been stopped. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,641: Line 16,641:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist =
Playlist  
= Playlist.OnAdd =
Playlist.OnAdd  
A playlist item has been added.<br />
A playlist item has been added.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,683: Line 16,683:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist.OnClear =
Playlist.OnClear  
A playlist item has been cleared.<br />
A playlist item has been cleared.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,716: Line 16,716:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= Playlist.OnRemove =
Playlist.OnRemove  
A playlist item has been removed.<br />
A playlist item has been removed.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,753: Line 16,753:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= System =
System  
= System.OnLowBattery =
System.OnLowBattery  
The system is on low battery.<br />
The system is on low battery.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,780: Line 16,780:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= System.OnQuit =
System.OnQuit  
Kodi will be closed.<br />
Kodi will be closed.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,814: Line 16,814:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= System.OnRestart =
System.OnRestart  
The system will be restarted.<br />
The system will be restarted.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,840: Line 16,840:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= System.OnSleep =
System.OnSleep  
The system will be suspended.<br />
The system will be suspended.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,866: Line 16,866:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= System.OnWake =
System.OnWake  
The system woke up from suspension.<br />
The system woke up from suspension.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,892: Line 16,892:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary =
VideoLibrary  
= VideoLibrary.OnCleanFinished =
VideoLibrary.OnCleanFinished  
The video library has been cleaned.<br />
The video library has been cleaned.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,919: Line 16,919:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.OnCleanStarted =
VideoLibrary.OnCleanStarted  
A video library clean operation has started.<br />
A video library clean operation has started.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,945: Line 16,945:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.OnExport =
VideoLibrary.OnExport  
A video library export has finished.<br />
A video library export has finished.<br />
'''Parameters:'''
'''Parameters:'''
Line 16,992: Line 16,992:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.OnRefresh =
VideoLibrary.OnRefresh  
The video library has been refreshed and a home screen reload might be necessary.<br />
The video library has been refreshed and a home screen reload might be necessary.<br />
'''Parameters:'''
'''Parameters:'''
Line 17,018: Line 17,018:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.OnRemove =
VideoLibrary.OnRemove  
A video item has been removed.<br />
A video item has been removed.<br />
'''Parameters:'''
'''Parameters:'''
Line 17,061: Line 17,061:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.OnScanFinished =
VideoLibrary.OnScanFinished  
Scanning the video library has been finished.<br />
Scanning the video library has been finished.<br />
'''Parameters:'''
'''Parameters:'''
Line 17,087: Line 17,087:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.OnScanStarted =
VideoLibrary.OnScanStarted  
A video library scan has started.<br />
A video library scan has started.<br />
'''Parameters:'''
'''Parameters:'''
Line 17,113: Line 17,113:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
= VideoLibrary.OnUpdate =
VideoLibrary.OnUpdate  
A video item has been updated.<br />
A video item has been updated.<br />
'''Parameters:'''
'''Parameters:'''
Line 17,175: Line 17,175:
</syntaxhighlight>}}
</syntaxhighlight>}}


= See also =
See also  
* [[JSON-RPC API]]
* [[JSON-RPC API]]
* [[JSON-RPC API/v4|JSON-RPC API v4 (Eden)]]
* [[JSON-RPC API/v4|JSON-RPC API v4 (Eden)]]
Line 17,182: Line 17,182:
* [[JSON-RPC API/v10|JSON-RPC API v10 (Leia)]]
* [[JSON-RPC API/v10|JSON-RPC API v10 (Leia)]]


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


[[Category:Development]]
[[Category:Development]]

Revision as of 13:14, 23 May 2020

Home icon grey.png   ▶ Development ▶ JSON-RPC API ▶ Ronie

Version 12 is the current development version of Kodi's JSON-RPC API and will be published with the release of v19 (Matrix).
This document has been updated to version 11.8.1. Recent changes are announced on the forum

It comes with support for WebSockets as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.


JSON-RPC 2.0 compatibility 
Version Method calls Notifications
(server-side)
Notifications
(client-side)
Parameters
by-name
Parameters
by-position
Batch requests
Version 6 Yes Yes Yes Yes Yes Yes
Documentation (JSON Schema) 
Supported features of JSON Schema 
Schema IETF Draft 03
type Yes
properties Yes
patternProperties No
additionalProperties Yes
items Yes
additionalItems Yes
required Yes
dependencies No
minimum Yes
maximum Yes
Schema IETF Draft 03
exclusiveMinimum Yes
exclusiveMaximum Yes
minItems Yes
maxItems Yes
uniqueItems Yes
pattern No
minLength Yes
maxLength Yes
enum Yes
default Yes
Schema IETF Draft 03
title No
description Yes
format No
divisibleBy Yes
disallow No
extends Yes
id Yes
$ref Yes
$schema No
Hyper Schema No
Error message 

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

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

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

Addons           List, enable and execute addons
Application      Application information and control
AudioLibrary     Audio Library information
Favourites       Favourites GetFavourites and AddFavourite
Files            Shares information & filesystem listings
GUI              Window properties and activation
Input            Allows limited navigation within Kodi
JSONRPC          A variety of standard JSONRPC calls
Player           Manages all available players
Playlist         Playlist modification
Profiles         Support for Profiles operations to xbmc. 
PVR              Live TV control
Settings         Allows manipulation of Kodi settings.
System           System controls and information
Textures         Supplies GetTextures and RemoveTexture. Textures are images.
VideoLibrary     Video Library information
XBMC             Dumping ground for very Kodi specific operations
Methods 
Addons 
Addons.ExecuteAddon 

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

  • ExecuteAddon

Parameters:

  1. string addonid
  2. [mixed: object|array|string params = ""]
  3. [boolean wait = 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:

  1. List.LimitsReturned limits
  2. Addon.Details addon
Addons.GetAddons 

Gets all available addons
Permissions:

  • ReadData

Parameters:

  1. [Addon.Types type]
  2. [Addon.Content content] (Content provided by the addon. Only considered for plugins and scripts.)
  3. [mixed: boolean|string enabled = all]
  4. [Addon.Fields properties]
  5. [List.Limits limits]
  6. [mixed: boolean|string installed = True]

Returns:

Type: object
Properties:

  1. List.LimitsReturned limits
  2. [arrayAddon.Details addons]
Addons.SetAddonEnabled 

Enables/Disables a specific addon
Permissions:

  • ManageAddon

Parameters:

  1. string addonid
  2. Global.Toggle enabled

Returns:

Type: string

Application 
Application.GetProperties 

Retrieves the values of the given properties
Permissions:

  • ReadData

Parameters:

  1. array properties

Returns:

Type: Application.Property.Value

Application.Quit 

Quit application
Permissions:

  • ControlPower

Returns:

Type: string

Application.SetMute 

Toggle mute/unmute
Permissions:

  • ControlPlayback

Parameters:

  1. Global.Toggle mute

Returns:

Type: boolean (Mute state)

Application.SetVolume 

Set the current volume
Permissions:

  • ControlPlayback

Parameters:

  1. mixed: integer|Global.IncrementDecrement volume

Returns:

Type: integer

AudioLibrary 
AudioLibrary.Clean 

Cleans the audio library from non-existent items
Permissions:

  • RemoveData

Parameters:

  1. [boolean showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)

Returns:

Type: string

AudioLibrary.Export 

Exports all items from the audio library
Permissions:

  • WriteFile

Parameters:

  1. [mixed: object|object options]

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:

  1. [Audio.Details.Album albumdetails]
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: object|object|object|object|object|object|object|object|List.Filter.Albums filter]
  5. [boolean includesingles = False]
  6. [boolean allroles = False] (Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.)

Returns:

Type: object
Properties:

  1. List.LimitsReturned limits
  2. [arrayAudio.Details.Album albums]
AudioLibrary.GetArtistDetails 

Retrieve details about a specific artist
Permissions:

  • ReadData

Parameters:

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

Returns:

Type: object
Properties:

  1. [Audio.Details.Artist artistdetails]
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] (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)
  2. [Audio.Fields.Artist properties]
  3. [List.Limits limits]
  4. [List.Sort sort]
  5. [mixed: object|object|object|object|object|object|object|object|object|object|object|object|object|object|object|List.Filter.Artists filter]
  6. [boolean allroles = False] (Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.)

Returns:

Type: object
Properties:

  1. List.LimitsReturned limits
  2. [arrayAudio.Details.Artist artists]
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:

  1. List.LimitsReturned limits
  2. arrayLibrary.Details.Genre genres
AudioLibrary.GetProperties 

Retrieves the values of the music library properties
Permissions:

  • ReadData

Parameters:

  1. array properties

Returns:

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

  1. List.LimitsReturned limits
  2. [arrayAudio.Details.Album albums]
AudioLibrary.GetRecentlyAddedSongs 

Retrieve recently added songs
Permissions:

  • ReadData

Parameters:

  1. [List.Amount albumlimit] (The amount of recently added albums from which to return the songs)
  2. [Audio.Fields.Song properties]
  3. [List.Limits limits]
  4. [List.Sort sort]

Returns:

Type: object
Properties:

  1. List.LimitsReturned limits
  2. [arrayAudio.Details.Song songs]
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:

  1. List.LimitsReturned limits
  2. [arrayAudio.Details.Album albums]
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:

  1. List.LimitsReturned limits
  2. [arrayAudio.Details.Song songs]
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:

  1. List.LimitsReturned limits
  2. arrayAudio.Details.Role roles
AudioLibrary.GetSongDetails 

Retrieve details about a specific song
Permissions:

  • ReadData

Parameters:

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

Returns:

Type: object
Properties:

  1. [Audio.Details.Song songdetails]
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: object|object|object|object|object|object|object|object|object|object|List.Filter.Songs filter]
  5. [boolean includesingles = True] (Only songs from albums are returned when false, but overidden when singlesonly parameter is true)
  6. [boolean allroles = False] (Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.)
  7. [boolean singlesonly = False] (Only singles are returned when true, and overides includesingles parameter)

Returns:

Type: object
Properties:

  1. List.LimitsReturned limits
  2. [arrayAudio.Details.Song songs]
AudioLibrary.GetSources 

Get all music sources, including unique ID
Permissions:

  • ReadData

Parameters:

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

Returns:

Type: object
Properties:

  1. List.LimitsReturned limits
  2. arrayLibrary.Details.Source sources
AudioLibrary.Scan 

Scans the audio sources for new library items
Permissions:

  • UpdateData

Parameters:

  1. [string directory = ""]
  2. [boolean showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)

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: Array.String artist = None]
  4. [Optional.String description]
  5. [mixed: Array.String genre = None]
  6. [mixed: Array.String theme = None]
  7. [mixed: Array.String mood = None]
  8. [mixed: Array.String style = None]
  9. [Optional.String type]
  10. [Optional.String albumlabel]
  11. [Optional.Number rating]
  12. [Optional.Integer year]
  13. [Optional.Integer userrating]
  14. [Optional.Integer votes]
  15. [Optional.String musicbrainzalbumid]
  16. [Optional.String musicbrainzreleasegroupid]
  17. [Optional.String sortartist]
  18. [Optional.String displayartist]
  19. [mixed: Array.String musicbrainzalbumartistid = None]
  20. [mixed: Media.Artwork.Set art = None]
  21. [Optional.Boolean isboxset]
  22. [Optional.String releasedate]
  23. [Optional.String originaldate]

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: Array.String instrument = None]
  4. [mixed: Array.String style = None]
  5. [mixed: Array.String mood = None]
  6. [Optional.String born]
  7. [Optional.String formed]
  8. [Optional.String description]
  9. [mixed: Array.String genre = None]
  10. [Optional.String died]
  11. [Optional.String disbanded]
  12. [mixed: Array.String yearsactive = None]
  13. [Optional.String musicbrainzartistid]
  14. [Optional.String sortname]
  15. [Optional.String type]
  16. [Optional.String gender]
  17. [Optional.String disambiguation]
  18. [mixed: Media.Artwork.Set art = None]

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: Array.String artist = None]
  4. [mixed: Array.String genre = None]
  5. [Optional.Integer year]
  6. [Optional.Number rating]
  7. [Optional.Integer track]
  8. [Optional.Integer disc]
  9. [Optional.Integer duration]
  10. [Optional.String comment]
  11. [Optional.String musicbrainztrackid]
  12. [Optional.String musicbrainzartistid]
  13. [Optional.Integer playcount]
  14. [Optional.String lastplayed]
  15. [Optional.Integer userrating]
  16. [Optional.Integer votes]
  17. [Optional.String displayartist]
  18. [Optional.String sortartist]
  19. [Optional.String mood]
  20. [mixed: Media.Artwork.Set art = None]
  21. [Optional.String disctitle]
  22. [Optional.String releasedate]
  23. [Optional.String originaldate]
  24. [Optional.Integer bpm]

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] (Required for media, script and androidapp favourites types)
  4. [Optional.String window] (Required for window favourite type)
  5. [Optional.String windowparameter]
  6. [Optional.String thumbnail]

Returns:

Type: string

Favourites.GetFavourites 

Retrieve all favourites
Permissions:

  • ReadData

Parameters:

  1. [mixed: Favourite.Type type = None]
  2. [Favourite.Fields.Favourite properties]

Returns:

Type: object
Properties:

  1. List.LimitsReturned limits
  2. [arrayFavourite.Details.Favourite favourites]
Files 
Files.Download 

Downloads the given file
Permissions:

  • ReadData

Parameters:

  1. string path

Returns:

Type: any

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] (Limits are applied after getting the directory content thus retrieval is not faster when they are applied.)

Returns:

Type: object
Properties:

  1. List.LimitsReturned limits
  2. arrayList.Item.File files
Files.GetFileDetails 

Get details for a specific file
Permissions:

  • ReadData

Parameters:

  1. string file (Full path to the file)
  2. [Files.Media media = files]
  3. [List.Fields.Files properties]

Returns:

Type: object
Properties:

  1. List.Item.File filedetails
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:

  1. List.LimitsReturned limits
  2. List.Items.Sources sources
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:

  1. string protocol
  2. any details (Transport specific details on how/from where to download the given file)
  3. string mode (Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol)
Files.SetFileDetails 

Update the given specific file with the given details
Permissions:

  • UpdateData

Parameters:

  1. string file (Full path to the file)
  2. Files.Media media (File type to update correct database. Currently only "video" is supported.)
  3. [Optional.Integer playcount]
  4. [Optional.String lastplayed] (Setting a valid lastplayed without a playcount will force playcount to 1.)
  5. [mixed: Video.Resume resume = None]

Returns:

Type: string

GUI 
GUI.ActivateWindow 

Activates the given window
Permissions:

  • ControlGUI

Parameters:

  1. GUI.Window window
  2. [array parameters]

Returns:

Type: string

GUI.GetProperties 

Retrieves the values of the given properties
Permissions:

  • ReadData

Parameters:

  1. array properties

Returns:

Type: GUI.Property.Value

GUI.GetStereoscopicModes 

Returns the supported stereoscopic modes of the GUI
Permissions:

  • ReadData

Returns:

Type: object
Properties:

  1. [arrayGUI.Stereoscopy.Mode stereoscopicmodes]
GUI.SetFullscreen 

Toggle fullscreen/GUI
Permissions:

  • ControlGUI

Parameters:

  1. Global.Toggle fullscreen

Returns:

Type: boolean (Fullscreen state)

GUI.SetStereoscopicMode 

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

  • ControlGUI

Parameters:

  1. string mode

Returns:

Type: string

GUI.ShowNotification 

Shows a GUI notification
Permissions:

  • ControlGUI

Parameters:

  1. string title
  2. string message
  3. [mixed: string|string image = ""]
  4. [integer displaytime = 5000] (The time in milliseconds the notification will be visible)

Returns:

Type: string

Input 
Input.Back 

Goes back in GUI
Permissions:

  • Navigate

Returns:

Type: string

Input.ButtonEvent 

Send a button press event
Permissions:

  • Navigate

Parameters:

  1. string button (Button name)
  2. string keymap (Keymap name (KB, XG, R1, or R2))
  3. integer holdtime = 0 (Number of milliseconds to simulate button hold.)

Returns:

Type: string

Input.ContextMenu 

Shows the context menu
Permissions:

  • Navigate

Returns:

Type: string

Input.Down 

Navigate down in GUI
Permissions:

  • Navigate

Returns:

Type: string

Input.ExecuteAction 

Execute a specific action
Permissions:

  • Navigate

Parameters:

  1. Input.Action action

Returns:

Type: string

Input.Home 

Goes to home window in GUI
Permissions:

  • Navigate

Returns:

Type: string

Input.Info 

Shows the information dialog
Permissions:

  • Navigate

Returns:

Type: string

Input.Left 

Navigate left in GUI
Permissions:

  • Navigate

Returns:

Type: string

Input.Right 

Navigate right in GUI
Permissions:

  • Navigate

Returns:

Type: string

Input.Select 

Select current item in GUI
Permissions:

  • Navigate

Returns:

Type: string

Input.SendText 

Send a generic (unicode) text
Permissions:

  • Navigate

Parameters:

  1. string text (Unicode text)
  2. [boolean done = True] (Whether this is the whole input or not (closes an open input dialog if true).)

Returns:

Type: string

Input.ShowCodec 

Show codec information of the playing item
Permissions:

  • Navigate

Returns:

Type: string

Input.ShowOSD 

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

  • Navigate

Returns:

Type: string

Input.ShowPlayerProcessInfo 

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

  • Navigate

Returns:

Type: string

Input.Up 

Navigate up in GUI
Permissions:

  • Navigate

Returns:

Type: string

JSONRPC 
JSONRPC.GetConfiguration 

Get client-specific configurations
Permissions:

  • ReadData

Returns:

Type: Configuration

JSONRPC.Introspect 

Enumerates all actions and descriptions
Permissions:

  • ReadData

Parameters:

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

Returns:

Type: object

JSONRPC.NotifyAll 

Notify all other connected clients
Permissions:

  • ReadData

Parameters:

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

Returns:

Type: any

JSONRPC.Permission 

Retrieve the clients permissions
Permissions:

  • ReadData

Returns:

Type: object
Properties:

  1. boolean ReadData
  2. boolean ControlPlayback
  3. boolean ControlNotify
  4. boolean ControlPower
  5. boolean UpdateData
  6. boolean RemoveData
  7. boolean Navigate
  8. boolean WriteFile
  9. boolean ControlSystem
  10. boolean ControlGUI
  11. boolean ManageAddon
  12. boolean ExecuteAddon
  13. boolean ControlPVR
JSONRPC.Ping 

Ping responder
Permissions:

  • ReadData

Returns:

Type: string

JSONRPC.SetConfiguration 

Change the client-specific configuration
Permissions:

  • ControlNotify

Parameters:

  1. [object notifications]

Returns:

Type: Configuration

JSONRPC.Version 

Retrieve the JSON-RPC protocol version.
Permissions:

  • ReadData

Returns:

Type: object
Properties:

  1. object version
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 (the broadcast id of the item to record)
  2. [boolean timerrule = False] (controls whether to create a timer rule or a onetime timer)

Returns:

Type: string

PVR.DeleteTimer 

Deletes a onetime timer or a timer rule
Permissions:

  • ControlPVR

Parameters:

  1. Library.Id timerid (the id of the onetime timer or timer rule to delete)

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:

  1. [PVR.Details.Broadcast broadcastdetails]
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:

  1. List.LimitsReturned limits
  2. arrayPVR.Details.Broadcast broadcasts
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:

  1. [PVR.Details.Channel channeldetails]
PVR.GetChannelGroupDetails 

Retrieves the details of a specific channel group
Permissions:

  • ReadData

Parameters:

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

Returns:

Type: object
Properties:

  1. [PVR.Details.ChannelGroup.Extended channelgroupdetails]
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:

  1. List.LimitsReturned limits
  2. arrayPVR.Details.ChannelGroup channelgroups
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:

  1. List.LimitsReturned limits
  2. arrayPVR.Details.Channel channels
PVR.GetProperties 

Retrieves the values of the given properties
Permissions:

  • ReadData

Parameters:

  1. array properties

Returns:

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

  1. [PVR.Details.Recording recordingdetails]
PVR.GetRecordings 

Retrieves the recordings
Permissions:

  • ReadData

Parameters:

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

Returns:

Type: object
Properties:

  1. List.LimitsReturned limits
  2. arrayPVR.Details.Recording recordings
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:

  1. [PVR.Details.Timer timerdetails]
PVR.GetTimers 

Retrieves the timers
Permissions:

  • ReadData

Parameters:

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

Returns:

Type: object
Properties:

  1. List.LimitsReturned limits
  2. arrayPVR.Details.Timer timers
PVR.Record 

Toggle recording of a channel
Permissions:

  • ControlPVR

Parameters:

  1. [Global.Toggle record = toggle]
  2. [mixed: string|Library.Id channel = current]

Returns:

Type: string

PVR.Scan 

Starts a channel scan
Permissions:

  • ControlPVR

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 (the broadcast id of the item to toggle a onetime timer or time rule for)
  2. [boolean timerrule = False] (controls whether to create / delete a timer rule or a onetime timer)

Returns:

Type: string

Player 
Player.GetActivePlayers 

Returns all active players
Permissions:

  • ReadData

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:

  1. List.Item.All item
Player.GetPlayers 

Get a list of available players
Permissions:

  • ReadData

Parameters:

  1. [string media = all]

Returns:

Type: array

Player.GetProperties 

Retrieves the values of the given properties
Permissions:

  • ReadData

Parameters:

  1. Player.Id playerid
  2. array properties

Returns:

Type: Player.Property.Value

Player.GetViewMode 

Get view mode of video player
Permissions:

  • ReadData

Returns:

Type: object
Properties:

  1. Player.ViewMode viewmode
  2. number zoom
  3. number pixelratio
  4. number verticalshift
  5. boolean nonlinearstretch
Player.GoTo 

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

  • ControlPlayback

Parameters:

  1. Player.Id playerid
  2. mixed: string|Playlist.Position to

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

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: object|Playlist.Item|object|object|object|object item]
  2. [object options]

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: Player.Speed

Player.Rotate 

Rotates current picture
Permissions:

  • ControlPlayback

Parameters:

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

Returns:

Type: string

Player.Seek 

Seek through the playing item
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid
  2. mixed: object|object|object|object value

Returns:

Type: object
Properties:

  1. [Player.Position.Percentage percentage]
  2. [Global.Time time]
  3. [Global.Time totaltime]
Player.SetAudioStream 

Set the audio stream played by the player
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid
  2. mixed: string|integer stream

Returns:

Type: string

Player.SetPartymode 

Turn partymode on or off
Permissions:

  • ControlPlayback

Parameters:

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

Returns:

Type: string

Player.SetRepeat 

Set the repeat mode of the player
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid
  2. mixed: Player.Repeat|string repeat

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

Player.SetSpeed 

Set the speed of the current playback
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid
  2. mixed: integer|Global.IncrementDecrement speed

Returns:

Type: Player.Speed

Player.SetSubtitle 

Set the subtitle displayed by the player
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid
  2. mixed: string|integer subtitle
  3. [boolean enable = False] (Whether to enable subtitles to be displayed after setting the new subtitle)

Returns:

Type: string

Player.SetVideoStream 

Set the video stream played by the player
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid
  2. mixed: string|integer stream

Returns:

Type: string

Player.SetViewMode 

Set view mode of video player
Permissions:

  • ControlPlayback

Parameters:

  1. mixed: Player.CustomViewMode|Player.ViewMode viewmode

Returns:

Type: string

Player.Stop 

Stops playback
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid

Returns:

Type: string

Player.Zoom 

Zoom current picture
Permissions:

  • ControlPlayback

Parameters:

  1. Player.Id playerid
  2. mixed: string|integer zoom

Returns:

Type: string

Playlist 
Playlist.Add 

Add item(s) to playlist
Permissions:

  • ControlPlayback

Parameters:

  1. Playlist.Id playlistid
  2. mixed: Playlist.Item|array item

Returns:

Type: string

Playlist.Clear 

Clear playlist
Permissions:

  • ControlPlayback

Parameters:

  1. Playlist.Id playlistid

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:

  1. List.LimitsReturned limits
  2. arrayList.Item.All items
Playlist.GetPlaylists 

Returns all existing playlists
Permissions:

  • ReadData

Returns:

Type: array

Playlist.GetProperties 

Retrieves the values of the given properties
Permissions:

  • ReadData

Parameters:

  1. Playlist.Id playlistid
  2. array properties

Returns:

Type: 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: Playlist.Item|array item

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

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

Profiles 
Profiles.GetCurrentProfile 

Retrieve the current profile
Permissions:

  • ReadData

Parameters:

  1. [Profiles.Fields.Profile properties]

Returns:

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

  1. List.LimitsReturned limits
  2. arrayProfiles.Details.Profile profiles
Profiles.LoadProfile 

Load the specified profile
Permissions:

  • Navigate

Parameters:

  1. string profile (Profile name)
  2. [boolean prompt] (Prompt for password)
  3. [Profiles.Password password]

Returns:

Type: string

Settings 
Settings.GetCategories 

Retrieves all setting categories
Permissions:

  • ReadData

Parameters:

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

Returns:

Type: object
Properties:

  1. [arraySetting.Details.Category categories]
Settings.GetSections 

Retrieves all setting sections
Permissions:

  • ReadData

Parameters:

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

Returns:

Type: object
Properties:

  1. [arraySetting.Details.Section sections]
Settings.GetSettingValue 

Retrieves the value of a setting
Permissions:

  • ReadData

Parameters:

  1. string setting

Returns:

Type: object
Properties:

  1. Setting.Value.Extended value
Settings.GetSettings 

Retrieves all settings
Permissions:

  • ReadData

Parameters:

  1. [Setting.Level level = standard]
  2. [mixed: object filter = None]

Returns:

Type: object
Properties:

  1. [arraySetting.Details.Setting settings]
Settings.ResetSettingValue 

Resets the value of a setting
Permissions:

  • WriteSetting

Parameters:

  1. string setting

Returns:

Type: string

Settings.SetSettingValue 

Changes the value of a setting
Permissions:

  • WriteSetting

Parameters:

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

Returns:

Type: boolean

System 
System.EjectOpticalDrive 

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

  • ControlSystem

Returns:

Type: string

System.GetProperties 

Retrieves the values of the given properties
Permissions:

  • ReadData

Parameters:

  1. array properties

Returns:

Type: System.Property.Value

System.Hibernate 

Puts the system running Kodi into hibernate mode
Permissions:

  • ControlPower

Returns:

Type: string

System.Reboot 

Reboots the system running Kodi
Permissions:

  • ControlPower

Returns:

Type: string

System.Shutdown 

Shuts the system running Kodi down
Permissions:

  • ControlPower

Returns:

Type: string

System.Suspend 

Suspends the system running Kodi
Permissions:

  • ControlPower

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:

  1. arrayTextures.Details.Texture textures
Textures.RemoveTexture 

Remove the specified texture
Permissions:

  • RemoveData

Parameters:

  1. Library.Id textureid (Texture database identifier)

Returns:

Type: string

VideoLibrary 
VideoLibrary.Clean 

Cleans the video library for non-existent items
Permissions:

  • RemoveData

Parameters:

  1. [boolean showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)
  2. [string content = video] (Content type to clean for)

Returns:

Type: string

VideoLibrary.Export 

Exports all items from the video library
Permissions:

  • WriteFile

Parameters:

  1. [mixed: object|object options]

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:

  1. [Video.Details.Episode episodedetails]
VideoLibrary.GetEpisodes 

Retrieve all tv show episodes
Permissions:

  • ReadData

Parameters:

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

Returns:

Type: object
Properties:

  1. List.LimitsReturned limits
  2. [arrayVideo.Details.Episode episodes]
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:

  1. List.LimitsReturned limits
  2. arrayLibrary.Details.Genre genres
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:

  1. List.LimitsReturned limits
  2. [arrayVideo.Details.TVShow tvshows]
VideoLibrary.GetMovieDetails 

Retrieve details about a specific movie
Permissions:

  • ReadData

Parameters:

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

Returns:

Type: object
Properties:

  1. [Video.Details.Movie moviedetails]
VideoLibrary.GetMovieSetDetails 

Retrieve details about a specific movie set
Permissions:

  • ReadData

Parameters:

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

Returns:

Type: object
Properties:

  1. [Video.Details.MovieSet.Extended setdetails]
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:

  1. List.LimitsReturned limits
  2. [arrayVideo.Details.MovieSet sets]
VideoLibrary.GetMovies 

Retrieve all movies
Permissions:

  • ReadData

Parameters:

  1. [Video.Fields.Movie properties]
  2. [List.Limits limits]
  3. [List.Sort sort]
  4. [mixed: object|object|object|object|object|object|object|object|object|object|List.Filter.Movies filter]

Returns:

Type: object
Properties:

  1. List.LimitsReturned limits
  2. [arrayVideo.Details.Movie movies]
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:

  1. [Video.Details.MusicVideo musicvideodetails]
VideoLibrary.GetMusicVideos 

Retrieve all music videos
Permissions:

  • ReadData

Parameters:

  1. [Video.Fields.MusicVideo properties]
  2. [List.Limits limits]
  3. [List.Sort sort]
  4. [mixed: object|object|object|object|object|object|object|List.Filter.MusicVideos filter]

Returns:

Type: object
Properties:

  1. List.LimitsReturned limits
  2. [arrayVideo.Details.MusicVideo musicvideos]
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:

  1. List.LimitsReturned limits
  2. [arrayVideo.Details.Episode episodes]
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:

  1. List.LimitsReturned limits
  2. [arrayVideo.Details.Movie movies]
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:

  1. List.LimitsReturned limits
  2. [arrayVideo.Details.MusicVideo musicvideos]
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:

  1. [Video.Details.Season seasondetails]
VideoLibrary.GetSeasons 

Retrieve all tv seasons
Permissions:

  • ReadData

Parameters:

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

Returns:

Type: object
Properties:

  1. List.LimitsReturned limits
  2. [arrayVideo.Details.Season seasons]
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:

  1. [Video.Details.TVShow tvshowdetails]
VideoLibrary.GetTVShows 

Retrieve all tv shows
Permissions:

  • ReadData

Parameters:

  1. [Video.Fields.TVShow properties]
  2. [List.Limits limits]
  3. [List.Sort sort]
  4. [mixed: object|object|object|object|object|object|List.Filter.TVShows filter]

Returns:

Type: object
Properties:

  1. List.LimitsReturned limits
  2. [arrayVideo.Details.TVShow tvshows]
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:

  1. List.LimitsReturned limits
  2. arrayLibrary.Details.Tag tags
VideoLibrary.RefreshEpisode 

Refresh the given episode in the library
Permissions:

  • UpdateData

Parameters:

  1. Library.Id episodeid
  2. boolean ignorenfo = False (Whether or not to ignore a local NFO if present.)
  3. string title = "" (Title to use for searching (instead of determining it from the item's filename/path).)

Returns:

Type: string

VideoLibrary.RefreshMovie 

Refresh the given movie in the library
Permissions:

  • UpdateData

Parameters:

  1. Library.Id movieid
  2. boolean ignorenfo = False (Whether or not to ignore a local NFO if present.)
  3. string title = "" (Title to use for searching (instead of determining it from the item's filename/path).)

Returns:

Type: string

VideoLibrary.RefreshMusicVideo 

Refresh the given music video in the library
Permissions:

  • UpdateData

Parameters:

  1. Library.Id musicvideoid
  2. boolean ignorenfo = False (Whether or not to ignore a local NFO if present.)
  3. string title = "" (Title to use for searching (instead of determining it from the item's filename/path).)

Returns:

Type: string

VideoLibrary.RefreshTVShow 

Refresh the given tv show in the library
Permissions:

  • UpdateData

Parameters:

  1. Library.Id tvshowid
  2. boolean ignorenfo = False (Whether or not to ignore a local NFO if present.)
  3. boolean refreshepisodes = False (Whether or not to refresh all episodes belonging to the TV show.)
  4. string title = "" (Title to use for searching (instead of determining it from the item's filename/path).)

Returns:

Type: string

VideoLibrary.RemoveEpisode 

Removes the given episode from the library
Permissions:

  • RemoveData

Parameters:

  1. Library.Id episodeid

Returns:

Type: string

VideoLibrary.RemoveMovie 

Removes the given movie from the library
Permissions:

  • RemoveData

Parameters:

  1. Library.Id movieid

Returns:

Type: string

VideoLibrary.RemoveMusicVideo 

Removes the given music video from the library
Permissions:

  • RemoveData

Parameters:

  1. Library.Id musicvideoid

Returns:

Type: string

VideoLibrary.RemoveTVShow 

Removes the given tv show from the library
Permissions:

  • RemoveData

Parameters:

  1. Library.Id tvshowid

Returns:

Type: string

VideoLibrary.Scan 

Scans the video sources for new library items
Permissions:

  • UpdateData

Parameters:

  1. [string directory = ""]
  2. [boolean showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)

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] (Runtime in seconds)
  5. [mixed: Array.String director = None]
  6. [Optional.String plot]
  7. [Optional.Number rating]
  8. [Optional.String votes]
  9. [Optional.String lastplayed]
  10. [mixed: Array.String writer = None]
  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: Media.Artwork.Set art = None]
  19. [mixed: Video.Resume resume = None]
  20. [Optional.Integer userrating]
  21. [Video.Ratings.Set ratings]
  22. [Optional.String dateadded]
  23. [mixed: Media.UniqueID.Set uniqueid = None]

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] (Runtime in seconds)
  5. [mixed: Array.String director = None]
  6. [mixed: Array.String studio = None]
  7. [Optional.Integer year] (linked with premiered. Overridden by premiered parameter)
  8. [Optional.String plot]
  9. [mixed: Array.String genre = None]
  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: Array.String writer = None]
  20. [mixed: Array.String country = None]
  21. [Optional.Integer top250]
  22. [Optional.String sorttitle]
  23. [Optional.String set]
  24. [mixed: Array.String showlink = None]
  25. [Optional.String thumbnail]
  26. [Optional.String fanart]
  27. [mixed: Array.String tag = None]
  28. [mixed: Media.Artwork.Set art = None]
  29. [mixed: Video.Resume resume = None]
  30. [Optional.Integer userrating]
  31. [Video.Ratings.Set ratings]
  32. [Optional.String dateadded]
  33. [Optional.String premiered] (linked with year. Overrides year)
  34. [mixed: Media.UniqueID.Set uniqueid = None]

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: Media.Artwork.Set art = None]
  4. [Optional.String plot]

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] (Runtime in seconds)
  5. [mixed: Array.String director = None]
  6. [mixed: Array.String studio = None]
  7. [Optional.Integer year] (linked with premiered. Overridden by premiered parameter)
  8. [Optional.String plot]
  9. [Optional.String album]
  10. [mixed: Array.String artist]
  11. [mixed: Array.String genre = None]
  12. [Optional.Integer track]
  13. [Optional.String lastplayed]
  14. [Optional.String thumbnail]
  15. [Optional.String fanart]
  16. [mixed: Array.String tag = None]
  17. [mixed: Media.Artwork.Set art = None]
  18. [mixed: Video.Resume resume = None]
  19. [Optional.Number rating]
  20. [Optional.Integer userrating]
  21. [Optional.String dateadded]
  22. [Optional.String premiered] (linked with year. Overrides year)

Returns:

Type: string

VideoLibrary.SetSeasonDetails 

Update the given season with the given details
Permissions:

  • UpdateData

Parameters:

  1. Library.Id seasonid
  2. [mixed: Media.Artwork.Set art = None]
  3. [Optional.Integer userrating]
  4. [Optional.String title]

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: Array.String studio = None]
  5. [Optional.String plot]
  6. [mixed: Array.String genre = None]
  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: Array.String tag = None]
  19. [mixed: Media.Artwork.Set art = None]
  20. [Optional.Integer userrating]
  21. [Video.Ratings.Set ratings]
  22. [Optional.String dateadded]
  23. [Optional.Integer runtime] (Runtime in seconds)
  24. [Optional.String status] (Valid values: 'returning series', 'in production', 'planned', 'cancelled', 'ended')
  25. [mixed: Media.UniqueID.Set uniqueid = None]

Returns:

Type: string

XBMC 
XBMC.GetInfoBooleans 

Retrieve info booleans about Kodi and the system
Permissions:

  • ReadData

Parameters:

  1. array booleans

Returns:

Type: object (Object containing key-value pairs of the retrieved info booleans)

XBMC.GetInfoLabels 

Retrieve info labels about Kodi and the system
Permissions:

  • ReadData

Parameters:

  1. array labels (See http://kodi.wiki/view/InfoLabels for a list of possible info labels)

Returns:

Type: object (Object containing key-value pairs of the retrieved info labels)

Global Types 
Addon 
Addon.Content 

Type: string

Addon.Details 

Extends:

Properties:

  • string addonid
  • Addon.Types type
  • [string name]
  • [string version]
  • [string summary]
  • [string description]
  • [string path]
  • [string author]
  • [string thumbnail]
  • [string disclaimer]
  • [string fanart]
  • [array dependencies]
  • [mixed: broken]
  • [array extrainfo]
  • [integer rating]
  • [boolean enabled]
  • [boolean installed]
Addon.Fields 

Extends:

Application 
Application.Property.Name 

Type: string

Application.Property.Value 

Type: object
Properties:

  • [integer volume]
  • [boolean muted]
  • [string name]
  • [object version]
  • [Array.String sorttokens]
  • [string language]
Array 
Array.Integer 

Type: array

Array.String 

Type: array

Audio 
Audio.Album.ReleaseType 

Type: string

Audio.Artist.Roles 

Type: array

Audio.Contributors 

Type: array

Audio.Details.Album 

Extends:

Properties:

Audio.Details.Artist 

Extends:

Properties:

Audio.Details.Base 

Extends:

Properties:

Audio.Details.Genres 

Type: array

Audio.Details.Media 

Extends:

Properties:

  • [string title]
  • [Array.String artist]
  • [integer year]
  • [number rating]
  • [Array.String musicbrainzalbumartistid]
  • [Array.Integer artistid]
  • [string displayartist]
  • [integer votes]
  • [integer userrating]
  • [string sortartist]
  • [string releasedate]
  • [string originaldate]
Audio.Details.Role 

Extends:

Properties:

Audio.Details.Song 

Extends:

Properties:

  • Library.Id songid
  • [string file]
  • [Array.String albumartist]
  • [string album]
  • [integer track]
  • [integer duration]
  • [string comment]
  • [string lyrics]
  • [integer playcount]
  • [string musicbrainztrackid]
  • [Array.String musicbrainzartistid]
  • [Library.Id albumid]
  • [string lastplayed]
  • [integer disc]
  • [Array.Integer albumartistid]
  • [Audio.Album.ReleaseType albumreleasetype]
  • [string mood]
  • [Audio.Contributors contributors]
  • [string displaycomposer]
  • [string displayconductor]
  • [string displayorchestra]
  • [string displaylyricist]
  • [Array.Integer genreid]
  • [Array.Integer sourceid]
  • [string disctitle]
  • [Integer bpm]
  • [Integer samplerate]
  • [Integer bitrate]
  • [Integer channels]
Audio.Fields.Album 

Extends:

Audio.Fields.Artist 

Extends:

Audio.Fields.Role 

Extends:

Audio.Fields.Song 

Extends:

Audio.Property.Name 

Type: string

Audio.Property.Value 

Type: object
Properties:

  • [Library.Id missingartistid]
  • [string librarylastupdated]
Configuration 
Configuration 

Type: object
Properties:

Configuration.Notifications 

Type: object
Properties:

  • boolean Player
  • boolean Playlist
  • boolean GUI
  • boolean System
  • boolean VideoLibrary
  • boolean AudioLibrary
  • boolean Application
  • boolean Input
  • boolean PVR
  • boolean Other
Favourite 
Favourite.Details.Favourite 

Type: object
Properties:

  • string title
  • Favourite.Type type
  • [string path]
  • [string window]
  • [string windowparameter]
  • [string thumbnail]
Favourite.Fields.Favourite 

Extends:

Favourite.Type 

Type: string

Files 
Files.Media 

Type: string

GUI 
GUI.Property.Name 

Type: string

GUI.Property.Value 

Type: object
Properties:

  • [object currentwindow]
  • [object currentcontrol]
  • [object skin]
  • [boolean fullscreen]
  • [GUI.Stereoscopy.Mode stereoscopicmode]
GUI.Stereoscopy.Mode 

Type: object
Properties:

  • string mode
  • string label
Global 
Global.IncrementDecrement 

Type: string

Global.String.NotEmpty 

Type: string

Global.Time 

Type: object
Properties:

  • integer hours
  • integer minutes
  • integer seconds
  • integer milliseconds
Global.Toggle 

Type: mixed

Global.Weekday 

Type: string

Item 
Item.Details.Base 

Type: object
Properties:

  • string label
Item.Fields.Base 

Type: array

Library 
Library.Details.Genre 

Extends:

Properties:

Library.Details.Source 

Extends:

Properties:

Library.Details.Tag 

Extends:

Properties:

Library.Fields.Genre 

Extends:

Library.Fields.Source 

Extends:

Library.Fields.Tag 

Extends:

Library.Id 

Type: integer

List 
List.Amount 

Type: integer

List.Fields.All 

Extends:

List.Fields.Files 

Extends:

List.Filter.Albums 

Type: mixed

List.Filter.Artists 

Type: mixed

List.Filter.Episodes 

Type: mixed

List.Filter.Movies 

Type: mixed

List.Filter.MusicVideos 

Type: mixed

List.Filter.Rule 

Type: object
Properties:

List.Filter.Rule.Albums 

Extends:

Properties:

List.Filter.Rule.Artists 

Extends:

Properties:

List.Filter.Rule.Episodes 

Extends:

Properties:

List.Filter.Rule.Movies 

Extends:

Properties:

List.Filter.Rule.MusicVideos 

Extends:

Properties:

List.Filter.Rule.Songs 

Extends:

Properties:

List.Filter.Rule.TVShows 

Extends:

Properties:

List.Filter.Rule.Textures 

Extends:

Properties:

List.Filter.Songs 

Type: mixed

List.Filter.TVShows 

Type: mixed

List.Filter.Textures 

Type: mixed

List.Item.All 

Extends:

Properties:

  • [string channel]
  • [PVR.Channel.Type channeltype]
  • [boolean hidden]
  • [boolean locked]
  • [integer channelnumber]
  • [string starttime]
  • [string endtime]
List.Item.Base 

Extends:

Properties:

  • [Library.Id id]
  • [string type]
  • [Array.String albumartist]
  • [string album]
  • [integer track]
  • [integer duration]
  • [string comment]
  • [string lyrics]
  • [string musicbrainztrackid]
  • [Array.String musicbrainzartistid]
  • [string trailer]
  • [string tagline]
  • [string plotoutline]
  • [string originaltitle]
  • [Array.String writer]
  • [Array.String studio]
  • [string mpaa]
  • [Video.Cast cast]
  • [Array.String country]
  • [string imdbnumber]
  • [string premiered]
  • [string productioncode]
  • [string set]
  • [Array.String showlink]
  • [integer top250]
  • [string votes]
  • [string firstaired]
  • [integer season]
  • [integer episode]
  • [string showtitle]
  • [Library.Id albumid]
  • [Library.Id setid]
  • [Library.Id tvshowid]
  • [integer watchedepisodes]
  • [integer disc]
  • [Array.String tag]
  • [Array.Integer albumartistid]
  • [Media.UniqueID uniqueid]
  • [string episodeguide]
  • [string sorttitle]
  • [string description]
  • [Array.String theme]
  • [Array.String mood]
  • [Array.String style]
  • [string albumlabel]
  • [integer specialsortseason]
  • [integer specialsortepisode]
  • [boolean compilation]
  • [Audio.Album.ReleaseType releasetype]
  • [Audio.Album.ReleaseType albumreleasetype]
  • [Audio.Contributors contributors]
  • [string displaycomposer]
  • [string displayconductor]
  • [string displayorchestra]
  • [string displaylyricist]
  • [string mediapath]
  • [string dynpath]
  • [boolean isboxset]
  • [integer totaldiscs]
  • [string disctitle]
  • [string releasedate]
  • [string originaldate]
  • [integer bpm]
  • [integer bitrate]
  • [integer samplerate]
  • [integer channels]
List.Item.File 

Extends:

Properties:

  • string file
  • string filetype
  • [integer size]
  • [string lastmodified]
  • [string mimetype]
List.Items.Sources 

Type: array

List.Limits 

Type: object
Properties:

List.LimitsReturned 

Type: object
Properties:

List.Sort 

Type: object
Properties:

  • [string method = none]
  • [string order = ascending]
  • [boolean ignorearticle]
  • [boolean useartistsortname]
Media 
Media.Artwork 

Type: object
Properties:

Media.Artwork.Set 

Type: object
Properties:

Media.Details.Base 

Extends:

Properties:

  • [string fanart]
  • [string thumbnail]
Media.UniqueID 

Type: object

Media.UniqueID.Set 

Type: object

Notifications 
Notifications.Item 

Type: mixed

Notifications.Item.Type 

Type: string

Optional 
Optional.Boolean 

Type: mixed

Optional.Integer 

Type: mixed

Optional.Number 

Type: mixed

Optional.String 

Type: mixed

PVR 
PVR.Channel.Type 

Type: string

PVR.ChannelGroup.Id 

Type: mixed

PVR.Details.Broadcast 

Extends:

Properties:

  • Library.Id broadcastid
  • [string title]
  • [string plot]
  • [string plotoutline]
  • [string starttime]
  • [string endtime]
  • [integer runtime]
  • [integer progress]
  • [number progresspercentage]
  • [string genre]
  • [string episodename]
  • [integer episodenum]
  • [integer episodepart]
  • [string firstaired]
  • [boolean hastimer]
  • [boolean isactive]
  • [integer parentalrating]
  • [boolean wasactive]
  • [string thumbnail]
  • [integer rating]
  • [string originaltitle]
  • [string cast]
  • [string director]
  • [string writer]
  • [integer year]
  • [integer imdbnumber]
  • [boolean hastimerrule]
  • [boolean hasrecording]
  • [string recording]
  • [boolean isseries]
  • [boolean isplayable]
PVR.Details.Channel 

Extends:

Properties:

  • Library.Id channelid
  • [string channel]
  • [PVR.Channel.Type channeltype]
  • [boolean hidden]
  • [boolean locked]
  • [string thumbnail]
  • [string lastplayed]
  • [PVR.Details.Broadcast broadcastnow]
  • [PVR.Details.Broadcast broadcastnext]
  • integer uniqueid
  • [string icon]
  • [integer channelnumber]
  • [integer subchannelnumber]
  • [boolean isrecording]
  • [boolean hasarchive]
PVR.Details.ChannelGroup 

Extends:

Properties:

PVR.Details.ChannelGroup.Extended 

Extends:

Properties:

PVR.Details.Recording 

Extends:

Properties:

  • Library.Id recordingid
  • [string title]
  • [string plot]
  • [string plotoutline]
  • [string genre]
  • [integer playcount]
  • [Video.Resume resume]
  • [string channel]
  • [string starttime]
  • [string endtime]
  • [integer runtime]
  • [integer lifetime]
  • [string icon]
  • [Media.Artwork art]
  • [string streamurl]
  • [string file]
  • [string directory]
  • [boolean radio]
  • [boolean isdeleted]
  • [integer epgeventid]
  • [integer channeluid]
  • [integer season]
  • [integer episode]
  • [string showtitle]
PVR.Details.Timer 

Extends:

Properties:

  • Library.Id timerid
  • [string title]
  • [string summary]
  • [Library.Id channelid]
  • [boolean isradio]
  • [boolean istimerrule]
  • [boolean ismanual]
  • [string starttime]
  • [string endtime]
  • [integer runtime]
  • [integer lifetime]
  • [string firstday]
  • [array weekdays]
  • [integer priority]
  • [integer startmargin]
  • [integer endmargin]
  • [PVR.TimerState state]
  • [string file]
  • [string directory]
  • [integer preventduplicateepisodes]
  • [boolean startanytime]
  • [boolean endanytime]
  • [string epgsearchstring]
  • [boolean fulltextepgsearch]
  • [integer recordinggroup]
  • [integer maxrecordings]
  • [integer epguid]
  • [boolean isreadonly]
PVR.Fields.Broadcast 

Extends:

PVR.Fields.Channel 

Extends:

PVR.Fields.Recording 

Extends:

PVR.Fields.Timer 

Extends:

PVR.Property.Name 

Type: string

PVR.Property.Value 

Type: object
Properties:

  • [boolean available]
  • [boolean recording]
  • [boolean scanning]
PVR.TimerState 

Type: string

Player 
Player.Audio.Stream 

Type: object
Properties:

  • integer index
  • string name
  • string language
  • string codec
  • integer bitrate
  • integer channels
  • boolean isdefault
  • boolean isoriginal
  • boolean isimpaired
  • integer samplerate
Player.CustomViewMode 

Type: object
Properties:

Player.Id 

Type: integer

Player.Notifications.Data 

Type: object
Properties:

Player.Notifications.Player 

Type: object
Properties:

Player.Notifications.Player.Seek 

Extends:

Properties:

Player.Position.Percentage 

Type: number

Player.Position.Time 

Type: object
Properties:

  • [integer hours]
  • [integer minutes]
  • [integer seconds]
  • [integer milliseconds]
Player.Property.Name 

Type: string

Player.Property.Value 

Type: object
Properties:

Player.Repeat 

Type: string

Player.Speed 

Type: object
Properties:

  • [integer speed]
Player.Subtitle 

Type: object
Properties:

  • integer index
  • string name
  • string language
  • boolean isdefault
  • boolean isforced
  • boolean isimpaired
Player.Type 

Type: string

Player.Video.Stream 

Type: object
Properties:

  • integer index
  • string name
  • string language
  • string codec
  • integer width
  • integer height
Player.ViewMode 

Type: string

Playlist 
Playlist.Id 

Type: integer

Playlist.Item 

Type: mixed

Playlist.Position 

Type: integer

Playlist.Property.Name 

Type: string

Playlist.Property.Value 

Type: object
Properties:

Playlist.Type 

Type: string

Profiles 
Profiles.Details.Profile 

Extends:

Properties:

  • [string thumbnail]
  • [integer lockmode]
Profiles.Fields.Profile 

Extends:

Profiles.Password 

Type: object
Properties:

  • string value
  • [string encryption = md5]
Setting 
Setting.Details.Base 

Type: object
Properties:

  • string id
  • string label
  • [string help]
Setting.Details.Category 

Extends:

Properties:

  • [array groups]
Setting.Details.Control 

Type: mixed

Setting.Details.ControlBase 

Type: object
Properties:

  • string type
  • string format
  • boolean delayed
Setting.Details.ControlButton 

Extends:

Properties:

  • string type
Setting.Details.ControlCheckmark 

Extends:

Properties:

  • string type
  • string format
Setting.Details.ControlEdit 

Extends:

Properties:

  • string type
  • boolean hidden
  • boolean verifynewvalue
Setting.Details.ControlHeading 

Extends:

Properties:

  • [string heading]
Setting.Details.ControlLabel 

Extends:

Properties:

  • string type
  • string format
Setting.Details.ControlList 

Extends:

Properties:

  • string type
  • boolean multiselect
Setting.Details.ControlRange 

Extends:

Properties:

  • string type
  • string formatlabel
  • string formatvalue
Setting.Details.ControlSlider 

Extends:

Properties:

  • string type
  • string formatlabel
  • boolean popup
Setting.Details.ControlSpinner 

Extends:

Properties:

  • string type
  • [string formatlabel]
  • [string minimumlabel]
Setting.Details.Group 

Type: object
Properties:

  • string id
  • [array settings]
Setting.Details.Section 

Extends:

Properties:

  • [array categories]
Setting.Details.Setting 

Type: mixed

Setting.Details.SettingAction 

Extends:

Properties:

  • string data
Setting.Details.SettingAddon 

Extends:

Properties:

Setting.Details.SettingBase 

Extends:

Properties:

Setting.Details.SettingBool 

Extends:

Properties:

  • boolean value
  • boolean default
Setting.Details.SettingDate 

Extends:

Setting.Details.SettingInt 

Extends:

Properties:

  • integer value
  • integer default
  • [integer minimum]
  • [integer step]
  • [integer maximum]
  • [array options]
Setting.Details.SettingList 

Extends:

Properties:

Setting.Details.SettingNumber 

Extends:

Properties:

  • number value
  • number default
  • number minimum
  • number step
  • number maximum
Setting.Details.SettingPath 

Extends:

Properties:

  • boolean writable
  • [array sources]
Setting.Details.SettingString 

Extends:

Properties:

  • string value
  • string default
  • boolean allowempty
  • [array options]
Setting.Details.SettingTime 

Extends:

Setting.Level 

Type: string

Setting.Type 

Type: string

Setting.Value 

Type: mixed

Setting.Value.Extended 

Type: mixed

Setting.Value.List 

Type: array

System 
System.Property.Name 

Type: string

System.Property.Value 

Type: object
Properties:

  • [boolean canshutdown]
  • [boolean cansuspend]
  • [boolean canhibernate]
  • [boolean canreboot]
Textures 
Textures.Details.Size 

Type: object
Properties:

  • [integer size]
  • [integer width]
  • [integer height]
  • [integer usecount]
  • [string lastused]
Textures.Details.Texture 

Type: object
Properties:

  • Library.Id textureid
  • [string url]
  • [string cachedurl]
  • [string lasthashcheck]
  • [string imagehash]
  • [array sizes]
Textures.Fields.Texture 

Extends:

Video 
Video.Cast 

Type: array

Video.Details.Base 

Extends:

Properties:

Video.Details.Episode 

Extends:

Properties:

  • Library.Id episodeid
  • [string votes]
  • [number rating]
  • [Array.String writer]
  • [string firstaired]
  • [string productioncode]
  • [integer season]
  • [integer episode]
  • [Media.UniqueID uniqueid]
  • [string originaltitle]
  • [string showtitle]
  • [Video.Cast cast]
  • [Library.Id tvshowid]
  • [integer specialsortseason]
  • [integer specialsortepisode]
  • [integer userrating]
  • [Library.Id seasonid]
  • [Video.Ratings ratings]
Video.Details.File 

Extends:

Properties:

Video.Details.Item 

Extends:

Properties:

  • [string file]
  • [string plot]
  • [string lastplayed]
  • [string dateadded]
Video.Details.Media 

Extends:

Properties:

  • [string title]
Video.Details.Movie 

Extends:

Properties:

Video.Details.MovieSet 

Extends:

Properties:

Video.Details.MovieSet.Extended 

Extends:

Properties:

Video.Details.MusicVideo 

Extends:

Properties:

Video.Details.Season 

Extends:

Properties:

  • Library.Id seasonid
  • integer season
  • [string showtitle]
  • [integer episode]
  • [integer watchedepisodes]
  • [Library.Id tvshowid]
  • [integer userrating]
  • [string title]
Video.Details.TVShow 

Extends:

Properties:

  • Library.Id tvshowid
  • [Array.String genre]
  • [integer year]
  • [number rating]
  • [string originaltitle]
  • [string sorttitle]
  • [Array.String studio]
  • [string mpaa]
  • [Video.Cast cast]
  • [integer episode]
  • [integer watchedepisodes]
  • [string imdbnumber]
  • [string premiered]
  • [string votes]
  • [string episodeguide]
  • [integer season]
  • [Array.String tag]
  • [integer userrating]
  • [Video.Ratings ratings]
  • [integer runtime]
  • [string status]
  • [Media.UniqueID uniqueid]
Video.Fields.Episode 

Extends:

Video.Fields.Movie 

Extends:

Video.Fields.MovieSet 

Extends:

Video.Fields.MusicVideo 

Extends:

Video.Fields.Season 

Extends:

Video.Fields.TVShow 

Extends:

Video.Rating 

Type: object
Properties:

  • number rating
  • [integer votes]
  • [boolean default]
Video.Ratings 

Type: object

Video.Ratings.Set 

Type: object

Video.Resume 

Type: object
Properties:

  • [number position]
  • [number total]
Video.Streams 

Type: object
Properties:

  • [array audio]
  • [array video]
  • [array subtitle]
Notifications 
Application 
Application.OnVolumeChanged 

The volume of the application has changed.
Parameters:

  1. string sender
  2. object data:
    • integer volume
    • boolean muted
AudioLibrary 
AudioLibrary.OnCleanFinished 

The audio library has been cleaned.
Parameters:

  1. string sender
  2. string data
AudioLibrary.OnCleanStarted 

An audio library clean operation has started.
Parameters:

  1. string sender
  2. string data
AudioLibrary.OnExport 

An audio library export has finished.
Parameters:

  1. string sender
  2. [object data]:
    • [string file = ""]
    • [integer failcount = 0]
AudioLibrary.OnRemove 

An audio item has been removed.
Parameters:

  1. string sender
  2. object data:
AudioLibrary.OnScanFinished 

Scanning the audio library has been finished.
Parameters:

  1. string sender
  2. string data
AudioLibrary.OnScanStarted 

An audio library scan has started.
Parameters:

  1. string sender
  2. string data
AudioLibrary.OnUpdate 

An audio item has been updated.
Parameters:

  1. string sender
  2. object data:
GUI 
GUI.OnDPMSActivated 

Energy saving/DPMS has been activated.
Parameters:

  1. string sender
  2. string data
GUI.OnDPMSDeactivated 

Energy saving/DPMS has been deactivated.
Parameters:

  1. string sender
  2. string data
GUI.OnScreensaverActivated 

The screensaver has been activated.
Parameters:

  1. string sender
  2. string data
GUI.OnScreensaverDeactivated 

The screensaver has been deactivated.
Parameters:

  1. string sender
  2. object data:
    • boolean shuttingdown
Input 
Input.OnInputFinished 

The user has provided the requested input.
Parameters:

  1. string sender
  2. string data
Input.OnInputRequested 

The user is requested to provide some information.
Parameters:

  1. string sender
  2. object data:
    • string type
    • string value
    • string title
Player 
Player.OnAVChange 

Audio- or videostream has changed. If there is no ID available extra information will be provided.
Parameters:

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

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

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

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

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

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

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

A property of the playing items has changed.
Parameters:

  1. string sender
  2. object data:
Player.OnResume 

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

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

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

  1. string sender
  2. object data:
Player.OnSpeedChanged 

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

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

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

  1. string sender
  2. object data:
Playlist 
Playlist.OnAdd 

A playlist item has been added.
Parameters:

  1. string sender
  2. object data:
Playlist.OnClear 

A playlist item has been cleared.
Parameters:

  1. string sender
  2. object data:
Playlist.OnRemove 

A playlist item has been removed.
Parameters:

  1. string sender
  2. object data:
System 
System.OnLowBattery 

The system is on low battery.
Parameters:

  1. string sender
  2. string data
System.OnQuit 

Kodi will be closed.
Parameters:

  1. string sender
  2. object data:
    • integer exitcode
System.OnRestart 

The system will be restarted.
Parameters:

  1. string sender
  2. string data
System.OnSleep 

The system will be suspended.
Parameters:

  1. string sender
  2. string data
System.OnWake 

The system woke up from suspension.
Parameters:

  1. string sender
  2. string data
VideoLibrary 
VideoLibrary.OnCleanFinished 

The video library has been cleaned.
Parameters:

  1. string sender
  2. string data
VideoLibrary.OnCleanStarted 

A video library clean operation has started.
Parameters:

  1. string sender
  2. string data
VideoLibrary.OnExport 

A video library export has finished.
Parameters:

  1. string sender
  2. [object data]:
    • [string file = ""]
    • [string root = ""]
    • [integer failcount = 0]
VideoLibrary.OnRefresh 

The video library has been refreshed and a home screen reload might be necessary.
Parameters:

  1. string sender
  2. string data
VideoLibrary.OnRemove 

A video item has been removed.
Parameters:

  1. string sender
  2. object data:
VideoLibrary.OnScanFinished 

Scanning the video library has been finished.
Parameters:

  1. string sender
  2. string data
VideoLibrary.OnScanStarted 

A video library scan has started.
Parameters:

  1. string sender
  2. string data
VideoLibrary.OnUpdate 

A video item has been updated.
Parameters:

  1. string sender
  2. object data:
See also 
External links