xbmc
Public Member Functions | Static Protected Attributes | List of all members
org.xbmc.eventclient.PacketBUTTON Class Reference

XBMC Event Client Class. More...

Inheritance diagram for org.xbmc.eventclient.PacketBUTTON:
Inheritance graph
[legend]
Collaboration diagram for org.xbmc.eventclient.PacketBUTTON:
Collaboration graph
[legend]

Public Member Functions

 PacketBUTTON (short code, boolean repeat, boolean down, boolean queue, short amount, byte axis)
 A button packet send a key press or release event to XBMC. More...
 
 PacketBUTTON (String map_name, String button_name, boolean repeat, boolean down, boolean queue, short amount, byte axis)
 A button packet send a key press or release event to XBMC. More...
 
- Public Member Functions inherited from org.xbmc.eventclient.Packet
int getNumPackets ()
 Get Number of Packets which will be sent with current Payload... More...
 
void send (InetAddress adr, int port) throws IOException
 Sends this packet to the EventServer. More...
 

Static Protected Attributes

static final byte BT_USE_NAME = 0x01
 
static final byte BT_DOWN = 0x02
 
static final byte BT_UP = 0x04
 
static final byte BT_USE_AMOUNT = 0x08
 
static final byte BT_QUEUE = 0x10
 
static final byte BT_NO_REPEAT = 0x20
 
static final byte BT_VKEY = 0x40
 
static final byte BT_AXIS = (byte)0x80
 
static final byte BT_AXISSINGLE = (byte)0x100
 
- Static Protected Attributes inherited from org.xbmc.eventclient.Packet
static final byte PT_HELO = 0x01
 
static final byte PT_BYE = 0x02
 
static final byte PT_BUTTON = 0x03
 
static final byte PT_MOUSE = 0x04
 
static final byte PT_PING = 0x05
 
static final byte PT_BROADCAST = 0x06
 
static final byte PT_NOTIFICATION = 0x07
 
static final byte PT_BLOB = 0x08
 
static final byte PT_LOG = 0x09
 
static final byte PT_ACTION = 0x0A
 
static final byte PT_DEBUG = (byte)0xFF
 

Additional Inherited Members

- Static Public Attributes inherited from org.xbmc.eventclient.Packet
static final byte ICON_NONE = 0x00
 
static final byte ICON_JPEG = 0x01
 
static final byte ICON_PNG = 0x02
 
static final byte ICON_GIF = 0x03
 
- Protected Member Functions inherited from org.xbmc.eventclient.Packet
 Packet (short packettype)
 This is an Abstract class and cannot be instanced. More...
 
void appendPayload (String payload)
 Appends a String to the payload (terminated with 0x00) More...
 
void appendPayload (byte payload)
 Appends a single Byte to the payload. More...
 
void appendPayload (byte[] payloadarr)
 Appends a Byte-Array to the payload. More...
 
void appendPayload (int i)
 Appends an integer to the payload. More...
 
void appendPayload (short s)
 Appends a short to the payload. More...
 

Detailed Description

XBMC Event Client Class.

A button packet send a key press or release event to XBMC

Author
Stefan Agner

Constructor & Destructor Documentation

◆ PacketBUTTON() [1/2]

org.xbmc.eventclient.PacketBUTTON.PacketBUTTON ( short  code,
boolean  repeat,
boolean  down,
boolean  queue,
short  amount,
byte  axis 
)
inline

A button packet send a key press or release event to XBMC.

Parameters
coderaw button code (default: 0)
repeatthis key press should repeat until released (default: 1) Note that queued pressed cannot repeat.
downif this is 1, it implies a press event, 0 implies a release event. (default: 1)
queuea queued key press means that the button event is executed just once after which the next key press is processed. It can be used for macros. Currently there is no support for time delays between queued presses. (default: 0)
amountunimplemented for now; in the future it will be used for specifying magnitude of analog key press events
axis

◆ PacketBUTTON() [2/2]

org.xbmc.eventclient.PacketBUTTON.PacketBUTTON ( String  map_name,
String  button_name,
boolean  repeat,
boolean  down,
boolean  queue,
short  amount,
byte  axis 
)
inline

A button packet send a key press or release event to XBMC.

Parameters
map_namea 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_namea button name defined in the map specified in map_name. For example, if map_name is "KB" referring to the <keyboard> section in Keymap.xml then, valid button_names include "printscreen", "minus", "x", etc.
repeatthis key press should repeat until released (default: 1) Note that queued pressed cannot repeat.
downif this is 1, it implies a press event, 0 implies a release event. (default: 1)
queuea queued key press means that the button event is executed just once after which the next key press is processed. It can be used for macros. Currently there is no support for time delays between queued presses. (default: 0)
amountunimplemented for now; in the future it will be used for specifying magnitude of analog key press events
axis

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