API de receptores
Un receptor es una transmisión de entrada: un multicast UDP, un origen HTTP o HLS, o una cámara RTSP. Un canal toma su video de un receptor. Más información sobre los orígenes compatibles en Receptores.
Objeto de receptor
Sección titulada «Objeto de receptor»{ "id": "news-source", "enable": true, "name": "News source", "source": "udp://239.1.1.1:1234", "user_agent": "Alta"}- id: ID del receptor. Solo en la solicitud de creación. Si lo omite, Alta genera un UUID.
- enable: inicia el receptor.
- name: nombre del receptor. Si lo omite en la solicitud de creación, Alta usa el ID.
- source: URL de la transmisión de entrada.
- user_agent (opcional): encabezado
User-Agentpara los orígenes HTTP.
Crear un receptor
Sección titulada «Crear un receptor»POST /api/ott/receiverEjemplo:
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}'Devuelve 204, o 409 si ya existe un receptor con este ID.
Obtener un receptor
Sección titulada «Obtener un receptor»GET /api/ott/receiver?id=<receiver_id>Devuelve el objeto de receptor sin el campo id, o 404. Disponible para admin y observer.
Actualizar un receptor
Sección titulada «Actualizar un receptor»PUT /api/ott/receiver?id=<receiver_id>Envíe todos los campos: enable, name, source y user_agent. Un campo que omita se borra. Si se omite enable, el receptor se deshabilita.
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"}'Cuando cambian el origen, el nombre o enable, Alta reinicia el receptor y los canales que lo usan. Si un canal no puede iniciarse, la respuesta es 200 con un objeto cuyo valor es el motivo:
{ "-": "reason of the error" }Al deshabilitar un receptor también se deshabilitan los canales que lo usan.
Eliminar un receptor
Sección titulada «Eliminar un receptor»DELETE /api/ott/receiver?id=<receiver_id>Detiene los canales que usan el receptor y después lo elimina. Los canales permanecen en la configuración y quedan deshabilitados. Antes de habilitarlos de nuevo, asigne otro receptor con Actualizar un canal. Devuelve 204, o 404.
Estado del receptor
Sección titulada «Estado del receptor»GET /api/ott/receiver/statusDevuelve el tráfico de todos los receptores por ID. Úselo para obtener la lista de ID de receptores. Disponible para admin y observer.
Respuesta:
{ "receivers": { "news-source": { "totalBytes": "1.5 GB", "speed": "4.2 Mbit/s" } }}- totalBytes: datos recibidos desde el inicio, como texto para mostrar.
- speed: velocidad actual, como texto para mostrar.
Importar desde M3U
Sección titulada «Importar desde M3U»Alta puede crear receptores y canales a partir de una lista M3U. La importación tiene dos pasos: leer la lista y después importar los elementos que seleccione.
1. Lea una lista desde una URL:
GET /api/ott/receiver/importm3u?id=<playlist_url>Alta descarga la URL desde el servidor, no desde su equipo. El servidor debe poder acceder a la dirección. Devuelve 422 si la descarga falla.
Para leer una lista desde su propio archivo, envíela como una cadena Base64 en el cuerpo JSON de una solicitud POST a /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')\""Respuesta:
[ { "id": "1", "name": "News", "channel_path": "news", "address": "udp://239.1.1.1:1234" }]2. Importe los elementos seleccionados:
PUT /api/ott/receiver/importm3uEl cuerpo es un objeto con los elementos que se van a importar, en el mismo formato. Cada elemento necesita address y 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"}}'Para cada elemento, Alta crea un receptor deshabilitado y el canal <channel_path>/main. Habilítelos con Actualizar un receptor e Iniciar y detener.
| Código | Descripción |
|---|---|
204 | Se han importado todos los elementos |
200 | Se han omitido algunos elementos. El cuerpo los agrupa por motivo: el canal ya existe, o ya existe un receptor con este origen |
400 | Un elemento no tiene dirección o ruta de canal |
413 | Más de 256 elementos |