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

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

@@ -0,0 +1,250 @@
+---
+product: iot
+framework:
+  - ios
+types:
+  - api
+retrievable_scope: always
+feature_domain: client_api
+---
+
+## 概述
+
+TXIoTMonitorSession 负责拉取设备实时监控画面，包括开始/停止会话、远端拉流与清晰度切换、与设备进行对讲、云台控制、截图与本地录制。TXIoTMonitorSession 通过 TXIoTEngine.getMonitorSession 获取实例，需在 TXIoTEngine 登录成功后调用。
+
+> **说明：**
+> 回调模型：监控事件通过 `TXIoTMonitorSessionDelegate` 协议回调，所有 Delegate 回调在主线程触发。公共类型与错误码定义见 TXIoTEngineDef。
+>
+
+## 方法列表
+
+|方法签名|描述|
+|---------|---------|
+|addDelegate:|添加实时监控事件代理。|
+|removeDelegate:|移除实时监控事件代理。|
+|startSession:|启动实时监控会话。|
+|stopSession|停止实时监控会话。|
+|startRemoteView:streamType:view:|开始远端拉流和渲染。|
+|stopRemoteView:|停止远端拉流和渲染。|
+|switchRemoteStream:streamType:|切换远端流的清晰度（高清/标清）。|
+|muteRemoteAudio:mute:|静音/取消静音单路远端音频。|
+|muteAllRemoteAudio:|静音/取消静音所有远端音频。|
+|startLocalAudio|开始对讲（上行音频）。|
+|stopLocalAudio|停止对讲。|
+|muteLocalAudio:|静音本地音频。|
+|startLocalVideo:videoEncoderParams:|开始本地视频采集和推送。|
+|stopLocalVideo|停止本地视频采集和推送。|
+|sendPTZCommand:command:speed:|发送云台控制指令。|
+|takeSnapshot:|对当前正在观看的通道进行截图。|
+|startLocalRecording:params:|开始对当前正在观看的通道进行录制。|
+|stopLocalRecording:|停止录制。|
+
+### addDelegate:
+
+**添加监控事件代理**
+
+|参数|描述|
+|---------|---------|
+|delegate|`id<TXIoTMonitorSessionDelegate>`；监控事件代理对象。|
+
+### removeDelegate:
+
+**移除监控事件代理**
+
+|参数|描述|
+|---------|---------|
+|delegate|`id<TXIoTMonitorSessionDelegate>`；要移除的监控事件代理对象。|
+
+### startSession:
+
+**启动实时监控会话**
+
+会话建立结果通过 `onSessionEstablished` 回调通知
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId*；要监控的设备 ID。|
+
+### stopSession
+
+**停止监控会话**
+
+### startRemoteView:streamType:view:
+
+**开始远端拉流渲染**
+
+|参数|描述|
+|---------|---------|
+|channelId|`NSInteger`；通道 ID。|
+|streamType|TXIoTStreamType；流类型：高清或标清。|
+|view|`TXView*`；用于渲染远端视频的视图。|
+
+### stopRemoteView:
+
+**停止远端拉流渲染**
+
+|参数|描述|
+|---------|---------|
+|channelId|`NSInteger`；通道 ID。|
+
+### switchRemoteStream:streamType:
+
+**切换远端流的清晰度（高清/标清）**
+
+|参数|描述|
+|---------|---------|
+|channelId|`NSInteger`；通道 ID。|
+|streamType|TXIoTStreamType；目标流的清晰度。|
+
+### muteRemoteAudio:mute:
+
+**静音/取消静音单路远端音频**
+
+|参数|描述|
+|---------|---------|
+|channelId|`NSInteger`；通道 ID。|
+|mute|`BOOL`；YES 静音，NO 取消静音。|
+
+### muteAllRemoteAudio:
+
+**静音/取消静音所有远端音频**
+
+|参数|描述|
+|---------|---------|
+|mute|`BOOL`；YES 静音，NO 取消静音。|
+
+### startLocalAudio
+
+**开始对讲（上行音频）**
+
+### stopLocalAudio
+
+**停止对讲**
+
+### muteLocalAudio:
+
+**静音本地音频**
+
+|参数|描述|
+|---------|---------|
+|mute|`BOOL`；YES 静音，NO 取消静音。|
+
+### startLocalVideo:videoEncoderParams:
+
+**开始本地视频采集和推送**
+
+|参数|描述|
+|---------|---------|
+|view|`TXView*`；用于渲染本地视频的视图。|
+|videoEncoderParams|TXIoTVideoEncoderParams*；视频编码参数。|
+
+### stopLocalVideo
+
+**停止本地视频采集和推送**
+
+### sendPTZCommand:command:speed:
+
+**发送云台控制指令**
+
+|参数|描述|
+|---------|---------|
+|channelId|`NSInteger`；通道 ID。|
+|command|TXIoTPTZCommand；云台指令。|
+|speed|`NSInteger`；控制速度。|
+
+### takeSnapshot:
+
+**截图。**截图结果通过 `onSnapshotComplete` 回调通知
+
+|参数|描述|
+|---------|---------|
+|channelId|`NSInteger`；通道 ID。|
+
+### startLocalRecording:params:
+
+**开始本地录制。**录制状态通过 Delegate 回调通知
+
+|参数|描述|
+|---------|---------|
+|channelId|`NSInteger`；通道 ID。|
+|params|TXIoTLocalRecordingParams*；录制参数，包含文件路径等。|
+
+### stopLocalRecording:
+
+**停止本地录制**
+
+|参数|描述|
+|---------|---------|
+|channelId|`NSInteger`；通道 ID。|
+
+## 监控事件回调
+
+`TXIoTMonitorSessionDelegate` 协议定义监控事件回调，所有方法均为 `@optional`。
+
+|回调|说明|
+|---------|---------|
+|onError:errorCode:errorMessage:|实时监控过程发生错误，错误码见 TXIoTErrorCode。|
+|onSessionEstablished|实时监控会话建立成功。|
+|onSessionReconnecting|实时监控会话重连中。|
+|onSessionRecovery|实时监控会话恢复。|
+|onRemoteStreamAvailable:available:|远端流可用性变化。|
+|onRenderFirstFrame:|首帧渲染完成。|
+|onPlayStateChanged:state:|播放状态变化。|
+|onSnapshotComplete:image:errorCode:|截图完成。|
+|onLocalRecordBegin:errorCode:storagePath:|本地录制开始。|
+|onLocalRecording:durationMs:storagePath:|本地录制进行中。|
+|onLocalRecordComplete:errorCode:storagePath:|本地录制完成。|
+
+## 监控相关数据结构与枚举
+
+### TXIoTVideoEncoderParams
+
+|字段|说明|
+|---------|---------|
+|resolution|视频编码分辨率。|
+
+### TXIoTLocalRecordingParams
+
+|字段|说明|
+|---------|---------|
+|filePath|本地录制文件保存路径。|
+
+### TXIoTStreamType
+
+|枚举|取值|说明|
+|---------|---------|---------|
+|TXIoTStreamTypeHD|0|高清|
+|TXIoTStreamTypeSD|1|标清|
+
+### TXIoTPTZCommand
+
+|枚举|取值|说明|
+|---------|---------|---------|
+|TXIoTPTZCommandUp|0|上|
+|TXIoTPTZCommandDown|1|下|
+|TXIoTPTZCommandLeft|2|左|
+|TXIoTPTZCommandRight|3|右|
+|TXIoTPTZCommandZoomIn|4|放大|
+|TXIoTPTZCommandZoomOut|5|缩小|
+|TXIoTPTZCommandStop|6|停止|
+
+### TXIoTPlayState
+
+|枚举|取值|说明|
+|---------|---------|---------|
+|TXIoTPlayStatePlaying|0|正在播放|
+|TXIoTPlayStateLoading|1|加载中|
+|TXIoTPlayStateStopped|2|已停止|
+
+### TXIoTVideoResolution
+
+|枚举|取值|说明|
+|---------|---------|---------|
+|TXIoTVideoResolution_640_360|0|横屏 640×360|
+|TXIoTVideoResolution_960_540|1|横屏 960×540|
+|TXIoTVideoResolution_1280_720|2|横屏 1280×720|
+|TXIoTVideoResolution_1920_1080|3|横屏 1920×1080|
+|TXIoTVideoResolution_360_640|4|竖屏 360×640|
+|TXIoTVideoResolution_540_960|5|竖屏 540×960|
+|TXIoTVideoResolution_720_1280|6|竖屏 720×1280|
+|TXIoTVideoResolution_1080_1920|7|竖屏 1080×1920|

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

