概述
本文档描述 IoT App SDK 在 Android 端的公共类型与枚举定义，包含错误码、通用枚举、公共数据结构与通用回调等，定义于
TXIoTEngineDef 接口中。说明：
TXIoTEngineDef 是各模块共用的基础类型定义接口，其他模块均通过 SDK 的公共依赖引入。各模块文档见：TXIoTEngine：引擎管理。
TXIoTFamilyManager：家庭与房间管理。
TXIoTDeviceManager：设备管理。
TXIoTCallSession：音视频通话。
TXIoTMonitorSession：实时监控。
TXIoTCloudStorage：云存回放。
错误码 — TXIoTErrorCode
TXIoTErrorCode
错误码 | 说明 |
Success | 成功。 |
Failed | 通用失败。 |
InvalidParameter | 参数非法。 |
InvalidAccessToken | Access Token 无效。 |
RateLimited | 请求频率超限。 |
UnauthorizedOperation | 未授权操作。 |
DeviceBound | 设备已绑定。 |
BindTokenNotExist | 绑定令牌不存在。 |
BindTokenIsExpired | 绑定令牌已过期。 |
BindTokenNoPairWithDevice | 绑定令牌与设备不匹配。 |
InvalidMessageId | 消息 ID 无效。 |
FamilyDeviceLimitExceeded | 家庭设备数量超限。 |
CanNotBindSameFamily | 不能绑定到同一家庭。 |
FamilyNotExist | 家庭不存在。 |
ProductNotExist | 产品不存在。 |
DeviceNotExist | 设备不存在。 |
DeviceOffline | 设备离线。 |
CameraStartFail | 摄像头启动失败。 |
CameraNotAuthorized | 摄像头权限未授权。 |
CameraOccupy | 摄像头被占用。 |
MicStartFail | 麦克风启动失败。 |
MicNotAuthorized | 麦克风权限未授权。 |
MicOccupy | 麦克风被占用。 |
SpeakerStartFail | 扬声器启动失败。 |
RecordDurationTooShort | 录制时长过短。 |
FilePathUnwritable | 文件路径不可写。 |
FilePathAlreadyExist | 文件路径已存在。 |
DeviceSwitchToVoIP | 设备切换到 VOIP 模式。 |
通用枚举
TXIoTFamilyRole
TXIoTFamilyRole
枚举 | 说明 |
Unknown | 未知。 |
Member | 普通成员。 |
Admin | 管理员。 |
公共数据结构
以下类型定义于
TXIoTEngineDef 接口中，作为 SDK 内部共用数据类型。TXIoTDeviceId
TXIoTDeviceId
字段 | 说明 |
productId | 产品 ID。 |
deviceName | 设备名称。 |
TXIoTDeviceStatus
TXIoTDeviceStatus
字段 | 说明 |
isOnline | 是否在线。 |
onlineDuration | 累计在线时长（单位：秒）。 |
bringOnlineTime | 上线时间戳（Unix 秒级时间戳）。 |
TXIoTDeviceInfo
TXIoTDeviceInfo
字段 | 说明 |
deviceId | 设备 ID。 |
aliasName | 设备别名。 |
familyId | 所属家庭 ID。 |
roomId | 所属房间 ID。 |
iconUrl | 设备图标 URL。 |
createTime | 创建时间（Unix 秒级时间戳）。 |
updateTime | 更新时间（Unix 秒级时间戳）。 |
status | 设备在线状态。 |
TXIoTFamilyInfo
TXIoTFamilyInfo
字段 | 说明 |
familyId | 家庭 ID。 |
name | 家庭名称。 |
createTime | 创建时间（Unix 秒级时间戳）。 |
updateTime | 更新时间（Unix 秒级时间戳）。 |
role | 当前用户在该家庭中的角色。 |
TXIoTRoomInfo
TXIoTRoomInfo
字段 | 说明 |
roomId | 房间 ID。 |
name | 房间名称。 |
familyId | 所属家庭 ID。 |
deviceCount | 房间内设备数量。 |
createTime | 创建时间（Unix 秒级时间戳）。 |
updateTime | 更新时间（Unix 秒级时间戳）。 |
TXIoTUserInfo
TXIoTUserInfo
字段 | 说明 |
userId | 用户 ID。 |
nickName | 用户昵称。 |
avatarUrl | 用户头像 URL。 |
role | 用户角色。 |
deviceBindTime | 设备绑定时间（Unix 秒级时间戳）。 |
TXIoTPageResult
TXIoTPageResult
分页查询结果。
T 为数据列表元素类型。在 TXIoTDeviceManager 的设备列表分页查询中使用：首次查询时 nextPageToken 传空，结果中返回的 nextPageToken 用于获取下一页。字段 | 说明 |
nextPageToken | 下一页游标；首次查询传空字符串，取结果中返回值用于获取下一页；为空字符串表示已到最后一页。 |
dataList | 当前页数据列表。 |
