Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

PHP wrapper for XBMC's JSON-RPC and HTTP APIs.

branch: master
README
+-----------------------------------------------+
|    XBMC PHP Library - (C) Kai Gohegan, 2010   |
+-----------------------------------------------+
		
A PHP library for interacting with XBMC using
JSON-RPC and XBMC's HTTP-API. Inspiration was
drawn from Jason Bryant-Greene's php-json-rpc
(https://bitbucket.org/jbg/php-json-rpc/src).
		
+-----------------------------------------------+
|                    License                    |
+-----------------------------------------------+
			
Copyright (c) 2010, Kai Gohegan
All rights reserved.

Redistribution and use in source and binary forms,
with or without modification, are permitted provided
that the following conditions are met:

Redistributions of source code must retain the above
copyright notice, this list of conditions and the
following disclaimer.
		
Redistributions in binary form must reproduce the
above copyright notice, this list of conditions and
the following disclaimer in the documentation and/or
other materials provided with the distribution.
		
Neither the name of Kai Gohegan nor the names of its
contributors may be used to endorse or promote products
derived from this software without specific prior written
permission.
		
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

+-----------------------------------------------+
|                     Usage                     |
+-----------------------------------------------+
		
First, include the xbmc.php file:
include("xbmc.php");
	
Next, create the two classes in one of the below formats:
		
1. Pass the URL parameters as an array
		
	$xbmcHost = new xbmcHost(array('host' => '0.0.0.0', 'port' => '8080', 'user' => 'username', 'pass' => 'password'));
	$xbmcJson = new xbmcJson($xbmcHost);
	$xbmcHttp = new xbmcHttp($xbmcHost);
		
2. Pass the URL as a string:
	
	$xbmcHost = new xbmcHost('username:password@IP:Port');
	$xbmcJson = new xbmcJson($xbmcHost);
	$xbmcHttp = new xbmcHttp($xbmcHost);
	
Then you can start making calls:
		
JSON-RPC API (http://wiki.xbmc.org/index.php?title=JSON_RPC)
Commands are sent using the following syntax:

$xbmcJson->NAMESPACE->COMMAND(array(PARAM1 => VALUE1, PARAM2 => VALUE2, etc..));

eg: $xbmcJson->VideoLibrary->GetRecentlyAddedMovies();
						
HTTP-API API (http://wiki.xbmc.org/index.php?title=Web_Server_HTTP_API)

Commands are sent using the following syntax:

$xbmcHttp->COMMAND("Parameter string in quotes. The string is automatically url-encoded.");

eg: $xbmcHttp->ExecBuiltIn("Notification(XBMC-PHP, Hello!)");

Something went wrong with that request. Please try again.