System ComponentsMiddlewareVideo IO & Storage (VIOS)VST API ReferenceVST Replay Stream Management API
VST Replay Stream Management API Reference
This page is for version Dev.
For other versions, use one of these documentation indexes:
- 3.3.0 (default): https://docs.nvidia.com/vss/3.3.0/llms.txt
- Dev: https://docs.nvidia.com/vss/dev/llms.txt
REST endpoints for the VST Replay Stream Management service.
The machine-readable OpenAPI specification is services/vios/doc/api/vst_replay_stream_ms/swagger.yaml in this repository.
Servers: https://localhost/api
Endpoint catalog
v1
| Method | Endpoint | Summary |
|---|---|---|
GET | /v1/replay/streams | Get list of available recorded streams |
GET | /v1/replay/stream/query | Query recorded stream for timestamp and metadata |
POST | /v1/replay/stream/start | Start recorded WebRTC streaming |
POST | /v1/replay/stream/swap | Switch stream type from live to recorded |
POST | /v1/replay/stream/stop | Stop recorded WebRTC streaming |
POST | /v1/replay/stream/pause | Pause the recorded WebRTC stream playback |
POST | /v1/replay/stream/resume | Resume the recorded stream WebRTC playback |
POST | /v1/replay/stream/seek | Perform seek operation on the stream |
GET | /v1/replay/stream/seek | Get current position in the stream playback |
GET | /v1/replay/stream/status | Get recorded stream playback status |
GET | /v1/replay/stream/{streamId}/picture | Get picture or snapshot of recorded streaming |
GET | /v1/replay/stream/{streamId}/picture/url | Get temporary URL for accessing replay picture |
GET | /v1/replay/stream/stats | Get recorded stream stats |
POST | /v1/replay/setAnswer | Share SDP answer with replay streaming service |
GET | /v1/replay/iceCandidate | Get list of ICE Candidates generated by replay streaming service |
POST | /v1/replay/iceCandidate | Share client’s ICE candidate with replay streaming service |
GET | /v1/replay/iceServers | Get list of ICE servers |
GET | /v1/replay/configuration | Get replay stream service configuration |
POST | /v1/replay/configuration | Set replay stream service configuration |
GET | /v1/replay/version | Get replay stream service version |
GET | /v1/replay/help | Get list of supported APIs by replay stream service |