yjz-web-sdk 1.0.8-beta.10 → 1.0.8-beta.12

package/lib/core/WebRTCSdk.d.ts

@@ -1,9 +1,10 @@
-import { EventEmitter } from "eventemitter3";
-import { SignalingClient } from "./signal/SignalingClient.ts";
-import { WebRTCClient } from "./rtc/WebRTCClient.ts";
-import { WebRTCConfig } from "./rtc/WebRTCConfig.ts";
+import { EventEmitter } from 'eventemitter3';
+import { SignalingClient } from './signal/SignalingClient';
+import { WebRTCClient } from './rtc/WebRTCClient';
 import type { WebRTCConfigOptions } from './rtc/WebRTCConfig';
-import { ChannelDataType } from "./data/WebrtcDataType.ts";
+import { WebRTCConfig } from './rtc/WebRTCConfig';
+import { ConnectorType } from './data/MessageType';
+import { ChannelDataType } from './data/WebrtcDataType';
 export declare class WebRTCSdk extends EventEmitter {
     config: WebRTCConfig | null;
     signalingClient: SignalingClient | null;
@@ -21,9 +22,11 @@ export declare class WebRTCSdk extends EventEmitter {
     startConnection(): void;
     private prepareConnection;
     reconnect(): Promise<void>;
-    initConnectConfig(): void;
+    initConnectConfig(initConfig?: boolean): void;
     initSignalingClient(): void;
-    switchControl(isControl: boolean): void;
+    switchControl(roomId: string, connectorType: ConnectorType): void;
+    updateConfig(options: WebRTCConfigOptions): void;
+    switchControlToMain(roomId: string): void;
     resetConfig(): void;
     /** 停止连接，并发送退出信令 */
     stop(): void;
@@ -35,11 +38,11 @@ export declare class WebRTCSdk extends EventEmitter {
     /** 发送信道数据 */
     sendChannelData(type: ChannelDataType, data: any): void;
     sendControlEvent(key: number): void;
-    sendRequestScreenshot(visible: boolean): void;
+    sendGroupAcceptControl(roomIds: string[], acceptControl: boolean): void;
     /**
-     * 处理 signal 消息，根据不同消息类型分发到 webRTCClient 或直接触发 SDK 事件
-     * @param message 信令消息
-     */
+       * 处理 signal 消息，根据不同消息类型分发到 webRTCClient 或直接触发 SDK 事件
+       * @param message 信令消息
+       */
     private handleSignaling;
     clearTimer: () => void;
     /** 发送 Offer 信令 */
@@ -50,4 +53,5 @@ export declare class WebRTCSdk extends EventEmitter {
     sendICEMessage: (ice: string) => void;
     sendPong(): void;
     sendSignOut(): void;
+    groupSendAction(type: ChannelDataType, data: any): void;
 }

package/lib/core/data/MessageType.d.ts

@@ -9,6 +9,7 @@ export declare enum MessageType {
     Pong = "Pong",
     SendScreenshot = "SendScreenshot",
     KickOut = "KickOut",
+    GroupPeersMessage = "GroupPeer",
     Error = "Error"
 }
 export declare enum SendType {
@@ -19,8 +20,41 @@ export declare enum SendType {
     IceCandidates = "IceCandidates",
     Pong = "Pong",
     Identity = "Web",
-    RequestScreenshot = "RequestScreenshot",
-    SwitchControl = "SwitchControl"
+    SwitchControl = "SwitchControl",
+    GroupSignIn = "GroupSignIn",
+    GroupSignOut = "GroupSignOut",
+    GroupSendAction = "GroupSendAction",
+    SwitchControlToMain = "SwitchControlToMain",
+    GroupAcceptControl = "GroupAcceptControl"
+}
+/**
+ * 标识自己以什么类型连接云机
+ * 内网转发类型中，主从切换由config中mainRoomIdOfGroup, subRoomIdsOfGroup控制
+ * 非内网转发类型中，主从切换由config中connectorType控制
+ */
+export declare enum ConnectorType {
+    /**
+     * 主控类型
+     * 页面展示: WebRTC
+     * 数据通道: WebRTC dataChannel
+     */
+    WebRTC = "webrtc",
+    /**
+     * 内网转发类型
+     * 主控
+     * 页面展示: WebRTC
+     * 数据通道: WebRTC dataChannel
+     * 从控
+     * 页面展示: Websocket
+     * 数据通道: Websocket
+     */
+    LanForwarding = "lanForwarding",
+    /**
+     * 混合-从控类型
+     * 页面展示: Websocket
+     * 数据通道: WebRTC dataChannel
+     */
+    Hybrid = "hybrid"
 }
 export declare enum IceConnectionState {
     NEW = "new",

package/lib/core/data/WebRtcError.d.ts

@@ -51,6 +51,6 @@ export declare enum EmitType {
     statisticInfo = "statisticInfo",
     cloudClipData = "cloudClipData",
     screenshot = "screenshot",
-    groupError = "groupError",
-    reconnect = "reconnect"
+    reconnect = "reconnect",
+    groupError = "groupError"
 }

package/lib/core/data/WebrtcDataType.d.ts

@@ -19,24 +19,24 @@ export declare enum ActionCommandEventValue {
 }
 export declare enum ActionCommandType {
     /**
-     * 执行云机back
-     */
+       * 执行云机back
+       */
     ActionBack = "ActionBack",
     /**
-     * 执行云机Home
-     */
+       * 执行云机Home
+       */
     ActionHome = "ActionHome",
     /**
-     * 执行云机Recent
-     */
+       * 执行云机Recent
+       */
     ActionRecent = "ActionRecent",
     /**
-     * 切换到虚拟按键模式
-     */
+       * 切换到虚拟按键模式
+       */
     ActionSwitchNavButtons = "ActionSwitchNavButtons",
     /**
-     * 切换到手势模式
-     */
+       * 切换到手势模式
+       */
     ActionSwitchNavGestural = "ActionSwitchNavGestural"
 }
 export interface ActionCommand {
@@ -124,51 +124,51 @@ export declare class ChannelData {
     constructor(type: ChannelDataType, data?: string | null, myId?: string | null);
     toString(): string;
     /**
-     * 格式化数据
-     * 如果数据已经是字符串，则直接返回；否则使用 JSON.stringify() 转换为字符串
-     * @param data 待转换数据
-     * @returns 格式化后的字符串
-     */
+       * 格式化数据
+       * 如果数据已经是字符串，则直接返回；否则使用 JSON.stringify() 转换为字符串
+       * @param data 待转换数据
+       * @returns 格式化后的字符串
+       */
     private static formatData;
     /**
-     * 生成点击数据
-     * @param touchData 触摸数据，可以是任意类型
-     */
+       * 生成点击数据
+       * @param touchData 触摸数据，可以是任意类型
+       */
     static click(touchData: any): ChannelData;
     static action(actionData: any): ChannelData;
     /**
-     * 生成剪贴板数据
-     * @param data 剪贴板数据，可以是字符串或其他类型
-     */
+       * 生成剪贴板数据
+       * @param data 剪贴板数据，可以是字符串或其他类型
+       */
     static clipboard(data: any): ChannelData;
     /**
-     * 生成输入数据
-     * @param data 输入数据对象
-     */
+       * 生成输入数据
+       * @param data 输入数据对象
+       */
     static input(data: any, myId: string): ChannelData;
     /**
-     * 生成鼠标滚动数据
-     * @param data 输入数据对象
-     */
+       * 生成鼠标滚动数据
+       * @param data 输入数据对象
+       */
     static wheel(data: any): ChannelData;
     /**
-     * 切换手势模式数据
-     * @param data 输入数据对象
-     */
+       * 切换手势模式数据
+       * @param data 输入数据对象
+       */
     static gesture(data: any): ChannelData;
     /**
-     * 生成中文输入数据
-     * @param data 中文输入数据
-     */
+       * 生成中文输入数据
+       * @param data 中文输入数据
+       */
     static chinese(data: any): ChannelData;
     /**
-     * 生成请求云设备信息数据
-     */
+       * 生成请求云设备信息数据
+       */
     static requestCloudDeviceInfo(): ChannelData;
     /**
-     * 生成清晰度数据（clarity）
-     * @param data 清晰度数据
-     */
+       * 生成清晰度数据（clarity）
+       * @param data 清晰度数据
+       */
     static clarity(data: any): ChannelData;
     static switchAudio(data: any): ChannelData;
     static changeSender(data: any): ChannelData;
@@ -202,3 +202,7 @@ export interface CloudPointer {
     action: ActionType;
     offsetTime: number;
 }
+export interface ScreenShotData {
+    roomId: string;
+    base64: string;
+}

package/lib/core/groupctrl/GroupCtrlSocketManager.d.ts

@@ -0,0 +1,18 @@
+import type { WebRTCConfigOptions } from '../rtc/WebRTCConfig';
+import type { WebRTCSdk } from '../WebRTCSdk';
+import { ChannelDataType } from '../data/WebrtcDataType';
+export declare class GroupCtrlSocketManager {
+    private config?;
+    private websocketModeSdkController?;
+    private isSynchronous;
+    constructor(config: WebRTCConfigOptions);
+    getRTCSdk(): WebRTCSdk | undefined;
+    startGroupControl(): void;
+    stopControl(): void;
+    sendData(type: ChannelDataType, data: any): void;
+    sendControlEvent(key: number): void;
+    switchToMainWebsocketMode(roomId: string): void;
+    synchronousOperation(isSynchronous: boolean): void;
+    setGroupAcceptControl(roomIds: string[], acceptControl: boolean): void;
+    private updateConfig;
+}

package/lib/core/groupctrl/SdkController.d.ts

@@ -1,16 +1,33 @@
-import { EventEmitter } from "eventemitter3";
-import type { WebRTCConfigOptions } from "../rtc/WebRTCConfig.ts";
-import type { ChannelDataType } from "../data/WebrtcDataType.ts";
+import { EventEmitter } from 'eventemitter3';
+import type { WebRTCConfigOptions } from '../rtc/WebRTCConfig.ts';
+import { WebRTCSdk } from '../WebRTCSdk';
+import type { ChannelDataType } from '../data/WebrtcDataType.ts';
+import type { ConnectorType } from '../data/MessageType';
 export declare class SdkController extends EventEmitter {
-    private sdk;
-    private config;
+    private readonly sdk;
+    private readonly config;
     constructor(config: WebRTCConfigOptions);
     private initSdk;
-    setIsControl(value: boolean): void;
     start(): void;
     stop(): void;
-    switchControl(isControl: boolean): void;
     sendData(type: ChannelDataType, data: any): void;
     sendControlData(key: number): void;
-    requestScreenshot(visible: boolean): void;
+    groupSendAction(type: ChannelDataType, data: any): void;
+    /**
+     * rtc群控环境下切换主从, 群控中每个被控者都是一个独立连接(websocket + webrtc)
+     * 因此切换主从时每个连接向自己对应的信令服务发送此信令, 信令收到后将switchControl透传给目标roomId的云机.
+     *
+     * @param roomId 切换目标房间号
+     * @param connectorType 切换目标类型
+     */
+    switchControl(roomId: string, connectorType: ConnectorType): void;
+    updateConfig(options: WebRTCConfigOptions): void;
+    /**
+     * 内网转发群控环境下切换主从, 群控中主控和所有从控处于同一连接(websocket)
+     * 因此切换主从时只需要发送一次此信令, 告诉信令要将哪个房间切换为主控. 信令服务会判断主从关系变化, 然后将switchControl分别发送给本次切换对应的2台云机.
+     * @param roomId
+     */
+    switchControlToMainMessage(roomId: string): void;
+    setGroupAcceptControl(roomIds: string[], acceptControl: boolean): void;
+    getRTCSdk(): WebRTCSdk;
 }

package/lib/core/rtc/WebRTCConfig.d.ts

@@ -1,3 +1,5 @@
+import { ConnectorType } from '../data/MessageType';
+import { LogLevel } from "../util/Logger.ts";
 export interface WebRTCConfigOptions {
     signalServerUrl: string;
     myId?: string;
@@ -9,10 +11,6 @@ export interface WebRTCConfigOptions {
     turnServerUri?: string;
     turnServerUserName?: string;
     turnServerPassword?: string;
-    isControl: boolean;
-    screenshotWidth?: number;
-    screenshotHeight?: number;
-    screenshotQuality?: number;
     canOperate?: boolean;
     screenUrl?: string;
     connectStatus?: number;
@@ -26,6 +24,15 @@ export interface WebRTCConfigOptions {
     isCalculate?: boolean;
     traceId?: string;
     signAgain?: boolean;
+    connectorType?: ConnectorType;
+    mainRoomIdOfGroup?: string;
+    subRoomIdsOfGroup?: string[];
+    mainCloudMyId?: string;
+    connectorAndRoomId?: Map<string, string>;
+    groupId?: string;
+    cacheTimeout?: number;
+    enableLogger?: boolean;
+    loggerLevel?: LogLevel;
 }
 export declare class WebRTCConfig {
     signalServerUrl: string;
@@ -38,13 +45,16 @@ export declare class WebRTCConfig {
     turnServerUri: string;
     turnServerUserName: string;
     turnServerPassword: string;
-    isControl: boolean;
-    screenshotWidth: number;
-    screenshotHeight: number;
-    screenshotQuality: number;
     token: string;
+    connectorType: ConnectorType;
+    mainRoomIdOfGroup?: string;
+    subRoomIdsOfGroup?: string[];
+    mainCloudMyId?: string;
+    connectorAndRoomId?: Map<string, string>;
+    groupId?: string;
     isGroup: boolean;
     turnKey: Array<string>;
     traceId: string;
+    signAgain: boolean;
     constructor(options: WebRTCConfigOptions);
 }

package/lib/core/signal/SignalingClient.d.ts

@@ -1,5 +1,6 @@
-import { EventEmitter } from "eventemitter3";
-import type { WebRTCConfig } from "../rtc/WebRTCConfig.ts";
+import { EventEmitter } from 'eventemitter3';
+import type { WebRTCConfig } from '../rtc/WebRTCConfig.ts';
+import { ConnectorType } from '../data/MessageType';
 export declare class SignalingClient extends EventEmitter {
     private config;
     private webSocket;
@@ -21,10 +22,9 @@ export declare class SignalingClient extends EventEmitter {
      */
     sendMessage(message: string): void;
     sendSignInMessage(): void;
-    sendSwitchControlMessage(isCtrl: boolean): void;
-    /**
-     * 用于从控请求当前截屏
-     * @param visible 当前从控page控件是否可见
-     */
-    sendRequestScreenshot(visible: boolean): void;
+    sendSwitchControlMessage(roomId: string, connectorType: ConnectorType): void;
+    sendSwitchControlToMainMessage(roomId: string): void;
+    sendGroupAcceptControl(roomIds: string[], acceptControl: boolean): void;
+    sendGroupAction(action: string): void;
+    sendGroupSignInMessage(): void;
 }

package/lib/core/util/KeyCodeUtil.d.ts

@@ -1,10 +1,13 @@
-import { KeyEventData } from "../data/WebrtcDataType.ts";
 /**
  * 根据浏览器 KeyboardEvent 计算 Android 平台的 meta 状态值
  * @param event - 浏览器的 KeyboardEvent
  * @returns 计算后的 meta 状态
  */
 export declare const computeAndroidMetaState: (event: KeyboardEvent) => number;
+export interface KeyEventData {
+    keyCode: number;
+    meta: number;
+}
 /**
  * 根据 KeyboardEvent 生成 Android 平台下的按键数据
  * @param event - 浏览器的 KeyboardEvent 对象

package/lib/core/util/Logger.d.ts

@@ -0,0 +1,20 @@
+export declare enum LogLevel {
+    DEBUG = 10,
+    INFO = 20,
+    WARN = 30,
+    ERROR = 40,
+    OFF = 100
+}
+export declare function setLogLevel(level: LogLevel): void;
+export declare function enableLog(enable: boolean): void;
+export declare function setNamespace(ns: string): void;
+declare class LoggerCore {
+    private canLog;
+    private log;
+    debug(...args: any[]): void;
+    info(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+}
+export declare const Logger: LoggerCore;
+export {};

package/lib/core/util/MapCache.d.ts

@@ -1,16 +1,18 @@
 export declare class MapCache {
     private key;
     private maxSize;
-    private expire;
+    private defaultExpire;
     constructor(key: string, maxSize?: number, expireMs?: number);
-    /** 读取 Map（自动清理过期） */
+    /** 从 localStorage 读取 Map（自动清理过期的 item） */
     getMap(): Map<string, any>;
-    /** 保存 Map（附带时间戳） */
+    /** 保存 Map（每个值都有独立的 timestamp/expire） */
     private saveMap;
-    /** 设置值（超出 maxSize 删除最早的） */
-    set(key: string, value: any): void;
-    /** 获取值（过期自动清空） */
+    /** 设置值（支持单项自定义过期时间） */
+    set(key: string, value: any, expireMs?: number): void;
+    /** 获取值（单项过期会自动清除） */
     get(key: string): any;
+    /** 检查是否存在且未过期 */
+    has(key: string): boolean;
     /** 删除 */
     delete(key: string): void;
     /** 清空 */

package/lib/core/util/TurnTestUtil.d.ts

@@ -1,5 +1,5 @@
-import type { TurnSelectionResult, TurnServerConfig, TurnTestResult, TurnTestSummary } from "../data/TurnType.ts";
-import type { WebRTCConfigOptions } from "../rtc/WebRTCConfig.ts";
+import type { TurnSelectionResult, TurnServerConfig, TurnTestResult, TurnTestSummary } from '../data/TurnType.ts';
+import type { WebRTCConfigOptions } from '../rtc/WebRTCConfig.ts';
 export declare const testTurnServer: (turnConfig: TurnServerConfig, timeoutMs?: number) => Promise<TurnTestResult>;
 export declare const testMultipleTurnServers: (servers: string[], timeoutMs?: number) => Promise<TurnTestSummary>;
 export declare const areTurnListsEmpty: (options: WebRTCConfigOptions) => boolean;

package/lib/index.d.ts

@@ -5,7 +5,8 @@ import { transformCoordinate, valueToPercentage } from "./core/util/ScreenContro
 import { ActionType, ChannelDataType, ContainerDirection, InputData, KeyEventData, TouchData, WheelData, GestureData, type ActionCommand, ActionCommandType, ActionCommandEventType, ActionCommandEventValue, TrackEventData, ClarityData } from "./core/data/WebrtcDataType";
 import { type TurnServerConfig, type TurnTestResult, type TurnTestSummary } from "./core/data/TurnType";
 import type { WebRTCConfigOptions } from './core/rtc/WebRTCConfig';
-import { GroupControllerManager } from "./core/groupctrl/GroupControllerManager";
 import { EmitType, type CameraError, type WebRtcError } from "./core/data/WebRtcError";
 import RemotePlayer from './components/RemotePlayer/index.vue';
-export { WebRTCSdk, getKeyEventData, transformCoordinate, valueToPercentage, ActionType, ChannelDataType, InputData, KeyEventData, TouchData, ContainerDirection, EmitType, WheelData, GestureData, ClarityData, type ActionCommand, ActionCommandType, GroupControllerManager, type WebRTCConfigOptions, ActionCommandEventType, ActionCommandEventValue, RemotePlayer, TrackEventData, type TurnServerConfig, type TurnTestResult, type TurnTestSummary, testMultipleTurnServers, type CameraError, type WebRtcError };
+import { ConnectorType } from './core/data/MessageType';
+import { GroupCtrlSocketManager } from './core/groupctrl/GroupCtrlSocketManager';
+export { WebRTCSdk, getKeyEventData, transformCoordinate, valueToPercentage, ActionType, ChannelDataType, InputData, KeyEventData, TouchData, ContainerDirection, EmitType, WheelData, GestureData, ClarityData, type ActionCommand, ActionCommandType, type WebRTCConfigOptions, ActionCommandEventType, ActionCommandEventValue, RemotePlayer, TrackEventData, type TurnServerConfig, type TurnTestResult, type TurnTestSummary, testMultipleTurnServers, type CameraError, type WebRtcError, ConnectorType, GroupCtrlSocketManager };