trtc-electron-sdk 9.6.8-alpha.2 → 9.6.8-alpha.5

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, TRTCAudioRecordingParams, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureProperty, TRTCSpeedTestParams } from './trtc_define';
 export * from './trtc_define';
 export * from './trtc_code';
 /**
@@ -323,7 +323,9 @@ declare class TRTCCloud extends EventEmitter {
      */
     handleOnConnectionRecovery(): void;
     /**
-     * 5.4 服务器测速的回调，SDK 对多个服务器 IP 做测速，每个 IP 的测速结果通过这个回调通知
+     * 5.4 废弃事件：服务器测速的回调，SDK 对多个服务器 IP 做测速，每个 IP 的测速结果通过这个回调通知
+     *
+     * @deprecated 从 TRTCSDK 9.3 后该接口已被废弃，不会抛出该事件, 请采用 onSpeedTestResult 事件代替
      *
      * @event TRTCCallback#onSpeedTest
      * @param {TRTCSpeedTestResult} currentResult - 当前完成的测速结果
@@ -331,6 +333,15 @@ declare class TRTCCloud extends EventEmitter {
      * @param {Number} totalCount    - 需要测速的服务器总数量
      */
     bindOnSpeedTest(): void;
+    /**
+     * 5.5 网速测试的结果回调
+     *
+     * 该统计回调由 startSpeedTest 触发。
+     *
+     * @event TRTCCallback#onSpeedTestResult
+     * @param {TRTCSpeedTestResult} result 网速测试数据数据，包括丢包、往返延迟、上下行的带宽速率。
+     */
+    bindOnSpeedTestResult(): void;
     /**
      * 6.1 摄像头准备就绪
      *
@@ -844,7 +855,7 @@ declare class TRTCCloud extends EventEmitter {
      * 当屏蔽本地视频后，房间里的其它成员将会收到 onUserVideoAvailable 回调通知
      * @param {Boolean} mute - true：屏蔽；false：开启，默认值：false
      */
-    muteLocalVideo(mute: boolean): void;
+    muteLocalVideo(mute: boolean, streamType?: TRTCVideoStreamType): void;
     /**
      * 3.4 开始显示远端视频画面
      *
@@ -880,8 +891,9 @@ declare class TRTCCloud extends EventEmitter {
      *
      * @param {String}  userId - 对方的用户标识
      * @param {Boolean} mute   - 是否停止接收
+     * @param {TRTCVideoStreamType} streamType   - 视频流类型
      */
-    muteRemoteVideoStream(userId: string, mute: boolean): void;
+    muteRemoteVideoStream(userId: string, mute: boolean, streamType?: TRTCVideoStreamType): void;
     /**
      * 3.8 停止接收所有远端视频流
      *
@@ -1160,10 +1172,15 @@ declare class TRTCCloud extends EventEmitter {
      * 注意：录音文件路径需精确到文件名及格式后缀，格式后缀决定录制文件的格式。
      * 例如：指定路径为 path/to/audio.aac，则会生成一个 AAC 格式的文件。目前支持的格式有 PCM, WAV, AAC
      *
-     * @param {String} path - 录音文件路径（必填），录音文件的保存路径，该路径需要用户自行指定，请确保路径存在且可写。
+     * @param {TRTCAudioRecordingParams} params                            - 录音参数。
+     * @param {String} params.filePath                                     - 文件路径（必填），录音文件的保存路径。该路径需要用户自行指定，请确保路径存在且可写
+     * @param {TRTCAudioRecordingContent} params.recordingContent          - 音频录制内容类型
      * @return {Number} 0：成功；-1：录音已开始；-2：文件或目录创建失败；-3：后缀指定的音频格式不支持
+     *
+     * 注意：
+     *     - 在 9.3 之前的版本，params 为 string 代表 录音文件路径（必填）, 9.3 以及以后同时支持 string 类型和 TRTCAudioRecordingParams。
      */
-    startAudioRecording(path: string): number;
+    startAudioRecording(params: TRTCAudioRecordingParams | string): number;
     /**
      * 4.13 停止录音
      *
@@ -1428,6 +1445,11 @@ declare class TRTCCloud extends EventEmitter {
      * - 共享整个窗口：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窗口
      * - TRTCScreenCaptureSourceTypeScreen: 该分享目标是整个Windows桌面
@@ -1442,7 +1464,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 平台预览界面）
      *
@@ -1861,13 +1883,21 @@ declare class TRTCCloud extends EventEmitter {
      * 测速结果将会用于优化 SDK 接下来的服务器选择策略，因此推荐您在用户首次通话前先进行一次测速，这将有助于我们选择最佳的服务器。
      * 同时，如果测试结果非常不理想，您可以通过醒目的 UI 提示用户选择更好的网络。
      *
-     * 注意：测速本身会消耗一定的流量，所以也会产生少量额外的流量费用。
+     * 注意：
+     * 1. 测速过程将产生少量的基础服务费用，详见 [计费概述 > 基础服务](https://cloud.tencent.com/document/product/647/17157#.E5.9F.BA.E7.A1.80.E6.9C.8D.E5.8A.A1) 文档说明。
+     * 2. 请在进入房间前进行网速测试，在房间中网速测试会影响正常的音视频传输效果，而且由于干扰过多，网速测试结果也不准确。
+     * 3. 同一时间只允许一项网速测试任务运行。
+     *
+     * @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 时不测试）。
      *
-     * @param {Number} sdkAppId - 应用标识
-     * @param {String} userId   - 用户标识
-     * @param {String} userSig  - 用户签名
+     * @return 接口调用结果，< 0：失败
      */
-    startSpeedTest(sdkAppId: number, userId: string, userSig: string): void;
+    startSpeedTest(params: TRTCSpeedTestParams | number, userId?: string, userSig?: string): any;
     /**
      * 13.2 停止网络测速
      */

package/liteav/trtc.js

