@tencentcloud/tuiroom-engine-js 3.0.0 → 3.0.2

package/index.d.ts

@@ -333,6 +333,16 @@ type TUIConferenceModifyInfo = {
         roomName?: string;
     };
 };
+/**
+ * 自动播放失败时回调参数结构体
+ *
+ * userId 用户ID
+ * resume 恢复播放的回调函数
+ */
+type TUIAutoPlayCallbackInfo = {
+    userId: string;
+    resume: () => void;
+};
 declare enum TUIInvitationStatus {
     kNone = 0,
     kPending = 1,
@@ -799,7 +809,18 @@ declare enum TUIRoomEvents {
      *   console.log('roomEngine.onUserScreenCaptureStopped');
      * });
      */
-    onUserScreenCaptureStopped = "onUserScreenCaptureStopped"
+    onUserScreenCaptureStopped = "onUserScreenCaptureStopped",
+    /**
+     * @description 自动播放失败的事件，监听到该事件后可以引导用户与页面进行交互
+     * @default 'onAutoPlayFailed'
+     * @event TUIRoomEvents#onAutoPlayFailed
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onAutoPlayFailed, ({userId, resume}) => {
+     *   // 自动播放失败，引导用户与页面进行交互
+     * });
+     */
+    onAutoPlayFailed = "onAutoPlayFailed"
 }
 declare enum TUIRoomDeviceMangerEvents {
     /**
@@ -1186,11 +1207,11 @@ declare enum TUILiveLayoutManagerEvents {
      * const roomEngine = new TUIRoomEngine();
      * const liveLayoutManager = roomEngine.getLiveLayoutManager();
      * const callback = (roomId, layoutInfo) => {
-     *   console.log('liveLayoutManager.onLiveVideoLayoutListChanged', roomId, layoutInfo);
+     *   console.log('liveLayoutManager.onLiveVideoLayoutChanged', roomId, layoutInfo);
      * };
-     * liveLayoutManager.on(TUILiveLayoutManagerEvents.onLiveVideoLayoutListChanged, callback);
+     * liveLayoutManager.on(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, callback);
      */
-    onLiveVideoLayoutListChanged = "onLiveVideoLayoutListChanged"
+    onLiveVideoLayoutChanged = "onLiveVideoLayoutListChanged"
 }
 
 declare class Logger {
@@ -1919,9 +1940,9 @@ declare class TUILiveLayoutManager {
      * const roomEngine = new TUIRoomEngine();
      * const liveLayoutManager = roomEngine.getLiveLayoutManager();
      * const callback = (roomId, layoutInfo) => {
-     *   console.log('liveLayoutManager.onLiveVideoLayoutListChanged', roomId, layoutInfo);
+     *   console.log('liveLayoutManager.onLiveVideoLayoutChanged', roomId, layoutInfo);
      * };
-     * liveLayoutManager.on(TUILiveLayoutManagerEvents.onLiveVideoLayoutListChanged, callback);
+     * liveLayoutManager.on(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, callback);
      */
     on(event: TUILiveLayoutManagerEvents, func: (...args: any[]) => void): void;
     /**
@@ -1933,9 +1954,9 @@ declare class TUILiveLayoutManager {
      * const roomEngine = new TUIRoomEngine();
      * const liveLayoutManager = roomEngine.getLiveLayoutManager();
      * const callback = (roomId, layoutInfo) => {
-     *   console.log('liveLayoutManager.onLiveVideoLayoutListChanged', roomId, layoutInfo);
+     *   console.log('liveLayoutManager.onLiveVideoLayoutChanged', roomId, layoutInfo);
      * };
-     * liveLayoutManager.off(TUILiveLayoutManagerEvents.onLiveVideoLayoutListChanged, callback);
+     * liveLayoutManager.off(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, callback);
      */
     off(event: TUILiveLayoutManagerEvents, func: (...args: any[]) => void): void;
     /**
@@ -3179,6 +3200,7 @@ declare class TUIRoomEngine {
      */
     off(event: string, func: (...args: any[]) => void): void;
     private handleTrtcCloudBindEvent;
+    private handleTrtcAutoPlayFailedEvent;
     /**
      * 获取摄像头设备列表<br>
      * @returns {Promise<TRTCDeviceInfo[]>} 摄像头列表
@@ -3407,4 +3429,4 @@ declare class TUIRoomEngine {
 }
 
 export { TRTCRole, TUIAudioQuality, TUIAudioRoute, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, TUIConferenceInvitationManager, TUIConferenceInvitationManagerEvents, TUIConferenceListManager, TUIConferenceListManagerEvents, TUIConferenceStatus, TUIErrorCode, TUIInvitationCode, TUIInvitationRejectedReason, TUIInvitationStatus, TUIKickedOutOfRoomReason, TUILiveLayoutManagerEvents, TUILiveListManagerEvents, TUILiveModifyFlag, TUIMediaDevice, TUIMediaDeviceState, TUIMediaDeviceType, TUINetworkQuality, TUIRequestAction, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomDismissedReason, TUIRoomEvents, TUIRoomType, TUISeatMode, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };
-export type { TUIConferenceInfo, TUIConferenceModifyInfo, TUIDeviceInfo, TUIEnterRoomOptions, TUIInvitation, TUILiveInfo, TUILiveListResult, TUILiveModifyInfo, TUILoginUserInfo, TUIMessage, TUINetwork, TUIRequest, TUIRequestCallback, TUIRoomInfo, TUISeatInfo, TUISeatLockParams, TUIUserInfo, TUIVideoEncoderParams };
+export type { TUIAutoPlayCallbackInfo, TUIConferenceInfo, TUIConferenceModifyInfo, TUIDeviceInfo, TUIEnterRoomOptions, TUIInvitation, TUILiveInfo, TUILiveListResult, TUILiveModifyInfo, TUILoginUserInfo, TUIMessage, TUINetwork, TUIRequest, TUIRequestCallback, TUIRoomInfo, TUISeatInfo, TUISeatLockParams, TUIUserInfo, TUIVideoEncoderParams };