JSON-RPC API/Examples - Revision history

Karellen at 23:07, 27 August 2020

2020-08-27T23:07:20Z

← Older revision		Revision as of 23:07, 27 August 2020
Line 1:		Line 1:
			{{JSON-RPC_API_nav}}
	{{mininav\|[[Development]]\|[[JSON-RPC API]]}}		{{mininav\|[[Development]]\|[[JSON-RPC API]]}}

Line 81:		Line 82:
	</syntaxhighlight>		</syntaxhighlight>

	~~[[Category:Manual]]~~
	[[Category:~~Development~~]]		[[Category:JSON-RPC]]

Fbacher: Add complex query that took me a long time to figure out

2019-03-07T21:35:41Z

Add complex query that took me a long time to figure out

← Older revision		Revision as of 21:35, 7 March 2019
Line 58:		Line 58:
	{"jsonrpc": "2.0", "method": "VideoLibrary.GetMovies", "params": { "filter": {"field": "playcount", "operator": "is", "value": "0"}, "limits": { "start" : 0, "end": 75 }, "properties" : ["art", "rating", "thumbnail", "playcount", "file"], "sort": { "order": "ascending", "method": "label", "ignorearticle": true } }, "id": "libMovies"}		{"jsonrpc": "2.0", "method": "VideoLibrary.GetMovies", "params": { "filter": {"field": "playcount", "operator": "is", "value": "0"}, "limits": { "start" : 0, "end": 75 }, "properties" : ["art", "rating", "thumbnail", "playcount", "file"], "sort": { "order": "ascending", "method": "label", "ignorearticle": true } }, "id": "libMovies"}
	</syntaxhighlight>		</syntaxhighlight>

			Movie With Multiple Filters
			<syntaxhighlight lang="javascript" enclose="div">
			{"jsonrpc": "2.0", "method": "VideoLibrary.GetMovies", "params": { "properties": [ "title", "lastplayed", "studio", "cast", "plot", "writer", "director", "fanart", "runtime", "mpaa", "thumbnail", "file","year", "genre", "tag", "trailer" ], "filter": { "or": [ { "field": "genre", "operator": "contains", "value": [ "Film-Noir" ] }, { "field": "tag", "operator": "contains", "value": [ "classic noir", "film noir", "french noir", "brit noir" ] } ] } }, "id": 1 }
			</syntaxhighlight>

	TV Shows		TV Shows
	<syntaxhighlight lang="javascript" enclose="div">		<syntaxhighlight lang="javascript" enclose="div">

NedBot: Bot: Automated text replacement (- XBMC + Kodi )

2015-05-04T08:39:17Z

Bot: Automated text replacement (- XBMC + Kodi )

← Older revision		Revision as of 08:39, 4 May 2015
Line 11:		Line 11:
	"AudioLibrary.GetAlbums" being the method in this example.		"AudioLibrary.GetAlbums" being the method in this example.
	=== What is playing? ===		=== What is playing? ===
	Commands to control the players in ~~XBMC~~ will only work if that player is currently in use.		Commands to control the players in Kodi will only work if that player is currently in use.
	<syntaxhighlight lang="javascript" enclose="div">		<syntaxhighlight lang="javascript" enclose="div">
	{"jsonrpc": "2.0", "method": "Player.GetActivePlayers", "id": 1}		{"jsonrpc": "2.0", "method": "Player.GetActivePlayers", "id": 1}

NedBot: Robot: Changing Category:XBMC Manual to Category:Manual

2014-11-17T21:28:49Z

Robot: Changing Category:XBMC Manual to Category:Manual

← Older revision		Revision as of 21:28, 17 November 2014
Line 75:		Line 75:
	</syntaxhighlight>		</syntaxhighlight>

	[[Category:~~XBMC~~ Manual]]		[[Category:Manual]]
	[[Category:Development]]		[[Category:Development]]

Bradynapier at 02:10, 27 July 2014

2014-07-27T02:10:31Z

