USB Sniffer - Software USB packets sniffer & protocol analyzer for Windows
Docs

IHIDButtonCaps Interface

This interface is implemented by HID button capability object.

Declaration

interface IHIDButtonCaps {
    // Properties
    ${usagePage}: number;
    ${reportID}: number;
    ${isAlias}: boolean;
    ${bitField}: number;
    ${linkCollection}: number;
    ${linkUsage}: number;
    ${linkUsagePage}: number;
    ${isAbsolute}: boolean;
    ${usage}: ${IHIDValue};
    ${string}: ${IHIDValue};
    ${designator}: ${IHIDValue};
    ${dataIndex}: ${IHIDValue};
}
// This interface is not available in managed environment
// This interface is not available in native environment

IHIDButtonCaps Properties

usagePage

usagePage: number;
// This property is not available in managed environment
// This property is not available in native environment

Specifies the usage page for a usage or usage range.

reportID

reportID: number;
// This property is not available in managed environment
// This property is not available in native environment

Specifies the report ID of the HID report that contains the usage or usage range.

isAlias

isAlias: boolean;
// This property is not available in managed environment
// This property is not available in native environment

Indicates, if true, that a button has a set of aliased usages. Otherwise, if isAlias is false, the button has only one usage.

bitField

bitField: number;
// This property is not available in managed environment
// This property is not available in native environment

Contains the data fields (one or two bytes) associated with an input, output, or feature main item.

linkCollection

linkCollection: number;
// This property is not available in managed environment
// This property is not available in native environment

Specifies the index of the link collection in a top-level collection's link collection array that contains the usage or usage range. If linkCollection is zero, the usage or usage range is contained in the top-level collection.

linkUsage

linkUsage: number;
// This property is not available in managed environment
// This property is not available in native environment

Specifies the usage of the link collection that contains the usage or usage range. If linkCollection is zero, linkUsage specifies the usage of the top-level collection.

linkUsagePage

linkUsagePage: number;
// This property is not available in managed environment
// This property is not available in native environment

Specifies the usage page of the link collection that contains the usage or usage range. If linkCollection is zero, linkUsagePage specifies the usage page of the top-level collection.

isAbsolute

isAbsolute: boolean;
// This property is not available in managed environment
// This property is not available in native environment

Specifies, if true, that the button usage or usage range provides absolute data. Otherwise, if isAbsolute is false, the button data is the change in state from the previous value.

usage

usage: ${IHIDValue};
// This property is not available in managed environment
// This property is not available in native environment

Usage.

string

string: ${IHIDValue};
// This property is not available in managed environment
// This property is not available in native environment

String descriptor.

designator

designator: ${IHIDValue};
// This property is not available in managed environment
// This property is not available in native environment

Designator.

dataIndex

dataIndex: ${IHIDValue};
// This property is not available in managed environment
// This property is not available in native environment

Data index.