@tencentcloud/sdk-mcp 1.3.0 → 1.3.2

package/resource/doc/roomkit/vue/states/device-state.md

@@ -1,316 +0,0 @@
-# Device State Documentation
-
-## 安装依赖
-
-您可以选择以下任一方式安装依赖：
-【npm】
-``` bash
-npm install tuikit-atomicx-vue3@latest --save
-```
-【pnpm】
-``` bash
-pnpm add tuikit-atomicx-vue3@latest
-```
-【yarn】
-``` bash
-yarn add tuikit-atomicx-vue3@latest
-```
-
-## Enums
-
-### DeviceError
-设备错误枚举
-
-```typescript
-export enum DeviceError {
-  NoError = 0,              // 无错误
-  NoDeviceDetected = 1,     // 未检测到设备
-  NoSystemPermission = 2,   // 无系统权限
-  NotSupportCapture = 3,    // 不支持捕获
-  OccupiedError = 4,        // 设备被占用
-  UnknownError = 5,         // 未知错误
-}
-```
-
-### AudioRoute
-音频路由枚举
-
-```typescript
-export enum AudioRoute {
-  Speakerphone = 0,  // 扬声器
-  Earpiece = 1,      // 听筒
-}
-```
-
-### MirrorType
-镜像类型枚举
-
-```typescript
-export enum MirrorType {
-  Auto = 0,      // 自动
-  Enable = 1,    // 启用
-  Disable = 2,   // 禁用
-}
-```
-
-### DeviceType
-设备类型枚举
-
-```typescript
-export enum DeviceType {
-  Microphone = 'Microphone',    // 麦克风
-  Camera = 'Camera',            // 摄像头
-  ScreenShare = 'ScreenShare',  // 屏幕共享
-}
-```
-
-### VideoQuality
-视频质量枚举
-
-```typescript
-export enum VideoQuality {
-  Quality360P = 1,   // 360P 分辨率
-  Quality540P = 2,   // 540P 分辨率
-  Quality720P = 3,   // 720P 分辨率
-  Quality1080P = 4,  // 1080P 分辨率
-}
-```
-
-### DevicePermission
-设备权限枚举
-
-```typescript
-export enum DevicePermission {
-  PublishAudio = 'PublishAudio',    // 发布音频权限
-  PublishVideo = 'PublishVideo',    // 发布视频权限
-  ScreenShare = 'ScreenShare',      // 屏幕共享权限
-}
-```
-
-### MediaSettingDisplayMode
-媒体设置显示模式枚举
-
-```typescript
-export enum MediaSettingDisplayMode {
-  Icon = 'Icon',                    // 仅图标模式
-  IconWithPanel = 'IconWithPanel',  // 图标加面板模式
-  Panel = 'Panel',                  // 仅面板模式
-}
-```
-
-### DeviceStatus
-设备状态枚举
-
-```typescript
-export enum DeviceStatus {
-  Off = 0,  // 关闭
-  On = 1,   // 开启
-}
-```
-
-### NetworkQuality
-网络质量枚举
-
-```typescript
-export enum NetworkQuality {
-  Unknown = 0,    // 未知
-  Excellent = 1,  // 优秀
-  Good = 2,       // 良好
-  Poor = 3,       // 较差
-  Bad = 4,        // 差
-  VeryBad = 5,    // 很差
-  Down = 6,       // 断开
-}
-```
-
-## Interfaces
-
-### VideoSettingProps
-视频设置属性接口
-
-```typescript
-export interface VideoSettingProps {
-  displayMode: MediaSettingDisplayMode;  // 显示模式（必需）
-  supportSwitchCamera?: boolean;         // 是否支持切换摄像头（可选）
-  supportSwitchResolution?: boolean;     // 是否支持切换分辨率（可选）
-  supportVideoPreview?: boolean;         // 是否支持视频预览（可选）
-  supportSwitchMirror?: boolean;         // 是否支持切换镜像（可选）
-}
-```
-
-#### 属性说明
-
-- **displayMode**: 设置显示模式，决定UI的展现形式
-- **supportSwitchCamera**: 是否允许用户切换前后摄像头
-- **supportSwitchResolution**: 是否允许用户切换视频分辨率
-- **supportVideoPreview**: 是否显示视频预览功能
-- **supportSwitchMirror**: 是否允许用户切换视频镜像效果
-
-### AudioSettingProps
-音频设置属性接口
-
-```typescript
-export interface AudioSettingProps {
-  displayMode: MediaSettingDisplayMode;  // 显示模式（必需）
-  supportSwitchMicrophone?: boolean;     // 是否支持切换麦克风（可选）
-  supportSwitchSpeaker?: boolean;        // 是否支持切换扬声器（可选）
-  supportAudioLevel?: boolean;           // 是否支持音频电平显示（可选）
-}
-```
-
-#### 属性说明
-
-- **displayMode**: 设置显示模式，决定UI的展现形式
-- **supportSwitchMicrophone**: 是否允许用户切换麦克风设备
-- **supportSwitchSpeaker**: 是否允许用户切换扬声器设备
-- **supportAudioLevel**: 是否显示音频电平指示器
-
-### NetworkInfo
-网络信息接口
-
-```typescript
-export interface NetworkInfo {
-  quality: NetworkQuality;  // 网络质量等级
-  upLoss: number;          // 上行丢包率（百分比）
-  downLoss: number;        // 下行丢包率（百分比）
-  delay: number;           // 网络延迟（毫秒）
-}
-```
-
-#### 属性说明
-
-- **quality**: 网络质量等级，用于快速判断网络状况
-- **upLoss**: 上行数据包丢失率，范围通常为 0-100
-- **downLoss**: 下行数据包丢失率，范围通常为 0-100
-- **delay**: 网络往返延迟时间，单位为毫秒
-
-## 使用示例
-
-### 视频设置配置示例
-
-```typescript
-const videoSettings: VideoSettingProps = {
-  displayMode: MediaSettingDisplayMode.IconWithPanel,
-  supportSwitchCamera: true,
-  supportSwitchResolution: true,
-  supportVideoPreview: true,
-  supportSwitchMirror: false
-};
-```
-
-### 音频设置配置示例
-
-```typescript
-const audioSettings: AudioSettingProps = {
-  displayMode: MediaSettingDisplayMode.Panel,
-  supportSwitchMicrophone: true,
-  supportSwitchSpeaker: true,
-  supportAudioLevel: true
-};
-```
-
-### 网络信息使用示例
-
-```typescript
-const networkInfo: NetworkInfo = {
-  quality: NetworkQuality.Good,
-  upLoss: 2.5,
-  downLoss: 1.8,
-  delay: 45
-};
-
-// 根据网络质量显示不同的提示
-function getNetworkStatusText(info: NetworkInfo): string {
-  switch (info.quality) {
-    case NetworkQuality.Excellent:
-      return "网络状况优秀";
-    case NetworkQuality.Good:
-      return "网络状况良好";
-    case NetworkQuality.Poor:
-      return "网络状况较差";
-    default:
-      return "网络状况未知";
-  }
-}
-```
-
-## 注意事项
-
-1. **设备权限**: 在使用摄像头和麦克风前，需要确保获得相应的系统权限
-2. **错误处理**: 建议根据 `DeviceError` 枚举值提供相应的用户提示
-3. **网络监控**: 定期检查 `NetworkInfo` 以优化用户体验
-4. **设备兼容性**: 不同设备对视频质量和功能的支持可能有差异
-
-## API 和事件使用示例
-```typescript
-import { useDeviceState } from 'tuikit-atomicx-vue3';
-const {
-    // 麦克风数据
-    microphoneStatus,
-    microphoneList,
-    currentMicrophone,
-    microphoneLastError,
-    isMicrophoneTesting,
-    currentMicVolume,
-    captureVolume,
-    testingMicVolume,
-
-    // 摄像头数据
-    cameraStatus,
-    cameraList,
-    currentCamera,
-    cameraLastError,
-    isCameraTesting,
-    isCameraTestLoading,
-    isFrontCamera,
-    localMirrorType,
-    localVideoQuality,
-
-    // 扬声器数据
-    speakerList,
-    currentSpeaker,
-    outputVolume,
-    currentAudioRoute,
-    isSpeakerTesting,
-
-    // 屏幕分享数据
-    screenStatus,
-
-    // 本地网络数据
-    networkInfo,
-
-    // 麦克风操作
-    openLocalMicrophone,
-    closeLocalMicrophone,
-    muteLocalAudio,
-    unmuteLocalAudio,
-    getMicrophoneList,
-    setCurrentMicrophone,
-    startMicrophoneTest,
-    stopMicrophoneTest,
-    setCaptureVolume,
-
-    // 扬声器操作
-    getSpeakerList,
-    setCurrentSpeaker,
-    setAudioRoute,
-    startSpeakerTest,
-    stopSpeakerTest,
-    setOutputVolume,
-
-    // 摄像头操作
-    openLocalCamera,
-    closeLocalCamera,
-    getCameraList,
-    setCurrentCamera,
-    switchCamera,
-    switchMirror,
-    updateVideoQuality,
-    startCameraDeviceTest,
-    stopCameraDeviceTest,
-
-    // 屏幕分享
-    startScreenShare,
-    stopScreenShare,
-} = useDeviceState();
-```

