@elgato-stream-deck/core
Version:
An npm module for interfacing with the Elgato Stream Deck
27 lines • 1.03 kB
TypeScript
import type { EventEmitter } from 'eventemitter3';
export interface HIDDeviceEvents {
error: [data: any];
input: [keys: Uint8Array];
}
/**
* The expected interface for a HIDDevice.
* This is to be implemented by any wrapping libraries to translate their platform specific devices into a common and simpler form
*/
export interface HIDDevice extends EventEmitter<HIDDeviceEvents> {
close(): Promise<void>;
sendFeatureReport(data: Uint8Array): Promise<void>;
getFeatureReport(reportId: number, reportLength: number): Promise<Uint8Array>;
sendReports(buffers: Uint8Array[]): Promise<void>;
getDeviceInfo(): Promise<HIDDeviceInfo>;
getChildDeviceInfo(): Promise<ChildHIDDeviceInfo | null>;
}
export interface HIDDeviceInfo {
readonly path: string | undefined;
readonly productId: number;
readonly vendorId: number;
}
export interface ChildHIDDeviceInfo extends HIDDeviceInfo {
readonly serialNumber: string;
readonly tcpPort: number;
}
//# sourceMappingURL=hid-device.d.ts.map