Page History

...

Metric	Id	Description
VIDEO_HEIGHT	2	Video height
VIDEO_WIDTH	3	Video width
VIDEO_RATE	4	Video bitrate, bps
VIDEO_SYNC	5	Video synchronization
VIDEO_FPS	6	Video frame rate per second
VIDEO_NACK	7	NACK requests count
VIDEO_PLI	8	PLI packets count
VIDEO_CODEC	9	Video codec
AUDIO_SYNC	10	Audio synchronization
AUDIO_RATE	11	Audio bitrate
AUDIO_LOST	12	Lost audio packets count
AUDIO_CODEC	13	Audio codec
VIDEO_B_FRAMES	16	B-frames count in the stream
VIDEO_K_FRAMES	17	K-frames count in the stream
VIDEO_P_FRAMES	18	P-frames count in the stream

The available metrics list can be obtained using /api/metric/list request

API

Request

Response

Response status

WS API

Code Block

theme	RDark

SEND
destination:/app/api/metric/list
content-length:100

{
 "requestId":"eb2c2807-8c2f-4418-aebe-03622404e4bb",
 "realm":"/api/metric/list",
 "payload":
  {
    "id":"3"
  }
}

Code Block

theme	RDark

MESSAGE
destination:/user/service
content-type:application/json;charset=UTF-8
subscription:sub-1
message-id:3-8
content-length:159

{
 "requestId":"eb2c2807-8c2f-4418-aebe-03622404e4bb",
 "status":200,
 "reason":"SUCCESS",
 "payload":[
  {
    "id":3,
    "name":"Video rate",
    "note":"",
    "enumName":"VIDEO_RATE"
  }
 ]
}

200 OK

400 Object not found

500 Persist exception

REST API

Code Block

theme	RDark

POST: /api/metric/list "application/json; charset=utf-8"
{"id":"3"}

Code Block

theme	RDark

{
    "status": 200,
    "reason": "SUCCESS",
    "payload": [
        {
            "id": 3,
            "name": "Video rate",
            "note": "",
            "enumName": "VIDEO_RATE"
        }
    ]
}

200 OK

400 Obkect not found

Where

id – metric Id
name - metric name
note - metric note
enumName - metric mnemonic identifier

...

Space shortcuts

Page tree

Versions Compared

Old Version 6

New Version Current

Key