API ресиверов
Ресивер — это входной поток: UDP multicast, источник HTTP или HLS либо RTSP-камера. Канал получает видео от ресивера. Подробнее о поддерживаемых источниках в разделе Ресиверы.
Объект ресивера
Заголовок раздела «Объект ресивера»{ "id": "news-source", "enable": true, "name": "News source", "source": "udp://239.1.1.1:1234", "user_agent": "Alta"}- id: ID ресивера. Только в запросе создания. Если не указать, Alta сгенерирует UUID.
- enable: запускает ресивер.
- name: название ресивера. Если не указать его в запросе создания, Alta использует ID.
- source: URL входного потока.
- user_agent (необязательный): заголовок
User-Agentдля HTTP-источников.
Создание ресивера
Заголовок раздела «Создание ресивера»POST /api/ott/receiverПример:
curl -sS -X POST -H "Authorization: Bearer $TOKEN" \ -H 'Content-Type: application/json' \ 'http://alta.example.com:8100/api/ott/receiver' \ -d '{"id": "news-source", "name": "News source", "source": "udp://239.1.1.1:1234", "enable": true}'Возвращает 204 или 409, если ресивер с таким ID уже существует.
Получение ресивера
Заголовок раздела «Получение ресивера»GET /api/ott/receiver?id=<receiver_id>Возвращает объект ресивера без поля id или 404. Доступно ролям admin и observer.
Изменение ресивера
Заголовок раздела «Изменение ресивера»PUT /api/ott/receiver?id=<receiver_id>Передайте все поля: enable, name, source и user_agent. Пропущенное поле очищается. Если пропустить enable, ресивер будет выключен.
curl -sS -X PUT -H "Authorization: Bearer $TOKEN" \ -H 'Content-Type: application/json' \ 'http://alta.example.com:8100/api/ott/receiver?id=news-source' \ -d '{"enable": true, "name": "News source", "source": "udp://239.1.1.2:1234"}'Если меняется источник, название или enable, Alta перезапускает ресивер и использующие его каналы. Если канал не удаётся запустить, ответ имеет код 200 и содержит объект, в котором значение — причина:
{ "-": "reason of the error" }Выключение ресивера также выключает использующие его каналы.
Удаление ресивера
Заголовок раздела «Удаление ресивера»DELETE /api/ott/receiver?id=<receiver_id>Останавливает каналы, которые используют ресивер, затем удаляет его. Каналы остаются в конфигурации и выключены. Прежде чем включить их снова, назначьте другой ресивер через Изменение канала. Возвращает 204 или 404.
Состояние ресивера
Заголовок раздела «Состояние ресивера»GET /api/ott/receiver/statusВозвращает трафик всех ресиверов по ID. Используйте этот запрос, чтобы получить список ID ресиверов. Доступно ролям admin и observer.
Ответ:
{ "receivers": { "news-source": { "totalBytes": "1.5 GB", "speed": "4.2 Mbit/s" } }}- totalBytes: принятые данные с момента запуска, текст для отображения.
- speed: текущая скорость, текст для отображения.
Импорт из M3U
Заголовок раздела «Импорт из M3U»Alta может создавать ресиверы и каналы из плейлиста M3U. Импорт состоит из двух шагов: прочитать плейлист, затем импортировать выбранные элементы.
1. Прочитайте плейлист по URL:
GET /api/ott/receiver/importm3u?id=<playlist_url>Alta скачивает URL с сервера, а не с вашего компьютера. Сервер должен иметь доступ к этому адресу. Возвращает 422, если скачать плейлист не удалось.
Чтобы прочитать плейлист из собственного файла, передайте его в виде строки Base64 в JSON-теле запроса POST на /api/ott/receiver/importm3u.
curl -sS -X POST -H "Authorization: Bearer $TOKEN" \ -H 'Content-Type: application/json' \ 'http://alta.example.com:8100/api/ott/receiver/importm3u' \ -d "\"$(base64 < playlist.m3u | tr -d '\n')\""Ответ:
[ { "id": "1", "name": "News", "channel_path": "news", "address": "udp://239.1.1.1:1234" }]2. Импортируйте выбранные элементы:
PUT /api/ott/receiver/importm3uТело запроса — объект с импортируемыми элементами в том же формате. Каждому элементу нужны address и channel_path.
curl -sS -X PUT -H "Authorization: Bearer $TOKEN" \ -H 'Content-Type: application/json' \ 'http://alta.example.com:8100/api/ott/receiver/importm3u' \ -d '{"1": {"id": "1", "name": "News", "channel_path": "news", "address": "udp://239.1.1.1:1234"}}'Для каждого элемента Alta создаёт выключенный ресивер и канал <channel_path>/main. Включите их через Изменение ресивера и Запуск и остановку.
| Код | Описание |
|---|---|
204 | Все элементы импортированы |
200 | Некоторые элементы пропущены. В теле они сгруппированы по причине: канал уже существует либо ресивер с таким источником уже существует |
400 | У элемента нет адреса или пути канала |
413 | Больше 256 элементов |