JSON-RPC API/v12 - Revision history

Ronie at 22:30, 1 June 2021

2021-06-01T22:30:23Z

Ronie at 22:54, 12 January 2021

2021-01-12T22:54:50Z

← Older revision		Revision as of 22:54, 12 January 2021
Line 2:		Line 2:
	{{mininav\|[[Development]]\|[[JSON-RPC API]]}}		{{mininav\|[[Development]]\|[[JSON-RPC API]]}}
	Version 12 is the current development version of Kodi's JSON-RPC API and will be published with the release of v19 (Matrix).<br />		Version 12 is the current development version of Kodi's JSON-RPC API and will be published with the release of v19 (Matrix).<br />
	This document has been updated to version 11.19.0. Recent changes are announced on the [https://forum.kodi.tv/forumdisplay.php?fid=174 forum]		This document has been updated to version 11.21.1. Recent changes are announced on the [https://forum.kodi.tv/forumdisplay.php?fid=174 forum]

	It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.		It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.
Line 5,230:		Line 5,230:
	'''Properties:'''		'''Properties:'''
	# [''[[#Player.Position.Percentage\|Player.Position.Percentage]]'' percentage]<br />		# [''[[#Player.Position.Percentage\|Player.Position.Percentage]]'' percentage]<br />
	# [''[[#Global.Time\|Global.Time]]'' time]<br />		# [''[[#Global.Time\|Global.Time]]'' time] (A duration.)<br />
	# [''[[#Global.Time\|Global.Time]]'' totaltime]<br />		# [''[[#Global.Time\|Global.Time]]'' totaltime] (A duration.)<br />
	</div>		</div>
	{{hidden\|style = width: 60%;\|headerstyle = background: #cccccc;\|contentstyle = text-align: left; border: 0px solid #AAAAAA;\|JSON Schema Description\|<syntaxhighlight enclose="div">		{{hidden\|style = width: 60%;\|headerstyle = background: #cccccc;\|contentstyle = text-align: left; border: 0px solid #AAAAAA;\|JSON Schema Description\|<syntaxhighlight enclose="div">
Line 5,307:		Line 5,307:
	},		},
	"time": {		"time": {
	"$ref": "Global.Time"		"$ref": "Global.Time",
			"description": "A duration."
	},		},
	"totaltime": {		"totaltime": {
	"$ref": "Global.Time"		"$ref": "Global.Time",
			"description": "A duration."
	}		}
	},		},
