@tencent-rtc/mcp 1.0.9 → 1.1.6

package/resource/doc/livekit/vue/components/live-player.md

@@ -0,0 +1,269 @@
+This article provides a detailed introduction to the watch page in **TUILiveKit** Demo. You can directly refer to this document to integrate the watch page we developed in your existing project, or you can deeply customize the page style, layout, and functional items according to your needs according to the content in the document.
+
+### Function Overview
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >**Functional classification**</td>
+
+<td rowspan="1" colSpan="1" >**Specific capabilities**</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Live video playback**</td>
+
+<td rowspan="1" colSpan="1" >HD and smooth live streaming experience</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Barrage Interaction**</td>
+
+<td rowspan="1" colSpan="1" >Real-time Barrage chat</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Viewer List**</td>
+
+<td rowspan="1" colSpan="1" >View online viewer information</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Follow Streamer**</td>
+
+<td rowspan="1" colSpan="1" >Follow your favorite streamers with one click</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Full Screen Play**</td>
+
+<td rowspan="1" colSpan="1" >Immersive viewing experience</td>
+</tr>
+</table>
+
+
+## Function Display
+
+The watch page provides default behavior and style, but if the default behavior and style don't fully meet your needs, you can also customize the UI. The numbers shown in the figure correspond to categories in the specific function list. These mainly include live broadcast information display, video broadcast area, online audience, audio and video operation, live broadcast duration, screen resolution switching, full screen function, chat interaction, message list, etc.
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/7a5f3ab9982c11f0af98525400454e06.png)
+
+
+## Quick Access
+
+### Step 1: Environment Configuration and Service Activation
+
+Before using Quick Access, you need to refer to [Preparations](https://write.woa.com/document/189231573727113216) configuration requirements and activate the corresponding services.
+
+
+
+
+【npm】
+``` bash
+npm install tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3 --save
+```
+
+
+【pnpm】
+``` bash
+pnpm add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
+```
+
+
+【yarn】
+``` bash
+yarn add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
+```
+
+### Step 2: Access the viewing page
+
+Create a live-player.vue file in your project and copy the following code to integrate the watch page into your project.
+``` vue
+<template>
+  <UIKitProvider language="zh-CN">
+    <div class="container">
+      <!-- Live core area -->
+      <section class="live">
+        <header class="header">
+          <IconArrowStrokeBack class="back-btn" size="20" />
+          <Avatar :src="currentLive?.liveOwner.avatarUrl" :size="32" class="avatar" />
+          <span class="user-name">{{ currentLive?.liveOwner.userName || currentLive?.liveOwner.userId }}</span>
+        </header>
+        <LiveCoreView class="player" />
+      </section>
+
+      <div class="sidebar">
+        <!-- Online viewers list -->
+        <section class="audience">
+          <header class="section-header">
+            <h3> online viewers <span>({{ audienceList.length }})</span></h3>
+          </header>
+          <LiveAudienceList class="list" />
+        </section>
+
+        <!-- Message List & Message List -->
+        <section class="barrage">
+          <header class="section-header">
+            <h3>MessageList</h3>
+          </header>
+          <BarrageList class="list" />
+          <BarrageInput class="input" height="48px" />
+        </section>
+      </div>
+    </div>
+  </UIKitProvider>
+</template>
+
+<script setup lang="ts">
+import { LiveAudienceList, BarrageList, BarrageInput, useLiveAudienceState, LiveCoreView, useLiveState, Avatar, useLoginState } from 'tuikit-atomicx-vue3';
+import { UIKitProvider, IconArrowStrokeBack } from '@tencentcloud/uikit-base-component-vue3';
+
+const { audienceList } = useLiveAudienceState();
+const { currentLive } = useLiveState();
+const { login } = useLoginState();
+
+async function initLogin() {
+  try {
+    await login({
+      sdkAppId: 0,        // SDKAppId, refer to step 1 to obtain
+      userId: '',         // UserID, refer to step 1 to obtain
+      userSig: '',        // userSig, refer to step 1 to obtain
+    });
+  } catch (error) {
+    console.error('Login Failed:', error);
+  }
+}
+
+onMounted(async () => {
+  await initLogin();
+});
+
+</script>
+
+<style>:global(body){height:100vh;width:100vw;margin:0;padding:0;overflow:hidden;font-size:15px;line-height:1.6;text-rendering:optimizeLegibility;}:global(*),:global(*::before),:global(*::after){box-sizing:border-box;margin:0;}.container{display:grid;grid-template-columns:70% 30%;height:100vh;width:100vw;gap:16px;padding:16px;background:var(--bg-color-default);box-sizing:border-box;overflow:hidden;}.live{display:flex;flex-direction:column;background:var(--bg-color-operate);border-radius:12px;overflow:hidden;box-shadow:0 2px 8px var(--shadow-color);}.header{display:flex;align-items:center;gap:12px;padding:16px;border-bottom:1px solid var(--stroke-color-primary);}.back-btn{cursor:pointer;color:var(--text-color-tertiary);transition:color 0.2s;}.back-btn:hover{color:var(--text-color-link-hover);}.avatar{border:1px solid var(--uikit-color-white-7);}.user-name{color:var(--text-color-primary);font-weight:500;}.player{flex:1;background:var(--uikit-color-black-1);}.sidebar{display:flex;flex-direction:column;gap:16px;height:100%;overflow:hidden;}.audience{display:flex;flex-direction:column;background:var(--bg-color-operate);border-radius:12px;overflow:hidden;box-shadow:0 2px 8px var(--shadow-color);flex:1;min-height:0;}.barrage{display:flex;flex-direction:column;background:var(--bg-color-operate);border-radius:12px;overflow:hidden;box-shadow:0 2px 8px var(--shadow-color);flex:1;min-height:0;}.section-header{padding:16px;border-bottom:1px solid var(--stroke-color-primary);background:var(--bg-color-operate);}.section-header h3{margin:0;font-size:16px;font-weight:600;color:var(--text-color-primary);}.section-header span{font-weight:400;color:var(--text-color-secondary);font-size:14px;}.list{flex:1;min-height:0;overflow-y:auto;}.input{border-top:1px solid var(--stroke-color-primary);flex-shrink:0;height:48px;}@media (max-width:1200px){.container{grid-template-columns:1fr;grid-template-rows:60% 20% 20%;gap:12px;}.sidebar{gap:12px;}.audience,.barrage{min-height:200px;}}@media (max-width:768px){.container{padding:8px;gap:8px;grid-template-rows:50% 25% 25%;}.header,.section-header{padding:12px;}.sidebar{gap:8px;}}</style>
+
+```
+
+### Step 3: Start the project
+``` bash
+npm run dev
+```
+
+## Customizable
+
+As shown in the functional diagram above, we also support customizing the UI of the watch page based on your project needs. The following table lists the main customizable features.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >**Category**</td>
+
+<td rowspan="1" colSpan="1" >**Function**</td>
+
+<td rowspan="1" colSpan="1" >**Description**</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Live information display**</td>
+
+<td rowspan="1" colSpan="1" >Customize the display of the watch page information area</td>
+
+<td rowspan="1" colSpan="1" >**Supports:**<br>- **Show/hide the logo, replace it with your desired logo**<br>- **UI customization, show/hide the follow button, and replace it with your desired button style**</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Online viewers**</td>
+
+<td rowspan="1" colSpan="1" >Customize audience information display</td>
+
+<td rowspan="1" colSpan="1" >**Supports:**<br>- **Show/hide audience level**<br>- **Customize audience information font and color UI**<br>- **Replace icon style with your desired style**</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**MessageList**</td>
+
+<td rowspan="1" colSpan="1" >Custom message barrage area display</td>
+
+<td rowspan="1" colSpan="1" >**Supports:**<br>- **Show/hide chat input area**<br>- **Supports UI customization for chat bubble style, audience level, etc.**</td>
+</tr>
+</table>
+
+
+## Playing a Live Stream
+
+#### Method 1: Playing by Specifying a LiveId
+
+If you need to specify a LiveId for playback, you need to add the following code based on the code in [step 3](https://write.woa.com/#c1b852bc-da02-4c9f-bb11-2a63582ce978) of the Quick Access section above. The reference method is as follows:
+``` typescript
+// live-player.vue
+import { onMounted } from 'vue';
+import { useLiveState } from 'tuikit-atomicx-vue3';
+
+const { joinLive } = useLiveState();
+
+onMounted(async () => {
+  // Enter liveId to join the live broadcast room. For the specific meaning of the parameters, 
+  // please refer to the preparation work in step 1.
+  await joinLive({ liveId: 'xxx' });                                  
+});
+```
+
+#### Method 2: Routing Configuration
+
+Because of the logic involved in redirecting from the live stream list (or homepage) to the live stream room, you'll need to configure Vue Router. Create a new router folder in the project's src directory and create an index.ts file. Then, import and use the router in your main file (e.g., main.ts or index.ts). See the [GitHub code examples](https://github.com/Tencent-RTC/TUILiveKit/blob/main/Web/web-vite-vue3/src/main.ts) for more information. For a live stream list, see the Live Stream List documentation.
+``` typescript
+// src/router/index.ts
+import { createRouter, createWebHistory } from 'vue-router';
+
+const routes = [
+  {
+    path: '/live-player',
+    component: () => import('../views/live-player.vue'),
+  },
+  // If you need the live broadcast list function, you can add the following route
+  // {  
+    //   path: '/live-list',  
+    //   component: () => import('../views/live-list.vue'),  
+  // },
+];
+
+const router = createRouter({
+  history: createWebHistory(),
+  routes,
+});
+export default router;
+
+// src/main.ts
+import { createApp } from 'vue';
+import App from './App.vue';
+import router from './router';
+
+const app = createApp(App);
+app.use(router);
+app.mount('#app');
+```
+
+### Next Steps
+
+Congratulations! You've successfully integrated the watch page. Next, you can implement content such as the anchor's start page and live broadcast list page. Please refer to the table below:
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >**Function**</td>
+
+<td rowspan="1" colSpan="1" >**Description**</td>
+
+<td rowspan="1" colSpan="1" >**Integration Guide**</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Host Streaming**</td>
+
+<td rowspan="1" colSpan="1" >The complete workflow for a host to start a stream, including pre-stream setup and various in-stream interactions.</td>
+
+<td rowspan="1" colSpan="1" >[Host Streaming](https://write.woa.com/document/189497714561167360)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Live Stream List**</td>
+
+<td rowspan="1" colSpan="1" >Display the live broadcast list interface and functions, including live broadcast list and room information display function</td>
+
+<td rowspan="1" colSpan="1" >[Live Stream List](https://write.woa.com/document/189592401543360512)</td>
+</tr>
+</table>

package/resource/doc/livekit/vue/components/live-scene-panel.md

@@ -0,0 +1,175 @@
+This document provides a detailed introduction to the **Media Source Configuration Panel (LiveScenePanel)**. You can refer to the sample code in this document for seamless integration of our pre-developed components in your existing project, or customize the style and layout according to your needs by following the component customization section in the document.
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/3c146f8f991211f0aa4252540044a08e.png)
+
+
+## Core Features
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >**Feature Category**</td>
+
+<td rowspan="1" colSpan="1" >**Specific Capability**</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Multi-material type support**</td>
+
+<td rowspan="1" colSpan="1" >Camera, screen sharing, image, video, text and multiple material types, support device selection and parameter configuration.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Intelligent display mode**</td>
+
+<td rowspan="1" colSpan="1" >Display the full panel when no material is present, and automatically switch to compact button mode when material is available, with responsive layout adaptation.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Material management operations**</td>
+
+<td rowspan="1" colSpan="1" >Complete material management features including addition, editing, rename, deletion, and sorting, with support for batch operations.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Real-time preview configuration**</td>
+
+<td rowspan="1" colSpan="1" >Camera configuration pop-up provides real-time preview, supports parameter adjustment and device testing.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Permission and Error Handling**</td>
+
+<td rowspan="1" colSpan="1" >Automated permission check, Friendly error prompt and retry mechanism to guarantee user experience.</td>
+</tr>
+</table>
+
+
+## Component Integration
+
+### Step 1: Configuring the Environment and Activating the Service
+
+Before performing quick integration, you need to refer to [preparations](https://write.woa.com/document/185222107981008896) to meet the related environment configuration and activate the corresponding service.
+
+### Step 2: Dependency Installation
+
+
+
+
+【npm】
+``` bash
+npm install tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3 --save
+```
+
+
+【pnpm】
+``` bash
+pnpm add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
+```
+
+
+【yarn】
+``` bash
+yarn add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
+```
+
+### Step 3: Integrating the **Media Source Configuration Panel**
+
+Add **Media Source Configuration Panel** to your project and use it. Copy the following example code directly into your project to show the media source configuration panel.
+``` typescript
+<template>
+  <UIKitProvider theme="dark" language="en-US">
+    <div class="app-container">
+      <LiveScenePanel class="live-scene-panel" />
+    </div>
+  </UIKitProvider>
+</template>
+
+<script setup lang="ts">
+import { onMounted } from 'vue';
+import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
+import { LiveScenePanel, useLoginState } from 'tuikit-atomicx-vue3';
+
+const { login } = useLoginState();
+
+async function initLogin() {
+  try {
+    await login({
+      sdkAppId: 0,        // SDKAppID, see Step 1 to get it
+      userId: '',         // UserID, see Step 1 to get it
+      userSig: '',        // userSig, see Step 1 to get it
+    });
+  } catch (error) {
+    console.error('login error:', error);
+  }
+}
+
+onMounted(async () => {
+  await initLogin();
+});
+</script>
+
+<style scoped>.app-container{width:100vw;height:100vh;display:flex;justify-content:center;align-items:center;padding:20px;box-sizing:border-box}.live-scene-panel{width:20%;height:80vh;background:rgba(0,0,0,0.8);border-radius:16px}</style>
+```
+
+## Customize Component
+
+The media source configuration panel provides users with various and dimensional feature APIs for user customization, allowing users to customize material types, operation behavior, style themes, etc. After completing **Step 3** above, see the following example to adjust the UI of the media source configuration panel, or directly copy the sample code incrementally into the component to generate the effect example.
+
+### Style Customization
+
+Customize component appearance via CSS class names and variables, supporting comprehensive customization of theme colors, layout styles, animation effects, and more.
+``` typescript
+<template>
+  <LiveScenePanel class="custom-live-scene-panel" />
+</template>
+
+<style>.app-container{width:100vw;height:100vh;display:flex;justify-content:center;align-items:center;padding:20px;box-sizing:border-box}.custom-live-scene-panel{width:100%;max-width:300px;height:80vh;background:linear-gradient(135deg,#667eea 0%,#764ba2 100%);border:2px solid #4c63d2;border-radius:16px;padding:24px;box-shadow:0 8px 32px rgba(0,0,0,0.1);color:white}.custom-live-scene-panel .add-material-item{background-color:#147fcb!important;color:white;border:none;border-radius:0!important;padding:12px 24px;font-weight:600;transition:all 0.3s ease}.custom-live-scene-panel .materials-list{margin-top:20px;gap:16px;display:grid;grid-template-columns:repeat(auto-fill,minmax(200px,1fr))}.custom-live-scene-panel .material-item{background:rgba(255,255,255,0.1);border:1px solid rgba(255,255,255,0.2);border-radius:12px;padding:16px;backdrop-filter:blur(10px);transition:all 0.3s ease}.custom-live-scene-panel .material-item:hover{background:rgba(255,255,255,0.2);transform:scale(1.02)}</style>
+```
+<table>
+<tr>
+<td rowspan="1" colSpan="2" >**Before modification**</td>
+
+<td rowspan="1" colSpan="2" >**After modification**</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Add Media Source Interface**</td>
+
+<td rowspan="1" colSpan="1" >**Media Source Setting Interface**</td>
+
+<td rowspan="1" colSpan="1" >**Add Media Source Interface**</td>
+
+<td rowspan="1" colSpan="1" >**Media Source Setting Interface**</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/ac5eab64991011f0a3b8525400e889b2.png)</td>
+
+<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/d16d5660991011f0a207525400bf7822.png)</td>
+
+<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/3f2a9ff2991011f0a3b8525400e889b2.png)</td>
+
+<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/62a92cae991011f08bb25254005ef0f7.png)</td>
+</tr>
+</table>
+
+
+### Listening for Status and Scaling
+
+Using status management Hooks, you can listen to internal state changes in the media source configuration panel and implement responsive processing for external business logic. This approach allows you to monitor and respond to operations like adding, deleting, and updating materials without modifying the component's internal code, thereby achieving data synchronization, service statistics, user prompts, and other extended features.
+``` typescript
+<template>
+    <!-- status display -->
+    <div class="status-info">
+      <span>Number of materials: {{ materialCount }}</span>
+      <span>Last operation: {{ lastOperation }}</span>
+    </div>
+    <LiveScenePanel />
+    <LiveScenePanel />
+    <StreamMixer />
+</template>
+
+<script setup lang="ts">
+import { ref, computed, watch } from 'vue';
+import { LiveScenePanel, useVideoMixerState, StreamMixer } from 'tuikit-atomicx-vue3';
+
+```