Skip to content

名词解释

客户端

客户端是用户或业务应用使用的一端,用来查询、回放、截图或导出目标设备的云录像。

基于 Flutter、React Native、Android、iOS、HarmonyOS 或 Electron SDK 开发的应用都属于客户端。客户端从业务服务端取得绑定目标设备的 app_access_token,再访问这台设备的录像。

设备端

设备端是运行在 IoT 音视频设备上的一端,用来把设备采集和编码后的音视频帧上传到云端。

设备端使用 C SDK,用自己的 device_iddevice_secret_key 建立 Service,再使用业务服务端签发的 device_access_token 取得上传权限。

业务服务端

业务服务端是由你部署和维护的可信服务。它保管 AppIdAccessKeyIdAccessKeySecret,完成用户与设备的业务授权判断,并调用 HTTP API。

业务服务端为设备签发 device_access_token,为客户端签发 app_access_token,也可以查询录像文件索引和删除录像。

AppId

AppId 是云存储应用的唯一标识。

同一个业务应用可以包含设备端、多个客户端技术栈和业务服务端,它们使用同一个 AppId 访问对应的云存储应用。AppId 不表示某个用户、某台设备或某段录像。

AccessKeyId

AccessKeyId 是应用级凭证标识。

业务服务端调用 HTTP API 时,用它标识签名使用的是哪组应用级凭证。AccessKeyId 本身不是密钥,必须和 AccessKeySecret 配套使用。

AccessKeySecret

AccessKeySecret 是应用级密钥,用于业务服务端生成 TGV1 请求签名。

只保存在可信业务服务端。不要下发到客户端或设备端,也不要写进源码、日志、截图或工单。

device_id

device_id 是设备在 TiStore 云存储服务中的稳定标识。

设备端创建 Service、业务服务端签发 Token、客户端访问录像,以及查询或删除录像时,都用同一个 device_id 表示这台设备。测试设备的取值在开通时随凭证下发,正式设备由项目的设备管理流程分配,见申请开通

device_secret_key

device_secret_key 是设备级密钥。

它和 device_id 一起证明设备身份,由设备端 C SDK 的 Service 使用。它不等同于应用级 AccessKeySecret,也不应通过普通配置、日志、聊天记录或工单传播。

device_access_token

device_access_token 是设备端上传录像使用的短期凭证。

业务服务端通过 HTTP API 为指定设备签发。设备端把它作为不透明字符串传给 C SDK,用于上传。

app_access_token

app_access_token 是客户端访问指定设备录像使用的短期凭证。

业务服务端确认当前用户有权访问目标设备后,为该设备签发。客户端把它作为不透明字符串传给 SDK。

通道

通道(Channel)表示同一设备中的一路媒体,由 channel_id 标识,取值范围为 0255

一个通道可以只包含音频帧、只包含视频帧,或同时包含两者。同一采集通道(通常是一个摄像头及其配套麦克风)的音频帧和视频帧使用相同的 channel_id。多摄像头、主子码流或多传感器设备可以分配多个通道;设备端和客户端要对各通道的业务含义保持一致。客户端回放时分别指定音频和视频的 channel_id,两者可以相同,也可以不同。

上传任务

上传任务是 C SDK 为一段媒体时间范围创建的异步处理过程。

创建请求成功只表示 SDK 接受了任务。设备持续写入音视频帧,任务根据开始和结束边界选择数据、上传并重试,最终结果以该请求的 on_result 回调为准。

录像时间段

录像时间段是一段可以查询和回放的云录像范围。

开始和结束时间都使用 UTC Unix 毫秒,范围采用左闭右开语义,即 [start_time_ms, end_time_ms)。结束时间点本身不属于当前时间段。

录像日期

录像日期是按指定 IANA 时区划分的自然日,使用 YYYY-MM-DD 格式表示。

日期查询会返回指定范围内的每一天。某一天至少存在一个当前可见的录像时点时,hasRecordingtrue。采用夏令时的地区可能存在 23 小时或 25 小时的自然日,因此不能把录像日期固定换算为 24 小时。

录像文件索引

录像文件索引是 HTTP API 返回的录像对象信息。业务服务端可以分页查询这些索引,并按设备和时间范围删除云端录像。

它和客户端 SDK 返回的录像时间段职责不同:前者面向服务端管理,后者面向客户端回放。

request_id

request_id 是服务端响应中的请求标识。

排查 HTTP API 问题时,记录本次请求的接口、发生时间、状态码、业务错误码和 request_id。不要同时记录 Token、Authorization 或签名原文。

TiStore 开发文档