← Older revision		Revision as of 02:10, 27 July 2014
Line 34:		Line 34:
	<syntaxhighlight lang="javascript" enclose="div">		<syntaxhighlight lang="javascript" enclose="div">
	{"jsonrpc": "2.0", "method": "Player.PlayPause", "params": { "playerid": 0 }, "id": 1}		{"jsonrpc": "2.0", "method": "Player.PlayPause", "params": { "playerid": 0 }, "id": 1}
			</syntaxhighlight>

			=== Get Properties ===
			<syntaxhighlight lang="javascript" enclose="div">
			{"jsonrpc": "2.0", "method": "Application.GetProperties", "params": {"properties": ["volume"]}, "id": 1}
	</syntaxhighlight>		</syntaxhighlight>

NedBot: Robot: Substituting template: Name

2014-06-05T20:36:27Z

Robot: Substituting template: Name

← Older revision		Revision as of 20:36, 5 June 2014
Line 11:		Line 11:
	"AudioLibrary.GetAlbums" being the method in this example.		"AudioLibrary.GetAlbums" being the method in this example.
	=== What is playing? ===		=== What is playing? ===
	Commands to control the players in ~~{{name}}~~ will only work if that player is currently in use.		Commands to control the players in XBMC will only work if that player is currently in use.
	<syntaxhighlight lang="javascript" enclose="div">		<syntaxhighlight lang="javascript" enclose="div">
	{"jsonrpc": "2.0", "method": "Player.GetActivePlayers", "id": 1}		{"jsonrpc": "2.0", "method": "Player.GetActivePlayers", "id": 1}

NedBot: Bot: Automated text replacement (- XBMC + {{name}} )

2014-06-05T01:06:54Z

Bot: Automated text replacement (- XBMC + {{name}} )

← Older revision		Revision as of 01:06, 5 June 2014
Line 11:		Line 11:
	"AudioLibrary.GetAlbums" being the method in this example.		"AudioLibrary.GetAlbums" being the method in this example.
	=== What is playing? ===		=== What is playing? ===
	Commands to control the players in ~~XBMC~~ will only work if that player is currently in use.		Commands to control the players in {{name}} will only work if that player is currently in use.
	<syntaxhighlight lang="javascript" enclose="div">		<syntaxhighlight lang="javascript" enclose="div">
	{"jsonrpc": "2.0", "method": "Player.GetActivePlayers", "id": 1}		{"jsonrpc": "2.0", "method": "Player.GetActivePlayers", "id": 1}

NedBot: Bot: automated adding of 'enclose="div"' to syntaxhighlight

2014-03-14T06:44:45Z

Bot: automated adding of 'enclose="div"' to syntaxhighlight

← Older revision		Revision as of 06:44, 14 March 2014
Line 6:		Line 6:
	=== Introspect ===		=== Introspect ===
	If you require more detailed information about an API method use:		If you require more detailed information about an API method use:
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript" enclose="div">
	{ "jsonrpc": "2.0", "method": "JSONRPC.Introspect", "params": { "filter": { "id": "AudioLibrary.GetAlbums", "type": "method" } }, "id": 1 }		{ "jsonrpc": "2.0", "method": "JSONRPC.Introspect", "params": { "filter": { "id": "AudioLibrary.GetAlbums", "type": "method" } }, "id": 1 }
	</syntaxhighlight>		</syntaxhighlight>
Line 12:		Line 12:
	=== What is playing? ===		=== What is playing? ===
	Commands to control the players in XBMC will only work if that player is currently in use.		Commands to control the players in XBMC will only work if that player is currently in use.
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript" enclose="div">
	{"jsonrpc": "2.0", "method": "Player.GetActivePlayers", "id": 1}		{"jsonrpc": "2.0", "method": "Player.GetActivePlayers", "id": 1}
	</syntaxhighlight><br />		</syntaxhighlight><br />
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript" enclose="div">
	{"id": 1, "jsonrpc": "2.0", "result": [ { "playerid": 0, "type": "audio" } ]}		{"id": 1, "jsonrpc": "2.0", "result": [ { "playerid": 0, "type": "audio" } ]}
	</syntaxhighlight>		</syntaxhighlight>
