跳到主要内容
Esc

Rerinku View SDK

本页内容

Rerinku View SDK 面向两类开发者:做摄像头的厂商,以及要在自己的网页或程序里用 Rerinku View 的集成方。它由两个库和一套 HTTP 接口组成,都以 Apache-2.0 开源。

组成 给谁用 做什么
设备端 SDK(C) 摄像头、门铃、开发板的固件 设备主动接入 Rerinku View:注册、接收命令、把硬件编码器的输出用 WebRTC 推上来
Web SDK(@rerinku/player) 网页、Electron 等浏览器环境 列设备、取缩略图,在 <video> 上播放实时画面和录像,断线自动重连
开放接口(HTTP) 服务端程序、原生 App、脚本 不用 SDK,直接用 REST 接口读设备信息、拉实时流

它们在系统里的位置

摄像头固件 ──设备端 SDK──▶ Rerinku View(你自己的机器)◀──Web SDK / 开放接口── 网页、程序、App
               注册:HTTP                         设备列表、缩略图:HTTP
               命令:MQTT                         实时画面:WebRTC
               画面:WebRTC(WHIP)
  • 设备主动连 Rerinku View。 设备端 SDK 不需要摄像头开端口、也不需要 ONVIF 或 RTSP:设备一注册就出现在控制台,有人看的时候才开始推流。
  • 只上行一份。 不管多少人在看,设备都只推一路给 Rerinku View,由 Rerinku View 分发给各个观看端,摄像头的上行带宽不会随观看人数增加。
  • 实时画面直连。 实时画面用 WebRTC 在设备、Rerinku View 和观看端之间直接传输,全程加密;只有开了快速连接且直连不通时,才经过 TURN 中继转发。

怎么选

  • 你在做摄像头固件:用设备端 SDK。只要你的编码器能输出 H.264 或 H.265,接入大约是 200 行 C。已经支持 ONVIF 或 RTSP 的摄像头不需要 SDK,Rerinku View 可以直接接入。
  • 你在做网页:用 Web SDK。播放、重连、编码判断都已经处理好,你只需要提供一个 <video>。
  • 你在写服务端程序或原生 App:直接调开放接口;如果运行环境有浏览器能力(如 Electron),也可以用 Web SDK。

版本与许可

版本 许可 获取方式
设备端 SDK 0.5.0 Apache-2.0 源码编译,见设备端 SDK
Web SDK 0.1.0 Apache-2.0 npm 包 @rerinku/player(尚未发布)

两个 SDK 都遵循语义化版本:1.0 之前,次版本号(如 0.5 → 0.6)可能带来不兼容的改动,修订号(0.5.0 → 0.5.1)不会。每次变更都记在各自的 CHANGELOG.md 里。

Rerinku View 服务端本身不开源;SDK 只依赖它公开的协议和接口。