tuikit-atomicx-vue3 4.4.0 → 4.5.0

package/dist/states/LiveSeatState/seatManager.d.ts

@@ -1,45 +1,332 @@
 import { DeviceControlPolicy, MoveSeatPolicy } from '../../types/seat';
 
+/**
+ * 麦位管理器类
+ * @description 单例模式的麦位管理器，提供所有麦位相关的操作方法
+ */
 declare class SeatManager {
     static instance: SeatManager;
+    /**
+     * 构造函数
+     * @description 创建麦位管理器实例，使用单例模式
+     */
     constructor();
+    /**
+     * 用户上麦
+     * @memberof module:LiveSeatState/seatManager
+     * @description 用户申请上到指定麦位，普通用户直接上麦，管理员需要使用其他方式
+     * @param {Object} params - 上麦参数
+     * @param {number} params.seatIndex - 麦位索引
+     * @returns {Promise<any>} 上麦操作的Promise
+     * @throws {Error} 当管理员尝试使用此方法时抛出错误
+     * @example
+     * ```typescript
+     * const { takeSeat } = useLiveSeatState();
+     *
+     * // 用户上到1号麦位
+     * try {
+     *   await takeSeat({ seatIndex: 1 });
+     *   console.log('上麦成功');
+     * } catch (error) {
+     *   console.error('上麦失败:', error);
+     * }
+     * ```
+     */
     takeSeat({ seatIndex }: {
         seatIndex: number;
-    }): Promise<import('@tencentcloud/tuiroom-engine-js').TUIRequest | undefined>;
-    leaveSeat(): Promise<void | undefined>;
+    }): Promise<any>;
+    /**
+     * 用户下麦
+     * @memberof module:LiveSeatState/seatManager
+     * @description 用户主动离开当前麦位
+     * @returns {Promise<any>} 下麦操作的Promise
+     * @example
+     * ```typescript
+     * const { leaveSeat } = useLiveSeatState();
+     *
+     * // 用户下麦
+     * try {
+     *   await leaveSeat();
+     *   console.log('下麦成功');
+     * } catch (error) {
+     *   console.error('下麦失败:', error);
+     * }
+     * ```
+     */
+    leaveSeat(): Promise<any>;
+    /**
+     * 锁定麦位
+     * @memberof module:LiveSeatState/seatManager
+     * @description 管理员锁定指定麦位，防止用户上麦
+     * @param {Object} params - 锁定参数
+     * @param {number} params.seatIndex - 要锁定的麦位索引
+     * @returns {Promise<any>} 锁定操作的Promise
+     * @example
+     * ```typescript
+     * const { lockSeat } = useLiveSeatState();
+     *
+     * // 锁定2号麦位
+     * try {
+     *   await lockSeat({ seatIndex: 2 });
+     *   console.log('麦位锁定成功');
+     * } catch (error) {
+     *   console.error('麦位锁定失败:', error);
+     * }
+     * ```
+     */
     lockSeat({ seatIndex }: {
         seatIndex: number;
     }): Promise<any>;
+    /**
+     * 解锁麦位
+     * @memberof module:LiveSeatState/seatManager
+     * @description 管理员解锁指定麦位，允许用户上麦
+     * @param {Object} params - 解锁参数
+     * @param {number} params.seatIndex - 要解锁的麦位索引
+     * @returns {Promise<any>} 解锁操作的Promise
+     * @example
+     * ```typescript
+     * const { unLockSeat } = useLiveSeatState();
+     *
+     * // 解锁2号麦位
+     * try {
+     *   await unLockSeat({ seatIndex: 2 });
+     *   console.log('麦位解锁成功');
+     * } catch (error) {
+     *   console.error('麦位解锁失败:', error);
+     * }
+     * ```
+     */
     unLockSeat({ seatIndex }: {
         seatIndex: number;
     }): Promise<any>;
