trtc-electron-sdk 9.3.301 → 9.5.8-beta.0

package/liteav/trtc.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
-import { AudioMusicParam, Rect, TRTCAppScene, TRTCAudioEffectParam, TRTCAudioQuality, TRTCBeautyStyle, TRTCDeviceState, TRTCDeviceType, TRTCLogLevel, TRTCRenderParams, TRTCRoleType, TRTCSwitchRoomParam, TRTCVideoBufferType, TRTCVideoFillMode, TRTCVideoFrame, TRTCVideoPixelFormat, TRTCVideoRotation, TRTCVideoStreamType, TRTCWaterMarkSrcType, PluginInfo } from './trtc_define';
+import { AudioMusicParam, Rect, TRTCAppScene, TRTCAudioEffectParam, TRTCAudioQuality, TRTCBeautyStyle, TRTCDeviceState, TRTCDeviceType, TRTCLogLevel, TRTCRenderParams, TRTCRoleType, TRTCSwitchRoomParam, TRTCVideoBufferType, TRTCVideoFillMode, TRTCVideoFrame, TRTCVideoPixelFormat, TRTCVideoRotation, TRTCVideoStreamType, TRTCWaterMarkSrcType, PluginInfo, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureProperty } from './trtc_define';
 export * from './trtc_define';
 export * from './trtc_code';
 /**
@@ -1428,6 +1428,11 @@ declare class TRTCCloud extends EventEmitter {
      * - 共享指定区域：sourceInfoList 中 type 为 Screen 的 source，captureRect 设为非 NULL，例如 { 100, 100, 300, 300 }
      * - 共享整个窗口：sourceInfoList 中 type 为 Window 的 source，captureRect 设为 { 0, 0, 0, 0 }
      * - 共享窗口区域：sourceInfoList 中 type 为 Window 的 source，captureRect 设为非 NULL，例如 { 100, 100, 300, 300 }
+     * @param {TRTCScreenCaptureSourceInfo} source - 指定分享源，详情参考TRTCScreenCaptureSourceInfo 定义
+     * @param {Rect} captureRect    - 指定捕获的区域
+     * @param {TRTCScreenCaptureProperty} property  - 指定屏幕分享目标的属性，包括捕获鼠标，高亮捕获窗口等，详情参考TRTCScreenCaptureProperty 定义
+     *
+     * 废弃参数使用方法(针对 9.3 以下版本):
      *
      * @param {TRTCScreenCaptureSourceType} type - 采集源类型
      * - TRTCScreenCaptureSourceTypeWindow: 该分享目标是某一个Windows窗口
@@ -1443,7 +1448,7 @@ declare class TRTCCloud extends EventEmitter {
      * @param {Boolean} captureMouse    - 指定是否捕获鼠标指针
      * @param {Boolean} highlightWindow - 指定是否高亮正在共享的窗口，以及当捕获图像被遮挡时高亮遮挡窗口提示用户移走遮挡
      */
-    selectScreenCaptureTarget(type: number, sourceId: string, sourcename: string, captureRect: Rect, captureMouse: boolean, highlightWindow: boolean): any;
+    selectScreenCaptureTarget(source: TRTCScreenCaptureSourceInfo | number, captureRect: Rect | string, property: TRTCScreenCaptureProperty | string, deprecatedCaptureRect?: Rect, captureMouse?: boolean, highlightWindow?: boolean): any;
     /**
      * 8.7 启动屏幕分享，支持选择使用主路或辅路进行屏幕分享。（暂不支持 mac 平台预览界面）
      *

package/liteav/trtc.js

@@ -2289,6 +2289,11 @@ class TRTCCloud extends events_1.EventEmitter {
      * - 共享指定区域：sourceInfoList 中 type 为 Screen 的 source，captureRect 设为非 NULL，例如 { 100, 100, 300, 300 }
      * - 共享整个窗口：sourceInfoList 中 type 为 Window 的 source，captureRect 设为 { 0, 0, 0, 0 }
      * - 共享窗口区域：sourceInfoList 中 type 为 Window 的 source，captureRect 设为非 NULL，例如 { 100, 100, 300, 300 }
+     * @param {TRTCScreenCaptureSourceInfo} source - 指定分享源，详情参考TRTCScreenCaptureSourceInfo 定义
+     * @param {Rect} captureRect    - 指定捕获的区域
+     * @param {TRTCScreenCaptureProperty} property  - 指定屏幕分享目标的属性，包括捕获鼠标，高亮捕获窗口等，详情参考TRTCScreenCaptureProperty 定义
+     *
+     * 废弃参数使用方法(针对 9.3 以下版本):
      *
      * @param {TRTCScreenCaptureSourceType} type - 采集源类型
      * - TRTCScreenCaptureSourceTypeWindow: 该分享目标是某一个Windows窗口
@@ -2304,9 +2309,19 @@ class TRTCCloud extends events_1.EventEmitter {
      * @param {Boolean} captureMouse    - 指定是否捕获鼠标指针
      * @param {Boolean} highlightWindow - 指定是否高亮正在共享的窗口，以及当捕获图像被遮挡时高亮遮挡窗口提示用户移走遮挡
      */