Line 21:		Line 21:

	Now we know which player is active we can query the current item with:		Now we know which player is active we can query the current item with:
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript" enclose="div">
	{"jsonrpc": "2.0", "method": "Player.GetItem", "params": { "properties": ["title", "album", "artist", "duration", "thumbnail", "file", "fanart", "streamdetails"], "playerid": 0 }, "id": "AudioGetItem"}		{"jsonrpc": "2.0", "method": "Player.GetItem", "params": { "properties": ["title", "album", "artist", "duration", "thumbnail", "file", "fanart", "streamdetails"], "playerid": 0 }, "id": "AudioGetItem"}
	</syntaxhighlight>		</syntaxhighlight>
	or		or
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript" enclose="div">
	{"jsonrpc": "2.0", "method": "Player.GetItem", "params": { "properties": ["title", "album", "artist", "season", "episode", "duration", "showtitle", "tvshowid", "thumbnail", "file", "fanart", "streamdetails"], "playerid": 1 }, "id": "VideoGetItem"}		{"jsonrpc": "2.0", "method": "Player.GetItem", "params": { "properties": ["title", "album", "artist", "season", "episode", "duration", "showtitle", "tvshowid", "thumbnail", "file", "fanart", "streamdetails"], "playerid": 1 }, "id": "VideoGetItem"}
	</syntaxhighlight>		</syntaxhighlight>
Line 32:		Line 32:

	=== Player play/pause ===		=== Player play/pause ===
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript" enclose="div">
	{"jsonrpc": "2.0", "method": "Player.PlayPause", "params": { "playerid": 0 }, "id": 1}		{"jsonrpc": "2.0", "method": "Player.PlayPause", "params": { "playerid": 0 }, "id": 1}
	</syntaxhighlight>		</syntaxhighlight>
