trtc-electron-sdk 12.1.608 → 12.2.701

package/liteav/trtc.d.ts

@@ -2,9 +2,14 @@
 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, TRTCVoiceChangerType, TRTCMusicPlayObserver, TRTCAudioFrameCallback, TRTCAudioProcessPluginOptions } from './trtc_define';
+import TRTCMediaMixingManager from './extensions/MediaMixingManager';
 export * from './trtc_define';
 export * from './trtc_code';
 export * from './vod_player';
+export * from './extensions/DeviceManager';
+export * from './extensions/AudioEffectManager';
+export * from './extensions/MediaMixingManager';
+export * from './extensions/PluginManager';
 /**
  * 腾讯云视频通话功能的主要接口类
  *
@@ -20,8 +25,10 @@ export * from './vod_player';
 declare class TRTCCloud extends EventEmitter {
     private logger;
     private id;
+    private static isIPCMode;
     private static sharedTRTCCloudInstance;
     private static subInstances;
+    private stateStore;
     private rtcCloud;
     private videoRendererMap;
     private localFillMode;
@@ -55,6 +62,12 @@ declare class TRTCCloud extends EventEmitter {
     private playAudioEffectIdList;
     private remoteVideoBufferMap;
     private localVideoBufferMap;
+    /**
+     * 构造函数
+     * @param config {TRTCInitConfig} - 初始化参数，可选
+     * @param config.networkProxy {Record<string, any>} - 网络代理参数，可选。为空时，默认不开启网络代理。
+     * @param config.isIPCMode {Boolean} - 是否跨进程模式，跨进程模式支持本地混流且混流视频采用原生窗口渲染。默认：false，不开启。
+     */
     constructor(config?: TRTCInitConfig);
     /**
      * 创建 TRTCCloud 主实例对象（单例模式）
@@ -628,7 +641,11 @@ declare class TRTCCloud extends EventEmitter {
      * 当您调用 [stopLocalRecording]{@link TRTCCloud#stopLocalRecording} 停止本地媒体录制任务时，SDK 会抛出该事件回调，用于通知您录制任务的最终结果。
      *
      * @event TRTCCallback#onLocalRecordComplete
-     * @param {number} errCode - 错误码 0：录制成功；-1：录制失败；-2：切换分辨率或横竖屏导致录制结束。
+     * @param {number} errCode - 错误码
+     *   - 0：录制成功；
+     *   - -1：录制失败；
+     *   - -2：切换分辨率或横竖屏导致录制结束；
+     *   - -3：录制时间太短，或未采集到任何视频或音频数据，请检查录制时长，或是否已开启音、视频采集。
      * @param {string} storagePath - 录制文件存储路径
      */
     handleOnLocalRecordComplete(errCode: number, storagePath: string): void;
@@ -1361,9 +1378,9 @@ declare class TRTCCloud extends EventEmitter {
      *    var camera = cameralist[i];
      *    console.info("camera deviceName: " + camera.deviceName + " deviceId:" + camera.deviceId);
      * }
-     * @return {TRTCDeviceInfo[]} 摄像头管理器列表
+     * @return {Array<TRTCDeviceInfo>} 摄像头管理器列表
      */
-    getCameraDevicesList(): TRTCDeviceInfo[];
+    getCameraDevicesList(): Array<TRTCDeviceInfo>;
     /**
      * 设置要使用的摄像头
      *
@@ -1375,7 +1392,7 @@ declare class TRTCCloud extends EventEmitter {
      *
      * @return {TRTCDeviceInfo} 设备信息，能获取设备 ID 和设备名称
      */
-    getCurrentCameraDevice(): any;
+    getCurrentCameraDevice(): TRTCDeviceInfo;
     /**
      * 获取麦克风设备列表
      *
@@ -1385,15 +1402,15 @@ declare class TRTCCloud extends EventEmitter {
      *     var mic = miclist[i];
      *     console.info("mic deviceName: " + mic.deviceName + " deviceId:" + mic.deviceId);
      *   }
-     * @return {TRTCDeviceInfo[]} 麦克风管理器列表
+     * @return {Array<TRTCDeviceInfo>} 麦克风管理器列表
      */
