JSON-RPC API - Revision history

Thezoggy at 05:47, 20 May 2022

2022-05-20T05:47:14Z

← Older revision		Revision as of 05:47, 20 May 2022
Line 546:		Line 546:
	\| 18.1		\| 18.1
	\| Leia		\| Leia
	\| {}		\| {"major":10,"minor":1,"patch":2}
	\|-		\|-
	\| 22 April 2019		\| 22 April 2019
	\| 18.2		\| 18.2
	\| Leia		\| Leia
	\| {}		\| {"major":10,"minor":3,"patch":0}
	\|-		\|-
	\| 27 June 2019		\| 27 June 2019
	\| 18.3		\| 18.3
	\| Leia		\| Leia
	\| {}		\| {"major":10,"minor":3,"patch":0}
	\|-		\|-
	\| 01 September 2019		\| 01 September 2019
	\| 18.4		\| 18.4
	\| Leia		\| Leia
	\| {}		\| {"major":10,"minor":3,"patch":0}
	\|-		\|-
	\| 17 November 2019		\| 17 November 2019
	\| 18.5		\| 18.5
	\| Leia		\| Leia
	\| {}		\| {"major":10,"minor":3,"patch":0}
	\|-		\|-
	\| 02 March 2020		\| 02 March 2020
	\| 18.6		\| 18.6
	\| Leia		\| Leia
	\| {}		\| {"major":10,"minor":3,"patch":0}
	\|-		\|-
	\| 21 May 2020		\| 21 May 2020
	\| 18.7		\| 18.7
	\| Leia		\| Leia
	\| {}		\| {"major":10,"minor":3,"patch":0}
	\|-		\|-
	\| 01 June 2020		\| 01 June 2020
	\| 18.7.1		\| 18.7.1
	\| Leia		\| Leia
	\| {}		\| {"major":10,"minor":3,"patch":0}
	\|-		\|-
	\| 14 June 2020		\| 14 June 2020
	\| 18.7.2		\| 18.7.2
	\| Leia		\| Leia
	\| {}		\| {"major":10,"minor":3,"patch":0}
	\|-		\|-
	\| 29 July 2020		\| 29 July 2020
	\| 18.8		\| 18.8
	\| Leia		\| Leia
	\| {}		\| {"major":10,"minor":3,"patch":0}
	\|-		\|-
	\| 24 October 2020		\| 24 October 2020
	\| 18.9		\| 18.9
	\| Leia		\| Leia
	\| {}		\| {"major":10,"minor":3,"patch":0}
	\|-		\|-
	\| style="background:#eee;" \| 20 February 2021		\| style="background:#eee;" \| 20 February 2021
	\| style="background:#eee;" \| 19.0		\| style="background:#eee;" \| 19.0
	\| style="background:#eee;" \| Matrix		\| style="background:#eee;" \| Matrix
	\| style="background:#eee;" \| {}		\| style="background:#eee;" \| {"major":12,"minor":2,"patch":1}
	\|-		\|-
	\| style="background:#eee;" \| 10 May 2021		\| style="background:#eee;" \| 10 May 2021
	\| style="background:#eee;" \| 19.1		\| style="background:#eee;" \| 19.1
	\| style="background:#eee;" \| Matrix		\| style="background:#eee;" \| Matrix
	\| style="background:#eee;" \| {}		\| style="background:#eee;" \| {"major":12,"minor":3,"patch":0}
	\|-		\|-
	\| style="background:#eee;" \| 09 October 2021		\| style="background:#eee;" \| 09 October 2021
	\| style="background:#eee;" \| 19.2		\| style="background:#eee;" \| 19.2
	\| style="background:#eee;" \| Matrix		\| style="background:#eee;" \| Matrix
	\| style="background:#eee;" \| {}		\| style="background:#eee;" \| {"major":12,"minor":4,"patch":0}
	\|-		\|-
	\| style="background:#eee;" \| 28 October 2021		\| style="background:#eee;" \| 28 October 2021
	\| style="background:#eee;" \| 19.3		\| style="background:#eee;" \| 19.3
	\| style="background:#eee;" \| Matrix		\| style="background:#eee;" \| Matrix
	\| style="background:#eee;" \| {}		\| style="background:#eee;" \| {"major":12,"minor":4,"patch":0}
	\|-		\|-
	\| style="background:#eee;" \| 04 March 2022		\| style="background:#eee;" \| 04 March 2022
