RTStream Guide
Overview
RTStream enables real-time ingestion of live video streams (RTSP/RTMP) and desktop capture sessions. Once connected, you can record, index, search, and export content from live sources.
For code-level details (SDK methods, parameters, examples), see rtstream-reference.md.
Use Cases
- Security & Monitoring: Connect RTSP cameras, detect events, trigger alerts
- Live Broadcasts: Ingest RTMP streams, index in real-time, enable instant search
- Meeting Recording: Capture desktop screen and audio, transcribe live, export recordings
- Event Processing: Monitor live feeds, run AI analysis, respond to detected content
Quick Start
-
Connect to a live stream (RTSP/RTMP URL) or get RTStream from a capture session
-
Start ingestion to begin recording the live content
-
Start AI pipelines for real-time indexing (audio, visual, transcription)
-
Monitor events via WebSocket for live AI results and alerts
-
Stop ingestion when done
-
Export to video for permanent storage and further processing
-
Search the recording to find specific moments
RTStream Sources
From RTSP/RTMP Streams
Connect directly to a live video source:
rtstream = coll.connect_rtstream(
url="rtmp://your-stream-server/live/stream-key",
name="My Live Stream",
)
From Capture Sessions
Get RTStreams from desktop capture (mic, screen, system audio):
session = conn.get_capture_session(session_id)
mics = session.get_rtstream("mic")
displays = session.get_rtstream("screen")
system_audios = session.get_rtstream("system_audio")
For capture session workflow, see capture.md.
Scripts
| Script | Description |
|---|---|
scripts/ws_listener.py |
WebSocket event listener for real-time AI results |