Line 11,220:		Line 11,222:
	{		{
	"additionalProperties": false,		"additionalProperties": false,
			"description": "A duration.",
	"id": "Global.Time",		"id": "Global.Time",
	"properties": {		"properties": {
	"hours": {		"hours": {
	~~"maximum": 23,~~
	"minimum": 0,		"minimum": 0,
	"required": true,		"required": true,
Line 11,332:		Line 11,334:
	"cursorright",		"cursorright",
	"cyclesubtitle",		"cyclesubtitle",
			"cycletonemapmethod",
	"decreasepar",		"decreasepar",
	"decreaserating",		"decreaserating",
Line 14,352:		Line 14,355:
	'''Properties:'''		'''Properties:'''
	<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">		<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
			* [''[[#Library.Id\|Library.Id]]'' broadcastid = -1]
	* [''[[#Library.Id\|Library.Id]]'' channelid = -1]		* [''[[#Library.Id\|Library.Id]]'' channelid = -1]
	* [''[[#Library.Id\|Library.Id]]'' clientid = -1]		* [''[[#Library.Id\|Library.Id]]'' clientid = -1]
Line 14,388:		Line 14,392:
	"id": "PVR.Details.Timer",		"id": "PVR.Details.Timer",
	"properties": {		"properties": {
			"broadcastid": {
			"$ref": "Library.Id",
			"default": -1
			},
	"channelid": {		"channelid": {
	"$ref": "Library.Id",		"$ref": "Library.Id",
Line 14,685:		Line 14,693:
	"isreadonly",		"isreadonly",
	"isreminder",		"isreminder",
	"clientid"		"clientid",
			"broadcastid"
	],		],
	"type": "string"		"type": "string"
Line 14,981:		Line 14,990:
	"properties": {		"properties": {
	"seekoffset": {		"seekoffset": {
	"$ref": "Global.Time"		"$ref": "Global.Time",
			"description": "A duration."
	},		},
	"time": {		"time": {
	"$ref": "Global.Time"		"$ref": "Global.Time",
			"description": "A duration."
	}		}
	}		}
Line 15,014:		Line 15,025:
	{		{
	"additionalProperties": false,		"additionalProperties": false,
			"description": "A position in duration.",
	"id": "Player.Position.Time",		"id": "Player.Position.Time",
	"properties": {		"properties": {
	"hours": {		"hours": {
	"default": 0,		"default": 0,
	~~"maximum": 23,~~
	"minimum": 0,		"minimum": 0,
	"type": "integer"		"type": "integer"
Line 15,208:		Line 15,219:
	},		},
	"time": {		"time": {
	"$ref": "Global.Time"		"$ref": "Global.Time",
			"description": "A duration."
	},		},
	"totaltime": {		"totaltime": {
	"$ref": "Global.Time"		"$ref": "Global.Time",
			"description": "A duration."
	},		},
	"type": {		"type": {

Ronie at 01:29, 2 November 2020

2020-11-02T01:29:02Z

Show changes

Ronie at 15:08, 15 October 2020

2020-10-15T15:08:10Z

← Older revision		Revision as of 15:08, 15 October 2020
Line 2:		Line 2:
	{{mininav\|[[Development]]\|[[JSON-RPC API]]}}		{{mininav\|[[Development]]\|[[JSON-RPC API]]}}
	Version 12 is the current development version of Kodi's JSON-RPC API and will be published with the release of v19 (Matrix).<br />		Version 12 is the current development version of Kodi's JSON-RPC API and will be published with the release of v19 (Matrix).<br />
	This document has been updated to version 11.13.0. Recent changes are announced on the [https://forum.kodi.tv/forumdisplay.php?fid=174 forum]		This document has been updated to version 11.15.0. Recent changes are announced on the [https://forum.kodi.tv/forumdisplay.php?fid=174 forum]

	It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.		It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.
Line 6,564:		Line 6,564:
	# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />		# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
	# [''string'' content = video] (Content type to clean for)<br />		# [''string'' content = video] (Content type to clean for)<br />
			# [''string'' directory = ""] (Path to the directory to clean up; performs a global cleanup if not specified)<br />
	</div>		</div>
	'''Returns:'''		'''Returns:'''
Line 6,589:		Line 6,590:
	],		],
	"name": "content",		"name": "content",
			"type": "string"
			},
			{
			"default": "",
			"description": "Path to the directory to clean up; performs a global cleanup if not specified",
			"name": "directory",
	"type": "string"		"type": "string"
	}		}
Line 9,400:		Line 9,407:
	* [''mixed: boolean\|string'' broken]		* [''mixed: boolean\|string'' broken]
	* [''array'' dependencies]		* [''array'' dependencies]
			* [''mixed: boolean\|string'' deprecated]
	* [''string'' description]		* [''string'' description]
	* [''string'' disclaimer]		* [''string'' disclaimer]
Line 9,457:		Line 9,465:
	},		},
	"type": "array"		"type": "array"
			},
			"deprecated": {
			"default": null,
			"type": [
			{
			"type": "boolean"
			},
			{
			"type": "string"
			}
			]
	},		},
	"description": {		"description": {
Line 9,548:		Line 9,567:
	"rating",		"rating",
	"enabled",		"enabled",
	"installed"		"installed",
			"deprecated"
	],		],
	"type": "string"		"type": "string"
Line 18,783:		Line 18,803:
	}		}
	</syntaxhighlight>}}		</syntaxhighlight>}}


	== External links ==		== External links ==

Karellen at 01:23, 20 September 2020

2020-09-20T01:23:18Z

← Older revision		Revision as of 01:23, 20 September 2020
Line 18,789:		Line 18,789:
	* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]		* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]

			{{updated\|19}}
	[[Category:JSON-RPC]]		[[Category:JSON-RPC]]

Karellen at 23:32, 27 August 2020

2020-08-27T23:32:33Z

← Older revision		Revision as of 23:32, 27 August 2020
Line 18,784:		Line 18,784:
	</syntaxhighlight>}}		</syntaxhighlight>}}

	~~== See also ==~~
	* [[JSON-RPC API]]
	* [[JSON-RPC API/v4\|JSON-RPC API v4 (Eden)]]
	* [[JSON-RPC API/v6\|JSON-RPC API v6 (Frodo - Jarvis)]]
	* [[JSON-RPC API/v8\|JSON-RPC API v8 (Krypton)]]
	* [[JSON-RPC API/v10\|JSON-RPC API v10 (Leia)]]

	== External links ==		== External links ==

Karellen at 23:04, 27 August 2020

2020-08-27T23:04:59Z

← Older revision		Revision as of 23:04, 27 August 2020
Line 1:		Line 1:
			{{JSON-RPC_API_nav}}
	{{mininav\|[[Development]]\|[[JSON-RPC API]]}}		{{mininav\|[[Development]]\|[[JSON-RPC API]]}}
	Version 12 is the current development version of Kodi's JSON-RPC API and will be published with the release of v19 (Matrix).<br />		Version 12 is the current development version of Kodi's JSON-RPC API and will be published with the release of v19 (Matrix).<br />
Line 18,794:		Line 18,795:
	* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]		* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]

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

Ronie at 08:50, 19 August 2020

2020-08-19T08:50:33Z

← Older revision		Revision as of 08:50, 19 August 2020
Line 1:		Line 1:
	{{mininav\|[[Development]]\|[[JSON-RPC API]]}}		{{mininav\|[[Development]]\|[[JSON-RPC API]]}}
	Version 12 is the current development version of Kodi's JSON-RPC API and will be published with the release of v19 (Matrix).<br />		Version 12 is the current development version of Kodi's JSON-RPC API and will be published with the release of v19 (Matrix).<br />
	This document has been updated to version 11.12.0. Recent changes are announced on the [https://forum.kodi.tv/forumdisplay.php?fid=174 forum]		This document has been updated to version 11.13.0. Recent changes are announced on the [https://forum.kodi.tv/forumdisplay.php?fid=174 forum]

	It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.		It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.
Line 9,813:		Line 9,813:
	'''Properties:'''		'''Properties:'''
	<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">		<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
			* [''integer'' albumduration]
	* ''[[#Library.Id\|Library.Id]]'' albumid		* ''[[#Library.Id\|Library.Id]]'' albumid
	* [''string'' albumlabel]		* [''string'' albumlabel]
Line 9,837:		Line 9,838:
	"id": "Audio.Details.Album",		"id": "Audio.Details.Album",
	"properties": {		"properties": {
			"albumduration": {
			"default": 0,
			"type": "integer"
			},
	"albumid": {		"albumid": {
	"$ref": "Library.Id",		"$ref": "Library.Id",
Line 10,360:		Line 10,365:
	"albumstatus",		"albumstatus",
	"datemodified",		"datemodified",
	"datenew"		"datenew",
			"albumduration"
	],		],
	"type": "string"		"type": "string"
Line 11,662:		Line 11,668:
	"datemodified",		"datemodified",
	"datenew",		"datenew",
	"customproperties"		"customproperties",
			"albumduration"
	],		],
	"type": "string"		"type": "string"
Line 11,760:		Line 11,767:
	"datemodified",		"datemodified",
	"datenew",		"datenew",
	"customproperties"		"customproperties",
			"albumduration"
	],		],
	"type": "string"		"type": "string"
Line 11,900:		Line 11,908:
	"year",		"year",
	"originalyear",		"originalyear",
			"albumduration",
	"review",		"review",
	"themes",		"themes",

Ronie at 02:54, 9 July 2020

2020-07-09T02:54:14Z

← Older revision		Revision as of 02:54, 9 July 2020
Line 1:		Line 1:
	{{mininav\|[[Development]]\|[[JSON-RPC API]]}}		{{mininav\|[[Development]]\|[[JSON-RPC API]]}}
	Version 12 is the current development version of Kodi's JSON-RPC API and will be published with the release of v19 (Matrix).<br />		Version 12 is the current development version of Kodi's JSON-RPC API and will be published with the release of v19 (Matrix).<br />
	This document has been updated to version 11.11.0. Recent changes are announced on the [https://forum.kodi.tv/forumdisplay.php?fid=174 forum]		This document has been updated to version 11.12.0. Recent changes are announced on the [https://forum.kodi.tv/forumdisplay.php?fid=174 forum]

	It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.		It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.
Line 11,349:		Line 11,349:
	</syntaxhighlight>}}		</syntaxhighlight>}}
	=== Item ===		=== Item ===
			==== Item.CustomProperties ====
			'''Type:''' ''object''
			<br />
			{{hidden\|style = width: 60%;\|headerstyle = background: #cccccc;\|contentstyle = text-align: left; border: 0px solid #AAAAAA;\|JSON Schema Description\|<syntaxhighlight enclose="div">
			{
			"additionalProperties": {
			"$ref": "Global.String.NotEmpty",
			"default": ""
			},
			"id": "Item.CustomProperties",
			"type": "object"
			}
			</syntaxhighlight>}}
	==== Item.Details.Base ====		==== Item.Details.Base ====
	'''Type:''' ''object''		'''Type:''' ''object''
