Index

A B C E F G H I L M N O P R S T U V W
All Classes|All Packages

A

add(HidServicesListener) - Method in class org.hid4java.event.HidServicesListenerList

addHidServicesListener(HidServicesListener) - Method in class org.hid4java.HidServices

B

buffer - Variable in class org.hid4java.jna.WideStringBuffer

C

clear() - Method in class org.hid4java.event.HidServicesListenerList

Removes all listeners

close() - Method in class org.hid4java.HidDevice

Close this device freeing the HidApi resources

close(HidDeviceStructure) - Static method in class org.hid4java.jna.HidApi

Close a HID device

E

enumerateDevices(int, int) - Static method in class org.hid4java.jna.HidApi

Enumerate the attached HID devices

equals(Object) - Method in class org.hid4java.HidDevice

exit() - Static method in class org.hid4java.jna.HidApi

Finalise the HID API library

F

fireHidDeviceAttached(HidDevice) - Method in class org.hid4java.event.HidServicesListenerList

Fire the HID device attached event

fireHidDeviceDetached(HidDevice) - Method in class org.hid4java.event.HidServicesListenerList

Fire the HID device detached event

fireHidFailure(HidDevice) - Method in class org.hid4java.event.HidServicesListenerList

Fire the HID failure event

freeEnumeration(HidDeviceInfoStructure) - Static method in class org.hid4java.jna.HidApi

Free an enumeration linked list

G

getAttachedHidDevices() - Method in class org.hid4java.HidServices

getFeatureReport(byte[], byte) - Method in class org.hid4java.HidDevice

Get a feature report from a HID device

getFeatureReport(HidDeviceStructure, byte[], byte) - Static method in class org.hid4java.jna.HidApi

Get a feature report from a HID device

getFieldOrder() - Method in class org.hid4java.jna.HidDeviceInfoStructure

getFieldOrder() - Method in class org.hid4java.jna.HidDeviceStructure

getFieldOrder() - Method in class org.hid4java.jna.WideStringBuffer

getHidDevice() - Method in class org.hid4java.event.HidServicesEvent

getHidDevice(int, int, String) - Method in class org.hid4java.HidServices

getHidServices() - Static method in class org.hid4java.HidManager

Simple service provider providing generally safe defaults.

getHidServices(HidServicesSpecification) - Static method in class org.hid4java.HidManager

Fully configurable service provider

getId() - Method in class org.hid4java.HidDevice

The "path" is well-supported across Windows, Mac and Linux so makes a better choice for a unique ID See #8 for details

getIndexedString(int) - Method in class org.hid4java.HidDevice

Get a string from a HID device, based on its string index

getIndexedString(HidDeviceStructure, int) - Static method in class org.hid4java.jna.HidApi

Get a string from a HID device, based on its string index

getInterfaceNumber() - Method in class org.hid4java.HidDevice

getLastErrorMessage() - Method in class org.hid4java.HidDevice

getLastErrorMessage(HidDeviceStructure) - Static method in class org.hid4java.jna.HidApi

getListeners() - Method in class org.hid4java.event.HidServicesListenerList

getManufacturer() - Method in class org.hid4java.HidDevice

getManufacturer(HidDeviceStructure) - Static method in class org.hid4java.jna.HidApi

getPath() - Method in class org.hid4java.HidDevice

getPauseInterval() - Method in class org.hid4java.HidServicesSpecification

getProduct() - Method in class org.hid4java.HidDevice

getProductId() - Method in class org.hid4java.HidDevice

getProductId(HidDeviceStructure) - Static method in class org.hid4java.jna.HidApi

getReleaseNumber() - Method in class org.hid4java.HidDevice

getScanInterval() - Method in class org.hid4java.HidServicesSpecification

getScanMode() - Method in class org.hid4java.HidServicesSpecification

getSerialNumber() - Method in class org.hid4java.HidDevice

getSerialNumber(HidDeviceStructure) - Static method in class org.hid4java.jna.HidApi

getUsage() - Method in class org.hid4java.HidDevice

getUsagePage() - Method in class org.hid4java.HidDevice

