trtc-cloud-js-sdk 2.13.2-beta.1 → 2.13.2-beta.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "trtc-cloud-js-sdk",
-  "version": "2.13.2-beta.1",
+  "version": "2.13.2-beta.3",
   "description": "Tencent Cloud RTC SDK for Web And Electron",
   "main": "trtc-cloud-js-sdk.js",
   "module": "trtc-cloud-js-sdk.esm.js",
@@ -19,6 +19,6 @@
   "author": "Tencent Cloud Client R&D Center",
   "license": "ISC",
   "dependencies": {
-    "trtc-sdk-v5": "5.18.4-beta.12"
+    "trtc-sdk-v5": "5.19.0-kit.1"
   }
 }

package/trtc-cloud-js-sdk.d.ts

@@ -937,15 +937,9 @@ declare class TRTCMediaMixingManager implements ITRTCMediaMixingManager {
 
 declare type WhiteboardToolType = 'pen' | 'rect' | 'ellipse' | 'arrow' | 'laser' | 'eraserObject';
 declare type WhiteboardOp = 'undo' | 'redo' | 'clearall';
-declare type WhiteboardSessionStalledReason = 'silence' | 'queue-full';
-declare enum TRTCWhiteboardEvent {
-    STARTED = "started",
-    STOPPED = "stopped",
-    ERROR = "error",
-    STALLED = "stalled",
-    RESUMED = "resumed",
-    UNDO_STATE_CHANGED = "undo-state-changed",
-    REDO_STATE_CHANGED = "redo-state-changed"
+interface WhiteboardCanvasInfo {
+    width: number;
+    height: number;
 }
 interface WhiteboardToolConfig {
     type?: WhiteboardToolType;
@@ -953,84 +947,101 @@ interface WhiteboardToolConfig {
     line_width?: number;
     laserFadeDuration?: number;
 }
-declare const WhiteboardToolConfig: any;
-interface WhiteboardCanvasInfo {
-    width: number;
-    height: number;
-}
-declare const WhiteboardCanvasInfo: any;
 interface WhiteboardRecvCommand {
     enable: number;
-    stroke_id?: string;
     op?: WhiteboardOp;
     owner_id?: string;
+    /**
+     * 白板角色（对齐插件 targetUser 语义）：
+     *   - 空 / 不传 -> host，本端作为白板发起方；
+     *   - 非空 userId -> guest，去看/画该 userId（host）的白板。
+     * 运行中传入非空值可做 guest→guest 的目标 host 切换。
+     * 注意：guest 需先 startRemoteView 把目标 host 的远端画面渲染进同一个 view 容器。
+     */
+    target_user?: string;
     view_handle?: number | string | HTMLElement;
     canvas?: WhiteboardCanvasInfo;
     tool?: WhiteboardToolConfig;
     whiteboard?: {
         interactive?: boolean;
     };
-    is_first?: boolean;
-    color?: string | number;
-    lw?: number;
-    xs?: string;
-    ys?: string;
-}
-declare const WhiteboardRecvCommand: any;
-interface WhiteboardSendPayload {
-    id: string;
-    is_first?: boolean;
-    tool?: WhiteboardToolType;
-    color?: string;
-    lw?: number;
-    xs?: string;
-    ys?: string;
-    op?: WhiteboardOp;
-}
-declare const WhiteboardSendPayload: any;
-interface WhiteboardSessionStalledInfo {
-    targetUser: string;
-    pendingCount: number;
-    reason: WhiteboardSessionStalledReason;
 }
-declare const WhiteboardSessionStalledInfo: any;
-interface WhiteboardSessionResumedInfo {
-    targetUser: string;
-    resentCount: number;
-}
-declare const WhiteboardSessionResumedInfo: any;
-interface WhiteboardHistoryStateChangedInfo {
-    available: boolean;
-}
-declare const WhiteboardHistoryStateChangedInfo: any;
 interface ITRTCWhiteboardManager {
     onRecvWhiteboardCommand(command: WhiteboardRecvCommand): Promise<void>;
     destroy(): Promise<void>;
     on(event: string, func: (...args: any[]) => void): void;
     off(event: string, func: (...args: any[]) => void): void;
 }
-declare const ITRTCWhiteboardManager: any;
+/**
+ * 白板事件 event_type 枚举。
+ * native 已有事件沿用 native 取值；Web Whiteboard 插件独有事件沿用插件事件名。
+ * 所有事件都通过 onExperimentalEvent("onSendWhiteboardCommand", params) 上抛，
+ * 由 params.event_type 区分具体事件。
+ */
+declare enum TRTCWhiteboardEvent {
+    STARTED = "started",
+    STOPPED = "stopped",
+    ERROR = "error",
+    REMOTE_STROKE_STARTED = "remote-stroke-started",
+    REMOTE_STROKE_COMMITTED = "remote-stroke-committed",
+    SESSION_HOST_LOST = "session-host-lost",
+    STALLED = "stalled",
+    RESUMED = "resumed",
+    ACK_DROPPED = "ack-dropped",
+    ROLE_CHANGED = "role-changed",
+    UNDO_STATE_CHANGED = "undo-state-changed",
+    REDO_STATE_CHANGED = "redo-state-changed"
+}
+/**
+ * native 上抛白板事件时统一使用的 experimental event name。
+ * 对齐 native：TRTCCloudListener.onExperimentalEvent(name, params)。
+ */
+declare const WHITEBOARD_EXPERIMENTAL_EVENT_NAME = "onSendWhiteboardCommand";
+/**
+ * onExperimentalEvent 上抛的 params（JSON 字符串反序列化后）结构。
+ * 字段命名对齐 native（snake_case），确保上层跨端解析逻辑一致。
+ */
+interface WhiteboardExperimentalEventPayload {
+    event_type: TRTCWhiteboardEvent | `${TRTCWhiteboardEvent}`;
+    error_code?: number;
+    error_message?: string;
+    user_id?: string;
+    stroke_id?: string;
+    can_undo?: boolean;
+    can_redo?: boolean;
+    target_user?: string;
+    pending_count?: number;
+    resent_count?: number;
+    reason?: string;
+    msg_type?: number;
+    attempts?: number;
+    enqueue_age?: number;
+    role?: 'host' | 'guest';
+}
 
 declare class TRTCWhiteboardManager implements ITRTCWhiteboardManager {
     static whiteboardManager: TRTCWhiteboardManager | null;
     private trtc;
+    private trtcCloud;
     private readonly eventEmitter;
-    private pluginEventHandlers;
-    private boundPlugin;
     private started;
     constructor(options: {
         trtc: any;
+        trtcCloud?: any;
     });
     onRecvWhiteboardCommand(command: WhiteboardRecvCommand): Promise<void>;
     private _start;
     private _update;
     private _stop;
     private _applyLocalOp;
+    /** 每次启动前绑定事件；插件会在 stop 时自动清理本次监听。 */
     private _bindPluginEvents;
-    private _offPluginEvents;
-    private _resetPluginEventBinding;
-    private _getWhiteboardPlugin;
-    private _emitWhiteboardEvent;
+    /**
+     * 对齐 native 的事件上抛：
+     * 1. 通过 trtcCloud 主监听回调抛 onExperimentalEvent(name, paramsJson)——与 native 一致；
+     * 2. 同时在 manager 自身 eventEmitter 上按 event_type 抛出，兼容已有订阅方式。
+     */
+    private _emit;
     on(event: string, func: (...args: any[]) => void): void;
     off(event: string, func: (...args: any[]) => void): void;
     destroy(): Promise<void>;
@@ -2165,4 +2176,4 @@ declare class TRTC_Cloud extends EventEmitter {
     getAITranscriberManager(): AITranscriberManager;
 }
 
-export { AITranscriberListener, AudioMuteType, IAITranscriberManager, ITRTCMediaMixingEvent, ITRTCMediaMixingManager, ITRTCWhiteboardManager, InteractionOption, Rect, TRTCAppScene, TRTCAudioQuality, TRTCAudioSceneEx, TRTCBeautyStyle, TRTCCameraCaptureMode, TRTCCameraCaptureParams, TRTCDeviceInfo, TRTCDeviceState, TRTCDeviceType, TRTCImageBuffer, TRTCLocalStatistics, TRTCLogLevel, TRTCMediaMixingEncParam, TRTCMediaMixingErrorCode, TRTCMediaMixingEvent, TRTCMediaSource, TRTCMediaSourceType, TRTCMixInputType, TRTCMixUser, TRTCNetworkQosParam, TRTCParams, TRTCPublishCDNParam, TRTCQosControlMode, TRTCQuality, TRTCQualityInfo, TRTCRemoteStatistics, TRTCRenderParams, TRTCRoleType, TRTCScreenCaptureProperty, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureSourceType, TRTCStatistics, TRTCTranscodingConfig, TRTCTranscodingConfigMode, TRTCVideoEncParam, TRTCVideoFillMode, TRTCVideoMirrorType, TRTCVideoQosPreference, TRTCVideoResolution, TRTCVideoResolutionMode, TRTCVideoRotation, TRTCVideoStreamType, TRTCVolumeInfo, TRTCWhiteboardEvent, TranscriberMessage, TranscriberParams, WhiteboardCanvasInfo, WhiteboardHistoryStateChangedInfo, WhiteboardOp, WhiteboardRecvCommand, WhiteboardSendPayload, WhiteboardSessionResumedInfo, WhiteboardSessionStalledInfo, WhiteboardSessionStalledReason, WhiteboardToolConfig, WhiteboardToolType, TRTC_Cloud as default, loggerManager };
+export { AITranscriberListener, AudioMuteType, IAITranscriberManager, ITRTCMediaMixingEvent, ITRTCMediaMixingManager, ITRTCWhiteboardManager, InteractionOption, Rect, TRTCAppScene, TRTCAudioQuality, TRTCAudioSceneEx, TRTCBeautyStyle, TRTCCameraCaptureMode, TRTCCameraCaptureParams, TRTCDeviceInfo, TRTCDeviceState, TRTCDeviceType, TRTCImageBuffer, TRTCLocalStatistics, TRTCLogLevel, TRTCMediaMixingEncParam, TRTCMediaMixingErrorCode, TRTCMediaMixingEvent, TRTCMediaSource, TRTCMediaSourceType, TRTCMixInputType, TRTCMixUser, TRTCNetworkQosParam, TRTCParams, TRTCPublishCDNParam, TRTCQosControlMode, TRTCQuality, TRTCQualityInfo, TRTCRemoteStatistics, TRTCRenderParams, TRTCRoleType, TRTCScreenCaptureProperty, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureSourceType, TRTCStatistics, TRTCTranscodingConfig, TRTCTranscodingConfigMode, TRTCVideoEncParam, TRTCVideoFillMode, TRTCVideoMirrorType, TRTCVideoQosPreference, TRTCVideoResolution, TRTCVideoResolutionMode, TRTCVideoRotation, TRTCVideoStreamType, TRTCVolumeInfo, TRTCWhiteboardEvent, TranscriberMessage, TranscriberParams, WHITEBOARD_EXPERIMENTAL_EVENT_NAME, WhiteboardCanvasInfo, WhiteboardExperimentalEventPayload, WhiteboardOp, WhiteboardRecvCommand, WhiteboardToolConfig, WhiteboardToolType, TRTC_Cloud as default, loggerManager };