trtc-electron-sdk 9.3.8-beta.0 → 9.3.105-beta.2

package/liteav/trtc.d.ts

@@ -793,6 +793,8 @@ declare class TRTCCloud extends EventEmitter {
      *
      * 参考文档：[云端混流转码](https://cloud.tencent.com/document/product/647/16827)。
      *
+     * 注意：混流转码为收费功能，调用接口将产生云端混流转码费用，详见 [云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。
+     *
      * @note 关于云端混流的注意事项：
      *  - 云端转码会引入一定的 CDN 观看延时，大概会增加1 - 2秒。
      *  - 调用该函数的用户，会将连麦中的多路画面混合到自己当前这路画面中。
@@ -1444,7 +1446,7 @@ declare class TRTCCloud extends EventEmitter {
      */
     selectScreenCaptureTarget(type: number, sourceId: string, sourcename: string, captureRect: Rect, captureMouse: boolean, highlightWindow: boolean): any;
     /**
-     * 8.7 启动屏幕分享，支持选择使用主路或辅路进行屏幕分享。（暂不支持 mac 平台预览界面）
+     * 8.7 启动屏幕分享，支持选择使用主路或辅路进行屏幕分享。
      *
      * 注意:
      * 一个用户同时最多只能上传一条主路（TRTCVideoStreamTypeBig）画面和一条辅路（TRTCVideoStreamTypeSub）画面，
@@ -1516,6 +1518,28 @@ declare class TRTCCloud extends EventEmitter {
      * @note 该方法只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeScreen 时生效，即分享屏幕时生效
      */
     removeAllExcludedShareWindow(): void;
+    /**
+     * 8.16 将指定窗口加入屏幕分享的包含列表中（该接口仅支持桌面系统）
+     *
+     * @param {String} win - 希望被分享出去的窗口（Windows 平台下为窗口句柄： HWND）
+     * - 该方法只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效，即分享窗口内容时，额外包含指定窗口的功能才生效。
+     * - 您在 startScreenCapture 之前和之后调用均可。
+     * - 通过该方法添加到包含列表中的窗口，会在退出房间后被 SDK 自动清除。
+     */
+    addIncludedShareWindow(win: string): void;
+    /**
+     * 8.17 将指定窗口从屏幕分享的包含列表中移除（该接口仅支持桌面系统）
+     *
+     * @param {String} win - 希望被分享出去的窗口（Mac 平台: 窗口 ID；Windows 平台： HWND）
+     * - 该方法只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效，即分享窗口内容时，额外包含指定窗口的功能才生效。
+     */
+    removeIncludedShareWindow(win: string): void;
+    /**
+     * 8.18 将全部窗口从屏幕分享的包含列表中移除（该接口仅支持桌面系统）
+     *
+     * @note 该方法只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效，即分享窗口内容时，额外包含指定窗口的功能才生效。
+     */
+    removeAllIncludedShareWindow(): void;
     /**
      * @private
      * 9.5 设置本地视频自定义渲染（Electron 平台下不可用）
@@ -1839,7 +1863,7 @@ declare class TRTCCloud extends EventEmitter {
      * 测速结果将会用于优化 SDK 接下来的服务器选择策略，因此推荐您在用户首次通话前先进行一次测速，这将有助于我们选择最佳的服务器。
      * 同时，如果测试结果非常不理想，您可以通过醒目的 UI 提示用户选择更好的网络。
      *
-     * 注意：测速本身会消耗一定的流量，所以也会产生少量额外的流量费用。
+     * 注意：测速过程将产生少量的基础服务费用，详见 [计费概述 > 基础服务](https://cloud.tencent.com/document/product/647/17157#.E5.9F.BA.E7.A1.80.E6.9C.8D.E5.8A.A1) 文档说明。
      *
      * @param {Number} sdkAppId - 应用标识
      * @param {String} userId   - 用户标识
@@ -1975,7 +1999,6 @@ declare class TRTCCloud extends EventEmitter {
     removePlugin(id: string): void;
     getPluginList(): PluginInfo[];
     createPlugin(pluginId: string): PluginInfo;
-    setPluginCallback(pluginCb: (pluginId: string, errorCode: number, msg: string) => void): void;
     getKey(uid: string, type: TRTCVideoStreamType): string;
     /**
      * 判断是否支持webGL

package/liteav/trtc.js

@@ -1335,6 +1335,8 @@ class TRTCCloud extends events_1.EventEmitter {
      *
      * 参考文档：[云端混流转码](https://cloud.tencent.com/document/product/647/16827)。
      *
+     * 注意：混流转码为收费功能，调用接口将产生云端混流转码费用，详见 [云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。
+     *
      * @note 关于云端混流的注意事项：
      *  - 云端转码会引入一定的 CDN 观看延时，大概会增加1 - 2秒。
      *  - 调用该函数的用户，会将连麦中的多路画面混合到自己当前这路画面中。
@@ -2308,7 +2310,7 @@ class TRTCCloud extends events_1.EventEmitter {
         }
     }
     /**
-     * 8.7 启动屏幕分享，支持选择使用主路或辅路进行屏幕分享。（暂不支持 mac 平台预览界面）
+     * 8.7 启动屏幕分享，支持选择使用主路或辅路进行屏幕分享。
      *
      * 注意:
      * 一个用户同时最多只能上传一条主路（TRTCVideoStreamTypeBig）画面和一条辅路（TRTCVideoStreamTypeSub）画面，
@@ -2424,6 +2426,34 @@ class TRTCCloud extends events_1.EventEmitter {
     removeAllExcludedShareWindow() {
         this.rtcCloud.removeAllExcludedShareWindow();
     }
+    /**
+     * 8.16 将指定窗口加入屏幕分享的包含列表中（该接口仅支持桌面系统）
+     *
+     * @param {String} win - 希望被分享出去的窗口（Windows 平台下为窗口句柄： HWND）
+     * - 该方法只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效，即分享窗口内容时，额外包含指定窗口的功能才生效。
+     * - 您在 startScreenCapture 之前和之后调用均可。
+     * - 通过该方法添加到包含列表中的窗口，会在退出房间后被 SDK 自动清除。
+     */
+    addIncludedShareWindow(win) {
+        this.rtcCloud.addIncludedShareWindow(win);
+    }
+    /**
+     * 8.17 将指定窗口从屏幕分享的包含列表中移除（该接口仅支持桌面系统）
+     *
+     * @param {String} win - 希望被分享出去的窗口（Mac 平台: 窗口 ID；Windows 平台： HWND）
+     * - 该方法只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效，即分享窗口内容时，额外包含指定窗口的功能才生效。
+     */
+    removeIncludedShareWindow(win) {
+        this.rtcCloud.removeIncludedShareWindow(win);
+    }
+    /**
+     * 8.18 将全部窗口从屏幕分享的包含列表中移除（该接口仅支持桌面系统）
+     *
+     * @note 该方法只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效，即分享窗口内容时，额外包含指定窗口的功能才生效。
+     */
+    removeAllIncludedShareWindow() {
+        this.rtcCloud.removeAllIncludedShareWindow();
+    }
     /////////////////////////////////////////////////////////////////////////////////
     //
     //                      （九）自定义采集和渲染
@@ -2909,7 +2939,7 @@ class TRTCCloud extends events_1.EventEmitter {
      * 测速结果将会用于优化 SDK 接下来的服务器选择策略，因此推荐您在用户首次通话前先进行一次测速，这将有助于我们选择最佳的服务器。
      * 同时，如果测试结果非常不理想，您可以通过醒目的 UI 提示用户选择更好的网络。
      *
-     * 注意：测速本身会消耗一定的流量，所以也会产生少量额外的流量费用。
+     * 注意：测速过程将产生少量的基础服务费用，详见 [计费概述 > 基础服务](https://cloud.tencent.com/document/product/647/17157#.E5.9F.BA.E7.A1.80.E6.9C.8D.E5.8A.A1) 文档说明。
      *
      * @param {Number} sdkAppId - 应用标识
      * @param {String} userId   - 用户标识
@@ -3168,15 +3198,9 @@ class TRTCCloud extends events_1.EventEmitter {
             },
             setParameter: (param) => {
                 return this.rtcCloud.setPluginParameter(pluginId, param);
-            },
-            getParameter: () => {
-                return this.rtcCloud.getPluginParameter(pluginId);
             }
         };
     }
-    setPluginCallback(pluginCb) {
-        this.rtcCloud.setPluginCallback(pluginCb);
-    }
     getKey(uid, type) {
         return String(uid) + '_' + String(type);
     }

package/liteav/trtc_define.d.ts

@@ -616,6 +616,9 @@ export declare class TRTCRemoteStatistics {
  * @param {Number} rtt       - 延迟（毫秒），代表 SDK 跟服务器一来一回之间所消耗的时间，这个值越小越好。
  *                             一般低于50ms的 rtt 是比较理想的情况，而高于100ms的 rtt 会引入较大的通话延时。
  *                             由于数据上下行共享一条网络连接，所以 local 和 remote 的 rtt 相同。
+ * @param {Number} gatewayRtt  - 延迟（毫秒），指 SDK 到本地路由器网关一次网络往返时间，该值越小越好。
+ *                               一般低于 50ms 的 gatewayRtt 相对理想，而高于 200ms 的 gatewayRtt 会引入较大的通话延时。
+ *                               当网络为蜂窝网非 WiFi 类型时，该值无效。
  * @param {Number} receivedBytes - 总接收字节数（包含信令和音视频）
  * @param {Number} sentBytes     - 总发送字节总数（包含信令和音视频）
  * @param {TRTCLocalStatistics[]} localStatisticsArray - 自己本地的音视频统计信息，由于可能有大画面、小画面以及辅路画面等多路的情况，所以是一个数组
@@ -630,13 +633,14 @@ export declare class TRTCStatistics {
     appCpu: number;
     systemCpu: number;
     rtt: number;
+    gatewayRtt: number;
     receivedBytes: number;
     sentBytes: number;
     localStatisticsArray: TRTCLocalStatistics[];
     localStatisticsArraySize: number;
     remoteStatisticsArray: TRTCRemoteStatistics[];
     remoteStatisticsArraySize: number;
-    constructor(upLoss?: number, downLoss?: number, appCpu?: number, systemCpu?: number, rtt?: number, receivedBytes?: number, sentBytes?: number, localStatisticsArray?: TRTCLocalStatistics[], localStatisticsArraySize?: number, remoteStatisticsArray?: TRTCRemoteStatistics[], remoteStatisticsArraySize?: number);
+    constructor(upLoss?: number, downLoss?: number, appCpu?: number, systemCpu?: number, rtt?: number, gatewayRtt?: number, receivedBytes?: number, sentBytes?: number, localStatisticsArray?: TRTCLocalStatistics[], localStatisticsArraySize?: number, remoteStatisticsArray?: TRTCRemoteStatistics[], remoteStatisticsArraySize?: number);
 }
 /**
  * 音乐参数
@@ -693,5 +697,4 @@ export interface PluginInfo {
     enable: () => number;
     disable: () => number;
     setParameter: (param: string) => number;
-    getParameter: (paramKey: string) => string;
 }

package/liteav/trtc_define.js

@@ -1194,6 +1194,9 @@ exports.TRTCRemoteStatistics = TRTCRemoteStatistics;
  * @param {Number} rtt       - 延迟（毫秒），代表 SDK 跟服务器一来一回之间所消耗的时间，这个值越小越好。
  *                             一般低于50ms的 rtt 是比较理想的情况，而高于100ms的 rtt 会引入较大的通话延时。
  *                             由于数据上下行共享一条网络连接，所以 local 和 remote 的 rtt 相同。
+ * @param {Number} gatewayRtt  - 延迟（毫秒），指 SDK 到本地路由器网关一次网络往返时间，该值越小越好。
+ *                               一般低于 50ms 的 gatewayRtt 相对理想，而高于 200ms 的 gatewayRtt 会引入较大的通话延时。
+ *                               当网络为蜂窝网非 WiFi 类型时，该值无效。
  * @param {Number} receivedBytes - 总接收字节数（包含信令和音视频）
  * @param {Number} sentBytes     - 总发送字节总数（包含信令和音视频）
  * @param {TRTCLocalStatistics[]} localStatisticsArray - 自己本地的音视频统计信息，由于可能有大画面、小画面以及辅路画面等多路的情况，所以是一个数组
@@ -1203,12 +1206,13 @@ exports.TRTCRemoteStatistics = TRTCRemoteStatistics;
  *
  */
 class TRTCStatistics {
-    constructor(upLoss = 0, downLoss = 0, appCpu = 0, systemCpu = 0, rtt = 0, receivedBytes = 0, sentBytes = 0, localStatisticsArray = [], localStatisticsArraySize = 0, remoteStatisticsArray = [], remoteStatisticsArraySize = 0) {
+    constructor(upLoss = 0, downLoss = 0, appCpu = 0, systemCpu = 0, rtt = 0, gatewayRtt = 0, receivedBytes = 0, sentBytes = 0, localStatisticsArray = [], localStatisticsArraySize = 0, remoteStatisticsArray = [], remoteStatisticsArraySize = 0) {
         this.upLoss = upLoss;
         this.downLoss = downLoss;
         this.appCpu = appCpu;
         this.systemCpu = systemCpu;
         this.rtt = rtt;
+        this.gatewayRtt = gatewayRtt;
         this.receivedBytes = receivedBytes;
         this.sentBytes = sentBytes;
         this.localStatisticsArray = localStatisticsArray;

package/package.json

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