@tencentcloud/tuiroom-engine-electron 1.4.5 → 1.5.0

package/index.d.ts

@@ -1,8 +1,8 @@
-import TIM from "tim-js-sdk";
+import TIM from 'tim-js-sdk';
 import TRTCCloud, { TRTCDeviceInfo, TRTCScreenCaptureSourceInfo } from 'trtc-electron-sdk';
-import { TUIRoomInfo, TUIVideoStreamType, TUIVideoQuality, TUIAudioQuality, TUIRole, TUIRoomEvents, TUIRoomType, TUISeatInfo, TUIRequestCallback, TUISpeechMode, TUIMediaDevice, TUISeatLockParams, TUILoginUserInfo, TUIUserInfo, TUIRequest } from './types';
+import { TUIRoomInfo, TUIVideoStreamType, TUIVideoQuality, TUIAudioQuality, TUIRole, TUIRoomEvents, TUIRoomType, TUISeatInfo, TUIRequestCallback, TUISpeechMode, TUIMediaDevice, TUISeatLockParams, TUILoginUserInfo, TUIUserInfo, TUIRequest, TUIVideoEncoderParams, TUIResolutionMode } from './types';
 export * from './types';
-export { TRTCDeviceType, TRTCDeviceState, TRTCDeviceInfo, TRTCVideoMirrorType, TRTCVideoRotation, TRTCVideoFillMode, TRTCVideoStreamType, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureSourceType, Rect, TRTCVideoEncParam, TRTCVideoResolution, TRTCVideoResolutionMode, TRTCScreenCaptureProperty } from 'trtc-electron-sdk';
+export { TRTCDeviceType, TRTCDeviceState, TRTCDeviceInfo, TRTCVideoMirrorType, TRTCVideoRotation, TRTCVideoFillMode, TRTCVideoStreamType, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureSourceType, Rect, TRTCVideoEncParam, TRTCVideoResolution, TRTCVideoResolutionMode, TRTCScreenCaptureProperty, TRTCVolumeInfo, } from 'trtc-electron-sdk';
 /**
  * TUIRoomEngine 提供了音视频房间的能力
  *
@@ -20,7 +20,7 @@ declare class TUIRoomEngine {
     private localVideoQuality;
     private localAudioQuality;
     static setModule(Module: any): void;
-    static once(event: string, func: Function): void;
+    static once(event: string, func: (...args: any[]) => void): void;
     constructor();
     /**
      * @private
@@ -250,7 +250,7 @@ declare class TUIRoomEngine {
      * } while (result.nextSequence !== 0)
      */
     getUserList(options?: {
-        nextSequence?: Number;
+        nextSequence?: number;
     }): Promise<Array<TUIUserInfo>>;
     /**
      * 获取用户的详细信息
@@ -351,6 +351,48 @@ declare class TUIRoomEngine {
     updateVideoQuality(options: {
         quality: TUIVideoQuality;
     }): Promise<void>;
+    /**
+     * 设置本地视频流的分辨率模式
+     * @param {object} options
+     * @param {TUIVideoStreamType} options.streamType
+     * @param {TUIResolutionMode} options.resolutionMode
+     *
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.setVideoResolutionMode({
+     *  type: TUIVideoStreamType.kCameraStream,
+     *  resolutionMode: TUIResolutionMode.kResolutionMode_Landscape,
+     * });
+     */
+    setVideoResolutionMode(options: {
+        streamType: TUIVideoStreamType;
+        resolutionMode: TUIResolutionMode;
+    }): Promise<void>;
+    /**
+     * 设置本地视频流的详细编码参数
+     * @param {object} options
+     * @param {TUIVideoStreamType} options.streamType
+     * @param {TUIVideoEncoderParams} options.encoderParams
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.updateVideoQualityEx({
+     *  streamType: TUIVideoStreamType.kCameraStream,
+     *  encoderParams: {
+     *   quality: TUIVideoQuality.kVideoQuality_720p,
+     *   fps: 15,
+     *   bitrate: 2000,
+     *   resMode: TUIResolutionMode.kResolutionMode_Landscape,
+     *  }
+     * });
+     */
+    updateVideoQualityEx(options: {
+        streamType: TUIVideoStreamType;
+        encoderParams: TUIVideoEncoderParams;
+    }): Promise<void>;
     /**
      * 设置本地音频的参数<br/>
      * @param {object} options 设置本地音频的参数
@@ -407,6 +449,18 @@ declare class TUIRoomEngine {
      * await roomEngine.stopPushLocalAudio();
      */
     stopPushLocalAudio(): Promise<void>;
+    /**
+     * 开始/停止向远端推本地音频流
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.muteLocalAudio();
+     * @since 1.5.0
+     */
+    muteLocalAudio(options: {
+        isMute: boolean;
+    }): Promise<void>;
     /**
      * 设置远端流渲染的区域
      *
@@ -1023,7 +1077,7 @@ declare class TUIRoomEngine {
      * const roomEngine = new TUIRoomEngine();
      * roomEngine.on(event, func);
      */
-    on(event: TUIRoomEvents, func: Function): void;
+    on(event: TUIRoomEvents, func: (...args: any[]) => void): void;
     private setObserver;
     /**
      * 取消监听 roomEngine 的事件
@@ -1035,7 +1089,7 @@ declare class TUIRoomEngine {
      * const roomEngine = new TUIRoomEngine();
      * roomEngine.off(event, func);
      */
-    off(event: String, func: Function): void;
+    off(event: string, func: (...args: any[]) => void): void;
     private handleTrtcCloudBindEvent;
     /**
      * 获取摄像头设备列表<br>
@@ -1186,6 +1240,13 @@ declare class TUIRoomEngine {
      */
     getTIM(): any;
     destroy(): void;
-    callExperimentalAPI(params: string): Promise<void>;
+    /**
+     * 实验性接口
+     * @private
+     * @param jsonStr jason 字符串
+     * @returns
+     */
+    callExperimentalAPI(jsonStr: string): Promise<void>;
+    private handleSetFramework;
 }
 export default TUIRoomEngine;