Line 38:		Line 38:
	=== Query the libraries ===		=== Query the libraries ===
	Artists		Artists
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript" enclose="div">
	{"jsonrpc": "2.0", "method": "AudioLibrary.GetArtists", "params": { "limits": { "start" : 0, "end": 75 }, "properties": [ "thumbnail", "fanart", "born", "formed", "died", "disbanded", "yearsactive", "mood", "style", "genre" ], "sort": { "order": "ascending", "method": "artist", "ignorearticle": true } }, "id": 1}		{"jsonrpc": "2.0", "method": "AudioLibrary.GetArtists", "params": { "limits": { "start" : 0, "end": 75 }, "properties": [ "thumbnail", "fanart", "born", "formed", "died", "disbanded", "yearsactive", "mood", "style", "genre" ], "sort": { "order": "ascending", "method": "artist", "ignorearticle": true } }, "id": 1}
	</syntaxhighlight>		</syntaxhighlight>
	Albums		Albums
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript" enclose="div">
	{"jsonrpc": "2.0", "method": "AudioLibrary.GetAlbums", "params": { "limits": { "start" : 0, "end": 50 }, "properties": ["playcount", "artist", "genre", "rating", "thumbnail", "year", "mood", "style"], "sort": { "order": "ascending", "method": "album", "ignorearticle": true } }, "id": "libAlbums"}		{"jsonrpc": "2.0", "method": "AudioLibrary.GetAlbums", "params": { "limits": { "start" : 0, "end": 50 }, "properties": ["playcount", "artist", "genre", "rating", "thumbnail", "year", "mood", "style"], "sort": { "order": "ascending", "method": "album", "ignorearticle": true } }, "id": "libAlbums"}
	</syntaxhighlight>		</syntaxhighlight>
	Songs		Songs
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript" enclose="div">
	{"jsonrpc": "2.0", "method": "AudioLibrary.GetSongs", "params": { "limits": { "start" : 0, "end": 25 }, "properties": [ "artist", "duration", "album", "track" ], "sort": { "order": "ascending", "method": "track", "ignorearticle": true } }, "id": "libSongs"}		{"jsonrpc": "2.0", "method": "AudioLibrary.GetSongs", "params": { "limits": { "start" : 0, "end": 25 }, "properties": [ "artist", "duration", "album", "track" ], "sort": { "order": "ascending", "method": "track", "ignorearticle": true } }, "id": "libSongs"}
	</syntaxhighlight>		</syntaxhighlight>
	Movies		Movies
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript" enclose="div">
	{"jsonrpc": "2.0", "method": "VideoLibrary.GetMovies", "params": { "filter": {"field": "playcount", "operator": "is", "value": "0"}, "limits": { "start" : 0, "end": 75 }, "properties" : ["art", "rating", "thumbnail", "playcount", "file"], "sort": { "order": "ascending", "method": "label", "ignorearticle": true } }, "id": "libMovies"}		{"jsonrpc": "2.0", "method": "VideoLibrary.GetMovies", "params": { "filter": {"field": "playcount", "operator": "is", "value": "0"}, "limits": { "start" : 0, "end": 75 }, "properties" : ["art", "rating", "thumbnail", "playcount", "file"], "sort": { "order": "ascending", "method": "label", "ignorearticle": true } }, "id": "libMovies"}
	</syntaxhighlight>		</syntaxhighlight>
	TV Shows		TV Shows
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript" enclose="div">
	{"jsonrpc": "2.0", "method": "VideoLibrary.GetTVShows", "params": { "filter": {"field": "playcount", "operator": "is", "value": "0"}, "limits": { "start" : 0, "end": 75 }, "properties": ["art", "genre", "plot", "title", "originaltitle", "year", "rating", "thumbnail", "playcount", "file", "fanart"], "sort": { "order": "ascending", "method": "label" } }, "id": "libTvShows"}		{"jsonrpc": "2.0", "method": "VideoLibrary.GetTVShows", "params": { "filter": {"field": "playcount", "operator": "is", "value": "0"}, "limits": { "start" : 0, "end": 75 }, "properties": ["art", "genre", "plot", "title", "originaltitle", "year", "rating", "thumbnail", "playcount", "file", "fanart"], "sort": { "order": "ascending", "method": "label" } }, "id": "libTvShows"}
	</syntaxhighlight>		</syntaxhighlight>
	Music Videos		Music Videos
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript" enclose="div">
	{"jsonrpc": "2.0", "method": "VideoLibrary.GetMusicVideos", "params": { "properties": [ "title", "thumbnail", "artist", "album", "genre", "lastplayed", "year", "runtime", "fanart", "file", "streamdetails" ], "sort": { "order": "ascending", "method": "artist", "ignorearticle": true } }, "id": "libMusicVideos"}		{"jsonrpc": "2.0", "method": "VideoLibrary.GetMusicVideos", "params": { "properties": [ "title", "thumbnail", "artist", "album", "genre", "lastplayed", "year", "runtime", "fanart", "file", "streamdetails" ], "sort": { "order": "ascending", "method": "artist", "ignorearticle": true } }, "id": "libMusicVideos"}
	</syntaxhighlight>		</syntaxhighlight>
	Audio Playlist		Audio Playlist
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript" enclose="div">
	{"jsonrpc": "2.0", "method": "Playlist.GetItems", "params": { "properties": ["title", "album", "artist", "duration"], "playlistid": 0 }, "id": 1}		{"jsonrpc": "2.0", "method": "Playlist.GetItems", "params": { "properties": ["title", "album", "artist", "duration"], "playlistid": 0 }, "id": 1}
	</syntaxhighlight>		</syntaxhighlight>
	Video Playlist		Video Playlist
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript" enclose="div">
	{"jsonrpc": "2.0", "method": "Playlist.GetItems", "params": { "properties": [ "runtime", "showtitle", "season", "title", "artist" ], "playlistid": 1}, "id": 1}		{"jsonrpc": "2.0", "method": "Playlist.GetItems", "params": { "properties": [ "runtime", "showtitle", "season", "title", "artist" ], "playlistid": 1}, "id": 1}
	</syntaxhighlight>		</syntaxhighlight>

