...
Управление транскодингом при помощи REST API
Устаревшая версия REST API (сборки сервера до 5.2.898)
REST-запрос должен быть HTTP/HTTPS POST запросом в таком виде:
- HTTP: http://test.flashphoner.com:8081/rest-api/transcoder/startup
- HTTPS: https://test.flashphoner.com:8444/rest-api/transcoder/startup
Здесь:
- test.flashphoner.com - адрес WCS-сервера
- 8081 - стандартный REST / HTTP порт WCS-сервера
- 8444 - стандартный HTTPS порт
- rest-api - обязательная часть URL
- /transcoder/startup - используемый REST-метод
REST-методы и статусы ответа
REST-метод | Пример тела REST-запроса | Пример тела REST-ответа | Статусы ответа | Описание | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
/transcoder/startup |
| 400 - Bad request 409 - Conflict 500 - Internal error | Создать транскодер с указанными параметрами для заданного потока | |||||||||||||||
/transcoder/find |
|
| 200 – транскодеры найдены 404 – транскодеры не найдены | Найти транскодер по указанным критериям | ||||||||||||||
/transcoder/find_all |
| 200 – транскодеры найдены 404 – транскодеры не найдены | Найти все транскодеры | |||||||||||||||
/transcoder/terminate |
| 200 - транскодер завершен 404 - транскодер не найден | Остановить транскодер и его выходной поток |
Параметры
Имя параметра | Описание | Пример |
---|---|---|
uri | URL транскодера | transcoder://tcode1 |
localStreamName | Имя выходного потока транскодера | testT |
remoteStreamName | Имя транскодируемого потока | test |
localMediaSessionId | Идентификатор медиасессии транскодера | 42a92132-bcd1-4436-a96f-3fec36b32b37 |
status | Текущий статус транскодера | PROCESSED_LOCAL |
hasAudio | Выходной поток содержит аудио | true |
hasVideo | Выходной поток содержит видео | true |
record | Выходной поток записывается | false |
Параметры кодирования | ||
width | Ширина картинки | 640 |
height | Высота картинки (обязательный параметр) | 480 |
keyFrameInterval | Частота генерации ключевых кадров (GOP) | 30 |
fps | Частота кадров в секунду | 30 |
bitrate | Битрейт в кб/с | 500 |
type | Кодек | OPENH264 |
watermark | Файл водяного знака | Test.png |
Ограничения
1. Для потоков без видео (только с аудио составляющей) создание транскодера при помощи REST API невозможно. Если отправить запрос /transcoder/startup для такого потока, сервер вернет 400 Bad request с сообщением "Can't start transcoder for audio only stream"
2. Если при создании транскодера по REST API не указать ни ширину, ни высоту, транскодинг не включится, поток будет скопирован без перекодирования.
3. Если указана только высота картинки, поток будет транскодирован с сохранением соотношения сторон, если эта возможность включена.
4, Если указана только ширина картинки, запрос вернет 400 Bad request с сообщением "Height is not specified"
Версия 2 REST API (сборки сервера, начиная с 5.2.898)
REST-запрос должен быть HTTP/HTTPS POST запросом в таком виде:
- HTTP: http://test.flashphoner.com:8081/rest-api/transcoder2/startup
- HTTPS: https://test.flashphoner.com:8444/rest-api/transcoder2/startup
Здесь:
- test.flashphoner.com - адрес WCS-сервера
- 8081 - стандартный REST / HTTP порт WCS-сервера
- 8444 - стандартный HTTPS порт
- rest-api - обязательная часть URL
- /transcoder2/startup - используемый REST-метод
REST-методы и статусы ответа
REST-метод | Пример тела REST-запроса | Пример тела REST-ответа | Статусы ответа | Описание | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
/transcoder2/startup |
| 200 - OK 400 - Bad request 409 - Conflict 500 - Internal error | Создать транскодер с указанными параметрами для заданного потока | |||||||||||||||
/transcoder2/find |
|
| 200 – OK 404 – Not found | Найти транскодер по указанным критериям | ||||||||||||||
/transcoder/find_all |
| 200 – OK 404 – Not found | Найти все транскодеры | |||||||||||||||
/transcoder/terminate |
| 200 – OK 404 – Not found | Остановить транскодер и его выходной поток |
Параметры
Имя параметра | Описание | Пример |
---|---|---|
uri | URL транскодера | transcoder2://tcode2 |
localStreamName | Имя выходного потока транскодера | testT |
remoteStreamName | Имя транскодируемого потока | test |
localMediaSessionId | Идентификатор медиасессии транскодера | 82ad5545-e11e-4f0f-801a-49e69d8c38f2 |
status | Текущий статус транскодера | PROCESSED_LOCAL |
hasAudio | Выходной поток содержит аудио | true |
hasVideo | Выходной поток содержит видео | true |
record | Выходной поток записывается | false |
Параметры кодирования | ||
width | Ширина картинки | 320 |
height | Высота картинки (обязательный параметр) | 240 |
audioCodec | Кодек аудио | mpeg4-generic |
audioRate | Частота дискретизации аудио, Гц | 44100 |
audioChannels | Количество каналов аудио | 2 |
audioBitrate | Битрейт аудио, бит/с | 64000 |
videoCodec | Кодек видео | H264 |
keyFrameInterval | Частота генерации ключевых кадров (GOP) | 30 |
fps | Частота кадров в секунду | 30 |
bitrate | Битрейт видео в кб/с | 500 |
type | Кодировщик | OPENH264 |
watermark | Файл водяного знака | Test.png |
videoRate | Частота дискретизации видео, Гц | 90000 |
Ограничения
1. Если параметры транскодирования видео переданы для потока без видео, либо параметры транскодирования аудио переданы для потока без аудио, запрос вернет 400 Bad request
Краткое руководство по тестированию
...
По умолчанию, если поток опубликован с одними размерами кадра, а запрашивается для воспроизведения с другими размерами, WCS пытается сохранить соотношение сторон видео. Например, если на сервере опубликован поток разрешением 640x360 и соотношением сторон 16:9, а подписчик запрашивает воспроизведение 320x240 (4:3), поток будет транскодирован к разрешению 320x180 (16:9). Если подписчик запрашивает только ширину высоту картинки, не указывая высотуширину, соотношение сторон также будет сохранено.
...
При этом поток будет транскодирован к тем ширине и высоте кадра, которые запрашивает подписчик. Если высота не указана подписчиком, будет установлена высота картинки 120. Если ширина не указана подписчиком, будет установлена ширина картинки 160.
Синхронизация аудио и видео на выходе транскодера
По умолчанию, транскодер не синхронизирует аудио и видео в выходном потоке, оставляя значение синхронизации как есть. Это может приводить к несовпадению звука и видео в транскодированном потоке. Чтобы этого избежать, в сборке 5.2.543 добавлен выравнивающий буфер, который включается настройкой
Code Block | ||
---|---|---|
| ||
av_paced_sender=true |
Размер выравнивающего буфера задается в кадрах настройкой
Code Block | ||
---|---|---|
| ||
av_paced_sender_max_buffer_size=5000 |
По умолчанию размер буфера составляет 5000 кадров
Для контроля работы выравнивающего буфера используется статистика, получаемая при помощи запроса
Code Block | ||||
---|---|---|---|---|
| ||||
curl -s 'http://localhost:8081/?action=stat&format=json&groups=buffer_stats' |
Добавление водяного знака в определенный поток
В сборке 5.2.693 появилась возможность добавлять в выходной поток транскодера водяной знак при создании транскодера по REST API, например
Code Block | ||||
---|---|---|---|---|
| ||||
{
"uri": "transcoder://tcode1",
"remoteStreamName": "test",
"localStreamName": "testT",
"encoder": {
"width": 640,
"height": 480,
"keyFrameInterval": 30,
"fps": 30,
"watermark": "Test.png"
}
} |
Если имя файла указано без пути, файл должен располагаться в каталоге /usr/local/FlashphonerWebCallServer/conf. Можно также указать полный путь к файлу, например
Code Block | ||||
---|---|---|---|---|
| ||||
{
"uri": "transcoder://tcode1",
"remoteStreamName": "test",
"localStreamName": "testT",
"encoder": {
"width": 640,
"height": 480,
"keyFrameInterval": 30,
"fps": 30,
"watermark": "/opt/media/Test.png"
}
} |
Многопоточное кодирование
В сборке 5.2.816 добавлена возможность многопоточного кодирования при использовании кодировщика на базе OpenH264. Количество потоков кодирования устанавливается следующей настройкой
Code Block | ||
---|---|---|
| ||
video_encoder_max_threads=2 |
По умолчанию, количество потоков установлено в 2.
Многопоточное кодирование включается в зависимости от разрешения выходного потока транскодера. Граница устанавливается при помощи следующей настройки
Code Block | ||
---|---|---|
| ||
video_encoder_second_thread_threshold=777000 |
Значение представляет собой произведение ширины картинки на высоту. Таким образом, по умолчанию в несколько потоков кодируются картинки разрешением 720p. При необходимости, этот порог можно понизить. Например, для того, чтобы кодировать в несколько потоков картинки 480p, установите значение
Code Block | ||
---|---|---|
| ||
video_encoder_second_thread_threshold=408950 |
Известные проблемы
1. Настройка качества кодирования не применяется при использовании OpenH264
Симптомы: качество картинки в плеере не изменяется при различных значениях настройки constraints.video.quality
, например
Code Block | ||
---|---|---|
| ||
constraints.video.quality=5 |
не отличается от
Code Block | ||
---|---|---|
| ||
constraints.video.quality=20 |
Решение: не использовать кодирование на базе OpenH264, поскольку управление CRF в нем не поддерживается
Code Block | ||
---|---|---|
| ||
encoder_priority=FF |