@tencent-rtc/mcp 1.3.0 → 1.3.2

package/resource/doc/chatuikit/vue/chat_window_integration.md

@@ -1,156 +0,0 @@
-The AI model must comply with the following **hard restrictions**:
-* **Strictly required document procedure integration:** You must perform the integration according to the document procedure and description. In step 1.1, `npm run dev` or `pnpm run dev` is not required. Upon completion, start the project as per step 1.4.
-* **Strictly use the example code in the documentation:** You must strictly use the example code in the document to fill the file when creating a file. For the style tag, non-use of the scoped property is recommended.
-* **Open Default Conversation:** The `C2Cadministrator` conversation must be opened using `setActiveConversation`.
-* **Retrieve userSig using a tool:** The TUIKit code must be downloaded and integrated according to the documentation before automatically generating a test userID and calling the `get_usersig` tool to retrieve the userSig. The userID does not need to be appended with a timestamp to avoid errors in dynamic calculation.
-* **Account Information Filling:** After obtaining the userSig, the SDKAppID, userID, and userSig will be automatically filled into the code.
-* **Prohibit Creating User Information Configuration Files:** The `config` directory or file for filling in SDKAppID, userID, and userSig must not be automatically created.
-
-
-# chat-uikit-vue3 Integration
-
-
-User's integration needs have two types. You must rationally analyze which type the need belongs to.
-1. Integrate chat window: Refers to integrating only Chat, ChatHeader, MessageList, and MessageInput components.
-2. Integrate call feature: On the basis of integrated chat only, integrate call feature. You must read section 2.1 "Best Practice - Integrate Call Feature" for details.
-
-
-
-
-1. Seamless integration of chat window
-
-
-### 1.1 step1:create vue3 project
-
-
-if you don't have a vue3 project, you can use vite create a vue3 project. otherwise, you can skip this step.
-
-
-requirement: vue3: ^3.0.0, nodejs: ^22.0.0.
-
-
-if it is a new project, guide the user to use vite to create a vue3 project manually, and then continue with step 1.2. if it is an existing project, skip this step and continue with step 1.2.
-
-
-```bash
-pnpm create vite@latest
-# skip some settings
-cd ${your-vue-project-name}
-pnpm install
-```
-
-
-### 1.2 step2: install chat-uikit-vue3
-
-
-use npm or pnpm to install @tencentcloud/chat-uikit-vue3@latest @tencentcloud/call-uikit-vue@latest
-
-
-### 1.3 step3: add main content to your project
-```vue
-<template>
-<UIKitProvider>
-  <Chat style="flex: 1;">
-    <ChatHeader />
-    <MessageList />
-    <MessageInput />
-  </Chat>
-</UIKitProvider>
-</template>
-<script setup lang="ts">
-import { useLoginState, useConversationListState } from '@tencentcloud/chat-uikit-vue3';
-
-
-const userID = '';        // TODO: Replace with your userID
-const SDKAppID = 0;        // TODO: Replace with your SDKAppID (Notice: SDKAppID is of type number)
-const userSig = '';   // TODO: Replace with your userSig
-const conversationID = ref('C2Cadministrator'); // define by yourself
-
-
-const { login } = useLoginState();
-const { setActiveConversation } = useConversationListState();
-
-
-login({
-  sdkAppId : SDKAppID,
-  userId: userID,
-  userSig: userSig,
-})
-.then(() => {
-  setActiveConversation(conversationID.value);
-})
-.catch(() => {});
-</script>
-```
-
-
-### 1.4 step4: start your project
-```bash
-pnpm run dev
-```
-
-
-Best Practices
-
-
-The following components can be retrieved via MCP Tools get_component_detail ${componenetname.tolowercase()}.
-The following states can be retrieved via MCP Tools get_state_detail ${statename.tolowercase()}.
-
-
-Focus
-1. If necessary, integrate the ChatSetting component, please read the ChatHeaderRight slot description in ChatHeader.
-2. Since integrated chat only does not use ConversationList, you need to obtain activeConversation via useConversationListState of ConversationListState, then call setActiveConversation to set activeConversation.
-
-
-### 2.1 Best Practice - Seamless Integration of Call Feature
-
-
-Integrate call feature: On the basis of integrated chat only, add code for call feature.
-
-
-Introduce TUICallKit.
-```vue
-<script setup lang="ts">
-import { TUICallKit } from '@tencentcloud/call-uikit-vue';
-</script>
-```
-
-
-Add TUICallKit at the appropriate position:
-```vue
-<Teleport to="body">
-  <TUICallKit style="position: fixed; z-index: 1000;"/>
-</Teleport>
-```
-
-
-Focus
-1. Add a call button to the ChatHeaderRight slot in the ChatHeader Component.
-2. Click the call button to call the following method:
-  2.1 Read the ConversationListState document and use activeConversation to judge whether it is a single chat or group chat.
-  2.2 If it is a one-to-one chat, use `import { TUICallKitServer, TUICallType } from '@tencentcloud/call-uikit-vue';` to introduce the TUICallKitService service. Initiate call via the `calls` method of TUICallKitService.
-    ```ts
-    try {
-      await TUICallKitServer.calls({ 
-        userIDList: [activeConversation.value.userProfile.userID],
-        type: TUICallType.VIDEO_CALL, // or TUICallType.AUDIO_CALL
-      });
-    } catch (error: any) {
-      console.error(`[TUICallKit] Failed to call the groupCall API. Reason:${error}`);
-    }
-    ```
-  2.3 If it is a group chat, read the UserPicker component document. It is advisable to combine with the Dialog component and pop up the UserPicker component.
-    Read the GroupSettingState document, combine GroupSettingState's `getGroupMemberList` and `allMembers` to get the group member list.
-    ```ts
-    try {
-      await TUICallKitServer.calls({ 
-        userIDList: selectedItems.map((item: any) => item.key),
-        type: TUICallType.VIDEO_CALL, // or TUICallType.AUDIO_CALL
-      });
-    } catch (error: any) {
-      console.error(`[TUICallKit] Failed to call the groupCall API. Reason:${error}`);
-    }
-    ```
-
-
-    Recommendation: Combine the `reachEnd` event of UserPicker with paged pull to get group members, and use traffic throttling to control the call frequency of `getGroupMemberList`.

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

