@tencent-rtc/mcp 1.2.8 → 1.3.0

package/resource/doc/livekit/vue/workflow.md

@@ -0,0 +1,218 @@
+# Web Live TUIKit Code Generation Workflow Instructions (Vue)
+
+**【Instruction Purpose】**: Provide Agent with a **code generation blueprint** for implementing Vue Web Live TUIKit core functionalities, and guide Agent to **prioritize using the latest documentation content fetched in real-time via tools**.
+
+**💡 Special Reminder:**
+1. **When user requirements include 【Live List】, 【Broadcaster Page】, and 【Viewer Page】, Agent MUST add a 【Host/Viewer Identity Selection】 page or logic in the generated code to allow users to test with different UserIDs**.
+2. **When users need to implement co-guest (mic connection) features, call** `get_web_live_state_detail` **to obtain liveKit client API for implementing related functions**.
+
+---
+
+## 📦 UIKit Version & Dependency Instructions
+
+### Recommended Versions
+```json
+{
+  "tuikit-atomicx-vue3": "latest",
+  "@tencentcloud/uikit-base-component-vue3": "latest",
+}
+```
+
+### Automatic Dependency Installation Workflow
+After generating code, Agent **MUST automatically execute** the following steps:
+
+1. **Detect Dependency Completeness**: Check if `package.json` contains all required dependencies
+2. **Auto-install Dependencies**: Execute `npm install` or `pnpm install`
+3. **Verify Installation**: Confirm successful installation before prompting user to run the project
+
+### esbuild Issue Resolution
+Add the following content to `package.json`. `resolutions` is compatible with `yarn`, `overrides` is compatible with `npm` and `pnpm`:
+```json
+{
+ "resolutions": {
+    "esbuild": "npm:esbuild-wasm@latest"
+  },
+   "overrides": {
+    "esbuild": "npm:esbuild-wasm@latest"
+  }
+}
+```
+
+---
+
+## 🔐 Automatic Test Credential Generation
+
+### UserSig Auto-fetch Workflow
+
+Before generating code, Agent **MUST**:
+
+1. **Call `get_usersig` MCP tool** to automatically generate test account credentials
+2. **Generate Test UserIDs**:
+   - Broadcaster UserID: Format as live001 or host001
+   - Viewer UserID: Format as user001 or viewer001
+3. **Embed in Code**: Directly write the generated SDKAppID, userID (for both host and viewer), and userSig into the code's configuration section
+4. **Security Notice**: Clearly mark in code comments that these are test credentials; production environment MUST generate on backend
+
+---
+
+## ⚙️ Core Code Generation Workflow (LLM Action Guide)
+
+Agent, this tool has **fetched in real-time** the latest documentation content corresponding to the user's required functionalities (Goals), and attached this content **below this instruction** (in the `llm_code_generation_instructions_md` field).
+
+### Strictly Execute Steps:
+
+#### Step 0: Pre-preparation (Automated)
+```
+a. Call get_usersig tool to generate test credentials
+   - Broadcaster userID: Use format `live001`
+   - Viewer userID: Use format `user001`
+   
+b. Check and prepare project environment
+   - Verify dependency versions in package.json
+   - Automatically add to dependencies if missing
+   
+c. Execute dependency installation
+   - Run npm install or pnpm install
+   - Wait for completion and check for errors
+```
+
+#### Step 1: Select Functional Modules
+Based on user's specific functional requirements, select corresponding instructions from the following function blocks.
+
+#### Step 2: Use Real-time Documentation
+**MUST prioritize and exclusively** use the real-time documentation content **provided in this tool's return results** (not external URLs) to generate Vue code snippets.
+
+---
+
+## 🎯 Feature Implementation Instructions
+
+### 1. Implement Live List Page (`liveList`)
+
+**Target Component**: `liveList`
+
+**Code Generation Instructions**:
+- Generate Vue component structure, import `liveList`
+- **Auto-inject Test Credentials**: Use auto-generated **viewer** `SDKAppID`, `userID`, `userSig` during component initialization
+- **Core Logic**: Reference real-time documentation content in this tool's return results, extract latest API calls and example code
+
+**Dependent Components**: `liveList`
+
+**Post-generation Actions**:
+```bash
+# Agent auto-executes
+npm install  # Install dependencies
+npm run dev  # Start dev server
+```
+
+---
+
+### 2. Implement PC Live Viewer Page (`livePlayer` & `barrage`)
+
+**Target Components**: `livePlayer`, `barrage`
+
+**Code Generation Instructions**:
+- Generate viewer page based on real-time documentation examples
+- **Auto-inject Test Credentials**: Configure **viewer** test account during player initialization
+- **Core Logic**: Reference real-time documentation content in this tool's return results, MUST follow documentation steps to integrate `livePlayer` and `barrage` (bullet comments), and demonstrate how to monitor video stream status
+- **Interaction Optimization**: Add loading states, error handling, reconnection mechanisms
+
+**Dependent Components**: `livePlayer`, `barrage`
+
+---
+
+### 3. Implement H5 Live Viewer Page (`livePlayer` & `barrage`)
+
+**Target Components**: `livePlayer`, `barrage`
+
+**Code Generation Instructions**:
+- Generate viewer page based on real-time documentation examples
+- **Auto-inject Test Credentials**: Configure **viewer** test account during player initialization
+- **Core Logic**: Reference real-time documentation content in this tool's return results, MUST follow documentation steps to integrate `livePlayer` and `barrage` (bullet comments), and demonstrate how to monitor video stream status
+- **Interaction Optimization**: Add loading states, error handling, reconnection mechanisms
+
+**Dependent Components**: `livePlayer`, `barrage`
+
+---
+
+### 4. Implement Live Broadcasting Page (`livePusher`)
+
+**Target Component**: `livePusher`
+
+**Code Generation Instructions**:
+- Generate broadcasting page based on real-time documentation examples
+- **Auto-inject Test Credentials**: Configure **broadcaster** test account during pusher initialization
+- **Core Logic**: Reference real-time documentation content in this tool's return results, MUST include Vue logic to handle camera and microphone **permission requests and toggle controls**
+- **Device Detection**: Auto-detect available camera and microphone devices
+- **Error Handling**: Handle permission denial, device unavailability, and other exceptions
+
+**Dependent Components**: `livePusher`
+
+---
+
+### 5. Implement Live Co-guest Feature (`CoGuestPanel`)
+
+**Target Component**: `CoGuestPanel`
+
+**Code Generation Instructions**:
+- Generate complex components or logic modules for co-guest functionality based on real-time documentation examples
+- **Auto-inject Test Credentials**: Configure test accounts separately for broadcaster and co-guest viewers
+- **Core Logic**: Reference real-time documentation content in this tool's return results, code should demonstrate how to use `CoGuestPanel` to manage co-guest requests and coordinate pusher/player logic switching
+- **State Management**: Handle state transitions for co-guest invitations, acceptance, rejection, disconnection, etc.
+- **Multi-person Co-guest**: Support scenarios with multiple simultaneous co-guests
+
+**Dependent Components**: `CoGuestPanel`, `livePusher`, `livePlayer`
+
+---
+
+## 🔄 Complete Automation Workflow Summary
+
+```mermaid
+graph TD
+    A[Receive User Requirements] --> B[Call get_web_live_uikit_integration to Fetch Latest Docs]
+    B --> C[Check package.json Dependencies]
+    C --> D[Auto-add Missing Dependencies]
+    D --> E[Execute npm install]
+    E --> F[Generate Code Based on Real-time Docs]
+    F --> G[Call get_usersig to Generate Test Credentials]
+    G --> H[Inject Test Credentials into Code]
+    H --> I[Add Security Comments and Warnings]
+    I --> J[Start Dev Server]
+    J --> K[Output Test Info to User]
+```
+
+---
+
+## 📋 Agent Checklist
+
+After completing code generation, Agent MUST confirm:
+
+- [x] Called `get_usersig` to generate test credentials
+- [x] Embedded credentials into code configuration section
+- [x] Added security warning comments in code
+- [x] Checked `package.json` dependency completeness
+- [x] Auto-executed `npm install`
+- [x] Verified successful dependency installation
+- [x] Used real-time documentation content (not external URLs)
+- [x] Added error handling and logging output
+- [x] Provided test account information to user
+- [x] Prompted user to run `npm run dev`
+
+---
+
+## 🚨 Security Warning (MUST be included in generated code comments)
+
+```javascript
+/**
+ * ⚠️ Important Security Notice
+ * 
+ * 1. The current userSig is a test credential auto-generated by development tools
+ * 2. userSig validity period is 7 days, regeneration required after expiration
+ * 3. ❌ Frontend generation of userSig is STRICTLY PROHIBITED in production
+ * 4. ✅ Before going live, userSig MUST be generated on backend services
+ * 5. Reference documentation: https://trtc.io/document/34385
+ * 
+ * SDKAppID and secretKey retrieval locations:
+ * - Chat Application: https://console.trtc.io
+ * - TRTC Application: https://console.trtc.io
+ */
+```