Line 11,648:		Line 11,661:
	"albumstatus",		"albumstatus",
	"datemodified",		"datemodified",
	"datenew"		"datenew",
			"customproperties"
	],		],
	"type": "string"		"type": "string"
Line 11,745:		Line 11,759:
	"channels",		"channels",
	"datemodified",		"datemodified",
	"datenew"		"datenew",
			"customproperties"
	],		],
	"type": "string"		"type": "string"
Line 12,653:		Line 12,668:
	* [''[[#Audio.Contributors\|Audio.Contributors]]'' contributors]		* [''[[#Audio.Contributors\|Audio.Contributors]]'' contributors]
	* [''[[#Array.String\|Array.String]]'' country]		* [''[[#Array.String\|Array.String]]'' country]
			* [''[[#Item.CustomProperties\|Item.CustomProperties]]'' customproperties]
	* [''string'' description]		* [''string'' description]
	* [''integer'' disc]		* [''integer'' disc]
Line 12,768:		Line 12,784:
	"country": {		"country": {
	"$ref": "Array.String"		"$ref": "Array.String"
			},
			"customproperties": {
			"$ref": "Item.CustomProperties"
	},		},
	"description": {		"description": {

Ronie at 13:33, 5 July 2020

2020-07-05T13:33:40Z

Show changes