package/resource/doc/roomkit/vue/states/login-state.md

@@ -1,51 +0,0 @@
-# Room Login State Documentation
-
-Room 组件登录 API 文档。
-
-## 安装依赖
-
-您可以选择以下任一方式安装依赖：
-【npm】
-``` bash
-npm install tuikit-atomicx-vue3@latest --save
-```
-【pnpm】
-``` bash
-pnpm add tuikit-atomicx-vue3@latest
-```
-【yarn】
-``` bash
-yarn add tuikit-atomicx-vue3@latest
-```
-
-## API使用示例
-
-```typescript
-import { useLoginState } from 'tuikit-atomicx-vue3';
-const {
-  loginUserInfo,
-  login,
-  logout,
-  setSelfInfo,
-} = useLoginState();
-
-// 登录
-login({
-  userId: 'xxx';
-  userSig: 'xxx';
-  sdkAppId: 0;
-}).then(() => {
-  // 登录成功获取登录用户的信息
-  const { userId, userName, avatarUrl, customInfo } = loginUserInfo;
-})
-
-// 登出
-logout();
-
-// 设置用户信息
-setSelfInfo({
-  userName: 'xxx',
-  avatarUrl: 'xxx',
-});
-
-```

package/resource/doc/roomkit/vue/states/room-list-state.md

