/usr/share/SuperCollider/HelpSource/Classes/GeneralHIDSlot.schelp is in supercollider-common 1:3.6.3~repack-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | class:: GeneralHIDSlot
summary:: A uniform class to a slot of an HID device
related:: Classes/HIDDeviceService, Classes/LID, Classes/GeneralHID, Classes/GeneralHIDSpec
categories:: External Control>HID
description::
GeneralHID is a cross platform wrapper for accessing HID devices. Currently the MacOSX and Linux HID support has been wrapped. Some of the code is inspired by the GUI wrapper.
A GeneralHIDSlot accesses one specific capability of a device, such as a button, an axis or an LED. Its value can be retrieved, an action can be set to be performed when data comes in, and the slot can be mapped to a control bus to use the value directly on the server. Slots are automatically created when a device is opened, so it is not necessary for a user to create a new slot.
See link::Classes/GeneralHID:: for a complete explanation and an example of how to access an HID device.
note::
It is advised to use this class instead of the platform specific classes: link::Classes/HIDDeviceService:: (on MacOSX) and link::Classes/LID:: (on Linux)
::
subsection::Some outstanding issues
This class is not completely finished yet. Common slot numbers across platforms are not yet guaranteed. On Windows there is not yet a proper implementation available.
ClassMethods::
private::initClass
InstanceMethods::
method::debug
Turns on debugging for the slot.
method::value
Get or set the current value of the slot. Setting is only sensible when the slot represents an LED on the device.
method::rawValue
Return the unscaled value of the slot.
method::action
Assign a function to the slot. The function has as an argument the slot.
method::createBus
Create a control bus on the specified server, and map the incoming values to this bus.
method::bus
Returns the bus to which this slot is mapped, if a bus has been created.
method::freeBus
Free the bus on the server.
method::kr
JITLib support. This calls .createBus, and returns an In.kr on the bus for you.
Examples::
See link::Classes/GeneralHID::. for a complete example of using an HID device.
|