@tencentcloud/sdk-mcp 1.7.8 → 1.7.9-beta.1

package/resource/knowledge/iot/client-api/app/miniprogram/txiotfamilymanager.md

@@ -0,0 +1,179 @@
+---
+product: iot
+framework:
+  - minprogram
+types:
+  - api
+retrievable_scope: always
+feature_domain: client_api
+---
+
+## 概述
+
+TXIoTFamilyManager 负责家庭的创建/删除/更新、房间的创建/删除/重命名，以及家庭成员的邀请与管理。TXIoTFamilyManager 通过 TXIoTEngine.getFamilyManager 获取实例，需在登录成功后调用。
+
+> **说明：**
+> 家庭是设备的顶层组织单元，房间是家庭下的二级分组。用户创建家庭后自动成为 ADMIN，可通过 `createFamilyInviteToken` 生成邀请令牌，其他用户通过 `joinFamilyAsMember` 加入。
+>
+
+## 方法列表
+
+|方法签名|描述|
+|---------|---------|
+|createFamily|创建家庭。|
+|deleteFamily|删除家庭。|
+|getFamilyList|获取当前用户的家庭列表。|
+|updateFamilyInfo|更新家庭信息（如名称）。|
+|createRoom|在指定家庭下创建房间。|
+|deleteRoom|删除指定房间。|
+|setRoomName|设置/修改房间名称。|
+|getRoomList|获取指定家庭的房间列表。|
+|createFamilyInviteToken|创建家庭邀请令牌。|
+|joinFamilyAsMember|通过令牌加入家庭。|
+|removeMemberFromFamily|从家庭中移除成员。|
+|getMemberList|获取家庭成员列表。|
+
+### createFamily
+
+**创建家庭**
+
+|参数|描述|
+|---------|---------|
+|name|`String`；名称。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<TXIoTFamilyInfo>|家庭信息。|
+
+### deleteFamily
+
+**删除家庭**
+
+|参数|描述|
+|---------|---------|
+|familyId|`String`；家庭 ID。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<Void>|操作结果。|
+
+### getFamilyList
+
+**获取当前用户的家庭列表**
+
+|返回值|描述|
+|---------|---------|
+|Promise<TXIoTPageResult<TXIoTFamilyInfo>>|家庭信息列表。|
+
+### updateFamilyInfo
+
+**更新家庭信息（如名称）**
+
+|参数|描述|
+|---------|---------|
+|familyInfo|TXIoTFamilyInfo；新的家庭信息对象。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<Void>|操作结果。|
+
+### createRoom
+
+**在指定家庭下创建房间**
+
+|参数|描述|
+|---------|---------|
+|familyId|`String`；家庭 ID。|
+|name|`String`；家庭名称。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<TXIoTRoomInfo>|房间信息。|
+
+### deleteRoom
+
+**删除指定房间**
+
+|参数|描述|
+|---------|---------|
+|familyId|`String`；家庭 ID。|
+|roomId|`String`；房间 ID。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<Void>|操作结果。|
+
+### setRoomName
+
+**设置/修改房间名称**
+
+|参数|描述|
+|---------|---------|
+|familyId|`String`；家庭 ID。|
+|roomId|`String`；房间 ID。|
+|name|`String`；房间名称。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<Void>|操作结果。|
+
+### getRoomList
+
+**获取指定家庭的房间列表**
+
+|参数|描述|
+|---------|---------|
+|familyId|`String`；家庭 ID。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<TXIoTPageResult<TXIoTRoomInfo>>|房间信息列表。|
+
+### createFamilyInviteToken
+
+**创建家庭邀请令牌**
+
+|参数|描述|
+|---------|---------|
+|familyId|`String`；家庭 ID。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<String>|邀请令牌。|
+
+### joinFamilyAsMember
+
+**通过令牌加入家庭**
+
+|参数|描述|
+|---------|---------|
+|inviteToken|`String`；邀请令牌。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<Void>|操作结果。|
+
+### removeMemberFromFamily
+
+**从家庭中移除成员**
+
+|参数|描述|
+|---------|---------|
+|familyId|`String`；家庭 ID。|
+|userId|`String`；用户 ID。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<Void>|操作结果。|
+
+### getMemberList
+
+**获取家庭成员列表**
+
+|参数|描述|
+|---------|---------|
+|familyId|`String`；家庭 ID。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<List<TXIoTUserInfo>>|家庭成员列表。|

package/resource/knowledge/iot/client-api/app/miniprogram/txiotmonitorsession.md

