Saltearse al contenido
Productos

API de canales

Un canal es la dirección de la transmisión que abren los espectadores. Un canal tiene una o más variantes, por ejemplo con distintas tasas de bits. Cada variante toma su entrada de un receptor.

ID en la API:

  • ID del canal: la ruta en la URL de la lista de reproducción, por ejemplo news. Use letras, dígitos, -, _ y /.
  • ID de la variante: el ID del canal y el nombre de la variante, por ejemplo news/main.

Las solicitudes de crear, modificar y eliminar trabajan con el canal completo. Las solicitudes de iniciar y detener trabajan con una variante.

{
"id": "news",
"name": "News",
"enable": true,
"storage": "archive",
"duration": 48,
"authorizer": "token-auth",
"tvg_id": 101,
"tvg_logo": "https://example.com/news.png",
"variants": {
"main": { "enable": true, "receiver": "news-source" },
"low": { "enable": true, "receiver": "news-low-source" }
}
}
  • id: ID del canal.
  • name: nombre del canal. Obligatorio.
  • enable: inicia o detiene todas las variantes del canal.
  • storage (opcional): ID del almacenamiento para el archivo.
  • duration (opcional): duración del archivo de este canal en horas. Reemplaza la duración del almacenamiento.
  • authorizer (opcional): ID del autorizador que protege el canal.
  • tvg_id, tvg_logo (opcionales): identificador EPG y logotipo para la lista M3U.
  • variants: objeto con las variantes por nombre. Se requiere al menos una variante.
    • enable: habilita la variante.
    • receiver: ID del receptor. Obligatorio.
    • old_name: solo para PUT. Consulte Actualizar un canal.
Ventana de terminal
POST /api/ott/channel

Ejemplo:

Ventana de terminal
curl -sS -X POST -H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' \
'http://alta.example.com:8100/api/ott/channel' \
-d '{
"id": "news",
"name": "News",
"enable": true,
"storage": "archive",
"variants": {
"main": { "enable": true, "receiver": "news-source" }
}
}'
CódigoDescripción
204El canal se ha creado
400Una variante no tiene receptor, o una variante habilitada no puede iniciarse. El cuerpo contiene el motivo
409El canal ya existe, o un receptor lo usa más de una variante
422Falta el nombre o las variantes
Ventana de terminal
PUT /api/ott/channel?id=<channel_id>

Envíe el objeto de canal completo. El id del cuerpo debe ser el mismo que el del parámetro de consulta.

Alta compara las variantes de la solicitud con las variantes que ya tiene mediante el campo old_name:

  • Una variante que existe: establezca old_name con su nombre actual. Sin old_name, Alta trata la variante como nueva y elimina la variante existente con el mismo nombre.
  • Una variante nueva: no establezca old_name.
  • Una variante renombrada: establezca old_name con el nombre anterior y ponga el nombre nuevo en la clave.
  • Una variante que quiere quitar: omítala de la solicitud.

Ejemplo: conservar main, renombrar low a sd y añadir hd:

Ventana de terminal
curl -sS -X PUT -H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' \
'http://alta.example.com:8100/api/ott/channel?id=news' \
-d '{
"id": "news",
"name": "News",
"enable": true,
"variants": {
"main": { "enable": true, "receiver": "news-source", "old_name": "main" },
"sd": { "enable": true, "receiver": "news-low-source", "old_name": "low" },
"hd": { "enable": true, "receiver": "news-hd-source" }
}
}'

Cuando el valor enable del canal difiere de su estado actual, Alta lo aplica a todas las variantes. Para desactivar una variante, deje el enable del canal como está y cambie el enable de la variante. Para iniciar o detener una variante sin una actualización completa, use Iniciar y detener.

Si cambia el storage de un canal, se elimina el archivo grabado en el almacenamiento anterior.

CódigoDescripción
204El canal se ha actualizado
400Una variante no puede iniciarse. El cuerpo contiene el motivo
404Una variante de old_name no existe
409Un receptor lo usa más de una variante
422Faltan las variantes
Ventana de terminal
DELETE /api/ott/channel?id=<channel_id>

Alta detiene y elimina todas las variantes del canal.

Devuelve 204, o 404 si el canal no existe.

Ventana de terminal
POST /api/ott/channel/start?id=<channel_id>/<variant>
POST /api/ott/channel/stop?id=<channel_id>/<variant>

Ejemplo:

Ventana de terminal
curl -sS -X POST -H "Authorization: Bearer $TOKEN" \
'http://alta.example.com:8100/api/ott/channel/stop?id=news/main'

Las solicitudes cambian el valor enable de la variante y lo guardan, por lo que el estado se mantiene tras reiniciar Alta. Una solicitud repetida no es un error.

CódigoDescripción
204Hecho
400La variante no puede iniciarse. El cuerpo contiene el motivo
404La variante no existe
Ventana de terminal
GET /api/ott/channel/storage?id=<channel_id>/<variant>

Devuelve el archivo de la variante como bloques continuos. Un hueco en la grabación inicia un bloque nuevo. Disponible para admin y observer.

Respuesta:

[
{ "start_time": 1747485787, "size": 1572864000, "duration": 3600 }
]
  • start_time: inicio del bloque como marca de tiempo Unix.
  • size: tamaño del bloque en bytes.
  • duration: duración del bloque en segundos.

Devuelve 204 si el canal no tiene almacenamiento, y 404 si la variante no existe. Para obtener los clips de vista previa MP4 del archivo, lea API de vista previa.

Ventana de terminal
PUT /api/ott/channel/exportm3u

Genera una lista M3U a partir de la lista que usted envía. Alta añade los parámetros del archivo a los canales que tienen almacenamiento, y los parámetros EPG a los canales que tienen tvg_id o tvg_logo. Disponible para admin y observer.

El cuerpo es un objeto. Cada elemento tiene el id del canal, el name para la lista y la address completa de la lista de reproducción en el OTT Server:

Ventana de terminal
curl -sS -X PUT -H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' \
'http://alta.example.com:8100/api/ott/channel/exportm3u' \
-d '{
"news": {
"id": "news",
"name": "News",
"address": "http://alta.example.com:8101/news/index.m3u8"
}
}'

Respuesta (texto sin formato):

#EXTM3U
#EXTINF:-1 tvg-id="101" catchup="append" catchup-days="2" catchup-source="?start=${start}", News
http://alta.example.com:8101/news/index.m3u8

Más información sobre los parámetros de la lista en Exportar lista de reproducción M3U8.