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

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

@@ -0,0 +1,173 @@
+---
+product: iot
+framework:
+  - ios
+types:
+  - api
+retrievable_scope: always
+feature_domain: client_api
+---
+
+## 概述
+
+`TXIoTEngine` 是整个 SDK 的入口，通过 `+(instancetype)getInstance` 获取单例，使用前须先调用 `login` 完成身份验证。
+
+> **说明：**
+> 线程模型：SDK 接口可在任意线程调用；回调均在主线程（UI 线程）触发，调用方可在回调中直接操作 UI。
+>
+
+SDK 模块一览：
+
+|模块|说明|
+|---------|---------|
+|TXIoTEngine 引擎管理|登录、获取各个业务对象。|
+|TXIoTFamilyManager 家庭与房间管理|家庭、房间、成员管理。|
+|TXIoTDeviceManager 设备管理|设备绑定/解绑、分享、指令下发、属性查询。|
+|TXIoTCallSession 音视频通话|音视频通话。|
+|TXIoTMonitorSession 监控直播|监控直播（拉流/对讲/云台/截图/录像）。|
+|公共类型与枚举|错误码、通用枚举、公共数据结构、回调接口。|
+
+## 方法列表
+
+|方法签名|描述|
+|---------|---------|
+|getInstance|获取引擎单例。|
+|addDelegate: / removeDelegate:|添加/移除引擎事件代理。|
+|login:userId:userSignature:|使用 appKey、userId、用户签名登录。|
+|logout|登出当前账号。|
+|getLoginUserInfo|获取当前登录用户信息。|
+|getFamilyManager|获取家庭管理器，未登录时返回 null。|
+|getDeviceManager|获取设备管理器，未登录时返回 null。|
+|getCallSession|获取音视频通话会话，未登录时返回 null。|
+|getMonitorSession|获取实时监控会话，未登录时返回 null。|
+
+### getInstance
+
+**获取引擎单例**
+
+|返回值|描述|
+|---------|---------|
+|TXIoTEngine 实例|SDK 引擎单例对象。|
+
+### addDelegate:
+
+**添加引擎事件**代理对象
+
+|参数|描述|
+|---------|---------|
+|delegate|`id<TXIoTEngineDelegate>`；引擎事件代理对象。|
+
+### removeDelegate:
+
+**移除引擎事件代理对象**
+
+|参数|描述|
+|---------|---------|
+|delegate|`id<TXIoTEngineDelegate>`；要移除的引擎事件代理对象。|
+
+### login:userId:userSignature:
+
+**使用 appKey、userId、用户签名进行登录**
+
+|参数|描述|
+|---------|---------|
+|appKey|`NSString*`；应用密钥。|
+|userId|`NSString*`；用户 ID。支持字母、数字、下划线，长度不超过 32 字节。|
+|userSignature|TXIoTUserSignature*；用户签名对象，见 TXIoTUserSignature。|
+
+### logout
+
+**登出当前账号**
+
+### getLoginUserInfo
+
+**获取当前已登录的用户信息**
+
+|返回值|描述|
+|---------|---------|
+|TXIoTUserInfo*|已登录返回用户信息对象；未登录返回 nil。类型定义见 TXIoTUserInfo。|
+
+### getFamilyManager
+
+**获取家庭管理器**
+
+|返回值|描述|
+|---------|---------|
+|TXIoTFamilyManager*|已登录返回家庭管理器实例；未登录返回 nil。。|
+
+### getDeviceManager
+
+**获取设备管理器**
+
+|返回值|描述|
+|---------|---------|
+|TXIoTDeviceManager*|已登录返回设备管理器实例；未登录返回 nil。。|
+
+### getCallSession
+
+**获取音视频通话会话**
+
+|返回值|描述|
+|---------|---------|
+|TXIoTCallSession*|已登录返回通话会话实例；未登录返回 nil。。|
+
+### getMonitorSession
+
+**获取实时监控会话**
+
+|返回值|描述|
+|---------|---------|
+|TXIoTMonitorSession*|已登录返回监控会话实例；未登录返回 nil。。|
+
+## 引擎事件回调
+
+`TXIoTEngineDelegate` 协议定义引擎层事件回调，所有方法均为 `@optional`。
+
+|回调|说明|
+|---------|---------|
+|onLoginSuccess|登录成功。|
+|onLoginFailure:errMsg:|登录失败，返回 TXIoTErrorCode 和错误信息。|
+|onLogout|登出完成。|
+|onUserSignatureExpired|用户签名已过期，需重新登录。|
+|onReceivePushMessage:|收到推送消息（如设备上下线状态变更）。|
+
+## 引擎相关数据结构与枚举
+
+### TXIoTPushMessage
+
+推送消息，通过 `onReceivePushMessage:` 回调接收。
+
+|字段|说明|
+|---------|---------|
+|messageTime|推送消息时间戳（Unix 秒级时间戳）。|
+|type|推送消息类型。|
+|subType|推送消息子类型。|
+|deviceId|关联的设备 ID。|
+
+### TXIoTUserSignature
+
+用户签名，用于登录认证。
+
+|字段|说明|
+|---------|---------|
+|requestId|请求 ID，由服务端签发。|
+|timestamp|签名的 Unix 秒级时间戳。|
+|nonce|签名随机数。|
+|signature|签名字符串，由服务端签发。|
+
+### TXIoTPushMessageType
+
+推送消息类型枚举。
+
+|枚举|取值|
+|---------|---------|
+|TXIoTPushMessageTypeStatusChange|0|
+
+### TXIoTPushMessageSubType
+
+推送消息子类型枚举。
+
+|枚举|取值|
+|---------|---------|
+|TXIoTPushMessageSubTypeOnline|0|
+|TXIoTPushMessageSubTypeOffline|1|

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