+    /**
+     * 踢用户下麦
+     * @memberof module:LiveSeatState/seatManager
+     * @description 管理员强制将指定用户踢下麦位
+     * @param {Object} params - 踢人参数
+     * @param {string} params.userId - 要踢下麦的用户ID
+     * @returns {Promise<any>} 踢人操作的Promise
+     * @example
+     * ```typescript
+     * const { kickUserOutOfSeat } = useLiveSeatState();
+     *
+     * // 踢用户下麦
+     * try {
+     *   await kickUserOutOfSeat({ userId: 'user123' });
+     *   console.log('用户已被踢下麦');
+     * } catch (error) {
+     *   console.error('踢人失败:', error);
+     * }
+     * ```
+     */
     kickUserOutOfSeat({ userId }: {
         userId: string;
-    }): Promise<void>;
+    }): Promise<any>;
+    /**
+     * 移动用户到指定麦位
+     * @memberof module:LiveSeatState/seatManager
+     * @description 管理员将用户移动到指定的麦位，支持不同的移动策略
+     * @param {Object} params - 移动参数
+     * @param {string} params.userId - 要移动的用户ID
+     * @param {number} params.targetIndex - 目标麦位索引
+     * @param {MoveSeatPolicy} params.policy - 移动策略
+     * @returns {Promise<any>} 移动操作的Promise
+     * @example
+     * ```typescript
+     * const { moveUserToSeat } = useLiveSeatState();
+     *
+     * // 将用户移动到3号麦位，如果被占用则强制替换
+     * try {
+     *   await moveUserToSeat({
+     *     userId: 'user123',
+     *     targetIndex: 3,
+     *     policy: MoveSeatPolicy.ForceReplace
+     *   });
+     *   console.log('用户移动成功');
+     * } catch (error) {
+     *   console.error('用户移动失败:', error);
+     * }
+     * ```
+     */
     moveUserToSeat({ userId, targetIndex, policy }: {
         userId: string;
         targetIndex: number;
         policy: MoveSeatPolicy;
-    }): Promise<void>;
+    }): Promise<any>;
+    /**
+     * 关闭远端摄像头
+     * @memberof module:LiveSeatState/seatManager
+     * @description 管理员强制关闭指定用户的摄像头
+     * @param {Object} params - 关闭参数
+     * @param {string} params.userId - 要关闭摄像头的用户ID
+     * @returns {Promise<any>} 关闭操作的Promise
+     * @example
+     * ```typescript
+     * const { closeRemoteCamera } = useLiveSeatState();
+     *
+     * // 关闭用户摄像头
+     * try {
+     *   await closeRemoteCamera({ userId: 'user123' });
+     *   console.log('用户摄像头已关闭');
+     * } catch (error) {
+     *   console.error('关闭摄像头失败:', error);
+     * }
+     * ```
+     */
     closeRemoteCamera({ userId }: {
         userId: string;
-    }): Promise<void | undefined>;
+    }): Promise<any>;
+    /**
+     * 关闭远端麦克风
+     * @memberof module:LiveSeatState/seatManager
+     * @description 管理员强制关闭指定用户的麦克风
+     * @param {Object} params - 关闭参数
+     * @param {string} params.userId - 要关闭麦克风的用户ID
+     * @returns {Promise<any>} 关闭操作的Promise
+     * @example
+     * ```typescript
+     * const { closeRemoteMicrophone } = useLiveSeatState();
+     *
+     * // 关闭用户麦克风
+     * try {
+     *   await closeRemoteMicrophone({ userId: 'user123' });
+     *   console.log('用户麦克风已关闭');
+     * } catch (error) {
+     *   console.error('关闭麦克风失败:', error);
+     * }
+     * ```
+     */
     closeRemoteMicrophone({ userId }: {
         userId: string;
-    }): Promise<void | undefined>;
+    }): Promise<any>;
+    /**
+     * 开启远端摄像头
+     * @memberof module:LiveSeatState/seatManager
+     * @description 管理员解锁指定用户的摄像头，允许用户开启摄像头
+     * @param {Object} params - 开启参数
+     * @param {string} params.userId - 要开启摄像头的用户ID
+     * @param {DeviceControlPolicy} params.policy - 设备控制策略
+     * @returns {Promise<any>} 开启操作的Promise
+     * @example
+     * ```typescript
+     * const { openRemoteCamera } = useLiveSeatState();
+     *
+     * // 允许用户开启摄像头
+     * try {
+     *   await openRemoteCamera({
+     *     userId: 'user123',
+     *     policy: DeviceControlPolicy.AllowOpen
+     *   });
+     *   console.log('用户摄像头已解锁');
+     * } catch (error) {
+     *   console.error('解锁摄像头失败:', error);
+     * }
+     * ```
+     */
     openRemoteCamera({ userId, policy }: {
         userId: string;
         policy: DeviceControlPolicy;
     }): Promise<any>;
