@tencentcloud/tuiroom-engine-js 2.1.0 → 2.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tencentcloud/tuiroom-engine-js",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "description": "TUIRoomEngine Web SDK",
   "main": "index.js",
   "types": "index.d.ts",

package/types.d.ts

@@ -47,6 +47,8 @@ export declare enum TUIErrorCode {
     ERR_OPEN_MICROPHONE_NEED_PERMISSION_FROM_ADMIN = -2361,
     ERR_OPEN_CAMERA_NEED_SEAT_UNLOCK = -2370,
     ERR_OPEN_CAMERA_NEED_PERMISSION_FROM_ADMIN = -2371,
+    ERR_OPEN_SCREEN_SHARE_NEED_SEAT_UNLOCK = -2372,
+    ERR_OPEN_SCREEN_SHARE_NEED_PERMISSION_FROM_ADMIN = -2373,
     ERR_SEND_MESSAGE_DISABLED_FOR_ALL = -2380,
     ERR_SEND_MESSAGE_DISABLED_FOR_CURRENT = -2381
 }
@@ -57,6 +59,7 @@ export type TUIRoomInfo = {
     isSeatEnabled: boolean;
     seatMode: TUISeatMode;
     isMicrophoneDisableForAllUser: boolean;
+    isScreenShareDisableForAllUser: boolean;
     isCameraDisableForAllUser: boolean;
     isMessageDisableForAllUser: boolean;
     maxSeatCount: number;
@@ -194,7 +197,8 @@ export declare enum TUIRequestAction {
     kRequestToTakeSeat = 4,
     kRequestRemoteUserOnSeat = 5,
     kApplyToAdminToOpenLocalCamera = 6,
-    kApplyToAdminToOpenLocalMicrophone = 7
+    kApplyToAdminToOpenLocalMicrophone = 7,
+    kApplyToAdminToOpenLocalScreenShare = 8
 }
 export declare enum TUIRequestCallbackType {
     kRequestAccepted = 0,
@@ -242,6 +246,31 @@ export type TUIRequestCallback = {
     code: number;
     message: string;
 };
+export declare enum TUIMediaDeviceType {
+    kMediaDeviceTypeUnknown = -1,
+    kMediaDeviceTypeAudioInput = 0,
+    kMediaDeviceTypeAudioOutput = 1,
+    kMediaDeviceTypeVideoCamera = 2
+}
+export declare enum TUIMediaDeviceState {
+    kMediaDeviceStateAdd = 0,
+    kMediaDeviceStateRemove = 1,
+    kMediaDeviceStateActive = 2
+}
+export declare enum TUIAudioRoute {
+    kAudioRouteSpeakerphone = 0,
+    kAudioRouteEarpiece = 1
+}
+export type TUIDeviceInfo = {
+    deviceId: string;
+    deviceName: string;
+    deviceProperties?: {
+        supportedResolution?: {
+            width: number;
+            height: number;
+        }[];
+    };
+};
 /**
  * **TUIRoomEngine 事件列表**<br>
  * @namespace TUIRoomEvents
@@ -371,6 +400,20 @@ export declare enum TUIRoomEvents {
      * });
      */
     onAllUserCameraDisableChanged = "onAllUserCameraDisableChanged",
+    /**
+     * @since v2.2.0
+     * @description 房间内所有用户屏幕分享被禁用事件
+     * @default 'onScreenShareForAllUserDisableChanged'
+     * @event TUIRoomEvents#onScreenShareForAllUserDisableChanged
+     * @param {object} options
+     * @param {boolean} options.isDisable 是否开启禁止屏幕分享
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onScreenShareForAllUserDisableChanged, ({ isDisable }) =>{
+     *    console.log('roomEngine.onScreenShareForAllUserDisableChanged', isDisable);
+     * });
+     */
+    onScreenShareForAllUserDisableChanged = "onScreenShareForAllUserDisableChanged",
     /**
      * @description 所有成员麦克风使用权限改变事件
      * @default 'onAllUserMicrophoneDisableChanged'
@@ -612,6 +655,7 @@ export declare enum TUIRoomEvents {
     onReceiveTextMessage = "onReceiveTextMessage",
     /**
      * @description 接收自定义消息事件
+     * @deprecated 该接口自 v2.0.0 版本废弃，请使用 tim 实例监听收消息事件
      * @default 'onReceiveCustomMessage'
      * @event TUIRoomEvents#onReceiveCustomMessage
      * @param {object} options
@@ -651,3 +695,49 @@ export declare enum TUIRoomEvents {
      */
     onUserScreenCaptureStopped = "onUserScreenCaptureStopped"
 }
+export declare enum TUIRoomDeviceMangerEvents {
+    /**
+     * @description 设备变更事件
+     * @default 'onDeviceChange'
+     * @event TUIRoomDeviceMangerEvents#onDeviceChange
+     * @param {object} options
+     * @param {string} options.deviceId 设备 Id
+     * @param {TRTCDeviceType} options.type 设备类型
+     * @param {TRTCDeviceState} options.state 设备变更状态
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const deviceManager = roomEngine.getDeviceManager();
+     * deviceManager.on(TUIRoomDeviceMangerEvents.onDeviceChange, ({ deviceId, type, state }) => {
+     *   console.log('deviceManager.onDeviceChange', deviceId, type, state);
+     * });
+     */
+    onDeviceChanged = "onDeviceChanged",
+    /**
+     * @description 麦克风测试音量
+     * @default 'onTestMicVolume'
+     * @event TUIRoomDeviceMangerEvents#onTestMicVolume
+     * @param {object} options
+     * @param {number} options.volume 麦克风测试音量（0-100）
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const deviceManager = roomEngine.getDeviceManager();
+     * deviceManager.on(TUIRoomDeviceMangerEvents.onTestMicVolume, ({ volume }) => {
+     *   console.log('deviceManager.onTestMicVolume', volume);
+     * });
+     */
+    onTestMicVolume = "onTestMicVolume",
+    /**
+     * @description 扬声器测试音量，仅 Electron 端支持
+     * @default 'onTestSpeakerVolume'
+     * @event TUIRoomDeviceMangerEvents#onTestSpeakerVolume
+     * @param {object} options
+     * @param {number} options.volume 扬声器测试音量（0-100）
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const deviceManager = roomEngine.getDeviceManager();
+     * deviceManager.on(TUIRoomDeviceMangerEvents.onTestSpeakerVolume, ({ volume }) => {
+     *   console.log('deviceManager.onTestSpeakerVolume', volume);
+     * });
+     */
+    onTestSpeakerVolume = "onTestSpeakerVolume"
+}