@@ -0,0 +1,226 @@
+---
+product: iot
+framework:
+  - minprogram
+types:
+  - api
+retrievable_scope: always
+feature_domain: client_api
+---
+
+## 概述
+
+TXIoTMonitorSession 负责拉取设备实时监控画面，包括开始/停止会话、远端拉流与清晰度切换、与设备进行对讲、云台控制、截图。TXIoTMonitorSession 通过 TXIoTEngine.getMonitorSession 获取实例，需在登录成功后调用。
+
+> **说明：**
+> 回调模型：所有 Listener 回调在主线程触发，公共类型与错误码定义见 TXIoTEngineDef。
+>
+
+## 方法列表
+
+|方法签名|描述|
+|---------|---------|
+|addListener|添加实时监控事件监听器。|
+|removeListener|移除实时监控事件监听器。|
+|setIoTPlayer|设置 iot-player 的组件 ID|
+|startSession|开启实时监控。|
+|stopSession|停止实时监控。|
+|startRemoteView|开始渲染远端视频流。|
+|stopRemoteView|停止渲染远端视频流。|
+|switchRemoteStream|切换远端视频流类型（高清/标清）。|
+|muteRemoteAudio|静音/取消静音单路远端音频。|
+|muteAllRemoteAudio|静音/取消静音所有远端音频。|
+|startLocalAudio|开启本地音频采集和推送（用于实现对讲功能）。|
+|stopLocalAudio|关闭本地音频采集和推送。|
+|muteLocalAudio|静音/取消静音本地音频。|
+|startLocalVideo|开启本地视频采集和推送。|
+|stopLocalVideo|关闭本地视频采集和推送。|
+|sendPTZCommand|发送云台控制指令。|
+|takeSnapshot|对当前正在观看的通道进行截图。|
+
+### addListener
+
+**添加监控事件回调**
+
+|参数|描述|
+|---------|---------|
+|listener|`TXIoTMonitorSessionListener`；监听器实例。|
+
+### removeListener
+
+**移除监控事件回调**
+
+|参数|描述|
+|---------|---------|
+|listener|`TXIoTMonitorSessionListener`；监听器实例。|
+
+### setIoTPlayer
+
+**绑定渲染组件**
+
+|参数|描述|
+|---------|---------|
+|channelId|`int`；通道 ID。|
+|iotPlayerComponentId|`String`；iot-player 组件 ID。|
+
+### startSession
+
+**开启实时监控**
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+
+### stopSession
+
+**停止实时监控**
+
+### startRemoteView
+
+**开始渲染远端视频流**
+
+|参数|描述|
+|---------|---------|
+|channelId|`int`；通道 ID。|
+|streamType|TXIoTStreamType；视频流类型（高清/标清）。|
+
+### stopRemoteView
+
+**停止渲染远端视频流**
+
+|参数|描述|
+|---------|---------|
+|channelId|`int`；通道 ID。|
+
+### switchRemoteStream
+
+**切换远端视频流类型（高清/标清）**
+
+|参数|描述|
+|---------|---------|
+|channelId|`int`；通道 ID。|
+|streamType|TXIoTStreamType；视频流类型（高清/标清）。|
+
+### muteRemoteAudio
+
+**静音/取消静音单路远端音频**
+
+|参数|描述|
+|---------|---------|
+|channelId|`int`；通道 ID。|
+|mute|`boolean`；是否静音。|
+
+### muteAllRemoteAudio
+
+**静音/取消静音所有远端音频**
+
+|参数|描述|
+|---------|---------|
+|mute|`boolean`；是否静音。|
+
+### startLocalAudio
+
+**开启本地音频采集和推送（用于实现对讲功能）**
+
+### stopLocalAudio
+
+**停止本地音频采集和推送**
+
+### muteLocalAudio
+
+**静音/取消静音本地音频**
+
+|参数|描述|
+|---------|---------|
+|mute|`boolean`；是否静音。|
+
+### startLocalVideo
+
+**开启本地视频采集和推送**
+
+|参数|描述|
+|---------|---------|
+|videoEncoderParams|TXIoTVideoEncoderParams；视频编码参数。|
+
+### stopLocalVideo
+
+**停止本地视频采集和推送**
+
+### sendPTZCommand
+
+**发送云台控制指令**
+
+|参数|描述|
+|---------|---------|
+|channelId|`int`；通道 ID。|
+|command|TXIoTPTZCommand；云台控制指令。|
+|speed|`int`；云台运动速度。|
+
+### takeSnapshot
+
+**对当前正在观看的通道进行截图**
+
+|参数|描述|
+|---------|---------|
+|channelId|`int`；通道 ID。|
+
+## 监控事件回调
+
+|回调方法|说明|
+|---------|---------|
+|`onError(channelId: Number, code: Number, msg: String)`|监控发生错误。|
+|`onSessionEstablished()`|监控会话建立成功。|
+|`onSessionReconnecting()`|会话重连中。|
+|`onSessionRecovery()`|会话恢复成功。|
+|`onRemoteStreamAvailable(channelId: Number, available: boolean)`|远端流可用性变化。|
+|`onRenderFirstFrame(channelId: Number)`|首帧渲染完成。|
+|`onPlayStateChanged(channelId: Number, state: Number)`|播放状态变化。状态类型为 TXIoTPlayState。|
+|`onSnapshotComplete(channelId: Number, imagePath: String)`|截图完成，成功时 imagePath 非 null。|
+
+## 监控相关数据结构与枚举
+
+### TXIoTStreamType
+
+|枚举|说明|
+|---------|---------|
+|HD|高清|
+|SD|标清|
+
+### TXIoTPTZCommand
+
+|枚举|说明|
+|---------|---------|
+|UP|上|
+|DOWN|下|
+|LEFT|左|
+|RIGHT|右|
+|ZOOM_IN|变焦放大|
+|ZOOM_OUT|变焦缩小|
+|STOP|停止|
+
+### TXIoTPlayState
+
+|枚举|说明|
+|---------|---------|
+|PLAYING|正在播放|
+|LOADING|加载中|
+|STOPPED|已停止|
+
+### TXIoTVideoResolution
+
+|枚举|说明|
+|---------|---------|
+|RESOLUTION_640_360|横屏 640×360|
+|RESOLUTION_960_540|横屏 960×540|
+|RESOLUTION_1280_720|横屏 1280×720|
+|RESOLUTION_1920_1080|横屏 1920×1080|
+|RESOLUTION_360_640|竖屏 360×640|
+|RESOLUTION_540_960|竖屏 540×960|
+|RESOLUTION_720_1280|竖屏 720×1280|
+|RESOLUTION_1080_1920|竖屏 1080×1920|
+
+### TXIoTVideoEncoderParams
+
+|字段|说明|
+|---------|---------|
+|resolution|视频编码分辨率。|