@@ -342,6 +342,7 @@ class TRTCCloud extends events_1.EventEmitter {
         this.bindOnNetworkQuality();
         this.bindOnStatistics();
         this.bindOnSpeedTest();
+        this.bindOnSpeedTestResult();
         this.bindOnUserVoiceVolume();
         this.bindOnRecvCustomCmdMsg();
         this.bindOnMissCustomCmdMsg();
@@ -707,7 +708,9 @@ class TRTCCloud extends events_1.EventEmitter {
         this.fire('onConnectionRecovery');
     }
     /**
-     * 5.4 服务器测速的回调，SDK 对多个服务器 IP 做测速，每个 IP 的测速结果通过这个回调通知
+     * 5.4 废弃事件：服务器测速的回调，SDK 对多个服务器 IP 做测速，每个 IP 的测速结果通过这个回调通知
+     *
+     * @deprecated 从 TRTCSDK 9.3 后该接口已被废弃，不会抛出该事件, 请采用 onSpeedTestResult 事件代替
      *
      * @event TRTCCallback#onSpeedTest
      * @param {TRTCSpeedTestResult} currentResult - 当前完成的测速结果
@@ -719,6 +722,19 @@ class TRTCCloud extends events_1.EventEmitter {
             this.fire('onSpeedTest', currentResult, finishedCount, totalCount);
         });
     }
+    /**
+     * 5.5 网速测试的结果回调
+     *
+     * 该统计回调由 startSpeedTest 触发。
+     *
+     * @event TRTCCallback#onSpeedTestResult
+     * @param {TRTCSpeedTestResult} result 网速测试数据数据，包括丢包、往返延迟、上下行的带宽速率。
+     */
+    bindOnSpeedTestResult() {
+        this.rtcCloud.onEvent('onSpeedTestResult', (result) => {
+            this.fire('onSpeedTestResult', result);
+        });
+    }
     /////////////////////////////////////////////////////////////////////////////////
     //
     //                      （六）硬件设备事件回调
@@ -1451,8 +1467,12 @@ class TRTCCloud extends events_1.EventEmitter {
      * 当屏蔽本地视频后，房间里的其它成员将会收到 onUserVideoAvailable 回调通知
      * @param {Boolean} mute - true：屏蔽；false：开启，默认值：false
      */
-    muteLocalVideo(mute) {
-        this.rtcCloud.muteLocalVideo(mute);
+    muteLocalVideo(mute, streamType) {
+        let newStreamType = streamType;
+        if (newStreamType === undefined) {
+            newStreamType = trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeBig;
+        }
+        this.rtcCloud.muteLocalVideo(newStreamType, mute);
     }
     /**
      * 3.4 开始显示远端视频画面
@@ -1524,9 +1544,14 @@ class TRTCCloud extends events_1.EventEmitter {
      *
      * @param {String}  userId - 对方的用户标识
      * @param {Boolean} mute   - 是否停止接收
+     * @param {TRTCVideoStreamType} streamType   - 视频流类型
      */
-    muteRemoteVideoStream(userId, mute) {
-        this.rtcCloud.muteRemoteVideoStream(userId, mute);
+    muteRemoteVideoStream(userId, mute, streamType) {
+        let newStreamType = streamType;
+        if (newStreamType === undefined) {
+            newStreamType = trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeBig;
+        }
+        this.rtcCloud.muteRemoteVideoStream(userId, newStreamType, mute);
     }
     /**
      * 3.8 停止接收所有远端视频流
@@ -1931,11 +1956,25 @@ class TRTCCloud extends events_1.EventEmitter {
      * 注意：录音文件路径需精确到文件名及格式后缀，格式后缀决定录制文件的格式。
      * 例如：指定路径为 path/to/audio.aac，则会生成一个 AAC 格式的文件。目前支持的格式有 PCM, WAV, AAC
      *
-     * @param {String} path - 录音文件路径（必填），录音文件的保存路径，该路径需要用户自行指定，请确保路径存在且可写。
+     * @param {TRTCAudioRecordingParams} params                            - 录音参数。
+     * @param {String} params.filePath                                     - 文件路径（必填），录音文件的保存路径。该路径需要用户自行指定，请确保路径存在且可写
+     * @param {TRTCAudioRecordingContent} params.recordingContent          - 音频录制内容类型
      * @return {Number} 0：成功；-1：录音已开始；-2：文件或目录创建失败；-3：后缀指定的音频格式不支持
+     *
+     * 注意：
+     *     - 在 9.3 之前的版本，params 为 string 代表 录音文件路径（必填）, 9.3 以及以后同时支持 string 类型和 TRTCAudioRecordingParams。
      */
-    startAudioRecording(path) {
-        return this.rtcCloud.startAudioRecording(path);
+    startAudioRecording(params) {
+        if (params instanceof trtc_define_1.TRTCAudioRecordingParams) {
+            return this.rtcCloud.startAudioRecording(params.filePath, params.recordingContent);
+        }
+        if (typeof params === 'string') {
+            const path = params;
+            const recordParams = new trtc_define_1.TRTCAudioRecordingParams(path);
+            return this.rtcCloud.startAudioRecording(recordParams.filePath, recordParams.recordingContent);
+        }
+        console.error('startAudioRecording, params is not instanceof TRTCAudioRecordingParams!');
+        return -1;
     }
     /**
      * 4.13 停止录音
@@ -2289,6 +2328,11 @@ class TRTCCloud extends events_1.EventEmitter {
      * - 共享整个窗口：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窗口
      * - TRTCScreenCaptureSourceTypeScreen: 该分享目标是整个Windows桌面
@@ -2303,9 +2347,20 @@ 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.sourceId && captureRect instanceof trtc_define_1.Rect && property instanceof trtc_define_1.TRTCScreenCaptureProperty) {
+            const realSource = source;
+            return this.rtcCloud.selectScreenCaptureTarget(realSource.type, realSource.sourceId, realSource.sourceName, realSource.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!');
@@ -2941,14 +2996,31 @@ class TRTCCloud extends events_1.EventEmitter {
      * 测速结果将会用于优化 SDK 接下来的服务器选择策略，因此推荐您在用户首次通话前先进行一次测速，这将有助于我们选择最佳的服务器。
      * 同时，如果测试结果非常不理想，您可以通过醒目的 UI 提示用户选择更好的网络。
      *
-     * 注意：测速本身会消耗一定的流量，所以也会产生少量额外的流量费用。
-     *
-     * @param {Number} sdkAppId - 应用标识
-     * @param {String} userId   - 用户标识
-     * @param {String} userSig  - 用户签名
-     */
-    startSpeedTest(sdkAppId, userId, userSig) {
-        this.rtcCloud.startSpeedTest(sdkAppId, userId, userSig);
+     * 注意：
+     * 1. 测速过程将产生少量的基础服务费用，详见 [计费概述 > 基础服务](https://cloud.tencent.com/document/product/647/17157#.E5.9F.BA.E7.A1.80.E6.9C.8D.E5.8A.A1) 文档说明。
+     * 2. 请在进入房间前进行网速测试，在房间中网速测试会影响正常的音视频传输效果，而且由于干扰过多，网速测试结果也不准确。
+     * 3. 同一时间只允许一项网速测试任务运行。
+     *
+     * @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 时不测试）。
+     *
+     * @return 接口调用结果，< 0：失败
+     */
+    startSpeedTest(params, userId, userSig) {
+        if (params instanceof trtc_define_1.TRTCSpeedTestParams) {
+            return this.rtcCloud.startSpeedTest(params.sdkAppId, params.userId, params.userSig, params.expectedUpBandwidth, params.expectedDownBandwidth);
+        }
+        if (userId !== undefined && userSig !== undefined) {
+            const sdkAppId = params;
+            const speedTestParams = new trtc_define_1.TRTCSpeedTestParams(sdkAppId, userId, userSig);
+            return this.rtcCloud.startSpeedTest(speedTestParams.sdkAppId, speedTestParams.userId, speedTestParams.userSig, speedTestParams.expectedUpBandwidth, speedTestParams.expectedDownBandwidth);
+        }
+        console.error('startSpeedTest, param is error');
+        return -1;
     }
     /**
      * 13.2 停止网络测速

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 - 视频数据结构类型
@@ -357,6 +379,25 @@ export declare class TRTCVolumeInfo {
     volume: number;
     constructor(userId?: string, volume?: number);
 }
+/**
+ * 5.7 测速参数
+ *
+ * 您可以在用户进入房间前通过 [startSpeedTest]{@link TRTCCloud#startSpeedTest} 接口测试网速（注意：请不要在通话中调用）。
+ *
+ * @param {Number}      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);
+}
 /**
  * 5.8 网络测速结果
  *
@@ -438,8 +479,19 @@ export declare enum TRTCTranscodingConfigMode {
     TRTC_TranscodingConfigMode_Template_PresetLayout = 8,
     TRTC_TranscodingConfigMode_Template_ScreenSharing = 9
 }
+export declare enum TRTCMixInputType {
+    TRTCMixInputTypeUndefined = 0,
+    TRTCMixInputTypeAudioVideo = 1,
+    TRTCMixInputTypePureVideo = 2,
+    TRTCMixInputTypePureAudio = 3
+}
+export declare enum TRTCAudioRecordingContent {
+    TRTCAudioRecordingContentAll = 0,
+    TRTCAudioRecordingContentLocal = 1,
+    TRTCAudioRecordingContentRemote = 2
+}
 /**
- * 5.11 云端混流（转码）配置
+ * 5.13 云端混流（转码）配置
  *
  * 包括最终编码质量和各路画面的摆放位置
  *
@@ -496,7 +548,7 @@ export declare class TRTCTranscodingConfig {
     constructor(mode?: TRTCTranscodingConfigMode, appId?: number, bizId?: number, videoWidth?: number, videoHeight?: number, videoBitrate?: number, videoFramerate?: number, videoGOP?: number, backgroundColor?: number, backgroundImage?: string, audioSampleRate?: number, audioBitrate?: number, audioChannels?: number, mixUsersArray?: any[], streamId?: string);
 }
 /**
- * 5.12 CDN 旁路推流参数
+ * 5.14 CDN 旁路推流参数
  *
  * @param {Number} appId - 腾讯云 AppID，请在 [实时音视频控制台](https://console.cloud.tencent.com/rav) 选择已经创建的应用，单击【帐号信息】后，在“直播信息”中获取
  * @param {Number} bizId - 腾讯云直播 bizId，请在 [实时音视频控制台](https://console.cloud.tencent.com/rav) 选择已经创建的应用，单击【帐号信息】后，在“直播信息”中获取
@@ -510,17 +562,19 @@ export declare class TRTCPublishCDNParam {
     constructor(appId?: number, bizId?: number, url?: null | string);
 }
 /**
- * 5.13 录音参数
+ * 5.15 录音参数
  *
  * 请正确填写参数，确保录音文件顺利生成。
  *
- * @param {String} filePath - 【字段含义】文件路径（必填），录音文件的保存路径。该路径需要用户自行指定，请确保路径存在且可写。<br>
- *                            【特别说明】该路径需精确到文件名及格式后缀，格式后缀决定录制文件的格式，例如：指定路径为 path/to/audio.aac，则会生成一个 AAC 格式的文件。目前支持的格式有 PCM, WAV, AAC
- *
+ * @param {String} filePath                            - 【字段含义】文件路径（必填），录音文件的保存路径。该路径需要用户自行指定，请确保路径存在且可写。<br>
+ *                                                       【特别说明】该路径需精确到文件名及格式后缀，格式后缀决定录制文件的格式，例如：指定路径为 path/to/audio.aac，则会生成一个 AAC 格式的文件。目前支持的格式有 PCM, WAV, AAC
+ * @param {TRTCAudioRecordingContent} recordingContent - 【字段含义】音频录制内容类型。
+ *                                                       【特别说明】默认录制所有本地和远端音频。
  */
 export declare class TRTCAudioRecordingParams {
     filePath: null | string;
-    constructor(filePath?: null | string);
+    recordingContent: TRTCAudioRecordingContent;
+    constructor(filePath?: null | string, recordingContent?: TRTCAudioRecordingContent);
 }
 /**
  * 5.14 音效

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.TRTCAudioRecordingContent = exports.TRTCMixInputType = exports.TRTCTranscodingConfigMode = exports.TRTCMixUser = exports.Rect = exports.TRTCSpeedTestResult = exports.TRTCSpeedTestParams = 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 - 视频数据结构类型
@@ -861,6 +885,27 @@ class TRTCVolumeInfo {
 }
 exports.TRTCVolumeInfo = TRTCVolumeInfo;
 ;
+/**
+ * 5.7 测速参数
+ *
+ * 您可以在用户进入房间前通过 [startSpeedTest]{@link TRTCCloud#startSpeedTest} 接口测试网速（注意：请不要在通话中调用）。
+ *
+ * @param {Number}      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;
 /**
  * 5.8 网络测速结果
  *
@@ -999,7 +1044,52 @@ var TRTCTranscodingConfigMode;
 })(TRTCTranscodingConfigMode = exports.TRTCTranscodingConfigMode || (exports.TRTCTranscodingConfigMode = {}));
 ;
 /**
- * 5.11 云端混流（转码）配置
+ * 5.11 混流输入类型
+ *
+ * @enum {Number}
+ *
+ */
+const TRTCMixInputType_HACK_JSDOC = {
+    /** 不指定，SDK 会根据另一个参数 pureAudio 的数值决定混流输入类型 */
+    TRTCMixInputTypeUndefined: 0,
+    /** 混入音频和视频 */
+    TRTCMixInputTypeAudioVideo: 1,
+    /** 只混入视频 */
+    TRTCMixInputTypePureVideo: 2,
+    /** 只混入音频 */
+    TRTCMixInputTypePureAudio: 3
+};
+var TRTCMixInputType;
+(function (TRTCMixInputType) {
+    TRTCMixInputType[TRTCMixInputType["TRTCMixInputTypeUndefined"] = 0] = "TRTCMixInputTypeUndefined";
+    TRTCMixInputType[TRTCMixInputType["TRTCMixInputTypeAudioVideo"] = 1] = "TRTCMixInputTypeAudioVideo";
+    TRTCMixInputType[TRTCMixInputType["TRTCMixInputTypePureVideo"] = 2] = "TRTCMixInputTypePureVideo";
+    TRTCMixInputType[TRTCMixInputType["TRTCMixInputTypePureAudio"] = 3] = "TRTCMixInputTypePureAudio";
+})(TRTCMixInputType = exports.TRTCMixInputType || (exports.TRTCMixInputType = {}));
+/**
+ * 5.12 音频录制内容类型, 9.3 版本开始支持
+ *
+ * 该枚举类型用于音频录制接口 [startAudioRecording]{@link TRTCCloud#startAudioRecording}，用于指定录制音频的内容。
+ *
+ * @enum {Number}
+ *
+ */
+const TRTCAudioRecordingContent_HACK_JSDOC = {
+    /** 录制本地和远端所有音频 */
+    TRTCAudioRecordingContentAll: 0,
+    /** 仅录制本地音频 */
+    TRTCAudioRecordingContentLocal: 1,
+    /** 仅录制远端音频 */
+    TRTCAudioRecordingContentRemote: 2,
+};
+var TRTCAudioRecordingContent;
+(function (TRTCAudioRecordingContent) {
+    TRTCAudioRecordingContent[TRTCAudioRecordingContent["TRTCAudioRecordingContentAll"] = 0] = "TRTCAudioRecordingContentAll";
+    TRTCAudioRecordingContent[TRTCAudioRecordingContent["TRTCAudioRecordingContentLocal"] = 1] = "TRTCAudioRecordingContentLocal";
+    TRTCAudioRecordingContent[TRTCAudioRecordingContent["TRTCAudioRecordingContentRemote"] = 2] = "TRTCAudioRecordingContentRemote";
+})(TRTCAudioRecordingContent = exports.TRTCAudioRecordingContent || (exports.TRTCAudioRecordingContent = {}));
+/**
+ * 5.13 云端混流（转码）配置
  *
  * 包括最终编码质量和各路画面的摆放位置
  *
@@ -1059,7 +1149,7 @@ class TRTCTranscodingConfig {
 exports.TRTCTranscodingConfig = TRTCTranscodingConfig;
 ;
 /**
- * 5.12 CDN 旁路推流参数
+ * 5.14 CDN 旁路推流参数
  *
  * @param {Number} appId - 腾讯云 AppID，请在 [实时音视频控制台](https://console.cloud.tencent.com/rav) 选择已经创建的应用，单击【帐号信息】后，在“直播信息”中获取
  * @param {Number} bizId - 腾讯云直播 bizId，请在 [实时音视频控制台](https://console.cloud.tencent.com/rav) 选择已经创建的应用，单击【帐号信息】后，在“直播信息”中获取
@@ -1076,17 +1166,19 @@ class TRTCPublishCDNParam {
 exports.TRTCPublishCDNParam = TRTCPublishCDNParam;
 ;
 /**
- * 5.13 录音参数
+ * 5.15 录音参数
  *
  * 请正确填写参数，确保录音文件顺利生成。
  *
- * @param {String} filePath - 【字段含义】文件路径（必填），录音文件的保存路径。该路径需要用户自行指定，请确保路径存在且可写。<br>
- *                            【特别说明】该路径需精确到文件名及格式后缀，格式后缀决定录制文件的格式，例如：指定路径为 path/to/audio.aac，则会生成一个 AAC 格式的文件。目前支持的格式有 PCM, WAV, AAC
- *
+ * @param {String} filePath                            - 【字段含义】文件路径（必填），录音文件的保存路径。该路径需要用户自行指定，请确保路径存在且可写。<br>
+ *                                                       【特别说明】该路径需精确到文件名及格式后缀，格式后缀决定录制文件的格式，例如：指定路径为 path/to/audio.aac，则会生成一个 AAC 格式的文件。目前支持的格式有 PCM, WAV, AAC
+ * @param {TRTCAudioRecordingContent} recordingContent - 【字段含义】音频录制内容类型。
+ *                                                       【特别说明】默认录制所有本地和远端音频。
  */
 class TRTCAudioRecordingParams {
-    constructor(filePath = null) {
+    constructor(filePath = null, recordingContent = TRTCAudioRecordingContent.TRTCAudioRecordingContentAll) {
         this.filePath = filePath;
+        this.recordingContent = recordingContent;
     }
 }
 exports.TRTCAudioRecordingParams = TRTCAudioRecordingParams;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "trtc-electron-sdk",
-  "version": "9.6.8-alpha.2",
+  "version": "9.6.8-alpha.5",
   "description": "trtc electron sdk",
   "main": "./liteav/trtc.js",
   "types": "./liteav/trtc.d.ts",