NedBot: Bot: Automated text replacement (-class="wikitable" +class="prettytable" & -Available Tags +Available tags & - +)

2014-03-14T05:53:02Z

Bot: Automated text replacement (-class="wikitable" +class="prettytable" & -Available Tags +Available tags & -<source +<syntaxhighlight & -</source> +</syntaxhighlight>)

← Older revision		Revision as of 05:53, 14 March 2014
Line 6:		Line 6:
	=== Introspect ===		=== Introspect ===
	If you require more detailed information about an API method use:		If you require more detailed information about an API method use:
	<~~source~~ lang="javascript">		<syntaxhighlight lang="javascript">
	{ "jsonrpc": "2.0", "method": "JSONRPC.Introspect", "params": { "filter": { "id": "AudioLibrary.GetAlbums", "type": "method" } }, "id": 1 }		{ "jsonrpc": "2.0", "method": "JSONRPC.Introspect", "params": { "filter": { "id": "AudioLibrary.GetAlbums", "type": "method" } }, "id": 1 }
	</~~source~~>		</syntaxhighlight>
	"AudioLibrary.GetAlbums" being the method in this example.		"AudioLibrary.GetAlbums" being the method in this example.
	=== What is playing? ===		=== What is playing? ===
	Commands to control the players in XBMC will only work if that player is currently in use.		Commands to control the players in XBMC will only work if that player is currently in use.
	<~~source~~ lang="javascript">		<syntaxhighlight lang="javascript">
	{"jsonrpc": "2.0", "method": "Player.GetActivePlayers", "id": 1}		{"jsonrpc": "2.0", "method": "Player.GetActivePlayers", "id": 1}
	</~~source~~><br />		</syntaxhighlight><br />
	<~~source~~ lang="javascript">		<syntaxhighlight lang="javascript">
	{"id": 1, "jsonrpc": "2.0", "result": [ { "playerid": 0, "type": "audio" } ]}		{"id": 1, "jsonrpc": "2.0", "result": [ { "playerid": 0, "type": "audio" } ]}
	</~~source~~>		</syntaxhighlight>
	In the above we can see that the audio player is active. It is possible for more than one player to be active: picture and audio.		In the above we can see that the audio player is active. It is possible for more than one player to be active: picture and audio.

	Now we know which player is active we can query the current item with:		Now we know which player is active we can query the current item with:
	<~~source~~ lang="javascript">		<syntaxhighlight lang="javascript">
	{"jsonrpc": "2.0", "method": "Player.GetItem", "params": { "properties": ["title", "album", "artist", "duration", "thumbnail", "file", "fanart", "streamdetails"], "playerid": 0 }, "id": "AudioGetItem"}		{"jsonrpc": "2.0", "method": "Player.GetItem", "params": { "properties": ["title", "album", "artist", "duration", "thumbnail", "file", "fanart", "streamdetails"], "playerid": 0 }, "id": "AudioGetItem"}
	</~~source~~>		</syntaxhighlight>
	or		or
	<~~source~~ lang="javascript">		<syntaxhighlight lang="javascript">
	{"jsonrpc": "2.0", "method": "Player.GetItem", "params": { "properties": ["title", "album", "artist", "season", "episode", "duration", "showtitle", "tvshowid", "thumbnail", "file", "fanart", "streamdetails"], "playerid": 1 }, "id": "VideoGetItem"}		{"jsonrpc": "2.0", "method": "Player.GetItem", "params": { "properties": ["title", "album", "artist", "season", "episode", "duration", "showtitle", "tvshowid", "thumbnail", "file", "fanart", "streamdetails"], "playerid": 1 }, "id": "VideoGetItem"}
	</~~source~~>		</syntaxhighlight>

	GetItem will ignore any properties that don't make sense for the specific player.		GetItem will ignore any properties that don't make sense for the specific player.

	=== Player play/pause ===		=== Player play/pause ===
	<~~source~~ lang="javascript">		<syntaxhighlight lang="javascript">
	{"jsonrpc": "2.0", "method": "Player.PlayPause", "params": { "playerid": 0 }, "id": 1}		{"jsonrpc": "2.0", "method": "Player.PlayPause", "params": { "playerid": 0 }, "id": 1}
	</~~source~~>		</syntaxhighlight>

	=== Query the libraries ===		=== Query the libraries ===
	Artists		Artists
	<~~source~~ lang="javascript">		<syntaxhighlight lang="javascript">
	{"jsonrpc": "2.0", "method": "AudioLibrary.GetArtists", "params": { "limits": { "start" : 0, "end": 75 }, "properties": [ "thumbnail", "fanart", "born", "formed", "died", "disbanded", "yearsactive", "mood", "style", "genre" ], "sort": { "order": "ascending", "method": "artist", "ignorearticle": true } }, "id": 1}		{"jsonrpc": "2.0", "method": "AudioLibrary.GetArtists", "params": { "limits": { "start" : 0, "end": 75 }, "properties": [ "thumbnail", "fanart", "born", "formed", "died", "disbanded", "yearsactive", "mood", "style", "genre" ], "sort": { "order": "ascending", "method": "artist", "ignorearticle": true } }, "id": 1}
	</~~source~~>		</syntaxhighlight>
	Albums		Albums
	<~~source~~ lang="javascript">		<syntaxhighlight lang="javascript">
	{"jsonrpc": "2.0", "method": "AudioLibrary.GetAlbums", "params": { "limits": { "start" : 0, "end": 50 }, "properties": ["playcount", "artist", "genre", "rating", "thumbnail", "year", "mood", "style"], "sort": { "order": "ascending", "method": "album", "ignorearticle": true } }, "id": "libAlbums"}		{"jsonrpc": "2.0", "method": "AudioLibrary.GetAlbums", "params": { "limits": { "start" : 0, "end": 50 }, "properties": ["playcount", "artist", "genre", "rating", "thumbnail", "year", "mood", "style"], "sort": { "order": "ascending", "method": "album", "ignorearticle": true } }, "id": "libAlbums"}
	</~~source~~>		</syntaxhighlight>
	Songs		Songs
	<~~source~~ lang="javascript">		<syntaxhighlight lang="javascript">
	{"jsonrpc": "2.0", "method": "AudioLibrary.GetSongs", "params": { "limits": { "start" : 0, "end": 25 }, "properties": [ "artist", "duration", "album", "track" ], "sort": { "order": "ascending", "method": "track", "ignorearticle": true } }, "id": "libSongs"}		{"jsonrpc": "2.0", "method": "AudioLibrary.GetSongs", "params": { "limits": { "start" : 0, "end": 25 }, "properties": [ "artist", "duration", "album", "track" ], "sort": { "order": "ascending", "method": "track", "ignorearticle": true } }, "id": "libSongs"}
	</~~source~~>		</syntaxhighlight>
	Movies		Movies
	<~~source~~ lang="javascript">		<syntaxhighlight lang="javascript">
	{"jsonrpc": "2.0", "method": "VideoLibrary.GetMovies", "params": { "filter": {"field": "playcount", "operator": "is", "value": "0"}, "limits": { "start" : 0, "end": 75 }, "properties" : ["art", "rating", "thumbnail", "playcount", "file"], "sort": { "order": "ascending", "method": "label", "ignorearticle": true } }, "id": "libMovies"}		{"jsonrpc": "2.0", "method": "VideoLibrary.GetMovies", "params": { "filter": {"field": "playcount", "operator": "is", "value": "0"}, "limits": { "start" : 0, "end": 75 }, "properties" : ["art", "rating", "thumbnail", "playcount", "file"], "sort": { "order": "ascending", "method": "label", "ignorearticle": true } }, "id": "libMovies"}
	</~~source~~>		</syntaxhighlight>
	TV Shows		TV Shows
	<~~source~~ lang="javascript">		<syntaxhighlight lang="javascript">
	{"jsonrpc": "2.0", "method": "VideoLibrary.GetTVShows", "params": { "filter": {"field": "playcount", "operator": "is", "value": "0"}, "limits": { "start" : 0, "end": 75 }, "properties": ["art", "genre", "plot", "title", "originaltitle", "year", "rating", "thumbnail", "playcount", "file", "fanart"], "sort": { "order": "ascending", "method": "label" } }, "id": "libTvShows"}		{"jsonrpc": "2.0", "method": "VideoLibrary.GetTVShows", "params": { "filter": {"field": "playcount", "operator": "is", "value": "0"}, "limits": { "start" : 0, "end": 75 }, "properties": ["art", "genre", "plot", "title", "originaltitle", "year", "rating", "thumbnail", "playcount", "file", "fanart"], "sort": { "order": "ascending", "method": "label" } }, "id": "libTvShows"}
	</~~source~~>		</syntaxhighlight>
	Music Videos		Music Videos
	<~~source~~ lang="javascript">		<syntaxhighlight lang="javascript">
	{"jsonrpc": "2.0", "method": "VideoLibrary.GetMusicVideos", "params": { "properties": [ "title", "thumbnail", "artist", "album", "genre", "lastplayed", "year", "runtime", "fanart", "file", "streamdetails" ], "sort": { "order": "ascending", "method": "artist", "ignorearticle": true } }, "id": "libMusicVideos"}		{"jsonrpc": "2.0", "method": "VideoLibrary.GetMusicVideos", "params": { "properties": [ "title", "thumbnail", "artist", "album", "genre", "lastplayed", "year", "runtime", "fanart", "file", "streamdetails" ], "sort": { "order": "ascending", "method": "artist", "ignorearticle": true } }, "id": "libMusicVideos"}
	</~~source~~>		</syntaxhighlight>
	Audio Playlist		Audio Playlist
	<~~source~~ lang="javascript">		<syntaxhighlight lang="javascript">
	{"jsonrpc": "2.0", "method": "Playlist.GetItems", "params": { "properties": ["title", "album", "artist", "duration"], "playlistid": 0 }, "id": 1}		{"jsonrpc": "2.0", "method": "Playlist.GetItems", "params": { "properties": ["title", "album", "artist", "duration"], "playlistid": 0 }, "id": 1}
	</~~source~~>		</syntaxhighlight>
	Video Playlist		Video Playlist
	<~~source~~ lang="javascript">		<syntaxhighlight lang="javascript">
	{"jsonrpc": "2.0", "method": "Playlist.GetItems", "params": { "properties": [ "runtime", "showtitle", "season", "title", "artist" ], "playlistid": 1}, "id": 1}		{"jsonrpc": "2.0", "method": "Playlist.GetItems", "params": { "properties": [ "runtime", "showtitle", "season", "title", "artist" ], "playlistid": 1}, "id": 1}
	</~~source~~>		</syntaxhighlight>

	[[Category:XBMC Manual]]		[[Category:XBMC Manual]]
	[[Category:Development]]		[[Category:Development]]

