trtc-electron-sdk 11.4.502-beta.0 → 11.4.502-beta.2

package/liteav/trtc.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
 import { VodPlayer } from './vod_player';
-import { AudioMusicParam, Rect, TRTCAppScene, TRTCAudioEffectParam, TRTCAudioQuality, TRTCBeautyStyle, TRTCDeviceState, TRTCDeviceType, TRTCLogLevel, TRTCRenderParams, TRTCRoleType, TRTCSwitchRoomParam, TRTCVideoBufferType, TRTCVideoFillMode, TRTCVideoPixelFormat, TRTCVideoRotation, TRTCVideoStreamType, TRTCWaterMarkSrcType, PluginInfo, TRTCAudioRecordingParams, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureProperty, TRTCSpeedTestParams, TRTCRecordType, TRTCDeviceInfo, TRTCCameraCaptureParams, TRTCImageBuffer, TRTCInitConfig, TRTCAudioParallelParams } from './trtc_define';
+import { AudioMusicParam, Rect, TRTCAppScene, TRTCAudioEffectParam, TRTCAudioQuality, TRTCBeautyStyle, TRTCDeviceState, TRTCDeviceType, TRTCLogLevel, TRTCRenderParams, TRTCRoleType, TRTCSwitchRoomParam, TRTCVideoBufferType, TRTCVideoFillMode, TRTCAudioFrame, TRTCVideoPixelFormat, TRTCVideoRotation, TRTCVideoStreamType, TRTCWaterMarkSrcType, PluginInfo, TRTCAudioRecordingParams, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureProperty, TRTCSpeedTestParams, TRTCRecordType, TRTCDeviceInfo, TRTCCameraCaptureParams, TRTCImageBuffer, TRTCInitConfig, TRTCAudioParallelParams } from './trtc_define';
 export * from './trtc_define';
 export * from './trtc_code';
 export * from './vod_player';
@@ -12,7 +12,7 @@ export * from './vod_player';
  * @example
  * // 创建/使用/销毁 TRTCCloud 对象的示例代码：
  * import TRTCCloud from 'trtc-electron-sdk';
- * this.rtcCloud = new TRTCCloud();
+ * this.rtcCloud = TRTCCloud.getTRTCShareInstance();
  * // 获取 SDK 版本号
  * let version = this.rtcCloud.getSDKVersion();
  *
