@tencentcloud/tuiroom-engine-electron 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/README.md +68 -67
  2. package/index.cjs.js +3 -11422
  3. package/index.d.ts +28 -21
  4. package/index.esm.js +3 -11357
  5. package/index.js +3 -11424
  6. package/package.json +1 -1
  7. package/types.d.ts +11 -0
package/index.d.ts CHANGED
@@ -2,7 +2,7 @@ import TIM from "tim-js-sdk";
2
2
  import TRTCCloud, { TRTCDeviceInfo, TRTCScreenCaptureSourceInfo } from 'trtc-electron-sdk';
3
3
  import { TUIRoomInfo, TUIVideoStreamType, TUIVideoProfile, TUIAudioProfile, TUIRole, TUIRoomEvents, TUIRoomType, TUISeatInfo, TUIRequestCallback } from './types';
4
4
  export * from './types';
5
- export { TRTCDeviceType, TRTCDeviceState, TRTCDeviceInfo, TRTCVideoMirrorType, TRTCVideoRotation, TRTCVideoFillMode, TRTCVideoStreamType, TRTCScreenCaptureSourceType, TRTCScreenCaptureSourceInfo, Rect, TRTCVideoEncParam, TRTCVideoResolution, TRTCVideoResolutionMode, TRTCScreenCaptureProperty } from 'trtc-electron-sdk';
5
+ export { TRTCDeviceType, TRTCDeviceState, TRTCDeviceInfo, TRTCVideoMirrorType, TRTCVideoRotation, TRTCVideoFillMode, TRTCVideoStreamType, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureSourceType, Rect, TRTCVideoEncParam, TRTCVideoResolution, TRTCVideoResolutionMode, TRTCScreenCaptureProperty } from 'trtc-electron-sdk';
6
6
  /**
7
7
  * TUIRoomEngine 提供了音视频房间的能力
8
8
  *
@@ -33,26 +33,26 @@ declare class TUIRoomEngine {
33
33
  */
34
34
  private JSCallNativeFunctionPromise;
35
35
  /**
36
- * 初始化 TUIRoomEngine
37
- *
38
- * @param {object} options
39
- * @param {number} options.sdkAppId sdkAppId <br>
40
- * 在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 单击 **应用管理** > **创建应用** 创建新应用之后，即可在 **应用信息** 中获取 sdkAppId 信息。
41
- * @param {string} options.userId 用户ID <br>
42
- * 建议限制长度为32字节，只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。
43
- * @param {string} options.userSig userSig 签名 <br>
44
- * 计算 userSig 的方式请参考 [UserSig 相关](https://cloud.tencent.com/document/product/647/17275)。
45
- * @returns {Promise<void>}
46
- *
47
- * @example
48
- * // 初始化 TUIRoomEngine
49
- * await TUIRoomEngine.init({
50
- * sdkAppId: 0, // 填写您申请的 sdkAppId
51
- * userId: '', // 填写您业务对应的 userId
52
- * userSig: '', // 填写服务器或本地计算的 userSig
53
- * })
54
- */
55
- static init(options: {
36
+ * 登录 TUIRoomEngine
37
+ *
38
+ * @param {object} options
39
+ * @param {number} options.sdkAppId sdkAppId <br>
40
+ * 在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 单击 **应用管理** > **创建应用** 创建新应用之后，即可在 **应用信息** 中获取 sdkAppId 信息。
41
+ * @param {string} options.userId 用户ID <br>
42
+ * 建议限制长度为32字节，只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。
43
+ * @param {string} options.userSig userSig 签名 <br>
44
+ * 计算 userSig 的方式请参考 [UserSig 相关](https://cloud.tencent.com/document/product/647/17275)。
45
+ * @returns {Promise<void>}
46
+ *
47
+ * @example
48
+ * // 登录 TUIRoomEngine
49
+ * await TUIRoomEngine.login({
50
+ * sdkAppId: 0, // 填写您申请的 sdkAppId
51
+ * userId: '', // 填写您业务对应的 userId
52
+ * userSig: '', // 填写服务器或本地计算的 userSig
53
+ * })
54
+ */
55
+ static login(options: {
56
56
  sdkAppId: number;
57
57
  userId: string;
58
58
  userSig: string;
@@ -77,6 +77,13 @@ declare class TUIRoomEngine {
77
77
  userName: string;
78
78
  avatarUrl: string;
79
79
  }): Promise<void>;
80
+ /**
81
+ * 登出 TUIRoomEngine, 登出 TUIRoomEngine 时将销毁所有 roomEngine 实例
82
+ *
83
+ * @example
84
+ * await TUIRoomEngine.logout();
85
+ */
86
+ static logout(): Promise<void>;
80
87
  /**
81
88
  * 主持人创建房间，调用 createRoom 的用户为房间的所有者。创建房间时可设置房间 Id, 房间名称，以及房间是否允许加入用户开启音视频，发送消息等功能。
82
89
  *