Martijn: Created page with "{{mininav|Development|JSON-RPC API}} == Examples == These examples take their base from v4. Any that require a higher version will be marked. === Introspect === If y..."

2013-08-31T21:05:07Z

Created page with "{{mininav|Development|JSON-RPC API}} == Examples == These examples take their base from v4. Any that require a higher version will be marked. === Introspect === If y..."

New page

{{mininav|[[Development]]|[[JSON-RPC API]]}}

== Examples ==
These examples take their base from v4. Any that require a higher version will be marked.

=== Introspect ===
If you require more detailed information about an API method use:
<source lang="javascript">
{ "jsonrpc": "2.0", "method": "JSONRPC.Introspect", "params": { "filter": { "id": "AudioLibrary.GetAlbums", "type": "method" } }, "id": 1 }
</source>
"AudioLibrary.GetAlbums" being the method in this example.
=== What is playing? ===
Commands to control the players in XBMC will only work if that player is currently in use.
<source lang="javascript">
{"jsonrpc": "2.0", "method": "Player.GetActivePlayers", "id": 1}
</source><br />
<source lang="javascript">
{"id": 1, "jsonrpc": "2.0", "result": [ { "playerid": 0, "type": "audio" } ]}
</source>
In the above we can see that the audio player is active. It is possible for more than one player to be active: picture and audio.