@@ -0,0 +1,180 @@
+---
+product: iot
+framework:
+  - minprogram
+types:
+  - api
+retrievable_scope: always
+feature_domain: client_api
+---
+
+## 概述
+
+TXIoTCallSession 负责与设备之间的音视频通话，包括发起呼叫、挂断、远端画面渲染、麦克风/摄像头控制及音频输出设备选择。TXIoTCallSession 通过 TXIoTEngine.getCallSession 获取实例，需在登录成功后调用。
+
+> **说明：**
+> 回调模型：通话事件通过 `TXIoTCallListener` 接口回调，所有 Listener 回调在主线程触发，公共类型与错误码定义见 TXIoTEngineDef。
+>
+
+## 方法列表
+
+|方法签名|描述|
+|---------|---------|
+|addListener|添加通话事件监听器。|
+|removeListener|移除通话事件监听器。|
+|setIoTPlayer|绑定 iot-player 渲染组件。|
+|callDevice|向设备发起通话（音频/视频）。|
+|hangup|挂断当前通话。|
+|startRemoteView|开始渲染远端视频。|
+|stopRemoteView|停止渲染远端视频。|
+|openMicrophone|打开麦克风。|
+|closeMicrophone|关闭麦克风。|
+|openCamera|打开摄像头并设置本地预览视图。|
+|closeCamera|关闭摄像头。|
+|switchCamera|切换摄像头（前后置）。|
+|selectAudioPlaybackDevice|选择音频播放设备（扬声器/听筒）。|
+
+### addListener
+
+**添加通话事件监听器**
+
+|参数|描述|
+|---------|---------|
+|listener|`TXIoTCallListener`；监听器实例。|
+
+### removeListener
+
+**移除通话事件监听器**
+
+|参数|描述|
+|---------|---------|
+|listener|`TXIoTCallListener`；监听器实例。|
+
+### setIoTPlayer
+
+**绑定渲染组件**
+
+把某个远端用户与其对应的 `iot-player` 组件绑定，SDK 会在该组件上渲染远端用户的音视频。音频通话没有视频画面时也需要绑定组件，音频通过该组件播放。
+
+|参数|描述|
+|---------|---------|
+|callUser|TXIoTCallUser；参与通话的用户。|
+|iotPlayerComponentId|`String`；`iot-player` 组件的 componentId。|
+
+### callDevice
+
+**向设备发起通话（音频/视频）**
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+|callType|TXIoTCallMediaType；通话类型（音频/视频）。|
+
+### hangup
+
+**挂断当前进行中的通话**
+
+### startRemoteView
+
+**开始渲染远端视频**
+
+|参数|描述|
+|---------|---------|
+|callUser|TXIoTCallUser；参与通话的用户。|
+
+### stopRemoteView
+
+**停止渲染远端视频**
+
+|参数|描述|
+|---------|---------|
+|callUser|TXIoTCallUser；参与通话的用户。|
+
+### openMicrophone
+
+**打开麦克风**
+
+### closeMicrophone
+
+**关闭麦克风**
+
+### openCamera
+
+**打开摄像头并设置本地预览视图**
+
+|参数|描述|
+|---------|---------|
+|camera|TXIoTCamera；摄像头（前置/后置）。|
+
+### closeCamera
+
+**关闭摄像头**
+
+### switchCamera
+
+**切换摄像头（前后置）**
+
+|参数|描述|
+|---------|---------|
+|camera|TXIoTCamera；摄像头（前置/后置）。|
+
+### selectAudioPlaybackDevice
+
+**选择音频播放设备（扬声器/听筒）**
+
+|参数|描述|
+|---------|---------|
+|device|TXIoTAudioPlaybackDevice；音频播放设备（扬声器/听筒）。|
+
+## 通话事件回调
+
+|回调方法|说明|
+|---------|---------|
+|`onError(code: Number, msg: String)`|通话发生错误。|
+|`onCallBegin(mediaType: Number)`|通话开始。类型为 TXIoTCallMediaType。|
+|`onCallEnd(mediaType: Number, reason: Number)`|通话结束，携带结束原因。原因类型为 TXIoTCallEndReason。|
+|`onCallRejected(callUser: TXIoTCallUser)`|通话被对方拒接。|
+|`onCallNoResponse(callUser: TXIoTCallUser)`|对方无应答。|
+|`onCallLineBusy(callUser: TXIoTCallUser)`|对方占线。|
+|`onCallUserOffline(callUser: TXIoTCallUser)`|对方离线。|
+|`onCallUserAudioAvailable(callUser: TXIoTCallUser, available: boolean)`|远端用户音频状态发生变化。|
+|`onCallUserVideoAvailable(callUser: TXIoTCallUser, available: boolean)`|远端用户视频状态发生变化。|
+
+## 通话相关数据结构与枚举
+
+### TXIoTCallMediaType
+
+|枚举|说明|
+|---------|---------|
+|AUDIO|音频通话。|
+|VIDEO|视频通话。|
+
+### TXIoTCallEndReason
+
+|枚举|说明|
+|---------|---------|
+|UNKNOWN|未知原因。|
+|LOCAL_HANGUP|本地挂断。|
+|REMOTE_HANGUP|远端挂断。|
+|CALL_PERMISSION_DENIED|呼叫权限被拒绝。|
+|NETWORK_ERROR|网络错误。|
+
+### TXIoTAudioPlaybackDevice
+
+|枚举|说明|
+|---------|---------|
+|SPEAKERPHONE|扬声器（外放）。|
+|EARPIECE|听筒。|
+
+### TXIoTCamera
+
+|枚举|说明|
+|---------|---------|
+|FRONT|前置摄像头。|
+|BACK|后置摄像头。|
+
+### TXIoTCallUser
+
+|字段|说明|
+|---------|---------|
+|deviceId|参与通话的设备 ID。|

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

