Overview
WCS supports realtime stream publishing and playing parameters monitoring with REST API
Metrics available
Metric | Description |
VIDEO_HEIGHT | Video height |
VIDEO_WIDTH | Video width |
VIDEO_RATE | Video bitrate |
VIDEO_SYNC | Video synchronization |
VIDEO_FPS | Video frame rate per second |
VIDEO_NACK | NACK requests count |
VIDEO_PLI | PLI packets count |
VIDEO_CODEC | Video codec |
| VIDEO_K_FRAMES | Video key frames (I-frames) count |
| VIDEO_P_FRAMES | Video P frames count |
| VIDEO_B_FRAMES | Video B frames count |
| VIDEO_LOST | Video lost packets count |
AUDIO_SYNC | Audio synchronization |
AUDIO_RATE | Audio bitrate |
AUDIO_LOST | Lost audio packets count |
AUDIO_CODEC | Audio codec |
REST API
REST query should be HTTP/HTTPS POST request as follows:
- HTTP: http://streaming.flashphoner.com:8081/rest-api/stream/metrics
- HTTPS: https://streaming.flashphoner.com:8444/rest-api/stream/metrics
Where
- streaming.flashphoner.com - WCS server address
- 8081 - REST / HTTP port of WCS server
- 8444 - HTTPS port of WCS server
- rest-api - URL mandatory part
- /stream/metrics - REST query used
REST queries and response states
REST query | REST query body example | REST response example | Response states |
|---|---|---|---|
/stream/metrics | {
"mediaSessionId" : "72b76eb8-3c01-47f3-b308-a0516d51249b"
}
| {
"VIDEO_B_FRAMES": 0,
"VIDEO_WIDTH": 1920,
"VIDEO_SYNC": 1583463093448,
"AUDIO_RATE": 31832,
"VIDEO_PLI": 0,
"VIDEO_HEIGHT": 1080,
"AUDIO_SYNC": 1583463093415,
"VIDEO_FPS": 36,
"AUDIO_CODEC": 111,
"VIDEO_P_FRAMES": 3989,
"VIDEO_RATE": 684352,
"VIDEO_CODEC": 119,
"VIDEO_K_FRAMES": 173,
"VIDEO_NACK": 1,
"VIDEO_LOST": 1,
"AUDIO_LOST": 130
}
| 200 - Stream metrics received 404 - Stream not found |
Parameters
Parameter | Description | Example |
|---|---|---|
mediaSessionId | Media session Id | 72b76eb8-3c01-47f3-b308-a0516d51249b |