@tencentcloud/sdk-mcp 1.3.9 → 1.4.0

package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md

@@ -0,0 +1,207 @@
+## 简介
+
+**LoginStore** 提供了一套完整的登录管理 API，包括用户登录、登出、设置个人信息等功能。
+通过该类，可以管理用户的登录状态和用户资料。
+
+> **重要：**
+>
+
+> 使用 **LoginStore.shared** 单例对象访问 **LoginStore** 实例。
+>
+
+> **说明：**
+>
+
+> 登录状态更新通过 **loginState** 发布者传递。订阅它以接收登录状态的实时更新。
+>
+
+## 功能特性
+- **用户登录**：支持使用 SDK 应用 ID、用户 ID 和用户签名进行登录。
+
+- **用户登出**：支持用户登出操作。
+
+- **个人信息设置**：支持设置用户昵称、头像、性别等个人资料。
+
+## 可订阅数据
+
+**LoginState** 的字段描述如下：
+| **属性名** | **类型** | **描述** |
+| --- | --- | --- |
+| loginStatus | StateFlow<LoginStatus> | 登录状态。 |
+| loginUserInfo | StateFlow<UserProfile?> | 登录用户信息。 |
+
+## API 列表
+| **函数名** | **描述** |
+| --- | --- |
+| LoginStore.shared | 单例对象。 |
+| addLoginListener | 登录事件监听器。 |
+| removeLoginListener | 登录事件监听器。 |
+| login | 登录。 |
+| logout | 登出。 |
+| setSelfInfo | 设置个人信息。 |
+
+### 获取实例
+
+#### LoginStore.shared
+
+单例对象。
+
+### 观察事件
+
+#### addLoginListener
+
+添加登录监听器
+``` kotlin
+abstract fun addLoginListener(listener: LoginListener)
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| listener | LoginListener | 必填 | 登录监听器。 |
+
+#### removeLoginListener
+
+移除登录监听器
+``` kotlin
+abstract fun removeLoginListener(listener: LoginListener)
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| listener | LoginListener | 必填 | 登录监听器。 |
+
+### 登录操作
+
+#### login
+
+登录
+``` kotlin
+abstract fun login(
+    context: Context,
+    sdkAppID: Int,
+    userID: String,
+    userSig: String,
+    completion: CompletionHandler? = null
+)
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| context | Context | 必填 | 上下文。 |
+| sdkAppID | Int | 必填 | SDK 应用 ID。 |
+| userID | String | 必填 | 用户 ID。 |
+| userSig | String | 必填 | 用户签名。 |
+| completion | CompletionHandler? | 必填 | 完成回调。 |
+
+#### logout
+
+登出
+``` kotlin
+abstract fun logout(completion: CompletionHandler? = null)
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| completion | CompletionHandler? | 必填 | 完成回调。 |
+
+#### setSelfInfo
+
+设置个人信息
+``` kotlin
+abstract fun setSelfInfo(
+    userProfile: UserProfile,
+    completion: CompletionHandler? = null
+)
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| userProfile | UserProfile | 必填 | 用户资料。 |
+| completion | CompletionHandler? | 必填 | 完成回调。 |
+
+## 数据结构
+
+### LoginStatus
+
+登录状态。
+| **枚举值** | **说明** |
+| --- | --- |
+| UNLOGIN | 未登录。 |
+| LOGINED | 已登录。 |
+
+### AllowType
+
+好友验证方式。
+| **枚举值** | **值** | **说明** |
+| --- | --- | --- |
+| ALLOW_ANY | 0 | 允许任何人。 |
+| NEED_CONFIRM | 1 | 需要验证。 |
+| DENY_ANY | 2 | 拒绝任何人。 |
+
+### Gender
+
+性别。
+| **枚举值** | **值** | **说明** |
+| --- | --- | --- |
+| UNKNOWN | 0 | 未知。 |
+| MALE | 1 | 男性。 |
+| FEMALE | 2 | 女性。 |
+
+### LoginListener
+
+登录事件。
+
+**方法**
+| **方法名** | **说明** |
+| --- | --- |
+| onKickedOffline | 当前用户被踢下线。 |
+| onLoginExpired | 登录票据过期。 |
+
+### UserProfile
+
+用户资料。
+| **属性** | **类型** | **说明** |
+| --- | --- | --- |
+| userID | String | 用户 ID。 |
+| nickname | String? | 昵称。 |
+| avatarURL | String? | 头像URL。 |
+| selfSignature | String? | 个性签名。 |
+| gender | Gender? | 性别。 |
+| role | Int? | 角色。 |
+| level | Int? | 等级。 |
+| birthday | Long? | 生日。 |
+| allowType | AllowType? | 好友验证方式。 |
+| customInfo | Map<String,ByteArray>? | 自定义信息。 |
+
+### LoginState
+
+登录状态。
+| **属性** | **类型** | **说明** |
+| --- | --- | --- |
+| loginStatus | StateFlow<LoginStatus> | 登录状态。 |
+| loginUserInfo | StateFlow<UserProfile?> | 登录用户信息。 |

package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md

@@ -1,8 +1,5 @@
 `LiveAudienceStore` 是 `AtomicXCore` 中专门负责管理直播间观众信息的模块。通过`LiveAudienceStore`，您可以为您的直播应用构建一套完整的观众列表及管理系统。
 
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/96da98a0ab3711f09b75525400bf7822.png)
-
-
 ## 核心功能
 - **实时观众列表**：获取并展示当前在直播间内的所有观众信息。
 
@@ -14,58 +11,21 @@
 
 - **房间管理**：主播或管理员可以将任意普通观众请出（踢出）直播间。
 
-
 ## 核心概念
 
 在开始集成之前，我们先通过下表了解一下 LiveAudienceStore 相关的几个核心概念：
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >**核心概念**</td>
-
-<td rowspan="1" colSpan="1" >**类型**</td>
-
-<td rowspan="1" colSpan="1" >**核心职责与描述**</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`LiveUserInfo`</td>
-
-<td rowspan="1" colSpan="1" >data class</td>
-
-<td rowspan="1" colSpan="1" >代表一个观众（用户）的基础信息模型。它包含了用户的唯一标识 (`userID`)、昵称 (`userName`) 和头像地址 (`avatarURL`)。</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`LiveAudienceState`</td>
-
-<td rowspan="1" colSpan="1" >data class</td>
-
-<td rowspan="1" colSpan="1" >代表观众模块的当前状态。其核心属性 `audienceList` 是一个 StateFlow，存储了观众列表的实时状态；`audienceCount` 则代表当前观众总数的实时状态。</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`LiveAudienceListener`</td>
-
-<td rowspan="1" colSpan="1" >abstract class</td>
-
-<td rowspan="1" colSpan="1" >代表观众动态的实时事件。分为 `onAudienceJoined` (观众加入) 和 `onAudienceLeft` (观众离开) 两种，用于实现对观众列表的增量更新。</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`LiveAudienceStore`</td>
-
-<td rowspan="1" colSpan="1" >abstract class</td>
-
-<td rowspan="1" colSpan="1" >这是与观众列表功能交互的核心管理类。通过它，您可以获取观众列表快照、执行管理操作，并通过订阅其 `LiveAudienceListener` 来接收实时动态。</td>
-</tr>
-</table>
-
+| **核心概念** | **类型** | **核心职责与描述** |
+| --- | --- | --- |
+| `LiveUserInfo` | data class | 代表一个观众（用户）的基础信息模型。它包含了用户的唯一标识 (`userID`)、昵称 (`userName`) 和头像地址 (`avatarURL`)。 |
+| `LiveAudienceState` | data class | 代表观众模块的当前状态。其核心属性 `audienceList` 是一个 StateFlow，存储了观众列表的实时状态；`audienceCount` 则代表当前观众总数的实时状态。 |
+| `LiveAudienceListener` | abstract class | 代表观众动态的实时事件。分为 `onAudienceJoined` (观众加入) 和 `onAudienceLeft` (观众离开) 两种，用于实现对观众列表的增量更新。 |
+| `LiveAudienceStore` | abstract class | 这是与观众列表功能交互的核心管理类。通过它，您可以获取观众列表快照、执行管理操作，并通过订阅其 `LiveAudienceListener` 来接收实时动态。 |
 
 ## 实现指南
 
 ### 步骤1：组件集成
 
-请参考 [开始直播](https://write.woa.com/document/191126372105478144) 集成 **AtomicXCore**，完成接入。
+请参考 开始直播 集成 **AtomicXCore**，完成接入。
 
 ### 步骤2：初始化并获取观众列表
 
@@ -86,11 +46,11 @@ class AudienceManager(
     // 对外暴露【全量】观众列表的状态流，方便UI层订阅
     private val _audienceList = MutableStateFlow<List<LiveUserInfo>>(emptyList())
     val audienceList: StateFlow<List<LiveUserInfo>> = _audienceList.asStateFlow()
-    
+
     // 对外暴露观众总数的状态流
     private val _audienceCount = MutableStateFlow(0)
     val audienceCount: StateFlow<Int> = _audienceCount.asStateFlow()
-    
+
     init {
         // 1. 订阅状态和事件，实现见下一节
         subscribeToAudienceState()
@@ -113,7 +73,7 @@ class AudienceManager(
             }
         })
     }
-    
+
     // ... 后续代码
 }
 ```
