@dlenroc/roku-ecp ·

Client for external control protocol provided on port 8060

Installation

npm install @dlenroc/roku-ecp

Usage

import { ECPExecutor, launch } from '@dlenroc/roku-ecp';

const ctx = new ECPExecutor({ address: 'https://:8060' });
await launch(ctx, { appId: 'dev' });

API

exitApp(payload: { appId: AppId }): Promise

input(payload: Record): Promise

keydown(payload: { key: string }): Promise

keypress(payload: { key: string }): Promise

keyup(payload: { key: string }): Promise

launch(payload: { appId: AppId; params?: Record }): Promise

queryActiveApp(): Promise

queryAppObjectCounts(payload: { appId: AppId }): Promise

queryApps(config?: Config): Promise

queryAppState(payload: { appId: AppId }): Promise

queryAppUI(): Promise

queryChannelPerformance(payload?: { appId?: AppId; params?: Record }): Promise

queryDeviceInfo(): Promise

queryFWBeacons(): Promise

queryGraphicsFrameRate(): Promise

queryIcon(payload: { appId: AppId }): Promise

queryMediaPlayer(): Promise

queryR2D2Bitmaps(payload?: { appId?: AppId }): Promise

queryRegistry(payload: { appId: AppId }): Promise

querySGNodesAll(payload?: { appId?: AppId }): Promise

querySGNodesNodes(payload: { appId?: AppId; nodeId: string }): Promise

querySGNodesRoots(payload?: { appId?: AppId }): Promise

querySGRendezvous(): Promise

search(payload: Record): Promise

trackFWBeacons(payload?: { appId?: AppId }): Promise

trackSGRendezvous(payload?: { appId?: AppId }): Promise

untrackFWBeacons(payload?: { appId?: AppId }): Promise

untrackSGRendezvous(payload?: { appId?: AppId }): Promise