...

REST-метод

Пример тела REST-запроса

Пример тела REST-ответа

Статусы ответа

Описание

/hls/startup

Code Block

language	js
theme	RDark

{
  "name":"test"
}

200 - OK

404 - Stream not found

500 - Internal error

Запустить HLS нарезку указанного потока

/hls/find_all

Code Block

language	js
theme	RDark

{
  "offset":0,
  "size":10
}

Code Block

language	js
theme	RDark

[{
    "id": "test",
    "streamName": "test",
    "status": "ACTIVE",
    "waitingSize": 0,
    "profiles": [
      "a_test",
      "v_test"
    ],
    "subscribers": 1,
    "playlist": "...",
    "createdDate": 1697605114475,
    "logs": []
}]

200 – OK

404 – Not found

Найти все потоки, для которых есть HLS нарезки

/hls/terminate

Code Block

language	js
theme	RDark

{
  "name":"test"
}

200 – OK

404 – Not found

Завершить или перезапустить HLS нарезку указанного потока

/hls/profiles

Code Block

language	js
theme	RDark

{
  "hlsId":"test",
  "profileName":"v_test"
}

Code Block

language	js
theme	RDark

{
  "name": "v_test",
  "stream": {
    "appKey": "defaultApp",
    "sessionId": "test-HLS",
    "mediaSessionId": "81b8b278-612e-4b72-9153-454be9df0a34-test-HLS",
    "name": "test",
    "published": false,
    "hasVideo": false,
    "hasAudio": true,
    "status": "PLAYING",
    "sdp": "...",
    "videoCodec": "H264",
    "record": false,
    "width": 1280,
    "height": 720,
    "bitrate": 0,
    "minBitrate": 0,
    "maxBitrate": 0,
    "quality": 0,
    "parentMediaSessionId": "f3401d2e-7e9a-4e18-a353-d323c947ac94",
    "history": false,
    "gop": 0,
    "fps": 0,
    "audioBitrate": 0,
    "codecImpl": "",
    "transport": "UDP",
    "cvoExtension": true,
    "createDate": 1697605114875,
    "mediaType": "play",
    "audioState": {
      "muted": false
    },
    "videoState": {
      "muted": false
    },
    "mediaProvider": "HLS"
  },
  "keyFrameReceived": true,
  "videoProfile": {
    "type": "video",
    "width": 1280,
    "height": 720,
    "fps": 29,
    "bitrate": 1720,
    "codec": "",
    "quality": 0,
    "audioGroupId": "audio"
  },
  "metrics": {
    "minFPS": 29.962547,
    "avgFPS": 30.000088,
    "maxFPS": 30.04292,
    "countGaps": 0,
    "resolutionChanges": 0,
    "queueSize": 10,
    "startPts": 375400,
    "currentPts": 375400
  },
  "subscribers": 1
}

200 – OK

400 – Bad request

404 – Not found

Получить статистику профиля нарезки HLS

/hls/subscribers

Code Block

language	js
theme	RDark

{
  "hlsId":"test"
}

Code Block

language	js
theme	RDark

[
  {
    "id": "192.168.0.83-59000-Mozilla/5.0 (X11; Linux x86_64) Chrome/118.0.0.0",
    "ip": "192.168.0.83",
    "port": 59000,
    "userAgent": "Mozilla/5.0 (X11; Linux x86_64) Chrome/118.0.0.0",
    "active": true,
    "metrics": {
      "profileTime": {
        "test": 71,
        "v_test": 541353
      },
      "requestsNumber": 5930,
      "requestsStatuses": {
        "200 OK": 5930
      },
      "profileSwitches": 1,
      "maxResponseTime": 29,
      "minResponseTime": 0,
      "avgResponseTime": 0.4436762225969646
    }
  }
]

200 – OK

400 – Bad request

404 – Not found

Получить список подписчиков на HLS нарезку

Параметры

...

Имя параметра

...

Описание

...

Пример

...

name

...

Имя потока, опубликованного на сервере

...

test

...

Особенности

1. Если HLS нарезка потока запущена при помощи REST запроса /hls/startup, и нет активных HLS подписчиков, нарезка остановится по истечении интервала в секундах

Code Block

theme	RDark

hls_manager_provider_timeout=300

По умолчанию, интервал составляет 5 минут. То же касается автоматически созданных HLS нарезок при установленной настройке

Code Block

theme	RDark

hls_auto_start=true

2. Если HLS нарезка потока останавливается при помощи REST запроса /hls/terminate, и есть активные HLS подписчики, то нарезка будет перезапущена. При этом активные HLS подписчики должны повторно подключиться к потоку.

Отображение сообщений о проблемах с LL HLS потоком

В сборке 5.2.1709 добавлена возможность вывода сообщений о проблемах с LL HLS потоком в ответ на REST API запрос /hls/find_all:

...

language	js
theme	RDark

...

/hls/enableRecording

Code Block

language	js
theme	RDark

{
  "ids": [
    "test",
    "test-HLS-ABR-STREAM"
  ]
}

200 – OK

400 – Bad request

404 – Not found

409 - Conflict

500 - Internal server error

Включить запись сегментов HLS-потока на диск

/hls/disableRecording

Code Block

language	js
theme	RDark

{
  "ids": [
    "test",
    "test-HLS-ABR-STREAM"
  ]
}

200 – OK

400 – Bad request

404 – Not found

Остановить запись сегментов HLS-потока на диск

Параметры

Имя параметра	Описание	Пример
name	Имя потока, опубликованного на сервере	test
hlsId	Имя потока, опубликованного на сервере	test
profileName	Имя профиля качества, для которого запрашивается статистика	v_test
offset	Смещение от начала списка потоков в ответе на запрос статистики	0
size	Максимальное количество потоков в ответе на запрос статистики	10
ids	Список имен HLS-потоков, для которых включается/останавливается запись сегментов на диск	[ "test", "test-HLS-ABR-STREAM" ]
state	Статус HLS нарезки	ACTIVE
logs	Сообщения о проблемах с LL HLS потоком	[]

Особенности

1. Если HLS нарезка потока запущена при помощи REST запроса /hls/startup, и нет активных HLS подписчиков, нарезка остановится по истечении интервала в секундах

Code Block

theme	RDark

hls_manager_provider_timeout=300

По умолчанию, интервал составляет 5 минут. То же касается автоматически созданных HLS нарезок при установленной настройке

Code Block

theme	RDark

hls_auto_start=true

2. Если HLS нарезка потока останавливается при помощи REST запроса /hls/terminate, и есть активные HLS подписчики, то нарезка будет перезапущена. При этом активные HLS подписчики должны повторно подключиться к потоку.

Отображение сообщений о проблемах с LL HLS потоком

В сборке 5.2.1709 добавлена возможность вывода сообщений о проблемах с LL HLS потоком в ответ на REST API запрос /hls/find_all:

Code Block

language	js
theme	RDark

{
   "test": {
    "handler": "com.flashphoner.server.client.handler.wcs4.WCS4Handler@74dbf27b",
    "state": "ACTIVE",
    "writer": "HLS-test",
    "streamStatus": "PLAYING",
    "writerStarted": "true",
    "logs": [
      "2023-07-18T10:22:52.457 WARNING: Playback speed changed to 0.779, segment 49, media type: video",
      "2023-07-18T10:22:56.614 WARNING: Gap{from=112000, to=114000, duration=2000}, media type: video",
      "2023-07-18T10:22:56.615 WARNING: Fps changed from 30 to 27, segment 50 , media type: video",
      "2023-07-18T10:22:56.624 WARNING: Segment 51.1 have no data, pts 112400, duration 400, media type: video",
      ...
    ]
  }
}

...

Code Block

language	js
theme	RDark

[
  {
    "id": "192.168.0.83-59000-Mozilla/5.0 (X11; Linux x86_64) Chrome/118.0.0.0",
    "ip": "192.168.0.83",
    "port": 59000,
    "userAgent": "Mozilla/5.0 (X11; Linux x86_64) Chrome/118.0.0.0",
    "active": true,
    "metrics": {
      "profileTime": {
        "test": 71,
        "v_test": 541353
      },
      "requestsNumber": 5930,
      "requestsStatuses": {
        "200 OK": 5930
      },
      "profileSwitches": 1,
      "maxResponseTime": 29,
      "minResponseTime": 0,
      "avgResponseTime": 0.4436762225969646
    }
  }
]

Здесь:

id - идентификатор подписчика
ip - IP адрес подписчика
port - исходящий порт подписчика
userAgent - данные заголовка User-Agent, переданные подписчиком
active - подписчик активен
metrics - текущие метрики подписчика:
- profileTime - время, в течение которого подписчик запрашивал данный профиль, указанное для каждого профиля
- requestsNumber - количество запросов от подписчика
- requestStatuses - количество статусов ответов на запросы подписчика, указанное для каждого запроса
- profileSwitches - число переходов подписчика с одного HLS ABR профиля на другой
- maxResponseTime - максимальное время ответа на запрос
- minResponseTime - минимальное время ответа на запрос
- avgResponseTime - среднее время ответа на запроc

Особенности отображения количества подписчиков и количества соединений HLS

В ответ на запросы /hls/find_all, /hls/profiles, /hls/subscribers возвращаются текущие количество и состав HLS подписчиков с точностью до вкладки браузера. Однако количество сетевых соединений для загрузки HLS, которое отображается на странице статистики сервера

Code Block

language	bash
theme	RDark

curl -s http://localhost:8081/?action=stat&params=connections_hls

