wehub-resource-sync
d48cda4081
CI / Test (ubuntu-latest, Node 18.x, bun) (push) Failing after 15m1s
CI / Test (ubuntu-latest, Node 18.x, npm) (push) Failing after 15m1s
CI / Test (ubuntu-latest, Node 18.x, pnpm) (push) Failing after 15m1s
CI / Test (ubuntu-latest, Node 18.x, yarn) (push) Failing after 15m1s
CI / Test (ubuntu-latest, Node 20.x, bun) (push) Failing after 17m13s
CI / Test (ubuntu-latest, Node 20.x, npm) (push) Failing after 18m42s
CI / Test (ubuntu-latest, Node 20.x, pnpm) (push) Failing after 15m0s
CI / Test (ubuntu-latest, Node 20.x, yarn) (push) Failing after 49m44s
CI / Test (ubuntu-latest, Node 22.x, bun) (push) Failing after 51m55s
CI / Test (ubuntu-latest, Node 22.x, pnpm) (push) Failing after 21m57s
CI / Test (ubuntu-latest, Node 22.x, npm) (push) Failing after 37m39s
CI / Test (ubuntu-latest, Node 22.x, yarn) (push) Failing after 34m7s
CI / Validate Components (push) Failing after 37m15s
CI / Python Tests (push) Failing after 10m1s
CI / Security Scan (push) Failing after 10m1s
CI / Lint (push) Failing after 17m12s
CI / Coverage (push) Failing after 20m19s
CI / Test (macos-latest, Node 18.x, bun) (push) Has been cancelled
CI / Test (macos-latest, Node 18.x, npm) (push) Has been cancelled
CI / Test (macos-latest, Node 18.x, pnpm) (push) Has been cancelled
CI / Test (macos-latest, Node 18.x, yarn) (push) Has been cancelled
CI / Test (windows-latest, Node 18.x, npm) (push) Has been cancelled
CI / Test (windows-latest, Node 18.x, pnpm) (push) Has been cancelled
CI / Test (windows-latest, Node 18.x, yarn) (push) Has been cancelled
CI / Test (macos-latest, Node 20.x, bun) (push) Has been cancelled
CI / Test (macos-latest, Node 20.x, npm) (push) Has been cancelled
CI / Test (macos-latest, Node 20.x, pnpm) (push) Has been cancelled
CI / Test (macos-latest, Node 20.x, yarn) (push) Has been cancelled
CI / Test (windows-latest, Node 20.x, npm) (push) Has been cancelled
CI / Test (windows-latest, Node 20.x, pnpm) (push) Has been cancelled
CI / Test (windows-latest, Node 20.x, yarn) (push) Has been cancelled
CI / Test (macos-latest, Node 22.x, bun) (push) Has been cancelled
CI / Test (macos-latest, Node 22.x, npm) (push) Has been cancelled
CI / Test (macos-latest, Node 22.x, pnpm) (push) Has been cancelled
CI / Test (macos-latest, Node 22.x, yarn) (push) Has been cancelled
CI / Test (windows-latest, Node 22.x, npm) (push) Has been cancelled
CI / Test (windows-latest, Node 22.x, pnpm) (push) Has been cancelled
CI / Test (windows-latest, Node 22.x, yarn) (push) Has been cancelled
66 lines
1.8 KiB
Markdown
66 lines
1.8 KiB
Markdown
# 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](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
|
|
|
|
1. **Connect to a live stream** (RTSP/RTMP URL) or get RTStream from a capture session
|
|
|
|
2. **Start ingestion** to begin recording the live content
|
|
|
|
3. **Start AI pipelines** for real-time indexing (audio, visual, transcription)
|
|
|
|
4. **Monitor events** via WebSocket for live AI results and alerts
|
|
|
|
5. **Stop ingestion** when done
|
|
|
|
6. **Export to video** for permanent storage and further processing
|
|
|
|
7. **Search the recording** to find specific moments
|
|
|
|
## RTStream Sources
|
|
|
|
### From RTSP/RTMP Streams
|
|
|
|
Connect directly to a live video source:
|
|
|
|
```python
|
|
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):
|
|
|
|
```python
|
|
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](capture.md).
|
|
|
|
---
|
|
|
|
## Scripts
|
|
|
|
| Script | Description |
|
|
|--------|-------------|
|
|
| `scripts/ws_listener.py` | WebSocket event listener for real-time AI results |
|