@@ -0,0 +1,171 @@
+---
+product: iot
+framework:
+  - ios
+types:
+  - api
+retrievable_scope: always
+feature_domain: client_api
+---
+
+## 概述
+
+本文档描述 IoT App SDK 在 iOS 端的公共类型与枚举定义，包含错误码、通用枚举、公共数据结构与通用回调等，定义于 `TXIoTEngineDef.h`。
+
+> **说明：**
+> `TXIoTEngineDef.h` 是各模块共用的基础类型定义头文件，各模块文档见：
+>
+> - TXIoTEngine：引擎管理。
+> - TXIoTFamilyManager：家庭与房间管理。
+> - TXIoTDeviceManager：设备管理。
+> - TXIoTCallSession：音视频通话。
+> - TXIoTMonitorSession：实时监控。
+
+## 错误码 — TXIoTErrorCode
+
+|错误码|取值||
+|---------|---------|---------|
+|TXIoTErrorCodeSuccess|0|成功。|
+|TXIoTErrorCodeFailed|-1|通用失败。|
+|TXIoTErrorCodeInvalidParameter|-2|参数非法。|
+|TXIoTErrorCodeInvalidAccessToken|-3|Access Token 无效。|
+|TXIoTErrorCodeRateLimited|-4|请求频率超限。|
+|TXIoTErrorCodeUnauthorizedOperation|-5|未授权操作。|
+|TXIoTErrorCodeDeviceBound|-1000|设备已绑定。|
+|TXIoTErrorCodeBindTokenNotExist|-1001|绑定令牌不存在。|
+|TXIoTErrorCodeBindTokenIsExpired|-1002|绑定令牌已过期。|
+|TXIoTErrorCodeBindTokenNoPairWithDevice|-1003|绑定令牌与设备不匹配。|
+|TXIoTErrorCodeInvalidMessageId|-1004|消息 ID 无效。|
+|TXIoTErrorCodeFamilyDeviceLimitExceeded|-1005|家庭设备数量超限。|
+|TXIoTErrorCodeCanNotBindSameFamily|-1006|不能绑定到同一家庭。|
+|TXIoTErrorCodeFamilyNotExist|-1007|家庭不存在。|
+|TXIoTErrorCodeProductNotExist|-1008|产品不存在。|
+|TXIoTErrorCodeDeviceNotExist|-1009|设备不存在。|
+|TXIoTErrorCodeDeviceOffline|-1010|设备离线。|
+|TXIoTErrorCodeCameraStartFail|-2000|摄像头启动失败。|
+|TXIoTErrorCodeCameraNotAuthorized|-2001|摄像头权限未授权。|
+|TXIoTErrorCodeCameraOccupy|-2002|摄像头被占用。|
+|TXIoTErrorCodeMicStartFail|-2003|麦克风启动失败。|
+|TXIoTErrorCodeMicNotAuthorized|-2004|麦克风权限未授权。|
+|TXIoTErrorCodeMicOccupy|-2005|麦克风被占用。|
+|TXIoTErrorCodeSpeakerStartFail|-2006|扬声器启动失败。|
+|TXIoTErrorCodeRecordDurationTooShort|-2007|录制时长过短。|
+|TXIoTErrorCodeFilePathUnwritable|-2008|文件路径不可写。|
+|TXIoTErrorCodeFilePathAlreadyExist|-2009|文件路径已存在。|
+|TXIoTErrorCodeDeviceSwitchToVoIP|-2010|设备切换到 VOIP 模式。|
+
+## 通用枚举
+
+### TXIoTFamilyRole
+
+家庭角色。
+
+|枚举|取值|
+|---------|---------|
+|TXIoTFamilyRoleUnknown|0|
+|TXIoTFamilyRoleMember|1|
+|TXIoTFamilyRoleAdmin|2|
+
+## 公共数据结构
+
+### TXIoTDeviceId
+
+设备 ID，用于唯一标识一个设备。在 TXIoTEngine、TXIoTDeviceManager、TXIoTCallSession、TXIoTMonitorSession 中使用。
+
+|字段|说明|
+|---------|---------|
+|productId|产品 ID。|
+|deviceName|设备名称。|
+
+### TXIoTDeviceStatus
+
+设备在线状态。
+
+|字段|说明|
+|---------|---------|
+|isOnline|是否在线。|
+|onlineDuration|累计在线时长（单位：秒）。|
+|bringOnlineTime|上线时间戳（Unix 秒级时间戳）。|
+
+### TXIoTDeviceInfo
+
+设备信息。在 TXIoTDeviceManager 中使用。
+
+|字段|说明|
+|---------|---------|
+|deviceId|设备 ID。|
+|aliasName|设备别名。|
+|familyId|所属家庭 ID。|
+|roomId|所属房间 ID。|
+|iconUrl|设备图标 URL。|
+|createTime|创建时间（Unix 秒级时间戳）。|
+|updateTime|更新时间（Unix 秒级时间戳）。|
+|status|设备在线状态。|
+
+### TXIoTFamilyInfo
+
+家庭信息。在 TXIoTFamilyManager 中使用。
+
+|字段|说明|
+|---------|---------|
+|familyId|家庭 ID。|
+|name|家庭名称。|
+|createTime|创建时间（Unix 秒级时间戳）。|
+|updateTime|更新时间（Unix 秒级时间戳）。|
+|role|当前用户在该家庭中的角色。|
+
+### TXIoTRoomInfo
+
+房间信息。在 TXIoTFamilyManager 中使用。
+
+|字段|说明|
+|---------|---------|
+|roomId|房间 ID。|
+|name|房间名称。|
+|familyId|所属家庭 ID。|
+|deviceCount|房间内设备数量。|
+|createTime|创建时间（Unix 秒级时间戳）。|
+|updateTime|更新时间（Unix 秒级时间戳）。|
+
+### TXIoTUserInfo
+
+用户信息。在 TXIoTEngine、TXIoTFamilyManager、TXIoTDeviceManager 中使用。
+
+|字段|说明|
+|---------|---------|
+|userId|用户 ID。|
+|nickName|用户昵称。|
+|avatarUrl|用户头像 URL。|
+|role|用户角色。|
+|deviceBindTime|设备绑定时间（Unix 秒级时间戳）。|
+
+### TXIoTPageResult<T>
+
+分页查询结果泛型类。在 TXIoTDeviceManager 中使用。
+
+|字段|说明|
+|---------|---------|
+|dataList|当前页数据列表。|
+|nextPageToken|下一页游标；首次查询传空字符串，取结果中返回值用于获取下一页；为空字符串表示已到最后一页。|
+
+## 通用回调
+
+### TXIoTCallback<ResultType>
+
+有返回值的异步回调。
+``` objectivec
+@interface TXIoTCallback<__covariant ResultType> : NSObject
+@property(nonatomic, copy) void (^onSuccess)(ResultType _Nullable result);
+@property(nonatomic, copy) void (^onError)(TXIoTErrorCode errorCode, NSString* _Nullable errorMessage);
+@end
+```
+
+### TXIoTVoidCallback
+
+无返回值的异步回调。
+``` objectivec
+@interface TXIoTVoidCallback : NSObject
+@property(nonatomic, copy) void (^onSuccess)(void);
+@property(nonatomic, copy) void (^onError)(TXIoTErrorCode errorCode, NSString* _Nullable errorMessage);
+@end
+```

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