-    getMicDevicesList(): any;
+    getMicDevicesList(): Array<TRTCDeviceInfo>;
     /**
      * 获取当前选择的麦克风
      *
      * @return {TRTCDeviceInfo} 设备信息，能获取设备 ID 和设备名称
      */
-    getCurrentMicDevice(): any;
+    getCurrentMicDevice(): TRTCDeviceInfo;
     /**
      * 设置要使用的麦克风
      *
@@ -1408,7 +1425,7 @@ declare class TRTCCloud extends EventEmitter {
      * 注意：查询的是系统硬件音量大小。
      * @return {Number} 音量值，范围是0 - 100
      */
-    getCurrentMicDeviceVolume(): any;
+    getCurrentMicDeviceVolume(): number;
     /**
      * 设置系统当前麦克风设备的音量
      *
@@ -1427,7 +1444,7 @@ declare class TRTCCloud extends EventEmitter {
      *
      * @return {Boolean} 静音状态
      */
-    getCurrentMicDeviceMute(): any;
+    getCurrentMicDeviceMute(): boolean;
     /**
      * 获取扬声器设备列表
      *
@@ -1437,15 +1454,15 @@ declare class TRTCCloud extends EventEmitter {
      *     var speaker = speakerlist[i];
      *     console.info("mic deviceName: " + speaker.deviceName + " deviceId:" + speaker.deviceId);
      *   }
-     * @return {TRTCDeviceInfo[]} 扬声器管理器列表
+     * @return {Array<TRTCDeviceInfo>} 扬声器管理器列表
      */
-    getSpeakerDevicesList(): any;
+    getSpeakerDevicesList(): Array<TRTCDeviceInfo>;
     /**
      * 获取当前的扬声器设备
      *
      * @return {TRTCDeviceInfo} 设备信息，能获取设备 ID 和设备名称
      */
-    getCurrentSpeakerDevice(): any;
+    getCurrentSpeakerDevice(): TRTCDeviceInfo;
     /**
      * 设置要使用的扬声器
      *
@@ -1457,7 +1474,7 @@ declare class TRTCCloud extends EventEmitter {
      *
      * @return {Number} 扬声器音量，范围0 - 100
      */
-    getCurrentSpeakerVolume(): any;
+    getCurrentSpeakerVolume(): number;
     /**
      * 设置系统当前扬声器设备音量
      *
@@ -1477,7 +1494,7 @@ declare class TRTCCloud extends EventEmitter {
      *
      * @return {Boolean} 静音状态
      */
-    getCurrentSpeakerDeviceMute(): any;
+    getCurrentSpeakerDeviceMute(): boolean;
     /**
      * 设置 SDK 使用的音频设备自动跟随系统默认设备
      *
@@ -2046,7 +2063,7 @@ declare class TRTCCloud extends EventEmitter {
      * @param {String} path - 音乐文件路径
      * @return {Number} 成功返回时长，失败返回-1
      */
-    getBGMDuration(path: string): any;
+    getBGMDuration(path: string): number;
     /**
      * 废弃接口： 设置背景音乐播放进度
      *
@@ -2146,7 +2163,7 @@ declare class TRTCCloud extends EventEmitter {
     /**
      * 停止播放背景音乐
      *
-     * @param {Number} id 音乐 ID
+     * @param {Number} id - 音乐 ID
      */
     stopPlayMusic(id: number): void;
     /**
@@ -2161,20 +2178,27 @@ declare class TRTCCloud extends EventEmitter {
      * @param {Number} id 音乐 ID
      */
     resumePlayMusic(id: number): void;
+    /**
+   * 获取背景音乐的播放进度（单位：毫秒）
+   *
+   * @param {Number} id - 音乐 ID。
+   * @return {Promise<number>|Number} 成功返回当前播放时间，单位：毫秒，失败返回 -1。
+   */
+    getMusicCurrentPosInMS(id: number): Promise<number> | number;
     /**
      * 获取背景音乐文件总时长，单位毫秒
      *
      * @param {String} path - 音乐文件路径
      * @return {Number} 成功返回时长，失败返回-1
      */
-    getMusicDurationInMS(path: string): any;
+    getMusicDurationInMS(path: string): number;
     /**
      * 设置背景音乐播放进度
      *
      * @param {Number} id - 音乐 ID
      * @param {Number} pts - 单位: 毫秒
      */
