trtc-electron-sdk 12.0.605 → 12.1.607

package/README.md

@@ -1,221 +1,134 @@
-# TRTC on Electron
-![](https://main.qcloudimg.com/raw/02bde06f116d6b406324e5ec431f0254.jpg)
-
-## 跑通 DEMO
-<span id="step1"></span>
-### 步骤1：创建新的应用
-1. 登录实时音视频控制台，选择【开发辅助】>【[快速跑通Demo](https://console.cloud.tencent.com/trtc/quickstart)】。
-2. 单击【立即开始】，输入应用名称，例如`TestTRTC`，单击【创建应用】。
-
-<span id="step2"></span>
-### 步骤2：下载 SDK 和 Demo 源码
-1. 鼠标移动至对应卡片，单击【[Github](https://github.com/tencentyun/TRTCSDK/tree/master/Electron)】跳转至 Github（或单击【[ZIP](http://liteavsdk-1252463788.cosgz.myqcloud.com/TXLiteAVSDK_TRTC_Electron_latest.zip)】），下载相关 SDK 及配套的 Demo 源码。
- ![](https://main.qcloudimg.com/raw/6273f79193eb7af25eff64020a0ea476.png)
-2. 下载完成后，返回实时音视频控制台，单击【我已下载，下一步】，可以查看 SDKAppID 和密钥信息。
-
-<span id="step3"></span>
-### 步骤3：配置 Demo 工程文件
-1. 解压 [步骤2](#step2) 中下载的源码包。
-2. 找到并打开 `TRTCSDK/Electron/js/GenerateTestUserSig.js` 文件。
-3. 设置 `GenerateTestUserSig.js` 文件中的相关参数：
-  <ul><li>SDKAPPID：默认为0，请设置为实际的 SDKAppID。</li>
-  <li>SECRETKEY：默认为空字符串，请设置为实际的密钥信息。</li></ul> 
-	<img src="https://main.qcloudimg.com/raw/a82e1c7c3b4edde3b9ac1326b2556147.png"/>
-4. 返回实时音视频控制台，单击【粘贴完成，下一步】。
-5. 单击【关闭指引，进入控制台管理应用】。
-
-<span id="step4"></span>
-### 步骤4：编译运行
-
-#### Windows 平台
-1. 下载最新版本的 [Node.js](https://nodejs.org/en/download/) 安装包，如果您的电脑是64位操作系统，请选择 Windows Installer (.msi) 64-bit，32位操作系统请选择 Windows Installer (.msi) 32-bit。
-![](https://main.qcloudimg.com/raw/5a6d85f58336456028a5984441cff08d.png)
-2. 打开应用程序列表中的 `Node.js command prompt`，启动命令行窗口，并将目录定位到 [步骤3](#step3) 中解压到的目标路径，并运行如下命令：
-```
-npm install
-```
-![](https://main.qcloudimg.com/raw/992dfabdc341cb24c06c129d3318349f.png)
-3. 如果您在中国大陆，可能会遭遇下载 electron 压缩包很慢的问题：
-![](https://main.qcloudimg.com/raw/a849b101e0f1e6e98315e5f88363b9e9.png)
-此时可以通过配置国内的镜像地址，或者从 [Github](https://github.com/electron/electron/releases) 下载对应的版本和 `SHASUMS256.txt` 文件到 `C:\Users\[您的用户名]\AppData\Local\electron\Cache` 目录下，如下图：
-![](https://main.qcloudimg.com/raw/d098a10d2016b7355c12f2a51d0989cd.png)
-4. 待 npm 的依赖包都安装完成后，继续在命令行窗口运行如下命令，即可运行起 Electron Demo。
-```
-npm start
-```
-![](https://main.qcloudimg.com/raw/1a69f78ecff302b4c7af7231ede5c9e1.png)
+# TRTC SDK for Electron
+Tencent Real-Time Communication (TRTC) is a set of low-latency, high-quality real-time communication services provided by Tencent Cloud, which is committed to providing stable, reliable and low-cost audio and video transmission capabilities for Tencent Cloud customers.
 
+## ✨ Features
+- 📺 [Video call](https://www.tencentcloud.com/document/product/647/35428)
+- 🎵 [Audio call](https://www.tencentcloud.com/document/product/647/35428)
+- 🚿 [Interactive video streaming](https://www.tencentcloud.com/document/product/647/35428)
+- 💧 [Interactive audio streaming](https://www.tencentcloud.com/document/product/647/35428)
+- 📼 [On-Cloud Recording](https://www.tencentcloud.com/document/product/647/45169)
+- 📼 [On-Cloud MixTranscoding](https://www.tencentcloud.com/document/product/647/47858#)
+- ⬆️ [Publishing to CSS CDN](https://www.tencentcloud.com/document/product/647/47858#)
 
-#### Mac OS 平台
-1. 打开终端（Terminal）窗口，输入如下命令安装 Homebrew，如果已经安装请跳过此步骤。
-```
-$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-```
-2. 继续键入如下命令，安装 Node.js：
-```
-$ brew install node
-```
-3. 如果您在中国大陆，可能会发现使用 Homebrew 的默认地址安装 Node.js 会比较慢，此时可以考虑替换为国内镜像地址。
-```cmd
-$ cd `brew --repo`
-$ git remote set-url origin https://mirrors.tuna.tsinghua.edu.cn/git/homebrew/brew.git
-$ brew update
-```
-4. 通过 cd 命令定位到 [步骤3](#step3) 中解压到的目标路径，并运行如下命令：
-```
-npm install
-```
-![](https://main.qcloudimg.com/raw/a39debd89aa81d9eeb5ca34ccd32026b.png)
-5. 待 npm 的依赖包都安装完成后，继续在命令行窗口运行如下命令，即可运行起 Electron Demo。
-```
-npm start
-```
-![](https://main.qcloudimg.com/raw/9e9558b0fd1aed0ba39594e4881b4394.png)
-
+## 💻 Environment Support
+- 🍎 Support macOS x64 and arm64（**Electron 11+**）
+- ⚙️ Support Windows ia32 and x64
+- 🌈 Electron: 8.5.0 ~ 24.8.8
 
-## 参考文档
-https://trtc-1252463788.file.myqcloud.com/electron_sdk/docs/index.html
+|    macOS     |   Windows   |    Electron    |
+| :----------: | :---------: | :------------: |
+| x64 \| arm64 | ia32 \| x64 | 8.5.0 ~ 24.8.8 |
 
-## 快速集成
 
-#### step1. 通过npm下载trtc库(确认联网状态)
-```
-npm install trtc-electron-sdk@latest --save-dev
-```
+## ⏬ Install
+By default, it will install the SDK compatible with your device Operation System platform and node.js CPU architecture. If you want to install SDK for specific Operating System or CPU architecture. You can configure the `platform` and `arch` you want in `package.json` or `.npmrc` file as following code. If you configure both, the configuration in `package.json` will work and override that in `.npmrc`.
 
-#### step2. 对接基本功能函数
 ```js
-//1、引入库
-const TRTCCloud = require('trtc-electron-sdk');
-const {
-    TRTCVideoStreamType,
-    TRTCAppScene,
-    TRTCVideoResolution,
-    TRTCVideoResolutionMode,
-    TRTCParams
-} = require('trtc-electron-sdk/liteav/trtc_define');
-
-//2、构建 TRTCCloud
-this.rtcCloud = new TRTCCloud();
-
-//3、注册回调
-subscribeEvents = (rtcCloud) => {
-    rtcCloud.on('onError', (errcode, errmsg) => {
-        console.info('trtc_demo: onError :' + errcode + " msg" + errmsg);
-    }); 
-
-    rtcCloud.on('onEnterRoom', (elapsed) => {
-        console.info('trtc_demo: onEnterRoom elapsed:' + elapsed);
-    });
-    rtcCloud.on('onExitRoom', (reason) => {
-        console.info('trtc_demo: onExitRoom reason:' + reason);
-    });
-
-    // 注册远程视频的可用状态
-    rtcCloud.on('onUserVideoAvailable', (uid, available) => {
-        console.info('trtc_demo: onUserVideoAvailable uid:' + uid + " available:" + available);
-        if (available) {
-            let view = this.findVideoView(uid, TRTCVideoStreamType.TRTCVideoStreamTypeBig);
-            this.rtcCloud.startRemoteView(uid, view);
-        }
-        else {
-            this.rtcCloud.stopRemoteView(uid);
-            this.destroyVideoView(uid, TRTCVideoStreamType.TRTCVideoStreamTypeBig);
-        }
-    });
-
-    //.....
-    //.....
-};
-subscribeEvents(this.rtcCloud);
-
-//4、进入房间
-enterroom () {
-    //1. 进房参数
-    let param = new TRTCParams();
-    param.sdkAppId = sdkInfo.sdkappid;
-    param.roomId = parseInt(this.roomId);
-    param.userSig = userSig;
-    param.userId = this.userId;
-    param.privateMapKey = '';
-    param.businessInfo = '';
-    this.rtcCloud.enterRoom(param, TRTCAppScene.TRTCAppSceneVideoCall);
-    //2. 编码参数
-    let encparam = new TRTCVideoEncParam();
-    encparam.videoResolution = TRTCVideoResolution.TRTCVideoResolution_640_360;
-    encparam.resMode = TRTCVideoResolutionMode.TRTCVideoResolutionModeLandscape;
-    encparam.videoFps = 15;
-    encparam.videoBitrate = 550;
-    this.rtcCloud.setVideoEncoderParam(encparam);
-    //3. 打开采集和预览本地视频、采集音频
-    enableVideoCapture(true);
-    enableAudioCapture(true);
-},
-
-//5、退出房间
-exitroom() {
-    this.rtcCloud.exitRoom();
-},
-
-//6、开启视频
-enableVideoCapture(bEnable) {
-    if (bEnable) {
-        let view = this.findView("local", TRTCVideoStreamType.TRTCVideoStreamTypeBig);
-        this.rtcCloud.startLocalPreview(view);
+// package.json
+{
+    ...
+    "trtc_electron" : {
+        "platform" : "win32",
+        "arch" : "ia32"
     }
-    else {
-        this.rtcCloud.stopLocalPreview();
-    }
-},
+    ...
+}
 
-//7、开启音频
-enableAudioCapture(bEnable) {
-    if (bEnable) {
-        this.rtcCloud.startLocalAudio();
-    }
-    else {
-        this.rtcCloud.stopLocalAudio();
-    }
-},
-
-//8、找个DOM结点，作为视频显示的view
-findVideoView(uid, streamtype) {
-    let key = uid + String(streamtype);
-    var userVideoEl = document.getElementById(key);
-    if (!userVideoEl) {
-    userVideoEl = document.createElement('div');
-    userVideoEl.id = key;
-    userVideoEl.classList.add('video_view');
-    document.querySelector("#video_wrap").appendChild(userVideoEl);
-    }
-    return userVideoEl;
-},
-
-//9、在视频退出时，清掉一个DOM结点
-destroyVideoView(uid, streamtype) {
-    let key = uid + String(streamtype);
-    var userVideoEl = document.getElementById(key);
-    if (userVideoEl) {
-    document.querySelector("#video_wrap").removeChild(userVideoEl);
-    }
-},
+// .npmrc
+trtc_electron_platform=win32
+trtc_electron_arch=ia32        // only support windows
+```
 
+Properties detail:
+- platform: darwin or win32
+- arch:  if not set, it will be `process.arch` of your installation node.js. **Only windows Supported.**
+
+```bash
+npm install trtc-electron-sdk
 ```
 
-## 常见问题
+## ⚠️ Notice
+You can build Electron application for Windows and macOS on macOS.
 
-### 1. 查看密钥时只能获取公钥和私钥信息，要如何获取密钥？
-TRTC SDK 6.6 版本（2019年08月）开始启用新的签名算法 HMAC-SHA256。在此之前已创建的应用，需要先升级签名算法才能获取新的加密密钥。如不升级，您也可以继续使用 [老版本算法 ECDSA-SHA256](https://cloud.tencent.com/document/product/647/17275#.E8.80.81.E7.89.88.E6.9C.AC.E7.AE.97.E6.B3.95)。
 
-升级操作：
- 1. 登录 [实时音视频控制台](https://console.cloud.tencent.com/trtc)。
- 2. 在左侧导航栏选择【应用管理】，单击目标应用所在行的【应用信息】。
- 3. 选择【快速上手】页签，单击【第二步 获取签发UserSig的密钥】区域的【点此升级】。
+On Windows you can only build Electron application for Windows.Can't build Electron application for macOS, for detail:https://www.electron.build/multi-platform-build.
 
-### 2. 两台设备同时运行 Demo，为什么看不到彼此的画面？
-请确保两台设备在运行 Demo 时使用的是不同的 UserID，TRTC 不支持同一个 UserID （除非 SDKAppID 不同）在两个设备同时使用。
+## 👋 Usage
+```js
+import TRTCCloud from 'trtc-electron-sdk';
 
-![](https://main.qcloudimg.com/raw/efa72d87654000eac615b0d9f2cfb6e5.png)
+const rtcCloud = TRTCCloud.getTRTCShareInstance();
+// Obtain the SDK version
+const version = rtcCloud.getSDKVersion();
+```
+
+## 📦 Build
+Taking webpack and electron-builder as example.
+
+```js
+// webpack config
+module.exports = {
+    ...
+    
+    module: {
+      rules: [
+        {
+          test: /\.node$/,
+          loader: "native-ext-loader",
+          options: {
+            emit: true,
+            rewritePath:
+              process.env.NODE_ENV === "production"
+                ? process.platform === "win32"
+                  ? ".\\"
+                  : "../"
+                : "node_modules/trtc-electron-sdk/build/Release",
+          },
+        },
+        ...
+      ],
+    },
+    
+    ...
+}
+
+// electron-builder config
+{
+  ... 
+    
+  "build": {
+    "win": {
+      "extraFiles": [
+        {
+          "from": "node_modules/trtc-electron-sdk/build/Release/",
+          "to": "./"
+        },
+        ...
+      ]
+    },
+    "mac": {
+      "extraFiles": [
+        {
+          "from": "node_modules/trtc-electron-sdk/build/Release/${arch}/trtc_electron_sdk.node",
+          "to": "./"
+        },
+        {
+          "from": "node_modules/trtc-electron-sdk/build/mac-framework/${arch}/",
+          "to": "./Frameworks"
+        },
+        ...
+      ]
+    }
+  }
+  
+  ...
+}
+
+```
 
-### 3. 防火墙有什么限制？
-由于 SDK 使用 UDP 协议进行音视频传输，所以对 UDP 有拦截的办公网络下无法使用，如遇到类似问题，请参考文档：[应对公司防火墙限制](https://cloud.tencent.com/document/product/647/34399)。
+## 🔗 Links
+- [Official Site](https://trtc.io/products/rtc)
+- [API Document](https://web.sdk.qcloud.com/trtc/electron/doc/en-us/trtc_electron_sdk/index.html
+)
+- [Online Demo](https://trtc.io/demo)
+- [Github demo]( https://github.com/Tencent-RTC/TRTC_Electron)

package/liteav/VideoRenderControl/VideoRenderFPSMonitor.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @class RenderFPSMonitor
+ */
+declare class VideoRenderFPSMonitor {
+    private logPrefix;
+    private emitter;
+    private nextAnimationFrame;
+    private lastTimestamp;
+    private refreshCount;
+    private pageRefreshFPS;
+    private lastPageRefreshFPS;
+    private videoRenderFPS;
+    private lastVideoRenderFPS;
+    private statisticDuration;
+    constructor();
+    private initPageRefreshFPSStatistic;
+    private statisticPageRefreshFPS;
+    /**
+     * 规则：
+     * 页面刷新帧率低于 10 时，设置渲染帧率为 5
+     * 页面刷新帧率低于 20 时，设置渲染帧率为 15
+     * 页面刷新帧率低于 30 时，设置渲染帧率为 25
+     * 页面刷新帧率高于 30 时，设置渲染帧率为 -1，负数表示关闭渲染帧率限制
+     * 页面刷新帧率从低于 10 到 30+ 时，持续 2 秒后，设置渲染帧率为 15
+     * 页面刷新帧率从低于 20 到 30+ 时，持续 2 秒后，设置渲染帧率为 25
+     * 页面刷新帧率从低于 30 到 30+ 时，持续 2 秒后，设置渲染帧率为 -1，负数表示关闭渲染帧率限制
+     */
+    private statisticVideoRenderFPS;
+    private onVisibilityChange;
+    private notifyFPS;
+    destroy(): void;
+    on(event: string, listener: (...args: any[]) => void): void;
+    off(event: string, listener: (...args: any[]) => void): void;
+    emit(event: string, ...args: any[]): void;
+}
+export declare const videoRenderFPSMonitor: VideoRenderFPSMonitor;
+export default VideoRenderFPSMonitor;

package/liteav/VideoRenderControl/VideoRenderFPSMonitor.js

@@ -0,0 +1,127 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.videoRenderFPSMonitor = void 0;
+const events_1 = require("events");
+const logger_1 = __importDefault(require("../logger"));
+/**
+ * @class RenderFPSMonitor
+ */
+class VideoRenderFPSMonitor {
+    constructor() {
+        this.logPrefix = '[RenderFPSMonitor]';
+        this.emitter = new events_1.EventEmitter();
+        this.nextAnimationFrame = 0;
+        this.lastTimestamp = 0;
+        this.refreshCount = 0;
+        this.pageRefreshFPS = 0;
+        this.lastPageRefreshFPS = 60;
+        this.videoRenderFPS = 0;
+        this.lastVideoRenderFPS = -1;
+        this.statisticDuration = 2000;
+        this.statisticPageRefreshFPS = this.statisticPageRefreshFPS.bind(this);
+        this.onVisibilityChange = this.onVisibilityChange.bind(this);
+        this.initPageRefreshFPSStatistic();
+        document.addEventListener('visibilitychange', this.onVisibilityChange);
+    }
+    initPageRefreshFPSStatistic() {
+        if (window.requestAnimationFrame) {
+            this.nextAnimationFrame = window.requestAnimationFrame(this.statisticPageRefreshFPS);
+        }
+    }
+    statisticPageRefreshFPS(timestamp) {
+        if (this.lastTimestamp === 0) {
+            this.lastTimestamp = timestamp;
+        }
+        this.refreshCount++;
+        const duration = timestamp - this.lastTimestamp;
+        if (duration >= this.statisticDuration) {
+            this.lastPageRefreshFPS = this.pageRefreshFPS;
+            this.pageRefreshFPS = Math.round(this.refreshCount * 1000 / duration);
+            setTimeout(() => {
+                this.statisticVideoRenderFPS();
+            }, 0);
+            this.lastTimestamp = timestamp;
+            this.refreshCount = 0;
+        }
+        this.nextAnimationFrame = window.requestAnimationFrame(this.statisticPageRefreshFPS);
+    }
+    /**
+     * 规则：
+     * 页面刷新帧率低于 10 时，设置渲染帧率为 5
+     * 页面刷新帧率低于 20 时，设置渲染帧率为 15
+     * 页面刷新帧率低于 30 时，设置渲染帧率为 25
+     * 页面刷新帧率高于 30 时，设置渲染帧率为 -1，负数表示关闭渲染帧率限制
+     * 页面刷新帧率从低于 10 到 30+ 时，持续 2 秒后，设置渲染帧率为 15
+     * 页面刷新帧率从低于 20 到 30+ 时，持续 2 秒后，设置渲染帧率为 25
+     * 页面刷新帧率从低于 30 到 30+ 时，持续 2 秒后，设置渲染帧率为 -1，负数表示关闭渲染帧率限制
+     */
+    statisticVideoRenderFPS() {
+        if (this.pageRefreshFPS <= 10) {
+            this.videoRenderFPS = this.pageRefreshFPS < 5 ? this.pageRefreshFPS : 5;
+        }
+        else if (this.pageRefreshFPS <= 20) {
+            this.videoRenderFPS = this.pageRefreshFPS < 15 ? this.pageRefreshFPS : 15;
+        }
+        else if (this.pageRefreshFPS <= 30) {
+            this.videoRenderFPS = this.pageRefreshFPS < 25 ? this.pageRefreshFPS : 25;
+        }
+        else if (this.pageRefreshFPS > 30 && this.lastPageRefreshFPS <= 10) {
+            this.videoRenderFPS = 15;
+        }
+        else if (this.pageRefreshFPS > 30 && this.lastPageRefreshFPS <= 20) {
+            this.videoRenderFPS = 25;
+        }
+        else {
+            this.videoRenderFPS = -1;
+        }
+        if (this.lastVideoRenderFPS !== this.videoRenderFPS) {
+            this.lastVideoRenderFPS = this.videoRenderFPS;
+            this.notifyFPS();
+        }
+    }
+    onVisibilityChange() {
+        if (document.hidden) {
+            logger_1.default.info(`${this.logPrefix} document hidden`);
+            this.videoRenderFPS = 1;
+            this.pageRefreshFPS = 1;
+        }
+        else {
+            logger_1.default.info(`${this.logPrefix} document show`);
+            this.videoRenderFPS = 5; // 慢启动
+            this.pageRefreshFPS = 5;
+        }
+        this.lastVideoRenderFPS = this.videoRenderFPS;
+        this.lastTimestamp = 0;
+        this.refreshCount = 0;
+        this.notifyFPS();
+    }
+    notifyFPS() {
+        logger_1.default.debug(`${this.logPrefix} pageRefreshFPS:${this.pageRefreshFPS} videoRenderFPS: ${this.videoRenderFPS}`);
+        this.emit('videoRenderFPS', {
+            pageFPS: this.pageRefreshFPS,
+            videoFPS: this.videoRenderFPS,
+        });
+    }
+    destroy() {
+        if (this.nextAnimationFrame) {
+            window.cancelAnimationFrame(this.nextAnimationFrame);
+            this.nextAnimationFrame = 0;
+        }
+        this.emitter.removeAllListeners();
+        document.removeEventListener('visibilitychange', this.onVisibilityChange);
+    }
+    on(event, listener) {
+        this.emitter.on(event, listener);
+    }
+    off(event, listener) {
+        this.emitter.off(event, listener);
+    }
+    emit(event, ...args) {
+        this.emitter.emit(event, ...args);
+    }
+}
+exports.videoRenderFPSMonitor = new VideoRenderFPSMonitor();
+exports.default = VideoRenderFPSMonitor;

package/liteav/trtc.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
 import { TRTCConfig } from './Renderer/util';
-import { AudioMusicParam, Rect, TRTCAppScene, TRTCAudioEffectParam, TRTCAudioQuality, TRTCBeautyStyle, TRTCDeviceState, TRTCDeviceType, TRTCLogLevel, TRTCRenderParams, TRTCRoleType, TRTCSpeedTestResult, TRTCStatistics, TRTCSwitchRoomParam, TRTCVideoBufferType, TRTCVideoFillMode, TRTCAudioFrame, TRTCVideoPixelFormat, TRTCVideoRotation, TRTCVideoStreamType, TRTCVolumeInfo, TRTCWaterMarkSrcType, TRTCQualityInfo, TRTCPluginType, TRTCPluginInfo, TRTCVideoProcessPluginOptions, TRTCMediaEncryptDecryptPluginOptions, TRTCAudioRecordingParams, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureProperty, TRTCSpeedTestParams, TRTCRecordType, TRTCDeviceInfo, TRTCCameraCaptureParams, TRTCImageBuffer, TRTCInitConfig, TRTCAudioParallelParams, TRTCVoiceReverbType, TRTCMusicPlayObserver, TRTCAudioFrameCallback } from './trtc_define';
+import { AudioMusicParam, Rect, TRTCAppScene, TRTCAudioEffectParam, TRTCAudioQuality, TRTCBeautyStyle, TRTCDeviceState, TRTCDeviceType, TRTCLogLevel, TRTCRenderParams, TRTCRoleType, TRTCSpeedTestResult, TRTCStatistics, TRTCSwitchRoomParam, TRTCVideoBufferType, TRTCVideoFillMode, TRTCAudioFrame, TRTCVideoPixelFormat, TRTCVideoRotation, TRTCVideoStreamType, TRTCVolumeInfo, TRTCWaterMarkSrcType, TRTCQualityInfo, TRTCPluginType, TRTCPluginInfo, TRTCVideoProcessPluginOptions, TRTCMediaEncryptDecryptPluginOptions, TRTCAudioRecordingParams, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureProperty, TRTCSpeedTestParams, TRTCRecordType, TRTCDeviceInfo, TRTCCameraCaptureParams, TRTCImageBuffer, TRTCInitConfig, TRTCAudioParallelParams, TRTCVoiceReverbType, TRTCVoiceChangerType, TRTCMusicPlayObserver, TRTCAudioFrameCallback, TRTCAudioProcessPluginOptions } from './trtc_define';
 export * from './trtc_define';
 export * from './trtc_code';
 export * from './vod_player';
@@ -67,6 +67,7 @@ declare class TRTCCloud extends EventEmitter {
      * 注释：会同时销毁所有子实例
      */
     static destroyTRTCShareInstance(): void;
+    private onFPSChanged;
     /**
      * 创建子实例
      *
@@ -1026,6 +1027,7 @@ declare class TRTCCloud extends EventEmitter {
      * @param {Number} params.videoFps     - 视频采集帧率
      * @param {Number} params.videoBitrate - 视频上行码率
      * @param {Number} params.minVideoBitrate - 视频最小码率
+     * @param {Boolean} params.enableAdjustRes - 是否允许动态调整分辨率，默认值：关闭。
      */
     setVideoEncoderParam(params: any): void;
     /**
@@ -1208,7 +1210,6 @@ declare class TRTCCloud extends EventEmitter {
      * 如果录制任务在退出房间前尚未通过本接口停止，则退出房间后录音任务会自动被停止。
      */
     stopLocalRecording(): void;
-    setVideoRenderFPS(fps: number): void;
     /**
      * 开启本地音频的采集和上行
      *
@@ -1630,8 +1631,8 @@ declare class TRTCCloud extends EventEmitter {
      *  true, // enable capture mouse
      *  true, // enable highlight
      *  true, // enable high performance
-     *  0, // default highlight color. On Mac, can only be '0', do not support customizing color.
-     *  0, // default highlight width
+     *  0xFF66FF, // highlight color.
+     *  8, // highlight width
      *  false // disable capture child window
      * );
      *
@@ -2204,16 +2205,59 @@ declare class TRTCCloud extends EventEmitter {
      * @param {Number} volume - 音量大小，100为正常音量，取值范围为0 - 100；默认值：100
      */
     setMusicPublishVolume(id: number, volume: number): void;
+    /**
+     * 开启耳返
+     *
+     * 主播开启耳返后，可以在耳机里听到麦克风采集到的自己发出的声音，该特效适用于主播唱歌的应用场景中。
+     *
+     * 需要您注意的是，由于蓝牙耳机的硬件延迟非常高，所以在主播佩戴蓝牙耳机时无法开启此特效，请尽量在用户界面上提示主播佩戴有线耳机。同时也需要注意，并非所有的手机开启此特效后都能达到优秀的耳返效果，我们已经对部分耳返效果不佳的手机屏蔽了该特效。
+     * @param {Boolean} enable - 是否开启耳返。
+     */
+    enableVoiceEarMonitor(enable: boolean): void;
+    /**
+     * 设置耳返音量
+     *
+     * 通过该接口您可以设置耳返特效中声音的音量大小。
+     *
+     * 如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。
+     * @param {Number} volumn - 音量大小，取值范围为0 - 100，默认值：100。
+     */
+    setVoiceEarMonitorVolume(volumn: number): void;
+    /**
+     * 设置语音音量
+     *
+     * 该接口可以设置语音音量的大小，一般配合音乐音量的设置接口 setAllMusicVolume 协同使用，用于调谐语音和音乐在混音前各自的音量占比。
+     *
+     * 如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。
+     * @param {Number} volume - 音量大小，取值范围为0 - 100，默认值：100。
+     */
+    setVoiceCaptureVolume(volume: number): void;
+    /**
+     * 设置语音音调
+     *
+     * 该接口可以设置语音音调，用于实现变调不变速的目的。
+     * @param {Number} pitch - 音调，取值范围为-1.0f~1.0f，默认值：0.0f。
+     */
+    setVoicePitch(pitch: number): void;
     /**
      * 设置人声的混响效果
      *
-     * 通过该接口您可以设置人声的混响效果，具体特效请参见枚举定义
+     * 通过该接口您可以设置人声的混响效果，具体特效请参见枚举定义。
      *
      * 注意：设置的效果在退出房间后会自动失效，如果下次进房还需要对应特效，需要调用此接口再次进行设置。
      *
-     * @param {TRTCVoiceReverbType} type - 人声的混响效果类型
+     * @param {TRTCVoiceReverbType} type - 人声的混响效果类型。
      */
     setVoiceReverbType(type: TRTCVoiceReverbType): void;
+    /**
+     * 设置人声的变声效果
+     *
+     * 通过该接口您可以设置人声的变声效果，具体特效请参见枚举定义
+     *
+     * 注意：设置的效果在退出房间后会自动失效，如果下次进房还需要对应特效，需要调用此接口再次进行设置
+     * @param {TRTCVoiceChangerType} type - 人声的变声效果类型 。
+     */
+    setVoiceChangerType(type: TRTCVoiceChangerType): void;
     /**
      * 废弃接口： 播放音效
      *
@@ -2384,10 +2428,12 @@ declare class TRTCCloud extends EventEmitter {
     /**
      * 设置日志保存路径
      *
-     * 注意：
-     * - windows 日志文件默认保存在 C:/Users/[系统用户名]/AppData/Roaming/Tencent/liteav/log，即 %appdata%/Tencent/liteav/log 下，如需修改，必须在所有方法前调用。
+     * 通过该接口您可以更改 SDK 本地日志的默认存储路径，SDK 默认的本地日志的存储位置：
+     * - windows 日志文件默认保存在 C:/Users/[系统用户名]/AppData/Roaming/liteav/log，即 %appdata%/liteav/log 下，如需修改，必须在所有方法前调用。
      * - mac 日志文件默认保存在 sandbox Documents/log 下，如需修改，必须在所有方法前调用。
      *
+     * 注意：请务必在所有其他接口之前调用，并且保证您指定的目录是存在的，并且您的应用程序拥有对该目录的读写权限。
+     *
      * @param {String} path - 存储日志的文件夹，例如 "D:\\Log"，UTF-8 编码
      */
     setLogDirPath(path: string): void;
@@ -2426,9 +2472,9 @@ declare class TRTCCloud extends EventEmitter {
      * 调用 [addPlugin]{@link TRTCCloud#addPlugin} 接口添加插件前，需要先调用本接口设置配置参数，否则插件不会启动、运行。
      *
      * @param type {TRTCPluginType} - 插件类型
-     * @param config {TRTCBeautyPluginEnvConfig | TRTCMediaEncryptDecryptPluginOptions} - 插件配置参数
+     * @param config {TRTCVideoProcessPluginOptions | TRTCMediaEncryptDecryptPluginOptions | TRTCAudioProcessPluginOptions} - 插件配置参数
      */
-    setPluginParams(type: TRTCPluginType, options: TRTCVideoProcessPluginOptions | TRTCMediaEncryptDecryptPluginOptions): void;
+    setPluginParams(type: TRTCPluginType, options: TRTCVideoProcessPluginOptions | TRTCMediaEncryptDecryptPluginOptions | TRTCAudioProcessPluginOptions): void;
     private _setVideoProcessPluginParams;
     private _setMediaEncryptDecryptPluginParams;
     private _setAudioProcessPluginParams;
@@ -2465,7 +2511,7 @@ declare class TRTCCloud extends EventEmitter {
      *  - pluginId - 插件ID
      *  - errorCode - 错误码。0、-1、-2、-3、-4、-5 是 SDK 内部定义错误码，其它错误码是插件自定义错误码。
      *     - 0 表示 addPlugin 成功
-     *     - -1 插件库错误
+     *     - -1 插件库加载失败
      *     - -2 插件库缺少插件创建函数
      *     - -3 创建函数执行失败
      *     - -4 插件初始化函数执行失败