Line 622:		Line 622:
	\| style="background:#eee;" \| Matrix		\| style="background:#eee;" \| Matrix
	\| style="background:#eee;" \| {"major":12,"minor":4,"patch":0}		\| style="background:#eee;" \| {"major":12,"minor":4,"patch":0}
			\|-
			\| TBA 2022
			\| 20.0
			\| Nexus
			\| {"major":12,"minor":10,"patch":2}
	\|-		\|-
	\|}		\|}

Thezoggy at 05:38, 20 May 2022

2022-05-20T05:38:28Z

← Older revision		Revision as of 05:38, 20 May 2022
Line 621:		Line 621:
	\| style="background:#eee;" \| 19.4		\| style="background:#eee;" \| 19.4
	\| style="background:#eee;" \| Matrix		\| style="background:#eee;" \| Matrix
	\| style="background:#eee;" \| {}		\| style="background:#eee;" \| {"major":12,"minor":4,"patch":0}
	\|-		\|-
	\|}		\|}

Thezoggy at 17:57, 19 May 2022

2022-05-19T17:57:41Z

← Older revision		Revision as of 17:57, 19 May 2022
Line 503:		Line 503:
	\|{"major":6,"minor":32,"patch":5}		\|{"major":6,"minor":32,"patch":5}
	\|-		\|-
	\| style="background:#eee;" \| 5 February 2017		\| style="background:#eee;" \| 05 February 2017
	\| style="background:#eee;" \| 17.0		\| style="background:#eee;" \| 17.0
	\| style="background:#eee;" \| Krypton		\| style="background:#eee;" \| Krypton
Line 558:		Line 558:
	\| {}		\| {}
	\|-		\|-
	\| 1 September 2019		\| 01 September 2019
	\| 18.4		\| 18.4
	\| Leia		\| Leia
Line 568:		Line 568:
	\| {}		\| {}
	\|-		\|-
	\| 2 March 2020		\| 02 March 2020
	\| 18.6		\| 18.6
	\| Leia		\| Leia
Line 578:		Line 578:
	\| {}		\| {}
	\|-		\|-
	\| 1 June 2020		\| 01 June 2020
	\| 18.7.1		\| 18.7.1
	\| Leia		\| Leia
Line 608:		Line 608:
	\| style="background:#eee;" \| {}		\| style="background:#eee;" \| {}
	\|-		\|-
	\| style="background:#eee;" \| 9 October 2021		\| style="background:#eee;" \| 09 October 2021
	\| style="background:#eee;" \| 19.2		\| style="background:#eee;" \| 19.2
	\| style="background:#eee;" \| Matrix		\| style="background:#eee;" \| Matrix
Line 618:		Line 618:
	\| style="background:#eee;" \| {}		\| style="background:#eee;" \| {}
	\|-		\|-
	\| style="background:#eee;" \| 4 March 2022		\| style="background:#eee;" \| 04 March 2022
	\| style="background:#eee;" \| 19.4		\| style="background:#eee;" \| 19.4
	\| style="background:#eee;" \| Matrix		\| style="background:#eee;" \| Matrix

Thezoggy at 17:56, 19 May 2022

2022-05-19T17:56:02Z

@@ Line 538: / Line 538: @@
 | style="background:#eee;" | {"major":8,"minor":0,"patch":0}
 |-
-| style="background:#eee;" | 29 January 2019
+| 29 January 2019
-| style="background:#eee;" | 18.0
+| 18.0
-| style="background:#eee;" | Leia
+| Leia
-| style="background:#eee;" | {"major":10,"minor":1,"patch":1}
+| {"major":10,"minor":1,"patch":1}
 |-
 |}

Karellen at 09:22, 15 December 2020

2020-12-15T09:22:21Z

← Older revision		Revision as of 09:22, 15 December 2020
Line 2:		Line 2:
	{{mininav\|[[Development]]}}		{{mininav\|[[Development]]}}

	~~{{cleanup}}~~

Karellen at 23:27, 27 August 2020

2020-08-27T23:27:33Z

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