getVendorId() - Method in class org.hid4java.HidDevice

getVersion() - Static method in class org.hid4java.HidServices

H

hashCode() - Method in class org.hid4java.HidDevice

hasNext() - Method in class org.hid4java.jna.HidDeviceInfoStructure

hid_close(Pointer) - Method in interface org.hid4java.jna.HidApiLibrary

Close a HID device

hid_enumerate(short, short) - Method in interface org.hid4java.jna.HidApiLibrary

Enumerate the HID Devices.

hid_error(Pointer) - Method in interface org.hid4java.jna.HidApiLibrary

Get a string describing the last error which occurred.

hid_exit() - Method in interface org.hid4java.jna.HidApiLibrary

Finalize the HIDAPI library.

hid_free_enumeration(Pointer) - Method in interface org.hid4java.jna.HidApiLibrary

Free an enumeration linked list

hid_get_feature_report(Pointer, Structure.ByReference, int) - Method in interface org.hid4java.jna.HidApiLibrary

Get a feature report from a HID device.

hid_get_indexed_string(Pointer, int, Structure.ByReference, int) - Method in interface org.hid4java.jna.HidApiLibrary

Get a string from a HID device, based on its string index.

hid_get_manufacturer_string(Pointer, Structure.ByReference, int) - Method in interface org.hid4java.jna.HidApiLibrary

Get the manufacturer string from a HID device

hid_get_product_string(Pointer, Structure.ByReference, int) - Method in interface org.hid4java.jna.HidApiLibrary

Get the product number string from a HID device

hid_get_serial_number_string(Pointer, Structure.ByReference, int) - Method in interface org.hid4java.jna.HidApiLibrary

Get the serial number string from a HID device

hid_init() - Method in interface org.hid4java.jna.HidApiLibrary

Initialize the HIDAPI library.

hid_open(short, short, WString) - Method in interface org.hid4java.jna.HidApiLibrary

Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.

hid_open_path(String) - Method in interface org.hid4java.jna.HidApiLibrary

Open a HID device by its path name.

hid_read(Pointer, Structure.ByReference, int) - Method in interface org.hid4java.jna.HidApiLibrary

Read an Input report from a HID device.

hid_read_timeout(Pointer, Structure.ByReference, int, int) - Method in interface org.hid4java.jna.HidApiLibrary

Read an Input report from a HID device with timeout.

hid_send_feature_report(Pointer, Structure.ByReference, int) - Method in interface org.hid4java.jna.HidApiLibrary

Send a Feature report to the device.

hid_set_nonblocking(Pointer, int) - Method in interface org.hid4java.jna.HidApiLibrary

Set the device handle to be non-blocking.

hid_write(Pointer, Structure.ByReference, int) - Method in interface org.hid4java.jna.HidApiLibrary

Write an Output report to a HID device.

HidApi - Class in org.hid4java.jna

JNA utility class to provide the following to low level operations:

HidApi() - Constructor for class org.hid4java.jna.HidApi

HidApiLibrary - Interface in org.hid4java.jna

JNA library interface to act as the proxy for the underlying native library

HidDevice - Class in org.hid4java

High level wrapper to provide the following to API consumers:

HidDevice(HidDeviceInfoStructure, HidDeviceManager) - Constructor for class org.hid4java.HidDevice

hidDeviceAttached(HidServicesEvent) - Method in interface org.hid4java.HidServicesListener

A HID device was attached

hidDeviceDetached(HidServicesEvent) - Method in interface org.hid4java.HidServicesListener

A HID device was detached

HidDeviceInfoStructure - Class in org.hid4java.jna

Value object to provide HID device information

HidDeviceInfoStructure() - Constructor for class org.hid4java.jna.HidDeviceInfoStructure

HidDeviceStructure - Class in org.hid4java.jna

Low level JNA value object to provide a HID device pointer

HidDeviceStructure(Pointer) - Constructor for class org.hid4java.jna.HidDeviceStructure

HidException - Exception in org.hid4java

Caught exception to provide the following to API consumers:

HidException(String) - Constructor for exception org.hid4java.HidException

