@tencentcloud/tuiroom-engine-electron 1.0.0 → 1.0.2

package/index.d.ts

@@ -2,7 +2,7 @@ import TIM from "tim-js-sdk";
 import TRTCCloud, { TRTCDeviceInfo, TRTCScreenCaptureSourceInfo } from 'trtc-electron-sdk';
 import { TUIRoomInfo, TUIVideoStreamType, TUIVideoProfile, TUIAudioProfile, TUIRole, TUIRoomEvents, TUIRoomType, TUISeatInfo, TUIRequestCallback } from './types';
 export * from './types';
-export { TRTCDeviceType, TRTCDeviceState, TRTCDeviceInfo, TRTCVideoMirrorType, TRTCVideoRotation, TRTCVideoFillMode, TRTCVideoStreamType, TRTCScreenCaptureSourceType, TRTCScreenCaptureSourceInfo, Rect, TRTCVideoEncParam, TRTCVideoResolution, TRTCVideoResolutionMode, TRTCScreenCaptureProperty } from 'trtc-electron-sdk';
+export { TRTCDeviceType, TRTCDeviceState, TRTCDeviceInfo, TRTCVideoMirrorType, TRTCVideoRotation, TRTCVideoFillMode, TRTCVideoStreamType, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureSourceType, Rect, TRTCVideoEncParam, TRTCVideoResolution, TRTCVideoResolutionMode, TRTCScreenCaptureProperty } from 'trtc-electron-sdk';
 /**
  * TUIRoomEngine 提供了音视频房间的能力
  *
@@ -33,7 +33,7 @@ declare class TUIRoomEngine {
      */
     private JSCallNativeFunctionPromise;
     /**
-     * 初始化 TUIRoomEngine
+     * 登录 TUIRoomEngine
      *
      * @param {object} options
      * @param {number} options.sdkAppId sdkAppId <br>
@@ -45,14 +45,14 @@ declare class TUIRoomEngine {
      * @returns {Promise<void>}
      *
      * @example
-     * // 初始化 TUIRoomEngine
-     * await TUIRoomEngine.init({
+     * // 登录 TUIRoomEngine
+     * await TUIRoomEngine.login({
      *  sdkAppId: 0,   // 填写您申请的 sdkAppId
      *  userId: '',    // 填写您业务对应的 userId
      *  userSig: '',   // 填写服务器或本地计算的 userSig
      * })
      */
-    static init(options: {
+    static login(options: {
         sdkAppId: number;
         userId: string;
         userSig: string;
@@ -77,6 +77,13 @@ declare class TUIRoomEngine {
         userName: string;
         avatarUrl: string;
     }): Promise<void>;
+    /**
+     * 登出 TUIRoomEngine, 登出 TUIRoomEngine 时将销毁所有 roomEngine 实例
+     *
+     * @example
+     * await TUIRoomEngine.logout();
+     */
+    static logout(): Promise<void>;
     /**
      * 主持人创建房间，调用 createRoom 的用户为房间的所有者。创建房间时可设置房间 Id, 房间名称，以及房间是否允许加入用户开启音视频，发送消息等功能。
      *
@@ -285,7 +292,7 @@ declare class TUIRoomEngine {
         seatIndex: number;
         timeout: number;
         requestCallback?: (callbackInfo: TUIRequestCallback) => void;
-    }): Promise<number>;
+    }): Promise<string>;
     /**
      * 离开麦位
      * @returns {Promise<void>}
@@ -346,7 +353,7 @@ declare class TUIRoomEngine {
         userId: string;
         timeout: number;
         requestCallback?: (callbackInfo: TUIRequestCallback) => void;
-    }): Promise<number>;
+    }): Promise<string>;
     /**
      * 关闭远端用户摄像头
      *
@@ -405,7 +412,7 @@ declare class TUIRoomEngine {
         userId: string;
         timeout: number;
         requestCallback?: (callbackInfo: TUIRequestCallback) => void;
-    }): Promise<number>;
+    }): Promise<string>;
     /**
      * 关闭远端用户麦克风
      *
@@ -482,7 +489,7 @@ declare class TUIRoomEngine {
         userId: string;
         timeout: number;
         requestCallback?: (callbackInfo: TUIRequestCallback) => void;
-    }): Promise<number>;
+    }): Promise<string>;
     /**
      * 要求其他人下麦
      * @param {object} options 要求其他人下麦的参数
@@ -504,22 +511,22 @@ declare class TUIRoomEngine {
     /**
      * 取消已经发出的请求
      * @param {object} options 取消已经发出请求的参数
-     * @param {number} options.requestId 请求 Id
+     * @param {string} options.requestId 请求 Id
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * await roomEngine.cancelRequest({
-     *  requestId: 0,    // 请使用实际 requestId
+     *  requestId: '',    // 请使用实际 requestId
      * });
      */
     cancelRequest(options: {
-        requestId: number;
+        requestId: string;
     }): Promise<void>;
     /**
      * 回复远端用户的请求
      * @param {object} options 回复远端用户的请求的参数
-     * @param {number} options.requestId 请求 Id
+     * @param {string} options.requestId 请求 Id
      * @param {boolean} options.agree 是否同意
      * @returns {Promise<void>}
      *
@@ -528,18 +535,18 @@ declare class TUIRoomEngine {
      *
      * // 同意远端的请求
      * await roomEngine.responseRemoteRequest({
-     *  requestId: 0,    // 请使用实际 requestId
+     *  requestId: '',    // 请使用实际 requestId
      *  agree: true,
      * });
      *
      * // 拒绝远端的请求
      * await roomEngine.responseRemoteRequest({
-     *  requestId: 0,    // 请使用实际 requestId
+     *  requestId: '',    // 请使用实际 requestId
      *  agree: false,
      * });
      */
     responseRemoteRequest(options: {
-        requestId: number;
+        requestId: string;
         agree: boolean;
     }): Promise<any>;
     /**