+    /**
+     * 开启远端麦克风
+     * @memberof module:LiveSeatState/seatManager
+     * @description 管理员解锁指定用户的麦克风，允许用户开启麦克风
+     * @param {Object} params - 开启参数
+     * @param {string} params.userId - 要开启麦克风的用户ID
+     * @param {DeviceControlPolicy} params.policy - 设备控制策略
+     * @returns {Promise<any>} 开启操作的Promise
+     * @example
+     * ```typescript
+     * const { openRemoteMicrophone } = useLiveSeatState();
+     *
+     * // 允许用户开启麦克风
+     * try {
+     *   await openRemoteMicrophone({
+     *     userId: 'user123',
+     *     policy: DeviceControlPolicy.AllowOpen
+     *   });
+     *   console.log('用户麦克风已解锁');
+     * } catch (error) {
+     *   console.error('解锁麦克风失败:', error);
+     * }
+     * ```
+     */
     openRemoteMicrophone({ userId, policy }: {
         userId: string;
         policy: DeviceControlPolicy;
     }): Promise<any>;
+    /**
+     * 静音本地麦克风
+     * @memberof module:LiveSeatState/seatManager
+     * @description 用户静音自己的麦克风
+     * @returns {Promise<void>} 静音操作的Promise
+     * @example
+     * ```typescript
+     * const { muteMicrophone } = useLiveSeatState();
+     *
+     * // 静音麦克风
+     * await muteMicrophone();
+     * console.log('麦克风已静音');
+     * ```
+     */
     muteMicrophone(): Promise<void>;
+    /**
+     * 取消静音本地麦克风
+     * @memberof module:LiveSeatState/seatManager
+     * @description 用户取消静音自己的麦克风
+     * @returns {Promise<void>} 取消静音操作的Promise
+     * @example
+     * ```typescript
+     * const { unmuteMicrophone } = useLiveSeatState();
+     *
+     * // 取消静音麦克风
+     * await unmuteMicrophone();
+     * console.log('麦克风已取消静音');
+     * ```
+     */
     unmuteMicrophone(): Promise<void>;
+    /**
+     * 开始播放流
+     * @memberof module:LiveSeatState/seatManager
+     * @description 开始播放麦位的音视频流
+     * @param {Object} params - 播放参数
+     * @param {string} params.view - 视频容器元素ID
+     * @returns {Promise<any>} 播放操作的Promise
+     * @example
+     * ```typescript
+     * const { startPlayStream } = useLiveSeatState();
+     *
+     * // 开始播放流到指定容器
+     * try {
+     *   await startPlayStream({ view: 'video-container' });
+     *   console.log('开始播放流');
+     * } catch (error) {
+     *   console.error('播放流失败:', error);
+     * }
+     * ```
+     */
     startPlayStream({ view }: {
         view: string;
     }): Promise<void>;
+    /**
+     * 停止播放流
+     * @memberof module:LiveSeatState/seatManager
+     * @description 停止播放麦位的音视频流
+     * @returns {Promise<any>} 停止操作的Promise
+     * @example
+     * ```typescript
+     * const { stopPlayStream } = useLiveSeatState();
+     *
+     * // 停止播放流
+     * try {
+     *   await stopPlayStream();
+     *   console.log('已停止播放流');
+     * } catch (error) {
+     *   console.error('停止播放流失败:', error);
+     * }
+     * ```
+     */
     stopPlayStream(): Promise<void>;
 }
 export default SeatManager;

package/dist/states/LiveSeatState/seatManager.js

@@ -8,9 +8,34 @@ import { TUIRole as U, TUIMoveSeatPolicy as u, TUIMediaDevice as f } from "@tenc
 import { useSeatStore as L } from "./store.js";
 import { MoveSeatPolicy as d } from "../../types/seat.js";
 const i = A(), { startPlayStream: P, stopPlayStream: R } = I(), { loginUserInfo: g } = v(), { seatList: S } = L(), l = class l {
+  /**
+   * 构造函数
+   * @description 创建麦位管理器实例，使用单例模式
+   */
   constructor() {
     l.instance || (l.instance = this);
   }
+  /**
+   * 用户上麦
+   * @memberof module:LiveSeatState/seatManager
+   * @description 用户申请上到指定麦位，普通用户直接上麦，管理员需要使用其他方式
+   * @param {Object} params - 上麦参数
+   * @param {number} params.seatIndex - 麦位索引
+   * @returns {Promise<any>} 上麦操作的Promise
+   * @throws {Error} 当管理员尝试使用此方法时抛出错误
+   * @example
+   * ```typescript
+   * const { takeSeat } = useLiveSeatState();
+   * 
+   * // 用户上到1号麦位
+   * try {
+   *   await takeSeat({ seatIndex: 1 });
+   *   console.log('上麦成功');
+   * } catch (error) {
+   *   console.error('上麦失败:', error);
+   * }
+   * ```
+   */
   async takeSeat({ seatIndex: e }) {
     var o, a, n;
     if ((await ((a = i.instance) == null ? void 0 : a.getUserInfo({ userId: ((o = g.value) == null ? void 0 : o.userId) || "" }))).userRole === U.kAdministrator)
@@ -20,10 +45,48 @@ const i = A(), { startPlayStream: P, stopPlayStream: R } = I(), { loginUserInfo:
       timeout: 0
     }));
   }
