Api class

Constructors

Api(DynamicLibrary dynamicLibrary)
The symbols are looked up in dynamicLibrary.
Api.fromLookup(Pointer<T> lookup<T extends NativeType>(String symbolName))
The symbols are looked up with lookup.

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

close(Pointer<hid_device> dev) → void
@brief Close a HID device.
enumerate(int vendor_id, int product_id) Pointer<hid_device_info>
@brief Enumerate the HID Devices.
error(Pointer<hid_device> dev) Pointer<wchar_t>
@brief Get a string describing the last error which occurred.
exit() int
@brief Finalize the HIDAPI library.
free_enumeration(Pointer<hid_device_info> devs) → void
@brief Free an enumeration Linked List
get_feature_report(Pointer<hid_device> dev, Pointer<Uint8> data, int length) int
@brief Get a feature report from a HID device.
get_indexed_string(Pointer<hid_device> dev, int string_index, Pointer<wchar_t> string, int maxlen) int
@brief Get a string from a HID device, based on its string index.
get_input_report(Pointer<hid_device> dev, Pointer<Uint8> data, int length) int
@brief Get a input report from a HID device.
get_manufacturer_string(Pointer<hid_device> dev, Pointer<wchar_t> string, int maxlen) int
@brief Get The Manufacturer String from a HID device.
get_product_string(Pointer<hid_device> dev, Pointer<wchar_t> string, int maxlen) int
@brief Get The Product String from a HID device.
get_serial_number_string(Pointer<hid_device> dev, Pointer<wchar_t> string, int maxlen) int
@brief Get The Serial Number String from a HID device.
init() int
@brief Initialize the HIDAPI library.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
open(int vendor_id, int product_id, Pointer<wchar_t> serial_number) Pointer<hid_device>
@brief Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.
open_path(Pointer<Int8> path) Pointer<hid_device>
@brief Open a HID device by its path name.
read(Pointer<hid_device> dev, Pointer<Uint8> data, int length) int
@brief Read an Input report from a HID device.
read_timeout(Pointer<hid_device> dev, Pointer<Uint8> data, int length, int milliseconds) int
@brief Read an Input report from a HID device with timeout.
send_feature_report(Pointer<hid_device> dev, Pointer<Uint8> data, int length) int
@brief Send a Feature report to the device.
set_nonblocking(Pointer<hid_device> dev, int nonblock) int
@brief Set the device handle to be non-blocking.
toString() String
A string representation of this object.
inherited
version() Pointer<hid_api_version>
@brief Get a runtime version of the library.
version_str() Pointer<Int8>
@brief Get a runtime version string of the library.
write(Pointer<hid_device> dev, Pointer<Uint8> data, int length) int
@brief Write an Output report to a HID device.

Operators

operator ==(Object other) bool
The equality operator.
inherited