Now we know which player is active we can query the current item with:
<source lang="javascript">
{"jsonrpc": "2.0", "method": "Player.GetItem", "params": { "properties": ["title", "album", "artist", "duration", "thumbnail", "file", "fanart", "streamdetails"], "playerid": 0 }, "id": "AudioGetItem"}
</source>
or
<source lang="javascript">
{"jsonrpc": "2.0", "method": "Player.GetItem", "params": { "properties": ["title", "album", "artist", "season", "episode", "duration", "showtitle", "tvshowid", "thumbnail", "file", "fanart", "streamdetails"], "playerid": 1 }, "id": "VideoGetItem"}
</source>

GetItem will ignore any properties that don't make sense for the specific player.

=== Player play/pause ===
<source lang="javascript">
{"jsonrpc": "2.0", "method": "Player.PlayPause", "params": { "playerid": 0 }, "id": 1}
</source>

=== Query the libraries ===
Artists
<source lang="javascript">
{"jsonrpc": "2.0", "method": "AudioLibrary.GetArtists", "params": { "limits": { "start" : 0, "end": 75 }, "properties": [ "thumbnail", "fanart", "born", "formed", "died", "disbanded", "yearsactive", "mood", "style", "genre" ], "sort": { "order": "ascending", "method": "artist", "ignorearticle": true } }, "id": 1}
</source>
Albums
<source lang="javascript">
{"jsonrpc": "2.0", "method": "AudioLibrary.GetAlbums", "params": { "limits": { "start" : 0, "end": 50 }, "properties": ["playcount", "artist", "genre", "rating", "thumbnail", "year", "mood", "style"], "sort": { "order": "ascending", "method": "album", "ignorearticle": true } }, "id": "libAlbums"}
</source>
Songs
<source lang="javascript">
{"jsonrpc": "2.0", "method": "AudioLibrary.GetSongs", "params": { "limits": { "start" : 0, "end": 25 }, "properties": [ "artist", "duration", "album", "track" ], "sort": { "order": "ascending", "method": "track", "ignorearticle": true } }, "id": "libSongs"}
</source>
Movies
<source lang="javascript">
{"jsonrpc": "2.0", "method": "VideoLibrary.GetMovies", "params": { "filter": {"field": "playcount", "operator": "is", "value": "0"}, "limits": { "start" : 0, "end": 75 }, "properties" : ["art", "rating", "thumbnail", "playcount", "file"], "sort": { "order": "ascending", "method": "label", "ignorearticle": true } }, "id": "libMovies"}
</source>
TV Shows
<source lang="javascript">
{"jsonrpc": "2.0", "method": "VideoLibrary.GetTVShows", "params": { "filter": {"field": "playcount", "operator": "is", "value": "0"}, "limits": { "start" : 0, "end": 75 }, "properties": ["art", "genre", "plot", "title", "originaltitle", "year", "rating", "thumbnail", "playcount", "file", "fanart"], "sort": { "order": "ascending", "method": "label" } }, "id": "libTvShows"}
</source>
Music Videos
<source lang="javascript">
{"jsonrpc": "2.0", "method": "VideoLibrary.GetMusicVideos", "params": { "properties": [ "title", "thumbnail", "artist", "album", "genre", "lastplayed", "year", "runtime", "fanart", "file", "streamdetails" ], "sort": { "order": "ascending", "method": "artist", "ignorearticle": true } }, "id": "libMusicVideos"}
</source>
Audio Playlist
<source lang="javascript">
{"jsonrpc": "2.0", "method": "Playlist.GetItems", "params": { "properties": ["title", "album", "artist", "duration"], "playlistid": 0 }, "id": 1}
</source>
Video Playlist
<source lang="javascript">
{"jsonrpc": "2.0", "method": "Playlist.GetItems", "params": { "properties": [ "runtime", "showtitle", "season", "title", "artist" ], "playlistid": 1}, "id": 1}
</source>

[[Category:XBMC Manual]]
[[Category:Development]]