JSON-RPC API: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
>Wilco
(Initial layout)
 
>Wilco
(→‎XBMC API: Added namespaces)
Line 12: Line 12:
== XBMC API ==
== XBMC API ==
The XBMC JSON api is split up into namespaces, which contain methods that can be called. These namespaces are:
The XBMC JSON api is split up into namespaces, which contain methods that can be called. These namespaces are:
Namespaces
<pre>
JSONRPC          A variety of standard JSONRPC calls
Player          Manages all available players
MusicPlayer      Audio playback control
VideoPlayer      Video playback control
Slideshow        Picture playback control
Playlist        Playlist Modification
Files            Shares information
MusicLibrary    Audio Library Information
VideoLibrary    Video Library Information
System          System Controls and Information
XBMC            Application controls
</pre>


== Namespace1 ==
== Namespace1 ==

Revision as of 22:36, 19 September 2010

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.


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.


XBMC API

The XBMC JSON 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
MusicPlayer      Audio playback control
VideoPlayer      Video playback control
Slideshow        Picture playback control
Playlist         Playlist Modification
Files            Shares information
MusicLibrary     Audio Library Information
VideoLibrary     Video Library Information
System           System Controls and Information
XBMC             Application controls

Namespace1

Namespace1.Method1

Plays a specified index in the playlist

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