@@ -132,7 +92,7 @@ class AudienceManager {
             }
         }
 
-        scope.launch {   
+        scope.launch {
             // audienceCount 是实时总数
             audienceStore.liveAudienceState.audienceCount.collect { count ->
                 _audienceCount.value = count
@@ -200,7 +160,7 @@ class AudienceManager {
             override fun onSuccess() {
                 println("成功将用户 $userId 设为管理员")
             }
-            
+
             override fun onFailure(code: Int, desc: String) {
                 println("设置管理员失败: $desc")
             }
@@ -276,40 +236,11 @@ class LiveRoomManager(
 ## API 文档
 
 关于 [LiveAudienceStore](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-live-audience-store/index.html) 及其相关类的所有公开接口、属性和方法的详细信息，请参阅随 [AtomicX Core](https://tencent-rtc.github.io/TUIKit_Android/index.html) 框架的官方 API 文档。本文档使用到的相关 Store 如下：
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >Store/Component</td>
-
-<td rowspan="1" colSpan="1" >功能描述</td>
-
-<td rowspan="1" colSpan="1" >API 文档</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >LiveCoreView</td>
-
-<td rowspan="1" colSpan="1" >直播视频流展示与交互的核心视图组件：负责视频流渲染和视图挂件处理，支持主播直播、观众连麦、主播连线等场景。</td>
-
-<td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.view/-live-core-view/index.html)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >LiveAudienceStore</td>
-
-<td rowspan="1" colSpan="1" >观众管理：获取实时观众列表（ID / 名称 / 头像），统计观众数量，监听观众进出事件。</td>
-
-<td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.view/-live-core-view/index.html)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >BarrageStore</td>
-
-<td rowspan="1" colSpan="1" >弹幕功能：发送文本 / 自定义弹幕，维护弹幕列表，实时监听弹幕状态。</td>
-
-<td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.barrage/-barrage-store/index.html)</td>
-</tr>
-</table>
-
+| Store/Component | 功能描述 | API 文档 |
+| --- | --- | --- |
+| LiveCoreView | 直播视频流展示与交互的核心视图组件：负责视频流渲染和视图挂件处理，支持主播直播、观众连麦、主播连线等场景。 | [API 文档](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.view/-live-core-view/index.html) |
+| LiveAudienceStore | 观众管理：获取实时观众列表（ID / 名称 / 头像），统计观众数量，监听观众进出事件。 | [API 文档](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.view/-live-core-view/index.html) |
+| BarrageStore | 弹幕功能：发送文本 / 自定义弹幕，维护弹幕列表，实时监听弹幕状态。 | [API 文档](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.barrage/-barrage-store/index.html) |
 
 ## 常见问题
 
@@ -328,8 +259,6 @@ class LiveRoomManager(
 
   - **关键点: 在"弹幕风暴"或礼物刷屏等消息流量极高的场景下，如果房间内的消息速率超过了 40条/秒 的阈值，为了保证核心消息（例如弹幕）的送达，人数变更的消息可能会被频控策略丢弃**。
 
-
       **这对开发者意味着什么？**
 
-
       `audienceCount` 是一个非常接近实时的**高精度估算值**，但在极端高并发场景下，它可能存在短暂的延迟或数据丢失。因此，我们建议您将其用于**UI展示**，而不应作为计费、统计等需要绝对精准场景的唯一依据。