JSON-RPC API

From Official Kodi Wiki
Revision as of 19:42, 19 September 2010 by Wilco (talk) (Initial layout)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

1 Overview

JSON RPC is a HTTP-based interface for communicating with XBMC. It replaces the now-depreceated HTTP API, and offers a more secure and robust mechanism in the same format. It is based upon the JSON RPC 2.0 specification.


2 Enabling JSON RPC

TODO: add detail and check
To enable the JSON RPC interface in XBMC the "Allow External Control of XBMC" option must be enabled in the settings page. To control XBMC from other computers the "Allow Control from other computers" must also be enabled.

Note: The EventServer is a different interface for sending remote keypresses to XBMC, and must be enabled separately, some programs may use both interfaces.


3 XBMC API

The XBMC JSON api is split up into namespaces, which contain methods that can be called. These namespaces are: Namespaces

4 Namespace1

4.1 Namespace1.Method1

Plays a specified index in the playlist

PARAMETERS
index          integer    The playlist index of the item to start playing