概述
TXIoTEngine 是整个 SDK 的入口，通过 getInstance(Context) 获取单例，使用前须先调用 login 完成身份验证。说明：
线程模型：SDK 接口可在任意线程调用；回调均在主线程（UI 线程）触发，调用方可在回调中直接操作 UI。
SDK 模块总览：
模块 | 说明 |
TXIoTEngine 引擎管理 | 登录、获取各个业务对象。 |
TXIoTFamilyManager 家庭与房间管理 | 家庭、房间、成员管理。 |
TXIoTDeviceManager 设备管理 | 设备绑定/解绑、分享、指令下发、属性查询。 |
TXIoTCallSession 音视频通话 | 音视频通话。 |
TXIoTMonitorSession 监控直播 | 监控直播（拉流/对讲/云台/截图/录像）。 |
公共类型与枚举 | 错误码、通用枚举、公共数据结构、回调接口。 |
方法列表
方法签名 | 描述 |
获取 TXIoTEngine 单例。 | |
添加引擎事件监听器。 | |
移除引擎事件监听器。 | |
登录 SDK（异步）。 | |
登出 SDK。 | |
获取当前登录用户信息。 | |
获取家庭管理器，未登录时返回 null。 | |
获取设备管理器，未登录时返回 null。 | |
获取音视频通话会话，未登录时返回 null。 | |
获取实时监控会话，未登录时返回 null。 |
getInstance
getInstance
TXIoTEngine getInstance | (Context context) |
获取 TXIoTEngine 单例
参数 | 描述 |
context | Context；Android 上下文。 |
返回值 | 描述 |
TXIoTEngine | 返回 TXIoTEngine 单例实例。 |
addListener
addListener
void addListener | (TXIoTEngineListener listener) |
添加引擎事件监听器
参数 | 描述 |
listener | TXIoTEngineListener；监听器实例。 |
removeListener
removeListener
void removeListener | (TXIoTEngineListener listener) |
移除引擎事件监听器
参数 | 描述 |
listener | TXIoTEngineListener；监听器实例。 |
login
login
void login | (String appKey, String userId, TXIoTUserSignature userSignature) |
登录 SDK（异步）
参数 | 描述 |
appKey | String；应用 Key。 |
userId | String；用户 ID。 |
userSignature | TXIoTUserSignature；用户身份签名（含 requestId / timestamp / nonce / signature）。 |
logout
logout
void logout | () |
登出 SDK
getLoginUserInfo
getLoginUserInfo
TXIoTUserInfo getLoginUserInfo | () |
获取当前登录用户信息
返回值 | 描述 |
TXIoTUserInfo | 返回 TXIoTUserInfo 对象；未登录时返回 null。 |
getFamilyManager
getFamilyManager
TXIoTFamilyManager getFamilyManager | () |
获取家庭管理器（登录后可用）
返回值 | 描述 |
TXIoTFamilyManager | 返回 TXIoTFamilyManager 实例；未登录时返回 null。 |
getDeviceManager
getDeviceManager
TXIoTDeviceManager getDeviceManager | () |
获取设备管理器（登录后可用）
返回值 | 描述 |
TXIoTDeviceManager | 返回 TXIoTDeviceManager 实例；未登录时返回 null。 |
getCallSession
getCallSession
TXIoTCallSession getCallSession | () |
获取音视频通话会话（登录后可用）
返回值 | 描述 |
TXIoTCallSession | 返回 TXIoTCallSession 实例；未登录时返回 null。 |
getMonitorSession
getMonitorSession
TXIoTMonitorSession getMonitorSession | () |
获取实时监控会话（登录后可用）
返回值 | 描述 |
TXIoTMonitorSession | 返回 TXIoTMonitorSession 实例；未登录时返回 null。 |
引擎事件回调
TXIoTEngineListener 是抽象类，所有回调方法均有默认空实现，调用方可按需覆写。TXIoTEngineListener
回调方法 | 说明 |
onLoginSuccess() | 登录成功。登录成功后各业务模块 getter 生效。 |
onLoginFailure(TXIoTErrorCode errCode, String errMsg) | 登录失败。errCode 为错误码，errMsg 为错误描述。 |
onLogout() | 登出完成。各业务模块 getter 失效。 |
onUserSignatureExpired() | 用户签名已过期，需重新获取签名后调用 login。 |
onReceivePushMessage(TXIoTPushMessage pushMessage) | 收到服务器推送消息，包含设备上下线等状态变更通知。 |
引擎相关数据结构与枚举
TXIoTPushMessage
TXIoTPushMessage
设备推送消息，包含消息时间、类型和关联设备
字段 | 说明 |
messageTime | 消息时间戳。 |
type | 消息类型。 |
subType | 消息子类型。 |
deviceId | 关联的设备 ID。 |
TXIoTPushMessageType
TXIoTPushMessageType
枚举 | 说明 |
STATUS_CHANGE | 设备状态变更。 |
TXIoTPushMessageSubType
TXIoTPushMessageSubType
枚举 | 说明 |
ONLINE | 设备上线。 |
OFFLINE | 设备离线。 |
TXIoTUserSignature
TXIoTUserSignature
字段 | 说明 |
requestId | 请求 ID，由服务端签发。 |
timestamp | 签名的 Unix 秒级时间戳。 |
nonce | 签名随机数。 |
signature | 签名字符串，由服务端签发。 |