+  /**
+   * 用户下麦
+   * @memberof module:LiveSeatState/seatManager
+   * @description 用户主动离开当前麦位
+   * @returns {Promise<any>} 下麦操作的Promise
+   * @example
+   * ```typescript
+   * const { leaveSeat } = useLiveSeatState();
+   * 
+   * // 用户下麦
+   * try {
+   *   await leaveSeat();
+   *   console.log('下麦成功');
+   * } catch (error) {
+   *   console.error('下麦失败:', error);
+   * }
+   * ```
+   */
   async leaveSeat() {
     var e;
     return await ((e = i.instance) == null ? void 0 : e.leaveSeat());
   }
+  /**
+   * 锁定麦位
+   * @memberof module:LiveSeatState/seatManager
+   * @description 管理员锁定指定麦位，防止用户上麦
+   * @param {Object} params - 锁定参数
+   * @param {number} params.seatIndex - 要锁定的麦位索引
+   * @returns {Promise<any>} 锁定操作的Promise
+   * @example
+   * ```typescript
+   * const { lockSeat } = useLiveSeatState();
+   * 
+   * // 锁定2号麦位
+   * try {
+   *   await lockSeat({ seatIndex: 2 });
+   *   console.log('麦位锁定成功');
+   * } catch (error) {
+   *   console.error('麦位锁定失败:', error);
+   * }
+   * ```
+   */
   async lockSeat({ seatIndex: e }) {
     var a, n;
     const t = await ((a = i.instance) == null ? void 0 : a.getSeatList()), o = t == null ? void 0 : t.find((c) => c.index === e);
@@ -37,6 +100,26 @@ const i = A(), { startPlayStream: P, stopPlayStream: R } = I(), { loginUserInfo:
         }
       }));
   }
+  /**
+   * 解锁麦位
+   * @memberof module:LiveSeatState/seatManager
+   * @description 管理员解锁指定麦位，允许用户上麦
+   * @param {Object} params - 解锁参数
+   * @param {number} params.seatIndex - 要解锁的麦位索引
+   * @returns {Promise<any>} 解锁操作的Promise
+   * @example
+   * ```typescript
+   * const { unLockSeat } = useLiveSeatState();
+   * 
+   * // 解锁2号麦位
+   * try {
+   *   await unLockSeat({ seatIndex: 2 });
+   *   console.log('麦位解锁成功');
+   * } catch (error) {
+   *   console.error('麦位解锁失败:', error);
+   * }
+   * ```
+   */
   async unLockSeat({ seatIndex: e }) {
     var a, n;
     const t = await ((a = i.instance) == null ? void 0 : a.getSeatList()), o = t == null ? void 0 : t.find((c) => c.index === e);
@@ -50,6 +133,26 @@ const i = A(), { startPlayStream: P, stopPlayStream: R } = I(), { loginUserInfo:
         }
       }));
   }
+  /**
+   * 踢用户下麦
+   * @memberof module:LiveSeatState/seatManager
+   * @description 管理员强制将指定用户踢下麦位
+   * @param {Object} params - 踢人参数
+   * @param {string} params.userId - 要踢下麦的用户ID
+   * @returns {Promise<any>} 踢人操作的Promise
+   * @example
+   * ```typescript
+   * const { kickUserOutOfSeat } = useLiveSeatState();
+   * 
+   * // 踢用户下麦
+   * try {
+   *   await kickUserOutOfSeat({ userId: 'user123' });
+   *   console.log('用户已被踢下麦');
+   * } catch (error) {
+   *   console.error('踢人失败:', error);
+   * }
+   * ```
+   */
   async kickUserOutOfSeat({ userId: e }) {
     var o;
     const t = S.value.find((a) => {
@@ -62,6 +165,32 @@ const i = A(), { startPlayStream: P, stopPlayStream: R } = I(), { loginUserInfo:
         userId: e
       }));
   }
