trtc-electron-sdk 11.9.606-beta.9 → 12.0.606

package/README.md

@@ -47,6 +47,12 @@ Properties detail:
 npm install trtc-electron-sdk
 ```
 
+## ⚠️ Notice
+You can build Electron application for Windows and macOS on macOS.
+
+
+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.
+
 ## 👋 Usage
 ```js
 import TRTCCloud from 'trtc-electron-sdk';
@@ -56,6 +62,70 @@ const rtcCloud = TRTCCloud.getTRTCShareInstance();
 const version = rtcCloud.getSDKVersion();
 ```
 
+## 📦 Build
+Taking webpack and electron-builder as example.
+
+```json
+// 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"
+        },
+        ...
+      ]
+    }
+  }
+  
+  ...
+}
+
+```
+
 ## 🔗 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

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, TRTCMusicPlayObserver, TRTCAudioFrameCallback, TRTCAudioProcessPluginOptions } from './trtc_define';
 export * from './trtc_define';
 export * from './trtc_code';
 export * from './vod_player';
@@ -632,12 +632,11 @@ declare class TRTCCloud extends EventEmitter {
      */
     handleOnLocalRecordComplete(errCode: number, storagePath: string): void;
     /**
-     * 系统音频采集回调
+     * 系统音频采集回调，SDK在采集失败时会抛出该事件回调，用于通知错误信息
      *
      * @event TRTCCallback#onSystemAudioLoopbackError
      *
      * @param {Number} errCode - 错误码含义
-     * - 0 ：代表启动成功；
      * - ERR_AUDIO_PLUGIN_START_FAIL(-1330)  ：开启系统声音录制失败，例如音频驱动插件不可用
      * - ERR_AUDIO_PLUGIN_INSTALL_NOT_AUTHORIZED (-1331) ：未授权安装音频驱动插件
      * - ERR_AUDIO_PLUGIN_INSTALL_FAILED (-1332) ：安装音频驱动插件失败
@@ -1027,6 +1026,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;
     /**
@@ -1631,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
      * );
      *
@@ -2427,9 +2427,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;

package/liteav/trtc.js

@@ -1312,12 +1312,11 @@ class TRTCCloud extends events_1.EventEmitter {
     //
     /////////////////////////////////////////////////////////////////////////////////
     /**
-     * 系统音频采集回调
+     * 系统音频采集回调，SDK在采集失败时会抛出该事件回调，用于通知错误信息
      *
      * @event TRTCCallback#onSystemAudioLoopbackError
      *
      * @param {Number} errCode - 错误码含义
-     * - 0 ：代表启动成功；
      * - ERR_AUDIO_PLUGIN_START_FAIL(-1330)  ：开启系统声音录制失败，例如音频驱动插件不可用
      * - ERR_AUDIO_PLUGIN_INSTALL_NOT_AUTHORIZED (-1331) ：未授权安装音频驱动插件
      * - ERR_AUDIO_PLUGIN_INSTALL_FAILED (-1332) ：安装音频驱动插件失败
@@ -2121,6 +2120,7 @@ class TRTCCloud extends events_1.EventEmitter {
      * @param {Number} params.videoFps     - 视频采集帧率
      * @param {Number} params.videoBitrate - 视频上行码率
      * @param {Number} params.minVideoBitrate - 视频最小码率
+     * @param {Boolean} params.enableAdjustRes - 是否允许动态调整分辨率，默认值：关闭。
      */
     setVideoEncoderParam(params) {
         if (params instanceof trtc_define_1.TRTCVideoEncParam) {
@@ -3023,8 +3023,8 @@ class TRTCCloud extends events_1.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
      * );
      *
@@ -4243,7 +4243,7 @@ class TRTCCloud extends events_1.EventEmitter {
      * 调用 [addPlugin]{@link TRTCCloud#addPlugin} 接口添加插件前，需要先调用本接口设置配置参数，否则插件不会启动、运行。
      *
      * @param type {TRTCPluginType} - 插件类型
-     * @param config {TRTCBeautyPluginEnvConfig | TRTCMediaEncryptDecryptPluginOptions} - 插件配置参数
+     * @param config {TRTCVideoProcessPluginOptions | TRTCMediaEncryptDecryptPluginOptions | TRTCAudioProcessPluginOptions} - 插件配置参数
      */
     setPluginParams(type, options) {
         this.logger.log(`setPluginParams params:`, type, options);

package/liteav/trtc_define.d.ts

@@ -174,7 +174,7 @@ export declare class TRTCScreenCaptureSourceInfo {
  * @param {Boolean} enableCaptureMouse    - 是否采集目标内容的同时采集鼠标，默认为 true
  * @param {Boolean} enableHighLight       - 是否高亮正在共享的窗口（在被分享目标周围绘制一个边框），默认为 true。
  * @param {Boolean} enableHighPerformance - 是否开启高性能模式（只会在分享屏幕时会生效），默认为 true。【特殊说明】开启后屏幕采集性能最佳，但会丧失抗遮挡能力，如果您同时开启 enableHighLight + enableHighPerformance，远端用户可以看到高亮的边框。
- * @param {Number} highLightColor         - 指定高亮边框的颜色，RGB 格式，传入 0 时代表采用默认颜色，默认颜色为 #8CBF26。MacOS 平台不支持。
+ * @param {Number} highLightColor         - 指定高亮边框的颜色，RGB 格式，传入 0 时代表采用默认颜色，默认颜色为 0xFFE640。
  * @param {Number} highLightWidth         - 指定高亮边框的宽度，传入0时采用默认描边宽度，默认宽度为 5 像素，您可以设置的最大值为 50。
  * @param {Boolean} enableCaptureChildWindow  - 窗口采集时是否采集子窗口（需要子窗口与被采集窗口具有 Owner 或 Popup 属性），默认为 false。
  */
@@ -364,12 +364,9 @@ export declare class TRTCParams {
  *                                                    【特别说明】<br>
  *                                                     - 当您把分辨率设置的比较高时，minVideoBitrate 不适合设置的太低，否则会出现画面模糊和大范围的马赛克宏块。
  *                                                       比如把分辨率设置为 720p，把码率设置为 200kbps，那么编码出的画面将会出现大范围区域性马赛克。
- * @param {Boolean}                 enableAdjustRes - 【字段含义】是否允许调整分辨率<br>
- *                                                    【推荐取值】 <br>
- *                                                     - 手机直播建议选择 NO。<br>
- *                                                     - 视频通话模式，若更关注流畅性，建议选择 YES，此时若遇到带宽有限的弱网，SDK 会自动降低分辨率以保障更好的流畅度（仅针对 TRTCVideoStreamTypeBig 生效）。
- *                                                     - 默认值：NO。<br>
- *                                                    【特别说明】若有录制需求，选择 YES 时，请确保通话过程中，调整分辨率不会影响您的录制效果。<br>
+ * @param {Boolean}                 enableAdjustRes - 【字段含义】是否允许动态调整分辨率（开启后会对云端录制产生影响）<br>
+ *                                                    【推荐取值】该功能适用于不需要云端录制的场景，开启后 SDK 会根据当前网络情况，智能选择出一个合适的分辨率，避免出现“大分辨率+小码率”的低效编码模式。<br>
+ *                                                    【特别说明】默认值：关闭。如有云端录制的需求，请不要开启此功能，因为如果视频分辨率发生变化后，云端录制出的 MP4 在普通的播放器上无法正常播放。<br>
  */
 export declare class TRTCVideoEncParam {
     videoResolution: TRTCVideoResolution;
@@ -612,22 +609,13 @@ export interface PluginInfo {
     setParameter: (param: string) => number;
 }
 export declare type TRTCPluginInfo = PluginInfo;
-/**
- *  视频处理插件选项
- */
 export declare type TRTCVideoProcessPluginOptions = {
     enable?: boolean;
     pixelFormat?: TRTCVideoPixelFormat;
 };
-/**
- *  音视频加解密插件选项
- */
 export declare type TRTCMediaEncryptDecryptPluginOptions = {
     enable?: boolean;
 };
-/**
- *  音频自定义处理插件选项
- */
 export declare type TRTCAudioProcessPluginOptions = {
     enable?: boolean;
 };

package/liteav/trtc_define.js

@@ -600,7 +600,7 @@ exports.TRTCScreenCaptureSourceInfo = TRTCScreenCaptureSourceInfo;
  * @param {Boolean} enableCaptureMouse    - 是否采集目标内容的同时采集鼠标，默认为 true
  * @param {Boolean} enableHighLight       - 是否高亮正在共享的窗口（在被分享目标周围绘制一个边框），默认为 true。
  * @param {Boolean} enableHighPerformance - 是否开启高性能模式（只会在分享屏幕时会生效），默认为 true。【特殊说明】开启后屏幕采集性能最佳，但会丧失抗遮挡能力，如果您同时开启 enableHighLight + enableHighPerformance，远端用户可以看到高亮的边框。
- * @param {Number} highLightColor         - 指定高亮边框的颜色，RGB 格式，传入 0 时代表采用默认颜色，默认颜色为 #8CBF26。MacOS 平台不支持。
+ * @param {Number} highLightColor         - 指定高亮边框的颜色，RGB 格式，传入 0 时代表采用默认颜色，默认颜色为 0xFFE640。
  * @param {Number} highLightWidth         - 指定高亮边框的宽度，传入0时采用默认描边宽度，默认宽度为 5 像素，您可以设置的最大值为 50。
  * @param {Boolean} enableCaptureChildWindow  - 窗口采集时是否采集子窗口（需要子窗口与被采集窗口具有 Owner 或 Popup 属性），默认为 false。
  */
@@ -909,12 +909,9 @@ exports.TRTCParams = TRTCParams;
  *                                                    【特别说明】<br>
  *                                                     - 当您把分辨率设置的比较高时，minVideoBitrate 不适合设置的太低，否则会出现画面模糊和大范围的马赛克宏块。
  *                                                       比如把分辨率设置为 720p，把码率设置为 200kbps，那么编码出的画面将会出现大范围区域性马赛克。
- * @param {Boolean}                 enableAdjustRes - 【字段含义】是否允许调整分辨率<br>
- *                                                    【推荐取值】 <br>
- *                                                     - 手机直播建议选择 NO。<br>
- *                                                     - 视频通话模式，若更关注流畅性，建议选择 YES，此时若遇到带宽有限的弱网，SDK 会自动降低分辨率以保障更好的流畅度（仅针对 TRTCVideoStreamTypeBig 生效）。
- *                                                     - 默认值：NO。<br>
- *                                                    【特别说明】若有录制需求，选择 YES 时，请确保通话过程中，调整分辨率不会影响您的录制效果。<br>
+ * @param {Boolean}                 enableAdjustRes - 【字段含义】是否允许动态调整分辨率（开启后会对云端录制产生影响）<br>
+ *                                                    【推荐取值】该功能适用于不需要云端录制的场景，开启后 SDK 会根据当前网络情况，智能选择出一个合适的分辨率，避免出现“大分辨率+小码率”的低效编码模式。<br>
+ *                                                    【特别说明】默认值：关闭。如有云端录制的需求，请不要开启此功能，因为如果视频分辨率发生变化后，云端录制出的 MP4 在普通的播放器上无法正常播放。<br>
  */
 class TRTCVideoEncParam {
     constructor(videoResolution = TRTCVideoResolution.TRTCVideoResolution_640_360, resMode = TRTCVideoResolutionMode.TRTCVideoResolutionModeLandscape, videoFps = 15, videoBitrate = 550, minVideoBitrate = 0, enableAdjustRes = false) {
@@ -1317,6 +1314,25 @@ var TRTCPluginType;
  * @property {Function} setParameter - 设置该插件的参数，返回值：0 成功，其他值表示失败，入参必须是序列化的 JSON 串，会透传到 C++ 插件层
  */
 const TRTCPluginInfo_HACK_JSDOC = null;
+/**
+ * 视频处理插件选项
+ * @typedef {Object} TRTCVideoProcessPluginOptions
+ * @property {Boolean} enable - 是否开启
+ * @property {TRTCVideoPixelFormat} pixelFormat - 视频格式
+ */
+const TRTCVideoProcessPluginOptions_HACK_JSDOC = null;
+/**
+ * 音视频加解密插件选项
+ * @typedef {Object} TRTCMediaEncryptDecryptPluginOptions
+ * @property {Boolean} enable - 是否开启
+ */
+const TRTCMediaEncryptDecryptPluginOptions_HACK_JSDOC = null;
+/**
+ * 音频自定义处理插件选项
+ * @typedef {Object} TRTCAudioProcessPluginOptions
+ * @property {Boolean} enable - 是否开启
+ */
+const TRTCAudioProcessPluginOptions_HACK_JSDOC = null;
 /**
  * 云端混流（转码）配置
  *

package/liteav/vod_player.d.ts

@@ -31,7 +31,6 @@ export declare class VodPlayer extends EventEmitter {
     getHeight(): number;
     mute(mute: boolean): void;
     setVolume(volume: number): void;
-    setRate(rate: number): void;
     attachTRTC(): void;
     detachTRTC(): void;
     publishVideo(): void;

package/liteav/vod_player.js

@@ -85,9 +85,6 @@ class VodPlayer extends events_1.EventEmitter {
     setVolume(volume) {
         this.nativeVodPlayer.setVolume(volume);
     }
-    setRate(rate) {
-        this.nativeVodPlayer.setRate(rate);
-    }
     attachTRTC() {
         this.nativeVodPlayer.attachTRTC();
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "trtc-electron-sdk",
-  "version": "11.9.606-beta.9",
+  "version": "12.0.606",
   "description": "trtc electron sdk",
   "main": "./liteav/trtc.js",
   "types": "./liteav/trtc.d.ts",
@@ -63,7 +63,13 @@
     "type": "git",
     "url": "git@git.code.oa.com:TRDCWeb/trtc-electron-sdk.git"
   },
-  "keywords": [],
+  "keywords": [
+    "RTC",
+    "TRTC",
+    "Electron",
+    "Windows",
+    "Mac"
+  ],
   "author": "",
   "license": "ISC",
   "files": [

package/scripts/utils.js

@@ -3,10 +3,7 @@
  */
 const semver = require("semver");
 const pkg = require("../package.json");
-const path = require("path");
-
 const { Platform } = require("./constant");
-const { platform, arch } = require("os");
 
 module.exports.readCliArgv = function () {
   const cliArgv = process.argv;
@@ -49,16 +46,18 @@ module.exports.readArgvFromNpmEnv = function () {
 
 module.exports.readArgvFromPkgJson = function () {
   let INIT_CWD = process.env["INIT_CWD"];
-  let pnpm_PkgJsonDir = INIT_CWD;
-  INIT_CWD = INIT_CWD.split("/");
-  INIT_CWD = INIT_CWD.splice(0, INIT_CWD.length - 2);
-  let PkgJsonDir = INIT_CWD.join("/") + "/package.json";
-  try {
-    require(PkgJsonDir);
-  } catch (error) {
-    pnpm_PkgJsonDir = pnpm_PkgJsonDir.split("/");
-    pnpm_PkgJsonDir = pnpm_PkgJsonDir.splice(0, pnpm_PkgJsonDir.length - 5);
-    PkgJsonDir = pnpm_PkgJsonDir.join("/") + "/package.json";
+  if (!INIT_CWD) return {};
+  let rootDirIndex = 0;
+  let PkgJsonDir = "";
+  if (process.platform === "win32") {
+    INIT_CWD = INIT_CWD.split("\\");
+    rootDirIndex = INIT_CWD.findIndex((item) => item === "node_modules");
+    PkgJsonDir =
+      INIT_CWD.splice(0, rootDirIndex).join("\\\\") + "\\\\package.json";
+  } else {
+    INIT_CWD = INIT_CWD.split("/");
+    rootDirIndex = INIT_CWD.findIndex((item) => item === "node_modules");
+    PkgJsonDir = INIT_CWD.splice(0, rootDirIndex).join("/") + "/package.json";
   }
   const { trtc_electron } = require(PkgJsonDir);
   console.log(
@@ -85,28 +84,26 @@ module.exports.readArgvFromPkgJson = function () {
 };
 
 module.exports.detectConfigArgv = function (configArgv) {
-  const localArch = process.arch;
-  const localPlatform = process.platform;
   if (Object.prototype.toString.call(configArgv) === "[object Object]") {
     const { platform, arch } = configArgv;
     if (platform === "darwin") {
       if (arch !== "x64" && arch !== "arm64") {
-        configArgv.arch = localArch;
+        configArgv.arch = "x64";
       }
     } else if (platform === "win32") {
       if (arch !== "ia32" && arch !== "x64") {
-        configArgv.arch = localArch;
+        configArgv.arch = "x64";
       }
     } else if (platform === "linux") {
       if (arch !== "x64" && arch !== "arm64") {
-        configArgv.arch = localArch;
+        configArgv.arch = "x64";
       }
     }
     return configArgv;
   } else {
     return {
-      platform: localPlatform,
-      arch: localArch,
+      platform: process.arch,
+      arch: process.platform,
     };
   }
 };