@@ -66,7 +66,7 @@ declare class TRTCCloud extends EventEmitter {
      * @example
      * // Enable 'debug' mode
      * const TRTCCloud = require('trtc-electron-sdk');
-     * const rtcCloud = new TRTCCloud();
+     * const rtcCloud = TRTCCloud.getTRTCShareInstance();
      * rtcCloud.getConfigObject().setDebugMode(true);
      *
      * @returns {TRTCConfig}
@@ -84,7 +84,7 @@ declare class TRTCCloud extends EventEmitter {
      * @example
      * // 创建/使用/销毁 TRTCCloud 对象的示例代码：
      * import TRTCCloud from 'trtc-electron-sdk';
-     * this.rtcCloud = new TRTCCloud();
+     * this.rtcCloud = TRTCCloud.getTRTCShareInstance();
      *
      * // 注册回调的方法，事件关键字详见下方"通用事件回调"
      * subscribeEvents = (rtcCloud) => {
@@ -1618,7 +1618,7 @@ declare class TRTCCloud extends EventEmitter {
      *  TRTCScreenCaptureProperty
      * } from 'trtc-electron-sdk';
      *
-     * const rtcCloud = new TRTCCloud();
+     * const rtcCloud = TRTCCloud.getTRTCShareInstance();
      *
      * const screenAndWindows = rtcCloud.getScreenCaptureSources(320, 180, 32, 32);
      *
@@ -1645,7 +1645,7 @@ declare class TRTCCloud extends EventEmitter {
      * // 示例2: 选择要分享的窗口或屏幕，9.3 及之前版本只能使用此方式
      * import TRTCCloud, { Rect } from 'trtc-electron-sdk';
      *
-     * const rtcCloud = new TRTCCloud();
+     * const rtcCloud = TRTCCloud.getTRTCShareInstance();
      *
      * const screenAndWindows = rtcCloud.getScreenCaptureSources(320, 180, 32, 32);
      *
@@ -1683,7 +1683,7 @@ declare class TRTCCloud extends EventEmitter {
      *  TRTCVideoResolutionMode
      * } from 'trtc-electron-sdk';
      *
-     * const rtcCloud = new TRTCCloud();
+     * const rtcCloud = TRTCCloud.getTRTCShareInstance();
      *
      * const screenAndWindows = rtcCloud.getScreenCaptureSources(320, 180, 32, 32);
      *
@@ -1785,6 +1785,112 @@ declare class TRTCCloud extends EventEmitter {
      * @note 该方法只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeScreen 时生效，即分享屏幕时生效
      */
     removeAllExcludedShareWindow(): void;
+    /**
+     * 将指定窗口加入屏幕分享的包含列表中（该接口仅支持桌面系统）
+     *
+     * @param {String} win - 希望被分享出去的窗口（Windows 平台下为窗口句柄： HWND）
+     * - 该方法只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效，即分享窗口内容时，额外包含指定窗口的功能才生效。
+     * - 您在 startScreenCapture 之前和之后调用均可。
+     * - 通过该方法添加到包含列表中的窗口，会在退出房间后被 SDK 自动清除。
+     */
+    addIncludedShareWindow(win: string): void;
+    /**
+     * 将指定窗口从屏幕分享的包含列表中移除（该接口仅支持桌面系统）
+     *
+     * @param {String} win - 希望被分享出去的窗口（Mac 平台: 窗口 ID；Windows 平台： HWND）
+     * - 该方法只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效，即分享窗口内容时，额外包含指定窗口的功能才生效。
+     */
+    removeIncludedShareWindow(win: string): void;
+    /**
+     * 将全部窗口从屏幕分享的包含列表中移除（该接口仅支持桌面系统）
+     *
+     * @note 该方法只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效，即分享窗口内容时，额外包含指定窗口的功能才生效。
+     */
+    removeAllIncludedShareWindow(): void;
+    /**
+     * 启用音频自定义采集模式
+     *
+     * 开启该模式后，SDK 不在运行原有的音频采集流程，即不再继续从麦克风采集音频数据，而是只保留音频编码和发送能力。
+     * 您需要通过 [sendCustomAudioData]{@link TRTCCloud#sendCustomAudioData} 不断地向 SDK 塞入自己采集的音频数据。
+     *
+     * 注意：
+     *  - 音频自定义采集与 SDK 默认的麦克疯音频采集互斥。因此，调用 `enableCustomAudioCapture(true)` 开启音频自定义采集前，需要先调用 [stopLocalAudio]{@link TRTCCloud#stopLocalAudio} 接口关闭默认的麦克风音频上行，否则不生效；调用 `enableCustomAudioCapture(false)` 关闭自定义采集后，要调用 [startLocalAudio]{@link TRTCCloud#startLocalAudio} 接口才能开启 SDK 默认的麦克风音频采集。
+     *  - 由于回声抵消（AEC）需要严格的控制声音采集和播放的时间，所以开启自定义音频采集后，AEC 能力可能会失效。
+     *
+     * @param {Boolean} enable - 是否启用，默认值：false。
+     */
+    enableCustomAudioCapture(enable: boolean): void;
+    /**
+     * 向 SDK 投送自己采集的音频数据
+     *
+     * 参数 {@link TRTCAudioFrame} 推荐下列填写方式（其他字段不需要填写）：
+     * - audioFormat：音频数据格式，仅支持 TRTCAudioFrameFormatPCM。
+     * - data：音频帧 buffer。音频帧数据只支持 PCM 格式，支持[5ms ~ 100ms]帧长，推荐使用 20ms 帧长，长度计算方法：【48000采样率、单声道的帧长度：48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
+     * - sampleRate：采样率，支持：16000、24000、32000、44100、48000。
+     * - channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
+     * - timestamp：时间戳，单位为毫秒（ms），请使用音频帧在采集时被记录下来的时间戳（可以在采集到一帧音频帧之后，通过调用 [generateCustomPTS]{@link TRTCCloud#generateCustomPTS} 获取时间戳）。
+     *
+     * 注意：请您精准地按每帧时长的间隔调用本接口，数据投送间隔不均匀时极易触发声音卡顿。
+     *
+     * @param {TRTCAudioFrame} frame - 音频数据
+     */
+    sendCustomAudioData(frame: TRTCAudioFrame): void;
+    /**
+     * 启用/关闭自定义音轨
+     *
+     * 开启后，您可以通过本接口向 SDK 混入一条自定义的音轨。通过两个布尔型参数，您可以控制该音轨是否要在远端和本地播放。
+     *
+     * 注意： 如果您指定参数 enablePublish 和 enablePlayout 均为 false，代表完全关闭您的自定义音轨。
+     * @param {Boolean} enablePublish - 控制混入的音轨是否要在远端播放，默认值：false。
+     * @param {Boolean} enablePlayout - 控制混入的音轨是否要在本地播放，默认值：false。
+     *
+     */
+    enableMixExternalAudioFrame(enablePublish: boolean, enablePlayout: boolean): void;
+    /**
+     * 向 SDK 混入自定义音轨
+     *
+     * * 调用该接口之前，您需要先通过 [enableMixExternalAudioFrame]{@link TRTCCloud#enableMixExternalAudioFrame} 开启自定义音轨，之后就可以通过本接口将自己的音轨以 PCM 格式混入到 SDK 中。
+     * 理想情况下，我们期望您的代码能够以非常均匀的速度向 SDK 提供音轨数据。但我们也非常清楚，完美的调用间隔是一个巨大的挑战。
+     * 所以 SDK 内部会开启一个音轨数据的缓冲区，该缓冲区的作用类似一个“蓄水池”，它能够暂存您传入的音轨数据，平抑由于接口调用间隔的抖动问题。
+     * 本接口的返回值代表这个音轨缓冲区的大小，单位是毫秒（ms），比如：如果该接口返回 50，则代表当前的音轨缓冲区有 50ms 的音轨数据。因此只要您在 50ms 内再次调用本接口，SDK 就能保证您混入的音轨数据是连续的。
+     * 当您调用该接口后，如果发现返回值 > 100ms，则可以等待一帧音频帧的播放时间之后再次调用；如果返回值 < 100ms，则代表缓冲区比较小，您可以再次混入一些音轨数据以确保音轨缓冲区的大小维持在“安全水位”以上。
+     * 参数 {@link TRTCAudioFrame} 推荐下列填写方式（其他字段不需要填写）：
+     * - data：音频帧 buffer。音频帧数据只支持 PCM 格式，支持[5ms ~ 100ms]帧长，推荐使用 20ms 帧长，长度计算方法：【48000采样率、单声道的帧长度：48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
+     * - sampleRate：采样率，支持：16000、24000、32000、44100、48000。
+     * - channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
+     * - timestamp：时间戳，单位为毫秒（ms），请使用音频帧在采集时被记录下来的时间戳（可以在获得一帧音频帧之后，通过调用 [generateCustomPTS]{@link TRTCCloud#generateCustomPTS} 获得时间戳）。
+     *
+     * 注意：
+     *  - 混入自定义音轨，需要有上行音频流驱动，支持的上行音频流包括：
+     *    - SDK 默认采集的麦克风音频流，调用 [startLocalAudio]{@link TRTCCloud#startLocalAudio} 接口开启。
+     *    - 开启了自定义音频流，并有自定义音频数据上行，分别调用 [sendCustomAudioData]{@link TRTCCloud#sendCustomAudioData} 和 [sendCustomAudioData]{@link TRTCCloud#sendCustomAudioData} 接口。
+     *    - 开启了背景音乐，调用接口 [startPlayMusic]{@link TRTCCloud#startPlayMusic}。
+     *  - 请您精准地按每帧时长的间隔调用本接口，数据投送间隔不均匀时极易触发声音卡顿。
+     *
+     * @param {TRTCAudioFrame} frame - 音频数据
+     * @returns {Number} - 音频缓冲时长，单位：ms。< 0 错误（-1 未启用 mixExternalAudioFrame）
+     */
+    mixExternalAudioFrame(frame: TRTCAudioFrame): number;
+    /**
+     * 设置推流时混入外部音频的推流音量和播放音量
+     *
+     * @param {Number} publishVolume - 设置的推流音量大小，范围0 - 100，-1表示不改变。
+     * @param {Number} playoutVolume - 设置的播放音量大小，范围0 - 100，-1表示不改变。
+     */
+    setMixExternalAudioVolume(publishVolume: number, playoutVolume: number): void;
+    /**
+     * 生成自定义采集时的时间戳
+     *
+     * 本接口仅适用于自定义采集模式，用于解决音视频帧的采集时间（capture time）和投送时间（send time）不一致所导致的音画不同步问题。
+     * 当您通过 [sendCustomAudioData]{@link TRTCCloud#sendCustomAudioData} 等接口进行自定义视频或音频采集时，请按照如下操作使用该接口：
+     *  1. 首先，在采集到一帧视频或音频帧时，通过调用本接口获得当时的 PTS 时间戳。
+     *  2. 之后可以将该视频或音频帧送入您使用的前处理模块（如第三方美颜组件，或第三方音效组件）。
+     *  3. 在真正调用 [sendCustomAudioData]{@link TRTCCloud#sendCustomAudioData} 进行投送时，请将该帧在采集时记录的 PTS 时间戳赋值给 {@link TRTCVideoFrame} 或 {@link TRTCAudioFrame} 中的 timestamp 字段。
+     *
+     *
+     * @returns {Number} - 时间戳（单位：ms）
+     */
+    generateCustomPTS(): number;
     /**
      * @private
      * 设置本地视频自定义渲染（Electron 平台下不可用）
@@ -1959,7 +2065,7 @@ declare class TRTCCloud extends EventEmitter {
      * @example
      * // 音乐播放
      * import TRTCCloud, { AudioMusicParam } from 'trtc-electron-sdk';
-     * const rtcCloud = new TRTCCloud();
+     * const rtcCloud = TRTCCloud.getTRTCShareInstance();
      *
      * const params = new AudioMusicParam();
      * params.id = 1;

package/liteav/trtc.js

@@ -144,7 +144,7 @@ let oriRtcCloud = null;
  * @example
  * // 创建/使用/销毁 TRTCCloud 对象的示例代码：
  * import TRTCCloud from 'trtc-electron-sdk';
- * this.rtcCloud = new TRTCCloud();
+ * this.rtcCloud = TRTCCloud.getTRTCShareInstance();
  * // 获取 SDK 版本号
  * let version = this.rtcCloud.getSDKVersion();
  *
@@ -225,7 +225,7 @@ class TRTCCloud extends events_1.EventEmitter {
      * @example
      * // Enable 'debug' mode
      * const TRTCCloud = require('trtc-electron-sdk');
-     * const rtcCloud = new TRTCCloud();
+     * const rtcCloud = TRTCCloud.getTRTCShareInstance();
      * rtcCloud.getConfigObject().setDebugMode(true);
      *
      * @returns {TRTCConfig}
@@ -267,7 +267,7 @@ class TRTCCloud extends events_1.EventEmitter {
      * @example
      * // 创建/使用/销毁 TRTCCloud 对象的示例代码：
      * import TRTCCloud from 'trtc-electron-sdk';
-     * this.rtcCloud = new TRTCCloud();
+     * this.rtcCloud = TRTCCloud.getTRTCShareInstance();
      *
      * // 注册回调的方法，事件关键字详见下方"通用事件回调"
      * subscribeEvents = (rtcCloud) => {
@@ -2944,7 +2944,7 @@ class TRTCCloud extends events_1.EventEmitter {
      *  TRTCScreenCaptureProperty
      * } from 'trtc-electron-sdk';
      *
-     * const rtcCloud = new TRTCCloud();
+     * const rtcCloud = TRTCCloud.getTRTCShareInstance();
      *
      * const screenAndWindows = rtcCloud.getScreenCaptureSources(320, 180, 32, 32);
      *
@@ -2971,7 +2971,7 @@ class TRTCCloud extends events_1.EventEmitter {
      * // 示例2: 选择要分享的窗口或屏幕，9.3 及之前版本只能使用此方式
      * import TRTCCloud, { Rect } from 'trtc-electron-sdk';
      *
-     * const rtcCloud = new TRTCCloud();
+     * const rtcCloud = TRTCCloud.getTRTCShareInstance();
      *
      * const screenAndWindows = rtcCloud.getScreenCaptureSources(320, 180, 32, 32);
      *
@@ -3027,7 +3027,7 @@ class TRTCCloud extends events_1.EventEmitter {
      *  TRTCVideoResolutionMode
      * } from 'trtc-electron-sdk';
      *
-     * const rtcCloud = new TRTCCloud();
+     * const rtcCloud = TRTCCloud.getTRTCShareInstance();
      *
      * const screenAndWindows = rtcCloud.getScreenCaptureSources(320, 180, 32, 32);
      *
@@ -3189,16 +3189,143 @@ class TRTCCloud extends events_1.EventEmitter {
     removeAllExcludedShareWindow() {
         this.rtcCloud.removeAllExcludedShareWindow();
     }
+    /**
+     * 将指定窗口加入屏幕分享的包含列表中（该接口仅支持桌面系统）
+     *
+     * @param {String} win - 希望被分享出去的窗口（Windows 平台下为窗口句柄： HWND）
+     * - 该方法只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效，即分享窗口内容时，额外包含指定窗口的功能才生效。
+     * - 您在 startScreenCapture 之前和之后调用均可。
+     * - 通过该方法添加到包含列表中的窗口，会在退出房间后被 SDK 自动清除。
+     */
+    addIncludedShareWindow(win) {
+        if (isNaN(+win)) {
+            console.error('trtc:addIncludedShareWindow, win: ' + win + 'is not invalid!');
+            return;
+        }
+        this.rtcCloud.addIncludedShareWindow(win);
+    }
+    /**
+     * 将指定窗口从屏幕分享的包含列表中移除（该接口仅支持桌面系统）
+     *
+     * @param {String} win - 希望被分享出去的窗口（Mac 平台: 窗口 ID；Windows 平台： HWND）
+     * - 该方法只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效，即分享窗口内容时，额外包含指定窗口的功能才生效。
+     */
+    removeIncludedShareWindow(win) {
+        if (isNaN(+win)) {
+            console.error('trtc:removeIncludedShareWindow, win: ' + win + 'is not invalid!');
+            return;
+        }
+        this.rtcCloud.removeIncludedShareWindow(win);
+    }
+    /**
+     * 将全部窗口从屏幕分享的包含列表中移除（该接口仅支持桌面系统）
+     *
+     * @note 该方法只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效，即分享窗口内容时，额外包含指定窗口的功能才生效。
+     */
+    removeAllIncludedShareWindow() {
+        this.rtcCloud.removeAllIncludedShareWindow();
+    }
     /////////////////////////////////////////////////////////////////////////////////
     //
     //                      （九）自定义采集和渲染
     //
     /////////////////////////////////////////////////////////////////////////////////
-    //TODO:暂时未完成
-    // | [enableCustomVideoCapture] | 启用视频自定义采集模式 |
-    // | [sendCustomVideoData] | 向 SDK 投送自己采集的视频数据 |
-    // | [enableCustomAudioCapture] | 向 SDK 投送自己采集的音频数据 |
-    // | [setAudioFrameCallback] | 设置音频数据回调 |
+    /**
+     * 启用音频自定义采集模式
+     *
+     * 开启该模式后，SDK 不在运行原有的音频采集流程，即不再继续从麦克风采集音频数据，而是只保留音频编码和发送能力。
+     * 您需要通过 [sendCustomAudioData]{@link TRTCCloud#sendCustomAudioData} 不断地向 SDK 塞入自己采集的音频数据。
+     *
+     * 注意：
+     *  - 音频自定义采集与 SDK 默认的麦克疯音频采集互斥。因此，调用 `enableCustomAudioCapture(true)` 开启音频自定义采集前，需要先调用 [stopLocalAudio]{@link TRTCCloud#stopLocalAudio} 接口关闭默认的麦克风音频上行，否则不生效；调用 `enableCustomAudioCapture(false)` 关闭自定义采集后，要调用 [startLocalAudio]{@link TRTCCloud#startLocalAudio} 接口才能开启 SDK 默认的麦克风音频采集。
+     *  - 由于回声抵消（AEC）需要严格的控制声音采集和播放的时间，所以开启自定义音频采集后，AEC 能力可能会失效。
+     *
+     * @param {Boolean} enable - 是否启用，默认值：false。
+     */
+    enableCustomAudioCapture(enable) {
+        this.rtcCloud.enableCustomAudioCapture(enable);
+    }
+    /**
+     * 向 SDK 投送自己采集的音频数据
+     *
+     * 参数 {@link TRTCAudioFrame} 推荐下列填写方式（其他字段不需要填写）：
+     * - audioFormat：音频数据格式，仅支持 TRTCAudioFrameFormatPCM。
+     * - data：音频帧 buffer。音频帧数据只支持 PCM 格式，支持[5ms ~ 100ms]帧长，推荐使用 20ms 帧长，长度计算方法：【48000采样率、单声道的帧长度：48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
+     * - sampleRate：采样率，支持：16000、24000、32000、44100、48000。
+     * - channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
+     * - timestamp：时间戳，单位为毫秒（ms），请使用音频帧在采集时被记录下来的时间戳（可以在采集到一帧音频帧之后，通过调用 [generateCustomPTS]{@link TRTCCloud#generateCustomPTS} 获取时间戳）。
+     *
+     * 注意：请您精准地按每帧时长的间隔调用本接口，数据投送间隔不均匀时极易触发声音卡顿。
+     *
+     * @param {TRTCAudioFrame} frame - 音频数据
+     */
+    sendCustomAudioData(frame) {
+        this.rtcCloud.sendCustomAudioData(frame);
+    }
+    /**
+     * 启用/关闭自定义音轨
+     *
+     * 开启后，您可以通过本接口向 SDK 混入一条自定义的音轨。通过两个布尔型参数，您可以控制该音轨是否要在远端和本地播放。
+     *
+     * 注意： 如果您指定参数 enablePublish 和 enablePlayout 均为 false，代表完全关闭您的自定义音轨。
+     * @param {Boolean} enablePublish - 控制混入的音轨是否要在远端播放，默认值：false。
+     * @param {Boolean} enablePlayout - 控制混入的音轨是否要在本地播放，默认值：false。
+     *
+     */
+    enableMixExternalAudioFrame(enablePublish, enablePlayout) {
+        this.rtcCloud.enableMixExternalAudioFrame(enablePublish, enablePlayout);
+    }
+    /**
+     * 向 SDK 混入自定义音轨
+     *
+     * * 调用该接口之前，您需要先通过 [enableMixExternalAudioFrame]{@link TRTCCloud#enableMixExternalAudioFrame} 开启自定义音轨，之后就可以通过本接口将自己的音轨以 PCM 格式混入到 SDK 中。
+     * 理想情况下，我们期望您的代码能够以非常均匀的速度向 SDK 提供音轨数据。但我们也非常清楚，完美的调用间隔是一个巨大的挑战。
+     * 所以 SDK 内部会开启一个音轨数据的缓冲区，该缓冲区的作用类似一个“蓄水池”，它能够暂存您传入的音轨数据，平抑由于接口调用间隔的抖动问题。
+     * 本接口的返回值代表这个音轨缓冲区的大小，单位是毫秒（ms），比如：如果该接口返回 50，则代表当前的音轨缓冲区有 50ms 的音轨数据。因此只要您在 50ms 内再次调用本接口，SDK 就能保证您混入的音轨数据是连续的。
+     * 当您调用该接口后，如果发现返回值 > 100ms，则可以等待一帧音频帧的播放时间之后再次调用；如果返回值 < 100ms，则代表缓冲区比较小，您可以再次混入一些音轨数据以确保音轨缓冲区的大小维持在“安全水位”以上。
+     * 参数 {@link TRTCAudioFrame} 推荐下列填写方式（其他字段不需要填写）：
+     * - data：音频帧 buffer。音频帧数据只支持 PCM 格式，支持[5ms ~ 100ms]帧长，推荐使用 20ms 帧长，长度计算方法：【48000采样率、单声道的帧长度：48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
+     * - sampleRate：采样率，支持：16000、24000、32000、44100、48000。
+     * - channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
+     * - timestamp：时间戳，单位为毫秒（ms），请使用音频帧在采集时被记录下来的时间戳（可以在获得一帧音频帧之后，通过调用 [generateCustomPTS]{@link TRTCCloud#generateCustomPTS} 获得时间戳）。
+     *
+     * 注意：
+     *  - 混入自定义音轨，需要有上行音频流驱动，支持的上行音频流包括：
+     *    - SDK 默认采集的麦克风音频流，调用 [startLocalAudio]{@link TRTCCloud#startLocalAudio} 接口开启。
+     *    - 开启了自定义音频流，并有自定义音频数据上行，分别调用 [sendCustomAudioData]{@link TRTCCloud#sendCustomAudioData} 和 [sendCustomAudioData]{@link TRTCCloud#sendCustomAudioData} 接口。
+     *    - 开启了背景音乐，调用接口 [startPlayMusic]{@link TRTCCloud#startPlayMusic}。
+     *  - 请您精准地按每帧时长的间隔调用本接口，数据投送间隔不均匀时极易触发声音卡顿。
+     *
+     * @param {TRTCAudioFrame} frame - 音频数据
+     * @returns {Number} - 音频缓冲时长，单位：ms。< 0 错误（-1 未启用 mixExternalAudioFrame）
+     */
+    mixExternalAudioFrame(frame) {
+        return this.rtcCloud.mixExternalAudioFrame(frame);
+    }
+    /**
+     * 设置推流时混入外部音频的推流音量和播放音量
+     *
+     * @param {Number} publishVolume - 设置的推流音量大小，范围0 - 100，-1表示不改变。
+     * @param {Number} playoutVolume - 设置的播放音量大小，范围0 - 100，-1表示不改变。
+     */
+    setMixExternalAudioVolume(publishVolume, playoutVolume) {
+        this.rtcCloud.setMixExternalAudioVolume(publishVolume, playoutVolume);
+    }
+    /**
+     * 生成自定义采集时的时间戳
+     *
+     * 本接口仅适用于自定义采集模式，用于解决音视频帧的采集时间（capture time）和投送时间（send time）不一致所导致的音画不同步问题。
+     * 当您通过 [sendCustomAudioData]{@link TRTCCloud#sendCustomAudioData} 等接口进行自定义视频或音频采集时，请按照如下操作使用该接口：
+     *  1. 首先，在采集到一帧视频或音频帧时，通过调用本接口获得当时的 PTS 时间戳。
+     *  2. 之后可以将该视频或音频帧送入您使用的前处理模块（如第三方美颜组件，或第三方音效组件）。
+     *  3. 在真正调用 [sendCustomAudioData]{@link TRTCCloud#sendCustomAudioData} 进行投送时，请将该帧在采集时记录的 PTS 时间戳赋值给 {@link TRTCVideoFrame} 或 {@link TRTCAudioFrame} 中的 timestamp 字段。
+     *
+     *
+     * @returns {Number} - 时间戳（单位：ms）
+     */
+    generateCustomPTS() {
+        return this.rtcCloud.generateCustomPTS();
+    }
     /**
      * @private
      * 设置本地视频自定义渲染（Electron 平台下不可用）
@@ -3455,7 +3582,7 @@ class TRTCCloud extends events_1.EventEmitter {
      * @example
      * // 音乐播放
      * import TRTCCloud, { AudioMusicParam } from 'trtc-electron-sdk';
-     * const rtcCloud = new TRTCCloud();
+     * const rtcCloud = TRTCCloud.getTRTCShareInstance();
      *
      * const params = new AudioMusicParam();
      * params.id = 1;

package/liteav/trtc_define.d.ts

@@ -232,6 +232,29 @@ export declare class TRTCVideoFrame {
     rotation: number;
     constructor(videoFormat?: TRTCVideoPixelFormat, bufferType?: TRTCVideoBufferType, data?: null | ArrayBuffer, textureId?: number, length?: number, width?: number, height?: number, timestamp?: number, rotation?: number);
 }
+/**
+ * 音频帧数据
+ *
+ * @param {TRTCAudioFrameFormat} audioFormat - 音频帧的格式
+ * @param {ArrayBuffer} data - 音频数据
+ * @param {Number} length - 音频数据的长度
+ * @param {Number} sampleRate - 采样率
+ * @param {Number} channel - 声道数
+ * @param {Number} timestamp - 时间戳，单位ms
+ * @param {ArrayBuffer|null} extraData - 音频额外数据，远端用户通过 `onLocalProcessedAudioFrame` 写入的数据会通过该字段回调
+ * @param {Number} extraDataLength - 音频消息数据的长度
+ */
+export declare class TRTCAudioFrame {
+    audioFormat: TRTCAudioFrameFormat;
+    data: ArrayBuffer | null;
+    length: number;
+    sampleRate: number;
+    channel: number;
+    timestamp: number;
+    extraData: ArrayBuffer | null;
+    extraDataLength: number;
+    constructor(audioFormat?: TRTCAudioFrameFormat, data?: any, length?: number, sampleRate?: number, channel?: number, timestamp?: number, extraData?: any, extraDataLength?: number);
+}
 export declare enum TRTCLogLevel {
     TRTCLogLevelNone = 0,
     TRTCLogLevelVerbose = 1,

package/liteav/trtc_define.js

@@ -6,8 +6,8 @@
  *
  */
 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.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.TRTCCameraCaptureMode = 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.TRTCRecordType = exports.TRTCVideoMirrorType = exports.TRTCVideoBufferType = exports.TRTCVideoPixelFormat = exports.TRTCBeautyStyle = exports.TRTCVideoRotation = exports.TRTCVideoFillMode = exports.TRTCQuality = exports.TRTCVideoStreamType = exports.TRTCVideoResolutionMode = exports.TRTCVideoResolution = void 0;
-exports.VideoBufferInfo = void 0;
+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.TRTCCameraCaptureMode = exports.TRTCDeviceType = exports.TRTCDeviceState = exports.TRTCLogLevel = exports.TRTCAudioFrame = 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.TRTCRecordType = exports.TRTCVideoMirrorType = exports.TRTCVideoBufferType = exports.TRTCVideoPixelFormat = exports.TRTCBeautyStyle = exports.TRTCVideoRotation = exports.TRTCVideoFillMode = exports.TRTCQuality = exports.TRTCVideoStreamType = exports.TRTCVideoResolutionMode = exports.TRTCVideoResolution = void 0;
+exports.VideoBufferInfo = exports.TRTCSwitchRoomParam = void 0;
 const util_1 = require("./Renderer/util");
 /////////////////////////////////////////////////////////////////////////////////
 //
@@ -657,6 +657,32 @@ class TRTCVideoFrame {
 }
 exports.TRTCVideoFrame = TRTCVideoFrame;
 ;
+/**
+ * 音频帧数据
+ *
+ * @param {TRTCAudioFrameFormat} audioFormat - 音频帧的格式
+ * @param {ArrayBuffer} data - 音频数据
+ * @param {Number} length - 音频数据的长度
+ * @param {Number} sampleRate - 采样率
+ * @param {Number} channel - 声道数
+ * @param {Number} timestamp - 时间戳，单位ms
+ * @param {ArrayBuffer|null} extraData - 音频额外数据，远端用户通过 `onLocalProcessedAudioFrame` 写入的数据会通过该字段回调
+ * @param {Number} extraDataLength - 音频消息数据的长度
+ */
+class TRTCAudioFrame {
+    constructor(audioFormat = TRTCAudioFrameFormat.TRTCAudioFrameFormatNone, data = null, length = 0, sampleRate = 48000, channel = 1, timestamp = 0, extraData = null, extraDataLength = 0) {
+        this.audioFormat = audioFormat;
+        this.data = data;
+        this.length = length;
+        this.sampleRate = sampleRate;
+        this.channel = channel;
+        this.timestamp = timestamp;
+        this.extraData = extraData;
+        this.extraDataLength = extraDataLength;
+    }
+}
+exports.TRTCAudioFrame = TRTCAudioFrame;
+;
 /////////////////////////////////////////////////////////////////////////////////
 //
 //                    【（四）更多枚举值定义】

package/package.json

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