@@ -0,0 +1,146 @@
+---
+product: iot
+framework:
+  - ios
+types:
+  - api
+retrievable_scope: always
+feature_domain: client_api
+---
+
+## 概述
+
+TXIoTFamilyManager 负责家庭的创建/删除/更新、房间的创建/删除/重命名，以及家庭成员的邀请与管理。TXIoTFamilyManager 通过 TXIoTEngine.getFamilyManager 获取实例，需在 TXIoTEngine 登录成功后调用。
+
+> **说明：**
+> 回调模型：通过 TXIoTCallback / TXIoTVoidCallback 回调返回结果的接口，回调在主线程触发。
+>
+
+## 方法列表
+
+|方法签名|描述|
+|---------|---------|
+|createFamily:callback:|创建家庭。|
+|deleteFamily:callback:|删除家庭。|
+|getFamilyList:|获取家庭列表。|
+|updateFamilyInfo:callback:|更新家庭信息。|
+|createRoom:name:callback:|在家庭下创建房间。|
+|deleteRoom:roomId:callback:|删除房间。|
+|setRoomName:roomId:name:callback:|设置房间名称。|
+|getRoomList:callback:|获取家庭下的房间列表。|
+|createFamilyInviteToken:callback:|创建家庭邀请令牌。|
+|joinFamilyAsMember:callback:|通过邀请令牌以成员身份加入家庭。|
+|removeMemberFromFamily:userId:callback:|将成员移出家庭。|
+|getMemberList:callback:|获取家庭成员列表。|
+
+### createFamily:callback:
+
+**创建家庭**
+
+|参数|描述|
+|---------|---------|
+|name|`NSString*`；家庭名称。|
+|callback|TXIoTCallback<TXIoTFamilyInfo*>*；异步回调，通过 onSuccess / onError 通知结果。|
+
+### deleteFamily:callback:
+
+**删除家庭**
+
+|参数|描述|
+|---------|---------|
+|familyId|`NSString*`；家庭 ID。|
+|callback|TXIoTVoidCallback*；异步回调，通过 onSuccess / onError 通知结果。|
+
+### getFamilyList:
+
+**获取家庭列表**
+
+|参数|描述|
+|---------|---------|
+|callback|TXIoTCallback<NSArray<TXIoTFamilyInfo*>*>*；异步回调，通过 onSuccess / onError 通知结果。|
+
+### updateFamilyInfo:callback:
+
+**更新家庭信息**
+
+|参数|描述|
+|---------|---------|
+|newFamilyInfo|TXIoTFamilyInfo*；新的家庭信息对象。|
+|callback|TXIoTVoidCallback*；异步回调，通过 onSuccess / onError 通知结果。|
+
+### createRoom:name:callback:
+
+**在家庭下创建房间**
+
+|参数|描述|
+|---------|---------|
+|familyId|`NSString*`；家庭 ID。|
+|name|`NSString*`；房间名称。|
+|callback|TXIoTCallback<TXIoTRoomInfo*>*；异步回调，通过 onSuccess / onError 通知结果。|
+
+### deleteRoom:roomId:callback:
+
+**删除房间**
+
+|参数|描述|
+|---------|---------|
+|familyId|`NSString*`；家庭 ID。|
+|roomId|`NSString*`；房间 ID。|
+|callback|TXIoTVoidCallback*；异步回调，通过 onSuccess / onError 通知结果。|
+
+### setRoomName:roomId:name:callback:
+
+**设置房间名称**
+
+|参数|描述|
+|---------|---------|
+|familyId|`NSString*`；家庭 ID。|
+|roomId|`NSString*`；房间 ID。|
+|name|`NSString*`；新名称。|
+|callback|TXIoTVoidCallback*；异步回调，通过 onSuccess / onError 通知结果。|
+
+### getRoomList:callback:
+
+**获取家庭下的房间列表**
+
+|参数|描述|
+|---------|---------|
+|familyId|`NSString*`；家庭 ID。|
+|callback|TXIoTCallback<NSArray<TXIoTRoomInfo*>*>*；异步回调，通过 onSuccess / onError 通知结果。|
+
+### createFamilyInviteToken:callback:
+
+**创建家庭邀请令牌**
+
+|参数|描述|
+|---------|---------|
+|familyId|`NSString*`；家庭 ID。|
+|callback|TXIoTCallback<NSString*>*；异步回调，通过 onSuccess / onError 通知结果。|
+
+### joinFamilyAsMember:callback:
+
+**通过邀请令牌以成员身份加入家庭**
+
+|参数|描述|
+|---------|---------|
+|inviteToken|`NSString*`；邀请令牌。|
+|callback|TXIoTVoidCallback*；异步回调，通过 onSuccess / onError 通知结果。|
+
+### removeMemberFromFamily:userId:callback:
+
+**将成员移出家庭**
+
+|参数|描述|
+|---------|---------|
+|familyId|`NSString*`；家庭 ID。|
+|userId|`NSString*`；用户 ID。|
+|callback|TXIoTVoidCallback*；异步回调，通过 onSuccess / onError 通知结果。|
+
+### getMemberList:callback:
+
+**获取家庭成员列表**
+
+|参数|描述|
+|---------|---------|
+|familyId|`NSString*`；家庭 ID。|
+|callback|TXIoTCallback<NSArray<TXIoTUserInfo*>*>*；异步回调，通过 onSuccess / onError 通知结果。|