Vuo  1.2.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Macros | Enumerations | Functions
VuoHidDevice

Description

Information about a Hid I/O device.

Classes

struct  VuoHidDevice
 Information about a USB HID device. More...
 

Enumerations

enum  VuoHidDevice_MatchType { VuoHidDevice_MatchName, VuoHidDevice_MatchLocation }
 Which field to match on. More...
 

Functions

VuoHidDevice VuoHidDevice_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoHidDevice_getJson (const VuoHidDevice value)
 Encodes value as a JSON object.
 
char * VuoHidDevice_getSummary (const VuoHidDevice value)
 Returns a compact string representation of value.
 
bool VuoHidDevice_areEqual (const VuoHidDevice valueA, const VuoHidDevice valueB)
 Returns true if the two values are equal.
 
bool VuoHidDevice_isLessThan (const VuoHidDevice valueA, const VuoHidDevice valueB)
 Returns true if valueA is less than valueB.
 
bool VuoHidDevice_realize (VuoHidDevice device, VuoHidDevice *realizedDevice)
 If device specifies name-matching:
 
VuoHidDevice VuoHidDevice_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoHidDevice_getString (const VuoHidDevice value)
 Automatically generated function.
 
void VuoHidDevice_retain (VuoHidDevice value)
 Automatically generated function.
 
void VuoHidDevice_release (VuoHidDevice value)
 Automatically generated function.
 

Class Documentation

struct VuoHidDevice
Class Members
VuoList_VuoHidControl controls All the device's controls.
VuoInteger location Where the device is connected in the USB topology. kIOHIDLocationIDKey << 8 + kUSBInterfaceNumber
VuoHidDevice_MatchType matchType Which field to use for matching a VuoHidDevice structure to an actual device.
VuoText name The device's display name.
VuoInteger productID
VuoInteger usage
VuoInteger usagePage
VuoInteger vendorID

Enumeration Type Documentation

Which field to match on.

Function Documentation

bool VuoHidDevice_areEqual ( const VuoHidDevice  valueA,
const VuoHidDevice  valueB 
)

Returns true if the two values are equal.

struct json_object* VuoHidDevice_getJson ( const VuoHidDevice  value)
read

Encodes value as a JSON object.

char* VuoHidDevice_getString ( const VuoHidDevice  value)

Automatically generated function.

char* VuoHidDevice_getSummary ( const VuoHidDevice  value)

Returns a compact string representation of value.

bool VuoHidDevice_isLessThan ( const VuoHidDevice  valueA,
const VuoHidDevice  valueB 
)

Returns true if valueA is less than valueB.

VuoHidDevice VuoHidDevice_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
{
"matchType": "location",
"name": "Multi-axis Controller: 3Dconnexion SpaceNavigator",
"location": 337641472
}
VuoHidDevice VuoHidDevice_makeFromString ( const char *  str)

Automatically generated function.

bool VuoHidDevice_realize ( VuoHidDevice  device,
VuoHidDevice realizedDevice 
)

If device specifies name-matching:

  • If a matching HID device is connected, sets realizedDevice to a specific, existing device matched by its location, and returns true.
  • If no matching HID device is connected, returns false, leaving realizedDevice unset.

If device specifies location-matching, sets realizedDevice to a copy of device, and returns true. (Doesn't bother checking whether the location actually exists.)

void VuoHidDevice_release ( VuoHidDevice  value)

Automatically generated function.

void VuoHidDevice_retain ( VuoHidDevice  value)

Automatically generated function.