@vmosedge/web-sdk 1.0.1

package/dist/types/index.d.ts

@@ -0,0 +1,381 @@
+declare class EventEmitter {
+    private listeners;
+    on(event: string, callback: Function): void;
+    once(event: string, callback: Function): void;
+    off(event: string, callback: Function): void;
+    emit(event: string, ...args: any[]): void;
+    clear(event?: string): void;
+}
+
+declare const AndroidKeyCode: {
+    readonly AndroidHome: 3;
+    readonly AndroidBack: 4;
+    readonly AndroidCall: 5;
+    readonly AndroidEndCall: 6;
+    readonly Digit0: 7;
+    readonly Digit1: 8;
+    readonly Digit2: 9;
+    readonly Digit3: 10;
+    readonly Digit4: 11;
+    readonly Digit5: 12;
+    readonly Digit6: 13;
+    readonly Digit7: 14;
+    readonly Digit8: 15;
+    readonly Digit9: 16;
+    readonly Star: 17;
+    readonly Pound: 18;
+    readonly ArrowUp: 19;
+    readonly ArrowDown: 20;
+    readonly ArrowLeft: 21;
+    readonly ArrowRight: 22;
+    readonly AndroidDPadCenter: 23;
+    readonly VolumeUp: 24;
+    readonly VolumeDown: 25;
+    readonly Power: 26;
+    readonly AndroidCamera: 27;
+    readonly Clear: 28;
+    readonly KeyA: 29;
+    readonly KeyB: 30;
+    readonly KeyC: 31;
+    readonly KeyD: 32;
+    readonly KeyE: 33;
+    readonly KeyF: 34;
+    readonly KeyG: 35;
+    readonly KeyH: 36;
+    readonly KeyI: 37;
+    readonly KeyJ: 38;
+    readonly KeyK: 39;
+    readonly KeyL: 40;
+    readonly KeyM: 41;
+    readonly KeyN: 42;
+    readonly KeyO: 43;
+    readonly KeyP: 44;
+    readonly KeyQ: 45;
+    readonly KeyR: 46;
+    readonly KeyS: 47;
+    readonly KeyT: 48;
+    readonly KeyU: 49;
+    readonly KeyV: 50;
+    readonly KeyW: 51;
+    readonly KeyX: 52;
+    readonly KeyY: 53;
+    readonly KeyZ: 54;
+    readonly Comma: 55;
+    readonly Period: 56;
+    readonly AltLeft: 57;
+    readonly AltRight: 58;
+    readonly ShiftLeft: 59;
+    readonly ShiftRight: 60;
+    readonly Tab: 61;
+    readonly Space: 62;
+    readonly AndroidSymbol: 63;
+    readonly AndroidExplorer: 64;
+    readonly AndroidEnvelope: 65;
+    readonly Enter: 66;
+    readonly Backspace: 67;
+    readonly Backquote: 68;
+    readonly Minus: 69;
+    readonly Equal: 70;
+    readonly BracketLeft: 71;
+    readonly BracketRight: 72;
+    readonly Backslash: 73;
+    readonly Semicolon: 74;
+    readonly Quote: 75;
+    readonly Slash: 76;
+    readonly At: 77;
+    readonly AndroidNum: 78;
+    readonly AndroidHeadsetHook: 79;
+    readonly AndroidFocus: 80;
+    readonly Plus: 81;
+    readonly ContextMenu: 82;
+    readonly AndroidNotification: 83;
+    readonly AndroidSearch: 84;
+    readonly PageUp: 92;
+    readonly PageDown: 93;
+    readonly Escape: 111;
+    readonly Delete: 112;
+    readonly ControlLeft: 113;
+    readonly ControlRight: 114;
+    readonly CapsLock: 115;
+    readonly ScrollLock: 116;
+    readonly MetaLeft: 117;
+    readonly MetaRight: 118;
+    readonly AndroidFunction: 119;
+    readonly PrintScreen: 120;
+    readonly Pause: 121;
+    readonly Home: 122;
+    readonly End: 123;
+    readonly Insert: 124;
+    readonly AndroidForward: 125;
+    readonly F1: 131;
+    readonly F2: 132;
+    readonly F3: 133;
+    readonly F4: 134;
+    readonly F5: 135;
+    readonly F6: 136;
+    readonly F7: 137;
+    readonly F8: 138;
+    readonly F9: 139;
+    readonly F10: 140;
+    readonly F11: 141;
+    readonly F12: 142;
+    readonly NumLock: 143;
+    readonly Numpad0: 144;
+    readonly Numpad1: 145;
+    readonly Numpad2: 146;
+    readonly Numpad3: 147;
+    readonly Numpad4: 148;
+    readonly Numpad5: 149;
+    readonly Numpad6: 150;
+    readonly Numpad7: 151;
+    readonly Numpad8: 152;
+    readonly Numpad9: 153;
+    readonly NumpadDivide: 154;
+    readonly NumpadMultiply: 155;
+    readonly NumpadSubtract: 156;
+    readonly NumpadAdd: 157;
+    readonly NumpadDecimal: 158;
+    readonly NumpadComma: 159;
+    readonly NumpadEnter: 160;
+    readonly NumpadEquals: 161;
+    readonly NumpadLeftParen: 162;
+    readonly NumpadRightParen: 163;
+    readonly VolumeMute: 164;
+    readonly AndroidAppSwitch: 187;
+    readonly AndroidCut: 277;
+    readonly AndroidCopy: 278;
+    readonly AndroidPaste: 279;
+};
+type AndroidKeyCode = (typeof AndroidKeyCode)[keyof typeof AndroidKeyCode];
+declare const AndroidKeyEventAction: {
+    readonly Down: 0;
+    readonly Up: 1;
+};
+type AndroidKeyEventAction = (typeof AndroidKeyEventAction)[keyof typeof AndroidKeyEventAction];
+declare const AndroidMetaState: {
+    readonly None: 0;
+    readonly AltOn: 2;
+    readonly AltLeftOn: 16;
+    readonly AltRightOn: 32;
+    readonly ShiftOn: 1;
+    readonly ShiftLeftOn: 64;
+    readonly ShiftRightOn: 128;
+    readonly SymOn: 4;
+    readonly FunctionOn: 8;
+    readonly CtrlOn: 4096;
+    readonly CtrlLeftOn: 8192;
+    readonly CtrlRightOn: 16384;
+    readonly MetaOn: 65536;
+    readonly MetaLeftOn: 131072;
+    readonly MetaRightOn: 262144;
+    readonly CapsLockOn: 1048576;
+    readonly NumLockOn: 2097152;
+    readonly ScrollLockOn: 4194304;
+};
+type AndroidMetaState = (typeof AndroidMetaState)[keyof typeof AndroidMetaState];
+
+declare const AndroidMotionEventAction: {
+    readonly Down: 0;
+    readonly Up: 1;
+    readonly Move: 2;
+    readonly Cancel: 3;
+    readonly Outside: 4;
+    readonly PointerDown: 5;
+    readonly PointerUp: 6;
+    readonly HoverMove: 7;
+    readonly Scroll: 8;
+    readonly HoverEnter: 9;
+    readonly HoverExit: 10;
+    readonly ButtonPress: 11;
+    readonly ButtonRelease: 12;
+};
+type AndroidMotionEventAction = (typeof AndroidMotionEventAction)[keyof typeof AndroidMotionEventAction];
+declare const AndroidMotionEventButton: {
+    readonly None: 0;
+    readonly Primary: 1;
+    readonly Secondary: 2;
+    readonly Tertiary: 4;
+    readonly Back: 8;
+    readonly Forward: 16;
+    readonly StylusPrimary: 32;
+    readonly StylusSecondary: 64;
+};
+type AndroidMotionEventButton = (typeof AndroidMotionEventButton)[keyof typeof AndroidMotionEventButton];
+
+type ChannelStatus = "disconnected" | "connecting" | "connected" | "error";
+interface AllChannelsStatus {
+    video: ChannelStatus;
+    audio: ChannelStatus;
+    touch: ChannelStatus;
+}
+
+declare const VmosEdgeClientEvents: {
+    readonly SIZE_CHANGED: "size-changed";
+    readonly ERROR: "error";
+    readonly STARTED: "started";
+    readonly STOPPED: "stopped";
+    readonly CLIPBOARD_CHANGED: "clipboard-changed";
+    readonly CHANNEL_CONNECTED: "channel-connected";
+    readonly GROUP_CONTROL_JOINED: "group-control-joined";
+    readonly GROUP_CONTROL_LEAVE: "group-control-leave";
+};
+type VmosEdgeClientEventName = (typeof VmosEdgeClientEvents)[keyof typeof VmosEdgeClientEvents];
+declare enum VmosEdgeErrorType {
+    CONNECTION = "connection",
+    VIDEO = "video",
+    AUDIO = "audio",
+    TOUCH = "touch",
+    DECODER = "decoder",
+    RENDERER = "renderer"
+}
+declare enum VmosEdgeErrorCode {
+    CONNECTION_FAILED = "CONNECTION_FAILED",
+    CONNECTION_TIMEOUT = "CONNECTION_TIMEOUT",
+    CONNECTION_LOST = "CONNECTION_LOST",
+    VIDEO_CHANNEL_CONNECTION_FAILED = "VIDEO_CHANNEL_CONNECTION_FAILED",
+    VIDEO_CHANNEL_CLOSED = "VIDEO_CHANNEL_CLOSED",
+    VIDEO_STREAM_ERROR = "VIDEO_STREAM_ERROR",
+    VIDEO_PIPELINE_ERROR = "VIDEO_PIPELINE_ERROR",
+    AUDIO_CHANNEL_CONNECTION_FAILED = "AUDIO_CHANNEL_CONNECTION_FAILED",
+    AUDIO_STREAM_ERROR = "AUDIO_STREAM_ERROR",
+    TOUCH_CHANNEL_CONNECTION_FAILED = "TOUCH_CHANNEL_CONNECTION_FAILED",
+    TOUCH_MESSAGE_PARSE_ERROR = "TOUCH_MESSAGE_PARSE_ERROR",
+    DECODER_INIT_FAILED = "DECODER_INIT_FAILED",
+    DECODER_ERROR = "DECODER_ERROR",
+    RENDERER_INIT_FAILED = "RENDERER_INIT_FAILED",
+    RENDERER_ERROR = "RENDERER_ERROR",
+    UNKNOWN_ERROR = "UNKNOWN_ERROR"
+}
+interface VmosEdgeErrorEvent {
+    type: VmosEdgeErrorType;
+    code: VmosEdgeErrorCode;
+    message: string;
+    port?: number;
+    allChannelsStatus?: AllChannelsStatus;
+}
+interface VmosEdgeSizeChangedEvent {
+    idealWidth: number;
+    idealHeight: number;
+    videoWidth: number;
+    videoHeight: number;
+    rotation: 0 | 1;
+}
+
+interface VmosEdgeChannelConnectedEvent {
+    channel: "video" | "audio" | "touch";
+    port?: number;
+    allChannelsStatus?: AllChannelsStatus;
+}
+interface VmosEdgeClientEventMap {
+    [VmosEdgeClientEvents.SIZE_CHANGED]: VmosEdgeSizeChangedEvent;
+    [VmosEdgeClientEvents.ERROR]: VmosEdgeErrorEvent;
+    [VmosEdgeClientEvents.STARTED]: void;
+    [VmosEdgeClientEvents.STOPPED]: void;
+    [VmosEdgeClientEvents.CLIPBOARD_CHANGED]: string;
+    [VmosEdgeClientEvents.CHANNEL_CONNECTED]: VmosEdgeChannelConnectedEvent;
+    [VmosEdgeClientEvents.GROUP_CONTROL_JOINED]: VmosEdgeClientConfig;
+    [VmosEdgeClientEvents.GROUP_CONTROL_LEAVE]: VmosEdgeClientConfig;
+}
+type VmosEdgeClientEventListener<T extends VmosEdgeClientEventName> = (data: VmosEdgeClientEventMap[T]) => void;
+interface VmosEdgeClientConfig {
+    ip: string;
+    deviceId: string;
+    ports: {
+        video?: number | undefined;
+        audio?: number | undefined;
+        touch?: number | undefined;
+    };
+}
+interface VmosEdgeClientOptions {
+    config: VmosEdgeClientConfig;
+    container: HTMLElement;
+    isGroupControl?: boolean;
+    retryCount?: number;
+    retryInterval?: number;
+    videoCodecPreference?: "no-preference" | "prefer-hardware" | "prefer-software";
+    renderPreference?: "default" | "high-performance" | "low-power";
+    touchMoveFrequency?: number;
+}
+
+declare class VmosEdgeClient extends EventEmitter {
+    private container;
+    private canvas;
+    private canvasContainer;
+    private device;
+    private isGroupControl;
+    private deviceTouchGroupMap;
+    private config;
+    private renderer;
+    private videoCodecPreference;
+    private renderPreference;
+    private decoder;
+    private textareaManager;
+    private videoWidth;
+    private videoHeight;
+    private isRunning;
+    private rotation;
+    private manualRotation;
+    private currentRotationAngle;
+    private resizeObserver;
+    private pointerMoveThrottleMap;
+    private touchMoveInterval;
+    private retryCount;
+    private maxRetries;
+    private retryInterval;
+    private stopVideoSubscription;
+    private static PointerEventButtonToAndroidButton;
+    constructor(options: VmosEdgeClientOptions);
+    private setupChannelStatusListener;
+    private extractErrorMessage;
+    private channelToErrorType;
+    private getErrorCodeForChannel;
+    private initCanvas;
+    private replaceCanvas;
+    private applyCanvasStyle;
+    private initTextareaManager;
+    private observeContainerResize;
+    on<T extends VmosEdgeClientEventName>(event: T, listener: VmosEdgeClientEventListener<T>): this;
+    once<T extends VmosEdgeClientEventName>(event: T, listener: VmosEdgeClientEventListener<T>): this;
+    off<T extends VmosEdgeClientEventName>(event: T, listener?: VmosEdgeClientEventListener<T> | Function): this;
+    emit<T extends VmosEdgeClientEventName>(event: T, ...args: VmosEdgeClientEventMap[T] extends void ? [] : [VmosEdgeClientEventMap[T]]): void;
+    start(): Promise<void>;
+    private connectWithRetry;
+    private internalStart;
+    private createVideoStream;
+    private setupTouch;
+    private performHandshake;
+    setGroupControlMode(enabled: boolean): void;
+    joinGroupControl(config: VmosEdgeClientConfig[]): void;
+    leaveGroupControl(config: VmosEdgeClientConfig[]): void;
+    stop(): void;
+    private emitSizeChanged;
+    private mapCoordinates;
+    private updateCanvasSize;
+    private createRenderer;
+    private bindInputEvents;
+    private unbindInputEvents;
+    private handleContextMenu;
+    private handlePointerEvent;
+    private sendTouch;
+    private handleWheelEvent;
+    sendText(text: string): void;
+    sendKeyCode(keyCode: AndroidKeyCode, action: AndroidKeyEventAction, metaState?: number): void;
+    clickKey(keyCode: AndroidKeyCode, metaState?: AndroidMetaState): void;
+    volumeUp(): void;
+    volumeDown(): void;
+    home(): void;
+    back(): void;
+    menu(): void;
+    setRotation(rotation: 0 | 1): void;
+    getRotation(): 0 | 1;
+    getRunningState(): boolean;
+    getVideoSize(): {
+        width: number;
+        height: number;
+    };
+    getConfig(): VmosEdgeClientConfig | null;
+    getScale(): number;
+}
+
+export { AndroidKeyCode, AndroidKeyEventAction, AndroidMetaState, AndroidMotionEventAction, AndroidMotionEventButton, VmosEdgeClient, VmosEdgeClientEvents, VmosEdgeErrorCode, VmosEdgeErrorType };
+export type { AllChannelsStatus, ChannelStatus, VmosEdgeChannelConnectedEvent, VmosEdgeClientConfig, VmosEdgeClientEventListener, VmosEdgeClientEventMap, VmosEdgeClientEventName, VmosEdgeClientOptions, VmosEdgeErrorEvent, VmosEdgeSizeChangedEvent };

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@vmosedge/web-sdk",
+  "version": "1.0.1",
+  "main": "./dist/index.cjs.js",
+  "module": "./dist/index.es.js",
+  "scripts": {},
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "web",
+    "vmos-edge",
+    "vmos-edge-web-sdk"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "ask",
+  "license": "ISC",
+  "description": "Vmos Edge Web SDK",
+  "dependencies": {},
+  "devDependencies": {},
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.cjs.js"
+    }
+  }
+}