Rerinku View SDK

The Rerinku View SDK is for two kinds of developers: camera makers, and integrators who want to use Rerinku View in their own web pages or programs. It’s made up of two libraries and an HTTP API, all open source under Apache-2.0.

Part	For	What it does
Device SDK (C)	Firmware for cameras, doorbells and dev boards	The device connects to Rerinku View on its own: it registers, receives commands, and pushes the hardware encoder’s output over WebRTC
Web SDK (@rerinku/player)	Web pages, Electron and other browser environments	Lists devices, fetches thumbnails, plays live video and recordings on a <video>, and reconnects automatically
Open API (HTTP)	Server-side programs, native apps, scripts	Reads device info and pulls live streams directly over REST, without an SDK

Where they fit

Camera firmware ──Device SDK──▶ Rerinku View (your machine) ◀──Web SDK / Open API── Web pages, programs, apps
                  Register: HTTP                          Device list, thumbnails: HTTP
                  Commands: MQTT                          Live video: WebRTC
                  Video: WebRTC (WHIP)

• The device connects to Rerinku View. With the device SDK, the camera needs no open ports, and no ONVIF or RTSP. The device shows up in the console as soon as it registers, and starts streaming only when someone is watching.
• Only one upstream copy. However many people are watching, the device pushes only one stream to Rerinku View, and Rerinku View distributes it to each viewer. The camera’s upload bandwidth doesn’t grow with the number of viewers.
• Live video goes direct. Live video travels over WebRTC directly between the device, Rerinku View and viewers, encrypted end to end. It goes through a TURN relay only when Quick Connect is on and a direct connection doesn’t work.

How to choose

• You’re building camera firmware: use the device SDK. As long as your encoder can output H.264 or H.265, integration takes about 200 lines of C. Cameras that already support ONVIF or RTSP don’t need the SDK; Rerinku View can connect them directly.
• You’re building a web page: use the web SDK. Playback, reconnection and codec checks are already handled; all you provide is a <video>.
• You’re writing a server-side program or a native app: call the open API directly. If your runtime has browser capabilities (such as Electron), you can also use the web SDK.

Versions and licenses

	Version	License	How to get it
Device SDK	0.5.0	Apache-2.0	Build from source; see Device SDK
Web SDK	0.1.0	Apache-2.0	npm package @rerinku/player (not published yet)

Both SDKs follow Semantic Versioning. Before 1.0, a minor version (such as 0.5 → 0.6) may bring incompatible changes; a patch version (0.5.0 → 0.5.1) won’t. Every change is recorded in each SDK’s CHANGELOG.md.

The Rerinku View server itself isn’t open source. The SDKs depend only on its public protocols and API.