trtc-cloud-js-sdk 2.12.3 → 2.13.0-beta.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "trtc-cloud-js-sdk",
-  "version": "2.12.3",
+  "version": "2.13.0-beta.10",
   "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.1-kit.2"
+    "trtc-sdk-v5": "5.18.4-beta.17"
   }
 }

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

@@ -2,6 +2,7 @@ import EventEmitter from 'eventemitter3';
 import { VirtualBackground } from 'trtc-sdk-v5/plugins/video-effect/virtual-background';
 import { BasicBeauty } from 'trtc-sdk-v5/plugins/video-effect/basic-beauty';
 import VideoMixer from 'trtc-sdk-v5/plugins/video-effect/video-mixer';
+import Whiteboard from 'trtc-sdk-v5/plugins/whiteboard';
 
 declare enum TRTCVideoResolution {
     TRTCVideoResolution_120_120 = 1,
@@ -780,11 +781,14 @@ interface ITRTCMediaMixingManager {
     addMediaSource(mediaSource: TRTCMediaSource): Promise<void>;
     removeMediaSource(mediaSource: TRTCMediaSource): Promise<void>;
     updateMediaSource(mediaSource: TRTCMediaSource): Promise<void>;
-    startPublish(): Promise<void>;
+    startPublish(options?: {
+        streamType?: TRTCVideoStreamType;
+    }): Promise<void>;
     stopPublish(): Promise<void>;
     updatePublishParams(params: TRTCMediaMixingEncParam): Promise<void>;
-    bindPreviewArea(view: HTMLElement | null): void;
-    destroy(): void;
+    bindPreviewArea(view: HTMLElement | null): Promise<void>;
+    updatePreviewArea(view: HTMLElement | null): Promise<void>;
+    destroy(): Promise<void>;
     on(event: string, func: (...args: any[]) => void): void;
     off(event: string, func: (...args: any[]) => void): void;
 }
@@ -813,6 +817,7 @@ declare class TRTCMediaMixingManager implements ITRTCMediaMixingManager {
     private sourceList;
     private trtcSourceMap;
     private mixVideoTrack;
+    private publishStreamType;
     private selectedSource;
     private logger;
     private trtc;
@@ -853,6 +858,7 @@ declare class TRTCMediaMixingManager implements ITRTCMediaMixingManager {
      * mediaMixingManager.bindPreviewArea( previewDOM);
      */
     bindPreviewArea(view: HTMLElement | null): Promise<void>;
+    updatePreviewArea(view: HTMLElement | null): Promise<void>;
     private _getTRTCSourceKey;
     private _getTRTCFillMode;
     private _getTRTCVideoProfile;
@@ -881,9 +887,13 @@ declare class TRTCMediaMixingManager implements ITRTCMediaMixingManager {
     updateMediaSource(mediaSource: TRTCMediaSource): Promise<void>;
     /**
      * 开始推流
+     * @param options {Object} - 推流参数，可选
+     * @param options.streamType {TRTCVideoStreamType} - 混流输出推流目标，默认主流。
      * @returns {Promise<void>}
      */
-    startPublish(): Promise<void>;
+    startPublish(options?: {
+        streamType?: TRTCVideoStreamType;
+    }): Promise<void>;
     /**
      * 停止推流
      * @returns {Promise<void>}
@@ -925,6 +935,107 @@ declare class TRTCMediaMixingManager implements ITRTCMediaMixingManager {
     private unselectMediaSource;
 }
 
+declare type WhiteboardToolType = 'pen' | 'rect' | 'ellipse' | 'arrow' | 'laser' | 'eraserObject';
+declare type WhiteboardOp = 'undo' | 'redo' | 'clearall';
+interface WhiteboardCanvasInfo {
+    width: number;
+    height: number;
+}
+interface WhiteboardToolConfig {
+    type?: WhiteboardToolType;
+    color?: string | number;
+    line_width?: number;
+    laserFadeDuration?: number;
+}
+interface WhiteboardRecvCommand {
+    enable: number;
+    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;
+    };
+}
+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;
+}
+/**
+ * 白板事件 event_type 枚举，取值与 native 完全一致。
+ * native 通过 onExperimentalEvent("onSendWhiteboardCommand", params) 上抛，
+ * 由 params.event_type 区分具体事件。
+ */
+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"
+}
+/**
+ * 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;
+    can_undo?: boolean;
+    can_redo?: boolean;
+    target_user?: string;
+    pending_count?: number;
+    resent_count?: number;
+    reason?: string;
+}
+
+declare class TRTCWhiteboardManager implements ITRTCWhiteboardManager {
+    static whiteboardManager: TRTCWhiteboardManager | null;
+    private trtc;
+    private trtcCloud;
+    private readonly eventEmitter;
+    private boundPlugin;
+    private started;
+    constructor(options: {
+        trtc: any;
+        trtcCloud?: any;
+    });
+    onRecvWhiteboardCommand(command: WhiteboardRecvCommand): Promise<void>;
+    private _start;
+    private _update;
+    private _stop;
+    private _applyLocalOp;
+    /** 按翻译表把插件事件转成 native event_type 上抛；同一插件实例只绑一次。 */
+    private _bindPluginEvents;
+    /**
+     * 对齐 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>;
+}
+
 /**
  * 转录参数
  */
@@ -1058,6 +1169,7 @@ declare class AITranscriberManager implements IAITranscriberManager {
     destroy(): void;
 }
 
+declare const loggerManager: any;
 declare class TRTC_Cloud extends EventEmitter {
     static shareInstance: TRTC_Cloud | null;
     static subCloudMap: Map<TRTC_Cloud, TRTC_Cloud>;
@@ -1127,7 +1239,7 @@ declare class TRTC_Cloud extends EventEmitter {
     private _hasJoinedRoom;
     private _isExitingRoom;
     constructor(config?: ITRTCCloudConfig);
-    static getPlugin(pluginName: string): typeof VirtualBackground | typeof BasicBeauty | typeof VideoMixer | null;
+    static getPlugin(pluginName: string): typeof VirtualBackground | typeof BasicBeauty | typeof VideoMixer | typeof Whiteboard | null;
     /**
      * 创建 TRTCCloud 对象单例
      * @param {ITRTCCloudConfig} config 构造函数初始化
@@ -1632,6 +1744,7 @@ declare class TRTC_Cloud extends EventEmitter {
      * @param {Number} params.videoFps 帧率
      * @param {Number} params.videoBitrate 码率
      * @param {Boolean=} params.screenAudio 屏幕分享是否采集系统音频, 默认 false 不采集
+     * @param {Boolean=} params.applyResolutionConstraints 是否将设置的分辨率作为约束应用于屏幕采集, 默认 false
      * @param {MediaStreamTrack=} params.videoTrack 自定义采集的 videoTrack
      * **Note:**
      * - 采集系统声音只支持 Chrome M74+ ，在 Windows 和 Chrome OS 上，可以捕获整个系统的音频
@@ -1673,10 +1786,13 @@ declare class TRTC_Cloud extends EventEmitter {
      *  await trtcCloud.stopScreenShare();
      */
     stopScreenShare(): Promise<void>;
-    _startPublishVideoTrack({ videoTrack }: {
+    _startPublishVideoTrack({ videoTrack, streamType }: {
         videoTrack: MediaStreamTrack;
+        streamType?: TRTCVideoStreamType;
+    }): Promise<void>;
+    _stopPublishVideoTrack({ streamType }?: {
+        streamType?: TRTCVideoStreamType;
     }): Promise<void>;
-    _stopPublishVideoTrack(): Promise<void>;
     startScreenCapture(): void;
     pauseScreenCapture(): void;
     resumeScreenCapture(): void;
@@ -2040,7 +2156,12 @@ declare class TRTC_Cloud extends EventEmitter {
        * @returns {TRTCMediaMixingManager | null}
        */
     getMediaMixingManager(): TRTCMediaMixingManager;
+    /**
+     * 获取互动白板管理器
+     * @returns {TRTCWhiteboardManager}
+     */
+    getWhiteboardManager(): TRTCWhiteboardManager;
     getAITranscriberManager(): AITranscriberManager;
 }
 
-export { AITranscriberListener, AudioMuteType, IAITranscriberManager, ITRTCMediaMixingEvent, ITRTCMediaMixingManager, 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, TranscriberMessage, TranscriberParams, TRTC_Cloud as default };
+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 };