帮你快速理解、总结文档立即下载
文档中心>物联网开发平台>客户端 API>Android>TXIoTEngineDef

TXIoTEngineDef

最近更新时间：2026-07-30 12:00:38

我的收藏

本页目录：

概述

本文档描述 IoT App SDK 在 Android 端的公共类型与枚举定义，包含错误码、通用枚举、公共数据结构与通用回调等，定义于 TXIoTEngineDef 接口中。
说明：
TXIoTEngineDef 是各模块共用的基础类型定义接口，其他模块均通过 SDK 的公共依赖引入。各模块文档见：
TXIoTEngine：引擎管理。
TXIoTFamilyManager：家庭与房间管理。
TXIoTDeviceManager：设备管理。
TXIoTCallSession：音视频通话。
TXIoTMonitorSession：实时监控。

错误码 — TXIoTErrorCode

TXIoTErrorCode
错误码
说明
ERR_SUCCESS
成功。
ERR_FAILED
通用失败。
ERR_INVALID_PARAMETER
参数非法。
ERR_INVALID_ACCESS_TOKEN
Access Token 无效。
ERR_RATE_LIMITED
请求频率超限。
ERR_UNAUTHORIZED_OPERATION
未授权操作。
ERR_DEVICE_BOUND
设备已绑定。
ERR_BIND_TOKEN_NOT_EXIST
绑定令牌不存在。
ERR_BIND_TOKEN_IS_EXPIRED
绑定令牌已过期。
ERR_BIND_TOKEN_NO_PAIR_WITH_DEVICE
绑定令牌与设备不匹配。
ERR_INVALID_MESSAGE_ID
消息 ID 无效。
ERR_FAMILY_DEVICE_LIMIT_EXCEEDED
家庭设备数量超限。
ERR_CAN_NOT_BIND_SAME_FAMILY
不能绑定到同一家庭。
ERR_FAMILY_NOT_EXIST
家庭不存在。
ERR_PRODUCT_NOT_EXIST
产品不存在。
ERR_DEVICE_NOT_EXIST
设备不存在。
ERR_DEVICE_OFFLINE
设备离线。
ERR_CAMERA_START_FAIL
摄像头启动失败。
ERR_CAMERA_NOT_AUTHORIZED
摄像头权限未授权。
ERR_CAMERA_OCCUPY
摄像头被占用。
ERR_MIC_START_FAIL
麦克风启动失败。
ERR_MIC_NOT_AUTHORIZED
麦克风权限未授权。
ERR_MIC_OCCUPY
麦克风被占用。
ERR_SPEAKER_START_FAIL
扬声器启动失败。
ERR_RECORD_DURATION_TOO_SHORT
录制时长过短。
ERR_FILE_PATH_UNWRITABLE
文件路径不可写。
ERR_FILE_PATH_ALREADY_EXIST
文件路径已存在。
ERR_DEVICE_SWITCH_TO_VOIP
设备切换到 VOIP 模式。

通用枚举

TXIoTFamilyRole

TXIoTFamilyRole
家庭角色枚举。在 TXIoTFamilyManager 的成员管理接口中使用。
枚举
说明
UNKNOWN
未知。
MEMBER
普通成员。
ADMIN
管理员。

公共数据结构

以下类型定义于 TXIoTEngineDef 接口中，作为 SDK 内部共用数据类型。

TXIoTDeviceId

TXIoTDeviceId
设备 ID，用于唯一标识一个设备。在 TXIoTDeviceManager 的绑定、查询接口中使用。
字段
说明
productId
产品 ID。
deviceName
设备名称。

TXIoTDeviceStatus

TXIoTDeviceStatus
设备在线状态。包含当前在线情况、累计在线时长和上线时间戳。在 TXIoTDeviceManager 的设备信息中包含此字段。
字段
说明
isOnline
是否在线。
onlineDuration
累计在线时长（单位：秒）。
bringOnlineTime
上线时间戳（Unix 秒级时间戳）。

TXIoTDeviceInfo

TXIoTDeviceInfo
设备信息。在 TXIoTDeviceManager 的绑定、设备列表、被分享设备列表等查询接口中返回。
字段
说明
deviceId
设备 ID。
aliasName
设备别名。
familyId
所属家庭 ID。
roomId
所属房间 ID。
iconUrl
设备图标 URL。
createTime
创建时间（Unix 秒级时间戳）。
updateTime
更新时间（Unix 秒级时间戳）。
status
设备在线状态。

TXIoTFamilyInfo

TXIoTFamilyInfo
家庭信息。在 TXIoTFamilyManager 的创建、查询接口中使用。
字段
说明
familyId
家庭 ID。
name
家庭名称。
createTime
创建时间（Unix 秒级时间戳）。
updateTime
更新时间（Unix 秒级时间戳）。
role
当前用户在该家庭中的角色。

TXIoTRoomInfo

TXIoTRoomInfo
房间信息。房间是家庭下的二级分组，在 TXIoTFamilyManager 的房间管理接口中使用。
字段
说明
roomId
房间 ID。
name
房间名称。
familyId
所属家庭 ID。
deviceCount
房间内设备数量。
createTime
创建时间（Unix 秒级时间戳）。
updateTime
更新时间（Unix 秒级时间戳）。

TXIoTUserInfo

TXIoTUserInfo
用户信息。在 TXIoTFamilyManager 的成员管理和 TXIoTDeviceManager 的设备分享接口中使用。
字段
说明
userId
用户 ID。
nickName
用户昵称。
avatarUrl
用户头像 URL。
role
用户角色。
deviceBindTime
设备绑定时间（Unix 秒级时间戳）。

TXIoTPageResult

TXIoTPageResult
分页查询结果。T 为数据列表元素类型。在 TXIoTDeviceManager 的设备列表分页查询中使用：首次查询时 nextPageToken 传空，结果中返回的 nextPageToken 用于获取下一页。
字段
说明
nextPageToken
下一页游标；首次查询传空字符串，取结果中返回值用于获取下一页；为空字符串表示已到最后一页。
dataList
当前页数据列表。

通用回调

TXIoTCallback

TXIoTCallback
有返回值的异步回调。在所有业务模块（TXIoTDeviceManager、TXIoTFamilyManager 等）中广泛使用。T 为回调成功时返回的结果类型：onSuccess(T result) 携带结果数据；onError(TXIoTErrorCode, String) 携带错误码与描述信息。
interface TXIoTCallback<T> {
    void onSuccess(T result);
    void onError(TXIoTErrorCode errorCode, String errorMessage);
}
中国站