trtc-electron-sdk 9.3.8-beta.0 → 9.3.109-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, TRTCSpeedTestParams } from './trtc_define';
 export * from './trtc_define';
 export * from './trtc_code';
 /**
@@ -39,6 +39,7 @@ declare class TRTCCloud extends EventEmitter {
     private audioQuality;
     private bgmId;
     private playAudioEffectIdList;
+    private isStartLocalPreview;
     constructor();
     /**
      * 创建 TRTCCloud 对象单例
@@ -323,14 +324,23 @@ declare class TRTCCloud extends EventEmitter {
      */
     handleOnConnectionRecovery(): void;
     /**
-     * 5.4 服务器测速的回调，SDK 对多个服务器 IP 做测速，每个 IP 的测速结果通过这个回调通知
+     * 5.4 废弃事件：服务器测速的回调，SDK 对多个服务器 IP 做测速，每个 IP 的测速结果通过这个回调通知
      *
+     * @deprecated
      * @event TRTCCallback#onSpeedTest
      * @param {TRTCSpeedTestResult} currentResult - 当前完成的测速结果
      * @param {Number} finishedCount - 已完成测速的服务器数量
      * @param {Number} totalCount    - 需要测速的服务器总数量
      */
     bindOnSpeedTest(): void;
+    /**
+     * 5.5 网速测试的结果回调
+     *
+     * @event TRTCCallback#onSpeedTestResult
+     * 该统计回调由 @link TRTCCloud#startSpeedTest 触发。
+     * @param {TRTCSpeedTestResult} result - 网速测试数据数据，包括丢包、往返延迟、上下行的带宽速率，详情请参考 {@link TRTCSpeedTestResult}。
+     */
+    bindOnSpeedTestResult(): void;
     /**
      * 6.1 摄像头准备就绪
      *
@@ -793,6 +803,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秒。
      *  - 调用该函数的用户，会将连麦中的多路画面混合到自己当前这路画面中。
@@ -1441,10 +1453,12 @@ declare class TRTCCloud extends EventEmitter {
      * @param {Number} captureRect.bottom - 指定捕获的区域的下坐标
      * @param {Boolean} captureMouse    - 指定是否捕获鼠标指针
      * @param {Boolean} highlightWindow - 指定是否高亮正在共享的窗口，以及当捕获图像被遮挡时高亮遮挡窗口提示用户移走遮挡
+     * @param {Boolean} enableHighPerformance - 是否开启高性能模式（只会在分享屏幕时会生效），默认为 true。
+     * 【特殊说明】开启后屏幕采集性能最佳，但会丧失抗遮挡能力，如果您同时开启 enableHighLight + enableHighPerformance，远端用户可以看到高亮的边框。
      */
-    selectScreenCaptureTarget(type: number, sourceId: string, sourcename: string, captureRect: Rect, captureMouse: boolean, highlightWindow: boolean): any;
+    selectScreenCaptureTarget(type: number, sourceId: string, sourcename: string, captureRect: Rect, captureMouse: boolean, highlightWindow: boolean, enableHighPerformance?: boolean): any;
     /**
-     * 8.7 启动屏幕分享，支持选择使用主路或辅路进行屏幕分享。（暂不支持 mac 平台预览界面）
+     * 8.7 启动屏幕分享，支持选择使用主路或辅路进行屏幕分享。
      *
      * 注意:
      * 一个用户同时最多只能上传一条主路（TRTCVideoStreamTypeBig）画面和一条辅路（TRTCVideoStreamTypeSub）画面，
@@ -1839,13 +1853,16 @@ 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   - 用户标识
-     * @param {String} userSig  - 用户签名
+     * @param {TRTCSpeedTestParams} params  - 网络测速参数
+     * @param {Number} params.sdkAppId      - 应用标识（必填）
+     * @param {String} params.userId        - 用户标识（必填）
+     * @param {String} params.userSig       - 用户签名（必填）
+     * @param {Number} params.expectedUpBandwidth         - 预期的上行带宽（kbps，取值范围： 10 ～ 5000，为 0 时不测试）
+     * @param {Number} params.expectedDownBandwidth       - 预期的下行带宽（kbps，取值范围： 10 ～ 5000，为 0 时不测试）。
      */
