@tencentcloud/tuiroom-engine-electron 1.2.0 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tencentcloud/tuiroom-engine-electron",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "TUIRoomEngine Electron SDK",
   "main": "index.js",
   "types": "index.d.ts",
@@ -20,7 +20,7 @@
   "dependencies": {
     "rtc-detect": "^0.0.5",
     "tim-js-sdk": "^2.27.0",
-    "trtc-electron-sdk": "^10.9.405-beta.0",
-    "tsignaling": "^1.0.5"
+    "trtc-electron-sdk": "^11.0.501-beta.0",
+    "tsignaling": "^1.0.6"
   }
 }

package/types.d.ts

@@ -1,22 +1,50 @@
 export declare enum TUIErrorCode {
     ERR_SUCC = 0,
     ERR_FAILED = -1,
+    ERR_FREQ_LIMIT = -2,
+    ERR_SDKAPPID_NOT_FOUND = -1000,
     ERR_INVALID_PARAMETER = -1001,
     ERR_SDK_NOT_INITIALIZED = -1002,
     ERR_PERMISSION_DENIED = -1003,
     ERR_REQUIRE_PAYMENT = -1004,
     ERR_CAMERA_START_FAILED = -1100,
-    ERR_CAMERA_NOT_AUTHORIZED = 1101,
-    ERR_CAMERA_OCCUPY = 1102,
-    ERR_CAMERA_DEVICE_EMPTY = 1103,
-    ERR_MICROPHONE_START_FAILED = 1104,
-    ERR_MICROPHONE_NOT_AUTHORIZED = 1105,
-    ERR_MICROPHONE_OCCUPY = 1106,
-    ERR_MICROPHONE_DEVICE_EMPTY = 1107,
-    ERR_GET_SCREEN_SHARING_TARGET_FAILED = 1108,
-    ERR_START_SCREEN_SHARING_FAILED = 1109,
-    ERR_ALREADY_ROOM_OWNER = -1200,
-    ERR_IM_ATTRIBUTE_WRITE_CONFLICT = -1201
+    ERR_CAMERA_NOT_AUTHORIZED = -1101,
+    ERR_CAMERA_OCCUPIED = -1102,
+    ERR_CAMERA_DEVICE_EMPTY = -1103,
+    ERR_MICROPHONE_START_FAILED = -1104,
+    ERR_MICROPHONE_NOT_AUTHORIZED = -1105,
+    ERR_MICROPHONE_OCCUPIED = -1106,
+    ERR_MICROPHONE_DEVICE_EMPTY = -1107,
+    ERR_GET_SCREEN_SHARING_TARGET_FAILED = -1108,
+    ERR_START_SCREEN_SHARING_FAILED = -1109,
+    ERR_ROOM_ID_NOT_EXIST = -2100,
+    ERR_OPERATION_INVALID_BEFORE_ENTER_ROOM = -2101,
+    ERR_EXIT_NOT_SUPPORTED_FOR_ROOM_OWNER = -2102,
+    ERR_OPERATION_NOT_SUPPORTED_IN_CURRENT_ROOM_TYPE = -2103,
+    ERR_OPERATION_NOT_SUPPORTED_IN_CURRENT_SPEECH_MODE = -2104,
+    ERR_ROOM_ID_INVALID = -2105,
+    ERR_ROOM_ID_OCCUPIED = -2106,
+    ERR_ROOM_NAME_INVALID = -2107,
+    ERR_ALREADY_IN_OTHER_ROOM = -2108,
+    ERR_USER_NOT_EXIST = -2200,
+    ERR_USER_NOT_ENTERED = -2201,
+    ERR_NEED_OWNER_PERMISSION = -2300,
+    ERR_NEED_ADMIN_PERMISSION = -2301,
+    ERR_REQUEST_NO_PERMISSION = -2310,
+    ERR_REQUEST_ID_INVALID = -2311,
+    ERR_MAX_SEAT_COUNT_LIMIT = -2340,
+    ERR_ALREADY_IN_SEAT = -2341,
+    ERR_SEAT_OCCUPIED = -2342,
+    ERR_SEAT_LOCKED = -2343,
+    ERR_SEAT_INDEX_NOT_EXIST = -2344,
+    ERR_USER_NOT_IN_SEAT = -2345,
+    ERR_ALL_SEAT_OCCUPIED = -2346,
+    ERR_OPEN_MICROPHONE_NEED_SEAT_UNLOCK = -2360,
+    ERR_OPEN_MICROPHONE_NEED_PERMISSION_FROM_ADMIN = -2361,
+    ERR_OPEN_CAMERA_NEED_SEAT_UNLOCK = -2370,
+    ERR_OPEN_CAMERA_NEED_PERMISSION_FROM_ADMIN = -2371,
+    ERR_SEND_MESSAGE_DISABLED_FOR_ALL = -2380,
+    ERR_SEND_MESSAGE_DISABLED_FOR_CURRENT = -2381
 }
 export type TUIRoomInfo = {
     roomId: string;
@@ -27,8 +55,6 @@ export type TUIRoomInfo = {
     isCameraDisableForAllUser: boolean;
     isMessageDisableForAllUser: boolean;
     maxSeatCount: number;
-    enableCDNStreaming: boolean;
-    cdnStreamDomain: string;
     roomOwner: string;
     createTime: number;
     roomMemberCount: number;
@@ -37,6 +63,7 @@ export type TUILoginUserInfo = {
     userId: string;
     userName: string;
     avatarUrl: string;
+    customInfo: Record<string, any>;
 };
 export type TUISeatLockParams = {
     lockSeat: boolean;
@@ -142,6 +169,7 @@ export type TUIUserInfo = {
     hasAudioStream: boolean;
     hasVideoStream: boolean;
     hasScreenStream: boolean;
+    roomCustomInfo: Record<string, any>;
 };
 export type TUISeatInfo = {
     index: number;
@@ -189,17 +217,6 @@ export declare enum TUIRoomEvents {
      * })
      */
     onError = "onError",
-    /**
-     * @description 当前用户被踢下麦事件
-     * @default 'onKickedOffSeat'
-     * @event TUIRoomEvents#onKickedOffSeat
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onKickedOffSeat, ({ userId }) => {
-     *   console.log('roomEngine.onKickedOffSeat', userId);
-     * });
-     */
-    onKickedOffSeat = "onKickedOffSeat",
     /**
      * @description 踢出房间事件
      * @default 'onKickedOutOfRoom'
@@ -277,7 +294,7 @@ export declare enum TUIRoomEvents {
      */
     onRoomSpeechModeChanged = "onRoomSpeechModeChanged",
     /**
-     * @description 所有成员摄像头使用权限修改事件
+     * @description 所有成员摄像头使用权限改变事件
      * @default 'onAllUserCameraDisableChanged'
      * @event TUIRoomEvents#onAllUserCameraDisableChanged
      * @param {object} options
@@ -290,7 +307,7 @@ export declare enum TUIRoomEvents {
      */
     onAllUserCameraDisableChanged = "onAllUserCameraDisableChanged",
     /**
-     * @description 所有成员麦克风使用权限修改事件
+     * @description 所有成员麦克风使用权限改变事件
      * @default 'onAllUserMicrophoneDisableChanged'
      * @event TUIRoomEvents#onAllUserMicrophoneDisableChanged
      * @param {object} options
@@ -303,7 +320,7 @@ export declare enum TUIRoomEvents {
      */
     onAllUserMicrophoneDisableChanged = "onAllUserMicrophoneDisableChanged",
     /**
-     * @description 修改所有成员发送消息状态事件
+     * @description 所有成员发送消息权限改变事件
      * @default 'onSendMessageForAllUserDisableChanged'
      * @event TUIRoomEvents#OnSendMessageForAllUserDisableChanged
      * @param {object} options
@@ -315,20 +332,6 @@ export declare enum TUIRoomEvents {
      * });
      */
     onSendMessageForAllUserDisableChanged = "onSendMessageForAllUserDisableChanged",
-    /**
-     * @description 修改特定成员发送消息状态事件
-     * @default 'onSendMessageForUserDisableChanged'
-     * @event TUIRoomEvents#onSendMessageForUserDisableChanged
-     * @param {object} options
-     * @param {string} options.userId 成员 Id
-     * @param {boolean} options.isDisable 是否被允许
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onSendMessageForUserDisableChanged, ({ userId, isDisable }) =>{
-     *    console.log('roomEngine.onSendMessageForUserDisableChanged', isDisable);
-     * });
-     */
-    onSendMessageForUserDisableChanged = "onSendMessageForUserDisableChanged",
     /**
      * @description 房间最大麦位数修改事件
      * @default 'onRoomMaxSeatCountChanged'
@@ -384,20 +387,6 @@ export declare enum TUIRoomEvents {
      * });
      */
     onUserRoleChanged = "onUserRoleChanged",
-    /**
-     * @description 用户禁止发文字消息状态改变事件
-     * @default 'onUserMuteStateChanged'
-     * @event TUIRoomEvents#onUserMuteStateChanged
-     * @param {object} options
-     * @param {string} options.userId 用户 Id
-     * @param {boolean} options.muted 是否被禁止发文字消息
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onUserMuteStateChanged, ({ userId, muted }) => {
-     *   console.log('roomEngine.onUserMuteStateChanged', userId, muted);
-     * });
-     */
-    onUserMuteStateChanged = "onUserMuteStateChanged",
     /**
      * @description 用户视频状态改变事件
      * @default 'onUserVideoStateChanged'
@@ -429,6 +418,20 @@ export declare enum TUIRoomEvents {
      * });
      */
     onUserAudioStateChanged = "onUserAudioStateChanged",
+    /**
+     * @description 用户发送消息状态改变事件
+     * @default 'onSendMessageForUserDisableChanged'
+     * @event TUIRoomEvents#onSendMessageForUserDisableChanged
+     * @param {object} options
+     * @param {string} options.userId 成员 Id
+     * @param {boolean} options.isDisable 是否被允许
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onSendMessageForUserDisableChanged, ({ userId, isDisable }) =>{
+     *    console.log('roomEngine.onSendMessageForUserDisableChanged', isDisable);
+     * });
+     */
+    onSendMessageForUserDisableChanged = "onSendMessageForUserDisableChanged",
     /**
      * @description 用户音量改变事件
      * @default 'onUserVoiceVolumeChanged'
@@ -474,6 +477,17 @@ export declare enum TUIRoomEvents {
      * });
      */
     onSeatListChanged = "onSeatListChanged",
+    /**
+     * @description 当前用户被踢下麦事件
+     * @default 'onKickedOffSeat'
+     * @event TUIRoomEvents#onKickedOffSeat
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onKickedOffSeat, ({ userId }) => {
+     *   console.log('roomEngine.onKickedOffSeat', userId);
+     * });
+     */
+    onKickedOffSeat = "onKickedOffSeat",
     /**
      * @description 请求接收事件
      * @default 'onRequestReceived'
@@ -548,11 +562,10 @@ export declare enum TUIRoomEvents {
      * @description 屏幕分享停止事件，当用户使用浏览器自带的【停止分享】按钮结束屏幕共享时，该用户会收到 'onUserScreenCaptureStopped' 事件用来修改屏幕共享状态。
      * @default 'onUserScreenCaptureStopped'
      * @event TUIRoomEvents#onUserScreenCaptureStopped
-     * @param {TUIChangeReason} options.reason 设备变更状态
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onUserScreenCaptureStopped, ({ reason }) => {
-     *   console.log('roomEngine.onUserScreenCaptureStopped', reason);
+     * roomEngine.on(TUIRoomEvents.onUserScreenCaptureStopped, () => {
+     *   console.log('roomEngine.onUserScreenCaptureStopped');
      * });
      */
     onUserScreenCaptureStopped = "onUserScreenCaptureStopped"