может отличаться от количества подписчиков. В большинстве случаев, HLS подписчики используют HTTP 2 протокол, и все вкладки одного браузера, которые получают HLS потоки с одного WCS сервера, будут использовать одно соединение.

При этом количество соединений, отображаемое параметром connections_hls, соответствует количеству установленных соединений на HLS порт, отображаемых командой netstat :

Code Block

language	bash
theme	RDark

sudo netstat -np | "200 OK": 5930
      },
      "profileSwitches": 1,
      "maxResponseTime": 29,
      "minResponseTime": 0,
      "avgResponseTime": 0.4436762225969646
    }
  }
]

Здесь:

id - идентификатор подписчика
ip - IP адрес подписчика
port - исходящий порт подписчика
userAgent - данные заголовка User-Agent, переданные подписчиком
active - подписчик активен
metrics - текущие метрики подписчика:
- profileTime - время, в течение которого подписчик запрашивал данный профиль, указанное для каждого профиля
- requestsNumber - количество запросов от подписчика
- requestStatuses - количество статусов ответов на запросы подписчика, указанное для каждого запроса
- profileSwitches - число переходов подписчика с одного HLS ABR профиля на другой
- maxResponseTime - максимальное время ответа на запрос
- minResponseTime - минимальное время ответа на запрос
- avgResponseTime - среднее время ответа на запроc

Особенности отображения количества подписчиков и количества соединений HLS

В ответ на запросы /hls/find_all, /hls/profiles, /hls/subscribers возвращаются текущие количество и состав HLS подписчиков с точностью до вкладки браузера. Однако количество сетевых соединений для загрузки HLS, которое отображается на странице статистики сервера

Code Block

language	bash
theme	RDark

curl -s http://localhost:8081/?action=stat&params=connections_hls

может отличаться от количества подписчиков. В большинстве случаев, HLS подписчики используют HTTP 2 протокол, и все вкладки одного браузера, которые получают HLS потоки с одного WCS сервера, будут использовать одно соединение.

При этом количество соединений, отображаемое параметром connections_hls, соответствует количеству установленных соединений на HLS порт, отображаемых командой netstat :

Code Block

language	bash
theme	RDark

sudo netstat -np | grep ESTABLISHED | grep java | grep 8445

...

grep ESTABLISHED | grep java | grep 8445

Здесь 8445 - HTTPS HLS порт WCS сервера

Запись сегментов на диск для отладки

В сборке 5.2.1913 добавлена возможность записать сегменты и плейлисты определенного потока, который уже играют подписчики, на диск в целях отладки. Запись производится в каталог, указанный настройкой

Code Block

theme	RDark

hls_debug_dir=hls-debug

Запись сегментов определенного потока запускается при помощи REST API запроса /hls/enableRecording

Code Block

language	js
theme	RDark

POST /rest-api/hls/enableRecording HTTP/1.1
Host: localhost:8081
Content-Type: application/json

{
    "ids": [
        "test",
        "test-HLS-ABR-STREAM"
    ] 
}

Для остановки записи используется REST API запрос /hls/disableRecording

Code Block

language	js
theme	RDark

POST /rest-api/hls/disableRecording HTTP/1.1
Host: localhost:8081
Content-Type: application/json

{
    "ids": [
        "test",
        "test-HLS-ABR-STREAM"
    ] 
}

С записанными сегментами можно работать различными инструментами, предназначенными для разбора и проигрывания медиафайлов: ffmpeg, ffprobe и т.п. Кроме того, записанный поток можно проиграть с сервера по URL с суффиксом -DEBUG

Code Block

theme	RDark

https://wcs:8445/test-DEBUG/test-DEBUG.m3u8

Если поток с определенным именем был записан, а затем опубликован новый поток с таким же именем, запись нового потока будет сделана с удалением предыдущей.

Поддержка HLS ABR

Для потоков с видео (только видео или видео+аудио) WCS поддерживает HLS ABR в CDN (в этом случае качества кодируются на выделенном Transcoder сервере) и на одном узле.

...

Space shortcuts

Page tree

Versions Compared

Old Version 80

New Version 81

Key

Параметры

Особенности

Отображение сообщений о проблемах с LL HLS потоком

Параметры

Особенности

Отображение сообщений о проблемах с LL HLS потоком

Особенности отображения количества подписчиков и количества соединений HLS

Особенности отображения количества подписчиков и количества соединений HLS

Запись сегментов на диск для отладки

Поддержка HLS ABR

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 80

New Version 81

Key

Параметры

Особенности

Отображение сообщений о проблемах с LL HLS потоком

Параметры

Особенности

Отображение сообщений о проблемах с LL HLS потоком

Особенности отображения количества подписчиков и количества соединений HLS

Особенности отображения количества подписчиков и количества соединений HLS

Запись сегментов на диск для отладки

Поддержка HLS ABR