trtc-electron-sdk 13.4.802-beta.3 → 13.5.802-beta.0

package/liteav/VideoRenderControl/LocalVideoRenderController.d.ts

@@ -17,7 +17,7 @@ declare class LocalVideoRenderController {
     startLocalPreview(views: Array<HTMLElement> | HTMLElement | null): void;
     stopLocalPreview(): void;
     updateLocalView(views: Array<HTMLElement> | HTMLElement | null): void;
-    startScreenCapture(view?: HTMLElement | null): void;
+    startScreenCapture(views?: Array<HTMLElement> | HTMLElement | null): void;
     stopScreenCapture(): void;
     setCustomRenderCallback(hasCallback: boolean): void;
     setExternalRenderEnabled(enabled: boolean): void;

package/liteav/VideoRenderControl/LocalVideoRenderController.js

@@ -53,10 +53,10 @@ class LocalVideoRenderController {
             throw error;
         }
     }
-    startScreenCapture(view = null) {
+    startScreenCapture(views = null) {
         try {
             this.isLocalSharingStarted = true;
-            this.hasLocalSharingView = view !== null && view !== undefined;
+            this.hasLocalSharingView = this.validateViews(views);
             this.update();
         }
         catch (error) {

package/liteav/trtc.d.ts

@@ -2,7 +2,7 @@
 import { EventEmitter } from 'events';
 import { TRTCConfig } from './Renderer/util';
 import TRTCLocalMediaTranscoder from './LocalMediaTranscoder';
-import { AudioMusicParam, Rect, TRTCAppScene, TRTCAudioEffectParam, TRTCAudioQuality, TRTCBeautyStyle, TRTCDeviceType, TRTCLogLevel, TRTCRenderParams, TRTCRoleType, TRTCSwitchRoomParam, TRTCVideoBufferType, TRTCVideoFillMode, TRTCAudioFrame, TRTCVideoPixelFormat, TRTCVideoRotation, TRTCVideoStreamType, TRTCWaterMarkSrcType, TRTCPluginType, TRTCPluginInfo, TRTCVideoProcessPluginOptions, TRTCMediaEncryptDecryptPluginOptions, TRTCAudioRecordingParams, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureProperty, TRTCSpeedTestParams, TRTCRecordType, TRTCDeviceInfo, TRTCCameraCaptureParams, TRTCImageBuffer, TRTCInitConfig, TRTCAudioParallelParams, TRTCVoiceReverbType, TRTCVoiceChangerType, TRTCMusicPlayObserver, TRTCAudioFrameCallback, TRTCAudioProcessPluginOptions, TRTCPublishTarget, TRTCStreamEncoderParam, TRTCStreamMixingConfig } from './trtc_define';
+import { AudioMusicParam, Rect, TRTCAppScene, TRTCAudioEffectParam, TRTCAudioQuality, TRTCBeautyStyle, TRTCDeviceType, TRTCLogLevel, TRTCRenderParams, TRTCRoleType, TRTCSwitchRoomParam, TRTCVideoBufferType, TRTCVideoEncParam, TRTCVideoFillMode, TRTCAudioFrame, TRTCVideoPixelFormat, TRTCVideoRotation, TRTCVideoStreamType, TRTCWaterMarkSrcType, TRTCPluginType, TRTCPluginInfo, TRTCVideoProcessPluginOptions, TRTCMediaEncryptDecryptPluginOptions, TRTCAudioRecordingParams, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureProperty, TRTCSpeedTestParams, TRTCRecordType, TRTCDeviceInfo, TRTCCameraCaptureParams, TRTCImageBuffer, TRTCInitConfig, TRTCAudioParallelParams, TRTCVoiceReverbType, TRTCVoiceChangerType, TRTCMusicPlayObserver, TRTCAudioFrameCallback, TRTCAudioProcessPluginOptions, TRTCPublishTarget, TRTCStreamEncoderParam, TRTCStreamMixingConfig } from './trtc_define';
 import { ITRTCCloud, TRTCVideoRenderCallback } from './types';
 import TRTCMediaMixingManager, { TRTCMediaMixingService } from './extensions/MediaMixingManager';
 /**
@@ -2087,7 +2087,10 @@ declare class TRTCCloud extends EventEmitter implements ITRTCCloud {
      * 一个用户同时最多只能上传一条主路（TRTCVideoStreamTypeBig）画面和一条辅路（TRTCVideoStreamTypeSub）画面，
      * 默认情况下，屏幕分享使用辅路画面，如果使用主路画面，建议您提前停止摄像头采集（stopLocalPreview）避免相互冲突。
      *
-     * @param {HTMLElement} view - 承载预览画面的 DOM
+     * @param {Array<HTMLElement>|HTMLElement|null} views - 承载预览画面的单个 HTML 块节点或者 HTML 块节点数组
+     * - 传入单个 HTML 块节点：在该节点上预览屏幕分享画面。
+     * - 传入 HTML 块节点数组：在多个节点上同时预览同一路屏幕分享画面（多路预览），适用于双屏/多窗口场景。
+     * - 传入 `null`：不预览屏幕分享画面，但不影响屏幕分享的采集与上行；此时若设置了 [setLocalVideoRenderCallback()]{@link TRTCCloud#setLocalVideoRenderCallback} 自定义渲染回调，可通过回调获取屏幕分享的视频帧自行渲染。
      * @param {TRTCVideoStreamType} type 屏幕分享使用的线路，可以设置为主路（TRTCVideoStreamTypeBig）或者辅路（TRTCVideoStreamTypeSub），默认使用辅路。
      * @param {TRTCVideoEncParam} params 屏幕分享的画面编码参数，可以设置为 null，表示让 SDK 选择最佳的编码参数（分辨率、码率等）。即使在调用 startScreenCapture 时设置 type=TRTCVideoStreamTypeBig，依然可以使用此接口更新屏幕分享的编码参数。
      *
@@ -2133,12 +2136,20 @@ declare class TRTCCloud extends EventEmitter implements ITRTCCloud {
      * );
      *
      * rtcCloud.startScreenCapture(
-     *  view, // HTML Element
+     *  view, // 单个 HTML Element
+     *  TRTCVideoStreamType.TRTCVideoStreamTypeSub,
+     *  screenShareEncParam,
+     * );
+     *
+     * @example
+     * // 屏幕分享多路预览：同一路屏幕分享画面同时渲染到多个 HTML 元素上
+     * rtcCloud.startScreenCapture(
+     *  [viewOnCurrentScreen, viewOnExtendedScreen], // HTML Element 数组
      *  TRTCVideoStreamType.TRTCVideoStreamTypeSub,
      *  screenShareEncParam,
      * );
      */
-    startScreenCapture(view?: HTMLElement | null, type?: TRTCVideoStreamType, params?: any): void;
+    startScreenCapture(views?: Array<HTMLElement> | HTMLElement | null, type?: TRTCVideoStreamType, params?: TRTCVideoEncParam | undefined | null): void;
     /**
      * 暂停屏幕分享
      */

package/liteav/trtc.js

@@ -3636,7 +3636,10 @@ class TRTCCloud extends events_1.EventEmitter {
      * 一个用户同时最多只能上传一条主路（TRTCVideoStreamTypeBig）画面和一条辅路（TRTCVideoStreamTypeSub）画面，
      * 默认情况下，屏幕分享使用辅路画面，如果使用主路画面，建议您提前停止摄像头采集（stopLocalPreview）避免相互冲突。
      *
-     * @param {HTMLElement} view - 承载预览画面的 DOM
+     * @param {Array<HTMLElement>|HTMLElement|null} views - 承载预览画面的单个 HTML 块节点或者 HTML 块节点数组
+     * - 传入单个 HTML 块节点：在该节点上预览屏幕分享画面。
+     * - 传入 HTML 块节点数组：在多个节点上同时预览同一路屏幕分享画面（多路预览），适用于双屏/多窗口场景。
+     * - 传入 `null`：不预览屏幕分享画面，但不影响屏幕分享的采集与上行；此时若设置了 [setLocalVideoRenderCallback()]{@link TRTCCloud#setLocalVideoRenderCallback} 自定义渲染回调，可通过回调获取屏幕分享的视频帧自行渲染。
      * @param {TRTCVideoStreamType} type 屏幕分享使用的线路，可以设置为主路（TRTCVideoStreamTypeBig）或者辅路（TRTCVideoStreamTypeSub），默认使用辅路。
      * @param {TRTCVideoEncParam} params 屏幕分享的画面编码参数，可以设置为 null，表示让 SDK 选择最佳的编码参数（分辨率、码率等）。即使在调用 startScreenCapture 时设置 type=TRTCVideoStreamTypeBig，依然可以使用此接口更新屏幕分享的编码参数。
      *
@@ -3682,12 +3685,20 @@ class TRTCCloud extends events_1.EventEmitter {
      * );
      *
      * rtcCloud.startScreenCapture(
-     *  view, // HTML Element
+     *  view, // 单个 HTML Element
+     *  TRTCVideoStreamType.TRTCVideoStreamTypeSub,
+     *  screenShareEncParam,
+     * );
+     *
+     * @example
+     * // 屏幕分享多路预览：同一路屏幕分享画面同时渲染到多个 HTML 元素上
+     * rtcCloud.startScreenCapture(
+     *  [viewOnCurrentScreen, viewOnExtendedScreen], // HTML Element 数组
      *  TRTCVideoStreamType.TRTCVideoStreamTypeSub,
      *  screenShareEncParam,
      * );
      */
-    startScreenCapture(view = null, type = trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeSub, params = null) {
+    startScreenCapture(views = null, type = trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeSub, params = null) {
         if ((type !== trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeSub && type !== trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeBig)) {
             type = trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeSub;
         }
@@ -3700,12 +3711,15 @@ class TRTCCloud extends events_1.EventEmitter {
             this.stopScreenCapture();
         }
         this.screenCaptureStreamType = type;
-        if (view !== undefined) {
-            if (view !== null) {
+        if (views !== undefined) {
+            if (views !== null) {
                 const key = this._getKey(LOCAL_USER_VIDEO_ID, type);
-                this._initRenderer(key, [view]);
+                this._initRenderer(key, Array.isArray(views) ? views : [views]);
             }
-            this.localVideoRenderController.startScreenCapture(view);
+            this.localVideoRenderController.startScreenCapture(views);
+        }
+        else {
+            this.logger.error('startScreenCapture parameter views is undefined, it should be Array<HTMLElement>, HTMLElement or null');
         }
         if (params) {
             this.rtcCloud.startScreenCapture(type, params);

package/liteav/types.d.ts

@@ -1,5 +1,5 @@
 import TRTCMediaMixingManager, { TRTCMediaMixingService } from './extensions/MediaMixingManager';
-import { AudioMusicParam, Rect, TRTCAppScene, TRTCAudioQuality, TRTCBeautyStyle, TRTCDeviceType, TRTCLogLevel, TRTCAudioFrame, TRTCVideoFillMode, TRTCVideoRotation, TRTCVideoStreamType, TRTCWaterMarkSrcType, TRTCPluginType, TRTCPluginInfo, TRTCVideoProcessPluginOptions, TRTCMediaEncryptDecryptPluginOptions, TRTCAudioRecordingParams, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureProperty, TRTCSpeedTestParams, TRTCRecordType, TRTCDeviceInfo, TRTCCameraCaptureParams, TRTCImageBuffer, TRTCInitConfig, TRTCAudioParallelParams, TRTCVoiceReverbType, TRTCVoiceChangerType, TRTCMusicPlayObserver, TRTCAudioFrameCallback, TRTCAudioProcessPluginOptions, TRTCPublishTarget, TRTCStreamEncoderParam, TRTCStreamMixingConfig, TRTCRenderParams, TRTCRoleType, TRTCSwitchRoomParam, TRTCVideoFrame, TRTCVideoPixelFormat, TRTCVideoBufferType } from './trtc_define';
+import { AudioMusicParam, Rect, TRTCAppScene, TRTCAudioQuality, TRTCBeautyStyle, TRTCDeviceType, TRTCLogLevel, TRTCAudioFrame, TRTCVideoFillMode, TRTCVideoRotation, TRTCVideoStreamType, TRTCWaterMarkSrcType, TRTCPluginType, TRTCPluginInfo, TRTCVideoProcessPluginOptions, TRTCMediaEncryptDecryptPluginOptions, TRTCAudioRecordingParams, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureProperty, TRTCSpeedTestParams, TRTCRecordType, TRTCDeviceInfo, TRTCCameraCaptureParams, TRTCImageBuffer, TRTCInitConfig, TRTCAudioParallelParams, TRTCVoiceReverbType, TRTCVoiceChangerType, TRTCMusicPlayObserver, TRTCAudioFrameCallback, TRTCAudioProcessPluginOptions, TRTCPublishTarget, TRTCStreamEncoderParam, TRTCStreamMixingConfig, TRTCRenderParams, TRTCRoleType, TRTCSwitchRoomParam, TRTCVideoFrame, TRTCVideoPixelFormat, TRTCVideoBufferType, TRTCVideoEncParam } from './trtc_define';
 import { TRTCVodPlayerEventMap } from './vod_player';
 export interface TRTCVideoRenderCallback {
     onRenderVideoFrame(userId: string, streamType: TRTCVideoStreamType, frame: TRTCVideoFrame): void;
@@ -112,7 +112,7 @@ export interface ITRTCCloud {
     setWaterMark(streamType: TRTCVideoStreamType, srcData: ArrayBuffer | string | null, srcType: TRTCWaterMarkSrcType, nWidth: number, nHeight: number, xOffset: number, yOffset: number, fWidthRatio: number): void;
     getScreenCaptureSources(thumbWidth: number, thumbHeight: number, iconWidth: number, iconHeight: number): Array<TRTCScreenCaptureSourceInfo>;
     selectScreenCaptureTarget(source: TRTCScreenCaptureSourceInfo | number, captureRect: Rect | string, property: TRTCScreenCaptureProperty | string, deprecatedCaptureRect?: Rect, captureMouse?: boolean, highlightWindow?: boolean): void;
-    startScreenCapture(view?: HTMLElement | null, type?: TRTCVideoStreamType, params?: any): void;
+    startScreenCapture(views: Array<HTMLElement> | HTMLElement | null, type: TRTCVideoStreamType, params: TRTCVideoEncParam | undefined | null): void;
     pauseScreenCapture(): void;
     resumeScreenCapture(): void;
     stopScreenCapture(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "trtc-electron-sdk",
-  "version": "13.4.802-beta.3",
+  "version": "13.5.802-beta.0",
   "description": "trtc electron sdk",
   "main": "./liteav/index.js",
   "types": "./liteav/index.d.ts",