-    seekMusicToPosInTime(id: number, pts: number): any;
+    seekMusicToPosInTime(id: number, pts: number): void;
     /**
      * 设置所有背景音乐的本地音量和远端音量的大小
      *
@@ -2186,7 +2210,7 @@ declare class TRTCCloud extends EventEmitter {
      *
      * @param {Number} volume - 音量大小，100为正常音量，取值范围为0 - 200。
      */
-    setAllMusicVolume(volume: number): any;
+    setAllMusicVolume(volume: number): void;
     /**
      * 设置背景音乐本地播放音量的大小
      *
@@ -2396,7 +2420,7 @@ declare class TRTCCloud extends EventEmitter {
      *
      * @return {String} UTF-8 编码的版本号。
      */
-    getSDKVersion(): any;
+    getSDKVersion(): string;
     /**
      * 设置 Log 输出级别
      *
@@ -2478,9 +2502,6 @@ declare class TRTCCloud extends EventEmitter {
      * @param config {TRTCVideoProcessPluginOptions | TRTCMediaEncryptDecryptPluginOptions | TRTCAudioProcessPluginOptions} - 插件配置参数
      */
     setPluginParams(type: TRTCPluginType, options: TRTCVideoProcessPluginOptions | TRTCMediaEncryptDecryptPluginOptions | TRTCAudioProcessPluginOptions): void;
-    private _setVideoProcessPluginParams;
-    private _setMediaEncryptDecryptPluginParams;
-    private _setAudioProcessPluginParams;
     /**
      * 添加插件
      *
@@ -2507,10 +2528,9 @@ declare class TRTCCloud extends EventEmitter {
      * @param [deviceId] {String} - 摄像头设备 ID，开启多个摄像头美颜时必填。
      */
     removePlugin(id: string, deviceId?: string): void;
-    private _createPlugin;
     /**
      * 注册插件事件监听，全局只需要调用一次
-     * @param {Function} pluginCb - 插件事件回调函数
+     * @param {Function} pluginCallback - 插件事件回调函数
      *  - pluginId - 插件ID
      *  - errorCode - 错误码。0、-1、-2、-3、-4、-5 是 SDK 内部定义错误码，其它错误码是插件自定义错误码。
      *     - 0 表示 addPlugin 成功
@@ -2523,7 +2543,7 @@ declare class TRTCCloud extends EventEmitter {
      *
      *  注意：错误码：-1000 到 1000 是 SDK 预留错误码，用户自定义插件中，请使用这个范围以外的错误码。
      */
-    setPluginCallback(pluginCb: (pluginId: string, errorCode: number, msg: string) => void): void;
+    setPluginCallback(pluginCallback: (pluginId: string, errorCode: number, msg: string) => void): void;
     /**
      * 初始化插件管理器
      *
@@ -2550,14 +2570,15 @@ declare class TRTCCloud extends EventEmitter {
     destroyPluginManager(): void;
     /**
      * 获取插件列表
-     * @returns TRTCPluginInfo[]
+     * @returns TRTCPluginInfo[]|null
      *
      * @ignore
      * @deprecated
      */
-    getPluginList(): TRTCPluginInfo[];
+    getPluginList(): TRTCPluginInfo[] | null;
     private _getKey;
     setEnableRenderFrame(enable: boolean): void;
+    log(info: string): void;
     private _getRendererMap;
     private _onRenderFrame;
     private _onRealRender;
@@ -2583,6 +2604,30 @@ declare class TRTCCloud extends EventEmitter {
     private _RGBA2BGRA;
     private _isMacPlatform;
     private _setRemoteVideoBuffer;
+    /**
+     * 获取设备管理器
+     *
+     * @returns {TRTCDeviceManager}
+     */
+    private getDeviceManager;
+    /**
+     * 获取音效管理器
+     *
+     * @returns {TRTCAudioEffectManager}
+     */
+    private getAudioEffectManager;
+    /**
+     * 获取本地混流管理器
+     *
+     * @returns {TRTCMediaMixingManager | null}
+     */
+    getMediaMixingManager(): TRTCMediaMixingManager | null;
+    /**
+     * 获取插件管理器
+     *
+     * @returns {TRTCPluginManager}
+     */
+    private getPluginManager;
 }
 export default TRTCCloud;
 export * from './LocalMediaTranscoder';