trtc-electron-sdk 10.3.8-beta.3 → 10.3.401-beta.2

package/liteav/trtc.d.ts

@@ -54,7 +54,17 @@ declare class TRTCCloud extends EventEmitter {
      */
     static destroyTRTCShareInstance(): void;
     /**
-     * 获取配置对象, 可用来打开 debug 模式
+     * 获取 TRTC 配置对象
+     *
+     * 可以通过 TRTC 配置对象 {@link TRTCConfig} 打开 debug 模式
+     *
+     * @example
+     * // Enable 'debug' mode
+     * const TRTCCloud = require('trtc-electron-sdk');
+     * const rtcCloud = new TRTCCloud();
+     * rtcCloud.getConfigObject().setDebugMode(true);
+     *
+     * @returns {TRTCConfig}
      */
     getConfigObject(): import("./Render/util").Config;
     setExternalRenderEnabled(enabled: boolean): void;
@@ -194,11 +204,11 @@ declare class TRTCCloud extends EventEmitter {
     /**
      * 3.3 用户是否开启摄像头视频
      *
-     * 当您收到 onUserVideoAvailable(userId, YES) 通知时，代表该路画面已经有可用的视频数据帧到达。
+     * 当您收到 onUserVideoAvailable(userId, 1) 通知时，代表该路画面已经有可用的视频数据帧到达。
      * 之后，您需要调用 [startRemoteView()]{@link TRTCCloud#startRemoteView} 接口加载该用户的远程画面。
      * 再之后，您还会收到名为 onFirstVideoFrame(userId) 的首帧画面渲染回调。
      *
-     * 当您收到了 onUserVideoAvailable(userId, NO) 通知时，代表该路远程画面已经被关闭，这可能是
+     * 当您收到了 onUserVideoAvailable(userId, 0) 通知时，代表该路远程画面已经被关闭，这可能是
      * 由于该用户调用了 [muteLocalVideo()]{@link TRTCCloud#muteLocalVideo} 或 [stopLocalPreview()]{@link TRTCCloud#stopLocalPreview} 所致。
      *
      * @event TRTCCallback#onUserVideoAvailable
@@ -209,7 +219,7 @@ declare class TRTCCloud extends EventEmitter {
     /**
      * 3.4 用户是否开启了辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）
      *
-     * 注意：显示辅路画面使用的函数是 [startRemoteSubStreamView()]{@link TRTCCloud#startRemoteSubStreamView} 而非 [startRemoteView()]{@link TRTCCloud#startRemoteView}。
+     * 注意：显示辅路画面使用的函数是[startRemoteView()]{@link TRTCCloud#startRemoteView},  从 8.0 版本开始已不再推荐使用 [startRemoteSubStreamView()]{@link TRTCCloud#startRemoteSubStreamView}。
      *
      * @event TRTCCallback#onUserSubStreamAvailable
      * @param {String}  userId    - 用户标识
@@ -661,7 +671,7 @@ declare class TRTCCloud extends EventEmitter {
      *
      * @param {TRTCSwitchRoomParam} params 房间切换参数，请参考 {@link TRTCSwitchRoomParam}
      *
-     * 接口调用结果会通过 TRTCCloudListener 中的 onSwitchRoom(errCode, errMsg) 回调通知给您。
+     * 接口调用结果会通过 onSwitchRoom(errCode, errMsg) 事件回调通知给您。
      */
     switchRoom(params: TRTCSwitchRoomParam): void;
     /**
@@ -690,13 +700,13 @@ declare class TRTCCloud extends EventEmitter {
      * <pre>
      *                 房间 001                     房间 002
      *               -------------               ------------
-     *  跨房连麦前：| 主播 A      |             | 主播 B     |
+     *  跨房连麦前：  | 主播 A      |             | 主播 B     |
      *              | 观众 U V W  |             | 观众 X Y Z |
      *               -------------               ------------
      *
      *                 房间 001                     房间 002
      *               -------------               ------------
-     *  跨房连麦后：| 主播 A B    |             | 主播 B A   |
+     *  跨房连麦后：  | 主播 A B    |             | 主播 B A   |
      *              | 观众 U V W  |             | 观众 X Y Z |
      *               -------------               ------------
      * </pre>
@@ -809,6 +819,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秒。
      *  - 调用该函数的用户，会将连麦中的多路画面混合到自己当前这路画面中。
@@ -830,7 +842,7 @@ declare class TRTCCloud extends EventEmitter {
      * @param {String} config.streamId          - 输出到 CDN 上的直播流 ID
      * @param {TRTCMixUser[]} config.mixUsersArray - 每一路子画面的位置信息
      * @param {String}  config.mixUsersArray[].userId      - 参与混流的 userId
-     * @param {String}  config.mixUsersArray[].roomId      - 参与混流的 roomId，跨房流传入的实际 roomId，当前房间流传入 roomId = null
+     * @param {String}  config.mixUsersArray[].roomId      - 参与混流的 roomId，跨房流传入的实际 roomId。当前房间流，请传入空字符串（roomId = ''）。
      * @param {Rect}  config.mixUsersArray[].rect        - 图层位置坐标以及大小，左上角为坐标原点(0,0) （绝对像素值）
      * @param {Number}  config.mixUsersArray[].rect.left   - 图层位置的左坐标
      * @param {Number}  config.mixUsersArray[].rect.top    - 图层位置的上坐标
@@ -855,16 +867,23 @@ declare class TRTCCloud extends EventEmitter {
      */
     stopLocalPreview(): void;
     /**
-     * 3.3 是否屏蔽自己的视频画面
+     * 3.3 暂停/恢复发布本地的视频流
      *
-     * 当屏蔽本地视频后，房间里的其它成员将会收到 onUserVideoAvailable 回调通知
-     * @param {Boolean} mute - true：屏蔽；false：开启，默认值：false
+     * 该接口可以暂停（或恢复）发布本地的视频画面，暂停之后，同一房间中的其他用户将无法继续看到自己画面。
+     * 该接口在指定 TRTCVideoStreamTypeBig 时等效于 start/stopLocalPreview 这两个接口，但具有更好的响应速度。
+     * 因为 start/stopLocalPreview 需要打开和关闭摄像头，而打开和关闭摄像头都是硬件设备相关的操作，非常耗时。
+     * 相比之下，muteLocalVideo 只需要在软件层面对数据流进行暂停或者放行即可，因此效率更高，也更适合需要频繁打开关闭的场景。
+     * 当暂停/恢复发布指定 TRTCVideoStreamTypeBig 后，同一房间中的其他用户将会收到 onUserVideoAvailable 回调通知。
+     * 当暂停/恢复发布指定 TRTCVideoStreamTypeSub 后，同一房间中的其他用户将会收到 onUserSubStreamAvailable 回调通知。
+     *
+     * @param {Boolean}             mute        - true：屏蔽；false：开启，默认值：false
+     * @param {TRTCVideoStreamType} streamType  - 要暂停/恢复的视频流类型, 仅支持 TRTCVideoStreamTypeBig 和 TRTCVideoStreamTypeSub
      */
     muteLocalVideo(mute: boolean, streamType?: TRTCVideoStreamType): void;
     /**
      * 3.4 开始显示远端视频画面
      *
-     * 在收到 SDK 的 onUserVideoAvailable(userId, true) 通知时，可以获知该远程用户开启了视频，
+     * 在收到 SDK 的 onUserVideoAvailable(userId, 1) 通知时，可以获知该远程用户开启了视频，
      * 此后调用 startRemoteView(userId) 接口加载该用户的远程画面时，可以用 loading 动画优化加载过程中的等待体验。
      * 待该用户的首帧画面开始显示时，您会收到 onFirstVideoFrame(userId) 事件回调。
      *
@@ -953,7 +972,7 @@ declare class TRTCCloud extends EventEmitter {
      */
     setLocalViewFillMode(mode: TRTCVideoFillMode): void;
     /**
-     * 3.13 设置远端图像的渲染模式
+     * 3.13 设置远端画面的渲染模式
      *
      * @param {String} userId - 用户 ID
      * @param {TRTCVideoStreamType} streamType - 视频流类型
@@ -1116,7 +1135,11 @@ declare class TRTCCloud extends EventEmitter {
      */
     muteRemoteAudio(userId: string, mute: boolean): void;
     /**
-     * 4.5 静音掉所有用户的声音，同时不再拉取该远端用户的音频数据流
+     * 4.5  静音/取消静音所有远端用户的音频流
+     *
+     * 当您静音所有用户的远端音频时，SDK 会停止播放所有来自远端的音频流，同时也会停止拉取所有用户的音频数据。
+     *
+     * 注意：该接口支持您在进入房间（enterRoom）前调用，暂停状态会在退出房间（exitRoom）在之后会被重置。
      *
      * @param {Boolean} mute - true：静音；false：非静音
      */
@@ -1205,11 +1228,18 @@ declare class TRTCCloud extends EventEmitter {
      * - TRTCAudioQualityMusic: 音乐模式：采样率：48k
      */
     setAudioQuality(quality: TRTCAudioQuality): void;
+    /**
+     * 4.15 废弃接口：设置麦克风的音量大小
+     *
+     * @deprecated 从 TRTCSDK6.9 后该接口已被废弃，请使用 setAudioCaptureVolume 接口替代。
+     * @param {Number} volume - 音量大小，100为正常音量，取值范围为0 - 200。
+     */
+    setMicVolumeOnMixing(volume: number): void;
     /**
      * 5.1 获取摄像头设备列表
      *
      * @example
-     * var cameralist = this.rtcCloud.getCameraDevicesList();
+     * var cameralist = rtcCloud.getCameraDevicesList();
      * for (i=0;i<cameralist.length;i++) {
      *    var camera = cameralist[i];
      *    console.info("camera deviceName: " + camera.deviceName + " deviceId:" + camera.deviceId);
@@ -1233,7 +1263,7 @@ declare class TRTCCloud extends EventEmitter {
      * 6.1 获取麦克风设备列表
      *
      * @example
-     *   var miclist = this.rtcCloud.getMicDevicesList();
+     *   var miclist = rtcCloud.getMicDevicesList();
      *   for (i=0;i<miclist.length;i++) {
      *     var mic = miclist[i];
      *     console.info("mic deviceName: " + mic.deviceName + " deviceId:" + mic.deviceId);
@@ -1285,7 +1315,7 @@ declare class TRTCCloud extends EventEmitter {
      * 6.8 获取扬声器设备列表
      *
      * @example
-     *   var speakerlist = this.rtcCloud.getSpeakerDevicesList();
+     *   var speakerlist = rtcCloud.getSpeakerDevicesList();
      *   for (i=0;i<speakerlist.length;i++) {
      *     var speaker = speakerlist[i];
      *     console.info("mic deviceName: " + speaker.deviceName + " deviceId:" + speaker.deviceId);
@@ -1308,10 +1338,6 @@ declare class TRTCCloud extends EventEmitter {
     /**
      * 6.11 获取系统当前扬声器设备音量
      *
-     * 注意：
-     * - SDK6.7 及以下版本，windows 查询的不是系统扬声器的音量大小，mac 是查询系统扬声器音量大小
-     * - SDK6.8 及以上版本，windows 和 mac 查询的都是系统扬声器的音量大小
-     *
      * @return {Number} 扬声器音量，范围0 - 100
      */
     getCurrentSpeakerVolume(): any;
@@ -1319,8 +1345,6 @@ declare class TRTCCloud extends EventEmitter {
      * 6.12 设置系统当前扬声器设备音量
      *
      * 注意：该接口的功能是调节系统播放音量，如果用户直接调节系统设置的播放音量时，该接口的设置结果会被用户的操作所覆盖。
-     * - SDK6.7 及以下版本，windows 设置的不是系统扬声器的音量大小，mac 是设置系统扬声器音量大小
-     * - SDK6.8 及以上版本，windows 和 mac 设置的都是系统扬声器的音量大小
      *
      * @param {Number} volume - 设置的扬声器音量，范围0 - 100
      */
@@ -1426,7 +1450,7 @@ declare class TRTCCloud extends EventEmitter {
      * 8.5 枚举可共享的窗口列表
      *
      * 如果您要给您的 App 增加屏幕分享功能，一般需要先显示一个窗口选择界面，这样用户可以选择希望分享的窗口。
-     * 通过如下函数，您可以获得可分享窗口的 ID、类型、窗口名称以及缩略图。
+     * 通过此函数，您可以获得可分享窗口的 ID、类型、窗口名称以及缩略图。
      * 拿到这些信息后，您就可以实现一个窗口选择界面，当然，您也可以使用我们在 Demo 源码中已经实现好的一个界面。
      *
      * 注意：返回的列表中包括屏幕和应用窗口，屏幕会在列表的前面几个元素中。
@@ -1471,7 +1495,7 @@ declare class TRTCCloud extends EventEmitter {
      */
     selectScreenCaptureTarget(source: TRTCScreenCaptureSourceInfo | number, captureRect: Rect | string, property: TRTCScreenCaptureProperty | string, deprecatedCaptureRect?: Rect, captureMouse?: boolean, highlightWindow?: boolean): any;
     /**
-     * 8.7 启动屏幕分享，支持选择使用主路或辅路进行屏幕分享。（暂不支持 mac 平台预览界面）
+     * 8.7 启动屏幕分享，支持选择使用主路或辅路进行屏幕分享。
      *
      * 注意:
      * 一个用户同时最多只能上传一条主路（TRTCVideoStreamTypeBig）画面和一条辅路（TRTCVideoStreamTypeSub）画面，
@@ -1495,12 +1519,14 @@ declare class TRTCCloud extends EventEmitter {
      */
     stopScreenCapture(): void;
     /**
-     * 8.11 设置辅流（屏幕分享）的编码器参数
+     * 8.11 设置屏幕分享（即辅路）的视频编码参数
      *
-     * - setVideoEncoderParam() 用于设置远端主路画面（TRTCVideoStreamTypeBig，一般用于摄像头）的编码参数。
-     * - setSubStreamEncoderParam() 用于设置远端辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的编码参数。
+     * 该接口可以设定远端用户所看到的屏幕分享（即辅路）的画面质量，同时也能决定云端录制出的视频文件中屏幕分享的画面质量。 请注意如下两个接口的差异：
+     * - setVideoEncoderParam() 用于设置主路画面（TRTCVideoStreamTypeBig，一般用于摄像头）的视频编码参数。
+     * - setSubStreamEncoderParam() 用于设置辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的视频编码参数。
      *
-     * 该设置决定了远端用户看到的画面质量，同时也是云端录制出的视频文件的画面质量。
+     * 注意：
+     * 即使您使用主路传输屏幕分享（在调用 startScreenCapture 时设置 type=TRTCVideoStreamTypeBig），依然要使用 setSubStreamEncoderParam 设定屏幕分享的编码参数，而不要使用 setVideoEncoderParam 。
      *
      * @param {TRTCVideoEncParam} params - 辅流（屏幕分享）编码参数
      * @param {TRTCVideoResolution} params.videoResolution - 视频分辨率
@@ -1773,7 +1799,13 @@ declare class TRTCCloud extends EventEmitter {
      */
     seekMusicToPosInTime(id: number, pts: number): any;
     /**
-     * 11.19 设置背景音乐的音量大小，播放背景音乐混音时使用，用来控制背景音音量大小
+     * 11.19 设置所有背景音乐的本地音量和远端音量的大小
+     *
+     * 该接口可以设置所有背景音乐的本地音量和远端音量。
+     *  - 本地音量：即主播本地可以听到的背景音乐的音量大小。
+     *  - 远端音量：即观众端可以听到的背景音乐的音量大小。
+     *
+     * 注意：如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。
      *
      * @param {Number} volume - 音量大小，100为正常音量，取值范围为0 - 200。
      */
@@ -1886,15 +1918,7 @@ declare class TRTCCloud extends EventEmitter {
      */
     stopSpeedTest(): void;
     /**
-     * 13.3 设置 SDK 使用的音频设备根据跟随系统默认设备
-     *
-     * @param {TRTCDeviceType} deviceType - 设备类型
-     * @param {Boolean} enable - 是否跟随系统默认的音频设备。 true：跟随, 当系统默认音频设备发生改变时，SDK 立即切换音频设备; false：不跟随, 只有当 SDK 使用的音频设备被移除后或插入新的音频设备为系统默认设备时，SDK 才切换至系统默认的音频设备。
-     *
-     */
-    enableFollowingDefaultAudioDevice(deviceType: TRTCDeviceType, enable: boolean): void;
-    /**
-     * 13.4 开始进行摄像头测试
+     * 13.3 开始进行摄像头测试
      *
      * 会触发 onFirstVideoFrame 回调接口
      *
@@ -1904,11 +1928,11 @@ declare class TRTCCloud extends EventEmitter {
      */
     startCameraDeviceTest(view: HTMLElement): void;
     /**
-     * 13.5 停止摄像头测试
+     * 13.4 停止摄像头测试
      */
     stopCameraDeviceTest(): void;
     /**
-     * 13.6 开始进行麦克风测试
+     * 13.5 开始进行麦克风测试
      *
      * 回调接口 onTestMicVolume 获取测试数据
      *
@@ -1918,11 +1942,11 @@ declare class TRTCCloud extends EventEmitter {
      */
     startMicDeviceTest(interval: number): void;
     /**
-     * 13.7 停止麦克风测试
+     * 13.6 停止麦克风测试
      */
     stopMicDeviceTest(): void;
     /**
-     * 13.8 开始进行扬声器测试
+     * 13.7 开始进行扬声器测试
      *
      * 回调接口 onTestSpeakerVolume 获取测试数据
      *
@@ -1932,7 +1956,7 @@ declare class TRTCCloud extends EventEmitter {
      */
     startSpeakerDeviceTest(testAudioFilePath: string): void;
     /**
-     * 13.9 停止扬声器测试
+     * 13.8 停止扬声器测试
      */
     stopSpeakerDeviceTest(): void;
     /**
@@ -1992,13 +2016,6 @@ declare class TRTCCloud extends EventEmitter {
      * @param {String} jsonStr - 接口及参数描述的 JSON 字符串
      */
     callExperimentalAPI(jsonStr: string): void;
-    /**
-     * 从 TRTCSDK6.9 后该接口已被废弃
-     *
-     * @deprecated 从 TRTCSDK6.9 后该接口已被废弃，请使用 setAudioCaptureVolume 接口替代。
-     * @param {Number} volume - 音量大小，100为正常音量，取值范围为0 - 200。
-     */
-    setMicVolumeOnMixing(volume: number): void;
     addLocalVideoRenderCallback(): void;
     addRemoteVideoRenderCallback(userId: string): void;
     /**

package/liteav/trtc.js

@@ -108,6 +108,38 @@ let formatLogParams = function (params) {
     }
     return logParamsStr;
 };
+const getComponentNO = function () {
+    var _a;
+    let componentName = '';
+    // @ts-ignore
+    if (global.__TRTCElectron && global.__TRTCElectron.componentName) {
+        // @ts-ignore
+        componentName = global.__TRTCElectron.componentName;
+    }
+    else {
+        const jsonStr = (_a = global.localStorage) === null || _a === void 0 ? void 0 : _a.getItem('__TRTCElectron');
+        if (jsonStr) {
+            try {
+                const jsonObj = JSON.parse(jsonStr);
+                if (jsonObj.componentName && typeof jsonObj.componentName === 'string') {
+                    componentName = jsonObj.componentName;
+                }
+            }
+            catch (error) {
+                console.warn('trtc: localstorage TRTCElectron parse error.', error);
+            }
+        }
+    }
+    let componentNO = '';
+    switch (componentName) {
+        case 'TUIRoom':
+            componentNO = '5';
+            break;
+        default:
+            break;
+    }
+    return componentNO;
+};
 let trtcCloudInstance = null;
 let oriRtcCloud = null;
 const renderModePixelFormatMap = new Map();
@@ -134,7 +166,8 @@ renderModePixelFormatMap.set(8, trtc_define_1.TRTCVideoPixelFormat.TRTCVideoPixe
 class TRTCCloud extends events_1.EventEmitter {
     constructor() {
         super();
-        oriRtcCloud = new trtc.NodeRTCCloud(pkg.version);
+        const componentNO = getComponentNO();
+        oriRtcCloud = new trtc.NodeRTCCloud(pkg.version, componentNO);
         this.rtcCloud = Object.assign({}, oriRtcCloud, {
             onlineLog: undefined
         });
@@ -193,7 +226,17 @@ class TRTCCloud extends events_1.EventEmitter {
         }
     }
     /**
-     * 获取配置对象, 可用来打开 debug 模式
+     * 获取 TRTC 配置对象
+     *
+     * 可以通过 TRTC 配置对象 {@link TRTCConfig} 打开 debug 模式
+     *
+     * @example
+     * // Enable 'debug' mode
+     * const TRTCCloud = require('trtc-electron-sdk');
+     * const rtcCloud = new TRTCCloud();
+     * rtcCloud.getConfigObject().setDebugMode(true);
+     *
+     * @returns {TRTCConfig}
      */
     getConfigObject() {
         return util_1.config;
@@ -563,11 +606,11 @@ class TRTCCloud extends events_1.EventEmitter {
     /**
      * 3.3 用户是否开启摄像头视频
      *
-     * 当您收到 onUserVideoAvailable(userId, YES) 通知时，代表该路画面已经有可用的视频数据帧到达。
+     * 当您收到 onUserVideoAvailable(userId, 1) 通知时，代表该路画面已经有可用的视频数据帧到达。
      * 之后，您需要调用 [startRemoteView()]{@link TRTCCloud#startRemoteView} 接口加载该用户的远程画面。
      * 再之后，您还会收到名为 onFirstVideoFrame(userId) 的首帧画面渲染回调。
      *
-     * 当您收到了 onUserVideoAvailable(userId, NO) 通知时，代表该路远程画面已经被关闭，这可能是
+     * 当您收到了 onUserVideoAvailable(userId, 0) 通知时，代表该路远程画面已经被关闭，这可能是
      * 由于该用户调用了 [muteLocalVideo()]{@link TRTCCloud#muteLocalVideo} 或 [stopLocalPreview()]{@link TRTCCloud#stopLocalPreview} 所致。
      *
      * @event TRTCCallback#onUserVideoAvailable
@@ -593,7 +636,7 @@ class TRTCCloud extends events_1.EventEmitter {
     /**
      * 3.4 用户是否开启了辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）
      *
-     * 注意：显示辅路画面使用的函数是 [startRemoteSubStreamView()]{@link TRTCCloud#startRemoteSubStreamView} 而非 [startRemoteView()]{@link TRTCCloud#startRemoteView}。
+     * 注意：显示辅路画面使用的函数是[startRemoteView()]{@link TRTCCloud#startRemoteView},  从 8.0 版本开始已不再推荐使用 [startRemoteSubStreamView()]{@link TRTCCloud#startRemoteSubStreamView}。
      *
      * @event TRTCCallback#onUserSubStreamAvailable
      * @param {String}  userId    - 用户标识
@@ -1039,8 +1082,9 @@ class TRTCCloud extends events_1.EventEmitter {
      * @event TRTCCallback#onScreenCaptureStarted
      */
     handleOnScreenCaptureStarted() {
+        console.debug('trtc:onScreenCaptureStarted');
         this.isScreenCapturing = true;
-        // 只有在 Buffer 为 null 时才新建，否则只能在 onVideoSizeChange 事件中重新申请 Buffer
+        // 只有在 Buffer 为 null 时才新建，否则只能在 onVideoSizeChange 事件中重新申请 Buffer         
         if (!screenVideoBuffer.buffer) {
             screenVideoBuffer.userId = '';
             screenVideoBuffer.streamType = this.screenCaptureStreamType;
@@ -1049,6 +1093,7 @@ class TRTCCloud extends events_1.EventEmitter {
             screenVideoBuffer.width = DEFAULT_VIDEO_WIDTH;
             screenVideoBuffer.height = DEFAULT_VIDEO_HEIGHT;
             this.rtcCloud.setSubVideoBuffer('', screenVideoBuffer.buffer, screenVideoBuffer.streamType, screenVideoBuffer.width, screenVideoBuffer.height, screenVideoBuffer.pixelFormat);
+            console.debug('trtc:onScreenCaptureStarted alloc add screenVideoBuffer', screenVideoBuffer);
         }
         this.fire('onScreenCaptureStarted');
     }
@@ -1077,10 +1122,12 @@ class TRTCCloud extends events_1.EventEmitter {
      * @param {Number} reason - 停止原因，0：表示用户主动停止；1：表示屏幕分享窗口被关闭
      */
     handleOnScreenCaptureStopped(reason) {
+        console.debug('trtc:onScreenCaptureStopped', reason);
         if (this.isScreenCapturing) {
             if (screenVideoBuffer.buffer) {
                 this.rtcCloud.setSubVideoBuffer('', screenVideoBuffer.buffer, screenVideoBuffer.streamType, 0, 0, screenVideoBuffer.pixelFormat);
                 screenVideoBuffer.buffer = null;
+                console.debug('trtc:onScreenCaptureStopped delete screenVideoBuffer', screenVideoBuffer);
             }
             this.isScreenCapturing = false;
         }
@@ -1334,7 +1381,7 @@ class TRTCCloud extends events_1.EventEmitter {
      *
      * @param {TRTCSwitchRoomParam} params 房间切换参数，请参考 {@link TRTCSwitchRoomParam}
      *
-     * 接口调用结果会通过 TRTCCloudListener 中的 onSwitchRoom(errCode, errMsg) 回调通知给您。
+     * 接口调用结果会通过 onSwitchRoom(errCode, errMsg) 事件回调通知给您。
      */
     switchRoom(params) {
         this.rtcCloud.switchRoom(params.roomId, params.strRoomId, params.userSig, params.privateMapKey);
@@ -1367,13 +1414,13 @@ class TRTCCloud extends events_1.EventEmitter {
      * <pre>
      *                 房间 001                     房间 002
      *               -------------               ------------
-     *  跨房连麦前：| 主播 A      |             | 主播 B     |
+     *  跨房连麦前：  | 主播 A      |             | 主播 B     |
      *              | 观众 U V W  |             | 观众 X Y Z |
      *               -------------               ------------
      *
      *                 房间 001                     房间 002
      *               -------------               ------------
-     *  跨房连麦后：| 主播 A B    |             | 主播 B A   |
+     *  跨房连麦后：  | 主播 A B    |             | 主播 B A   |
      *              | 观众 U V W  |             | 观众 X Y Z |
      *               -------------               ------------
      * </pre>
@@ -1510,6 +1557,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秒。
      *  - 调用该函数的用户，会将连麦中的多路画面混合到自己当前这路画面中。
@@ -1531,7 +1580,7 @@ class TRTCCloud extends events_1.EventEmitter {
      * @param {String} config.streamId          - 输出到 CDN 上的直播流 ID
      * @param {TRTCMixUser[]} config.mixUsersArray - 每一路子画面的位置信息
      * @param {String}  config.mixUsersArray[].userId      - 参与混流的 userId
-     * @param {String}  config.mixUsersArray[].roomId      - 参与混流的 roomId，跨房流传入的实际 roomId，当前房间流传入 roomId = null
+     * @param {String}  config.mixUsersArray[].roomId      - 参与混流的 roomId，跨房流传入的实际 roomId。当前房间流，请传入空字符串（roomId = ''）。
      * @param {Rect}  config.mixUsersArray[].rect        - 图层位置坐标以及大小，左上角为坐标原点(0,0) （绝对像素值）
      * @param {Number}  config.mixUsersArray[].rect.left   - 图层位置的左坐标
      * @param {Number}  config.mixUsersArray[].rect.top    - 图层位置的上坐标
@@ -1599,7 +1648,7 @@ class TRTCCloud extends events_1.EventEmitter {
                 this._initRender(key, view);
             }
             // view 为 null 时，可能启动了自定义渲染，所以 Buffer 还是要创建，否则自定义渲染就拿不到数据；
-            // view 非 null 时，当然必须创建 Buffer
+            // view 非 null 时，当然必须创建 Buffer 
             // 只有在 Buffer 为 null 时才新建，否则只能在 onVideoSizeChange 事件中重新申请 Buffer
             if (!localVideoBuffer.buffer) {
                 localVideoBuffer.streamType = trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeBig;
@@ -1632,10 +1681,17 @@ class TRTCCloud extends events_1.EventEmitter {
         }
     }
     /**
-     * 3.3 是否屏蔽自己的视频画面
+     * 3.3 暂停/恢复发布本地的视频流
      *
-     * 当屏蔽本地视频后，房间里的其它成员将会收到 onUserVideoAvailable 回调通知
-     * @param {Boolean} mute - true：屏蔽；false：开启，默认值：false
+     * 该接口可以暂停（或恢复）发布本地的视频画面，暂停之后，同一房间中的其他用户将无法继续看到自己画面。
+     * 该接口在指定 TRTCVideoStreamTypeBig 时等效于 start/stopLocalPreview 这两个接口，但具有更好的响应速度。
+     * 因为 start/stopLocalPreview 需要打开和关闭摄像头，而打开和关闭摄像头都是硬件设备相关的操作，非常耗时。
+     * 相比之下，muteLocalVideo 只需要在软件层面对数据流进行暂停或者放行即可，因此效率更高，也更适合需要频繁打开关闭的场景。
+     * 当暂停/恢复发布指定 TRTCVideoStreamTypeBig 后，同一房间中的其他用户将会收到 onUserVideoAvailable 回调通知。
+     * 当暂停/恢复发布指定 TRTCVideoStreamTypeSub 后，同一房间中的其他用户将会收到 onUserSubStreamAvailable 回调通知。
+     *
+     * @param {Boolean}             mute        - true：屏蔽；false：开启，默认值：false
+     * @param {TRTCVideoStreamType} streamType  - 要暂停/恢复的视频流类型, 仅支持 TRTCVideoStreamTypeBig 和 TRTCVideoStreamTypeSub
      */
     muteLocalVideo(mute, streamType) {
         let newStreamType = streamType;
@@ -1647,7 +1703,7 @@ class TRTCCloud extends events_1.EventEmitter {
     /**
      * 3.4 开始显示远端视频画面
      *
-     * 在收到 SDK 的 onUserVideoAvailable(userId, true) 通知时，可以获知该远程用户开启了视频，
+     * 在收到 SDK 的 onUserVideoAvailable(userId, 1) 通知时，可以获知该远程用户开启了视频，
      * 此后调用 startRemoteView(userId) 接口加载该用户的远程画面时，可以用 loading 动画优化加载过程中的等待体验。
      * 待该用户的首帧画面开始显示时，您会收到 onFirstVideoFrame(userId) 事件回调。
      *
@@ -1671,7 +1727,7 @@ class TRTCCloud extends events_1.EventEmitter {
                 this._initRender(key, view);
             }
             // view 为 null 时，可能启动了自定义渲染，所以 Buffer 还是要创建，否则自定义渲染就拿不到数据；
-            // view 非 null 时，当然必须创建 Buffer
+            // view 非 null 时，当然必须创建 Buffer 
             const videoBufferInfo = {
                 userId: userId,
                 buffer: (0, util_1.allocBuffer)(DEFAULT_VIDEO_WIDTH * DEFAULT_VIDEO_HEIGHT * this.pixelLength, userId, streamType),
@@ -1855,7 +1911,7 @@ class TRTCCloud extends events_1.EventEmitter {
         }
     }
     /**
-     * 3.13 设置远端图像的渲染模式
+     * 3.13 设置远端画面的渲染模式
      *
      * @param {String} userId - 用户 ID
      * @param {TRTCVideoStreamType} streamType - 视频流类型
@@ -2097,7 +2153,11 @@ class TRTCCloud extends events_1.EventEmitter {
         this.rtcCloud.muteRemoteAudio(userId, mute);
     }
     /**
-     * 4.5 静音掉所有用户的声音，同时不再拉取该远端用户的音频数据流
+     * 4.5  静音/取消静音所有远端用户的音频流
+     *
+     * 当您静音所有用户的远端音频时，SDK 会停止播放所有来自远端的音频流，同时也会停止拉取所有用户的音频数据。
+     *
+     * 注意：该接口支持您在进入房间（enterRoom）前调用，暂停状态会在退出房间（exitRoom）在之后会被重置。
      *
      * @param {Boolean} mute - true：静音；false：非静音
      */
@@ -2215,6 +2275,15 @@ class TRTCCloud extends events_1.EventEmitter {
     setAudioQuality(quality) {
         this.audioQuality = quality;
     }
+    /**
+     * 4.15 废弃接口：设置麦克风的音量大小
+     *
+     * @deprecated 从 TRTCSDK6.9 后该接口已被废弃，请使用 setAudioCaptureVolume 接口替代。
+     * @param {Number} volume - 音量大小，100为正常音量，取值范围为0 - 200。
+     */
+    setMicVolumeOnMixing(volume) {
+        this.setAudioCaptureVolume(volume);
+    }
     /////////////////////////////////////////////////////////////////////////////////
     //
     //                      （五）摄像头相关接口函数
@@ -2224,7 +2293,7 @@ class TRTCCloud extends events_1.EventEmitter {
      * 5.1 获取摄像头设备列表
      *
      * @example
-     * var cameralist = this.rtcCloud.getCameraDevicesList();
+     * var cameralist = rtcCloud.getCameraDevicesList();
      * for (i=0;i<cameralist.length;i++) {
      *    var camera = cameralist[i];
      *    console.info("camera deviceName: " + camera.deviceName + " deviceId:" + camera.deviceId);
@@ -2259,7 +2328,7 @@ class TRTCCloud extends events_1.EventEmitter {
      * 6.1 获取麦克风设备列表
      *
      * @example
-     *   var miclist = this.rtcCloud.getMicDevicesList();
+     *   var miclist = rtcCloud.getMicDevicesList();
      *   for (i=0;i<miclist.length;i++) {
      *     var mic = miclist[i];
      *     console.info("mic deviceName: " + mic.deviceName + " deviceId:" + mic.deviceId);
@@ -2325,7 +2394,7 @@ class TRTCCloud extends events_1.EventEmitter {
      * 6.8 获取扬声器设备列表
      *
      * @example
-     *   var speakerlist = this.rtcCloud.getSpeakerDevicesList();
+     *   var speakerlist = rtcCloud.getSpeakerDevicesList();
      *   for (i=0;i<speakerlist.length;i++) {
      *     var speaker = speakerlist[i];
      *     console.info("mic deviceName: " + speaker.deviceName + " deviceId:" + speaker.deviceId);
@@ -2354,10 +2423,6 @@ class TRTCCloud extends events_1.EventEmitter {
     /**
      * 6.11 获取系统当前扬声器设备音量
      *
-     * 注意：
-     * - SDK6.7 及以下版本，windows 查询的不是系统扬声器的音量大小，mac 是查询系统扬声器音量大小
-     * - SDK6.8 及以上版本，windows 和 mac 查询的都是系统扬声器的音量大小
-     *
      * @return {Number} 扬声器音量，范围0 - 100
      */
     getCurrentSpeakerVolume() {
@@ -2367,8 +2432,6 @@ class TRTCCloud extends events_1.EventEmitter {
      * 6.12 设置系统当前扬声器设备音量
      *
      * 注意：该接口的功能是调节系统播放音量，如果用户直接调节系统设置的播放音量时，该接口的设置结果会被用户的操作所覆盖。
-     * - SDK6.7 及以下版本，windows 设置的不是系统扬声器的音量大小，mac 是设置系统扬声器音量大小
-     * - SDK6.8 及以上版本，windows 和 mac 设置的都是系统扬声器的音量大小
      *
      * @param {Number} volume - 设置的扬声器音量，范围0 - 100
      */
@@ -2518,7 +2581,7 @@ class TRTCCloud extends events_1.EventEmitter {
      * 8.5 枚举可共享的窗口列表
      *
      * 如果您要给您的 App 增加屏幕分享功能，一般需要先显示一个窗口选择界面，这样用户可以选择希望分享的窗口。
-     * 通过如下函数，您可以获得可分享窗口的 ID、类型、窗口名称以及缩略图。
+     * 通过此函数，您可以获得可分享窗口的 ID、类型、窗口名称以及缩略图。
      * 拿到这些信息后，您就可以实现一个窗口选择界面，当然，您也可以使用我们在 Demo 源码中已经实现好的一个界面。
      *
      * 注意：返回的列表中包括屏幕和应用窗口，屏幕会在列表的前面几个元素中。
@@ -2564,6 +2627,7 @@ class TRTCCloud extends events_1.EventEmitter {
      * @param {Boolean} highlightWindow - 指定是否高亮正在共享的窗口，以及当捕获图像被遮挡时高亮遮挡窗口提示用户移走遮挡
      */
     selectScreenCaptureTarget(source, captureRect, property, deprecatedCaptureRect, captureMouse, highlightWindow) {
+        console.debug('trtc: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);
@@ -2583,7 +2647,7 @@ class TRTCCloud extends events_1.EventEmitter {
         }
     }
     /**
-     * 8.7 启动屏幕分享，支持选择使用主路或辅路进行屏幕分享。（暂不支持 mac 平台预览界面）
+     * 8.7 启动屏幕分享，支持选择使用主路或辅路进行屏幕分享。
      *
      * 注意:
      * 一个用户同时最多只能上传一条主路（TRTCVideoStreamTypeBig）画面和一条辅路（TRTCVideoStreamTypeSub）画面，
@@ -2594,6 +2658,7 @@ class TRTCCloud extends events_1.EventEmitter {
      * @param {TRTCVideoEncParam} params 屏幕分享的画面编码参数，可以设置为 null，表示让 SDK 选择最佳的编码参数（分辨率、码率等）。即使在调用 startScreenCapture 时设置 type=TRTCVideoStreamTypeBig，依然可以使用此接口更新屏幕分享的编码参数。
      */
     startScreenCapture(view = null, type = trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeSub, params = null) {
+        console.debug('trtc:startScreenCapture:', view, type, params);
         if ((type !== trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeSub && type !== trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeBig)) {
             type = trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeSub;
         }
@@ -2601,6 +2666,10 @@ class TRTCCloud extends events_1.EventEmitter {
             console.error('trtc:startScreenCapture, params is not instanceof TRTCVideoEncParam!');
             return;
         }
+        if (this.isScreenCapturing && this.screenCaptureStreamType !== type && screenVideoBuffer.buffer) {
+            // 已经在分享中，切换分享流类型，停止当前正在进行的分享
+            this.stopScreenCapture();
+        }
         this.screenCaptureStreamType = type;
         if (view !== undefined) {
             if (view !== null) {
@@ -2638,12 +2707,14 @@ class TRTCCloud extends events_1.EventEmitter {
         this.screenCaptureStreamType = trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeSub;
     }
     /**
-     * 8.11 设置辅流（屏幕分享）的编码器参数
+     * 8.11 设置屏幕分享（即辅路）的视频编码参数
      *
-     * - setVideoEncoderParam() 用于设置远端主路画面（TRTCVideoStreamTypeBig，一般用于摄像头）的编码参数。
-     * - setSubStreamEncoderParam() 用于设置远端辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的编码参数。
+     * 该接口可以设定远端用户所看到的屏幕分享（即辅路）的画面质量，同时也能决定云端录制出的视频文件中屏幕分享的画面质量。 请注意如下两个接口的差异：
+     * - setVideoEncoderParam() 用于设置主路画面（TRTCVideoStreamTypeBig，一般用于摄像头）的视频编码参数。
+     * - setSubStreamEncoderParam() 用于设置辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的视频编码参数。
      *
-     * 该设置决定了远端用户看到的画面质量，同时也是云端录制出的视频文件的画面质量。
+     * 注意：
+     * 即使您使用主路传输屏幕分享（在调用 startScreenCapture 时设置 type=TRTCVideoStreamTypeBig），依然要使用 setSubStreamEncoderParam 设定屏幕分享的编码参数，而不要使用 setVideoEncoderParam 。
      *
      * @param {TRTCVideoEncParam} params - 辅流（屏幕分享）编码参数
      * @param {TRTCVideoResolution} params.videoResolution - 视频分辨率
@@ -3058,7 +3129,13 @@ class TRTCCloud extends events_1.EventEmitter {
         return this.rtcCloud.seekMusicToPosInTime(id, pts);
     }
     /**
-     * 11.19 设置背景音乐的音量大小，播放背景音乐混音时使用，用来控制背景音音量大小
+     * 11.19 设置所有背景音乐的本地音量和远端音量的大小
+     *
+     * 该接口可以设置所有背景音乐的本地音量和远端音量。
+     *  - 本地音量：即主播本地可以听到的背景音乐的音量大小。
+     *  - 远端音量：即观众端可以听到的背景音乐的音量大小。
+     *
+     * 注意：如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。
      *
      * @param {Number} volume - 音量大小，100为正常音量，取值范围为0 - 200。
      */
@@ -3227,17 +3304,7 @@ class TRTCCloud extends events_1.EventEmitter {
         this.rtcCloud.stopSpeedTest();
     }
     /**
-     * 13.3 设置 SDK 使用的音频设备根据跟随系统默认设备
-     *
-     * @param {TRTCDeviceType} deviceType - 设备类型
-     * @param {Boolean} enable - 是否跟随系统默认的音频设备。 true：跟随, 当系统默认音频设备发生改变时，SDK 立即切换音频设备; false：不跟随, 只有当 SDK 使用的音频设备被移除后或插入新的音频设备为系统默认设备时，SDK 才切换至系统默认的音频设备。
-     *
-     */
-    enableFollowingDefaultAudioDevice(deviceType, enable) {
-        this.rtcCloud.enableFollowingDefaultAudioDevice(deviceType, enable);
-    }
-    /**
-     * 13.4 开始进行摄像头测试
+     * 13.3 开始进行摄像头测试
      *
      * 会触发 onFirstVideoFrame 回调接口
      *
@@ -3274,7 +3341,7 @@ class TRTCCloud extends events_1.EventEmitter {
         }
     }
     /**
-     * 13.5 停止摄像头测试
+     * 13.4 停止摄像头测试
      */
     stopCameraDeviceTest() {
         let key = this.getKey(CAMERA_DEVICE_TEST_VIEW, trtc_define_1.TRTCVideoStreamType.TRTCVideoStreamTypeBig);
@@ -3289,7 +3356,7 @@ class TRTCCloud extends events_1.EventEmitter {
         }
     }
     /**
-     * 13.6 开始进行麦克风测试
+     * 13.5 开始进行麦克风测试
      *
      * 回调接口 onTestMicVolume 获取测试数据
      *
@@ -3301,13 +3368,13 @@ class TRTCCloud extends events_1.EventEmitter {
         this.rtcCloud.startMicDeviceTest(interval);
     }
     /**
-     * 13.7 停止麦克风测试
+     * 13.6 停止麦克风测试
      */
     stopMicDeviceTest() {
         this.rtcCloud.stopMicDeviceTest();
     }
     /**
-     * 13.8 开始进行扬声器测试
+     * 13.7 开始进行扬声器测试
      *
      * 回调接口 onTestSpeakerVolume 获取测试数据
      *
@@ -3320,7 +3387,7 @@ class TRTCCloud extends events_1.EventEmitter {
         this.rtcCloud.startSpeakerDeviceTest(testAudioFilePath);
     }
     /**
-     * 13.9 停止扬声器测试
+     * 13.8 停止扬声器测试
      */
     stopSpeakerDeviceTest() {
         this.rtcCloud.stopSpeakerDeviceTest();
@@ -3409,25 +3476,16 @@ class TRTCCloud extends events_1.EventEmitter {
     //                      （十五） 废弃接口函数
     //
     /////////////////////////////////////////////////////////////////////////////////
-    /**
-     * 从 TRTCSDK6.9 后该接口已被废弃
-     *
-     * @deprecated 从 TRTCSDK6.9 后该接口已被废弃，请使用 setAudioCaptureVolume 接口替代。
-     * @param {Number} volume - 音量大小，100为正常音量，取值范围为0 - 200。
-     */
-    setMicVolumeOnMixing(volume) {
-        this.setAudioCaptureVolume(volume);
-    }
     ///------------------------内部方法-----------------------------
     addLocalVideoRenderCallback() {
-        if ([1, 2, 5].indexOf(this.renderMode) !== -1) {
-            this.pixelformate = trtc_define_1.TRTCVideoPixelFormat.TRTCVideoPixelFormat_I420;
-            this.pixelLength = 1.5;
-        }
-        else if (this.isExternalRenderEnabled || [3, 4, 6].indexOf(this.renderMode) !== -1) {
+        if (this.isExternalRenderEnabled || [3, 4, 6].indexOf(this.renderMode) !== -1) {
             this.pixelformate = trtc_define_1.TRTCVideoPixelFormat.TRTCVideoPixelFormat_RGBA32;
             this.pixelLength = 4;
         }
+        else if ([1, 2, 5].indexOf(this.renderMode) !== -1) {
+            this.pixelformate = trtc_define_1.TRTCVideoPixelFormat.TRTCVideoPixelFormat_I420;
+            this.pixelLength = 1.5;
+        }
         else if ([7, 8].indexOf(this.renderMode) !== -1) {
             this.pixelformate = trtc_define_1.TRTCVideoPixelFormat.TRTCVideoPixelFormat_BGRA32;
             this.pixelLength = 4;
@@ -3446,14 +3504,14 @@ class TRTCCloud extends events_1.EventEmitter {
         }, this.pixelformate);
     }
     addRemoteVideoRenderCallback(userId) {
-        if ([1, 2, 5].indexOf(this.renderMode) !== -1) {
-            this.pixelformate = trtc_define_1.TRTCVideoPixelFormat.TRTCVideoPixelFormat_I420;
-            this.pixelLength = 1.5;
-        }
-        else if (this.isExternalRenderEnabled || [3, 4, 6].indexOf(this.renderMode) !== -1) {
+        if (this.isExternalRenderEnabled || [3, 4, 6].indexOf(this.renderMode) !== -1) {
             this.pixelformate = trtc_define_1.TRTCVideoPixelFormat.TRTCVideoPixelFormat_RGBA32;
             this.pixelLength = 4;
         }
+        else if ([1, 2, 5].indexOf(this.renderMode) !== -1) {
+            this.pixelformate = trtc_define_1.TRTCVideoPixelFormat.TRTCVideoPixelFormat_I420;
+            this.pixelLength = 1.5;
+        }
         else if ([7, 8].indexOf(this.renderMode) !== -1) {
             this.pixelformate = trtc_define_1.TRTCVideoPixelFormat.TRTCVideoPixelFormat_BGRA32;
             this.pixelLength = 4;
@@ -3496,14 +3554,14 @@ class TRTCCloud extends events_1.EventEmitter {
             this.streams.forEach((value, key, map) => {
                 oldStreams.set(key, value);
             });
-            if ([1, 2, 5].indexOf(mode) !== -1) {
-                this.pixelformate = trtc_define_1.TRTCVideoPixelFormat.TRTCVideoPixelFormat_I420;
-                this.pixelLength = 1.5;
-            }
-            else if (this.isExternalRenderEnabled || [3, 4, 6].indexOf(mode) !== -1) {
+            if (this.isExternalRenderEnabled || [3, 4, 6].indexOf(mode) !== -1) {
                 this.pixelformate = trtc_define_1.TRTCVideoPixelFormat.TRTCVideoPixelFormat_RGBA32;
                 this.pixelLength = 4;
             }
+            else if ([1, 2, 5].indexOf(mode) !== -1) {
+                this.pixelformate = trtc_define_1.TRTCVideoPixelFormat.TRTCVideoPixelFormat_I420;
+                this.pixelLength = 1.5;
+            }
             else {
                 // 7,8
                 this.pixelformate = trtc_define_1.TRTCVideoPixelFormat.TRTCVideoPixelFormat_BGRA32;
@@ -3788,7 +3846,7 @@ class TRTCCloud extends events_1.EventEmitter {
             renderer = new Render_1.default.RGBRenderer(); // RGBA32 Canvas 2D
         }
         else if (this.renderMode === 4) {
-            renderer = new Render_1.default.Canvas3DRGBARenderer(); // RGBA canvas 3D
+            renderer = new Render_1.default.Canvas3DRGBARenderer(); // RGBA canvas 3D 
         }
         else if (this.renderMode === 5) {
             renderer = new Render_1.default.I420VideoRenderer(); // I420 video(html)
@@ -3867,7 +3925,7 @@ class TRTCCloud extends events_1.EventEmitter {
             }
             else if (format == trtc_define_1.TRTCVideoPixelFormat.TRTCVideoPixelFormat_BGRA32) {
                 if (this.renderMode !== 3) {
-                    videoframe.data = this._YUV2RGBA(width, height, data);
+                    videoframe.data = this._YUV2RGBA(width, height, data.buffer || data);
                     videoframe.length = width * height * 4;
                     callback(userid, streamType, videoframe);
                 }

package/liteav/trtc_define.d.ts

@@ -590,7 +590,7 @@ export declare class TRTCAudioRecordingParams {
     constructor(filePath?: null | string, recordingContent?: TRTCAudioRecordingContent);
 }
 /**
- * 5.14 音效
+ * 5.16 音效
  *
  * @param {Number} effectId  - 【字段含义】音效 ID<br>
  *                             【特殊说明】SDK 允许播放多路音效，因此需要音效 ID 进行标记，用于控制音效的开始、停止、音量等

package/liteav/trtc_define.js

@@ -257,7 +257,7 @@ const TRTCVideoPixelFormat_HACK_JSDOC = {
     // TRTCVideoPixelFormat_Texture_2D: 2,
     /** BGRA32 */
     TRTCVideoPixelFormat_BGRA32: 3,
-    /** RGBA */
+    // RGBA32
     TRTCVideoPixelFormat_RGBA32: 5,
     TRTCVideoPixelFormat_H264: 6,
 };
@@ -1199,7 +1199,7 @@ class TRTCAudioRecordingParams {
 exports.TRTCAudioRecordingParams = TRTCAudioRecordingParams;
 ;
 /**
- * 5.14 音效
+ * 5.16 音效
  *
  * @param {Number} effectId  - 【字段含义】音效 ID<br>
  *                             【特殊说明】SDK 允许播放多路音效，因此需要音效 ID 进行标记，用于控制音效的开始、停止、音量等

package/package.json

@@ -1,21 +1,21 @@
 {
   "name": "trtc-electron-sdk",
-  "version": "10.3.8-beta.3",
+  "version": "10.3.401-beta.2",
   "description": "trtc electron sdk",
   "main": "./liteav/trtc.js",
   "types": "./liteav/trtc.d.ts",
   "dependencies": {
     "cos-nodejs-sdk-v5": "^2.8.2",
-    "download": "^8.0.0",
     "events": "^3.2.0",
-    "fs-extra": "^9.0.1",
-    "fs-sync": "^1.0.6",
     "lodash.isequal": "^4.5.0",
-    "rimraf": "^3.0.2",
-    "semver": "^6.0.0",
-    "signale": "^1.4.0",
     "yuv-buffer": "^1.0.0",
-    "yuv-canvas": "^1.2.9"
+    "yuv-canvas": "^1.2.6",
+    "download": "^8.0.0",
+    "fs-sync": "^1.0.6",
+    "fs-extra": "^9.0.1",
+    "signale": "^1.4.0",
+    "rimraf": "^3.0.2",
+    "semver": "^6.0.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.11.6",
@@ -42,7 +42,9 @@
     "copy:types": "node ./scripts/copy-types.js",
     "publish_doc": "node ./scripts/publish-doc.js",
     "doc": "npm run doc:clean && npm run doc:build",
-    "doc:build": "jsdoc -c ./jsdoc/jsdoc.json && node ./jsdoc/fix-doc.js",
+    "doc:build": "npm run doc:build-zh && npm run doc:build-en",
+    "doc:build-zh": "./node_modules/.bin/jsdoc -c ./jsdoc/jsdoc_zh.json && node ./jsdoc/fix-doc_zh.js",
+    "doc:build-en": "./node_modules/.bin/jsdoc -c ./jsdoc/jsdoc_en.json && node ./jsdoc/fix-doc_en.js",
     "doc:clean": "node ./jsdoc/clean-doc.js",
     "prerelease": "npm run build && npm run doc && node ./scripts/prerelase.js",
     "publish_npm": "node scripts/publish-npm.js"

package/scripts/download.js

@@ -11,7 +11,6 @@ const {
     detectOwnVersion,
     detectOwnName,
 } = require('./utils');
-const { Platform } = require('./constant');
 
 const buildDownloadInfo = () => {
     const configArgv = Object.assign({}, readCliArgv(), readArgvFromNpmEnv());
@@ -34,7 +33,6 @@ const buildDownloadInfo = () => {
     };
 };
 
-let downloadFrameworkSuccessCount = 0;
 const main = () => {
     const {
         packageVersion,
@@ -71,12 +69,6 @@ const main = () => {
                 .then(() => {
                     console.log('copy success!');
                     rimraf.sync(outputDir);
-                    if (platform === Platform.MACOS) {
-                        const txFFmpegUrl = 'https://web.sdk.qcloud.com/trtc/electron/download/trtc-electron-sdk/mac-framework/TXFFmpeg.framework.zip';
-                        const txSoundTouchUrl = 'https://web.sdk.qcloud.com/trtc/electron/download/trtc-electron-sdk/mac-framework/TXSoundTouch.framework.zip';
-                        downloadFramework(txFFmpegUrl, outputDir, buildDir);
-                        downloadFramework(txSoundTouchUrl, outputDir, buildDir);
-                    }
                 })
                 .catch(err => console.error(err));
         }).catch(err => {
@@ -85,23 +77,4 @@ const main = () => {
     });
 };
 
-const downloadFramework = (url, outputDir, buildDir) => {
-    download(url, outputDir, {
-        strip: 0,
-        extract: true
-    }).then(() => {
-        signale.success('Success', 'Download framework finished');
-        downloadFrameworkSuccessCount++;
-        rimraf.sync(path.join(outputDir, '__MACOSX'));
-        const frameworkPath = path.join(buildDir, 'mac-framework');
-        fs.mkdirpSync(frameworkPath);
-        if (downloadFrameworkSuccessCount === 2) {
-            fs.copySync(path.join(outputDir), frameworkPath);
-            rimraf.sync(outputDir);
-        }
-    }).catch(err => {
-        signale.fatal('Failed', err);
-    });
-};
-
 main();

package/scripts/prerelase.js

@@ -1,5 +1,16 @@
 const path = require('path');
 const {copy, remove} = require('fs-sync');
+const fs = require('fs');
+
+const liteavPath = path.join(__dirname, '../liteav');
+const liteavFiles = fs.readdirSync(liteavPath, {withFileTypes: true});
+liteavFiles.forEach(file => {
+  if (file.isFile() && file.name.indexOf('_en.') !== -1) {
+    const filePath = path.join(liteavPath, file.name);
+    console.log(`Remove en files not to be published: `, filePath);
+    remove(filePath);
+  }
+});
 
 remove('./npm');
 copy(path.resolve('./liteav'), path.resolve('./npm/liteav'));

package/scripts/publish-doc.js

@@ -34,7 +34,7 @@ const cos = new COS({
 
 const bucket = 'sdk-web-1252463788';
 const region = 'ap-hongkong';
-const keyPrefix = 'trtc/electron/doc/zh-cn/trtc_electron_sdk/';
+const keyPrefix = 'trtc/electron/doc/';
 const docPath = path.join(__dirname, '../_doc');
 
 function walkSync(dir, filelist) {