Versions Compared

Key

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

Table of Contents

...

The available metrics

...

WCS sends the following stream parameters for aquisitionacquisition:

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

...

Code Block
languagejs
themeRDark
https://hostname:8090/api/metric/list
{
  "id": "4"
}

Where:

  • id – metric Id.

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

The response contains the following fields:

Code Block
languagejs
themeRDark
[
    {
        "id": 4,
        "name": "Video rate",
        "note": "",
        "enumName": "VIDEO_RATE"
    }
]

Metrics

...

acquisition principles

Metrics are combined to profiles to collect from specific nodes. Every profile contains specific metrics set and aquisition acquisition rate. A couple of metric aquisition rules can be set for certain profile which For a profile, several metric acquisition rules, which are applied to a stream on a node, can be specified.

A number of profiles can be applied to one node (WCS instance). In this that case, metric sets and rules from the profiles are summarized, and minimum aquisition acquisition rate for same metric is applied. Let's look to on the example:

1. The profiles profile1 and profile2 are applied to test1.flasphonerflashphoner.com node

2. profile1 includes:

  • VIDEO_RATE, VIDEO_FPS metrics which are aquired acquired with rate 5
  • the rule Stream name == stream1

3. profile2 includes:

  • VIDEO_RATE, AUDIO_RATE metrics which are aquired acquired with rate 10
  • the rule Stream name == stream1

As a the result, for the stream stream1 on test1.flashphoner.com node the following metric sets will be aquiredacquired:

  • VIDEO_RATE with rate 5
  • VIDEO_FPS with rate 5
  • AUDIO_RATE with rate 10