+  /**
+   * 移动用户到指定麦位
+   * @memberof module:LiveSeatState/seatManager
+   * @description 管理员将用户移动到指定的麦位，支持不同的移动策略
+   * @param {Object} params - 移动参数
+   * @param {string} params.userId - 要移动的用户ID
+   * @param {number} params.targetIndex - 目标麦位索引
+   * @param {MoveSeatPolicy} params.policy - 移动策略
+   * @returns {Promise<any>} 移动操作的Promise
+   * @example
+   * ```typescript
+   * const { moveUserToSeat } = useLiveSeatState();
+   * 
+   * // 将用户移动到3号麦位，如果被占用则强制替换
+   * try {
+   *   await moveUserToSeat({
+   *     userId: 'user123',
+   *     targetIndex: 3,
+   *     policy: MoveSeatPolicy.ForceReplace
+   *   });
+   *   console.log('用户移动成功');
+   * } catch (error) {
+   *   console.error('用户移动失败:', error);
+   * }
+   * ```
+   */
   async moveUserToSeat({ userId: e, targetIndex: t, policy: o }) {
     var c;
     if (!S.value.find((s) => {
@@ -80,6 +209,26 @@ const i = A(), { startPlayStream: P, stopPlayStream: R } = I(), { loginUserInfo:
       policy: n[o]
     }));
   }
+  /**
+   * 关闭远端摄像头
+   * @memberof module:LiveSeatState/seatManager
+   * @description 管理员强制关闭指定用户的摄像头
+   * @param {Object} params - 关闭参数
+   * @param {string} params.userId - 要关闭摄像头的用户ID
+   * @returns {Promise<any>} 关闭操作的Promise
+   * @example
+   * ```typescript
+   * const { closeRemoteCamera } = useLiveSeatState();
+   * 
+   * // 关闭用户摄像头
+   * try {
+   *   await closeRemoteCamera({ userId: 'user123' });
+   *   console.log('用户摄像头已关闭');
+   * } catch (error) {
+   *   console.error('关闭摄像头失败:', error);
+   * }
+   * ```
+   */
   async closeRemoteCamera({ userId: e }) {
     var t;
     return await ((t = i.instance) == null ? void 0 : t.closeRemoteDeviceByAdmin({
@@ -87,6 +236,26 @@ const i = A(), { startPlayStream: P, stopPlayStream: R } = I(), { loginUserInfo:
       device: f.kCamera
     }));
   }
+  /**
+   * 关闭远端麦克风
+   * @memberof module:LiveSeatState/seatManager
+   * @description 管理员强制关闭指定用户的麦克风
+   * @param {Object} params - 关闭参数
+   * @param {string} params.userId - 要关闭麦克风的用户ID
+   * @returns {Promise<any>} 关闭操作的Promise
+   * @example
+   * ```typescript
+   * const { closeRemoteMicrophone } = useLiveSeatState();
+   * 
+   * // 关闭用户麦克风
+   * try {
+   *   await closeRemoteMicrophone({ userId: 'user123' });
+   *   console.log('用户麦克风已关闭');
+   * } catch (error) {
+   *   console.error('关闭麦克风失败:', error);
+   * }
+   * ```
+   */
   async closeRemoteMicrophone({ userId: e }) {
     var t;
     return await ((t = i.instance) == null ? void 0 : t.closeRemoteDeviceByAdmin({
@@ -94,6 +263,30 @@ const i = A(), { startPlayStream: P, stopPlayStream: R } = I(), { loginUserInfo:
       device: f.kMicrophone
     }));
   }
+  /**
+   * 开启远端摄像头
+   * @memberof module:LiveSeatState/seatManager
+   * @description 管理员解锁指定用户的摄像头，允许用户开启摄像头
+   * @param {Object} params - 开启参数
+   * @param {string} params.userId - 要开启摄像头的用户ID
+   * @param {DeviceControlPolicy} params.policy - 设备控制策略
+   * @returns {Promise<any>} 开启操作的Promise
+   * @example
+   * ```typescript
+   * const { openRemoteCamera } = useLiveSeatState();
+   * 
+   * // 允许用户开启摄像头
+   * try {
+   *   await openRemoteCamera({ 
+   *     userId: 'user123',
+   *     policy: DeviceControlPolicy.AllowOpen
+   *   });
+   *   console.log('用户摄像头已解锁');
+   * } catch (error) {
+   *   console.error('解锁摄像头失败:', error);
+   * }
+   * ```
+   */
   async openRemoteCamera({ userId: e, policy: t }) {
     var n, c;
     const o = await ((n = i.instance) == null ? void 0 : n.getSeatList()), a = o == null ? void 0 : o.find((s) => (s == null ? void 0 : s.userId) === e);
@@ -107,6 +300,30 @@ const i = A(), { startPlayStream: P, stopPlayStream: R } = I(), { loginUserInfo:
         }
       }));
   }
