Управление транскодингом при помощи 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

Code Block

language	js
theme	RDark

{
 "uri": "transcoder://tcode1",
 "remoteStreamName": "test",
 "localStreamName": "testT",
 "encoder": {
  "width": 640,
  "height": 480,
  "keyFrameInterval": 30,
  "fps": 30,
  "watermark": "Test.png"
 }
}

400 - Bad request

409 - Conflict

500 - Internal error

Создать транскодер с указанными параметрами для заданного потока

/transcoder/find

Code Block

language	js
theme	RDark

{
 "remoteStreamName": "test"
}

Code Block

language	js
theme	RDark

[
    {
        "localMediaSessionId": "42a92132-bcd1-4436-a96f-3fec36b32b37",
        "localStreamName": "testT",
        "remoteStreamName": "test",
        "uri": "transcoder://tcode1",
        "status": "PROCESSED_LOCAL",
        "hasAudio": true,
        "hasVideo": true,
        "record": false,
        "encoder": {
            "width": 640,
            "height": 480,
            "keyFrameInterval": 30,
            "fps": 30,
            "watermark": "Test.png"
        }
    }
]

200 – транскодеры найдены

404 – транскодеры не найдены

Найти транскодер по указанным критериям

/transcoder/find_all

Code Block

language	js
theme	RDark

[
    {
        "localMediaSessionId": "42a92132-bcd1-4436-a96f-3fec36b32b37",
        "localStreamName": "testT",
        "remoteStreamName": "test",
        "uri": "transcoder://tcode1",
        "status": "PROCESSED_LOCAL",
        "hasAudio": true,
        "hasVideo": true,
        "record": false,
        "encoder": {
            "width": 640,
            "height": 480,
            "keyFrameInterval": 30,
            "fps": 30
        }
    }
]

200 – транскодеры найдены

404 – транскодеры не найдены

Найти все транскодеры

/transcoder/terminate

Code Block

language	js
theme	RDark

{
"uri":"transcoder://tcode1"
}

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

Code Block

language	js
theme	RDark

{
 "uri": "transcoder2://tcode2",
 "remoteStreamName": "test",
 "localStreamName": "testT",
 "encoder": {
  "videoCodec": "H264",
  "audioCodec": "mpeg4-generic",
  "width": 320,
  "height": 240,
  "keyFrameInterval": 60,
  "fps": 30,
  "audioRate": 44100,
  "audioBitrate": 64000
 }
}

200 - OK

400 - Bad request

409 - Conflict

500 - Internal error

Создать транскодер с указанными параметрами для заданного потока

/transcoder2/find

Code Block

language	js
theme	RDark

{
 "remoteStreamName": "test"
}

Code Block

language	js
theme	RDark

[
  {
    "localMediaSessionId": "82ad5545-e11e-4f0f-801a-49e69d8c38f2",
    "localStreamName": "testT",
    "remoteStreamName": "test",
    "uri": "transcoder2://tcode2",
    "status": "PROCESSED_LOCAL",
    "hasAudio": true,
    "hasVideo": true,
    "record": false,
    "encoder": {
      "width": 320,
      "height": 240,
      "keyFrameInterval": 60,
      "fps": 30,
      "audioRate": 44100,
      "audioCodec": "mpeg4-generic",
      "videoCodec": "H264",
      "videoRate": 90000
    }
  }
]

200 – OK

404 – Not found

Найти транскодер по указанным критериям

/transcoder/find_all

Code Block

language	js
theme	RDark

[
  {
    "localMediaSessionId": "82ad5545-e11e-4f0f-801a-49e69d8c38f2",
    "localStreamName": "testT",
    "remoteStreamName": "test",
    "uri": "transcoder2://tcode2",
    "status": "PROCESSED_LOCAL",
    "hasAudio": true,
    "hasVideo": true,
    "record": false,
    "encoder": {
      "width": 320,
      "height": 240,
      "keyFrameInterval": 60,
      "fps": 30,
      "audioRate": 44100,
      "audioCodec": "mpeg4-generic",
      "videoCodec": "H264",
      "videoRate": 90000
    }
  }
]

200 – OK

404 – Not found

Найти все транскодеры

/transcoder/terminate

Code Block

language	js
theme	RDark

{
 "uri":"transcoder2://tcode2"
}

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

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

...

Code Block

language	bash
theme	RDark

{
 "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

theme	RDark

video_encoder_max_threads=2

По умолчанию, количество потоков установлено в 2.

Многопоточное кодирование включается в зависимости от разрешения выходного потока транскодера. Граница устанавливается при помощи следующей настройки

Code Block

theme	RDark

video_encoder_second_thread_threshold=777000

Значение представляет собой произведение ширины картинки на высоту. Таким образом, по умолчанию в несколько потоков кодируются картинки разрешением 720p. При необходимости, этот порог можно понизить. Например, для того, чтобы кодировать в несколько потоков картинки 480p, установите значение

Code Block

theme	RDark

video_encoder_second_thread_threshold=408950

Известные проблемы

1. Настройка качества кодирования не применяется при использовании OpenH264

Симптомы: качество картинки в плеере не изменяется при различных значениях настройки constraints.video.quality , например

Code Block

theme	RDark

constraints.video.quality=5

не отличается от

Code Block

theme	RDark

constraints.video.quality=20

Решение: не использовать кодирование на базе OpenH264, поскольку управление CRF в нем не поддерживается

Code Block

theme	RDark

encoder_priority=FF

Space shortcuts

Page tree

Versions Compared

Old Version 7

New Version 14

Key

Управление транскодингом при помощи REST API

Устаревшая версия REST API (сборки сервера до 5.2.898)

REST-методы и статусы ответа

Ограничения

Версия 2 REST API (сборки сервера, начиная с 5.2.898)

REST-методы и статусы ответа

Параметры

Ограничения

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

Многопоточное кодирование

Известные проблемы

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 7

New Version 14

Key

Управление транскодингом при помощи REST API

Устаревшая версия REST API (сборки сервера до 5.2.898)

REST-методы и статусы ответа

Ограничения

Версия 2 REST API (сборки сервера, начиная с 5.2.898)

REST-методы и статусы ответа

Параметры

Ограничения

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

Многопоточное кодирование

Известные проблемы