@tencentcloud/tuiroom-engine-electron 0.0.1 → 0.0.2

package/types.d.ts

@@ -1,459 +1,459 @@
-export declare enum TUIErrorCode {
-    ERR_SUCC = 0,
-    ERR_FAILED = -1,
-    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
-}
-export type TUIRoomInfo = {
-    roomId: string;
-    roomType: TUIRoomType;
-    owner: string;
-    name: string;
-    createTime: number;
-    roomMemberCount: number;
-    maxSeatCount: number;
-    enableVideo: boolean;
-    enableAudio: boolean;
-    enableMessage: boolean;
-    enableSeatControl: boolean;
-};
-export declare enum TUIRole {
-    kRoomOwner = 0,
-    kAdministrator = 1,
-    kGeneralUser = 2
-}
-/**
- * 消息结构体
- * @typedef {object} TUIMessage
- * @property {string} messageId 消息 Id
- * @property {string} message 消息内容
- * @property {number} timestamp 时间戳信息, 精确到秒
- * @property {TUIRole} userId 用户 Id
- * @property {boolean} userName 用户名称
- * @property {boolean} avatarUrl 用户头像地址
- */
-export type TUIMessage = {
-    messageId: string;
-    message: string;
-    timestamp: number;
-    userId: string;
-    userName: string;
-    avatarUrl: string;
-};
-export declare enum TUIVideoProfile {
-    kLowDefinition = 0,
-    kStandardDefinition = 1,
-    kHighDefinition = 2,
-    kSuperDefinition = 3
-}
-export declare enum TUIAudioProfile {
-    kAudioProfileSpeech = 0,
-    kAudioProfileDefault = 1,
-    kAudioProfileMusic = 2
-}
-export declare enum TUIVideoStreamType {
-    kCameraStream = 0,
-    kScreenStream = 1,
-    kCameraStreamLow = 2
-}
-export declare enum TUINetworkQuality {
-    kQualityUnknown = 0,
-    kQualityExcellent = 1,
-    kQualityGood = 2,
-    kQualityPoor = 3,
-    kQualityBad = 4,
-    kQualityVeryBad = 5,
-    kQualityDown = 6
-}
-export declare enum TUIRoomType {
-    kGroup = 1,
-    kOpen = 2
-}
-export declare enum TUICaptureSourceType {
-    kWindow = 0,
-    kScreen = 1
-}
-export declare enum TUIChangeReason {
-    kChangedBySelf = 0,
-    kChangedByAdmin = 1
-}
-export declare enum TUIRequestAction {
-    kInvalidAction = 0,
-    kRequestToOpenRemoteCamera = 1,
-    kRequestToOpenRemoteMicrophone = 2,
-    kRequestToConnectOtherRoom = 3,
-    kRequestToTakeSeat = 4,
-    kRequestRemoteUserOnSeat = 5
-}
-export declare enum TUIRequestCallbackType {
-    kRequestAccepted = 0,
-    kRequestRejected = 1,
-    kRequestCancelled = 2,
-    kRequestTimeout = 3,
-    kRequestError = 4
-}
-export declare enum TRTCRole {
-    kAnchor = 0,
-    kAudience = 1
-}
-export type TUIUserInfo = {
-    userId: string;
-    userName: string;
-    avatarUrl: string;
-    userRole: TUIRole;
-    hasAudioStream: boolean;
-    hasVideoStream: boolean;
-    hasScreenStream: boolean;
-};
-export type TUISeatInfo = {
-    index: number;
-    userId: string;
-    locked: boolean;
-    videoMuted: boolean;
-    audioMuted: boolean;
-};
-export type TUIRequest = {
-    requestAction: TUIRequestAction;
-    timestamp: number;
-    requestId: number;
-    userId: string;
-    content: string;
-};
-export type TUIRequestCallback = {
-    requestCallbackType: TUIRequestCallbackType;
-    requestId: number;
-    userId: string;
-    code: number;
-    message: string;
-};
-/**
- * **TUIRoomEngine 事件列表**<br>
- * @namespace TUIRoomEvents
- * @example
- * import TUIRoomEngine, { TUIRoomEvents } from 'tui-room-engine-js';
- * const roomEngine = new TUIRoomEngine();
- * roomEngine.on(TUIRoomEvents.onError, (error) => {
- *  console.log('roomEngine.error', error);
- * })
- */
-export declare enum TUIRoomEvents {
-    /**
-     *
-     * @description 错误事件
-     * @event TUIRoomEvents#onError
-     * @param {object} options
-     * @param {number} options.code 错误代码
-     * @param {string} options.message 错误信息
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onError, (error) => {
-     *  console.log('TUIRoomError error', error);
-     * })
-     */
-    onError = "onError",
-    /**
-     * @description 踢出房间事件
-     * @default 'onKickedOutOfRoom'
-     * @event TUIRoomEvents#onKickedOutOfRoom
-     * @param {object} options
-     * @param {string} options.roomId 房间号
-     * @param {string} options.message 踢出房间信息
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onKickedOutOfRoom, ({ roomId, message }) => {
-     *   console.log('roomEngine.onKickedOutOfRoom', roomId, message);
-     * });
-     */
-    onKickedOutOfRoom = "onKickedOutOfRoom",
-    /**
-     * @description 当前用户被踢下线
-     * @default 'onKickedOffLine'
-     * @event TUIRoomEvents#onKickedOffLine
-     * @param {string} options.message 用户被踢下线信息
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onKickedOffLine, ({ message }) => {
-     *   console.log('roomEngine.onKickedOffLine', message);
-     * });
-     */
-    onKickedOffLine = "onKickedOffLine",
-    /**
-     * @description userSig 过期事件
-     * @default 'onUserSigExpired'
-     * @event TUIRoomEvents#onUserSigExpired
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onUserSigExpired, () => {
-     *   console.log('roomEngine.onUserSigExpired');
-     * });
-     */
-    onUserSigExpired = "onUserSigExpired",
-    /**
-     * @description 主持人销毁房间事件
-     * @default 'onRoomDismissed'
-     * @event TUIRoomEvents#onRoomDismissed
-     * @param {object} options
-     * @param {string} options.roomId 房间号
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onRoomDismissed, ({ roomId }) => {
-     *   console.log('roomEngine.onRoomDismissed', roomId);
-     * });
-     */
-    onRoomDismissed = "onRoomDismissed",
-    /**
-     * @description 房间信息修改事件
-     * @default 'onRoomInfoChanged'
-     * @event TUIRoomEvents#onRoomInfoChanged
-     * @param {object} options
-     * @param {string} options.roomId  房间号
-     * @param {string} options.roomInfo 房间信息
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onRoomInfoChanged, ({ roomId, roomInfo }) => {
-     *   console.log('roomEngine.onRoomInfoChanged', roomId, roomInfo);
-     * });
-     */
-    onRoomInfoChanged = "onRoomInfoChanged",
-    /**
-     * @description 远端用户进入房间事件
-     * @default 'onRemoteUserEnterRoom'
-     * @event TUIRoomEvents#onRemoteUserEnterRoom
-     * @param {object} options
-     * @param {string} options.roomId 房间号
-     * @param {TUIUserInfo} options.userInfo 用户信息
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onRemoteUserEnterRoom, ({ roomId, userInfo }) => {
-     *   console.log('roomEngine.onRemoteUserEnterRoom', roomId, userInfo);
-     * });
-     */
-    onRemoteUserEnterRoom = "onRemoteUserEnterRoom",
-    /**
-     * @description 远端用户离开房间事件
-     * @default 'onRemoteUserLeaveRoom'
-     * @event TUIRoomEvents#onRemoteUserLeaveRoom
-     * @param {object} options
-     * @param {string} options.roomId 房间号
-     * @param {TUIUserInfo} options.userInfo 用户信息
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onRemoteUserLeaveRoom, ({ roomId, userInfo }) => {
-     *   console.log('roomEngine.onRemoteUserLeaveRoom', roomId, userInfo);
-     * });
-     */
-    onRemoteUserLeaveRoom = "onRemoteUserLeaveRoom",
-    /**
-     * @description 用户角色改变事件
-     * @default 'onKickedOutOfRoom'
-     * @event TUIRoomEvents#onUserRoleChanged
-     * @param {object} options
-     * @param {string} options.userId 用户Id
-     * @param {TUIRole} options.userRole 用户变更后的角色
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onUserRoleChanged, ({ userId, userRole }) => {
-     *   console.log('roomEngine.onUserRoleChanged', userId, userRole);
-     * });
-     */
-    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'
-     * @event TUIRoomEvents#onUserVideoStateChanged
-     * @param {object} options
-     * @param {string} options.userId 用户Id
-     * @param {TUIVideoStreamType} options.streamType 用户流类型
-     * @param {boolean} options.hasVideo 是否有视频流
-     * @param {TUIChangeReason} options.reason 变更原因
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onUserVideoStateChanged, ({ userId, streamType, hasVideo, reason }) => {
-     *   console.log('roomEngine.onUserVideoStateChanged', userId, streamType, hasVideo, reason);
-     * });
-     */
-    onUserVideoStateChanged = "onUserVideoStateChanged",
-    /**
-     * @description 用户音频状态改变事件
-     * @default 'onUserAudioStateChanged'
-     * @event TUIRoomEvents#onUserAudioStateChanged
-     * @param {object} options
-     * @param {string} options.userId 用户Id
-     * @param {boolean} options.hasVideo 是否有音频流
-     * @param {TUIChangeReason} options.reason 原因
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onUserAudioStateChanged, ({ userId, hasAudio, reason }) => {
-     *   console.log('roomEngine.onUserAudioStateChanged', userId, hasAudio, reason);
-     * });
-     */
-    onUserAudioStateChanged = "onUserAudioStateChanged",
-    /**
-     * @description 用户音量改变事件
-     * @default 'onUserVoiceVolumeChanged'
-     * @event TUIRoomEvents#onUserVoiceVolumeChanged
-     * @param {object} options
-     * @param {Array<TRTCVolumeInfo>} options.userVolumeList 房间内所有用户的音量, 包含 userId 及 volume 信息，volume 区间为 1～100;
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onUserVoiceVolumeChanged, ({ userVolumeList }) => {
-     *   userVolumeList.forEach(userVolume => {
-     *     console.log('roomEngine.onUserVoiceVolumeChanged', userVolume.userId, userVolume.volume);
-     *   })
-     * });
-     */
-    onUserVoiceVolumeChanged = "onUserVoiceVolumeChanged",
-    /**
-     * @description 用户网络质量改变事件
-     * @default 'onUserNetworkQualityChanged'
-     * @event TUIRoomEvents#onUserNetworkQualityChanged
-     * @param {object} options
-     * @param {TUINetworkQuality} options.networkMap 遍历网络质量等级
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onUserNetworkQualityChanged, ({ userNetworkList }) => {
-     *   userNetworkList.forEach(userNetwork => {
-     *     console.log('roomEngine.onUserNetworkQualityChanged', userNetwork.userId, userNetwork.volume);
-     *   })
-     * });
-     */
-    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 离开的麦位信息
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onSeatListChanged, ({ seatList, usersSeated, usersLeft }) => {
-     *   console.log('roomEngine.onSeatListChanged',seatList, usersSeated, usersLeft);
-     * });
-     */
-    onSeatListChanged = "onSeatListChanged",
-    /**
-     * @description 请求接收事件
-     * @default 'onRequestReceived'
-     * @event TUIRoomEvents#onRequestReceived
-     * @param {object} options
-     * @param {TUIRequest} options.request 请求接收
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onRequestReceived, ({ request }) => {
-     *   console.log('roomEngine.onRequestReceived', request);
-     * });
-     */
-    onRequestReceived = "onRequestReceived",
-    /**
-     * @description 请求取消事件
-     * @default 'onRequestCancelled'
-     * @event TUIRoomEvents#onRequestCancelled
-     * @param {object} options
-     * @param {string} options.requestId 请求Id
-     * @param {string} options.userId 取消请求的用户Id
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onRequestCancelled, ({ requestId, userId }) => {
-     *   console.log('roomEngine.onRequestCancelled', requestId, userId);
-     * });
-     */
-    onRequestCancelled = "onRequestCancelled",
-    /**
-     * @description 接收文本消息事件
-     * @default 'onReceiveTextMessage'
-     * @event TUIRoomEvents#onReceiveTextMessage
-     * @param {object} options
-     * @param {string} options.roomId 房间Id
-     * @param {TUIMessage} options.message 接收的文本消息
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onReceiveTextMessage, ({ roomId, message }) => {
-     *   console.log('roomEngine.onReceiveTextMessage', roomId, message);
-     * });
-     */
-    onReceiveTextMessage = "onReceiveTextMessage",
-    /**
-     * @description 接收自定义消息事件
-     * @default 'onReceiveCustomMessage'
-     * @event TUIRoomEvents#onReceiveCustomMessage
-     * @param {object} options
-     * @param {string} options.roomId 房间Id
-     * @param {TUIMessage} options.message 接收的自定义消息
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onReceiveCustomMessage, ({ roomId, message }) => {
-     *   console.log('roomEngine.onReceiveCustomMessage', roomId, message);
-     * });
-     */
-    onReceiveCustomMessage = "onReceiveCustomMessage",
-    /**
-     * @description 设备变更事件
-     * @default 'onDeviceChange'
-     * @event TUIRoomEvents#onDeviceChange
-     * @param {object} options
-     * @param {string} options.deviceId 设备 Id
-     * @param {TRTCDeviceType} options.type 设备类型
-     * @param {TRTCDeviceState} options.state 设备变更状态
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onDeviceChange, ({ deviceId, type, state }) => {
-     *   console.log('roomEngine.onReceiveCustomMessage', deviceId, type, state);
-     * });
-     */
-    onDeviceChange = "onDeviceChange",
-    /**
-     * @description 屏幕分享停止事件，当用户使用浏览器自带的【停止分享】按钮结束屏幕共享时，该用户会收到 'onUserScreenCaptureStopped' 事件用来修改屏幕共享状态。
-     * @default 'onUserScreenCaptureStopped'
-     * @event TUIRoomEvents#onUserScreenCaptureStopped
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onUserScreenCaptureStopped, () => {
-     *   console.log('roomEngine.onReceiveCustomMessage', deviceId, type, state);
-     * });
-     */
-    onUserScreenCaptureStopped = "onUserScreenCaptureStopped"
-}
+export declare enum TUIErrorCode {
+    ERR_SUCC = 0,
+    ERR_FAILED = -1,
+    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
+}
+export type TUIRoomInfo = {
+    roomId: string;
+    roomType: TUIRoomType;
+    owner: string;
+    name: string;
+    createTime: number;
+    roomMemberCount: number;
+    maxSeatCount: number;
+    enableVideo: boolean;
+    enableAudio: boolean;
+    enableMessage: boolean;
+    enableSeatControl: boolean;
+};
+export declare enum TUIRole {
+    kRoomOwner = 0,
+    kAdministrator = 1,
+    kGeneralUser = 2
+}
+/**
+ * 消息结构体
+ * @typedef {object} TUIMessage
+ * @property {string} messageId 消息 Id
+ * @property {string} message 消息内容
+ * @property {number} timestamp 时间戳信息, 精确到秒
+ * @property {TUIRole} userId 用户 Id
+ * @property {boolean} userName 用户名称
+ * @property {boolean} avatarUrl 用户头像地址
+ */
+export type TUIMessage = {
+    messageId: string;
+    message: string;
+    timestamp: number;
+    userId: string;
+    userName: string;
+    avatarUrl: string;
+};
+export declare enum TUIVideoProfile {
+    kLowDefinition = 0,
+    kStandardDefinition = 1,
+    kHighDefinition = 2,
+    kSuperDefinition = 3
+}
+export declare enum TUIAudioProfile {
+    kAudioProfileSpeech = 0,
+    kAudioProfileDefault = 1,
+    kAudioProfileMusic = 2
+}
+export declare enum TUIVideoStreamType {
+    kCameraStream = 0,
+    kScreenStream = 1,
+    kCameraStreamLow = 2
+}
+export declare enum TUINetworkQuality {
+    kQualityUnknown = 0,
+    kQualityExcellent = 1,
+    kQualityGood = 2,
+    kQualityPoor = 3,
+    kQualityBad = 4,
+    kQualityVeryBad = 5,
+    kQualityDown = 6
+}
+export declare enum TUIRoomType {
+    kGroup = 1,
+    kOpen = 2
+}
+export declare enum TUICaptureSourceType {
+    kWindow = 0,
+    kScreen = 1
+}
+export declare enum TUIChangeReason {
+    kChangedBySelf = 0,
+    kChangedByAdmin = 1
+}
+export declare enum TUIRequestAction {
+    kInvalidAction = 0,
+    kRequestToOpenRemoteCamera = 1,
+    kRequestToOpenRemoteMicrophone = 2,
+    kRequestToConnectOtherRoom = 3,
+    kRequestToTakeSeat = 4,
+    kRequestRemoteUserOnSeat = 5
+}
+export declare enum TUIRequestCallbackType {
+    kRequestAccepted = 0,
+    kRequestRejected = 1,
+    kRequestCancelled = 2,
+    kRequestTimeout = 3,
+    kRequestError = 4
+}
+export declare enum TRTCRole {
+    kAnchor = 0,
+    kAudience = 1
+}
+export type TUIUserInfo = {
+    userId: string;
+    userName: string;
+    avatarUrl: string;
+    userRole: TUIRole;
+    hasAudioStream: boolean;
+    hasVideoStream: boolean;
+    hasScreenStream: boolean;
+};
+export type TUISeatInfo = {
+    index: number;
+    userId: string;
+    locked: boolean;
+    videoMuted: boolean;
+    audioMuted: boolean;
+};
+export type TUIRequest = {
+    requestAction: TUIRequestAction;
+    timestamp: number;
+    requestId: number;
+    userId: string;
+    content: string;
+};
+export type TUIRequestCallback = {
+    requestCallbackType: TUIRequestCallbackType;
+    requestId: number;
+    userId: string;
+    code: number;
+    message: string;
+};
+/**
+ * **TUIRoomEngine 事件列表**<br>
+ * @namespace TUIRoomEvents
+ * @example
+ * import TUIRoomEngine, { TUIRoomEvents } from '@tencentcloud/tuiroom-engine-electron';
+ * const roomEngine = new TUIRoomEngine();
+ * roomEngine.on(TUIRoomEvents.onError, (error) => {
+ *  console.log('roomEngine.error', error);
+ * })
+ */
+export declare enum TUIRoomEvents {
+    /**
+     *
+     * @description 错误事件
+     * @event TUIRoomEvents#onError
+     * @param {object} options
+     * @param {number} options.code 错误代码
+     * @param {string} options.message 错误信息
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onError, (error) => {
+     *  console.log('TUIRoomError error', error);
+     * })
+     */
+    onError = "onError",
+    /**
+     * @description 踢出房间事件
+     * @default 'onKickedOutOfRoom'
+     * @event TUIRoomEvents#onKickedOutOfRoom
+     * @param {object} options
+     * @param {string} options.roomId 房间号
+     * @param {string} options.message 踢出房间信息
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onKickedOutOfRoom, ({ roomId, message }) => {
+     *   console.log('roomEngine.onKickedOutOfRoom', roomId, message);
+     * });
+     */
+    onKickedOutOfRoom = "onKickedOutOfRoom",
+    /**
+     * @description 当前用户被踢下线
+     * @default 'onKickedOffLine'
+     * @event TUIRoomEvents#onKickedOffLine
+     * @param {string} options.message 用户被踢下线信息
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onKickedOffLine, ({ message }) => {
+     *   console.log('roomEngine.onKickedOffLine', message);
+     * });
+     */
+    onKickedOffLine = "onKickedOffLine",
+    /**
+     * @description userSig 过期事件
+     * @default 'onUserSigExpired'
+     * @event TUIRoomEvents#onUserSigExpired
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onUserSigExpired, () => {
+     *   console.log('roomEngine.onUserSigExpired');
+     * });
+     */
+    onUserSigExpired = "onUserSigExpired",
+    /**
+     * @description 主持人销毁房间事件
+     * @default 'onRoomDismissed'
+     * @event TUIRoomEvents#onRoomDismissed
+     * @param {object} options
+     * @param {string} options.roomId 房间号
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onRoomDismissed, ({ roomId }) => {
+     *   console.log('roomEngine.onRoomDismissed', roomId);
+     * });
+     */
+    onRoomDismissed = "onRoomDismissed",
+    /**
+     * @description 房间信息修改事件
+     * @default 'onRoomInfoChanged'
+     * @event TUIRoomEvents#onRoomInfoChanged
+     * @param {object} options
+     * @param {string} options.roomId  房间号
+     * @param {string} options.roomInfo 房间信息
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onRoomInfoChanged, ({ roomId, roomInfo }) => {
+     *   console.log('roomEngine.onRoomInfoChanged', roomId, roomInfo);
+     * });
+     */
+    onRoomInfoChanged = "onRoomInfoChanged",
+    /**
+     * @description 远端用户进入房间事件
+     * @default 'onRemoteUserEnterRoom'
+     * @event TUIRoomEvents#onRemoteUserEnterRoom
+     * @param {object} options
+     * @param {string} options.roomId 房间号
+     * @param {TUIUserInfo} options.userInfo 用户信息
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onRemoteUserEnterRoom, ({ roomId, userInfo }) => {
+     *   console.log('roomEngine.onRemoteUserEnterRoom', roomId, userInfo);
+     * });
+     */
+    onRemoteUserEnterRoom = "onRemoteUserEnterRoom",
+    /**
+     * @description 远端用户离开房间事件
+     * @default 'onRemoteUserLeaveRoom'
+     * @event TUIRoomEvents#onRemoteUserLeaveRoom
+     * @param {object} options
+     * @param {string} options.roomId 房间号
+     * @param {TUIUserInfo} options.userInfo 用户信息
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onRemoteUserLeaveRoom, ({ roomId, userInfo }) => {
+     *   console.log('roomEngine.onRemoteUserLeaveRoom', roomId, userInfo);
+     * });
+     */
+    onRemoteUserLeaveRoom = "onRemoteUserLeaveRoom",
+    /**
+     * @description 用户角色改变事件
+     * @default 'onKickedOutOfRoom'
+     * @event TUIRoomEvents#onUserRoleChanged
+     * @param {object} options
+     * @param {string} options.userId 用户Id
+     * @param {TUIRole} options.userRole 用户变更后的角色
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onUserRoleChanged, ({ userId, userRole }) => {
+     *   console.log('roomEngine.onUserRoleChanged', userId, userRole);
+     * });
+     */
+    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'
+     * @event TUIRoomEvents#onUserVideoStateChanged
+     * @param {object} options
+     * @param {string} options.userId 用户Id
+     * @param {TUIVideoStreamType} options.streamType 用户流类型
+     * @param {boolean} options.hasVideo 是否有视频流
+     * @param {TUIChangeReason} options.reason 变更原因
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onUserVideoStateChanged, ({ userId, streamType, hasVideo, reason }) => {
+     *   console.log('roomEngine.onUserVideoStateChanged', userId, streamType, hasVideo, reason);
+     * });
+     */
+    onUserVideoStateChanged = "onUserVideoStateChanged",
+    /**
+     * @description 用户音频状态改变事件
+     * @default 'onUserAudioStateChanged'
+     * @event TUIRoomEvents#onUserAudioStateChanged
+     * @param {object} options
+     * @param {string} options.userId 用户Id
+     * @param {boolean} options.hasVideo 是否有音频流
+     * @param {TUIChangeReason} options.reason 原因
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onUserAudioStateChanged, ({ userId, hasAudio, reason }) => {
+     *   console.log('roomEngine.onUserAudioStateChanged', userId, hasAudio, reason);
+     * });
+     */
+    onUserAudioStateChanged = "onUserAudioStateChanged",
+    /**
+     * @description 用户音量改变事件
+     * @default 'onUserVoiceVolumeChanged'
+     * @event TUIRoomEvents#onUserVoiceVolumeChanged
+     * @param {object} options
+     * @param {Array<TRTCVolumeInfo>} options.userVolumeList 房间内所有用户的音量, 包含 userId 及 volume 信息，volume 区间为 1～100;
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onUserVoiceVolumeChanged, ({ userVolumeList }) => {
+     *   userVolumeList.forEach(userVolume => {
+     *     console.log('roomEngine.onUserVoiceVolumeChanged', userVolume.userId, userVolume.volume);
+     *   })
+     * });
+     */
+    onUserVoiceVolumeChanged = "onUserVoiceVolumeChanged",
+    /**
+     * @description 用户网络质量改变事件
+     * @default 'onUserNetworkQualityChanged'
+     * @event TUIRoomEvents#onUserNetworkQualityChanged
+     * @param {object} options
+     * @param {TUINetworkQuality} options.networkMap 遍历网络质量等级
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onUserNetworkQualityChanged, ({ userNetworkList }) => {
+     *   userNetworkList.forEach(userNetwork => {
+     *     console.log('roomEngine.onUserNetworkQualityChanged', userNetwork.userId, userNetwork.volume);
+     *   })
+     * });
+     */
+    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 离开的麦位信息
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onSeatListChanged, ({ seatList, usersSeated, usersLeft }) => {
+     *   console.log('roomEngine.onSeatListChanged',seatList, usersSeated, usersLeft);
+     * });
+     */
+    onSeatListChanged = "onSeatListChanged",
+    /**
+     * @description 请求接收事件
+     * @default 'onRequestReceived'
+     * @event TUIRoomEvents#onRequestReceived
+     * @param {object} options
+     * @param {TUIRequest} options.request 请求接收
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onRequestReceived, ({ request }) => {
+     *   console.log('roomEngine.onRequestReceived', request);
+     * });
+     */
+    onRequestReceived = "onRequestReceived",
+    /**
+     * @description 请求取消事件
+     * @default 'onRequestCancelled'
+     * @event TUIRoomEvents#onRequestCancelled
+     * @param {object} options
+     * @param {string} options.requestId 请求Id
+     * @param {string} options.userId 取消请求的用户Id
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onRequestCancelled, ({ requestId, userId }) => {
+     *   console.log('roomEngine.onRequestCancelled', requestId, userId);
+     * });
+     */
+    onRequestCancelled = "onRequestCancelled",
+    /**
+     * @description 接收文本消息事件
+     * @default 'onReceiveTextMessage'
+     * @event TUIRoomEvents#onReceiveTextMessage
+     * @param {object} options
+     * @param {string} options.roomId 房间Id
+     * @param {TUIMessage} options.message 接收的文本消息
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onReceiveTextMessage, ({ roomId, message }) => {
+     *   console.log('roomEngine.onReceiveTextMessage', roomId, message);
+     * });
+     */
+    onReceiveTextMessage = "onReceiveTextMessage",
+    /**
+     * @description 接收自定义消息事件
+     * @default 'onReceiveCustomMessage'
+     * @event TUIRoomEvents#onReceiveCustomMessage
+     * @param {object} options
+     * @param {string} options.roomId 房间Id
+     * @param {TUIMessage} options.message 接收的自定义消息
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onReceiveCustomMessage, ({ roomId, message }) => {
+     *   console.log('roomEngine.onReceiveCustomMessage', roomId, message);
+     * });
+     */
+    onReceiveCustomMessage = "onReceiveCustomMessage",
+    /**
+     * @description 设备变更事件
+     * @default 'onDeviceChange'
+     * @event TUIRoomEvents#onDeviceChange
+     * @param {object} options
+     * @param {string} options.deviceId 设备 Id
+     * @param {TRTCDeviceType} options.type 设备类型
+     * @param {TRTCDeviceState} options.state 设备变更状态
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onDeviceChange, ({ deviceId, type, state }) => {
+     *   console.log('roomEngine.onReceiveCustomMessage', deviceId, type, state);
+     * });
+     */
+    onDeviceChange = "onDeviceChange",
+    /**
+     * @description 屏幕分享停止事件，当用户使用浏览器自带的【停止分享】按钮结束屏幕共享时，该用户会收到 'onUserScreenCaptureStopped' 事件用来修改屏幕共享状态。
+     * @default 'onUserScreenCaptureStopped'
+     * @event TUIRoomEvents#onUserScreenCaptureStopped
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onUserScreenCaptureStopped, () => {
+     *   console.log('roomEngine.onReceiveCustomMessage', deviceId, type, state);
+     * });
+     */
+    onUserScreenCaptureStopped = "onUserScreenCaptureStopped"
+}