@@ -1,287 +0,0 @@
-# Room List State Documentation
-
-Room 房间列表 State API 文档。
-
-## 安装依赖
-
-您可以选择以下任一方式安装依赖：
-【npm】
-``` bash
-npm install tuikit-atomicx-vue3@latest --save
-```
-【pnpm】
-``` bash
-pnpm add tuikit-atomicx-vue3@latest
-```
-【yarn】
-``` bash
-yarn add tuikit-atomicx-vue3@latest
-```
-
-## Enums
-
-### RoomStatus
-房间状态枚举
-
-```typescript
-export enum RoomStatus {
-  Scheduled = 1,  // 已预约
-  Running = 2,    // 进行中
-}
-```
-
-### RoomEndedReason
-房间结束原因枚举
-
-```typescript
-export enum RoomEndedReason {
-  ByOwner = 1,   // 由房主结束
-  ByServer = 2,  // 由服务器结束
-}
-```
-
-### RoomInvitationStatus
-房间邀请状态枚举
-
-```typescript
-export enum RoomInvitationStatus {
-  None = 0,      // 无状态
-  Pending = 1,   // 等待中
-  Timeout = 2,   // 超时
-  Rejected = 3,  // 已拒绝
-}
-```
-
-### InvitationRejectedReason
-邀请拒绝原因枚举
-
-```typescript
-export enum InvitationRejectedReason {
-  Rejected = "Rejected",  // 拒绝
-  Busy = "Busy",         // 忙碌
-}
-```
-
-## Interfaces
-
-### RoomUser
-房间用户信息
-
-```typescript
-export interface RoomUser {
-  userId: string;      // 用户ID
-  userName: string;    // 用户名
-  avatarURL: string;   // 头像URL
-}
-```
-
-### RoomInfo
-房间信息
-
-```typescript
-export interface RoomInfo {
-  readonly roomId: string;                    // 房间ID（只读）
-  roomName: string;                          // 房间名称
-  roomOwner: RoomUser;                       // 房间所有者
-  readonly participantCount: number;          // 参与者数量（只读）
-  readonly createTime: number;               // 创建时间（只读）
-  readonly roomStatus: RoomStatus;           // 房间状态（只读）
-  scheduledStartTime?: number;               // 预约开始时间（可选）
-  scheduledEndTime?: number;                 // 预约结束时间（可选）
-  startReminderInSeconds?: number;           // 开始前提醒时间（秒）（可选）
-  scheduleAttendees?: RoomUser[];            // 预约参与者列表（可选）
-  password?: string;                         // 房间密码（可选）
-  isAllMicrophoneDisabled: boolean;          // 是否禁用所有麦克风
-  isAllCameraDisabled: boolean;              // 是否禁用所有摄像头
-  isAllScreenShareDisabled: boolean;         // 是否禁用所有屏幕共享
-  isAllMessageDisabled: boolean;             // 是否禁用所有消息
-}
-```
-
-### RoomInvitation
-房间邀请信息
-
-```typescript
-export interface RoomInvitation {
-  roomInfo: RoomInfo;                        // 房间信息
-  inviter: RoomUser;                         // 邀请者
-  invitee: RoomUser;                         // 被邀请者
-  status: RoomInvitationStatus;              // 邀请状态
-}
-```
-
-## Type Definitions
-
-### ScheduleRoomOptions
-预约房间选项
-
-```typescript
-export type ScheduleRoomOptions = {
-  roomName?: string;                         // 房间名称（可选）
-  password?: string;                         // 房间密码（可选）
-  scheduleStartTime: number;                 // 预约开始时间（必需）
-  scheduleEndTime: number;                   // 预约结束时间（必需）
-  reminderSecondsBeforeStart?: number;       // 开始前提醒时间（秒）（可选）
-  scheduleAttendees?: string[];              // 预约参与者ID列表（可选）
-  isAllMicrophoneDisabled?: boolean;         // 是否禁用所有麦克风（可选）
-  isAllCameraDisabled?: boolean;             // 是否禁用所有摄像头（可选）
-  isAllScreenShareDisabled?: boolean;        // 是否禁用所有屏幕共享（可选）
-  isAllMessageDisabled?: boolean;            // 是否禁用所有消息（可选）
-};
-```
-
-### ScheduleUpdateRoomOptions
-更新预约房间选项
-
-```typescript
-export type ScheduleUpdateRoomOptions = {
-  roomName?: string;                         // 房间名称（可选）
-  scheduleStartTime?: number;                // 预约开始时间（可选）
-  scheduleEndTime?: number;                  // 预约结束时间（可选）
-}
-```
-
-### CreateRoomOptions
-创建房间选项
-
-```typescript
-export type CreateRoomOptions = {
-  roomName?: string;                         // 房间名称（可选）
-  password?: string;                         // 房间密码（可选）
-  isAllMicrophoneDisabled?: boolean;         // 是否禁用所有麦克风（可选）
-  isAllCameraDisabled?: boolean;             // 是否禁用所有摄像头（可选）
-  isAllScreenShareDisabled?: boolean;        // 是否禁用所有屏幕共享（可选）
-  isAllMessageDisabled?: boolean;            // 是否禁用所有消息（可选）
-};
-```
-
-### UpdateRoomOptions
-更新房间选项
-
-```typescript
-export type UpdateRoomOptions = {
-  roomName?: string;                         // 房间名称（可选）
-  password?: string;                         // 房间密码（可选）
-};
-```
-
-## IRoomListState Interface
-
-房间列表状态管理接口
-
-### Properties
-
-```typescript
-export interface IRoomListState {
-  scheduledRoomList: RoomInfo[];             // 预约房间列表
-  scheduledRoomListCursor: string;           // 预约房间列表游标
-  currentRoom: RoomInfo | null;              // 当前房间信息
-}
-```
-
-### Methods
-
-#### 房间列表管理
-
-- **getScheduledRoomList(options: { cursor: string, count?: number }): Promise<void>**
-  - 获取预约房间列表
-
-- **getScheduledAttendees(options: { roomId: string, cursor: string, count?: number }): Promise<{ attendees: RoomUser[], cursor: string }>**
-  - 获取预约参与者列表
-
-#### 预约房间管理
-
-- **scheduleRoom(options: { roomId: string, options: ScheduleRoomOptions }): Promise<void>**
-  - 预约房间
-
-- **updateScheduledRoom(options: { roomId: string, options: ScheduleUpdateRoomOptions }): Promise<void>**
-  - 更新预约房间
-
-- **addScheduledAttendees(options: { roomId: string, userIdList: string[] }): Promise<void>**
-  - 添加预约参与者
-
-- **removeScheduledAttendees(options: { roomId: string, userIdList: string[] }): Promise<void>**
-  - 移除预约参与者
-
-- **cancelScheduledRoom(options: { roomId: string }): Promise<void>**
-  - 取消预约房间
-
-#### 房间操作
-
-- **createAndJoinRoom(options: { roomId: string, options: CreateRoomOptions }): Promise<void>**
-  - 创建并加入房间
-
-- **joinRoom(options: { roomId: string, password?: string }): Promise<void>**
-  - 加入房间
-
-- **leaveRoom(): Promise<void>**
-  - 离开房间
-
-- **endRoom(): Promise<void>**
-  - 结束房间
-
-- **updateRoomInfo(options: { roomId: string, options: UpdateRoomOptions }): Promise<void>**
-  - 更新房间信息
-
-#### 邀请管理
-
-- **callUserToRoom(options: { roomId: string, userIdList: string[] }): Promise<RoomInvitation>**
-  - 邀请用户到房间
-
-- **cancelCall(options: { roomId: string, userIdList: string[] }): Promise<void>**
-  - 取消邀请
-
-- **getPendingInvitations(options: { roomId: string, cursor: string, count?: number }): Promise<{invitations: RoomInvitation[], cursor: string }>**
-  - 获取待处理的邀请
-
-### Event Handlers
-
-#### 预约房间事件
-
-- **onAddedToScheduledRoom: (options: { roomInfo: RoomInfo; }) => void**
-  - 被添加到预约房间时触发
-
-- **onRemovedFromScheduledRoom: (options: { roomInfo: RoomInfo; operateUser: RoomUser }) => void**
-  - 被从预约房间移除时触发
-
-- **onScheduledRoomCancelled: (options: { roomInfo: RoomInfo; operateUser: RoomUser }) => void**
-  - 预约房间被取消时触发
-
-- **onScheduledRoomStartingSoon: (options: { roomInfo: RoomInfo }) => void**
-  - 预约房间即将开始时触发
-
-#### 房间状态事件
-
-- **onRoomEnded: (options: { roomId: string; reason: RoomEndedReason }) => void**
-  - 房间结束时触发
-
-#### 邀请相关事件
-
-- **onRoomCallReceived: (options: { invitation: RoomInvitation }) => void**
-  - 收到房间邀请时触发
-
-- **onRoomCallCancelled: (options: { invitation: RoomInvitation }) => void**
-  - 房间邀请被取消时触发
-
-- **onRoomCallTimeout: (options: { invitation: RoomInvitation }) => void**
-  - 房间邀请超时时触发
-
-- **onRoomCallAccepted: (options: { invitation: RoomInvitation }) => void**
-  - 房间邀请被接受时触发
-
-- **onRoomCallRejected: (options: { invitation: RoomInvitation, reason: InvitationRejectedReason }) => void**
-  - 房间邀请被拒绝时触发
-
-### Example
-
-## API 和事件使用示例
-```typescript
-import { useRoomListState } from 'tuikit-atomicx-vue3';
-const {
-  joinRoom,
-  leaveRoom,
-  endRoom,
-  subscribeEvent,
-  unsubscribeEvent
-} = useRoomListState();
-```