@tencentcloud/sdk-mcp 1.4.6 → 1.6.0-beta.1

package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md

@@ -0,0 +1,466 @@
+## 简介
+
+`DeviceStore` 提供了一套全面的 API 来管理音视频设备，包括麦克风、摄像头和屏幕分享等功能。
+
+> **重要：**
+>
+
+> 请使用 **DeviceStore.shared** 单例获取 `DeviceStore` 实例。不要尝试直接初始化。
+>
+
+> **说明：**
+>
+
+> 设备状态更新通过 **deviceState** 发布者传递。订阅它以接收有关麦克风、摄像头、网络等状态的实时更新。
+>
+
+## 功能特性
+- **麦克风管理**：打开/关闭麦克风，设置采集音量和输出音量。
+
+- **摄像头管理**：打开/关闭摄像头，切换前后摄像头，设置镜像和视频质量。
+
+- **音频路由**：切换扬声器和听筒。
+
+- **屏幕分享**：开启和关闭屏幕分享功能。
+
+- **网络状态**：实时监控网络质量信息。
+
+## 可订阅数据
+
+**DeviceState** 的字段描述如下：
+
+|**属性名**|**类型**|**描述**|
+|---------|---------|---------|
+|microphoneStatus|StateFlow<DeviceStatus>|麦克风状态。|
+|microphoneLastError|StateFlow<DeviceError>|麦克风错误，用于出现报错时提取错误信息。|
+|captureVolume|StateFlow<Int>|采集音量，取值范围0到100。|
+|currentMicVolume|StateFlow<Int>|当前用户实际输出音量。|
+|outputVolume|StateFlow<Int>|最大输出音量，取值范围0到100。|
+|cameraStatus|StateFlow<DeviceStatus>|摄像头状态。|
+|cameraLastError|StateFlow<DeviceError>|摄像头错误，用于出现报错时提取错误信息。|
+|isFrontCamera|StateFlow<Boolean>|是否为前置摄像头。|
+|localMirrorType|StateFlow<MirrorType>|镜像状态。|
+|localVideoQuality|StateFlow<VideoQuality>|本地视频质量。|
+|currentAudioRoute|StateFlow<AudioRoute>|当前音频路由位置。|
+|screenStatus|StateFlow<DeviceStatus>|屏幕分享状态。|
+|networkInfo|StateFlow<NetworkInfo>|网络信息。|
+|networkType|StateFlow<NetworkType>|当前网络类型。|
+
+## API 列表
+
+|**函数名**|**描述**|
+|---------|---------|
+|DeviceStore.shared|单例对象。|
+|openLocalMicrophone|打开本地麦克风。|
+|closeLocalMicrophone|关闭本地麦克风。|
+|setCaptureVolume|设置采集音量。|
+|setOutputVolume|设置输出音量。|
+|setAudioRoute|设置音频路由。|
+|startCameraTest|开始摄像头测试。|
+|stopCameraTest|停止摄像头测试。|
+|openLocalCamera|打开本地摄像头。|
+|closeLocalCamera|关闭本地摄像头。|
+|switchCamera|切换摄像头。|
+|switchMirror|切换镜像状态。|
+|updateVideoQuality|更新视频质量。|
+|startScreenShare|开启屏幕分享。|
+|stopScreenShare|关闭屏幕分享。|
+|reset|重置为默认状态。|
+
+### 获取实例
+
+#### DeviceStore.shared
+
+单例对象。
+
+### 麦克风操作
+
+#### openLocalMicrophone
+
+打开本地麦克风。
+``` kotlin
+abstract fun openLocalMicrophone(completion: CompletionHandler?)
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|completion|CompletionHandler?|操作是否成功。|
+
+#### closeLocalMicrophone
+
+关闭本地麦克风。
+``` kotlin
+abstract fun closeLocalMicrophone()
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+#### setCaptureVolume
+
+设置采集音量。
+``` kotlin
+abstract fun setCaptureVolume(volume: Int)
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|volume|Int|采集音量，取值范围0到100。|
+
+#### setOutputVolume
+
+设置最大输出音量。
+``` kotlin
+abstract fun setOutputVolume(volume: Int)
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|volume|Int|最大音量，取值范围0到100。|
+
+### 音频路由
+
+#### setAudioRoute
+
+设置音频路由。
+``` kotlin
+abstract fun setAudioRoute(audioRoute: AudioRoute)
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|audioRoute|AudioRoute|路由位置。|
+
+### 摄像头操作
+
+#### startCameraTest
+
+开始摄像头测试，如果摄像头打开成功，会将画面渲染到设置的 CameraView 上。
+``` kotlin
+abstract fun startCameraTest(cameraView: CameraView, completion: CompletionHandler?)
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|cameraView|CameraView|摄像头采集画面的渲染视图。|
+|completion|CompletionHandler?|操作是否成功。|
+
+#### stopCameraTest
+
+停止摄像头测试。
+``` kotlin
+abstract fun stopCameraTest()
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+#### openLocalCamera
+
+打开本地摄像头。
+``` kotlin
+abstract fun openLocalCamera(isFront: Boolean, completion: CompletionHandler?)
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|isFront|Boolean|是否前置摄像头。|
+|completion|CompletionHandler?|操作是否成功。|
+
+#### closeLocalCamera
+
+关闭本地摄像头。
+``` kotlin
+abstract fun closeLocalCamera()
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+#### switchCamera
+
+切换摄像头。
+``` kotlin
+abstract fun switchCamera(isFront: Boolean)
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|isFront|Boolean|是否前置摄像头。|
+
+#### switchMirror
+
+切换镜像状态。
+``` kotlin
+abstract fun switchMirror(mirrorType: MirrorType)
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|mirrorType|MirrorType|镜像状态。|
+
+#### updateVideoQuality
+
+更新视频质量。
+``` kotlin
+abstract fun updateVideoQuality(quality: VideoQuality)
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|quality|VideoQuality|视频质量。|
+
+### 屏幕分享
+
+#### startScreenShare
+
+开启屏幕分享。
+``` kotlin
+abstract fun startScreenShare()
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+#### stopScreenShare
+
+关闭屏幕采集。
+``` kotlin
+abstract fun stopScreenShare()
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+### 重置
+
+#### reset
+
+重置为默认状态。
+``` kotlin
+abstract fun reset()
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+## 数据结构
+
+### DeviceType
+
+设备类型。
+
+|**枚举值**|**值**|**说明**|
+|---------|---------|---------|
+|MICROPHONE|0|麦克风类型。|
+|CAMERA|1|摄像头类型。|
+|SCREEN_SHARE|2|屏幕分享类型。|
+
+### DeviceError
+
+设备相关错误码。
+
+|**枚举值**|**值**|**说明**|
+|---------|---------|---------|
+|NO_ERROR|0|操作成功。|
+|NO_DEVICE_DETECTED|1|未检测到设备。|
+|NO_SYSTEM_PERMISSION|2|没有系统权限。|
+|NOT_SUPPORT_CAPTURE|3|不支持采集。|
+|OCCUPIED_ERROR|4|设备已占用。|
+|UNKNOWN_ERROR|5|未知错误。|
+
+### DeviceStatus
+
+设备开启状态。
+
+|**枚举值**|**值**|**说明**|
+|---------|---------|---------|
+|OFF|0|关闭。|
+|ON|1|开启。|
+
+### AudioRoute
+
+音频路由。
+
+|**枚举值**|**值**|**说明**|
+|---------|---------|---------|
+|SPEAKERPHONE|0|扬声器，使用扬声器播放（即"免提"），扬声器位于手机底部，声音偏大，适合外放音乐。|
+|EARPIECE|1|听筒，使用听筒播放，听筒位于手机顶部，声音偏小，适合需要保护隐私的通话场景。|
+
+### VideoQuality
+
+视频质量档位。
+
+|**枚举值**|**值**|**说明**|
+|---------|---------|---------|
+|QUALITY_360P|1|360P，分辨率 640 × 360。|
+|QUALITY_540P|2|540P，分辨率 960 × 540。|
+|QUALITY_720P|3|720P，分辨率 1280 × 720。|
+|QUALITY_1080P|4|1080P，分辨率 1920 × 1080。|
+
+### NetworkQuality
+
+网络质量。
+
+|**枚举值**|**值**|**说明**|
+|---------|---------|---------|
+|UNKNOWN|0|未知网络。|
+|EXCELLENT|1|极佳。|
+|GOOD|2|良好。|
+|POOR|3|较差。|
+|BAD|4|差。|
+|VERY_BAD|5|极差。|
+|DOWN|6|中断。|
+
+### MirrorType
+
+摄像头镜像状态。
+
+|**枚举值**|**值**|**说明**|
+|---------|---------|---------|
+|AUTO|0|自动，前置摄像头镜像，后置摄像头不镜像。|
+|ENABLE|1|前后摄像头均镜像。|
+|DISABLE|2|前后摄像头均不镜像。|
+
+### NetworkType
+
+网络类型。
+
+|**枚举值**|**值**|**说明**|
+|---------|---------|---------|
+|UNKNOWN|0|未知或未识别的网络类型。|
+|WIFI|1|WiFi 网络连接。|
+|CELLULAR|2|蜂窝/移动数据网络连接。|
+
+### DeviceFocusOwner
+
+设备焦点。
+
+|**枚举值**|**说明**|
+|---------|---------|
+|call|语音通话场景。|
+|live|直播场景。|
+|room|房间场景。|
+|none|未设置。|
+
+### NetworkInfo
+
+网络信息。
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|userID|String|用户唯一 ID。|
+|quality|NetworkQuality|网络质量。|
+|upLoss|Int|上行丢包率，取值范围0到100。|
+|downLoss|Int|下行丢包率，取值范围0到100。|
+|delay|Int|延迟（单位：毫秒）。|
+
+### DeviceState
+
+设备状态。
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|microphoneStatus|StateFlow<DeviceStatus>|麦克风状态。|
+|microphoneLastError|StateFlow<DeviceError>|麦克风错误，用于出现报错时提取错误信息。|
+|captureVolume|StateFlow<Int>|采集音量，取值范围0到100。|
+|currentMicVolume|StateFlow<Int>|当前用户实际输出音量。|
+|outputVolume|StateFlow<Int>|最大输出音量，取值范围0到100。|
+|cameraStatus|StateFlow<DeviceStatus>|摄像头状态。|
+|cameraLastError|StateFlow<DeviceError>|摄像头错误，用于出现报错时提取错误信息。|
+|isFrontCamera|StateFlow<Boolean>|是否为前置摄像头。|
+|localMirrorType|StateFlow<MirrorType>|镜像状态。|
+|localVideoQuality|StateFlow<VideoQuality>|本地视频质量。|
+|currentAudioRoute|StateFlow<AudioRoute>|当前音频路由位置。|
+|screenStatus|StateFlow<DeviceStatus>|屏幕分享状态。|
+|networkInfo|StateFlow<NetworkInfo>|网络信息。|
+|networkType|StateFlow<NetworkType>|当前网络类型。|
+
+## 使用示例
+``` kotlin
+// 获取单例实例
+val store = DeviceStore.shared()
+// 订阅状态变化
+lifecycleScope.launch {
+    store.deviceState.microphoneStatus.collect { status ->
+        println("麦克风状态: $status")
+    }
+}
+lifecycleScope.launch {
+    store.deviceState.cameraStatus.collect { status ->
+        println("摄像头状态: $status")
+    }
+}
+// 打开麦克风
+store.openLocalMicrophone { code, message ->
+    if (code == 0) {
+        println("麦克风打开成功")
+    }
+}
+// 打开前置摄像头
+store.openLocalCamera(isFront = true) { code, message ->
+    if (code == 0) {
+        println("摄像头打开成功")
+    }
+}
+```

package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md

@@ -0,0 +1,173 @@
+## 简介
+
+`GiftStore` 提供了一套完整的礼物管理 API，包括发送礼物、刷新礼物列表、设置语言和监听礼物事件。 通过该类，可以在直播间内实现礼物互动功能。
+
+> **重要：**
+>
+
+> 使用 **GiftStore.create** 工厂方法创建 `GiftStore` 实例，需要传入有效的直播间 ID。
+>
+
+> **说明：**
+>
+
+> 礼物状态更新通过 **giftState** 发布者传递。订阅它以接收房间内礼物数据的实时更新。
+>
+
+## 功能特性
+- **礼物发送**：支持向当前房间发送指定礼物。
+
+- **礼物列表**：获取和刷新当前房间可用的礼物列表。
+
+- **语言设置**：设置礼物信息的展示语言。
+
+- **事件监听**：监听礼物接收事件。
+
+## 可订阅数据
+
+**GiftState** 的字段描述如下：
+
+|**属性名**|**类型**|**描述**|
+|---------|---------|---------|
+|usableGifts|StateFlow<List<GiftCategory>>|当前房间可用的所有礼物分类及礼物列表。|
+
+## API 列表
+
+|**函数名**|**描述**|
+|---------|---------|
+|GiftStore.create|创建礼物管理实例。|
+|addGiftListener|礼物事件回调。|
+|removeGiftListener|礼物事件回调。|
+|sendGift|发送礼物。|
+|refreshUsableGifts|刷新可用礼物列表。|
+|setLanguage|设置展示语言。|
+
+### 创建实例
+
+#### GiftStore.create
+
+创建礼物管理实例。
+
+### 观察状态和事件
+
+#### addGiftListener
+
+礼物事件回调。
+
+#### removeGiftListener
+
+礼物事件回调。
+
+### 礼物操作
+
+#### sendGift
+
+向当前房间发送指定礼物。
+``` kotlin
+abstract fun sendGift(
+        giftID: String,
+        count: Int,
+        completion: CompletionHandler?
+    )
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|giftID|String|要发送的礼物唯一标识 ID。|
+|count|Int|单次发送的礼物数量。|
+|completion|CompletionHandler?|完成回调（成功/失败状态）。|
+
+#### refreshUsableGifts
+
+手动刷新当前房间的可用礼物列表。
+``` kotlin
+abstract fun refreshUsableGifts(completion: CompletionHandler?)
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|completion|CompletionHandler?|完成回调（成功时可通过 state 获取最新礼物列表，失败时返回错误信息）。|
+
+#### setLanguage
+
+设置礼物信息的展示语言。
+``` kotlin
+abstract fun setLanguage(language: String)
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|language|String|语言代码（"zh-CN" 表示中文，"en" 表示英文），设置完成展示界面刷新后礼物名称、描述等会同步更新为对应语言。|
+
+## 数据结构
+
+### Gift
+
+礼物数据模型，包含单个礼物的完整属性信息。
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|giftID|String|礼物 ID。|
+|name|String|礼物名称。|
+|desc|String|礼物描述。|
+|iconURL|String|礼物图标图片的网络 URL，用于加载礼物缩略图。|
+|resourceURL|String|礼物动效资源文件的网络 URL，用于加载礼物展示动效。|
+|level|Long|礼物等级，用于区分礼物稀有度或价值层级。|
+|coins|Long|礼物价格（金币）。|
+|extensionInfo|Map<String,String>|礼物扩展信息，可自定义字段（如特效类型、赠送限制等）。|
+
+### GiftCategory
+
+礼物分类。
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|categoryID|String|分类唯一标识 ID，用于区分不同礼物分类。|
+|name|String|分类展示名称，用于 UI 分类显示（如 "热门礼物"，"高级礼物"）。|
+|desc|String|分类描述信息，用于说明该分类的特点。|
+|extensionInfo|Map<String,String>|分类扩展信息，包含自定义字段（如排序权重、显示样式等）。|
+|giftList|List<Gift>|当前分类下的所有礼物列表。|
+
+### GiftState
+
+礼物状态，管理当前房间的礼物数据状态，支持实时更新并可被订阅监听。
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|usableGifts|StateFlow<List<GiftCategory>>|当前房间可用的所有礼物分类及礼物列表。|
+
+### GiftListener
+
+礼物事件，用于接收直播间/语音聊天房内的礼物动态。
+
+**方法**
+
+**onReceiveGift**: 收到新礼物消息的事件回调。当直播间/语音聊天房内有其他观众发送礼物时，会触发该事件并返回相关信息。
+``` kotlin
+open fun onReceiveGift(liveID: String, gift: Gift, count: Int, sender: LiveUserInfo) {}
+```
+
+|**参数名**|**类型**|**说明**|
+|---------|---------|---------|
+|liveID|String|直播间 ID。|
+|gift|Gift|礼物信息。|
+|count|Int|礼物数量。|
+|sender|LiveUserInfo|礼物发送者信息。|

