trtc-electron-sdk 11.6.601-alpha.0 → 11.6.601

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, PluginInfo, TRTCAudioRecordingParams, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureProperty, TRTCSpeedTestParams, TRTCRecordType, TRTCDeviceInfo, TRTCCameraCaptureParams, TRTCImageBuffer, TRTCInitConfig, TRTCAudioParallelParams, TRTCVoiceReverbType } 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, PluginInfo, TRTCAudioRecordingParams, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureProperty, TRTCSpeedTestParams, TRTCRecordType, TRTCDeviceInfo, TRTCCameraCaptureParams, TRTCImageBuffer, TRTCInitConfig, TRTCAudioParallelParams, TRTCVoiceReverbType, TRTCMusicPlayObserver } from './trtc_define';
 export * from './trtc_define';
 export * from './trtc_code';
 export * from './vod_player';
@@ -600,34 +600,6 @@ declare class TRTCCloud extends EventEmitter {
      * @param {Number} height - 截图画面的高度
      */
     handleOnSnapshotComplete(userId: string, type: TRTCVideoStreamType, buffer: ArrayBuffer, width: number, height: number): void;
-    /**
-     * 废弃事件： 开始播放背景音乐
-     *
-     * @deprecated 从 TRTCSDK 8.0 后该接口已被废弃，不推荐使用
-     *
-     * @event TRTCCallback#onPlayBGMBegin
-     * @param {Number} errCode - 错误码
-     */
-    handleOnPlayBGMBegin(errCode: number): void;
-    /**
-     * 废弃事件： 播放背景音乐的进度
-     *
-     * @deprecated 从 TRTCSDK 8.0 后该接口已被废弃，不推荐使用
-     *
-     * @event TRTCCallback#onPlayBGMProgress
-     * @param {Number} progressMS - 已播放时间
-     * @param {Number} durationMS - 总时间
-     */
-    handleOnPlayBGMProgress(progressMS: number, durationMS: number): void;
-    /**
-     * 废弃事件： 播放背景音乐结束
-     *
-     * @deprecated 从 TRTCSDK 8.0 后该接口已被废弃，不推荐使用
-     *
-     * @event TRTCCallback#onPlayBGMComplete
-     * @param {Number} errCode - 错误码
-     */
-    handleOnPlayBGMComplete(errCode: number): void;
     /**
      * 本地录制任务开始的事件回调
      *
@@ -2090,24 +2062,26 @@ declare class TRTCCloud extends EventEmitter {
      */
     setSystemAudioLoopbackVolume(volume: number): void;
     /**
-     * 启动播放背景音乐
+     * 设置背景音乐的事件回调监听
+     *
+     * 请在播放背景音乐之前使用该接口设置播放事件回调，以便感知背景音乐的播放进度。
+     *
+     * @param {TRTCMusicPlayObserver} observer - 背景音乐播放事件回调
+     *
+     */
+    setMusicObserver(observer: TRTCMusicPlayObserver): void;
+    /**
+     * 开始播放背景音乐
      *
      * @param {AudioMusicParam} musicParam - 背景音乐参数
-     * @param {Object} callbackMap - 播放音乐事件回调(可选)
-     * @param {Function} callbackMap.onStart      - 开始播放背景音乐回调
-     * @param {Function} callbackMap.onPlayProgress      - 播放背景音乐的进度
-     * @param {Function} callbackMap.onComplete   - 播放背景音乐结束
+     * @param {TRTCMusicPlayObserver} [observer] - <span style="color:red;">该可选入参已经废弃。</span> 播放音乐事件回调监听，请使用 [setMusicObserver()]{@link TRTCCloud#setMusicObserver} 接口设置背景音乐事件回调。
      *
      * @example
-     * // 音乐播放
      * import TRTCCloud, { AudioMusicParam } from 'trtc-electron-sdk';
      * const rtcCloud = TRTCCloud.getTRTCShareInstance();
      *
-     * const params = new AudioMusicParam();
-     * params.id = 1;
-     * params.path = 'path';
-     * params.publish = true;
-     * rtcCloud.startPlayMusic(params, {
+     * // 设置背景音乐播放事件监听
+     * rtcCloud.setMusicObserver({
      *      onStart: (id: number, errCode: number) => {
      *        console.log(`onStart, id: ${id}, errorCode: ${errCode}`);
      *      },
@@ -2117,13 +2091,16 @@ declare class TRTCCloud extends EventEmitter {
      *      onComplete: (id: number, errCode: number) => {
      *          console.log(`onComplete, id: ${id}, errCode: ${errCode}`);
      *      }
-     * )
+     * });
+     *
+     * // 开始播放背景音乐
+     * const params = new AudioMusicParam();
+     * params.id = 1;
+     * params.path = 'path';
+     * params.publish = true;
+     * rtcCloud.startPlayMusic(params);
      */
-    startPlayMusic(musicParam: AudioMusicParam, callbackMap?: {
-        onStart?: (id: number, errCode: number) => void;
-        onPlayProgress?: (id: number, curPtsMS: number, durationMS: number) => void;
-        onComplete?: (id: number, errCode: number) => void;
-    }): void;
+    startPlayMusic(musicParam: AudioMusicParam, callbackMap?: TRTCMusicPlayObserver): void;
     /**
      * 停止播放背景音乐
      *

package/liteav/trtc.js

@@ -139,7 +139,6 @@ const getComponentNO = function () {
     }
     return componentNO;
 };
-let oriRtcCloud = null;
 /**
  * 腾讯云视频通话功能的主要接口类
  *
@@ -160,10 +159,6 @@ class TRTCCloud extends events_1.EventEmitter {
         this.logger = new logger_1.Logger(`TRTC_${this.id}`);
         const componentNO = getComponentNO();
         this.rtcCloud = new NodeTRTCEngine.NodeTRTCCloud(Object.assign({ jsVersion: pkg.version, componentNO }, config));
-        this.logger.warn('NodeRTCCloud:', this.rtcCloud);
-        // this.rtcCloud = Object.assign({}, oriRtcCloud, {
-        //     onlineLog: undefined
-        // });
         this.videoRendererMap = new Map();
         this.pixelFormat = trtc_define_1.TRTCVideoPixelFormat.TRTCVideoPixelFormat_I420;
         this.pixelLength = 1.5;
@@ -338,15 +333,7 @@ class TRTCCloud extends events_1.EventEmitter {
      * @namespace TRTCCallback
      */
     initEventHandler() {
-        // this.rtcCloud.onEvent('apierror', (funcName: string) => {
-        //     this.logger.error(`api ${funcName} failed. this is an error
-        //       thrown by c++ addon layer. it often means sth is
-        //       going wrong with this function call and it refused
-        //       to do what is asked. kindly check your parameter types
-        //       to see if it matches properly.`);
-        // });
         this.rtcCloud.setTRTCCloudCallback((args) => {
-            this.logger.log('trtc event:', args);
             const key = args[0];
             const data = args[1];
             switch (key) {
@@ -467,15 +454,6 @@ class TRTCCloud extends events_1.EventEmitter {
                 case 'onSnapshotComplete':
                     this.handleOnSnapshotComplete(data.userId, data.type, data.data, data.width, data.height);
                     break;
-                case 'onPlayBGMBegin':
-                    this.handleOnPlayBGMBegin(data.errCode);
-                    break;
-                case 'onPlayBGMProgress':
-                    this.handleOnPlayBGMProgress(data.progressMS, data.durationMS);
-                    break;
-                case 'onPlayBGMComplete':
-                    this.handleOnPlayBGMComplete(data.errCode);
-                    break;
                 case 'onAudioDeviceCaptureVolumeChanged':
                     this.handleOnAudioDeviceCaptureVolumeChanged(data.volume, data.muted);
                     break;
@@ -526,7 +504,6 @@ class TRTCCloud extends events_1.EventEmitter {
             this.emit(event, ...args);
         });
     }
-    ;
     /////////////////////////////////////////////////////////////////////////////////
     //
     //                      （一）错误事件和警告事件
@@ -581,7 +558,6 @@ class TRTCCloud extends events_1.EventEmitter {
             arch: process && process.arch || '',
             ua: window.navigator.userAgent
         };
-        // oriRtcCloud.onlineLog(result, SDK_LOG_LEVEL, '[trtc-electron-sdk] trtcstats', formatLogParams(params));
         this.rtcCloud.callExperimentalAPI(JSON.stringify({
             api: 'reportOnlineLog',
             params: {
@@ -1281,40 +1257,6 @@ class TRTCCloud extends events_1.EventEmitter {
     //                      （十二）背景混音事件回调
     //
     /////////////////////////////////////////////////////////////////////////////////
-    /**
-     * 废弃事件： 开始播放背景音乐
-     *
-     * @deprecated 从 TRTCSDK 8.0 后该接口已被废弃，不推荐使用
-     *
-     * @event TRTCCallback#onPlayBGMBegin
-     * @param {Number} errCode - 错误码
-     */
-    handleOnPlayBGMBegin(errCode) {
-        this.fire('onPlayBGMBegin', errCode);
-    }
-    /**
-     * 废弃事件： 播放背景音乐的进度
-     *
-     * @deprecated 从 TRTCSDK 8.0 后该接口已被废弃，不推荐使用
-     *
-     * @event TRTCCallback#onPlayBGMProgress
-     * @param {Number} progressMS - 已播放时间
-     * @param {Number} durationMS - 总时间
-     */
-    handleOnPlayBGMProgress(progressMS, durationMS) {
-        this.fire('onPlayBGMProgress', progressMS, durationMS);
-    }
-    /**
-     * 废弃事件： 播放背景音乐结束
-     *
-     * @deprecated 从 TRTCSDK 8.0 后该接口已被废弃，不推荐使用
-     *
-     * @event TRTCCallback#onPlayBGMComplete
-     * @param {Number} errCode - 错误码
-     */
-    handleOnPlayBGMComplete(errCode) {
-        this.fire('onPlayBGMComplete', errCode);
-    }
     /**
      * 本地录制任务开始的事件回调
      *
@@ -1934,7 +1876,7 @@ class TRTCCloud extends events_1.EventEmitter {
      */
     setCameraCaptureParams(params) {
         if (params && (0, validate_util_1.isNumber)(params.mode) && (0, validate_util_1.isNumber)(params.width) && (0, validate_util_1.isNumber)(params.height)) {
-            this.rtcCloud.setCameraCaptureParam(params.mode, params.width, params.height);
+            this.rtcCloud.setCameraCaptureParam(params);
         }
         else {
             this.logger.error('setCameraCaptureParams invalid params:', params);
@@ -2620,12 +2562,12 @@ class TRTCCloud extends events_1.EventEmitter {
     startAudioRecording(params) {
         var _a;
         if (params instanceof trtc_define_1.TRTCAudioRecordingParams && ((_a = params.filePath) === null || _a === void 0 ? void 0 : _a.length)) {
-            return this.rtcCloud.startAudioRecording(params.filePath, params.recordingContent, params.maxDurationPerFile);
+            return this.rtcCloud.startAudioRecording(params);
         }
         else if (typeof params === 'string' && params.length) {
             const path = params;
             const recordParams = new trtc_define_1.TRTCAudioRecordingParams(path);
-            return this.rtcCloud.startAudioRecording(recordParams.filePath, recordParams.recordingContent, recordParams.maxDurationPerFile);
+            return this.rtcCloud.startAudioRecording(recordParams);
         }
         else {
             this.logger.error('startAudioRecording, params is not valid');
@@ -3693,24 +3635,28 @@ class TRTCCloud extends events_1.EventEmitter {
         this.rtcCloud.setSystemAudioLoopbackVolume(volume);
     }
     /**
-     * 启动播放背景音乐
+     * 设置背景音乐的事件回调监听
+     *
+     * 请在播放背景音乐之前使用该接口设置播放事件回调，以便感知背景音乐的播放进度。
+     *
+     * @param {TRTCMusicPlayObserver} observer - 背景音乐播放事件回调
+     *
+     */
+    setMusicObserver(observer) {
+        this.rtcCloud.setMusicObserver(observer.onStart, observer.onPlayProgress, observer.onComplete);
+    }
+    /**
+     * 开始播放背景音乐
      *
      * @param {AudioMusicParam} musicParam - 背景音乐参数
-     * @param {Object} callbackMap - 播放音乐事件回调(可选)
-     * @param {Function} callbackMap.onStart      - 开始播放背景音乐回调
-     * @param {Function} callbackMap.onPlayProgress      - 播放背景音乐的进度
-     * @param {Function} callbackMap.onComplete   - 播放背景音乐结束
+     * @param {TRTCMusicPlayObserver} [observer] - <span style="color:red;">该可选入参已经废弃。</span> 播放音乐事件回调监听，请使用 [setMusicObserver()]{@link TRTCCloud#setMusicObserver} 接口设置背景音乐事件回调。
      *
      * @example
-     * // 音乐播放
      * import TRTCCloud, { AudioMusicParam } from 'trtc-electron-sdk';
      * const rtcCloud = TRTCCloud.getTRTCShareInstance();
      *
-     * const params = new AudioMusicParam();
-     * params.id = 1;
-     * params.path = 'path';
-     * params.publish = true;
-     * rtcCloud.startPlayMusic(params, {
+     * // 设置背景音乐播放事件监听
+     * rtcCloud.setMusicObserver({
      *      onStart: (id: number, errCode: number) => {
      *        console.log(`onStart, id: ${id}, errorCode: ${errCode}`);
      *      },
@@ -3720,29 +3666,20 @@ class TRTCCloud extends events_1.EventEmitter {
      *      onComplete: (id: number, errCode: number) => {
      *          console.log(`onComplete, id: ${id}, errCode: ${errCode}`);
      *      }
-     * )
+     * });
+     *
+     * // 开始播放背景音乐
+     * const params = new AudioMusicParam();
+     * params.id = 1;
+     * params.path = 'path';
+     * params.publish = true;
+     * rtcCloud.startPlayMusic(params);
      */
     startPlayMusic(musicParam, callbackMap) {
-        let onStartCb = (id, errCode) => {
-            this.fire('onPlayBGMBegin', errCode);
-            if (callbackMap && callbackMap.onStart) {
-                callbackMap.onStart(id, errCode);
-            }
-        };
-        let onPlayProgressCb = (id, curPtsMS, durationMS) => {
-            this.fire('onPlayBGMProgress', curPtsMS, durationMS);
-            if (callbackMap && callbackMap.onPlayProgress) {
-                callbackMap.onPlayProgress(id, curPtsMS, durationMS);
-            }
-        };
-        let onCompleteCb = (id, errCode) => {
-            this.fire('onPlayBGMComplete', errCode);
-            if (callbackMap && callbackMap.onComplete) {
-                callbackMap.onComplete(id, errCode);
-            }
-        };
+        if ((callbackMap === null || callbackMap === void 0 ? void 0 : callbackMap.onStart) || (callbackMap === null || callbackMap === void 0 ? void 0 : callbackMap.onPlayProgress) || (callbackMap === null || callbackMap === void 0 ? void 0 : callbackMap.onComplete)) {
+            this.rtcCloud.setMusicObserver((callbackMap === null || callbackMap === void 0 ? void 0 : callbackMap.onStart) || null, (callbackMap === null || callbackMap === void 0 ? void 0 : callbackMap.onPlayProgress) || null, (callbackMap === null || callbackMap === void 0 ? void 0 : callbackMap.onComplete) || null);
+        }
         this.rtcCloud.startPlayMusic(musicParam);
-        this.rtcCloud.setMusicObserver(onStartCb, onPlayProgressCb, onCompleteCb);
     }
     /**
      * 停止播放背景音乐
@@ -4124,7 +4061,7 @@ class TRTCCloud extends events_1.EventEmitter {
      * @param {Boolean} enabled - 指定是否启用，默认为禁止状态
      */
     setLogCompressEnabled(enabled) {
-        // this.rtcCloud.setLogCompressEnabled(enabled); // To-do: 缺少该接口
+        this.rtcCloud.setLogCompressEnabled(enabled);
     }
     /**
      * 设置日志保存路径

package/liteav/trtc_define.d.ts

@@ -815,6 +815,33 @@ export declare class AudioMusicParam {
     endTimeMS: number;
     constructor(id?: number, path?: string, loopCount?: number, publish?: boolean, isShortFile?: boolean, startTimeMS?: number, endTimeMS?: number);
 }
+/**
+ * 背景音乐播放事件监听器类型定义
+ */
+export declare type TRTCMusicPlayObserver = {
+    /**
+     * 背景音乐开始播放事件
+     * @param {Number} id - 背景音乐 ID
+     * @param {Number} errCode - 错误码。0: 开始播放成功；-4001: 打开文件失败，如音频文件格式不支持，本地音频文件不存在，网络音频文件无法访问等。
+     * @returns
+     */
+    onStart: (id: number, errCode: number) => void | null;
+    /**
+     * 背景音乐的播放进度事件
+     * @param {Number} id - 背景音乐 ID
+     * @param {Number} curPtsMS - 背景音乐当前播放时间戳
+     * @param {Number} durationMS - 背景音乐时长
+     * @returns
+     */
+    onPlayProgress: (id: number, curPtsMS: number, durationMS: number) => void | null;
+    /**
+     * 背景音乐播放完毕事件
+     * @param {Number} id - 背景音乐 ID
+     * @param {Number} errCode - 错误码。0: 播放结束；-4002: 解码失败，如音频文件损坏，网络音频文件服务器无法访问等。
+     * @returns
+     */
+    onComplete: (id: number, errCode: number) => void | null;
+};
 /**
  * 房间切换参数
  *

package/liteav/trtc_define.js

@@ -1524,6 +1524,36 @@ class AudioMusicParam {
     }
 }
 exports.AudioMusicParam = AudioMusicParam;
+/**
+ * @namespace TRTCMusicEvent
+ *
+ * @description 背景音乐事件
+ */
+/**
+ * @callback TRTCMusicEvent~onStart
+ * @param {number} [id] - 背景音乐 ID
+ * @param {number} [errCode] - 错误码。0: 开始播放成功；-4001: 打开文件失败，如音频文件格式不支持，本地音频文件不存在，网络音频文件无法访问等。
+ */
+/**
+ * @callback TRTCMusicEvent~onPlayProgress
+ * @param {number} [id] - 背景音乐 ID
+ * @param {Number} [curPtsMS] - 背景音乐当前播放时间戳
+ * @param {Number} [durationMS] - 背景音乐时长
+ */
+/**
+ * @callback TRTCMusicEvent~onComplete
+ * @param {number} [id] - 背景音乐 ID
+ * @param {number} [errCode] - 错误码。0: 播放结束；-4002: 解码失败，如音频文件损坏，网络音频文件服务器无法访问等。
+ */
+/**
+ * 背景音乐播放事件回调
+ *
+ * @typedef {Object} TRTCMusicPlayObserver
+ * @property {TRTCMusicEvent~onStart|null} onStart - 背景音乐开始播放事件。
+ * @property {TRTCMusicEvent~onPlayProgress|null} onPlayProgress - 背景音乐的播放进度事件。
+ * @property {TRTCMusicEvent~onComplete|null} onComplete - 背景音乐播放完毕事件。
+ */
+const TRTCMusicPlayObserver_HACK_JSDOC = null;
 /**
  * 房间切换参数
  *

package/package.json

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