@tencentcloud/tuiroom-engine-electron 1.0.1 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tencentcloud/tuiroom-engine-electron",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "TUIRoomEngine Electron SDK",
   "main": "index.js",
   "types": "index.d.ts",
@@ -19,8 +19,8 @@
   "license": "ISC",
   "dependencies": {
     "rtc-detect": "^0.0.5",
-    "tim-js-sdk": "^2.25.0",
-    "trtc-electron-sdk": "^10.3.405",
-    "tsignaling": "^0.10.0"
+    "tim-js-sdk": "^2.27.0",
+    "trtc-electron-sdk": "^10.9.405-beta.0",
+    "tsignaling": "^1.0.5"
   }
 }

package/types.d.ts

@@ -20,16 +20,28 @@ export declare enum TUIErrorCode {
 }
 export type TUIRoomInfo = {
     roomId: string;
+    roomName: string;
     roomType: TUIRoomType;
-    owner: string;
-    name: string;
+    speechMode: TUISpeechMode;
+    isMicrophoneDisableForAllUser: boolean;
+    isCameraDisableForAllUser: boolean;
+    isMessageDisableForAllUser: boolean;
+    maxSeatCount: number;
+    enableCDNStreaming: boolean;
+    cdnStreamDomain: string;
+    roomOwner: string;
     createTime: number;
     roomMemberCount: number;
-    maxSeatCount: number;
-    enableVideo: boolean;
-    enableAudio: boolean;
-    enableMessage: boolean;
-    enableSeatControl: boolean;
+};
+export type TUILoginUserInfo = {
+    userId: string;
+    userName: string;
+    avatarUrl: string;
+};
+export type TUISeatLockParams = {
+    lockSeat: boolean;
+    lockVideo: boolean;
+    lockAudio: boolean;
 };
 export declare enum TUIRole {
     kRoomOwner = 0,
@@ -54,13 +66,13 @@ export type TUIMessage = {
     userName: string;
     avatarUrl: string;
 };
-export declare enum TUIVideoProfile {
-    kLowDefinition = 0,
-    kStandardDefinition = 1,
-    kHighDefinition = 2,
-    kSuperDefinition = 3
+export declare enum TUIVideoQuality {
+    kVideoQuality_360p = 1,
+    kVideoQuality_540p = 2,
+    kVideoQuality_720p = 3,
+    kVideoQuality_1080p = 4
 }
-export declare enum TUIAudioProfile {
+export declare enum TUIAudioQuality {
     kAudioProfileSpeech = 0,
     kAudioProfileDefault = 1,
     kAudioProfileMusic = 2
@@ -80,8 +92,18 @@ export declare enum TUINetworkQuality {
     kQualityDown = 6
 }
 export declare enum TUIRoomType {
-    kGroup = 1,
-    kOpen = 2
+    kConference = 1,
+    kLivingRoom = 2
+}
+export declare enum TUISpeechMode {
+    kFreeToSpeak = 1,
+    kApplyToSpeak = 2,
+    kSpeakAfterTakingSeat = 3
+}
+export declare enum TUIMediaDevice {
+    kMicrophone = 1,
+    kCamera = 2,
+    kScreen = 3
 }
 export declare enum TUICaptureSourceType {
     kWindow = 0,
@@ -97,7 +119,9 @@ export declare enum TUIRequestAction {
     kRequestToOpenRemoteMicrophone = 2,
     kRequestToConnectOtherRoom = 3,
     kRequestToTakeSeat = 4,
-    kRequestRemoteUserOnSeat = 5
+    kRequestRemoteUserOnSeat = 5,
+    kApplyToAdminToOpenLocalCamera = 6,
+    kApplyToAdminToOpenLocalMicrophone = 7
 }
 export declare enum TUIRequestCallbackType {
     kRequestAccepted = 0,
@@ -123,19 +147,19 @@ export type TUISeatInfo = {
     index: number;
     userId: string;
     locked: boolean;
-    videoMuted: boolean;
-    audioMuted: boolean;
+    isVideoLocked: boolean;
+    isAudioLocked: boolean;
 };
 export type TUIRequest = {
     requestAction: TUIRequestAction;
     timestamp: number;
-    requestId: number;
+    requestId: string;
     userId: string;
     content: string;
 };
 export type TUIRequestCallback = {
     requestCallbackType: TUIRequestCallbackType;
-    requestId: number;
+    requestId: string;
     userId: string;
     code: number;
     message: string;
@@ -227,19 +251,97 @@ export declare enum TUIRoomEvents {
      */
     onRoomDismissed = "onRoomDismissed",
     /**
-     * @description 房间信息修改事件
-     * @default 'onRoomInfoChanged'
-     * @event TUIRoomEvents#onRoomInfoChanged
+     * @description 房间名字修改事件
+     * @default 'onRoomNameChanged'
+     * @event TUIRoomEvents#onRoomChanged
+     * @param {object} options
+     * @param {string} options.roomName 房间名字
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onRoomNameChanged, ({ roomId, roomName }) =>{
+     *    console.log('roomEngine.onRoomNameChanged', roomId, roomName);
+     * });
+     */
+    onRoomNameChanged = "onRoomNameChanged",
+    /**
+     * @description 房间模式修改事件
+     * @default 'onRoomSpeechModeChanged'
+     * @event TUIRoomEvents#onRoomSpeechModeChanged
+     * @param {object} options
+     * @param {TUISpeechMode} options.speechMode 房间模式
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onRoomSpeechModeChanged, ({ roomId, speechMode }) =>{
+     *    console.log('roomEngine.onRoomSpeechModeChanged', roomId, speechMode);
+     * });
+     */
+    onRoomSpeechModeChanged = "onRoomSpeechModeChanged",
+    /**
+     * @description 所有成员摄像头使用权限修改事件
+     * @default 'onAllUserCameraDisableChanged'
+     * @event TUIRoomEvents#onAllUserCameraDisableChanged
+     * @param {object} options
+     * @param {boolean} options.isDisable 是否允许使用摄像头
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onAllUserCameraDisableChanged, ({ isDisable }) =>{
+     *    console.log('roomEngine.onAllUserCameraDisableChanged', isDisable);
+     * });
+     */
+    onAllUserCameraDisableChanged = "onAllUserCameraDisableChanged",
+    /**
+     * @description 所有成员麦克风使用权限修改事件
+     * @default 'onAllUserMicrophoneDisableChanged'
+     * @event TUIRoomEvents#onAllUserMicrophoneDisableChanged
+     * @param {object} options
+     * @param {boolean} options.isDisable 是否允许使用麦克风
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onAllUserMicrophoneDisableChanged, ({ isDisable }) =>{
+     *    console.log('roomEngine.onAllUserMicrophoneDisableChanged', isDisable);
+     * });
+     */
+    onAllUserMicrophoneDisableChanged = "onAllUserMicrophoneDisableChanged",
+    /**
+     * @description 修改所有成员发送消息状态事件
+     * @default 'onSendMessageForAllUserDisableChanged'
+     * @event TUIRoomEvents#OnSendMessageForAllUserDisableChanged
+     * @param {object} options
+     * @param {boolean} options.isDisable 是否被允许
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onSendMessageForAllUserDisableChanged, ({ isDisable }) =>{
+     *    console.log('roomEngine.onSendMessageForAllUserDisableChanged', isDisable);
+     * });
+     */
+    onSendMessageForAllUserDisableChanged = "onSendMessageForAllUserDisableChanged",
+    /**
+     * @description 修改特定成员发送消息状态事件
+     * @default 'onSendMessageForUserDisableChanged'
+     * @event TUIRoomEvents#onSendMessageForUserDisableChanged
      * @param {object} options
-     * @param {string} options.roomId  房间号
-     * @param {string} options.roomInfo 房间信息
+     * @param {string} options.userId 成员 Id
+     * @param {boolean} options.isDisable 是否被允许
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onRoomInfoChanged, ({ roomId, roomInfo }) => {
-     *   console.log('roomEngine.onRoomInfoChanged', roomId, roomInfo);
+     * roomEngine.on(TUIRoomEvents.onSendMessageForUserDisableChanged, ({ userId, isDisable }) =>{
+     *    console.log('roomEngine.onSendMessageForUserDisableChanged', isDisable);
      * });
      */
-    onRoomInfoChanged = "onRoomInfoChanged",
+    onSendMessageForUserDisableChanged = "onSendMessageForUserDisableChanged",
+    /**
+     * @description 房间最大麦位数修改事件
+     * @default 'onRoomMaxSeatCountChanged'
+     * @event TUIRoomEvents#onRoomMaxSeatCountChanged
+     * @param {object} options
+     * @param {boolean} options.maxSeatNumber 最大麦位数
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onRoomMaxSeatCountChanged, ({ maxSeatNumber }) =>{
+     *    console.log('roomEngine.onRoomMaxSeatCountChanged', maxSeatNumber);
+     * });
+     */
+    onRoomMaxSeatCountChanged = "onRoomMaxSeatCountChanged",
     /**
      * @description 远端用户进入房间事件
      * @default 'onRemoteUserEnterRoom'
@@ -287,7 +389,7 @@ export declare enum TUIRoomEvents {
      * @default 'onUserMuteStateChanged'
      * @event TUIRoomEvents#onUserMuteStateChanged
      * @param {object} options
-     * @param {string} options.userId 用户Id
+     * @param {string} options.userId 用户 Id
      * @param {boolean} options.muted 是否被禁止发文字消息
      * @example
      * const roomEngine = new TUIRoomEngine();
@@ -357,32 +459,18 @@ export declare enum TUIRoomEvents {
      * });
      */
     onUserNetworkQualityChanged = "onUserNetworkQualityChanged",
-    /**
-     * @description 麦位控制启用事件
-     * @default 'onSeatControlEnabled'
-     * @event TUIRoomEvents#onSeatControlEnabled
-     * @param {object} options
-     * @param {boolean} options.enabled 是否启用
-     * @param {number} options.maxSeatNumber 最大麦位数量
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onSeatControlEnabled, ({ enabled, maxSeatNumber }) => {
-     *   console.log('roomEngine.onSeatControlEnabled', enabled, maxSeatNumber);
-     * });
-     */
-    onSeatControlEnabled = "onSeatControlEnabled",
     /**
      * @description 麦位列表改变事件
      * @default 'onSeatListChanged'
      * @event TUIRoomEvents#onSeatListChanged
      * @param {object} options
      * @param {Array<TUISeatInfo>} options.seatList 麦位列表
-     * @param {Array<TUISeatInfo>} options.usersSeated 新增麦位信息
-     * @param {Array<TUISeatInfo>} options.usersLeft 离开的麦位信息
+     * @param {Array<TUISeatInfo>} options.seatedList 新增麦位列表
+     * @param {Array<TUISeatInfo>} options.leftList 离开的麦位列表
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onSeatListChanged, ({ seatList, usersSeated, usersLeft }) => {
-     *   console.log('roomEngine.onSeatListChanged',seatList, usersSeated, usersLeft);
+     * roomEngine.on(TUIRoomEvents.onSeatListChanged, ({ seatList, seatedList, leftList }) => {
+     *   console.log('roomEngine.onSeatListChanged',seatList, seatedList, leftList);
      * });
      */
     onSeatListChanged = "onSeatListChanged",
@@ -452,7 +540,7 @@ export declare enum TUIRoomEvents {
      * @example
      * const roomEngine = new TUIRoomEngine();
      * roomEngine.on(TUIRoomEvents.onDeviceChange, ({ deviceId, type, state }) => {
-     *   console.log('roomEngine.onReceiveCustomMessage', deviceId, type, state);
+     *   console.log('roomEngine.onDeviceChange', deviceId, type, state);
      * });
      */
     onDeviceChange = "onDeviceChange",
@@ -460,10 +548,11 @@ export declare enum TUIRoomEvents {
      * @description 屏幕分享停止事件，当用户使用浏览器自带的【停止分享】按钮结束屏幕共享时，该用户会收到 'onUserScreenCaptureStopped' 事件用来修改屏幕共享状态。
      * @default 'onUserScreenCaptureStopped'
      * @event TUIRoomEvents#onUserScreenCaptureStopped
+     * @param {TUIChangeReason} options.reason 设备变更状态
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onUserScreenCaptureStopped, () => {
-     *   console.log('roomEngine.onReceiveCustomMessage', deviceId, type, state);
+     * roomEngine.on(TUIRoomEvents.onUserScreenCaptureStopped, ({ reason }) => {
+     *   console.log('roomEngine.onUserScreenCaptureStopped', reason);
      * });
      */
     onUserScreenCaptureStopped = "onUserScreenCaptureStopped"