HidException(String, Throwable) - Constructor for exception org.hid4java.HidException

hidFailure(HidServicesEvent) - Method in interface org.hid4java.HidServicesListener

A HID failure occurred during scanning

HidManager - Class in org.hid4java

Factory to provide the following to API consumers:

HidManager() - Constructor for class org.hid4java.HidManager

HidrawHidApiLibrary - Interface in org.hid4java.jna

JNA library interface to act as the proxy for the underlying native library

HidServices - Class in org.hid4java

JNA bridge class to provide the following to USB HID:

HidServices() - Constructor for class org.hid4java.HidServices

Initialise with a default HID specification

HidServices(HidServicesSpecification) - Constructor for class org.hid4java.HidServices

HidServicesEvent - Class in org.hid4java.event

Event to provide the following to API consumers:

HidServicesEvent(HidDevice) - Constructor for class org.hid4java.event.HidServicesEvent

HidServicesListener - Interface in org.hid4java

Interface to provide the following to API consumers:

HidServicesListenerList - Class in org.hid4java.event

HID services listener list

HidServicesListenerList() - Constructor for class org.hid4java.event.HidServicesListenerList

HidServicesSpecification - Class in org.hid4java

Specification to provide the following to API consumers:

HidServicesSpecification() - Constructor for class org.hid4java.HidServicesSpecification

I

init() - Static method in class org.hid4java.jna.HidApi

Initialise the HID API library.

INSTANCE - Static variable in interface org.hid4java.jna.HidrawHidApiLibrary

INSTANCE - Static variable in interface org.hid4java.jna.LibusbHidApiLibrary

interface_number - Variable in class org.hid4java.jna.HidDeviceInfoStructure

Interface number

isAutoShutdown() - Method in class org.hid4java.HidServicesSpecification

isAutoStart() - Method in class org.hid4java.HidServicesSpecification

isOpen() - Method in class org.hid4java.HidDevice

isVidPidSerial(int, int, String) - Method in class org.hid4java.HidDevice

L

LibusbHidApiLibrary - Interface in org.hid4java.jna

JNA library interface to act as the proxy for the underlying native library

M

main(String[]) - Static method in class org.hid4java.HidServices

Jar entry point to allow for version interrogation

manufacturer_string - Variable in class org.hid4java.jna.HidDeviceInfoStructure

Manufacturer string

N

next - Variable in class org.hid4java.jna.HidDeviceInfoStructure

Reference to next device

next() - Method in class org.hid4java.jna.HidDeviceInfoStructure

NO_SCAN - org.hid4java.ScanMode

Equivalent to scan interval of zero.

O

open() - Method in class org.hid4java.HidDevice

Open this device and obtain a device structure

open(int, int, String) - Static method in class org.hid4java.jna.HidApi

Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number

open(String) - Static method in class org.hid4java.jna.HidApi

Open a HID device by its path name

org.hid4java - package org.hid4java

org.hid4java.event - package org.hid4java.event

org.hid4java.jna - package org.hid4java.jna

P

path - Variable in class org.hid4java.jna.HidDeviceInfoStructure

USB path

product_id - Variable in class org.hid4java.jna.HidDeviceInfoStructure

Produce ID

product_string - Variable in class org.hid4java.jna.HidDeviceInfoStructure

Usage Page for this Device/Interface (Windows/Mac only)

ptr - Variable in class org.hid4java.jna.HidDeviceStructure

ptr() - Method in class org.hid4java.jna.HidDeviceStructure

R

read() - Method in class org.hid4java.HidDevice

Read an Input report from a HID device

read(byte[]) - Method in class org.hid4java.HidDevice

Read an Input report from a HID device

read(byte[], int) - Method in class org.hid4java.HidDevice

Read an Input report from a HID device with timeout

read(int) - Method in class org.hid4java.HidDevice

Read an Input report from a HID device

read(int, int) - Method in class org.hid4java.HidDevice

Read an Input report from a HID device

read(HidDeviceStructure, byte[]) - Static method in class org.hid4java.jna.HidApi

Read an Input report from a HID device