Line 53:		Line 53:
	The ''Notifications'' functionality includes both server-side (from the server to clients) and client-side (from clients to the server) notifications. A JSON-RPC notification is a valid JSON-RPC request with no ''id'' property. Following the JSON-RPC 2.0 specification any JSON-RPC request with no ''id'' must be considered as a notification and the receiver must not send a response upon a notification.		The ''Notifications'' functionality includes both server-side (from the server to clients) and client-side (from clients to the server) notifications. A JSON-RPC notification is a valid JSON-RPC request with no ''id'' property. Following the JSON-RPC 2.0 specification any JSON-RPC request with no ''id'' must be considered as a notification and the receiver must not send a response upon a notification.

	In the specific case of Kodi, server-side notifications are used to inform clients about certain events to relieve clients of the need to periodically poll for certain events. Furthermore there are two ways of client-side notifications. Using ~~[[/#~~JSONRPC.NotifyAll~~\|JSONRPC.NotifyAll]]~~ it is possible to ask Kodi to relay the message in the JSON-RPC request to all other connected clients. The second way is to send JSON-RPC requests without an ''id'' property in case the client does not care about the response (e.g. the method ~~[[/#Player.Stop\|~~Player.Stop]] does not return any useful information to the client).		In the specific case of Kodi, server-side notifications are used to inform clients about certain events to relieve clients of the need to periodically poll for certain events. Furthermore there are two ways of client-side notifications. Using JSONRPC.NotifyAll it is possible to ask Kodi to relay the message in the JSON-RPC request to all other connected clients. The second way is to send JSON-RPC requests without an ''id'' property in case the client does not care about the response (e.g. the method Player.Stop does not return any useful information to the client).

	==== Direct file download ====		==== Direct file download ====
	The ''Direct file download'' functionality is the ability to directly download files from Kodi by calling ~~[[/#~~Files.Download~~\|Files.Download]]~~. In this case the term ''direct'' means that the download happens within the JSON-RPC response of the ~~[[/#Files.Download\|~~Files.Download]] request.		The ''Direct file download'' functionality is the ability to directly download files from Kodi by calling Files.Download. In this case the term ''direct'' means that the download happens within the JSON-RPC response of the Files.Download request.

	==== Redirected file download ====		==== Redirected file download ====
	The ''Redirected file download'' functionality is the ability to indirectly download files from Kodi by calling ~~[[/#~~Files.PrepareDownload~~\|Files.PrepareDownload]]~~ and using the data received in the response to download the file over a different protocol (like HTTP, FTP ...) or another socket. As the ''Redirected file download'' is very transport specific, it must be handled separately for every transport supporting it.		The ''Redirected file download'' functionality is the ability to indirectly download files from Kodi by calling Files.PrepareDownload and using the data received in the response to download the file over a different protocol (like HTTP, FTP ...) or another socket. As the ''Redirected file download'' is very transport specific, it must be handled separately for every transport supporting it.

	=== Comparison ===		=== Comparison ===

Karellen at 23:15, 27 August 2020

2020-08-27T23:15:31Z

Show changes

Karellen at 23:06, 27 August 2020

2020-08-27T23:06:26Z

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

	~~{{JSON-RPC API nav}}~~
	~~<br />~~

	{{cleanup}}		{{cleanup}}
Line 582:		Line 580:
	* [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)]

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

	~~[[JSON-RPC API/Examples]]~~

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

Karellen at 03:20, 11 July 2020

2020-07-11T03:20:36Z

← Older revision		Revision as of 03:20, 11 July 2020
Line 72:		Line 72:
	!style="padding-left: 10px; padding-right: 10px;"\|Redirected file<br />download		!style="padding-left: 10px; padding-right: 10px;"\|Redirected file<br />download
	\|-		\|-
	\|style="padding-left: 5px;" colspan="2"\|[[Python ~~Development\|Python]]~~		\|style="padding-left: 5px;" colspan="2"\|Python
	\|{{yes}}		\|{{yes}}
	\|{{no}}		\|{{no}}

Karellen at 22:20, 16 June 2020

2020-06-16T22:20:32Z

← Older revision		Revision as of 22:20, 16 June 2020
Line 7:		Line 7:


	JSON-RPC is a HTTP- and/or raw TCP socket-based interface for communicating with Kodi. It replaces the deprecated [[HTTP API]], and offers a more secure and robust mechanism in the same format. It is based upon the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification].		JSON-RPC is a HTTP- and/or raw TCP socket-based interface for communicating with Kodi. It replaces the deprecated HTTP API, and offers a more secure and robust mechanism in the same format. It is based upon the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification].

	Each method in the interface can have different security needs which means one client may be allowed to only control playback while another can only read and manipulate the library. In version 2 (first stable) and 4 all clients are granted full authority but will later be forced to ask for privileges and the user of Kodi will have to grant said client access. The design of JSON-RPC is that most methods should behave roughly the same and maintain consistency while hiding the mechanics of Kodi from the client creator.		Each method in the interface can have different security needs which means one client may be allowed to only control playback while another can only read and manipulate the library. In version 2 (first stable) and 4 all clients are granted full authority but will later be forced to ask for privileges and the user of Kodi will have to grant said client access. The design of JSON-RPC is that most methods should behave roughly the same and maintain consistency while hiding the mechanics of Kodi from the client creator.