python.xbmcclient.XBMCClient Class Reference

Public Member Functions
def	__init__ (self, name="", icon_file=None, broadcast=False, uid=UNIQUE_IDENTIFICATION, ip="127.0.0.1")
def	connect (self, ip=None, port=None)
def	close (self)
def	ping (self)
def	send_notification (self, title="", message="", icon_file=None)
def	send_keyboard_button (self, button=None)
def	send_remote_button (self, button=None)
def	release_button (self)
def	send_button (self, map="", button="", amount=0)
def	send_button_state (self, map="", button="", amount=0, down=0, axis=0)
def	send_mouse_position (self, x=0, y=0)
def	send_log (self, loglevel=0, logmessage="", autoprint=True)
def	send_action (self, actionmessage="", actiontype=ACTION_EXECBUILTIN)

Public Attributes
	name
	icon_file
	icon_type
	ip
	port
	sock
	uid
	addr

Detailed Description

An XBMC event client

Constructor & Destructor Documentation

__init__()

def python.xbmcclient.XBMCClient.__init__	(		self,
			name = "",
			icon_file = None,
			broadcast = False,
			uid = UNIQUE_IDENTIFICATION,
			ip = "127.0.0.1"
	)

Keyword arguments:
name -- Name of the client
icon_file -- location of an icon file, if any (png, jpg or gif)
uid  -- unique identification

Member Function Documentation

close()

def python.xbmcclient.XBMCClient.close

(

self

)

Close the current connection

connect()

def python.xbmcclient.XBMCClient.connect	(		self,
			ip = None,
			port = None
	)

Initialize connection to XBMC
ip -- IP Address of XBMC
port -- port that the event server on XBMC is listening on

ping()

def python.xbmcclient.XBMCClient.ping

(

self

)

Send a PING packet

release_button()

def python.xbmcclient.XBMCClient.release_button

(

self

)

Release all buttons

send_action()

def python.xbmcclient.XBMCClient.send_action	(		self,
			actionmessage = "",
			actiontype = ACTION_EXECBUILTIN
	)

Keyword arguments:
actionmessage -- the ActionString
actiontype -- The ActionType the ActionString should be sent to.

send_button()

def python.xbmcclient.XBMCClient.send_button	(		self,
			map = "",
			button = "",
			amount = 0
	)

Send a button event to XBMC
Keyword arguments:
map -- a combination of map_name and button_name refers to a
       mapping in the user's Keymap.xml or Lircmap.xml.
       map_name can be one of the following:
   "KB" => standard keyboard map ( <keyboard> section )
   "XG" => xbox gamepad map ( <gamepad> section )
   "R1" => xbox remote map ( <remote> section )
   "R2" => xbox universal remote map ( <universalremote>
           section )
   "LI:devicename" => LIRC remote map where 'devicename' is the
                      actual device's name
button -- a button name defined in the map specified in map, above.
  For example, if map is "KB" referring to the <keyboard>
  section in Keymap.xml then, valid buttons include
  "printscreen", "minus", "x", etc.

send_button_state()

def python.xbmcclient.XBMCClient.send_button_state	(		self,
			map = "",
			button = "",
			amount = 0,
			down = 0,
			axis = 0
	)

Send a button event to XBMC
Keyword arguments:
map -- a combination of map_name and button_name refers to a
       mapping in the user's Keymap.xml or Lircmap.xml.
       map_name can be one of the following:
   "KB" => standard keyboard map ( <keyboard> section )
   "XG" => xbox gamepad map ( <gamepad> section )
   "R1" => xbox remote map ( <remote> section )
   "R2" => xbox universal remote map ( <universalremote>
           section )
   "LI:devicename" => LIRC remote map where 'devicename' is the
                      actual device's name
button -- a button name defined in the map specified in map, above.
  For example, if map is "KB" referring to the <keyboard>
  section in Keymap.xml then, valid buttons include
  "printscreen", "minus", "x", etc.

send_keyboard_button()

def python.xbmcclient.XBMCClient.send_keyboard_button	(		self,
			button = None
	)

Send a keyboard event to XBMC
Keyword Arguments:
button -- name of the keyboard button to send (same as in Keymap.xml)

send_log()

def python.xbmcclient.XBMCClient.send_log	(		self,
			loglevel = 0,
			logmessage = "",
			autoprint = True
	)

Keyword arguments:
loglevel -- the loglevel, follows XBMC standard.
logmessage -- the message to log
autoprint -- if the logmessage should automatically be printed to stdout

send_mouse_position()

def python.xbmcclient.XBMCClient.send_mouse_position	(		self,
			x = 0,
			y = 0
	)

Send a mouse event to XBMC
Keywords Arguments:
x -- absolute x position of mouse ranging from 0 to 65535
     which maps to the entire screen width
y -- same a 'x' but relates to the screen height

send_notification()

def python.xbmcclient.XBMCClient.send_notification	(		self,
			title = "",
			message = "",
			icon_file = None
	)

Send a notification to the connected XBMC
Keyword Arguments:
title -- The title/heading for the notification
message -- The message to be displayed
icon_file -- location of an icon file, if any (png, jpg, gif)

send_remote_button()

def python.xbmcclient.XBMCClient.send_remote_button	(		self,
			button = None
	)

Send a remote control event to XBMC
Keyword Arguments:
button -- name of the remote control button to send (same as in Keymap.xml)

---

The documentation for this class was generated from the following file:

• tools/EventClients/lib/python/xbmcclient.py