...
Current streams information can be obtained with /api/stream/list request
API | Request | Response | Response status | |||
---|---|---|---|---|---|---|
WS API |
|
|
| 200 OK 400 Object not found 500 Persist exception | ||||||
REST API |
|
|
| 200 OK 400 Object not found 500 Persist exception |
Where
- node – node identifier (mandatory)
- mediaId – media session identifier
- name – stream name
- age – stream cache record age in milliseconds
- publisher - publisher identifier (for played streams)
- status – stream status (PENDING, PUBLISHING, PLAYING, UNPUBLISHED, STOPPED, FAILED)
- showClosed - show closed streams from cache
- nodeIp - IP address of server monitored
- nodeHostName - hostname of server monitored
Response data are obtained from current metrics cache.
...
Current instantaneous metric values for stream published or played on WCS can be obtained with /api/stream/metrics request
API | Request | Response | Response status | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
WS API |
|
| 200 OK 400 Object not found 500 Persist exception | ||||||||||
REST API |
|
| 200 OK 400 Object not found 500 Persist exception |
Здесь:
- node – node identifier (mandatory)
- mediaId – media session identifier (mandatory)
- limit - messages quantity in cache selection
- offset - cache offset
- time - time stamp
- seq - cache message sequence number
...
Stream history information can be obtained with /api/stream/history request
API | Request | Response | Response status | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
WS API |
|
| 200 OK 400 Object not found 500 Persist exception | ||||||||||
REST API |
|
| 200 OK 400 Object not found 500 Persist exception |
Where
- node – node identifier
- mediaId – media session identifier
- name – stream name
- publisher - publisher identifier (for played streams)
- status – stream status (PENDING, PUBLISHING, PLAYING, UNPUBLISHED, STOPPED, FAILED)
- id - stream identifier in backend server database
- createDate – stream creation date
- endDate – stream termination date
- duration - длительность потока
- subscribers - list of identifiers of subscribers (for published streams)
...