-    startSpeedTest(sdkAppId: number, userId: string, userSig: string): void;
+    startSpeedTest(params: TRTCSpeedTestParams | number, userId?: string, userSig?: string): void;
     /**
      * 13.2 停止网络测速
      */
@@ -1975,7 +1992,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
@@ -2004,5 +2020,6 @@ declare class TRTCCloud extends EventEmitter {
     _YUV2RGBA(width: number, height: number, buffer: ArrayBufferLike): Uint8ClampedArray;
     _BGRA2RGBA(data: ArrayBuffer, width: number, height: number): Uint8ClampedArray;
     _isMacPlatform(): boolean;
+    _isLocalUser(uid: string): boolean;
 }
 export default TRTCCloud;

package/liteav/trtc.js

@@ -116,6 +116,7 @@ class TRTCCloud extends events_1.EventEmitter {
         // 生成一个足够大, 不会与用户输入重复的 id
         this.bgmId = 1 << 29;
         this.playAudioEffectIdList = [];
+        this.isStartLocalPreview = false;
         this.initEventHandler();
         console.log('constructor render:' + this.renderMode + '|sdk version:' + pkg.version +
             '|native sdk version:' + this.rtcCloud.getSDKVersion());
@@ -160,6 +161,7 @@ class TRTCCloud extends events_1.EventEmitter {
      */
     destroy() {
         this.firstVideoFrameList = [];
+        this.isStartLocalPreview = false;
         this.playAudioEffectIdList = [];
         this.rtcCloud.destroy();
     }
@@ -338,6 +340,7 @@ class TRTCCloud extends events_1.EventEmitter {
         this.bindOnNetworkQuality();
         this.bindOnStatistics();
         this.bindOnSpeedTest();
+        this.bindOnSpeedTestResult();
         this.bindOnUserVoiceVolume();
         this.bindOnRecvCustomCmdMsg();
         this.bindOnMissCustomCmdMsg();
@@ -418,6 +421,7 @@ class TRTCCloud extends events_1.EventEmitter {
      */
     handleOnExitRoom(reason) {
         this.firstVideoFrameList = [];
+        this.isStartLocalPreview = false;
         this.fire('onExitRoom', reason);
     }
     /**
@@ -703,8 +707,9 @@ class TRTCCloud extends events_1.EventEmitter {
         this.fire('onConnectionRecovery');
     }
     /**
-     * 5.4 服务器测速的回调，SDK 对多个服务器 IP 做测速，每个 IP 的测速结果通过这个回调通知
+     * 5.4 废弃事件：服务器测速的回调，SDK 对多个服务器 IP 做测速，每个 IP 的测速结果通过这个回调通知
      *
+     * @deprecated
      * @event TRTCCallback#onSpeedTest
      * @param {TRTCSpeedTestResult} currentResult - 当前完成的测速结果
      * @param {Number} finishedCount - 已完成测速的服务器数量
@@ -715,6 +720,18 @@ class TRTCCloud extends events_1.EventEmitter {
             this.fire('onSpeedTest', currentResult, finishedCount, totalCount);
         });
     }
+    /**
+     * 5.5 网速测试的结果回调
+     *
+     * @event TRTCCallback#onSpeedTestResult
+     * 该统计回调由 @link TRTCCloud#startSpeedTest 触发。
+     * @param {TRTCSpeedTestResult} result - 网速测试数据数据，包括丢包、往返延迟、上下行的带宽速率，详情请参考 {@link TRTCSpeedTestResult}。
+     */
+    bindOnSpeedTestResult() {
+        this.rtcCloud.onEvent('onSpeedTestResult', (result) => {
+            this.fire('onSpeedTestResult', result);
+        });
+    }
     /////////////////////////////////////////////////////////////////////////////////
     //
     //                      （六）硬件设备事件回调
@@ -1335,6 +1352,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秒。
      *  - 调用该函数的用户，会将连麦中的多路画面混合到自己当前这路画面中。
@@ -1423,6 +1442,7 @@ class TRTCCloud extends events_1.EventEmitter {
                 let key = this.getKey('local_video', trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeBig);
                 this._initRender(key, view);
             }
+            this.isStartLocalPreview = true;
             this.rtcCloud.startLocalPreview();
             this.addLocalVideoRenderCallback();
         }
@@ -1434,12 +1454,13 @@ class TRTCCloud extends events_1.EventEmitter {
      * 3.2 停止本地摄像头采集和预览
      */
     stopLocalPreview() {
+        this.isStartLocalPreview = false;
+        this.firstVideoFrameList = this.firstVideoFrameList.filter((item) => {
+            return !(this._isLocalUser(item.uid) && item.type === trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeBig);
+        });
         let key = this.getKey('local_video', trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeBig);
         this._destroyRender(key, null);
         this.rtcCloud.stopLocalPreview();
-        this.firstVideoFrameList = this.firstVideoFrameList.filter(function (item) {
-            return !('' === item.uid && item.type === trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeBig);
-        });
     }
     /**
      * 3.3 是否屏蔽自己的视频画面
@@ -2298,17 +2319,19 @@ class TRTCCloud extends events_1.EventEmitter {
      * @param {Number} captureRect.bottom - 指定捕获的区域的下坐标
      * @param {Boolean} captureMouse    - 指定是否捕获鼠标指针
      * @param {Boolean} highlightWindow - 指定是否高亮正在共享的窗口，以及当捕获图像被遮挡时高亮遮挡窗口提示用户移走遮挡
+     * @param {Boolean} enableHighPerformance - 是否开启高性能模式（只会在分享屏幕时会生效），默认为 true。
+     * 【特殊说明】开启后屏幕采集性能最佳，但会丧失抗遮挡能力，如果您同时开启 enableHighLight + enableHighPerformance，远端用户可以看到高亮的边框。
      */
-    selectScreenCaptureTarget(type, sourceId, sourcename, captureRect, captureMouse, highlightWindow) {
+    selectScreenCaptureTarget(type, sourceId, sourcename, captureRect, captureMouse, highlightWindow, enableHighPerformance = true) {
         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);
+            return this.rtcCloud.selectScreenCaptureTarget(type, sourceId, sourcename, captureRect.left, captureRect.top, captureRect.right, captureRect.bottom, captureMouse, highlightWindow, enableHighPerformance);
         }
         else {
             console.error('selectScreenCaptureTarget, sourceId or sourcename is undefined!');
         }
     }
     /**
-     * 8.7 启动屏幕分享，支持选择使用主路或辅路进行屏幕分享。（暂不支持 mac 平台预览界面）
+     * 8.7 启动屏幕分享，支持选择使用主路或辅路进行屏幕分享。
      *
      * 注意:
      * 一个用户同时最多只能上传一条主路（TRTCVideoStreamTypeBig）画面和一条辅路（TRTCVideoStreamTypeSub）画面，
@@ -2909,14 +2932,27 @@ 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   - 用户标识
-     * @param {String} userSig  - 用户签名
+     * @param {TRTCSpeedTestParams} params  - 网络测速参数
+     * @param {Number} params.sdkAppId      - 应用标识（必填）
+     * @param {String} params.userId        - 用户标识（必填）
+     * @param {String} params.userSig       - 用户签名（必填）
+     * @param {Number} params.expectedUpBandwidth         - 预期的上行带宽（kbps，取值范围： 10 ～ 5000，为 0 时不测试）
+     * @param {Number} params.expectedDownBandwidth       - 预期的下行带宽（kbps，取值范围： 10 ～ 5000，为 0 时不测试）。
      */
-    startSpeedTest(sdkAppId, userId, userSig) {
-        this.rtcCloud.startSpeedTest(sdkAppId, userId, userSig);
+    startSpeedTest(params, userId, userSig) {
+        if (params instanceof trtc_define_1.TRTCSpeedTestParams) {
+            this.rtcCloud.startSpeedTest(params.sdkAppId, params.userId, params.userSig, params.expectedUpBandwidth, params.expectedDownBandwidth);
+        }
+        else if (typeof params === 'number' && typeof userId === 'string' && typeof userSig === 'string') {
+            // 兼容旧版本调用
+            let sdkAppId = params;
+            this.rtcCloud.startSpeedTest(sdkAppId, userId, userSig, 0, 0);
+        }
+        else {
+            console.error('enterRoom, params error!');
+        }
     }
     /**
      * 13.2 停止网络测速
@@ -2955,8 +2991,8 @@ class TRTCCloud extends events_1.EventEmitter {
         let key = this.getKey('camera_device_test_view', trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeBig);
         this._destroyRender(key, null);
         this.rtcCloud.stopCameraDeviceTest();
-        this.firstVideoFrameList = this.firstVideoFrameList.filter(function (item) {
-            return !('' === item.uid && item.type === trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeBig);
+        this.firstVideoFrameList = this.firstVideoFrameList.filter((item) => {
+            return !(this._isLocalUser(item.uid) && item.type === trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeBig);
         });
     }
     /**
@@ -3168,15 +3204,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);
     }
@@ -3215,6 +3245,7 @@ class TRTCCloud extends events_1.EventEmitter {
         return this.streams.get(key);
     }
     _onRenderFrame(uid, type, width, height, timestamp, rotation, data) {
+        const isCurrentLocalUser = this._isLocalUser(uid);
         // 由于 mac 监听自定义渲染回调后不会回调 onFirstVideoFrame ，所以在这里自己实现回调 onFirstVideoFrame
         if (this._isMacPlatform()) {
             setImmediate(() => {
@@ -3222,12 +3253,14 @@ class TRTCCloud extends events_1.EventEmitter {
                     return uid === item.uid && type === item.type;
                 });
                 if (index === -1) {
-                    this.emit('onFirstVideoFrame', uid, type, width, height);
-                    this.firstVideoFrameList.push({ uid: uid, type: type });
+                    if (!isCurrentLocalUser || this.isStartLocalPreview) {
+                        this.emit('onFirstVideoFrame', uid, type, width, height);
+                        this.firstVideoFrameList.push({ uid: uid, type: type });
+                    }
                 }
             });
         }
-        if (uid.length == 0) {
+        if (isCurrentLocalUser) {
             if (this.isExternalRenderEnabled) {
                 this.fire(CUSTOM_VIDEO_DATA, {
                     uid: '', type, rotation, timestamp,
@@ -3468,6 +3501,9 @@ class TRTCCloud extends events_1.EventEmitter {
     _isMacPlatform() {
         return process.platform == 'darwin';
     }
+    _isLocalUser(uid) {
+        return uid === '';
+    }
 }
 class VideoRenderCallback {
     constructor() {

package/liteav/trtc_define.d.ts

@@ -374,6 +374,8 @@ export declare class TRTCVolumeInfo {
  * @param {Number}      upLostRate   - 上行丢包率，范围是[0 - 1.0]，例如0.3代表每向服务器发送10个数据包，可能有3个会在中途丢失。
  * @param {Number}      downLostRate - 下行丢包率，范围是[0 - 1.0]，例如0.2代表从服务器每收取10个数据包，可能有2个会在中途丢失。
  * @param {Number}      rtt          - 延迟（毫秒），代表 SDK 跟服务器一来一回之间所消耗的时间，这个值越小越好，正常数值在10ms - 100ms之间。
+ * @param {Number}      availableUpBandwidth          - 上行带宽（kbps，-1：无效值）。
+ * @param {Number}      availableDownBandwidth        - 下行带宽（kbps，-1：无效值）。
  *
  */
 export declare class TRTCSpeedTestResult {
@@ -382,7 +384,29 @@ export declare class TRTCSpeedTestResult {
     upLostRate: number;
     downLostRate: number;
     rtt: number;
-    constructor(ip?: string, quality?: TRTCQuality, upLostRate?: number, downLostRate?: number, rtt?: number);
+    availableUpBandwidth: number;
+    availableDownBandwidth: number;
+    constructor(ip?: string, quality?: TRTCQuality, upLostRate?: number, downLostRate?: number, rtt?: number, availableUpBandwidth?: number, availableDownBandwidth?: number);
+}
+/**
+ * 5.9 测速参数
+ *
+ * 您可以在用户进入房间前通过 {@link startSpeedTest} 接口测试网速（注意：请不要在通话中调用）。
+ *
+ * @param {String}     sdkAppId  - 应用标识
+ * @param {String}     userId    - 用户标识
+ * @param {String}     userSig   - 用户签名
+ * @param {Number}     expectedUpBandwidth   - 预期的上行带宽（kbps，取值范围： 10 ～ 5000，为 0 时不测试）
+ * @param {Number}     expectedDownBandwidth - 预期的下行带宽（kbps，取值范围： 10 ～ 5000，为 0 时不测试）。
+ *
+ */
+export declare class TRTCSpeedTestParams {
+    sdkAppId: number;
+    userId: string;
+    userSig: string;
+    expectedUpBandwidth: number;
+    expectedDownBandwidth: number;
+    constructor(sdkAppId?: number, userId?: string, userSig?: string, expectedUpBandwidth?: number, expectedDownBandwidth?: number);
 }
 /**
  * 记录矩形的四个点坐标
@@ -616,6 +640,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 +657,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 +721,4 @@ export interface PluginInfo {
     enable: () => number;
     disable: () => number;
     setParameter: (param: string) => number;
-    getParameter: (paramKey: string) => string;
 }

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.TRTCSpeedTestParams = 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;
 /////////////////////////////////////////////////////////////////////////////////
 //
 //                    【（一）视频相关枚举值定义】
@@ -878,19 +878,45 @@ exports.TRTCVolumeInfo = TRTCVolumeInfo;
  * @param {Number}      upLostRate   - 上行丢包率，范围是[0 - 1.0]，例如0.3代表每向服务器发送10个数据包，可能有3个会在中途丢失。
  * @param {Number}      downLostRate - 下行丢包率，范围是[0 - 1.0]，例如0.2代表从服务器每收取10个数据包，可能有2个会在中途丢失。
  * @param {Number}      rtt          - 延迟（毫秒），代表 SDK 跟服务器一来一回之间所消耗的时间，这个值越小越好，正常数值在10ms - 100ms之间。
+ * @param {Number}      availableUpBandwidth          - 上行带宽（kbps，-1：无效值）。
+ * @param {Number}      availableDownBandwidth        - 下行带宽（kbps，-1：无效值）。
  *
  */
 class TRTCSpeedTestResult {
-    constructor(ip = '', quality = TRTCQuality.TRTCQuality_Unknown, upLostRate = 0.0, downLostRate = 0.0, rtt = 0) {
+    constructor(ip = '', quality = TRTCQuality.TRTCQuality_Unknown, upLostRate = 0.0, downLostRate = 0.0, rtt = 0, availableUpBandwidth = -1, availableDownBandwidth = -1) {
         this.ip = ip;
         this.quality = quality;
         this.upLostRate = upLostRate;
         this.downLostRate = downLostRate;
         this.rtt = rtt;
+        this.availableUpBandwidth = availableUpBandwidth;
+        this.availableDownBandwidth = availableDownBandwidth;
     }
 }
 exports.TRTCSpeedTestResult = TRTCSpeedTestResult;
 ;
+/**
+ * 5.9 测速参数
+ *
+ * 您可以在用户进入房间前通过 {@link startSpeedTest} 接口测试网速（注意：请不要在通话中调用）。
+ *
+ * @param {String}     sdkAppId  - 应用标识
+ * @param {String}     userId    - 用户标识
+ * @param {String}     userSig   - 用户签名
+ * @param {Number}     expectedUpBandwidth   - 预期的上行带宽（kbps，取值范围： 10 ～ 5000，为 0 时不测试）
+ * @param {Number}     expectedDownBandwidth - 预期的下行带宽（kbps，取值范围： 10 ～ 5000，为 0 时不测试）。
+ *
+ */
+class TRTCSpeedTestParams {
+    constructor(sdkAppId = 0, userId = '', userSig = '', expectedUpBandwidth = 0, expectedDownBandwidth = 0) {
+        this.sdkAppId = sdkAppId;
+        this.userId = userId;
+        this.userSig = userSig;
+        this.expectedUpBandwidth = expectedUpBandwidth;
+        this.expectedDownBandwidth = expectedDownBandwidth;
+    }
+}
+exports.TRTCSpeedTestParams = TRTCSpeedTestParams;
 /**
  * 记录矩形的四个点坐标
  *
@@ -1194,6 +1220,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 +1232,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.109-beta.0",
   "description": "trtc electron sdk",
   "main": "./liteav/trtc.js",
   "types": "./liteav/trtc.d.ts",