@elgato-stream-deck/tcp
Version:
An npm module for interfacing with select Elgato Stream Deck devices in node over tcp
40 lines • 1.36 kB
TypeScript
import { EventEmitter } from 'events';
import { DeviceModelId, DeviceModelType } from '@elgato-stream-deck/core';
export interface StreamDeckTcpDiscoveryServiceOptions {
/**
* How often to update the mDNS query, in milliseconds.
* Set to 0 to disable, when calling query() manually.
* Note: this must not be higher than the ttl reported by the streamdecks, which is currently 60s
*/
queryInterval?: number;
}
export interface StreamDeckTcpDefinition {
address: string;
port: number;
name: string;
vendorId: number;
productId: number;
serialNumber?: string;
modelType: DeviceModelType;
modelId: DeviceModelId;
modelName: string;
/**
* Whether this is a primary tcp device, or using a secondary usb port on a tcp device
*/
isPrimary: boolean;
}
export interface StreamDeckTcpDiscoveryServiceEvents {
up: [service: StreamDeckTcpDefinition];
down: [service: StreamDeckTcpDefinition];
}
export declare class StreamDeckTcpDiscoveryService extends EventEmitter<StreamDeckTcpDiscoveryServiceEvents> {
#private;
constructor(options?: StreamDeckTcpDiscoveryServiceOptions);
get knownStreamDecks(): StreamDeckTcpDefinition[];
/**
* Broadcast the query to the network
*/
query(): void;
destroy(): void;
}
//# sourceMappingURL=discoveryService.d.ts.map