read(HidDeviceStructure, byte[], int) - Static method in class org.hid4java.jna.HidApi

Read an Input report from a HID device with timeout

release_number - Variable in class org.hid4java.jna.HidDeviceInfoStructure

Release number

remove(HidServicesListener) - Method in class org.hid4java.event.HidServicesListenerList

removeHidServicesListener(HidServicesListener) - Method in class org.hid4java.HidServices

S

scan() - Method in class org.hid4java.HidServices

Manually scans for HID device connection changes and triggers listener events as required

SCAN_AT_FIXED_INTERVAL - org.hid4java.ScanMode

Trigger continuous scan at given interval.

SCAN_AT_FIXED_INTERVAL_WITH_PAUSE_AFTER_WRITE - org.hid4java.ScanMode

Trigger continuous scan at given interval but introduce a pause after a write operation to allow the device time to process data without having to respond to further enumeration requests.

ScanMode - Enum in org.hid4java

Provide a collection of different device enumeration scanning modes so that device attach/detach events can be generated.

sendFeatureReport(byte[], byte) - Method in class org.hid4java.HidDevice

Send a Feature report to the device

sendFeatureReport(HidDeviceStructure, byte[], byte) - Static method in class org.hid4java.jna.HidApi

Send a Feature report to the device using a simplified interface

serial_number - Variable in class org.hid4java.jna.HidDeviceInfoStructure

Serial number

setAutoShutdown(boolean) - Method in class org.hid4java.HidServicesSpecification

setAutoStart(boolean) - Method in class org.hid4java.HidServicesSpecification

setNonBlocking(boolean) - Method in class org.hid4java.HidDevice

Set the device handle to be non-blocking

setNonBlocking(HidDeviceStructure, boolean) - Static method in class org.hid4java.jna.HidApi

Set the device handle to be non-blocking

setPauseInterval(int) - Method in class org.hid4java.HidServicesSpecification

setScanInterval(int) - Method in class org.hid4java.HidServicesSpecification

setScanMode(ScanMode) - Method in class org.hid4java.HidServicesSpecification

show() - Method in class org.hid4java.jna.HidDeviceInfoStructure

shutdown() - Method in class org.hid4java.HidServices

Stop scanning for devices and shut down the HidApi

start() - Method in class org.hid4java.HidServices

Start scanning for devices (if not already scanning)

stop() - Method in class org.hid4java.HidServices

Stop scanning for devices

T

toArray() - Method in class org.hid4java.event.HidServicesListenerList

Returns an array with the currently registered listeners.

toString() - Method in class org.hid4java.event.HidServicesEvent

toString() - Method in class org.hid4java.HidDevice

toString() - Method in class org.hid4java.jna.WideStringBuffer

hidapi uses wchar_t which is written l i k e t h i s (with '\0' in between)

U

usage - Variable in class org.hid4java.jna.HidDeviceInfoStructure

Usage number

usage_page - Variable in class org.hid4java.jna.HidDeviceInfoStructure

Usage for this Device/Interface (Windows/Mac only)

useLibUsbVariant - Static variable in class org.hid4java.jna.HidApi

Enables use of the libusb variant of the hidapi native library when running on a Linux platform.

V

valueOf(String) - Static method in enum org.hid4java.ScanMode

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.hid4java.ScanMode

Returns an array containing the constants of this enum type, in the order they are declared.

vendor_id - Variable in class org.hid4java.jna.HidDeviceInfoStructure

Vendor ID

W

WideStringBuffer - Class in org.hid4java.jna

Wrapper for a wide character (WCHAR) structure

WideStringBuffer(byte[]) - Constructor for class org.hid4java.jna.WideStringBuffer

WideStringBuffer(int) - Constructor for class org.hid4java.jna.WideStringBuffer

write(byte[], int, byte) - Method in class org.hid4java.HidDevice

write(HidDeviceStructure, byte[], int, byte) - Static method in class org.hid4java.jna.HidApi

Write an Output report to a HID device using a simplified interface

A B C E F G H I L M N O P R S T U V W
All Classes|All Packages