@@ -0,0 +1,76 @@
+---
+product: iot
+framework:
+  - minprogram
+types:
+  - api
+retrievable_scope: always
+feature_domain: client_api
+---
+
+## 概述
+
+`TXIoTCloudStorage` 是云存功能模块，通过 `TXIoTEngine.getCloudStorage(deviceId)` 获取，提供设备云端录像的日期列表与事件列表查询能力。
+
+> **说明：**
+> 云存模块与设备一一对应，每次调用 `getCloudStorage` 都会返回一个与 `deviceId` 绑定的新实例，不做缓存；未登录或初始化未完成时返回 `null`。所有异步方法均返回 Promise：成功 resolve 具体数据，失败 reject `{ code, message }`，其中 `code` 取值见 `TXIoTErrorCode`
+>
+
+## 方法列表
+
+|方法签名|描述|
+|---------|---------|
+|getDayList|查询指定通道有云端录像的日期列表。|
+|getEventList|分页查询指定日期的云存事件列表。|
+
+### getDayList
+
+**查询有云端录像的日期列表**
+
+|参数|描述|
+|---------|---------|
+|channelId|`int`；通道 ID，从 0 开始计数；单通道设备填 0。|
+|timeZoneId|`String`；按天统计录像所用的 IANA 时区 ID，例如 `Asia/Shanghai`。|
+
+|返回值|描述|
+|---------|---------|
+|`Promise<List<String>>`|有云端录像的日期字符串列表，格式为 `YYYY-MM-DD`（如`2026-08-20`）|
+
+### getEventList
+
+**分页查询指定日期的云存事件列表**
+
+|参数|描述|
+|---------|---------|
+|channelId|`int`；通道 ID，从 0 开始计数；单通道设备填 0。|
+|timeZoneId|`String`；按天统计事件所用的 IANA 时区 ID，例如 `Asia/Shanghai`。|
+|date|`String`；要查询的日期，格式为 `YYYY-MM-DD`（如`2026-08-20`），通常取自 `getDayList` 的返回结果。|
+|nextPageToken|`String`；分页游标。首次查询传空字符串 `''`；翻页时传入上一次返回结果中的 `nextPageToken`。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<TXIoTPageResult<TXIoTEvent>>|resolve 分页结果，`list` 为本页事件列表（元素类型为 `TXIoTEvent`），`nextPageToken` 为空字符串表示已经是最后一页；reject `{ code, message }`。|
+
+## 云存相关数据结构
+
+### TXIoTEvent
+
+**云存事件，包含事件类型、缩略图、发生时间及关联录像文件**
+
+|字段|说明|
+|---------|---------|
+|eventType|事件类型标识，可能为空字符串，调用方可按需过滤。|
+|thumbnailUrl|事件缩略图 URL。|
+|eventTimeMs|事件发生时间，Unix 毫秒级时间戳。|
+|durationMs|事件时长，单位毫秒。|
+|videoFiles|事件关联的录像文件列表，元素类型为 TXIoTVideoFile。|
+
+### TXIoTVideoFile
+
+**云存录像文件，包含播放地址与时间信息**
+
+|字段|说明|
+|---------|---------|
+|videoUrl|录像播放地址，为 HLS（m3u8）地址。|
+|startTimeMs|录像片段起始时间，Unix 毫秒级时间戳。|
+|durationMs|录像片段时长，单位毫秒。|