package/resource/doc/native_live/android/V2TXLiveCode_api_android.md

@@ -0,0 +1,312 @@
+# Tencent Cloud Live Streaming SDK V2TXLiveCode Error Code Documentation
+
+## Overview
+
+`V2TXLiveCode.java` defines the error and warning codes for the Tencent Cloud Live Streaming (CSS) SDK on Android. This file categorizes error codes and provides detailed descriptions for features such as host (push), player (playback), stream mixing, and recording.
+
+**File Path**: `com/tencent/live2/V2TXLiveCode.java`  
+**Platform Support**: Android  
+**Total Error Codes**: 20 core error and warning codes
+
+## 📋 Table of Contents
+
+### 1. [Error Code Categories](#错误码分类)
+### 2. [General Error Codes](#通用错误码)
+### 3. [Network-Related Warning Codes](#网络相关警告码)
+### 4. [Camera-Related Warning Codes](#摄像头相关警告码)
+### 5. [Microphone-Related Warning Codes](#麦克风相关警告码)
+### 6. [Screen Sharing Warning Codes](#屏幕分享相关警告码)
+### 7. [Codec Warning Codes](#编解码相关警告码)
+### 8. [Error Code Usage Guide](#错误码使用指南)
+### 9. [Error Handling Best Practices](#错误处理最佳实践)
+
+## 1. Error Code Categories
+
+### 🎯 Error Code Breakdown
+
+| Category                        | Number of Codes | Main Functionality                        |
+|----------------------------------|----------------|-------------------------------------------|
+| General Error Codes              | 9              | API calls, parameter validation, permission checks |
+| Network-Related Warning Codes    | 2              | Network status, video stutter monitoring  |
+| Camera-Related Warning Codes     | 3              | Camera device status monitoring           |
+| Microphone-Related Warning Codes | 3              | Microphone device status monitoring       |
+| Screen Sharing Warning Codes     | 3              | Screen sharing status monitoring          |
+| Codec Warning Codes              | 2              | Audio/video codec status monitoring       |
+
+### 🔧 Technical Highlights
+
+- **Hierarchical Categorization**: Error codes are organized by functional module.
+- **Detailed Descriptions**: Each error code includes a clear explanation and usage scenario.
+- **Platform-Specific**: Android-only error codes.
+- **Debug-Friendly**: Comprehensive explanations and handling recommendations for each error code.
+
+## 2. General Error Codes
+
+### ✅ V2TXLIVE_OK - Operation Successful
+
+```java
+public static final int V2TXLIVE_OK = 0;
+```
+
+**Description**: Operation completed successfully; no error occurred.
+
+**Typical Use Cases**:
+- API call succeeded
+- Operation executed and confirmed
+- Status check returned normal
+
+### ❌ V2TXLIVE_ERROR_FAILED - General Error
+
+```java
+public static final int V2TXLIVE_ERROR_FAILED = -1;
+```
+
+**Description**: Unclassified general error.
+
+**Possible Causes**:
+- Internal processing exception
+
+### ❌ V2TXLIVE_ERROR_INVALID_PARAMETER - Invalid Parameter
+
+```java
+public static final int V2TXLIVE_ERROR_INVALID_PARAMETER = -2;
+```
+
+**Description**: Invalid parameters were provided in the API call.
+
+**Common Scenarios**:
+- Incorrect stream push URL format
+- Unsupported parameter value
+
+### ❌ V2TXLIVE_ERROR_REFUSED - API Call Refused
+
+```java
+public static final int V2TXLIVE_ERROR_REFUSED = -3;
+```
+
+**Description**: API call was refused.
+
+**Possible Causes**:
+- Incorrect call timing
+
+### ❌ V2TXLIVE_ERROR_NOT_SUPPORTED - API Not Supported
+
+```java
+public static final int V2TXLIVE_ERROR_NOT_SUPPORTED = -4;
+```
+
+**Description**: This API is not supported.
+
+**Common Scenarios**:
+- Feature not supported on the current platform
+- SDK version is too low
+- Hardware does not support the feature
+
+### ❌ V2TXLIVE_ERROR_INVALID_LICENSE - Invalid License
+
+```java
+public static final int V2TXLIVE_ERROR_INVALID_LICENSE = -5;
+```
+
+**Description**: License is invalid; the call failed.
+
+**Possible Causes**:
+- License file not set
+- License expired
+- License does not match the package name
+
+### ❌ V2TXLIVE_ERROR_REQUEST_TIMEOUT - Request Timeout
+
+```java
+public static final int V2TXLIVE_ERROR_REQUEST_TIMEOUT = -6;
+```
+
+**Description**: Request to the server timed out.
+
+**Common Scenarios**:
+- Unstable network connection
+- Slow server response
+
+### ❌ V2TXLIVE_ERROR_SERVER_PROCESS_FAILED - Server Processing Failed
+
+```java
+public static final int V2TXLIVE_ERROR_SERVER_PROCESS_FAILED = -7;
+```
+
+**Description**: The server was unable to process your request.
+
+**Possible Causes**:
+- Internal server error
+- Incorrect request format
+- Insufficient server resources
+
+### ❌ V2TXLIVE_ERROR_DISCONNECTED - Disconnected
+
+```java
+public static final int V2TXLIVE_ERROR_DISCONNECTED = -8;
+```
+
+**Description**: Network connection was lost.
+
+**Common Scenarios**:
+- Push stream network disconnected
+- Playback network disconnected
+
+### ❌ V2TXLIVE_ERROR_NO_AVAILABLE_HEVC_DECODERS - No Available HEVC Decoders
+
+```java
+public static final int V2TXLIVE_ERROR_NO_AVAILABLE_HEVC_DECODERS = -2304;
+```
+
+**Description**: No available HEVC decoders found.
+
+**Possible Causes**:
+- Device does not support HEVC Hardware Decoding
+- HEVC decoder initialization failed
+- System version is too low
+
+## 3. Network-Related Warning Codes
+
+### ⚠️ V2TXLIVE_WARNING_NETWORK_BUSY - Network Busy
+
+```java
+public static final int V2TXLIVE_WARNING_NETWORK_BUSY = 1101;
+```
+
+**Description**: Poor network conditions detected; insufficient upstream bandwidth is causing data upload to be blocked.
+
+**Monitoring Indicators**:
+- Upstream bandwidth limitations
+- Increased network latency
+- High packet loss rate
+
+### ⚠️ V2TXLIVE_WARNING_VIDEO_BLOCK - Video Stutter
+
+```java
+public static final int V2TXLIVE_WARNING_VIDEO_BLOCK = 2105;
+```
+
+**Description**: Video playback is experiencing stutter.
+
+**Possible Causes**:
+- Insufficient network bandwidth
+- Decoding performance bottleneck
+- Rendering performance issues
+
+## 4. Camera-Related Warning Codes
+
+### ⚠️ V2TXLIVE_WARNING_CAMERA_START_FAILED - Camera Start Failed
+
+```java
+public static final int V2TXLIVE_WARNING_CAMERA_START_FAILED = -1301;
+```
+
+**Description**: Failed to start the camera.
+
+**Possible Causes**:
+- Hardware malfunction
+- Driver issues
+- Resource conflicts
+
+### ⚠️ V2TXLIVE_WARNING_CAMERA_OCCUPIED - Camera Occupied
+
+```java
+public static final int V2TXLIVE_WARNING_CAMERA_OCCUPIED = -1316;
+```
+
+**Description**: Camera is currently in use.
+
+**Possible Scenarios**:
+- Another app is using the camera
+- System camera app is running
+- Video call is in progress
+
+### ⚠️ V2TXLIVE_WARNING_CAMERA_NO_PERMISSION - Camera Not Authorized
+
+```java
+public static final int V2TXLIVE_WARNING_CAMERA_NO_PERMISSION = -1314;
+```
+
+**Description**: Camera access not authorized. This typically occurs on mobile devices when the user denies permission.
+
+## 5. Microphone-Related Warning Codes
+
+### ⚠️ V2TXLIVE_WARNING_MICROPHONE_START_FAILED - Microphone Start Failed
+
+```java
+public static final int V2TXLIVE_WARNING_MICROPHONE_START_FAILED = -1302;
+```
+
+**Description**: Failed to start the microphone.
+
+**Possible Causes**:
+- Hardware connection issues
+- Abnormal system audio settings
+- Audio session initialization failed
+
+### ⚠️ V2TXLIVE_WARNING_MICROPHONE_OCCUPIED - Microphone Occupied
+
+```java
+public static final int V2TXLIVE_WARNING_MICROPHONE_OCCUPIED = -1319;
+```
+
+**Description**: Microphone is currently in use. For example, opening the microphone will fail if the device is in a call.
+
+**Possible Scenarios**:
+- Device is in a call
+- Another audio app is using the microphone
+- Audio session conflict
+
+### ⚠️ V2TXLIVE_WARNING_MICROPHONE_NO_PERMISSION - Microphone Not Authorized
+
+```java
+public static final int V2TXLIVE_WARNING_MICROPHONE_NO_PERMISSION = -1317;
+```
+
+**Description**: Microphone access not authorized. This typically occurs on mobile devices when the user denies permission.
+
+## 6. Screen Sharing Warning Codes
+
+### ⚠️ V2TXLIVE_WARNING_SCREEN_CAPTURE_NOT_SUPPORTED - Screen Sharing Not Supported by System
+
+```java
+public static final int V2TXLIVE_WARNING_SCREEN_CAPTURE_NOT_SUPPORTED = -1309;
+```
+
+**Description**: The current system does not support screen sharing.
+
+### ⚠️ V2TXLIVE_WARNING_SCREEN_CAPTURE_START_FAILED - Failed to Start Screen Capture
+
+```java
+public static final int V2TXLIVE_WARNING_SCREEN_CAPTURE_START_FAILED = -1308;
+```
+
+**Description**: Failed to start screen capture. On mobile devices, this may be due to the user denying permission.
+
+### ⚠️ V2TXLIVE_WARNING_SCREEN_CAPTURE_INTERRUPTED - Screen Capture Interrupted by System
+
+```java
+public static final int V2TXLIVE_WARNING_SCREEN_CAPTURE_INTERRUPTED = -7001;
+```
+
+**Description**: Screen capture was interrupted by the system.
+
+## 7. Codec Warning Codes
+
+### ⚠️ V2TXLIVE_WARNING_CURRENT_ENCODE_TYPE_CHANGED - Encoder Changed
+
+```java
+public static final int V2TXLIVE_WARNING_CURRENT_ENCODE_TYPE_CHANGED = 1104;
+```
+
+**Description**: The encoder has changed. You can get the current codec format from the `codec_type` field in the extension info of the `onWarning` callback.
+
+### ⚠️ V2TXLIVE_WARNING_CURRENT_DECODE_TYPE_CHANGED - Decoder Changed
+
+```java
+public static final int V2TXLIVE_WARNING_CURRENT_DECODE_TYPE_CHANGED = 2008;
+```
+
+**Description**: The decoder has changed. You can get the current decoding format from the `codec_type` field in the extension info of the `onWarning` callback.
+
+**Note**: The extension info for this warning code is not supported on Windows.