package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/LikeStore.md

@@ -1,11 +1,11 @@
 ## 简介
 
-**LikeStore** 提供了一套完整的点赞管理 API，包括发送点赞、监听点赞事件和获取点赞状态。通过该类，可以在直播间内实现点赞互动功能。
+`LikeStore` 提供了一套完整的点赞管理 API，包括发送点赞、监听点赞事件和获取点赞状态。通过该类，可以在直播间内实现点赞互动功能。
 
 > **重要：**
 >
 
-> 使用 **LikeStore.create** 工厂方法创建 **LikeStore** 实例，需要传入有效的直播间 ID。
+> 使用 **LikeStore.create** 工厂方法创建 `LikeStore` 实例，需要传入有效的直播间 ID。
 >
 
 > **说明：**
@@ -26,9 +26,10 @@
 ### LikeState
 
 点赞状态，用于展示和订阅直播间/语音聊天房的点赞信息。
-| **属性** | **类型** | **说明** |
-| --- | --- | --- |
-| totalLikeCount | StateFlow<Long> | 当前直播间/语音聊天房的累计总点赞数，支持实时更新并可被订阅监听。 |
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|totalLikeCount|StateFlow<Long>|当前直播间/语音聊天房的累计总点赞数，支持实时更新并可被订阅监听。|
 
 ### LikeListener
 
@@ -42,8 +43,9 @@
 ``` kotlin
 open fun onReceiveLikesMessage(liveID: String, totalLikesReceived: Long, sender: LiveUserInfo) {}
 ```
-| **参数名** | **类型** | **说明** |
-| --- | --- | --- |
-| liveID | String | 直播间ID。 |
-| totalLikesReceived | Long | 本次收到的新点赞数。 |
-| sender | LiveUserInfo | 点赞发送者信息。 |
+
+|**参数名**|**类型**|**说明**|
+|---------|---------|---------|
+|liveID|String|直播间 ID。|
+|totalLikesReceived|Long|本次收到的新点赞数。|
+|sender|LiveUserInfo|点赞发送者信息。|