+  /**
+   * 开启远端麦克风
+   * @memberof module:LiveSeatState/seatManager
+   * @description 管理员解锁指定用户的麦克风，允许用户开启麦克风
+   * @param {Object} params - 开启参数
+   * @param {string} params.userId - 要开启麦克风的用户ID
+   * @param {DeviceControlPolicy} params.policy - 设备控制策略
+   * @returns {Promise<any>} 开启操作的Promise
+   * @example
+   * ```typescript
+   * const { openRemoteMicrophone } = useLiveSeatState();
+   * 
+   * // 允许用户开启麦克风
+   * try {
+   *   await openRemoteMicrophone({ 
+   *     userId: 'user123',
+   *     policy: DeviceControlPolicy.AllowOpen
+   *   });
+   *   console.log('用户麦克风已解锁');
+   * } catch (error) {
+   *   console.error('解锁麦克风失败:', error);
+   * }
+   * ```
+   */
   async openRemoteMicrophone({ userId: e, policy: t }) {
     var n, c;
     const o = await ((n = i.instance) == null ? void 0 : n.getSeatList()), a = o == null ? void 0 : o.find((s) => (s == null ? void 0 : s.userId) === e);
@@ -120,17 +337,83 @@ const i = A(), { startPlayStream: P, stopPlayStream: R } = I(), { loginUserInfo:
         }
       }));
   }
+  /**
+   * 静音本地麦克风
+   * @memberof module:LiveSeatState/seatManager
+   * @description 用户静音自己的麦克风
+   * @returns {Promise<void>} 静音操作的Promise
+   * @example
+   * ```typescript
+   * const { muteMicrophone } = useLiveSeatState();
+   * 
+   * // 静音麦克风
+   * await muteMicrophone();
+   * console.log('麦克风已静音');
+   * ```
+   */
   async muteMicrophone() {
     var e;
     await ((e = i.instance) == null ? void 0 : e.muteLocalAudio());
   }
+  /**
+   * 取消静音本地麦克风
+   * @memberof module:LiveSeatState/seatManager
+   * @description 用户取消静音自己的麦克风
+   * @returns {Promise<void>} 取消静音操作的Promise
+   * @example
+   * ```typescript
+   * const { unmuteMicrophone } = useLiveSeatState();
+   * 
+   * // 取消静音麦克风
+   * await unmuteMicrophone();
+   * console.log('麦克风已取消静音');
+   * ```
+   */
   async unmuteMicrophone() {
     var e;
     await ((e = i.instance) == null ? void 0 : e.unmuteLocalAudio());
   }
+  /**
+   * 开始播放流
+   * @memberof module:LiveSeatState/seatManager
+   * @description 开始播放麦位的音视频流
+   * @param {Object} params - 播放参数
+   * @param {string} params.view - 视频容器元素ID
+   * @returns {Promise<any>} 播放操作的Promise
+   * @example
+   * ```typescript
+   * const { startPlayStream } = useLiveSeatState();
+   * 
+   * // 开始播放流到指定容器
+   * try {
+   *   await startPlayStream({ view: 'video-container' });
+   *   console.log('开始播放流');
+   * } catch (error) {
+   *   console.error('播放流失败:', error);
+   * }
+   * ```
+   */
   async startPlayStream({ view: e }) {
     return await P({ view: e });
   }
+  /**
+   * 停止播放流
+   * @memberof module:LiveSeatState/seatManager
+   * @description 停止播放麦位的音视频流
+   * @returns {Promise<any>} 停止操作的Promise
+   * @example
+   * ```typescript
+   * const { stopPlayStream } = useLiveSeatState();
+   * 
+   * // 停止播放流
+   * try {
+   *   await stopPlayStream();
+   *   console.log('已停止播放流');
+   * } catch (error) {
+   *   console.error('停止播放流失败:', error);
+   * }
+   * ```
+   */
   async stopPlayStream() {
     return await R();
   }