@tencentcloud/tuiroom-engine-js 2.3.1 → 2.3.3

package/index.d.ts

@@ -220,6 +220,10 @@ declare enum TUIResolutionMode {
     kResolutionMode_Landscape = 0,
     kResolutionMode_Portrait = 1
 }
+declare enum TUIRoomDismissedReason {
+    kByOwner = 1,
+    kByServer = 2
+}
 type TUIUserInfo = {
     userId: string;
     userName: string;
@@ -350,10 +354,11 @@ declare enum TUIRoomEvents {
      * @event TUIRoomEvents#onRoomDismissed
      * @param {object} options
      * @param {string} options.roomId 房间号
+     * @param {TUIRoomDismissedReason} options.reason 房间解散原因枚举，该字段自 v2.3.0 开始支持
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onRoomDismissed, ({ roomId }) => {
-     *   console.log('roomEngine.onRoomDismissed', roomId);
+     * roomEngine.on(TUIRoomEvents.onRoomDismissed, ({ roomId,reason }) => {
+     *   console.log('roomEngine.onRoomDismissed', roomId,reason);
      * });
      */
     onRoomDismissed = "onRoomDismissed",
@@ -512,10 +517,11 @@ declare enum TUIRoomEvents {
      * @param {object} options
      * @param {string} options.userId 用户Id
      * @param {TUIRole} options.userRole 用户变更后的角色
+     * @param {TUIUserInfo} options.userInfo 用户信息,该字段自 v2.3.0 开始支持
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onUserRoleChanged, ({ userId, userRole }) => {
-     *   console.log('roomEngine.onUserRoleChanged', userId, userRole);
+     * roomEngine.on(TUIRoomEvents.onUserRoleChanged, ({ userInfo }) => {
+     *   console.log('roomEngine.onUserRoleChanged', userInfo);
      * });
      */
     onUserRoleChanged = "onUserRoleChanged",
@@ -614,10 +620,12 @@ declare enum TUIRoomEvents {
      * @description 当前用户被踢下麦事件
      * @default 'onKickedOffSeat'
      * @event TUIRoomEvents#onKickedOffSeat
+     * @param {number} options.seatIndex 麦位编号，该字段自 v2.3.0 开始支持
+     * @param {TUIUserInfo} options.userInfo 操作踢人的（主持人/管理员）用户信息，该字段自 v2.3.0 开始支持
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onKickedOffSeat, ({ userId }) => {
-     *   console.log('roomEngine.onKickedOffSeat', userId);
+     * roomEngine.on(TUIRoomEvents.onKickedOffSeat, ({ seatIndex, userInfo }) => {
+     *   console.log('roomEngine.onKickedOffSeat', seatIndex, userInfo);
      * });
      */
     onKickedOffSeat = "onKickedOffSeat",
@@ -641,10 +649,12 @@ declare enum TUIRoomEvents {
      * @param {object} options
      * @param {string} options.requestId 请求Id
      * @param {string} options.userId 取消请求的用户Id
+     * @param {TUIRequest} options.request 请求信息，该字段自 v2.3.0 开始支持
+     * @param {TUIUserInfo} options.userInfo 处理该请求的 管理员/房主 的用户信息，该字段自 v2.3.0 开始支持
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onRequestCancelled, ({ requestId, userId }) => {
-     *   console.log('roomEngine.onRequestCancelled', requestId, userId);
+     * roomEngine.on(TUIRoomEvents.onRequestCancelled, ({ request, userInfo }) => {
+     *   console.log('roomEngine.onRequestCancelled', request, userInfo);
      * });
      */
     onRequestCancelled = "onRequestCancelled",
@@ -655,10 +665,12 @@ declare enum TUIRoomEvents {
      * @param {object} options
      * @param {string} options.requestId 请求Id
      * @param {string} options.userId 处理该请求的 管理员/房主 的用户ID
+     * @param {TUIRequest} options.request 请求信息，该字段自 v2.3.0 开始支持
+     * @param {TUIUserInfo} options.userInfo 处理该请求的 管理员/房主 的用户信息，该字段自 v2.3.0 开始支持
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onRequestProcessed, ({ requestId, userId }) => {
-     *   console.log('roomEngine.onRequestProcessed', requestId, userId);
+     * roomEngine.on(TUIRoomEvents.onRequestProcessed, ({ request, userInfo }) => {
+     *   console.log('roomEngine.onRequestProcessed', request, userInfo);
      * });
      */
     onRequestProcessed = "onRequestProcessed",
@@ -1549,12 +1561,12 @@ declare class TUIRoomEngine {
      * @param {TUIMediaDevice} options.device 请求的设备
      * @param {number} options.timeout 超时时间。若 timeout 设置为 0 ，则无超时时间
      * @param {Function} 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
-     * @return {Promise<number>} <br/>
-     * 该接口返回 requestId，用户可使用该 requestId 调用 cancelRequest 接口取消请求
+     * @return {Promise<TUIRequest>} <br/>
+     * 该接口返回 request 结构体，当 request.requestId 不为 '' 时，用户可调用 cancelRequest 接口取消请求。
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const requestId = roomEngine.openRemoteDeviceByAdmin({
+     * const request = roomEngine.openRemoteDeviceByAdmin({
      *   userId: 'user_1234',
      *   device: TUIMediaDevice.kMicrophone  //请求的设备为麦克风
      *   timeout: 0,
@@ -1594,12 +1606,12 @@ declare class TUIRoomEngine {
      * @param {TUIMediaDevice} options.device 请求的设备
      * @param {number} options.timeout 超时时间。若 timeout 设置为 0 ，则无超时时间
      * @param {Function} 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
-     * @return {Promise<number>} <br/>
-     * 该接口返回 requestId，用户可使用该 requestId 调用 cancelRequest 接口取消请求
+     * @return {Promise<TUIRequest>} <br/>
+     * 该接口返回 request 结构体，当 request.requestId 不为 '' 时，用户可调用 cancelRequest 接口取消请求。
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const requestId = roomEngine.applyToAdminToOpenLocalDevice({
+     * const request = roomEngine.applyToAdminToOpenLocalDevice({
      *   device: TUIMediaDevice.kMicrophone, //请求打开麦克风
      *   timeout: 0,
      *   requestCallback: ({ requestCallbackType, requestId, userId, code, message }) => {
@@ -1816,7 +1828,7 @@ declare class TUIRoomEngine {
      * @param {number} options.seatIndex 麦位 index, 无麦位序号时设置为 -1
      * @param {number} options.timeout 超时时间。若 timeout 设置为 0，则无超时时间
      * @param {Function} options.requestCallback 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
-     * @returns {Promise<number>} <br/>
+     * @returns {Promise<TUIRequest>} <br/>
      * 该接口返回 request 结构体，当 request.requestId 不为 '' 时，用户可调用 cancelRequest 接口取消上麦请求。
      *
      * @example
@@ -1877,12 +1889,12 @@ declare class TUIRoomEngine {
      * @param {string} options.userId  用户 Id
      * @param {number} options.timeout  超时时间，设置为 0 时，无超时时间
      * @param {Function} options.requestCallback 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
-     * @returns {Promise<number>} <br/>
-     * 该接口返回 requestId，用户可使用该 requestId 调用 cancelRequest 接口取消请求
+     * @returns {Promise<TUIRequest>} <br/>
+     * 该接口返回 request 结构体，当 request.requestId 不为 '' 时，用户可调用 cancelRequest 接口取消请求。
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const requestId = await roomEngine.takeUserOnSeatByAdmin({
+     * const request = await roomEngine.takeUserOnSeatByAdmin({
      *   seatIndex: 0,
      *   userId: 'user_1234',
      *   timeout: 0,
@@ -2090,6 +2102,7 @@ declare class TUIRoomEngine {
      */
     on(event: TUIRoomEvents, func: (...args: any[]) => void): void;
     private setObserver;
+    private supportForDeprecatedEvents;
     /**
      * 取消监听 roomEngine 的事件
      * @param event TUIRoomEvents
@@ -2285,4 +2298,4 @@ declare class TUIRoomEngine {
     private static handleSetFramework;
 }
 
-export { TRTCRole, TUIAudioQuality, TUIAudioRoute, TUICaptureSourceType, TUIChangeReason, type TUIDeviceInfo, TUIErrorCode, TUIKickedOutOfRoomReason, type TUILoginUserInfo, TUIMediaDevice, TUIMediaDeviceState, TUIMediaDeviceType, type TUIMessage, type TUINetwork, TUINetworkQuality, type TUIRequest, TUIRequestAction, type TUIRequestCallback, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomEvents, type TUIRoomInfo, TUIRoomType, type TUISeatInfo, type TUISeatLockParams, TUISeatMode, TUISpeechMode, type TUIUserInfo, type TUIVideoEncoderParams, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };
+export { TRTCRole, TUIAudioQuality, TUIAudioRoute, TUICaptureSourceType, TUIChangeReason, type TUIDeviceInfo, TUIErrorCode, TUIKickedOutOfRoomReason, type TUILoginUserInfo, TUIMediaDevice, TUIMediaDeviceState, TUIMediaDeviceType, type TUIMessage, type TUINetwork, TUINetworkQuality, type TUIRequest, TUIRequestAction, type TUIRequestCallback, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomDismissedReason, TUIRoomEvents, type TUIRoomInfo, TUIRoomType, type TUISeatInfo, type TUISeatLockParams, TUISeatMode, TUISpeechMode, type TUIUserInfo, type TUIVideoEncoderParams, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };