概述
TXIoTEngine 是整个 SDK 的入口，通过 getInstance() 获取单例，使用前须先调用 login 完成身份验证。SDK 模块一览：
模块 | 说明 |
TXIoTEngine 引擎管理 | 登录、获取各个业务对象。 |
TXIoTFamilyManager 家庭与房间管理 | 家庭、房间、成员管理。 |
TXIoTDeviceManager 设备管理 | 设备绑定/解绑、分享、指令下发、属性查询。 |
TXIoTCallSession 音视频通话 | 音视频通话。 |
TXIoTMonitorSession 监控直播 | 监控直播（拉流/对讲/云台/截图/录像）。 |
TXIoTCloudStorage 云存回放 | 云端录像的日期与事件查询。 |
公共类型与枚举 | 错误码、通用枚举、公共数据结构、回调接口。 |
方法列表
方法签名 | 描述 |
获取引擎单例。 | |
添加/移除引擎事件代理。 | |
使用 appKey、userId、用户签名登录。 | |
登出当前账号。 | |
获取当前登录用户信息。 | |
获取家庭管理器，未登录时返回 null。 | |
获取设备管理器，未登录时返回 null。 | |
获取音视频通话会话，未登录时返回 null。 | |
获取实时监控会话，未登录时返回 null。 | |
获取云存模块，未登录时返回 null。 |
getInstance
getInstance
getInstance | () |
获取引擎单例
返回值 | 描述 |
Promise<TXIoTEngine> | SDK 引擎单例对象；首次调用会等待内部 wasm 模块加载完成。 |
addListener
removeListener
removeListener
removeListener | (listener) |
移除引擎事件代理对象
参数 | 描述 |
listener | 要移除的引擎事件代理对象。 |
login
login
login | (appKey, userId, userSignature) |
使用 appKey、userId、用户签名进行登录
参数 | 描述 |
appKey | string；应用密钥。 |
userId | string；用户 ID。支持字母、数字、下划线，长度不超过32字节。 |
userSignature |
logout
logout
logout | () |
登出当前账号
getLoginUserInfo
getFamilyManager
getFamilyManager
getFamilyManager | () |
获取家庭管理器
返回值 | 描述 |
TXIoTFamilyManager |
getDeviceManager
getDeviceManager
getDeviceManager | () |
获取设备管理器
返回值 | 描述 |
TXIoTDeviceManager |
getCallSession
getCallSession
getCallSession | () |
获取音视频通话会话
返回值 | 描述 |
TXIoTCallSession |
getMonitorSession
getMonitorSession
getMonitorSession | () |
获取实时监控会话
返回值 | 描述 |
TXIoTMonitorSession |
getCloudStorage
getCloudStorage
getCloudStorage | (TXIoTDeviceId deviceId) |
获取云存模块
参数 | 描述 |
deviceId |
返回值 | 描述 |
TXIoTCloudStorage |
引擎事件回调
协议定义引擎层事件回调。
TXIoTEngineListener
回调 | 说明 |
onLoginSuccess | 登录成功。 |
onLoginFailure | |
onLogout | 登出完成。 |
onUserSignatureExpired | 用户签名已过期，需重新登录。 |
onReceivePushMessage | 收到推送消息（如设备上下线状态变更）。 |
引擎相关数据结构与枚举
TXIoTPushMessage
TXIoTPushMessage
推送消息，通过
onReceivePushMessage 回调接收。字段 | 说明 |
messageTime | 推送消息时间戳（Unix 秒级时间戳）。 |
type | 推送消息类型。 |
subType | 推送消息子类型。 |
deviceId | 关联的设备 ID。 |
TXIoTUserSignature
TXIoTUserSignature
用户签名，用于登录认证。
字段 | 说明 |
requestId | 请求 ID，由服务端签发。 |
timestamp | 签名的 Unix 秒级时间戳。 |
nonce | 签名随机数。 |
signature | 签名字符串，由服务端签发。 |
TXIoTPushMessageType
TXIoTPushMessageType
推送消息类型枚举。
枚举 | 取值 |
StatusChange | 0 |
TXIoTPushMessageSubType
TXIoTPushMessageSubType
推送消息子类型枚举。
枚举 | 取值 |
Online | 0 |
Offline | 1 |
