@blackmagic-controller/node
Version:
An npm module for interfacing with the Blackmagic usb/bluetooth controllers in node
27 lines • 1.59 kB
TypeScript
import type { BlackmagicController } from '@blackmagic-controller/core';
import * as HID from 'node-hid';
import { BlackmagicControllerDeviceInfo } from './hid-device.js';
export { VENDOR_ID, DeviceModelId, KeyId, BlackmagicController, BlackmagicControllerEvents, BlackmagicControllerControlDefinitionBase, BlackmagicControllerButtonControlDefinition, BlackmagicControllerTBarControlDefinition, BlackmagicControllerSetButtonColorValue, BlackmagicControllerControlDefinition, OpenBlackmagicControllerOptions, } from '@blackmagic-controller/core';
export { BlackmagicControllerDeviceInfo };
export interface OpenBlackmagicControllerOptionsNode {
clearOnClose?: boolean;
}
/**
* Scan for and list detected devices
*/
export declare function listBlackmagicControllers(): Promise<BlackmagicControllerDeviceInfo[]>;
/**
* If the provided device is a supported blackmagic controller, get the info about it
*/
export declare function getBlackmagicControllerDeviceInfo(dev: HID.Device): BlackmagicControllerDeviceInfo | null;
/**
* Get the info of a device if the given path is a supported blackmagic controller
*/
export declare function getBlackmagicControllerInfo(path: string): Promise<BlackmagicControllerDeviceInfo | undefined>;
/**
* Open a supported blackmagic controller
* @param devicePath The path of the device to open.
* @param userOptions Options to customise the device behvaiour
*/
export declare function openBlackmagicController(devicePath: string, userOptions?: OpenBlackmagicControllerOptionsNode): Promise<BlackmagicController>;
//# sourceMappingURL=index.d.ts.map