Concepts
Glossary
Understand streams, sources, leases, retained frames, and private media references.
SDK 0.1.0Private preview
Core terms
| Term | Meaning |
|---|---|
| Stream | An owned, leased live-video resource with a bounded retained-frame history. |
| Source | The camera path feeding a stream: managed LiveKit, RTSP, HLS, or a customer LiveKit room. |
| Publish token | A short-lived LiveKit credential that can publish media to one managed stream. It cannot call the HTTP API. |
| Viewer token | A short-lived, subscribe-only LiveKit credential for watching a managed or pull stream. |
| Stream time | Milliseconds elapsed since the first captured frame, not since the stream resource was created. |
| Frame index | A zero-based lifetime frame number. Negative indices count backward from the latest retained frame. |
| Retained window | The bounded history still available for inference; currently ten minutes. |
hallikar:// reference | A private media selector resolved by Hallikar inside a chat-completion request. |
| Keepalive | A lease renewal that prevents an active stream from expiring. |
| Region pin | The optional X-Hallikar-Region header used to keep a stream and its follow-up calls in one region. |