Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Metric

Id

Description

VIDEO_HEIGHT

12

Video height

VIDEO_WIDTH

23

Video width

VIDEO_RATE

34

Video bitrate, bps

VIDEO_SYNC

45

Video synchronization

VIDEO_FPS

56

Video frame rate per second

VIDEO_NACK

67

NACK requests count

VIDEO_PLI

78

PLI packets count

VIDEO_CODEC

89

Video codec

AUDIO_SYNC

910

Audio synchronization

AUDIO_RATE

1011

Audio bitrate

AUDIO_LOST

1112

Lost audio packets count

AUDIO_CODEC

1213

Audio codec

The available metrics list can be obtained using REST API query /api/metric/list

...

request

APIRequestResponseResponse status
WS API
Code Block
themeRDark

...

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

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

...

    "id":

...

"

...

3"
  }
}

Where

  • id – metric Id

If metric Id is set, the response will contain information about the metric with this Id only. Otherwise, response will contain list with all the available metrics.

The response contains the following fields:

...

languagejs
themeRDark

...

Code Block
themeRDark
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
themeRDark
POST: /api/metric/list "application/json; charset=utf-8"
{"id":"3"}
Code Block
themeRDark
{
    "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

If metric Id is set, the response will contain information about the metric with this Id only. Otherwise, response will contain list with all the available metrics.

Metrics acquisition principles

...