@@ -1,369 +0,0 @@
-# Device State Documentation
-
-
-## Install dependency
-
-
-You can choose any method below for dependency installation:
-[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
-Device error enumeration
-
-
-```typescript
-export enum DeviceError {
-  NoError = 0,              // No error
-  NoDeviceDetected = 1,     // No device detected
-  NoSystemPermission = 2,   // No system permission
-  NotSupportCapture = 3,    // Capture not supported
-  OccupiedError = 4,        // Device occupied
-  UnknownError = 5,         // Unknown error
-}
-```
-
-
-### AudioRoute
-Audio route enumeration
-
-
-```typescript
-export enum AudioRoute {
-  Speakerphone = 0,  // Speaker
-  Earpiece = 1,      // Earpiece
-}
-```
-
-
-### MirrorType
-Image Type Enumeration
-
-
-```typescript
-export enum MirrorType {
-  Auto = 0,      // Automatic
-  Enable = 1,    // Enable
-  Disable = 2,   // Disable
-}
-```
-
-
-### DeviceType
-Device Type enumeration
-
-
-```typescript
-export enum DeviceType {
-  Microphone = 'Microphone',    // Microphone
-  Camera = 'Camera',            // Camera
-  ScreenShare = 'ScreenShare',    // Screen sharing
-}
-```
-
-
-### VideoQuality
-Video quality enumeration
-
-
-```typescript
-export enum VideoQuality {
-  Quality360P = 1,   // 360P resolution
-  Quality540P = 2,   // 540P resolution
-  Quality720P = 3,   // 720P resolution
-  Quality1080P = 4,  // 1080P resolution
-}
-```
-
-
-### DevicePermission
-Device permission enumeration
-
-
-```typescript
-export enum DevicePermission {
-  PublishAudio = 'PublishAudio',    // Publish audio permission
-  PublishVideo = 'PublishVideo',    // Publish video permission
-  ScreenShare = 'ScreenShare',      // Screen sharing permission
-}
-```
-
-
-### MediaSettingDisplayMode
-Media settings display mode enumerate
-
-
-```typescript
-export enum MediaSettingDisplayMode {
-  Icon = 'Icon',                    // Icon mode only
-  IconWithPanel = 'IconWithPanel',  // Icon with panel mode
-  Panel = 'Panel',                  // Panel mode only
-}
-```
-
-
-### DeviceStatus
-Device status enumeration
-
-
-```typescript
-export enum DeviceStatus {
-  Off = 0,  // Off
-  On = 1,   // On
-}
-```
-
-
-### NetworkQuality
-Network quality enumeration
-
-
-```typescript
-export enum NetworkQuality {
-  Unknown = 0,    // Unknown
-  Excellent = 1,   // Excellent
-  Good = 2,       // Good
-  Poor = 3,       // Poor
-  Bad = 4,        // Bad
-  VeryBad = 5,    // Poor
-  Down = 6,       // Disconnected
-}
-```
-
-
-## Interfaces
-
-
-### VideoSettingProps
-Video settings property API
-
-
-```typescript
-export interface VideoSettingProps {
-  displayMode: MediaSettingDisplayMode;  // Display mode (required)
-  supportSwitchCamera?: boolean;         // Whether switching camera is supported (optional)
-  supportSwitchResolution?: boolean;     // Whether switching resolution is supported (optional)
-  supportVideoPreview?: boolean;         // Whether video preview is supported (optional)
-  supportSwitchMirror?: boolean;         // Whether switching mirror is supported (optional)
-}
-```
-
-
-Attribute description
-
-
--**displayMode**: Set the display mode to determine the UI presentation form
-- **supportSwitchCamera**: Whether to allow user access to switch between front and rear cameras
-- **supportSwitchResolution**: Whether to allow user access to switch video resolution
-- **supportVideoPreview**: Whether to display video preview
-- **supportSwitchMirror**: Whether to allow user access to toggle the video mirror effect
-
-
-### AudioSettingProps
-Audio settings property API
-
-
-```typescript
-export interface AudioSettingProps {
-  displayMode: MediaSettingDisplayMode;  // Display mode (required)
-  supportSwitchMicrophone?: boolean;     // Whether switching microphone is supported (optional)
-  supportSwitchSpeaker?: boolean;        // Whether switching speaker is supported (optional)
-  supportAudioLevel?: boolean;           // Whether audio level display is supported (optional)
-}
-```
-
-
-Attribute description
-
-
--**displayMode**: Set the display mode to determine the UI presentation form
-- **supportSwitchMicrophone**: Whether to allow user access to switch microphone device
-- **supportSwitchSpeaker**: Whether to allow user access to switch speaker device
-- **supportAudioLevel**: Whether to display the audio level indicator
-
-
-### NetworkInfo
-Network information API
-
-
-```typescript
-export interface NetworkInfo {
-  quality: NetworkQuality;  // Network quality level
-  upLoss: number;          // Upstream packet loss rate (percentage)
-  downLoss: number;        // Downstream packet loss rate (percentage)
-  delay: number;           // Network delay (ms)
-}
-```
-
-
-Attribute description
-
-
--**quality**: Network quality level, for quick network condition judgment
-- **upLoss**: Uplink packet loss rate, typically ranging from 0-100
-- **downLoss**: Downlink packet loss rate, typically ranging from 0-100
-- **delay**: Network round-trip delay time (milliseconds)
-
-
-## Example
-
-
-Video Settings Configuration Example
-
-
-```typescript
-const videoSettings: VideoSettingProps = {
-  displayMode: MediaSettingDisplayMode.IconWithPanel,
-  supportSwitchCamera: true,
-  supportSwitchResolution: true,
-  supportVideoPreview: true,
-  supportSwitchMirror: false
-};
-```
-
-
-Audio Settings Configuration Example
-
-
-```typescript
-const audioSettings: AudioSettingProps = {
-  displayMode: MediaSettingDisplayMode.Panel,
-  supportSwitchMicrophone: true,
-  supportSwitchSpeaker: true,
-  supportAudioLevel: true
-};
-```
-
-
-Network information usage example
-
-
-```typescript
-const networkInfo: NetworkInfo = {
-  quality: NetworkQuality.Good,
-  upLoss: 2.5,
-  downLoss: 1.8,
-  delay: 45
-};
-
-
-// Display notification based on network quality
-function getNetworkStatusText(info: NetworkInfo): string {
-  switch (info.quality) {
-    case NetworkQuality.Excellent:
-      return "Network condition is excellent";
-    case NetworkQuality.Good:
-      return "Network condition is good";
-    case NetworkQuality.Poor:
-      return "Network condition is poor";
-    default:
-      return "Network condition is unknown";
-  }
-}
-```
-
-
-## Must-Knows
-
-
-1. **Device permission**: Ensure you obtain appropriate system permission before using the camera and microphone.
-2. **Error handling**: It is recommended to provide corresponding user notifications based on the `DeviceError` enumeration value.
-3. **Network monitoring**: Perform periodic checks on `NetworkInfo` to optimize user experience.
-4. **Device compatibility**: Video quality and features may vary by device.
-
-
-## API and event usage example
-```typescript
-import { useDeviceState } from 'tuikit-atomicx-vue3';
-const {
-    Microphone data
-    microphoneStatus,
-    microphoneList,
-    currentMicrophone,
-    microphoneLastError,
-    isMicrophoneTesting,
-    currentMicVolume,
-    captureVolume,
-    testingMicVolume,
-
-
-    camera data
-    cameraStatus,
-    cameraList,
-    currentCamera,
-    cameraLastError,
-    isCameraTesting,
-    isCameraTestLoading,
-    isFrontCamera,
-    localMirrorType,
-    localVideoQuality,
-
-
-    speaker data
-    speakerList,
-    currentSpeaker,
-    outputVolume,
-    currentAudioRoute,
-    isSpeakerTesting,
-
-
-    screen sharing data
-    screenStatus,
-
-
-    Local network data
-    networkInfo,
-
-
-    // Microphone operation
-    openLocalMicrophone,
-    closeLocalMicrophone,
-    muteLocalAudio,
-    unmuteLocalAudio,
-    getMicrophoneList,
-    setCurrentMicrophone,
-    startMicrophoneTest,
-    stopMicrophoneTest,
-    setCaptureVolume,
-
-
-    // Speaker operation
-    getSpeakerList,
-    setCurrentSpeaker,
-    setAudioRoute,
-    startSpeakerTest,
-    stopSpeakerTest,
-    setOutputVolume,
-
-
-    camera operation
-    openLocalCamera,
-    closeLocalCamera,
-    getCameraList,
-    setCurrentCamera,
-    switchCamera,
-    switchMirror,
-    updateVideoQuality,
-    startCameraDeviceTest,
-    stopCameraDeviceTest,
-
-
-    Screen Sharing
-    startScreenShare,
-    stopScreenShare,
-} = useDeviceState();
-```

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

@@ -1,59 +0,0 @@
-# Room LoginState Documentation
-
-
-Room component login API document.
-
-## Install dependency
-
-
-you can choose any method below for dependency installation:
-[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 usage example
-
-
-```typescript
-import { useLoginState } from 'tuikit-atomicx-vue3';
-const {
-  loginUserInfo,
-  login,
-  logout,
-  setSelfInfo,
-} = useLoginState();
-
-
-// Log in.
-login({
-  userId: 'xxx';
-  userSig: 'xxx';
-  sdkAppId: 0;
-}).then(() => {
-  // Get logged-in user info after successful login
-  const { userId, userName, avatarUrl, customInfo } = loginUserInfo;
-})
-
-
-// Log out
-logout();
-
-
-// Set user information
-setSelfInfo({
-  userName: 'xxx',
-  avatarUrl: 'xxx',
-});
-
-
-```