Versions Compared

Key

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

...

ПараметрОписание
appKeyИдентификатор серверного приложения, которое должно взаимодействовать с бэкенд-сервером во время сеанса
mediaProvidersСписок поддерживаемых клиентом технологий публикации или воспроизведения потока
clientVersionВерсия SDK клиента
clientOSVersionВерсия операционной системы клиента
clientBrowserVersionВерсия браузера клиента

2. Сервер отправляет сообщение getUserData

Code Block
languagejs
themeRDark
{
  "message":"getUserData",
  "data":
    [
      {
        "useWsTunnel":false,
        "useWsTunnelPacketization2":false,
        "useBase64BinaryEncoding":false,
        "mediaProviders":["WebRTC","MSE","WSPlayer"],
        "authToken":"/5.129.23.83:50066/188.40.244.249:8443",
        "status":"ESTABLISHED",
        "clientVersion":"0.5.28",
        "clientOSVersion":"5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.80 Safari/537.36",
        "clientBrowserVersion":"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.80 Safari/537.36",
        "forceLogger":false,
        "keepAlive":false
      }
    ]
}

...

ПараметрОписание
mediaSessionIdИдентификатор WebRTC медиасессии
nameИмя воспроизводимого потока
publishedПоток опубликован на сервере (игнорируется)
hasVideoПрисутствует ли видео в потоке
hasAudioПрисутствует ли аудио в потоке
statusСтатус потока
audioCodecАудиокодек
videoCodecВидеокодек
infoТекстовое описание статуса
recordЗаписывается ли поток на сервере
widthШирина кадра
heightВысота кадра
bitrateБитрейт потока
minBitrateМинимальный битрейт потока
maxBitrateМаксимальный битрейт потока
qualityПоказатель качества потока
createDateДата создания в виде целого числа
streamInfoДополнительная информация о потоке на сервере
mediaProviderТехнология, используемая для воспроизведения

Метрики публикации/воспроизведения

В сборке 5.2.576 к сообщениям inboundVideoRate, outboundVideoRate, предназначенным для мониторинга качества канала публикации/воспроизведения, добавлены основные метрики потока, для контроля их на стороне клиента:

Code Block
languagejs
themeRDark
{
 "message":"inboundVideoRate",
 "data":
  [
    {
     "mediaSessionId":"a12145d0-7eee-11ea-9833-9da59e0cc100",
     "videoRate":704856,
     "fps":31,
     "nack":0,
     "pli":0,
     "lostPackets":0,
     "width":640,
     "height":360
    }
  ]
}
{
 "message":"outboundVideoRate",
 "data":
  [
    {
     "mediaSessionId":"0040ed40-7eef-11ea-9833-9da59e0cc100",
     "videoRate":685256,
     "fps":30,
     "nack":0,
     "pli":13,
     "lostPackets":0,
     "width":640,
     "height":360
    }
  ]
}

Параметры сообщения

ПараметрОписание
mediaSessionIdИдентификатор WebRTC медиасессии
videoRateБитрейт видео, бит/с
fpsЧастота кадров
nackКоличество NACK пакетов
pliКоличество PLI запросов
lostPacketsКоличество потерянных пакетов
widthШирина картинки
heightВысота картинки

Проверка доступности потока на сервере

Для проверки доступности потока на сервере необходимо отправить сообщение availableStream

Code Block
languagejs
themeRDark
[
  {
    "mediaSessionId": "2f693140-7d54-11eb-91fe-1fd0fb28f180",
    "name": "test"
  }
]

Параметры сообщения

ПараметрОписание
mediaSessionIdИдентификатор WebRTC медиасессии
nameИмя потока

В ответ сервер пришлет сообщение availableStream

Code Block
languagejs
themeRDark
[
  {
    "status": "false",
    "info": "Restricted access",
    "id": "2f693140-7d54-11eb-91fe-1fd0fb28f180"
  }
]

Параметры сообщения

ПараметрОписание
status

true, если поток доступен для воспроизведения

false, если недоступен

infoПричина недоступности потока
idИдентификатор WebRTC медиасессии

Информация о причине недоступности потока поддерживается, начиная со сборки 5.2.911