Skip to navigation

VST Live Stream Management API Reference

View as Markdown

REST endpoints for the VST Live Stream Management service.

The machine-readable OpenAPI specification is services/vios/doc/api/vst_live_stream_ms/swagger.yaml in this repository.

Servers: https://localhost/api

Endpoint catalog

v1

MethodEndpointSummary
GET/v1/live/streamsGet list of available live streams
POST/v1/live/stream/settingsSet stream settings
GET/v1/live/stream/queryQuery live stream for timestamp and metadata
POST/v1/live/stream/startStart live WebRTC streaming
POST/v1/live/stream/swapSwitch stream type from recorded to live
POST/v1/live/stream/stopStop live WebRTC streaming
POST/v1/live/stream/pausePause the live stream WebRTC playback
POST/v1/live/stream/resumeResume the live stream WebRTC playback
GET/v1/live/stream/statusGet live stream playback status
GET/v1/live/stream/{streamId}/pictureGet picture or snapshot of live streaming
GET/v1/live/stream/{streamId}/picture/urlGet temporary URL for accessing live picture
GET/v1/live/stream/statsGet live stream stats
POST/v1/live/setAnswerShare SDP answer with live streaming service
POST/v1/live/iceCandidateShare client’s ICE candidate with live streaming service
GET/v1/live/iceCandidateGet list of ICE Candidates generated by live streaming service
GET/v1/live/iceServersGet list of ICE servers
GET/v1/live/configurationGet live stream service configuration
POST/v1/live/configurationSet live stream service configuration
GET/v1/live/versionGet live stream service version
GET/v1/live/helpGet list of supported APIs by live stream service