Archive:JSON-RPC API/v4: Difference between revisions
>Montellese (added json-rpc 2.0 compatibility table) |
>Montellese (updated method, type and notification documentation) |
||
Line 191: | Line 191: | ||
====Application.GetProperties==== | ====Application.GetProperties==== | ||
Retrieves the values of the given properties<br /> | Retrieves the values of the given properties<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
#'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
#''[[#Application.Property.Name|Application.Property.Name]]''[] properties | |||
''' | </div> | ||
'''Returns:''' ''[[#Application.Property.Value|Application.Property.Value]]'' | |||
====Application.Quit==== | ====Application.Quit==== | ||
Quit application<br /> | Quit application<br /> | ||
''' | '''Permissions:''' | ||
* ControlPower | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns: '''<br /> | '''Returns:''' ''string'' | ||
''' | |||
''' | ====Application.SetMute==== | ||
Toggle mute/unmute<br /> | |||
'''Permissions:''' | |||
* ControlPlayback | |||
'''Parameters:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''mixed'' mute | |||
</div> | |||
'''Returns:''' ''boolean'' | |||
====Application.SetVolume==== | ====Application.SetVolume==== | ||
Set the current volume<br /> | Set the current volume<br /> | ||
''' | '''Permissions:''' | ||
* ControlPlayback | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''integer'' volume | |||
</div> | |||
'''Returns:''' ''integer'' | |||
''' | |||
< | |||
'''Returns | |||
===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:''' | ||
* RemoveData | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
====AudioLibrary.Export==== | ====AudioLibrary.Export==== | ||
Exports all items from the audio library<br /> | Exports all items from the audio library<br /> | ||
''' | '''Permissions:''' | ||
* WriteFile | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
# | #[ ''mixed'' options ] | ||
</div> | |||
#[ '' | '''Returns:''' ''string'' | ||
''' | |||
====AudioLibrary.GetAlbumDetails==== | ====AudioLibrary.GetAlbumDetails==== | ||
Retrieve details about a specific album<br /> | Retrieve details about a specific album<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Library.Id|Library.Id]]'' albumid | #''[[#Library.Id|Library.Id]]'' albumid | ||
#[ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' | #[ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''[[#Audio.Details.Album|Audio.Details.Album]]'' albumdetails ] | *[ ''[[#Audio.Details.Album|Audio.Details.Album]]'' albumdetails ] | ||
</div> | |||
====AudioLibrary.GetAlbums==== | ====AudioLibrary.GetAlbums==== | ||
Retrieve all albums from specified artist or genre<br /> | Retrieve all albums from specified artist or genre<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#[ ''[[#Library.Id|Library.Id]]'' artistid = -1 ] | #[ ''[[#Library.Id|Library.Id]]'' artistid = -1 ] | ||
#[ ''[[#Library.Id|Library.Id]]'' genreid = -1 ] | #[ ''[[#Library.Id|Library.Id]]'' genreid = -1 ] | ||
#[ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' | #[ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ] | ||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ '' | *[ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ] | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
</div> | |||
====AudioLibrary.GetArtistDetails==== | ====AudioLibrary.GetArtistDetails==== | ||
Retrieve details about a specific artist<br /> | Retrieve details about a specific artist<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Library.Id|Library.Id]]'' artistid | #''[[#Library.Id|Library.Id]]'' artistid | ||
#[ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' | #[ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''[[#Audio.Details.Artist|Audio.Details.Artist]]'' artistdetails ] | *[ ''[[#Audio.Details.Artist|Audio.Details.Artist]]'' artistdetails ] | ||
</div> | |||
====AudioLibrary.GetArtists==== | ====AudioLibrary.GetArtists==== | ||
Retrieve all artists<br /> | Retrieve all artists<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#[ ''[[#Optional.Boolean|Optional.Boolean]]'' albumartistsonly = null ] | #[ ''[[#Optional.Boolean|Optional.Boolean]]'' albumartistsonly = null ] | ||
#[ ''[[#Library.Id|Library.Id]]'' genreid = -1 ] | #[ ''[[#Library.Id|Library.Id]]'' genreid = -1 ] | ||
#[ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' | #[ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties ] | ||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
*[ '' | *[ ''[[#Audio.Details.Artist|Audio.Details.Artist]]''[] artists ] | ||
</div> | |||
====AudioLibrary.GetGenres==== | ====AudioLibrary.GetGenres==== | ||
Retrieve all genres<br /> | Retrieve all genres<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
#[ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
#[ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties ] | |||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*'' | *''[[#Library.Details.Genre|Library.Details.Genre]]''[] genres | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
</div> | |||
====AudioLibrary.GetRecentlyAddedAlbums==== | ====AudioLibrary.GetRecentlyAddedAlbums==== | ||
Retrieve recently added albums<br /> | Retrieve recently added albums<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#[ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' | #[ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ] | ||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ '' | *[ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ] | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
</div> | |||
====AudioLibrary.GetRecentlyAddedSongs==== | ====AudioLibrary.GetRecentlyAddedSongs==== | ||
Retrieve recently added songs<br /> | Retrieve recently added songs<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
#[ ''[[#List.Amount|List.Amount]]'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
#[ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' | #[ ''[[#List.Amount|List.Amount]]'' albumlimit = -1 ] | ||
#[ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ] | |||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
*[ '' | *[ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ] | ||
</div> | |||
====AudioLibrary.GetSongDetails==== | ====AudioLibrary.GetSongDetails==== | ||
Retrieve details about a specific song<br /> | Retrieve details about a specific song<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Library.Id|Library.Id]]'' songid | #''[[#Library.Id|Library.Id]]'' songid | ||
#[ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' | #[ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''[[#Audio.Details.Song|Audio.Details.Song]]'' songdetails ] | *[ ''[[#Audio.Details.Song|Audio.Details.Song]]'' songdetails ] | ||
</div> | |||
====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:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#[ ''[[#Library.Id|Library.Id]]'' artistid = -1 ] | #[ ''[[#Library.Id|Library.Id]]'' artistid = -1 ] | ||
#[ ''[[#Library.Id|Library.Id]]'' albumid = -1 ] | #[ ''[[#Library.Id|Library.Id]]'' albumid = -1 ] | ||
#[ ''[[#Library.Id|Library.Id]]'' genreid = -1 ] | #[ ''[[#Library.Id|Library.Id]]'' genreid = -1 ] | ||
#[ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' | #[ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ] | ||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
*[ '' | *[ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ] | ||
</div> | |||
====AudioLibrary.Scan==== | ====AudioLibrary.Scan==== | ||
Scans the audio sources for new library items<br /> | Scans the audio sources for new library items<br /> | ||
''' | '''Permissions:''' | ||
* UpdateData | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
===Files=== | ===Files=== | ||
====Files.Download==== | ====Files.Download==== | ||
Provides a way to download a given file (e.g. providing an URL to the real file location)<br /> | |||
'''Permissions:''' | |||
''' | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' path | #''string'' path | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*''string'' path | *''string'' path | ||
</div> | |||
====Files.GetDirectory==== | ====Files.GetDirectory==== | ||
''' | Get the directories and files in the given directory<br /> | ||
'''Permissions:''' | |||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' directory | #''string'' directory | ||
#[ ''[[#Files.Media|Files.Media]]'' media = "files" ] | #[ ''[[#Files.Media|Files.Media]]'' media = "files" ] | ||
#[ ''[[#List.Fields.All|List.Fields.All]]'' | #[ ''[[#List.Fields.All|List.Fields.All]]'' properties ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*''[[#List. | *''[[#List.Item.File|List.Item.File]]''[] files | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
</div> | |||
====Files.GetSources==== | ====Files.GetSources==== | ||
Get the sources of the media windows<br /> | Get the sources of the media windows<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Files.Media|Files.Media]]'' media | #''[[#Files.Media|Files.Media]]'' media | ||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*''[[#List.Items. | *''[[#List.Items.Sources|List.Items.Sources]]'' sources | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
</div> | |||
===Input=== | ===Input=== | ||
====Input.Back==== | ====Input.Back==== | ||
Goes back in GUI<br /> | Goes back in GUI<br /> | ||
''' | '''Permissions:''' | ||
* Navigate | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
====Input.Down==== | ====Input.Down==== | ||
Navigate down in GUI<br /> | Navigate down in GUI<br /> | ||
''' | '''Permissions:''' | ||
* Navigate | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
====Input.Home==== | ====Input.Home==== | ||
Goes to home window in GUI<br /> | Goes to home window in GUI<br /> | ||
''' | '''Permissions:''' | ||
* Navigate | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
====Input.Left==== | ====Input.Left==== | ||
Navigate left in GUI<br /> | Navigate left in GUI<br /> | ||
''' | '''Permissions:''' | ||
* Navigate | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
====Input.Right==== | ====Input.Right==== | ||
Navigate right in GUI<br /> | Navigate right in GUI<br /> | ||
''' | '''Permissions:''' | ||
* Navigate | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
====Input.Select==== | ====Input.Select==== | ||
Select current item in GUI<br /> | Select current item in GUI<br /> | ||
''' | '''Permissions:''' | ||
* Navigate | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
====Input.Up==== | ====Input.Up==== | ||
Navigate up in GUI<br /> | Navigate up in GUI<br /> | ||
''' | '''Permissions:''' | ||
* Navigate | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
===JSONRPC=== | ===JSONRPC=== | ||
====JSONRPC.Introspect==== | ====JSONRPC.Introspect==== | ||
Enumerates all actions and descriptions<br /> | Enumerates all actions and descriptions<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#[ ''boolean'' getdescriptions = True ] | #[ ''boolean'' getdescriptions = True ] | ||
#[ ''boolean'' getmetadata = False ] | #[ ''boolean'' getmetadata = False ] | ||
Line 787: | Line 556: | ||
*[ ''boolean'' getreferences = True ] | *[ ''boolean'' getreferences = True ] | ||
'''Returns: '''< | </div> | ||
'''Type:''' ''object''< | '''Returns:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object'' | |||
</div> | |||
====JSONRPC.NotifyAll==== | ====JSONRPC.NotifyAll==== | ||
Notify all other connected clients<br /> | Notify all other connected clients<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' sender | #''string'' sender | ||
#''string'' message | #''string'' message | ||
#[ ''any'' data = null ] | #[ ''any'' data = null ] | ||
</div> | |||
''' | '''Returns:''' ''any'' | ||
====JSONRPC.Permission==== | ====JSONRPC.Permission==== | ||
Retrieve the clients permissions<br /> | Retrieve the clients permissions<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns: '''< | '''Returns:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*''boolean'' navigate | |||
*''boolean'' removedata | *''boolean'' removedata | ||
*''boolean'' controlplayback | *''boolean'' controlplayback | ||
Line 819: | Line 593: | ||
*''boolean'' controlpower | *''boolean'' controlpower | ||
</div> | |||
====JSONRPC.Ping==== | ====JSONRPC.Ping==== | ||
Ping responder<br /> | Ping responder<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
====JSONRPC.Version==== | ====JSONRPC.Version==== | ||
Retrieve the jsonrpc protocol version<br /> | Retrieve the jsonrpc protocol version<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
=== | ===Player=== | ||
==== | ====Player.GetActivePlayers==== | ||
Returns all active players<br /> | |||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns: '''<br /> | '''Returns:''' | ||
'''Type:''' ''string''<br /> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
''' | '''Type:''' ''array'' | ||
</div> | |||
====Player.GetItem==== | |||
Retrieves the currently played item<br /> | |||
'''Permissions:''' | |||
* ReadData | |||
'''Parameters:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Player.Id|Player.Id]]'' playerid | |||
#[ ''[[#List.Fields.All|List.Fields.All]]'' properties ] | |||
</div> | |||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | |||
'''Properties:''' | |||
*''[[#List.Item.All|List.Item.All]]'' item | |||
</div> | |||
====Player.GetProperties==== | |||
Retrieves the values of the given properties<br /> | |||
'''Permissions:''' | |||
* ReadData | |||
'''Parameters:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Player.Id|Player.Id]]'' playerid | |||
#''[[#Player.Property.Name|Player.Property.Name]]''[] properties | |||
</div> | |||
'''Returns:''' ''[[#Player.Property.Value|Player.Property.Value]]'' | |||
====Player.GoNext==== | |||
Go to next item on the playlist<br /> | |||
'''Permissions:''' | |||
* ControlPlayback | |||
'''Parameters:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Player.Id|Player.Id]]'' playerid | |||
</div> | |||
'''Returns:''' ''string'' | |||
====Player.GoPrevious==== | |||
Go to previous item on the playlist<br /> | |||
'''Permissions:''' | |||
* ControlPlayback | |||
'''Parameters:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Player.Id|Player.Id]]'' playerid | |||
</div> | |||
'''Returns:''' ''string'' | |||
====Player.GoTo==== | |||
Go to item at the given position in the playlist<br /> | |||
'''Permissions:''' | |||
* ControlPlayback | |||
'''Parameters:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Player.Id|Player.Id]]'' playerid | |||
#''[[#Playlist.Position|Playlist.Position]]'' position | |||
</div> | |||
'''Returns:''' ''string'' | |||
====Player.MoveDown==== | |||
If picture is zoomed move viewport down<br /> | |||
'''Permissions:''' | |||
* ControlPlayback | |||
'''Parameters:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Player.Id|Player.Id]]'' playerid | |||
</div> | |||
'''Returns:''' ''string'' | |||
==== | ====Player.MoveLeft==== | ||
If picture is zoomed move viewport left otherwise skip previous<br /> | If picture is zoomed move viewport left otherwise skip previous<br /> | ||
''' | '''Permissions:''' | ||
'''Parameters:''' | * ControlPlayback | ||
< | '''Parameters:''' | ||
'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
''' | #''[[#Player.Id|Player.Id]]'' playerid | ||
</div> | |||
'''Returns:''' ''string'' | |||
==== | ====Player.MoveRight==== | ||
If picture is zoomed move viewport right otherwise skip next<br /> | If picture is zoomed move viewport right otherwise skip next<br /> | ||
''' | '''Permissions:''' | ||
'''Parameters:''' | * ControlPlayback | ||
< | '''Parameters:''' | ||
'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
''' | #''[[#Player.Id|Player.Id]]'' playerid | ||
</div> | |||
'''Returns:''' ''string'' | |||
==== | ====Player.MoveUp==== | ||
If picture is zoomed move viewport up<br /> | If picture is zoomed move viewport up<br /> | ||
''' | '''Permissions:''' | ||
'''Parameters:''' | * ControlPlayback | ||
< | '''Parameters:''' | ||
'''Returns: '''<br /> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
''' | #''[[#Player.Id|Player.Id]]'' playerid | ||
''' | </div> | ||
'''Returns:''' ''string'' | |||
====Player.Open==== | |||
Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.<br /> | |||
'''Permissions:''' | |||
* ControlPlayback | |||
'''Parameters:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#[ ''mixed'' item ] | |||
</div> | |||
'''Returns:''' ''string'' | |||
====Player.PlayPause==== | |||
Pauses or unpause playback and returns the new state<br /> | |||
'''Permissions:''' | |||
* ControlPlayback | |||
'''Parameters:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Player.Id|Player.Id]]'' playerid | |||
</div> | |||
'''Returns:''' ''[[#Player.Speed|Player.Speed]]'' | |||
==== | ====Player.Repeat==== | ||
Set the repeat mode of the player<br /> | |||
''' | '''Permissions:''' | ||
'''Parameters:''' | * ControlPlayback | ||
< | '''Parameters:''' | ||
''' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
''' | #''[[#Player.Id|Player.Id]]'' playerid | ||
#''[[#Player.Repeat|Player.Repeat]]'' state | |||
</div> | |||
'''Returns:''' ''string'' | |||
==== | ====Player.Rotate==== | ||
Rotates current picture<br /> | Rotates current picture<br /> | ||
''' | '''Permissions:''' | ||
'''Parameters:''' | * ControlPlayback | ||
<br /> | '''Parameters:''' | ||
'''Returns: '''<br /> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
''' | #''[[#Player.Id|Player.Id]]'' playerid | ||
''' | </div> | ||
'''Returns:''' ''string'' | |||
====Player.Seek==== | |||
Seek through the playing item<br /> | |||
'''Permissions:''' | |||
* ControlPlayback | |||
'''Parameters:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Player.Id|Player.Id]]'' playerid | |||
#''mixed'' value | |||
</div> | |||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | |||
'''Properties:''' | |||
*[ ''[[#Global.Time|Global.Time]]'' totaltime ] | |||
*[ ''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage = 0 ] | |||
*[ ''[[#Global.Time|Global.Time]]'' time ] | |||
</div> | |||
====Player.SetAudioStream==== | |||
Set the audio stream played by the player<br /> | |||
'''Permissions:''' | |||
* ControlPlayback | |||
'''Parameters:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Player.Id|Player.Id]]'' playerid | |||
#''mixed'' stream | |||
</div> | |||
'''Returns:''' ''string'' | |||
====Player.SetSpeed==== | |||
Set the speed of the current playback<br /> | |||
'''Permissions:''' | |||
* ControlPlayback | |||
'''Parameters:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Player.Id|Player.Id]]'' playerid | |||
#''mixed'' speed | |||
</div> | |||
'''Returns:''' ''[[#Player.Speed|Player.Speed]]'' | |||
====Player.SetSubtitle==== | |||
Set the subtitle displayed by the player<br /> | |||
'''Permissions:''' | |||
* ControlPlayback | |||
'''Parameters:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Player.Id|Player.Id]]'' playerid | |||
#''mixed'' subtitle | |||
</div> | |||
'''Returns:''' ''string'' | |||
==== | ====Player.Shuffle==== | ||
Shuffle items in the player<br /> | |||
''' | '''Permissions:''' | ||
'''Parameters:''' | * ControlPlayback | ||
< | '''Parameters:''' | ||
'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
''' | #''[[#Player.Id|Player.Id]]'' playerid | ||
</div> | |||
'''Returns:''' ''string'' | |||
==== | ====Player.Stop==== | ||
Stops playback<br /> | |||
''' | '''Permissions:''' | ||
'''Parameters:''' | * ControlPlayback | ||
< | '''Parameters:''' | ||
'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
''' | #''[[#Player.Id|Player.Id]]'' playerid | ||
</div> | |||
'''Returns:''' ''string'' | |||
==== | ====Player.UnShuffle==== | ||
Unshuffle items in the player<br /> | |||
''' | '''Permissions:''' | ||
'''Parameters:''' | * ControlPlayback | ||
< | '''Parameters:''' | ||
'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
''' | #''[[#Player.Id|Player.Id]]'' playerid | ||
</div> | |||
'''Returns:''' ''string'' | |||
==== | ====Player.Zoom==== | ||
Zooms current picture<br /> | Zooms current picture<br /> | ||
''' | '''Permissions:''' | ||
* ControlPlayback | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Player.Id|Player.Id]]'' playerid | |||
#''integer'' value | #''integer'' value | ||
</div> | |||
''' | '''Returns:''' ''string'' | ||
==== | ====Player.ZoomIn==== | ||
Zoom in once<br /> | Zoom in once<br /> | ||
''' | '''Permissions:''' | ||
'''Parameters:''' | * ControlPlayback | ||
< | '''Parameters:''' | ||
'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
''' | #''[[#Player.Id|Player.Id]]'' playerid | ||
</div> | |||
'''Returns:''' ''string'' | |||
==== | ====Player.ZoomOut==== | ||
Zoom out once<br /> | Zoom out once<br /> | ||
''' | '''Permissions:''' | ||
'''Parameters:''' | * ControlPlayback | ||
< | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Player.Id|Player.Id]]'' playerid | |||
'' | </div> | ||
'''Returns:''' ''string'' | |||
< | |||
'''Returns | |||
===Playlist=== | ===Playlist=== | ||
====Playlist.Add==== | ====Playlist.Add==== | ||
Add | Add item(s) to playlist<br /> | ||
''' | '''Permissions:''' | ||
* ControlPlayback | |||
'''Parameters:''' | '''Parameters:''' | ||
#''[[#Playlist.Id|Playlist.Id]]'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
#''[[#Playlist. | #''[[#Playlist.Id|Playlist.Id]]'' playlistid | ||
#''[[#Playlist.Item|Playlist.Item]]'' item | |||
''' | </div> | ||
'''Returns:''' ''string'' | |||
====Playlist.Clear==== | ====Playlist.Clear==== | ||
Clear playlist<br /> | Clear playlist<br /> | ||
''' | '''Permissions:''' | ||
* ControlPlayback | |||
* | |||
'''Parameters:''' | '''Parameters:''' | ||
#'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
#''[[#Playlist.Id|Playlist.Id]]'' playlistid | |||
''' | </div> | ||
'''Returns:''' ''string'' | |||
====Playlist.GetItems==== | ====Playlist.GetItems==== | ||
Get all items from playlist<br /> | |||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
#''[[#Playlist.Id|Playlist.Id]]'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
#[ ''[[#List.Fields.All|List.Fields.All]]'' | #''[[#Playlist.Id|Playlist.Id]]'' playlistid | ||
#[ ''[[#List.Fields.All|List.Fields.All]]'' properties ] | |||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*''[[#List. | *''[[#List.Item.All|List.Item.All]]''[] items | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
</div> | |||
====Playlist. | ====Playlist.GetPlaylists==== | ||
Returns all existing playlists<br /> | |||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' None | |||
<br /> | |||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''array'' | |||
</div> | |||
====Playlist.GetProperties==== | |||
Retrieves the values of the given properties<br /> | |||
'''Permissions:''' | |||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
#''[[#Playlist.Id|Playlist.Id]]'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
#''[' | #''[[#Playlist.Id|Playlist.Id]]'' playlistid | ||
#''[[#Playlist.Property.Name|Playlist.Property.Name]]''[] properties | |||
''' | </div> | ||
'''Returns:''' ''[[#Playlist.Property.Value|Playlist.Property.Value]]'' | |||
====Playlist. | ====Playlist.Insert==== | ||
Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).<br /> | |||
''' | '''Permissions:''' | ||
* ControlPlayback | |||
'''Parameters:''' | '''Parameters:''' | ||
#''[[#Playlist.Id|Playlist.Id]]'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
''' | #''[[#Playlist.Id|Playlist.Id]]'' playlistid | ||
''' | #''[[#Playlist.Position|Playlist.Position]]'' position | ||
#''[[#Playlist.Item|Playlist.Item]]'' item | |||
</div> | |||
'''Returns:''' ''string'' | |||
====Playlist. | ====Playlist.Remove==== | ||
Remove item from playlist. Does not work for picture playlists (aka slideshows).<br /> | |||
''' | '''Permissions:''' | ||
* ControlPlayback | |||
'''Parameters:''' | '''Parameters:''' | ||
#''[[#Playlist.Id|Playlist.Id]]'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
#''[[#Playlist.Id|Playlist.Id]]'' playlistid | |||
#''[[#Playlist | #''[[#Playlist.Position|Playlist.Position]]'' position | ||
</div> | |||
''' | '''Returns:''' ''string'' | ||
====Playlist. | ====Playlist.Swap==== | ||
Swap items in the playlist. Does not work for picture playlists (aka slideshows).<br /> | |||
''' | '''Permissions:''' | ||
* ControlPlayback | |||
'''Parameters:''' | '''Parameters:''' | ||
#''[[#Playlist.Id|Playlist.Id]]'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
''' | #''[[#Playlist.Id|Playlist.Id]]'' playlistid | ||
''' | #''[[#Playlist.Position|Playlist.Position]]'' position1 | ||
#''[[#Playlist.Position|Playlist.Position]]'' position2 | |||
</div> | |||
'''Returns:''' ''string'' | |||
===System=== | ===System=== | ||
====System.GetProperties==== | ====System.GetProperties==== | ||
Retrieves the values of the given properties<br /> | Retrieves the values of the given properties<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
#'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
#''[[#System.Property.Name|System.Property.Name]]''[] properties | |||
''' | </div> | ||
'''Returns:''' ''[[#System.Property.Value|System.Property.Value]]'' | |||
====System.Hibernate==== | ====System.Hibernate==== | ||
Puts the system running XBMC into hibernate mode<br /> | Puts the system running XBMC into hibernate mode<br /> | ||
''' | '''Permissions:''' | ||
* ControlPower | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
====System.Reboot==== | ====System.Reboot==== | ||
Reboots the system running XBMC<br /> | Reboots the system running XBMC<br /> | ||
''' | '''Permissions:''' | ||
* ControlPower | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
====System.Shutdown==== | ====System.Shutdown==== | ||
Shuts the system running XBMC down<br /> | Shuts the system running XBMC down<br /> | ||
''' | '''Permissions:''' | ||
* ControlPower | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
====System.Suspend==== | ====System.Suspend==== | ||
Suspends the system running XBMC<br /> | Suspends the system running XBMC<br /> | ||
''' | '''Permissions:''' | ||
* ControlPower | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
===VideoLibrary=== | ===VideoLibrary=== | ||
====VideoLibrary.Clean==== | ====VideoLibrary.Clean==== | ||
Cleans the video library from non-existent items<br /> | Cleans the video library from non-existent items<br /> | ||
''' | '''Permissions:''' | ||
* RemoveData | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
====VideoLibrary.Export==== | ====VideoLibrary.Export==== | ||
Exports all items from the video library<br /> | Exports all items from the video library<br /> | ||
''' | '''Permissions:''' | ||
* WriteFile | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
# | #[ ''mixed'' options ] | ||
#[ '' | </div> | ||
'''Returns:''' ''string'' | |||
''' | |||
====VideoLibrary.GetEpisodeDetails==== | ====VideoLibrary.GetEpisodeDetails==== | ||
Retrieve details about a specific tv show episode<br /> | Retrieve details about a specific tv show episode<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Library.Id|Library.Id]]'' episodeid | #''[[#Library.Id|Library.Id]]'' episodeid | ||
#[ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' | #[ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''[[#Video.Details.Episode|Video.Details.Episode]]'' episodedetails ] | *[ ''[[#Video.Details.Episode|Video.Details.Episode]]'' episodedetails ] | ||
</div> | |||
====VideoLibrary.GetEpisodes==== | ====VideoLibrary.GetEpisodes==== | ||
Retrieve all tv show episodes<br /> | Retrieve all tv show episodes<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#[ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ] | #[ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ] | ||
#[ ''integer'' season = -1 ] | #[ ''integer'' season = -1 ] | ||
#[ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' | #[ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ] | ||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ '' | *[ ''[[#Video.Details.Episode|Video.Details.Episode]]''[] episodes ] | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
</div> | |||
====VideoLibrary.GetGenres==== | ====VideoLibrary.GetGenres==== | ||
Retrieve all genres<br /> | Retrieve all genres<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' type | #''string'' type | ||
#[ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' | #[ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties ] | ||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*'' | *''[[#Library.Details.Genre|Library.Details.Genre]]''[] genres | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
</div> | |||
====VideoLibrary.GetMovieDetails==== | ====VideoLibrary.GetMovieDetails==== | ||
Retrieve details about a specific movie<br /> | Retrieve details about a specific movie<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Library.Id|Library.Id]]'' movieid | #''[[#Library.Id|Library.Id]]'' movieid | ||
#[ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' | #[ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''[[#Video.Details.Movie|Video.Details.Movie]]'' moviedetails ] | *[ ''[[#Video.Details.Movie|Video.Details.Movie]]'' moviedetails ] | ||
</div> | |||
====VideoLibrary.GetMovieSetDetails==== | ====VideoLibrary.GetMovieSetDetails==== | ||
Retrieve details about a specific movie set<br /> | Retrieve details about a specific movie set<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Library.Id|Library.Id]]'' setid | #''[[#Library.Id|Library.Id]]'' setid | ||
#[ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' | #[ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties ] | ||
#[ ''object'' movies ]<br /> | #[ ''object'' movies ]<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''[[#List.Sort|List.Sort]]'' sort ] | *[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
*[ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' | *[ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ] | ||
*[ ''[[#List.Limits|List.Limits]]'' limits ] | *[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''[[#Video.Details.MovieSet.Extended|Video.Details.MovieSet.Extended]]'' setdetails ] | *[ ''[[#Video.Details.MovieSet.Extended|Video.Details.MovieSet.Extended]]'' setdetails ] | ||
</div> | |||
====VideoLibrary.GetMovieSets==== | ====VideoLibrary.GetMovieSets==== | ||
Retrieve all movie sets<br /> | Retrieve all movie sets<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
#[ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
#[ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties ] | |||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
*[ '' | *[ ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''[] sets ] | ||
</div> | |||
====VideoLibrary.GetMovies==== | ====VideoLibrary.GetMovies==== | ||
Retrieve all movies<br /> | Retrieve all movies<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
#[ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
#[ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ] | |||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ '' | *[ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ] | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
</div> | |||
====VideoLibrary.GetMusicVideoDetails==== | ====VideoLibrary.GetMusicVideoDetails==== | ||
Retrieve details about a specific music video<br /> | Retrieve details about a specific music video<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Library.Id|Library.Id]]'' musicvideoid | #''[[#Library.Id|Library.Id]]'' musicvideoid | ||
#[ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' | #[ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]'' musicvideodetails ] | *[ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]'' musicvideodetails ] | ||
</div> | |||
====VideoLibrary.GetMusicVideos==== | ====VideoLibrary.GetMusicVideos==== | ||
Retrieve all music videos<br /> | Retrieve all music videos<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#[ ''[[#Library.Id|Library.Id]]'' artistid = -1 ] | #[ ''[[#Library.Id|Library.Id]]'' artistid = -1 ] | ||
#[ ''[[#Library.Id|Library.Id]]'' albumid = -1 ] | #[ ''[[#Library.Id|Library.Id]]'' albumid = -1 ] | ||
#[ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' | #[ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ] | ||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ '' | *[ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]''[] musicvideos ] | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
</div> | |||
====VideoLibrary.GetRecentlyAddedEpisodes==== | ====VideoLibrary.GetRecentlyAddedEpisodes==== | ||
Retrieve all recently added tv episodes<br /> | Retrieve all recently added tv episodes<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
#[ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
#[ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ] | |||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ '' | *[ ''[[#Video.Details.Episode|Video.Details.Episode]]''[] episodes ] | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
</div> | |||
====VideoLibrary.GetRecentlyAddedMovies==== | ====VideoLibrary.GetRecentlyAddedMovies==== | ||
Retrieve all recently added movies<br /> | Retrieve all recently added movies<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
#[ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
#[ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ] | |||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ '' | *[ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ] | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
</div> | |||
====VideoLibrary.GetRecentlyAddedMusicVideos==== | ====VideoLibrary.GetRecentlyAddedMusicVideos==== | ||
Retrieve all recently added music videos<br /> | Retrieve all recently added music videos<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
#[ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
#[ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ] | |||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ '' | *[ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]''[] musicvideos ] | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
</div> | |||
====VideoLibrary.GetSeasons==== | ====VideoLibrary.GetSeasons==== | ||
Retrieve all tv seasons<br /> | Retrieve all tv seasons<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Library.Id|Library.Id]]'' tvshowid | #''[[#Library.Id|Library.Id]]'' tvshowid | ||
#[ ''[[#Video.Fields.Season|Video.Fields.Season]]'' | #[ ''[[#Video.Fields.Season|Video.Fields.Season]]'' properties ] | ||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ '' | *[ ''[[#Video.Details.Season|Video.Details.Season]]''[] seasons ] | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
</div> | |||
====VideoLibrary.GetTVShowDetails==== | ====VideoLibrary.GetTVShowDetails==== | ||
Retrieve details about a specific tv show<br /> | Retrieve details about a specific tv show<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''[[#Library.Id|Library.Id]]'' tvshowid | #''[[#Library.Id|Library.Id]]'' tvshowid | ||
#[ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' | #[ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''[[#Video.Details.TVShow|Video.Details.TVShow]]'' tvshowdetails ] | *[ ''[[#Video.Details.TVShow|Video.Details.TVShow]]'' tvshowdetails ] | ||
</div> | |||
====VideoLibrary.GetTVShows==== | ====VideoLibrary.GetTVShows==== | ||
Retrieve all tv shows<br /> | Retrieve all tv shows<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
#[ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
#[ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ] | |||
#[ ''[[#List.Limits|List.Limits]]'' limits ] | #[ ''[[#List.Limits|List.Limits]]'' limits ] | ||
#[ ''[[#List.Sort|List.Sort]]'' sort ] | #[ ''[[#List.Sort|List.Sort]]'' sort ] | ||
'''Returns: '''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | *''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
*[ '' | *[ ''[[#Video.Details.TVShow|Video.Details.TVShow]]''[] tvshows ] | ||
</div> | |||
====VideoLibrary.Scan==== | ====VideoLibrary.Scan==== | ||
Scans the video sources for new library items<br /> | Scans the video sources for new library items<br /> | ||
''' | '''Permissions:''' | ||
* UpdateData | |||
* | |||
'''Parameters:''' None | '''Parameters:''' None | ||
<br /> | <br /> | ||
'''Returns | '''Returns:''' ''string'' | ||
===XBMC=== | ===XBMC=== | ||
====XBMC.GetInfoBooleans==== | ====XBMC.GetInfoBooleans==== | ||
Retrieve info booleans about XBMC and the system<br /> | Retrieve info booleans about XBMC and the system<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
#''array'' booleans | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
'''Returns: '''< | #''array''[1..X] booleans | ||
'''Type:''' ''object''< | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object'' | |||
</div> | |||
====XBMC.GetInfoLabels==== | ====XBMC.GetInfoLabels==== | ||
Retrieve info labels about XBMC and the system<br /> | Retrieve info labels about XBMC and the system<br /> | ||
''' | '''Permissions:''' | ||
* ReadData | |||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''array''[1..X] labels | |||
</div> | |||
''' | '''Returns:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
'''Type:''' ''object'' | |||
</div> | |||
''' | |||
# | |||
'''Type:''' '' | |||
Line 1,686: | Line 1,363: | ||
===Application=== | ===Application=== | ||
====Application.Property.Name==== | ====Application.Property.Name==== | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
====Application.Property.Value==== | ====Application.Property.Value==== | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''boolean'' muted = False ] | *[ ''boolean'' muted = False ] | ||
*[ ''integer'' volume = 0 ] | *[ ''integer'' volume = 0 ] | ||
*[ ''object'' version ]<br /> | |||
'''Properties:''' | |||
**''integer'' major | |||
**''string'' tag | |||
**''integer'' minor | |||
**[ ''mixed'' revision = null ] | |||
*[ ''string'' name = "" ] | |||
===Array=== | ===Array=== | ||
====Array.Integer==== | ====Array.Integer==== | ||
'''Type:''' ''array'' | '''Type:''' ''array'' | ||
====Array.String==== | ====Array.String==== | ||
'''Type:''' ''array'' | '''Type:''' ''array'' | ||
===Audio=== | ===Audio=== | ||
====Audio.Details.Album==== | ====Audio.Details.Album==== | ||
''' | '''Extends:''' | ||
*''[[#Audio.Details.Media|Audio.Details.Media]]'' | |||
<br /> | |||
'''Properties:''' | '''Properties:''' | ||
*[ ''string'' style = "" ] | *[ ''string'' style = "" ] | ||
*[ ''string'' mood = "" ] | |||
*[ ''string'' albumlabel = "" ] | |||
*[ ''string'' theme = "" ] | *[ ''string'' theme = "" ] | ||
*''[[#Library.Id|Library.Id]]'' albumid | *''[[#Library.Id|Library.Id]]'' albumid | ||
*[ ''[[#Library.Id|Library.Id]]'' artistid = -1 ] | *[ ''[[#Library.Id|Library.Id]]'' artistid = -1 ] | ||
*[ ''string'' type = "" ] | *[ ''string'' type = "" ] | ||
*[ ''string'' | *[ ''string'' description = "" ] | ||
====Audio.Details.Artist==== | ====Audio.Details.Artist==== | ||
''' | '''Extends:''' | ||
*''[[#Audio.Details.Base|Audio.Details.Base]]'' | |||
<br /> | |||
'''Properties:''' | '''Properties:''' | ||
*[ ''string'' style = "" ] | *[ ''string'' style = "" ] | ||
Line 1,735: | Line 1,407: | ||
*[ ''string'' musicbrainzartistid = "" ] | *[ ''string'' musicbrainzartistid = "" ] | ||
*''string'' artist | *''string'' artist | ||
*[ ''string'' formed = "" ] | *[ ''string'' formed = "" ] | ||
*[ ''string'' disbanded = "" ] | *[ ''string'' disbanded = "" ] | ||
Line 1,742: | Line 1,413: | ||
*[ ''string'' yearsactive = "" ] | *[ ''string'' yearsactive = "" ] | ||
*[ ''string'' instrument = "" ] | *[ ''string'' instrument = "" ] | ||
*[ ''string'' died = "" ] | *[ ''string'' died = "" ] | ||
*[ ''string'' mood = "" ] | *[ ''string'' mood = "" ] | ||
====Audio.Details. | ====Audio.Details.Base==== | ||
''' | '''Extends:''' | ||
''' | *''[[#Media.Details.Base|Media.Details.Base]]'' | ||
<br /> | |||
'''Properties:''' | |||
*[ ''string'' genre = "" ] | |||
====Audio.Details.Media==== | |||
'''Extends:''' | |||
*''[[#Audio.Details.Base|Audio.Details.Base]]'' | |||
<br /> | |||
'''Properties:''' | '''Properties:''' | ||
*[ ''integer'' rating = 0 ] | *[ ''integer'' rating = 0 ] | ||
*[ ''string'' | *[ ''string'' title = "" ] | ||
*[ ''string'' | *[ ''string'' artist = "" ] | ||
*[ ''string'' | *[ ''string'' musicbrainzalbumartistid = "" ] | ||
*[ ''integer'' year = 0 ] | *[ ''integer'' year = 0 ] | ||
*[ ''string'' musicbrainzalbumid = "" ] | *[ ''string'' musicbrainzalbumid = "" ] | ||
====Audio.Details.Song==== | |||
'''Extends:''' | |||
*''[[#Audio.Details.Media|Audio.Details.Media]]'' | |||
<br /> | |||
'''Properties:''' | |||
*[ ''string'' album = "" ] | *[ ''string'' album = "" ] | ||
*[ ''string'' | *[ ''string'' comment = "" ] | ||
*''[[#Library.Id|Library.Id]]'' songid | *''[[#Library.Id|Library.Id]]'' songid | ||
*[ ''string'' musicbrainzartistid = "" ] | |||
*[ ''string'' lyrics = "" ] | |||
*[ ''integer'' track = 0 ] | *[ ''integer'' track = 0 ] | ||
*[ ''string'' musicbrainztrackid = "" ] | *[ ''string'' musicbrainztrackid = "" ] | ||
*[ '' | *[ ''[[#Library.Id|Library.Id]]'' albumid = -1 ] | ||
*[ ''string'' | *[ ''[[#Library.Id|Library.Id]]'' artistid = -1 ] | ||
*[ ''string'' | *[ ''string'' albumartist = "" ] | ||
*[ '' | *[ ''string'' file = "" ] | ||
*[ ''integer'' duration = 0 ] | |||
*[ ''integer'' playcount = 0 ] | *[ ''integer'' playcount = 0 ] | ||
====Audio.Fields.Album==== | ====Audio.Fields.Album==== | ||
''' | '''Extends:''' | ||
*''[[#Item.Fields.Base|Item.Fields.Base]]'' | |||
====Audio.Fields.Artist==== | ====Audio.Fields.Artist==== | ||
''' | '''Extends:''' | ||
*''[[#Item.Fields.Base|Item.Fields.Base]]'' | |||
====Audio.Fields.Song==== | ====Audio.Fields.Song==== | ||
''' | '''Extends:''' | ||
*''[[#Item.Fields.Base|Item.Fields.Base]]'' | |||
===Configuration=== | ===Configuration=== | ||
====Configuration==== | ====Configuration==== | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*''[[#Configuration.Notifications|Configuration.Notifications]]'' notifications | *''[[#Configuration.Notifications|Configuration.Notifications]]'' notifications | ||
Line 1,794: | Line 1,474: | ||
====Configuration.Notifications==== | ====Configuration.Notifications==== | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*''boolean'' gui | *''boolean'' gui | ||
Line 1,805: | Line 1,484: | ||
===Files=== | ===Files=== | ||
====Files.Media==== | ====Files.Media==== | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
===Global=== | ===Global=== | ||
====Global.Time==== | ====Global.Time==== | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*''integer'' hours | *''integer'' hours | ||
Line 1,818: | Line 1,494: | ||
*''integer'' milliseconds | *''integer'' milliseconds | ||
===Item=== | |||
====Item.Details.Base==== | |||
'''Type:''' ''object''<br /> | |||
'''Properties:''' | |||
*''string'' label | |||
====Item.Fields.Base==== | |||
'''Type:''' ''array'' | |||
===Library=== | ===Library=== | ||
====Library.Details.Genre==== | ====Library.Details.Genre==== | ||
''' | '''Extends:''' | ||
*''[[#Item.Details.Base|Item.Details.Base]]'' | |||
<br /> | |||
'''Properties:''' | '''Properties:''' | ||
*''[[#Library.Id|Library.Id]]'' genreid | *''[[#Library.Id|Library.Id]]'' genreid | ||
*[ ''string'' thumbnail = "" ] | |||
*[ ''string'' title = "" ] | *[ ''string'' title = "" ] | ||
====Library.Fields.Genre==== | ====Library.Fields.Genre==== | ||
''' | '''Extends:''' | ||
*''[[#Item.Fields.Base|Item.Fields.Base]]'' | |||
====Library.Id==== | ====Library.Id==== | ||
'''Type:''' ''integer'' | '''Type:''' ''integer'' | ||
===List=== | ===List=== | ||
====List.Amount==== | ====List.Amount==== | ||
'''Type:''' ''integer'' | '''Type:''' ''integer'' | ||
====List.Fields.All==== | ====List.Fields.All==== | ||
''' | '''Extends:''' | ||
*''[[#Item.Fields.Base|Item.Fields.Base]]'' | |||
====List. | |||
''' | ====List.Item.All==== | ||
''' | '''Extends:''' | ||
== | *''[[#Video.Details.File|Video.Details.File]]'' | ||
''' | *''[[#Audio.Details.Media|Audio.Details.Media]]'' | ||
''' | <br /> | ||
==== | '''Properties:''' | ||
''' | *[ ''string'' comment = "" ] | ||
''' | *[ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ] | ||
==== | *[ ''[[#Array.String|Array.String]]'' set ] | ||
''' | *[ ''string'' lyrics = "" ] | ||
''' | *[ ''string'' albumartist = "" ] | ||
====List. | *[ ''integer'' duration = 0 ] | ||
''' | *[ ''[[#Array.Integer|Array.Integer]]'' setid ] | ||
''' | *[ ''[[#Library.Id|Library.Id]]'' id = -1 ] | ||
====List.Items. | *[ ''string'' album = "" ] | ||
'''Type:''' ''array'' | *[ ''string'' votes = "" ] | ||
*[ ''string'' mpaa = "" ] | |||
*[ ''string'' writer = "" ] | |||
*[ ''[[#Library.Id|Library.Id]]'' albumid = -1 ] | |||
*[ ''string'' type = "unknown" ] | |||
*[ ''string'' plotoutline = "" ] | |||
*[ ''integer'' track = 0 ] | |||
*[ ''integer'' season = 0 ] | |||
*[ ''string'' musicbrainztrackid = "" ] | |||
*[ ''string'' imdbnumber = "" ] | |||
*[ ''string'' studio = "" ] | |||
*[ ''string'' showlink = "" ] | |||
*[ ''string'' showtitle = "" ] | |||
*[ ''integer'' episode = 0 ] | |||
*[ ''string'' musicbrainzartistid = "" ] | |||
*[ ''string'' productioncode = "" ] | |||
*[ ''string'' country = "" ] | |||
*[ ''string'' premiered = "" ] | |||
*[ ''string'' originaltitle = "" ] | |||
*[ ''[[#Video.Cast|Video.Cast]]'' cast ] | |||
*[ ''[[#Library.Id|Library.Id]]'' artistid = -1 ] | |||
*[ ''string'' firstaired = "" ] | |||
*[ ''string'' tagline = "" ] | |||
*[ ''integer'' top250 = 0 ] | |||
*[ ''string'' trailer = "" ] | |||
====List.Item.File==== | |||
'''Extends:''' | |||
*''[[#List.Item.All|List.Item.All]]'' | |||
<br /> | |||
'''Properties:''' | |||
*''string'' filetype | |||
*''string'' file | |||
====List.Items.Sources==== | |||
'''Type:''' ''array'' | |||
====List.Limits==== | ====List.Limits==== | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''integer'' start = 0 ] | *[ ''integer'' start = 0 ] | ||
Line 1,870: | Line 1,584: | ||
====List.LimitsReturned==== | ====List.LimitsReturned==== | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*''integer'' start | *[ ''integer'' start = 0 ] | ||
*''integer'' total | *''integer'' total | ||
*''integer'' end | *[ ''integer'' end = -1 ] | ||
====List.Sort==== | ====List.Sort==== | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''string'' order = "ascending" ] | *[ ''string'' order = "ascending" ] | ||
*[ ''boolean'' ignorearticle = False ] | *[ ''boolean'' ignorearticle = False ] | ||
*[ ''string'' method = "none" ] | *[ ''string'' method = "none" ] | ||
===Media=== | |||
====Media.Details.Base==== | |||
'''Extends:''' | |||
*''[[#Item.Details.Base|Item.Details.Base]]'' | |||
<br /> | |||
'''Properties:''' | |||
*[ ''string'' fanart = "" ] | |||
*[ ''string'' thumbnail = "" ] | |||
===Optional=== | ===Optional=== | ||
====Optional.Boolean==== | ====Optional.Boolean==== | ||
'''Type:''' '' | '''Type:''' ''mixed'' | ||
===Player=== | ===Player=== | ||
====Player. | ====Player.Audio.Stream==== | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*'' | *''integer'' index | ||
*'' | *''string'' name | ||
*''string'' language | |||
====Player.Audio.Stream.Extended==== | |||
'''Extends:''' | |||
*''[[#Player.Audio.Stream|Player.Audio.Stream]]'' | |||
<br /> | |||
'''Properties:''' | |||
*''integer'' channels | |||
*''string'' codec | |||
*''integer'' bitrate | |||
====Player. | ====Player.Id==== | ||
'''Type:''' ''integer'' | |||
====Player.Notifications.Data==== | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*'' | *''[[#Player.Notifications.Item|Player.Notifications.Item]]'' item | ||
*'' | *''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player | ||
====Player. | ====Player.Notifications.Item==== | ||
'''Type:''' ''mixed'' | |||
====Player.Notifications.Item.Type==== | |||
'''Type:''' ''string'' | |||
====Player.Notifications.Player==== | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*''[[#Player.Id|Player.Id]]'' playerid | |||
*''[[# | *[ ''integer'' speed = 0 ] | ||
*'' | |||
=== | ====Player.Notifications.Player.Seek==== | ||
==== | '''Extends:''' | ||
*''[[#Player.Notifications.Player|Player.Notifications.Player]]'' | |||
<br /> | |||
'''Properties:''' | |||
*[ ''[[#Global.Time|Global.Time]]'' seekoffset ] | |||
*[ ''[[#Global.Time|Global.Time]]'' time ] | |||
====Player.Position.Percentage==== | |||
'''Type:''' ''number'' | |||
====Player.Property.Name==== | |||
'''Type:''' ''string'' | |||
====Player.Property.Value==== | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''[[# | *[ ''boolean'' canrotate = False ] | ||
*[ ''[[# | *[ ''boolean'' canrepeat = False ] | ||
*[ ''[[# | *[ ''integer'' speed = 0 ] | ||
*[ ''[[# | *[ ''boolean'' canshuffle = False ] | ||
*[ '' | *[ ''boolean'' shuffled = False ] | ||
*[ '' | *[ ''boolean'' canmove = False ] | ||
*[ ''[[# | *[ ''boolean'' subtitleenabled = False ] | ||
*[ ''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage = 0 ] | |||
*[ ''[[#Player.Type|Player.Type]]'' type = "video" ] | |||
*[ ''[[#Player.Repeat|Player.Repeat]]'' repeat = "off" ] | |||
*[ ''boolean'' canseek = False ] | |||
*[ ''[[#Player.Subtitle|Player.Subtitle]]'' currentsubtitle ] | |||
*[ ''[[#Player.Subtitle|Player.Subtitle]]''[] subtitles ] | |||
*[ ''[[#Global.Time|Global.Time]]'' totaltime ] | |||
*[ ''boolean'' canzoom = False ] | |||
*[ ''[[#Player.Audio.Stream.Extended|Player.Audio.Stream.Extended]]'' currentaudiostream ] | |||
*[ ''[[#Playlist.Id|Playlist.Id]]'' playlistid = -1 ] | |||
*[ ''[[#Player.Audio.Stream.Extended|Player.Audio.Stream.Extended]]''[] audiostreams ] | |||
*[ ''boolean'' partymode = False ] | |||
*[ ''[[#Global.Time|Global.Time]]'' time ] | |||
*[ ''[[#Playlist.Position|Playlist.Position]]'' position = -1 ] | |||
*[ ''boolean'' canchangespeed = False ] | |||
==== | ====Player.Repeat==== | ||
'''Type:''' ''string'' | |||
====Player.Speed==== | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ '' | *[ ''integer'' speed = 0 ] | ||
==== | ====Player.Subtitle==== | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*''integer'' | *''integer'' index | ||
*'' | *''string'' name | ||
*'' | *''string'' language | ||
====Playlist. | ====Player.Type==== | ||
'''Type:''' ''string'' | |||
===Playlist=== | |||
====Playlist.Id==== | |||
'''Type:''' ''integer'' | |||
====Playlist.Item==== | |||
'''Type:''' ''mixed'' | |||
====Playlist.Position==== | |||
'''Type:''' ''integer'' | |||
====Playlist.Property.Name==== | |||
'''Type:''' ''string'' | |||
====Playlist.Property.Value==== | |||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''[[#Playlist. | *[ ''[[#Playlist.Type|Playlist.Type]]'' type = "unknown" ] | ||
*[ ''integer'' size = 0 ] | |||
*[ '' | |||
====Playlist.Type==== | |||
'''Type:''' ''string'' | |||
===System=== | ===System=== | ||
====System.Property.Name==== | ====System.Property.Name==== | ||
'''Type:''' ''string'' | '''Type:''' ''string'' | ||
====System.Property.Value==== | ====System.Property.Value==== | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''boolean'' canreboot = False ] | *[ ''boolean'' canreboot = False ] | ||
Line 1,987: | Line 1,727: | ||
===Video=== | ===Video=== | ||
====Video.Cast==== | ====Video.Cast==== | ||
'''Type:''' ''array''<br /> | '''Type:''' ''array'' | ||
''' | ====Video.Details.Base==== | ||
'''Extends:''' | |||
*''[[#Media.Details.Base|Media.Details.Base]]'' | |||
<br /> | |||
'''Properties:''' | |||
*[ ''integer'' playcount = 0 ] | |||
====Video.Details.Episode==== | ====Video.Details.Episode==== | ||
''' | '''Extends:''' | ||
*''[[#Video.Details.File|Video.Details.File]]'' | |||
<br /> | |||
'''Properties:''' | '''Properties:''' | ||
*[ ''number'' rating = 0 ] | *[ ''number'' rating = 0 ] | ||
*[ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ] | *[ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ] | ||
*[ ''string'' votes = "" ] | *[ ''string'' votes = "" ] | ||
*[ ''integer'' episode = 0 ] | *[ ''integer'' episode = 0 ] | ||
*[ ''string'' productioncode = "" ] | *[ ''string'' productioncode = "" ] | ||
*[ ''string'' | *[ ''integer'' season = 0 ] | ||
*[ ''string'' writer = "" ] | |||
*''[[#Library.Id|Library.Id]]'' episodeid | *''[[#Library.Id|Library.Id]]'' episodeid | ||
*[ ''string'' originaltitle = "" ] | *[ ''string'' originaltitle = "" ] | ||
*[ ''[[#Video.Cast|Video.Cast]]'' cast ] | *[ ''[[#Video.Cast|Video.Cast]]'' cast ] | ||
*[ ''string'' firstaired = "" ] | *[ ''string'' firstaired = "" ] | ||
*[ '' | *[ ''string'' showtitle = "" ] | ||
====Video.Details.File==== | |||
'''Extends:''' | |||
*''[[#Video.Details.Item|Video.Details.Item]]'' | |||
<br /> | |||
'''Properties:''' | |||
*[ ''string'' director = "" ] | |||
*[ ''[[#Video.Streams|Video.Streams]]'' streamdetails ] | |||
*[ ''string'' runtime = "" ] | *[ ''string'' runtime = "" ] | ||
*[ ''[[#Video.Resume|Video.Resume]]'' resume ] | |||
====Video.Details.Item==== | |||
'''Extends:''' | |||
*''[[#Video.Details.Media|Video.Details.Media]]'' | |||
<br /> | |||
'''Properties:''' | |||
*[ ''string'' plot = "" ] | |||
*[ ''string'' lastplayed = "" ] | |||
*[ ''string'' file = "" ] | |||
====Video.Details.Media==== | |||
'''Extends:''' | |||
*''[[#Video.Details.Base|Video.Details.Base]]'' | |||
<br /> | |||
'''Properties:''' | |||
*[ ''string'' title = "" ] | |||
====Video.Details.Movie==== | ====Video.Details.Movie==== | ||
''' | '''Extends:''' | ||
*''[[#Video.Details.File|Video.Details.File]]'' | |||
<br /> | |||
'''Properties:''' | '''Properties:''' | ||
*[ ''number'' rating = 0 ] | *[ ''number'' rating = 0 ] | ||
*[ ''[[#Array.String|Array.String]]'' set ] | *[ ''[[#Array.String|Array.String]]'' set ] | ||
*[ ''integer'' year = 0 ] | *[ ''integer'' year = 0 ] | ||
*[ ''[[#Array.Integer|Array.Integer]]'' setid ] | *[ ''[[#Array.Integer|Array.Integer]]'' setid ] | ||
*[ ''string'' votes = "" ] | *[ ''string'' votes = "" ] | ||
*[ ''string'' | *[ ''string'' tagline = "" ] | ||
*[ ''string'' writer = "" ] | *[ ''string'' writer = "" ] | ||
*[ ''string'' plotoutline = "" ] | *[ ''string'' plotoutline = "" ] | ||
*[ ''string'' sorttitle = "" ] | |||
*[ ''string'' | |||
*[ ''string'' imdbnumber = "" ] | *[ ''string'' imdbnumber = "" ] | ||
*[ ''string'' studio = "" ] | *[ ''string'' studio = "" ] | ||
Line 2,047: | Line 1,800: | ||
*[ ''string'' productioncode = "" ] | *[ ''string'' productioncode = "" ] | ||
*[ ''string'' country = "" ] | *[ ''string'' country = "" ] | ||
*[ ''string'' premiered = "" ] | *[ ''string'' premiered = "" ] | ||
*[ ''string'' originaltitle = "" ] | *[ ''string'' originaltitle = "" ] | ||
*[ ''[[#Video.Cast|Video.Cast]]'' cast ] | *[ ''[[#Video.Cast|Video.Cast]]'' cast ] | ||
*[ ''string'' | *[ ''string'' mpaa = "" ] | ||
*[ ''integer'' top250 = 0 ] | *[ ''integer'' top250 = 0 ] | ||
*[ ''string'' trailer = "" ] | *[ ''string'' trailer = "" ] | ||
====Video.Details.MovieSet==== | ====Video.Details.MovieSet==== | ||
''' | '''Extends:''' | ||
*''[[#Video.Details.Media|Video.Details.Media]]'' | |||
<br /> | |||
'''Properties:''' | '''Properties:''' | ||
*''[[#Library.Id|Library.Id]]'' setid | *''[[#Library.Id|Library.Id]]'' setid | ||
====Video.Details.MovieSet.Extended==== | ====Video.Details.MovieSet.Extended==== | ||
''' | '''Extends:''' | ||
*''[[#Video.Details.MovieSet|Video.Details.MovieSet]]'' | |||
<br /> | |||
'''Properties:''' | '''Properties:''' | ||
*[ | *[ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ] | ||
====Video.Details.MusicVideo==== | ====Video.Details.MusicVideo==== | ||
''' | '''Extends:''' | ||
*''[[#Video.Details.File|Video.Details.File]]'' | |||
<br /> | |||
'''Properties:''' | '''Properties:''' | ||
*[ ''string'' album = "" ] | *[ ''string'' album = "" ] | ||
*[ ''string'' artist = "" ] | *[ ''string'' artist = "" ] | ||
*[ '' | *[ ''integer'' track = 0 ] | ||
*[ ''string'' | *[ ''string'' studio = "" ] | ||
*[ ''integer'' year = 0 ] | *[ ''integer'' year = 0 ] | ||
*[ ''string'' genre = "" ] | *[ ''string'' genre = "" ] | ||
*''[[#Library.Id|Library.Id]]'' musicvideoid | *''[[#Library.Id|Library.Id]]'' musicvideoid | ||
====Video.Details.Season==== | ====Video.Details.Season==== | ||
''' | '''Extends:''' | ||
*''[[#Video.Details.Base|Video.Details.Base]]'' | |||
<br /> | |||
'''Properties:''' | '''Properties:''' | ||
*''integer'' season | |||
*[ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ] | *[ ''[[#Library.Id|Library.Id]]'' tvshowid = -1 ] | ||
*[ ''integer'' episode = 0 ] | *[ ''integer'' episode = 0 ] | ||
*[ ''string'' showtitle = "" ] | *[ ''string'' showtitle = "" ] | ||
====Video.Details.TVShow==== | ====Video.Details.TVShow==== | ||
''' | '''Extends:''' | ||
*''[[#Video.Details.Item|Video.Details.Item]]'' | |||
<br /> | |||
'''Properties:''' | '''Properties:''' | ||
*[ ''string'' episodeguide = "" ] | *[ ''string'' episodeguide = "" ] | ||
*''[[#Library.Id|Library.Id]]'' tvshowid | *''[[#Library.Id|Library.Id]]'' tvshowid | ||
*[ ''integer'' episode = 0 ] | |||
*[ ''string'' imdbnumber = "" ] | |||
*[ ''number'' rating = 0 ] | *[ ''number'' rating = 0 ] | ||
*[ ''string'' | *[ ''string'' mpaa = "" ] | ||
*[ ''integer'' year = 0 ] | *[ ''integer'' year = 0 ] | ||
*[ ''string'' votes = "" ] | *[ ''string'' votes = "" ] | ||
*[ ''string'' premiered = "" ] | *[ ''string'' premiered = "" ] | ||
*[ ''string'' originaltitle = "" ] | *[ ''string'' originaltitle = "" ] | ||
*[ ''[[#Video.Cast|Video.Cast]]'' cast ] | *[ ''[[#Video.Cast|Video.Cast]]'' cast ] | ||
*[ ''string'' studio = "" ] | |||
*[ ''string'' sorttitle = "" ] | *[ ''string'' sorttitle = "" ] | ||
*[ '' | *[ ''string'' genre = "" ] | ||
====Video.Fields.Episode==== | ====Video.Fields.Episode==== | ||
''' | '''Extends:''' | ||
*''[[#Item.Fields.Base|Item.Fields.Base]]'' | |||
====Video.Fields.Movie==== | ====Video.Fields.Movie==== | ||
''' | '''Extends:''' | ||
*''[[#Item.Fields.Base|Item.Fields.Base]]'' | |||
====Video.Fields.MovieSet==== | ====Video.Fields.MovieSet==== | ||
''' | '''Extends:''' | ||
*''[[#Item.Fields.Base|Item.Fields.Base]]'' | |||
====Video.Fields.MusicVideo==== | ====Video.Fields.MusicVideo==== | ||
''' | '''Extends:''' | ||
*''[[#Item.Fields.Base|Item.Fields.Base]]'' | |||
====Video.Fields.Season==== | ====Video.Fields.Season==== | ||
''' | '''Extends:''' | ||
*''[[#Item.Fields.Base|Item.Fields.Base]]'' | |||
====Video.Fields.TVShow==== | ====Video.Fields.TVShow==== | ||
''' | '''Extends:''' | ||
*''[[#Item.Fields.Base|Item.Fields.Base]]'' | |||
====Video.Resume==== | ====Video.Resume==== | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''number'' position = 0 ] | *[ ''number'' position = 0 ] | ||
Line 2,171: | Line 1,896: | ||
====Video.Streams==== | ====Video.Streams==== | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''array'' video ] | *[ ''array''[1..X] video ] | ||
*[ ''array'' audio ] | *[ ''array''[1..X] audio ] | ||
*[ ''array'' subtitle ] | *[ ''array''[1..X] subtitle ] | ||
==Notifications== | ==Notifications== | ||
Line 2,182: | Line 1,907: | ||
An audio item has been removed.<br /> | An audio item has been removed.<br /> | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' sender | #''string'' sender | ||
#''object'' data<br /> | #''object'' data<br /> | ||
Line 2,187: | Line 1,913: | ||
*''[[#Notifications.Library.Audio.Type|Notifications.Library.Audio.Type]]'' type | *''[[#Notifications.Library.Audio.Type|Notifications.Library.Audio.Type]]'' type | ||
*''[[#Library.Id|Library.Id]]'' id | *''[[#Library.Id|Library.Id]]'' id | ||
'''Returns: '''null | |||
</div> | |||
'''Returns:''' null | |||
====AudioLibrary.OnUpdate==== | ====AudioLibrary.OnUpdate==== | ||
An audio item has been updated.<br /> | An audio item has been updated.<br /> | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' sender | #''string'' sender | ||
#''object'' data<br /> | #''object'' data<br /> | ||
Line 2,197: | Line 1,926: | ||
*''string'' type | *''string'' type | ||
*''[[#Library.Id|Library.Id]]'' id | *''[[#Library.Id|Library.Id]]'' id | ||
'''Returns: '''null | |||
</div> | |||
'''Returns:''' null | |||
===Player=== | ===Player=== | ||
Line 2,203: | Line 1,934: | ||
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:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' sender | #''string'' sender | ||
# | #''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data | ||
</div> | |||
'''Returns:''' null | |||
'''Returns: '''null | |||
====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:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' sender | #''string'' sender | ||
# | #''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data | ||
</div> | |||
'''Returns:''' null | |||
'''Returns: '''null | |||
====Player.OnSeek==== | ====Player.OnSeek==== | ||
The playback position has been changed.<br /> | The playback position has been changed. If there is no ID available extra information will be provided.<br /> | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' sender | #''string'' sender | ||
#''object'' data<br /> | #''object'' data<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*'' | *[ ''[[#Player.Notifications.Item|Player.Notifications.Item]]'' item ] | ||
*'' | *''[[#Player.Notifications.Player.Seek|Player.Notifications.Player.Seek]]'' player | ||
'''Returns: '''null | |||
</div> | |||
'''Returns:''' null | |||
====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 /> | |||
'''Parameters:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' sender | |||
#''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data | |||
</div> | |||
'''Returns:''' null | |||
====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:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' sender | #''string'' sender | ||
#''object'' data<br /> | #''object'' data<br /> | ||
'''Properties:''' | '''Properties:''' | ||
*[ ''[[#Player.Notifications.Item|Player.Notifications.Item]]'' item ] | |||
</div> | |||
'''Returns:''' null | |||
*[ ''[[#Notifications.Player. | |||
'''Returns: '''null | |||
===System=== | ===System=== | ||
Line 2,269: | Line 1,987: | ||
The system is on low battery.<br /> | The system is on low battery.<br /> | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' sender | #''string'' sender | ||
#''null'' data | #''null'' data | ||
'''Returns: '''null | </div> | ||
'''Returns:''' null | |||
====System.OnQuit==== | ====System.OnQuit==== | ||
XBMC will be closed.<br /> | XBMC will be closed.<br /> | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' sender | #''string'' sender | ||
#''null'' data | #''null'' data | ||
'''Returns: '''null | </div> | ||
'''Returns:''' null | |||
====System.OnRestart==== | ====System.OnRestart==== | ||
The system will be restarted.<br /> | The system will be restarted.<br /> | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' sender | #''string'' sender | ||
#''null'' data | #''null'' data | ||
'''Returns: '''null | </div> | ||
'''Returns:''' null | |||
====System.OnSleep==== | ====System.OnSleep==== | ||
The system will be suspended.<br /> | The system will be suspended.<br /> | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' sender | #''string'' sender | ||
#''null'' data | #''null'' data | ||
'''Returns: '''null | </div> | ||
'''Returns:''' null | |||
====System.OnWake==== | ====System.OnWake==== | ||
The system woke up from suspension.<br /> | The system woke up from suspension.<br /> | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' sender | #''string'' sender | ||
#''null'' data | #''null'' data | ||
'''Returns: '''null | </div> | ||
'''Returns:''' null | |||
===VideoLibrary=== | ===VideoLibrary=== | ||
Line 2,305: | Line 2,033: | ||
A video item has been removed.<br /> | A video item has been removed.<br /> | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' sender | #''string'' sender | ||
#''object'' data<br /> | #''object'' data<br /> | ||
Line 2,310: | Line 2,039: | ||
*''[[#Notifications.Library.Video.Type|Notifications.Library.Video.Type]]'' type | *''[[#Notifications.Library.Video.Type|Notifications.Library.Video.Type]]'' type | ||
*''[[#Library.Id|Library.Id]]'' id | *''[[#Library.Id|Library.Id]]'' id | ||
'''Returns: '''null | |||
</div> | |||
'''Returns:''' null | |||
====VideoLibrary.OnUpdate==== | ====VideoLibrary.OnUpdate==== | ||
A video item has been updated.<br /> | A video item has been updated.<br /> | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
#''string'' sender | #''string'' sender | ||
#''object'' data<br /> | #''object'' data<br /> | ||
Line 2,321: | Line 2,053: | ||
*''string'' type | *''string'' type | ||
*''[[#Library.Id|Library.Id]]'' id | *''[[#Library.Id|Library.Id]]'' id | ||
'''Returns: '''null | |||
</div> | |||
'''Returns:''' null | |||
==See also== | ==See also== |
Revision as of 09:29, 25 October 2011
Version 3 is a development version of XBMC's JSON-RPC API and will be released as a stable version 4 with the release of Eden. It is a complete re-write and re-structuring of version 2 and therefore isn't backwards compatible to it. The main reason for this was the need to make this version fully compatible with all the functionality, features and requirements of the JSON-RPC 2.0 specification. This was a main concern during early development to make it easier for third party developers and applications to interact with XBMC's JSON-RPC API by using existing JSON-RPC libraries.
An rough and incomplete list of changes compared to version 2 can be found here. A more complete and detailed list can be found in the forum.
JSON-RPC 2.0 compatibility
Version | Method calls | Notifications (server-side) |
Notifications (client-side) |
Parameters by-name |
Parameters by-position |
Bulk requests |
---|---|---|---|---|---|---|
Version 3 | Yes | Yes | Yes | Yes | Yes | Yes |
Documentation (JSON Schema)
Starting with JSON-RPC API version 3 a new way of API documentation has been introduced. All methods and data types are described using JSON Schema. This provides third party developers with an always complete and up-to-date documentation by calling JSONRPC.Introspect even during periods of heavy development. Furthermore the same method and data type specification that can be used by third party developers as a documentation is used by XBMC to check and verify method parameters and their values on every JSON-RPC request and allows to provide detailed error messages in case of a bad or missing parameter.
Supported features of JSON Schema
Schema | IETF Draft 03 |
---|---|
type | Yes |
properties | Yes |
patternProperties | No |
additionalProperties | Yes |
items | Yes |
additionalItems | Yes |
required | Yes |
dependencies | No |
minimum | Yes |
maximum | Yes |
Schema | IETF Draft 03 |
---|---|
exclusiveMinimum | Yes |
exclusiveMaximum | Yes |
minItems | Yes |
maxItems | Yes |
uniqueItems | Yes |
pattern | No |
minLength | Yes |
maxLength | Yes |
enum | Yes |
default | Yes |
Schema | IETF Draft 03 |
---|---|
title | No |
description | Yes |
format | No |
divisibleBy | Yes |
disallow | No |
extends | Yes |
id | Yes |
$ref | Yes |
$schema | No |
Hyper Schema | No |
Error message
If XBMC detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is
{ "type": "object", "properties": { "code": { "type": "integer", "required": true }, "message": { "type": "string", "required": true }, "data": { "type": "object", "properties": { "method": { "type": "string", "required": true }, "stack": { "type": "object", "id": "Error.Stack", "properties": { "name": { "type": "string", "required": true }, "type": { "type": "string", "required": true }, "message": { "type": "string", "required": true }, "property": { "$ref": "Error.Stack" } } } } } } }
Namespaces
The XBMC JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:
JSONRPC A variety of standard JSONRPC calls Player Manages all available players Playlist Playlist modification Files Shares information AudioLibrary Audio Library information VideoLibrary Video Library information Input Allows limited navigation within XBMC Application Application information and control System System controls and information XBMC Dumping ground for very XBMC specific operations
Methods
Application
Application.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- Application.Property.Name[] properties
Returns: Application.Property.Value
Application.Quit
Quit application
Permissions:
- ControlPower
Parameters: None
Returns: string
Application.SetMute
Toggle mute/unmute
Permissions:
- ControlPlayback
Parameters:
- mixed mute
Returns: boolean
Application.SetVolume
Set the current volume
Permissions:
- ControlPlayback
Parameters:
- integer volume
Returns: integer
AudioLibrary
AudioLibrary.Clean
Cleans the audio library from non-existent items
Permissions:
- RemoveData
Parameters: None
Returns: string
AudioLibrary.Export
Exports all items from the audio library
Permissions:
- WriteFile
Parameters:
- [ mixed options ]
Returns: string
AudioLibrary.GetAlbumDetails
Retrieve details about a specific album
Permissions:
- ReadData
Parameters:
- Library.Id albumid
- [ Audio.Fields.Album properties ]
Returns:
Type: object
Properties:
- [ Audio.Details.Album albumdetails ]
AudioLibrary.GetAlbums
Retrieve all albums from specified artist or genre
Permissions:
- ReadData
Parameters:
- [ Library.Id artistid = -1 ]
- [ Library.Id genreid = -1 ]
- [ Audio.Fields.Album properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- [ Audio.Details.Album[] albums ]
- List.LimitsReturned limits
AudioLibrary.GetArtistDetails
Retrieve details about a specific artist
Permissions:
- ReadData
Parameters:
- Library.Id artistid
- [ Audio.Fields.Artist properties ]
Returns:
Type: object
Properties:
- [ Audio.Details.Artist artistdetails ]
AudioLibrary.GetArtists
Retrieve all artists
Permissions:
- ReadData
Parameters:
- [ Optional.Boolean albumartistsonly = null ]
- [ Library.Id genreid = -1 ]
- [ Audio.Fields.Artist properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Audio.Details.Artist[] artists ]
AudioLibrary.GetGenres
Retrieve all genres
Permissions:
- ReadData
Parameters:
- [ Library.Fields.Genre properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- Library.Details.Genre[] genres
- List.LimitsReturned limits
AudioLibrary.GetRecentlyAddedAlbums
Retrieve recently added albums
Permissions:
- ReadData
Parameters:
- [ Audio.Fields.Album properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- [ Audio.Details.Album[] albums ]
- List.LimitsReturned limits
AudioLibrary.GetRecentlyAddedSongs
Retrieve recently added songs
Permissions:
- ReadData
Parameters:
- [ List.Amount albumlimit = -1 ]
- [ Audio.Fields.Song properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Audio.Details.Song[] songs ]
AudioLibrary.GetSongDetails
Retrieve details about a specific song
Permissions:
- ReadData
Parameters:
- Library.Id songid
- [ Audio.Fields.Song properties ]
Returns:
Type: object
Properties:
- [ Audio.Details.Song songdetails ]
AudioLibrary.GetSongs
Retrieve all songs from specified album, artist or genre
Permissions:
- ReadData
Parameters:
- [ Library.Id artistid = -1 ]
- [ Library.Id albumid = -1 ]
- [ Library.Id genreid = -1 ]
- [ Audio.Fields.Song properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Audio.Details.Song[] songs ]
AudioLibrary.Scan
Scans the audio sources for new library items
Permissions:
- UpdateData
Parameters: None
Returns: string
Files
Files.Download
Provides a way to download a given file (e.g. providing an URL to the real file location)
Permissions:
- ReadData
Parameters:
- string path
Returns:
Type: object
Properties:
- string path
Files.GetDirectory
Get the directories and files in the given directory
Permissions:
- ReadData
Parameters:
- string directory
- [ Files.Media media = "files" ]
- [ List.Fields.All properties ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.Item.File[] files
- List.LimitsReturned limits
Files.GetSources
Get the sources of the media windows
Permissions:
- ReadData
Parameters:
- Files.Media media
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.Items.Sources sources
- List.LimitsReturned limits
Input
Input.Back
Goes back in GUI
Permissions:
- Navigate
Parameters: None
Returns: string
Input.Down
Navigate down in GUI
Permissions:
- Navigate
Parameters: None
Returns: string
Input.Home
Goes to home window in GUI
Permissions:
- Navigate
Parameters: None
Returns: string
Input.Left
Navigate left in GUI
Permissions:
- Navigate
Parameters: None
Returns: string
Input.Right
Navigate right in GUI
Permissions:
- Navigate
Parameters: None
Returns: string
Input.Select
Select current item in GUI
Permissions:
- Navigate
Parameters: None
Returns: string
Input.Up
Navigate up in GUI
Permissions:
- Navigate
Parameters: None
Returns: string
JSONRPC
JSONRPC.Introspect
Enumerates all actions and descriptions
Permissions:
- ReadData
Parameters:
- [ boolean getdescriptions = True ]
- [ boolean getmetadata = False ]
- [ boolean filterbytransport = True ]
- [ object filter ]
Properties:
- string type
- string id
- [ boolean getreferences = True ]
Returns:
Type: object
JSONRPC.NotifyAll
Notify all other connected clients
Permissions:
- ReadData
Parameters:
- string sender
- string message
- [ any data = null ]
Returns: any
JSONRPC.Permission
Retrieve the clients permissions
Permissions:
- ReadData
Parameters: None
Returns:
Type: object
Properties:
- boolean navigate
- boolean removedata
- boolean controlplayback
- boolean readdata
- boolean updatedata
- boolean writefile
- boolean controlnotify
- boolean controlpower
JSONRPC.Ping
Ping responder
Permissions:
- ReadData
Parameters: None
Returns: string
JSONRPC.Version
Retrieve the jsonrpc protocol version
Permissions:
- ReadData
Parameters: None
Returns: string
Player
Player.GetActivePlayers
Returns all active players
Permissions:
- ReadData
Parameters: None
Returns:
Type: array
Player.GetItem
Retrieves the currently played item
Permissions:
- ReadData
Parameters:
- Player.Id playerid
- [ List.Fields.All properties ]
Returns:
Type: object
Properties:
- List.Item.All item
Player.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- Player.Id playerid
- Player.Property.Name[] properties
Returns: Player.Property.Value
Player.GoNext
Go to next item on the playlist
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
Returns: string
Player.GoPrevious
Go to previous item on the playlist
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
Returns: string
Player.GoTo
Go to item at the given position in the playlist
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- Playlist.Position position
Returns: string
Player.MoveDown
If picture is zoomed move viewport down
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
Returns: string
Player.MoveLeft
If picture is zoomed move viewport left otherwise skip previous
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
Returns: string
Player.MoveRight
If picture is zoomed move viewport right otherwise skip next
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
Returns: string
Player.MoveUp
If picture is zoomed move viewport up
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
Returns: string
Player.Open
Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.
Permissions:
- ControlPlayback
Parameters:
- [ mixed item ]
Returns: string
Player.PlayPause
Pauses or unpause playback and returns the new state
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
Returns: Player.Speed
Player.Repeat
Set the repeat mode of the player
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- Player.Repeat state
Returns: string
Player.Rotate
Rotates current picture
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
Returns: string
Player.Seek
Seek through the playing item
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed value
Returns:
Type: object
Properties:
- [ Global.Time totaltime ]
- [ Player.Position.Percentage percentage = 0 ]
- [ Global.Time time ]
Player.SetAudioStream
Set the audio stream played by the player
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed stream
Returns: string
Player.SetSpeed
Set the speed of the current playback
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed speed
Returns: Player.Speed
Player.SetSubtitle
Set the subtitle displayed by the player
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- mixed subtitle
Returns: string
Player.Shuffle
Shuffle items in the player
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
Returns: string
Player.Stop
Stops playback
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
Returns: string
Player.UnShuffle
Unshuffle items in the player
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
Returns: string
Player.Zoom
Zooms current picture
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
- integer value
Returns: string
Player.ZoomIn
Zoom in once
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
Returns: string
Player.ZoomOut
Zoom out once
Permissions:
- ControlPlayback
Parameters:
- Player.Id playerid
Returns: string
Playlist
Playlist.Add
Add item(s) to playlist
Permissions:
- ControlPlayback
Parameters:
- Playlist.Id playlistid
- Playlist.Item item
Returns: string
Playlist.Clear
Clear playlist
Permissions:
- ControlPlayback
Parameters:
- Playlist.Id playlistid
Returns: string
Playlist.GetItems
Get all items from playlist
Permissions:
- ReadData
Parameters:
- Playlist.Id playlistid
- [ List.Fields.All properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.Item.All[] items
- List.LimitsReturned limits
Playlist.GetPlaylists
Returns all existing playlists
Permissions:
- ReadData
Parameters: None
Returns:
Type: array
Playlist.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- Playlist.Id playlistid
- Playlist.Property.Name[] properties
Returns: Playlist.Property.Value
Playlist.Insert
Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).
Permissions:
- ControlPlayback
Parameters:
- Playlist.Id playlistid
- Playlist.Position position
- Playlist.Item item
Returns: string
Playlist.Remove
Remove item from playlist. Does not work for picture playlists (aka slideshows).
Permissions:
- ControlPlayback
Parameters:
- Playlist.Id playlistid
- Playlist.Position position
Returns: string
Playlist.Swap
Swap items in the playlist. Does not work for picture playlists (aka slideshows).
Permissions:
- ControlPlayback
Parameters:
- Playlist.Id playlistid
- Playlist.Position position1
- Playlist.Position position2
Returns: string
System
System.GetProperties
Retrieves the values of the given properties
Permissions:
- ReadData
Parameters:
- System.Property.Name[] properties
Returns: System.Property.Value
System.Hibernate
Puts the system running XBMC into hibernate mode
Permissions:
- ControlPower
Parameters: None
Returns: string
System.Reboot
Reboots the system running XBMC
Permissions:
- ControlPower
Parameters: None
Returns: string
System.Shutdown
Shuts the system running XBMC down
Permissions:
- ControlPower
Parameters: None
Returns: string
System.Suspend
Suspends the system running XBMC
Permissions:
- ControlPower
Parameters: None
Returns: string
VideoLibrary
VideoLibrary.Clean
Cleans the video library from non-existent items
Permissions:
- RemoveData
Parameters: None
Returns: string
VideoLibrary.Export
Exports all items from the video library
Permissions:
- WriteFile
Parameters:
- [ mixed options ]
Returns: string
VideoLibrary.GetEpisodeDetails
Retrieve details about a specific tv show episode
Permissions:
- ReadData
Parameters:
- Library.Id episodeid
- [ Video.Fields.Episode properties ]
Returns:
Type: object
Properties:
- [ Video.Details.Episode episodedetails ]
VideoLibrary.GetEpisodes
Retrieve all tv show episodes
Permissions:
- ReadData
Parameters:
- [ Library.Id tvshowid = -1 ]
- [ integer season = -1 ]
- [ Video.Fields.Episode properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- [ Video.Details.Episode[] episodes ]
- List.LimitsReturned limits
VideoLibrary.GetGenres
Retrieve all genres
Permissions:
- ReadData
Parameters:
- string type
- [ Library.Fields.Genre properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- Library.Details.Genre[] genres
- List.LimitsReturned limits
VideoLibrary.GetMovieDetails
Retrieve details about a specific movie
Permissions:
- ReadData
Parameters:
- Library.Id movieid
- [ Video.Fields.Movie properties ]
Returns:
Type: object
Properties:
- [ Video.Details.Movie moviedetails ]
VideoLibrary.GetMovieSetDetails
Retrieve details about a specific movie set
Permissions:
- ReadData
Parameters:
- Library.Id setid
- [ Video.Fields.MovieSet properties ]
- [ object movies ]
Properties:
- [ List.Sort sort ]
- [ Video.Fields.Movie properties ]
- [ List.Limits limits ]
Returns:
Type: object
Properties:
- [ Video.Details.MovieSet.Extended setdetails ]
VideoLibrary.GetMovieSets
Retrieve all movie sets
Permissions:
- ReadData
Parameters:
- [ Video.Fields.MovieSet properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Video.Details.MovieSet[] sets ]
VideoLibrary.GetMovies
Retrieve all movies
Permissions:
- ReadData
Parameters:
- [ Video.Fields.Movie properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- [ Video.Details.Movie[] movies ]
- List.LimitsReturned limits
VideoLibrary.GetMusicVideoDetails
Retrieve details about a specific music video
Permissions:
- ReadData
Parameters:
- Library.Id musicvideoid
- [ Video.Fields.MusicVideo properties ]
Returns:
Type: object
Properties:
- [ Video.Details.MusicVideo musicvideodetails ]
VideoLibrary.GetMusicVideos
Retrieve all music videos
Permissions:
- ReadData
Parameters:
- [ Library.Id artistid = -1 ]
- [ Library.Id albumid = -1 ]
- [ Video.Fields.MusicVideo properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- [ Video.Details.MusicVideo[] musicvideos ]
- List.LimitsReturned limits
VideoLibrary.GetRecentlyAddedEpisodes
Retrieve all recently added tv episodes
Permissions:
- ReadData
Parameters:
- [ Video.Fields.Episode properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- [ Video.Details.Episode[] episodes ]
- List.LimitsReturned limits
VideoLibrary.GetRecentlyAddedMovies
Retrieve all recently added movies
Permissions:
- ReadData
Parameters:
- [ Video.Fields.Movie properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- [ Video.Details.Movie[] movies ]
- List.LimitsReturned limits
VideoLibrary.GetRecentlyAddedMusicVideos
Retrieve all recently added music videos
Permissions:
- ReadData
Parameters:
- [ Video.Fields.MusicVideo properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- [ Video.Details.MusicVideo[] musicvideos ]
- List.LimitsReturned limits
VideoLibrary.GetSeasons
Retrieve all tv seasons
Permissions:
- ReadData
Parameters:
- Library.Id tvshowid
- [ Video.Fields.Season properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- [ Video.Details.Season[] seasons ]
- List.LimitsReturned limits
VideoLibrary.GetTVShowDetails
Retrieve details about a specific tv show
Permissions:
- ReadData
Parameters:
- Library.Id tvshowid
- [ Video.Fields.TVShow properties ]
Returns:
Type: object
Properties:
- [ Video.Details.TVShow tvshowdetails ]
VideoLibrary.GetTVShows
Retrieve all tv shows
Permissions:
- ReadData
Parameters:
- [ Video.Fields.TVShow properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Video.Details.TVShow[] tvshows ]
VideoLibrary.Scan
Scans the video sources for new library items
Permissions:
- UpdateData
Parameters: None
Returns: string
XBMC
XBMC.GetInfoBooleans
Retrieve info booleans about XBMC and the system
Permissions:
- ReadData
Parameters:
- array[1..X] booleans
Returns:
Type: object
XBMC.GetInfoLabels
Retrieve info labels about XBMC and the system
Permissions:
- ReadData
Parameters:
- array[1..X] labels
Returns:
Type: object
Global types
Application
Application.Property.Name
Type: string
Application.Property.Value
Type: object
Properties:
- [ boolean muted = False ]
- [ integer volume = 0 ]
- [ object version ]
Properties:
- integer major
- string tag
- integer minor
- [ mixed revision = null ]
- [ string name = "" ]
Array
Array.Integer
Type: array
Array.String
Type: array
Audio
Audio.Details.Album
Extends:
Properties:
- [ string style = "" ]
- [ string mood = "" ]
- [ string albumlabel = "" ]
- [ string theme = "" ]
- Library.Id albumid
- [ Library.Id artistid = -1 ]
- [ string type = "" ]
- [ string description = "" ]
Audio.Details.Artist
Extends:
Properties:
- [ string style = "" ]
- [ string description = "" ]
- [ string musicbrainzartistid = "" ]
- string artist
- [ string formed = "" ]
- [ string disbanded = "" ]
- [ string born = "" ]
- Library.Id artistid
- [ string yearsactive = "" ]
- [ string instrument = "" ]
- [ string died = "" ]
- [ string mood = "" ]
Audio.Details.Base
Extends:
Properties:
- [ string genre = "" ]
Audio.Details.Media
Extends:
Properties:
- [ integer rating = 0 ]
- [ string title = "" ]
- [ string artist = "" ]
- [ string musicbrainzalbumartistid = "" ]
- [ integer year = 0 ]
- [ string musicbrainzalbumid = "" ]
Audio.Details.Song
Extends:
Properties:
- [ string album = "" ]
- [ string comment = "" ]
- Library.Id songid
- [ string musicbrainzartistid = "" ]
- [ string lyrics = "" ]
- [ integer track = 0 ]
- [ string musicbrainztrackid = "" ]
- [ Library.Id albumid = -1 ]
- [ Library.Id artistid = -1 ]
- [ string albumartist = "" ]
- [ string file = "" ]
- [ integer duration = 0 ]
- [ integer playcount = 0 ]
Audio.Fields.Album
Extends:
Audio.Fields.Artist
Extends:
Audio.Fields.Song
Extends:
Configuration
Configuration
Type: object
Properties:
- Configuration.Notifications notifications
Configuration.Notifications
Type: object
Properties:
- boolean gui
- boolean system
- boolean player
- boolean audiolibrary
- boolean other
- boolean videolibrary
Files
Files.Media
Type: string
Global
Global.Time
Type: object
Properties:
- integer hours
- integer seconds
- integer minutes
- integer milliseconds
Item
Item.Details.Base
Type: object
Properties:
- string label
Item.Fields.Base
Type: array
Library
Library.Details.Genre
Extends:
Properties:
- Library.Id genreid
- [ string thumbnail = "" ]
- [ string title = "" ]
Library.Fields.Genre
Extends:
Library.Id
Type: integer
List
List.Amount
Type: integer
List.Fields.All
Extends:
List.Item.All
Extends:
Properties:
- [ string comment = "" ]
- [ Library.Id tvshowid = -1 ]
- [ Array.String set ]
- [ string lyrics = "" ]
- [ string albumartist = "" ]
- [ integer duration = 0 ]
- [ Array.Integer setid ]
- [ Library.Id id = -1 ]
- [ string album = "" ]
- [ string votes = "" ]
- [ string mpaa = "" ]
- [ string writer = "" ]
- [ Library.Id albumid = -1 ]
- [ string type = "unknown" ]
- [ string plotoutline = "" ]
- [ integer track = 0 ]
- [ integer season = 0 ]
- [ string musicbrainztrackid = "" ]
- [ string imdbnumber = "" ]
- [ string studio = "" ]
- [ string showlink = "" ]
- [ string showtitle = "" ]
- [ integer episode = 0 ]
- [ string musicbrainzartistid = "" ]
- [ string productioncode = "" ]
- [ string country = "" ]
- [ string premiered = "" ]
- [ string originaltitle = "" ]
- [ Video.Cast cast ]
- [ Library.Id artistid = -1 ]
- [ string firstaired = "" ]
- [ string tagline = "" ]
- [ integer top250 = 0 ]
- [ string trailer = "" ]
List.Item.File
Extends:
Properties:
- string filetype
- string file
List.Items.Sources
Type: array
List.Limits
Type: object
Properties:
- [ integer start = 0 ]
- [ integer end = -1 ]
List.LimitsReturned
Type: object
Properties:
- [ integer start = 0 ]
- integer total
- [ integer end = -1 ]
List.Sort
Type: object
Properties:
- [ string order = "ascending" ]
- [ boolean ignorearticle = False ]
- [ string method = "none" ]
Media
Media.Details.Base
Extends:
Properties:
- [ string fanart = "" ]
- [ string thumbnail = "" ]
Optional
Optional.Boolean
Type: mixed
Player
Player.Audio.Stream
Type: object
Properties:
- integer index
- string name
- string language
Player.Audio.Stream.Extended
Extends:
Properties:
- integer channels
- string codec
- integer bitrate
Player.Id
Type: integer
Player.Notifications.Data
Type: object
Properties:
- Player.Notifications.Item item
- Player.Notifications.Player player
Player.Notifications.Item
Type: mixed
Player.Notifications.Item.Type
Type: string
Player.Notifications.Player
Type: object
Properties:
- Player.Id playerid
- [ integer speed = 0 ]
Player.Notifications.Player.Seek
Extends:
Properties:
- [ Global.Time seekoffset ]
- [ Global.Time time ]
Player.Position.Percentage
Type: number
Player.Property.Name
Type: string
Player.Property.Value
Type: object
Properties:
- [ boolean canrotate = False ]
- [ boolean canrepeat = False ]
- [ integer speed = 0 ]
- [ boolean canshuffle = False ]
- [ boolean shuffled = False ]
- [ boolean canmove = False ]
- [ boolean subtitleenabled = False ]
- [ Player.Position.Percentage percentage = 0 ]
- [ Player.Type type = "video" ]
- [ Player.Repeat repeat = "off" ]
- [ boolean canseek = False ]
- [ Player.Subtitle currentsubtitle ]
- [ Player.Subtitle[] subtitles ]
- [ Global.Time totaltime ]
- [ boolean canzoom = False ]
- [ Player.Audio.Stream.Extended currentaudiostream ]
- [ Playlist.Id playlistid = -1 ]
- [ Player.Audio.Stream.Extended[] audiostreams ]
- [ boolean partymode = False ]
- [ Global.Time time ]
- [ Playlist.Position position = -1 ]
- [ boolean canchangespeed = False ]
Player.Repeat
Type: string
Player.Speed
Type: object
Properties:
- [ integer speed = 0 ]
Player.Subtitle
Type: object
Properties:
- integer index
- string name
- string language
Player.Type
Type: string
Playlist
Playlist.Id
Type: integer
Playlist.Item
Type: mixed
Playlist.Position
Type: integer
Playlist.Property.Name
Type: string
Playlist.Property.Value
Type: object
Properties:
- [ Playlist.Type type = "unknown" ]
- [ integer size = 0 ]
Playlist.Type
Type: string
System
System.Property.Name
Type: string
System.Property.Value
Type: object
Properties:
- [ boolean canreboot = False ]
- [ boolean cansuspend = False ]
- [ boolean canhibernate = False ]
- [ boolean canshutdown = False ]
Video
Video.Cast
Type: array
Video.Details.Base
Extends:
Properties:
- [ integer playcount = 0 ]
Video.Details.Episode
Extends:
Properties:
- [ number rating = 0 ]
- [ Library.Id tvshowid = -1 ]
- [ string votes = "" ]
- [ integer episode = 0 ]
- [ string productioncode = "" ]
- [ integer season = 0 ]
- [ string writer = "" ]
- Library.Id episodeid
- [ string originaltitle = "" ]
- [ Video.Cast cast ]
- [ string firstaired = "" ]
- [ string showtitle = "" ]
Video.Details.File
Extends:
Properties:
- [ string director = "" ]
- [ Video.Streams streamdetails ]
- [ string runtime = "" ]
- [ Video.Resume resume ]
Video.Details.Item
Extends:
Properties:
- [ string plot = "" ]
- [ string lastplayed = "" ]
- [ string file = "" ]
Video.Details.Media
Extends:
Properties:
- [ string title = "" ]
Video.Details.Movie
Extends:
Properties:
- [ number rating = 0 ]
- [ Array.String set ]
- [ integer year = 0 ]
- [ Array.Integer setid ]
- [ string votes = "" ]
- [ string tagline = "" ]
- [ string writer = "" ]
- [ string plotoutline = "" ]
- [ string sorttitle = "" ]
- [ string imdbnumber = "" ]
- [ string studio = "" ]
- [ string showlink = "" ]
- [ string genre = "" ]
- Library.Id movieid
- [ string productioncode = "" ]
- [ string country = "" ]
- [ string premiered = "" ]
- [ string originaltitle = "" ]
- [ Video.Cast cast ]
- [ string mpaa = "" ]
- [ integer top250 = 0 ]
- [ string trailer = "" ]
Video.Details.MovieSet
Extends:
Properties:
- Library.Id setid
Video.Details.MovieSet.Extended
Extends:
Properties:
- [ Video.Details.Movie[] movies ]
Video.Details.MusicVideo
Extends:
Properties:
- [ string album = "" ]
- [ string artist = "" ]
- [ integer track = 0 ]
- [ string studio = "" ]
- [ integer year = 0 ]
- [ string genre = "" ]
- Library.Id musicvideoid
Video.Details.Season
Extends:
Properties:
- integer season
- [ Library.Id tvshowid = -1 ]
- [ integer episode = 0 ]
- [ string showtitle = "" ]
Video.Details.TVShow
Extends:
Properties:
- [ string episodeguide = "" ]
- Library.Id tvshowid
- [ integer episode = 0 ]
- [ string imdbnumber = "" ]
- [ number rating = 0 ]
- [ string mpaa = "" ]
- [ integer year = 0 ]
- [ string votes = "" ]
- [ string premiered = "" ]
- [ string originaltitle = "" ]
- [ Video.Cast cast ]
- [ string studio = "" ]
- [ string sorttitle = "" ]
- [ string genre = "" ]
Video.Fields.Episode
Extends:
Video.Fields.Movie
Extends:
Video.Fields.MovieSet
Extends:
Video.Fields.MusicVideo
Extends:
Video.Fields.Season
Extends:
Video.Fields.TVShow
Extends:
Video.Resume
Type: object
Properties:
- [ number position = 0 ]
- [ number total = 0 ]
Video.Streams
Type: object
Properties:
- [ array[1..X] video ]
- [ array[1..X] audio ]
- [ array[1..X] subtitle ]
Notifications
AudioLibrary
AudioLibrary.OnRemove
An audio item has been removed.
Parameters:
Returns: null
AudioLibrary.OnUpdate
An audio item has been updated.
Parameters:
Returns: null
Player
Player.OnPause
Playback of a media item has been paused. If there is no ID available extra information will be provided.
Parameters:
- string sender
- Player.Notifications.Data data
Returns: null
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:
- string sender
- Player.Notifications.Data data
Returns: null
Player.OnSeek
The playback position has been changed. If there is no ID available extra information will be provided.
Parameters:
- string sender
- object data
Properties:
- [ Player.Notifications.Item item ]
- Player.Notifications.Player.Seek player
Returns: null
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:
- string sender
- Player.Notifications.Data data
Returns: null
Player.OnStop
Playback of a media item has been stopped. If there is no ID available extra information will be provided.
Parameters:
Returns: null
System
System.OnLowBattery
The system is on low battery.
Parameters:
- string sender
- null data
Returns: null
System.OnQuit
XBMC will be closed.
Parameters:
- string sender
- null data
Returns: null
System.OnRestart
The system will be restarted.
Parameters:
- string sender
- null data
Returns: null
System.OnSleep
The system will be suspended.
Parameters:
- string sender
- null data
Returns: null
System.OnWake
The system woke up from suspension.
Parameters:
- string sender
- null data
Returns: null
VideoLibrary
VideoLibrary.OnRemove
A video item has been removed.
Parameters:
Returns: null
VideoLibrary.OnUpdate
A video item has been updated.
Parameters:
Returns: null