Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

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

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"
}
{
    "AUDIO_CODEC": 103, 
    "AUDIO_LOST": 0, 
    "AUDIO_RATE": 164952, 
    "AUDIO_SYNC": 242648, 
    "VIDEO_CODEC": 119, 
    "VIDEO_FPS": 31, 
    "VIDEO_HEIGHT": 720, 
    "VIDEO_NACK": 0, 
    "VIDEO_PLI": 0, 
    "VIDEO_RATE": 3945704, 
    "VIDEO_SYNC": 242600, 
    "VIDEO_WIDTH": 1280
}

200 - Stream metrics received

404 - Stream not found

Parameters

Parameter

Description

Example

mediaSessionId

Media session Id

72b76eb8-3c01-47f3-b308-a0516d51249b

  • No labels