-    selectScreenCaptureTarget(type, sourceId, sourcename, captureRect, captureMouse, highlightWindow) {
-        if (sourceId !== null && sourceId !== undefined && sourcename !== null && sourcename !== undefined) {
-            return this.rtcCloud.selectScreenCaptureTarget(type, sourceId, sourcename, captureRect.left, captureRect.top, captureRect.right, captureRect.bottom, captureMouse, highlightWindow);
+    selectScreenCaptureTarget(source, captureRect, property, deprecatedCaptureRect, captureMouse, highlightWindow) {
+        if (source && typeof source !== 'number' && captureRect instanceof trtc_define_1.Rect && property instanceof trtc_define_1.TRTCScreenCaptureProperty) {
+            return this.rtcCloud.selectScreenCaptureTarget(source.type, source.sourceId, source.sourceName, source.isMinimizeWindow, captureRect.left, captureRect.top, captureRect.right, captureRect.bottom, property.enableCaptureMouse, property.enableHighLight, property.enableHighPerformance, property.highLightColor, property.highLightWidth, property.enableCaptureChildWindow);
+        }
+        const type = source;
+        const sourceId = captureRect;
+        const sourcename = property;
+        if (sourceId !== null && sourceId !== undefined && sourcename !== null
+            && sourcename !== undefined && deprecatedCaptureRect !== undefined && captureMouse !== undefined
+            && highlightWindow !== undefined) {
+            const selSource = new trtc_define_1.TRTCScreenCaptureSourceInfo(type, sourceId, sourcename);
+            const selProperty = new trtc_define_1.TRTCScreenCaptureProperty(captureMouse, highlightWindow);
+            return this.rtcCloud.selectScreenCaptureTarget(selSource.type, selSource.sourceId, selSource.sourceName, selSource.isMinimizeWindow, deprecatedCaptureRect.left, deprecatedCaptureRect.top, deprecatedCaptureRect.right, deprecatedCaptureRect.bottom, selProperty.enableCaptureMouse, selProperty.enableHighLight, selProperty.enableHighPerformance, selProperty.highLightColor, selProperty.highLightWidth, selProperty.enableCaptureChildWindow);
         }
         else {
             console.error('selectScreenCaptureTarget, sourceId or sourcename is undefined!');

package/liteav/trtc_define.d.ts

@@ -142,7 +142,29 @@ export declare class TRTCScreenCaptureSourceInfo {
     constructor(type?: TRTCScreenCaptureSourceType, sourceId?: string, sourceName?: string, thumbBGRA?: TRTCImageBuffer, iconBGRA?: TRTCImageBuffer, isMinimizeWindow?: boolean);
 }
 /**
- * 3.6 设备信息
+ * 3.6 屏幕分享的进阶控制参数
+ *
+ * 该参数用于屏幕分享相关的接口 [selectScreenCaptureTarget]{@link TRTCCloud#selectScreenCaptureTarget}，用于在指定分享目标时设定一系列进阶控制参数。
+ * 比如：是否采集鼠标、是否要采集子窗口、是否要在被分享目标周围绘制一个边框等。
+ *
+ * @param {Boolean} enableCaptureMouse    - 是否采集目标内容的同时采集鼠标，默认为 true
+ * @param {Boolean} enableHighLight       - 是否高亮正在共享的窗口（在被分享目标周围绘制一个边框），默认为 true。
+ * @param {Boolean} enableHighPerformance - 是否开启高性能模式（只会在分享屏幕时会生效），默认为 true。【特殊说明】开启后屏幕采集性能最佳，但会丧失抗遮挡能力，如果您同时开启 enableHighLight + enableHighPerformance，远端用户可以看到高亮的边框。
+ * @param {Number} highLightColor         - 指定高亮边框的颜色，RGB 格式，传入 0 时代表采用默认颜色，默认颜色为 #8CBF26。
+ * @param {Number} highLightWidth         - 指定高亮边框的宽度，传入0时采用默认描边宽度，默认宽度为 5px，您可以设置的最大值为 50。
+ * @param {Boolean} enableCaptureChildWindow  - 窗口采集时是否采集子窗口（需要子窗口与被采集窗口具有 Owner 或 Popup 属性），默认为 false。
+ */
+export declare class TRTCScreenCaptureProperty {
+    enableCaptureMouse: boolean;
+    enableHighLight: boolean;
+    enableHighPerformance: boolean;
+    highLightColor: number;
+    highLightWidth: number;
+    enableCaptureChildWindow: boolean;
+    constructor(enableCaptureMouse?: boolean, enableHighLight?: boolean, enableHighPerformance?: boolean, highLightColor?: number, highLightWidth?: number, enableCaptureChildWindow?: boolean);
+}
+/**
+ * 3.7 设备信息
  *
  * @param {String} deviceId   - 设备PID，字符编码格式是UTF-8
  * @param {String} deviceName - 设备名称，字符编码格式是UTF-8
@@ -154,7 +176,7 @@ export declare class TRTCDeviceInfo {
     constructor(deviceId?: string, deviceName?: string);
 }
 /**
- * 3.7 视频帧数据
+ * 3.8 视频帧数据
  *
  * @param {TRTCVideoPixelFormat} videoFormat   - 视频帧的格式
  * @param {TRTCVideoBufferType} bufferType - 视频数据结构类型

package/liteav/trtc_define.js

@@ -6,7 +6,7 @@
  *
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TRTCSwitchRoomParam = exports.AudioMusicParam = exports.TRTCStatistics = exports.TRTCRemoteStatistics = exports.TRTCLocalStatistics = exports.TRTCAudioEffectParam = exports.TRTCAudioRecordingParams = exports.TRTCPublishCDNParam = exports.TRTCTranscodingConfig = exports.TRTCTranscodingConfigMode = exports.TRTCMixUser = exports.Rect = exports.TRTCSpeedTestResult = exports.TRTCVolumeInfo = exports.TRTCQualityInfo = exports.TRTCNetworkQosParam = exports.TRTCRenderParams = exports.TRTCVideoEncParam = exports.TRTCParams = exports.TRTCWaterMarkSrcType = exports.TRTCDeviceType = exports.TRTCDeviceState = exports.TRTCLogLevel = exports.TRTCVideoFrame = exports.TRTCDeviceInfo = exports.TRTCScreenCaptureSourceInfo = exports.TRTCImageBuffer = exports.TRTCAudioQuality = exports.TRTCScreenCaptureSourceType = exports.TRTCAudioFrameFormat = exports.TRTCVideoQosPreference = exports.TRTCQosControlMode = exports.TRTCRoleType = exports.TRTCAppScene = exports.TRTCVideoMirrorType = exports.TRTCVideoBufferType = exports.TRTCVideoPixelFormat = exports.TRTCBeautyStyle = exports.TRTCVideoRotation = exports.TRTCVideoFillMode = exports.TRTCQuality = exports.TRTCVideoStreamType = exports.TRTCVideoResolutionMode = exports.TRTCVideoResolution = void 0;
+exports.TRTCSwitchRoomParam = exports.AudioMusicParam = exports.TRTCStatistics = exports.TRTCRemoteStatistics = exports.TRTCLocalStatistics = exports.TRTCAudioEffectParam = exports.TRTCAudioRecordingParams = exports.TRTCPublishCDNParam = exports.TRTCTranscodingConfig = exports.TRTCTranscodingConfigMode = exports.TRTCMixUser = exports.Rect = exports.TRTCSpeedTestResult = exports.TRTCVolumeInfo = exports.TRTCQualityInfo = exports.TRTCNetworkQosParam = exports.TRTCRenderParams = exports.TRTCVideoEncParam = exports.TRTCParams = exports.TRTCWaterMarkSrcType = exports.TRTCDeviceType = exports.TRTCDeviceState = exports.TRTCLogLevel = exports.TRTCVideoFrame = exports.TRTCDeviceInfo = exports.TRTCScreenCaptureProperty = exports.TRTCScreenCaptureSourceInfo = exports.TRTCImageBuffer = exports.TRTCAudioQuality = exports.TRTCScreenCaptureSourceType = exports.TRTCAudioFrameFormat = exports.TRTCVideoQosPreference = exports.TRTCQosControlMode = exports.TRTCRoleType = exports.TRTCAppScene = exports.TRTCVideoMirrorType = exports.TRTCVideoBufferType = exports.TRTCVideoPixelFormat = exports.TRTCBeautyStyle = exports.TRTCVideoRotation = exports.TRTCVideoFillMode = exports.TRTCQuality = exports.TRTCVideoStreamType = exports.TRTCVideoResolutionMode = exports.TRTCVideoResolution = void 0;
 /////////////////////////////////////////////////////////////////////////////////
 //
 //                    【（一）视频相关枚举值定义】
@@ -539,7 +539,31 @@ class TRTCScreenCaptureSourceInfo {
 exports.TRTCScreenCaptureSourceInfo = TRTCScreenCaptureSourceInfo;
 ;
 /**
- * 3.6 设备信息
+ * 3.6 屏幕分享的进阶控制参数
+ *
+ * 该参数用于屏幕分享相关的接口 [selectScreenCaptureTarget]{@link TRTCCloud#selectScreenCaptureTarget}，用于在指定分享目标时设定一系列进阶控制参数。
+ * 比如：是否采集鼠标、是否要采集子窗口、是否要在被分享目标周围绘制一个边框等。
+ *
+ * @param {Boolean} enableCaptureMouse    - 是否采集目标内容的同时采集鼠标，默认为 true
+ * @param {Boolean} enableHighLight       - 是否高亮正在共享的窗口（在被分享目标周围绘制一个边框），默认为 true。
+ * @param {Boolean} enableHighPerformance - 是否开启高性能模式（只会在分享屏幕时会生效），默认为 true。【特殊说明】开启后屏幕采集性能最佳，但会丧失抗遮挡能力，如果您同时开启 enableHighLight + enableHighPerformance，远端用户可以看到高亮的边框。
+ * @param {Number} highLightColor         - 指定高亮边框的颜色，RGB 格式，传入 0 时代表采用默认颜色，默认颜色为 #8CBF26。
+ * @param {Number} highLightWidth         - 指定高亮边框的宽度，传入0时采用默认描边宽度，默认宽度为 5px，您可以设置的最大值为 50。
+ * @param {Boolean} enableCaptureChildWindow  - 窗口采集时是否采集子窗口（需要子窗口与被采集窗口具有 Owner 或 Popup 属性），默认为 false。
+ */
+class TRTCScreenCaptureProperty {
+    constructor(enableCaptureMouse = true, enableHighLight = true, enableHighPerformance = true, highLightColor = 0, highLightWidth = 0, enableCaptureChildWindow = false) {
+        this.enableCaptureMouse = enableCaptureMouse;
+        this.enableHighLight = enableHighLight;
+        this.enableHighPerformance = enableHighPerformance;
+        this.highLightColor = highLightColor;
+        this.highLightWidth = highLightWidth;
+        this.enableCaptureChildWindow = enableCaptureChildWindow;
+    }
+}
+exports.TRTCScreenCaptureProperty = TRTCScreenCaptureProperty;
+/**
+ * 3.7 设备信息
  *
  * @param {String} deviceId   - 设备PID，字符编码格式是UTF-8
  * @param {String} deviceName - 设备名称，字符编码格式是UTF-8
@@ -554,7 +578,7 @@ class TRTCDeviceInfo {
 exports.TRTCDeviceInfo = TRTCDeviceInfo;
 ;
 /**
- * 3.7 视频帧数据
+ * 3.8 视频帧数据
  *
  * @param {TRTCVideoPixelFormat} videoFormat   - 视频帧的格式
  * @param {TRTCVideoBufferType} bufferType - 视频数据结构类型

package/package.json

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