API de canais
Um canal é o endereço do stream que os espectadores abrem. Um canal tem uma ou mais variantes, por exemplo com bitrates diferentes. Cada variante recebe a entrada de um receptor.
IDs na API:
- ID do canal: o caminho na URL da playlist, por exemplo
news. Use letras, dígitos,-,_e/. - ID da variante: o ID do canal e o nome da variante, por exemplo
news/main.
As requisições de criar, alterar e excluir trabalham com o canal inteiro. As requisições de iniciar e parar trabalham com uma variante.
Objeto de canal
Seção intitulada “Objeto de canal”{ "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 do canal.
- name: Nome do canal. Obrigatório.
- enable: Inicia ou para todas as variantes do canal.
- storage (opcional): ID do armazenamento do arquivo.
- duration (opcional): Duração do arquivo deste canal, em horas. Substitui a duração do armazenamento.
- authorizer (opcional): ID do autorizador que protege o canal.
- tvg_id, tvg_logo (opcional): Identificador EPG e logotipo para a playlist M3U.
- variants: Objeto com as variantes por nome. Pelo menos uma variante é obrigatória.
- enable: Ativa a variante.
- receiver: ID do receptor. Obrigatório.
- old_name: Somente para
PUT. Veja Atualizar um canal.
Criar um canal
Seção intitulada “Criar um canal”POST /api/ott/channelExemplo:
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ódigo | Descrição |
|---|---|
204 | O canal foi criado |
400 | Uma variante não tem receptor, ou uma variante ativada não consegue iniciar. O corpo contém o motivo |
409 | O canal já existe, ou um receptor é usado por mais de uma variante |
422 | Sem nome ou sem variantes |
Atualizar um canal
Seção intitulada “Atualizar um canal”PUT /api/ott/channel?id=<channel_id>Envie o objeto completo do canal. O id no corpo deve ser o mesmo do parâmetro de consulta.
O Alta compara as variantes da requisição com as variantes que ele já tem pelo campo old_name:
- Uma variante que existe: defina
old_namecom o nome atual dela. Semold_name, o Alta trata a variante como nova e exclui a variante existente com o mesmo nome. - Uma variante nova: não defina
old_name. - Uma variante renomeada: defina
old_namecom o nome anterior e coloque o novo nome na chave. - Uma variante que você quer remover: omita-a da requisição.
Exemplo: manter main, renomear low para sd e adicionar hd:
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" } } }'Quando o valor enable do canal é diferente do estado atual, o Alta o aplica a todas as variantes. Para desligar uma variante, mantenha o enable do canal como está e altere o enable da variante. Para iniciar ou parar uma variante sem uma atualização completa, use Iniciar e parar.
Alterar o storage de um canal remove o arquivo gravado no armazenamento anterior.
| Código | Descrição |
|---|---|
204 | O canal foi atualizado |
400 | Uma variante não consegue iniciar. O corpo contém o motivo |
404 | Uma variante de old_name não existe |
409 | Um receptor é usado por mais de uma variante |
422 | Sem variantes |
Excluir um canal
Seção intitulada “Excluir um canal”DELETE /api/ott/channel?id=<channel_id>O Alta para e remove todas as variantes do canal.
Retorna 204, ou 404 se o canal não existir.
Iniciar e parar
Seção intitulada “Iniciar e parar”POST /api/ott/channel/start?id=<channel_id>/<variant>POST /api/ott/channel/stop?id=<channel_id>/<variant>Exemplo:
curl -sS -X POST -H "Authorization: Bearer $TOKEN" \ 'http://alta.example.com:8100/api/ott/channel/stop?id=news/main'As requisições alteram o valor enable da variante e o salvam, então o estado permanece após uma reinicialização do Alta. Uma requisição repetida não é um erro.
| Código | Descrição |
|---|---|
204 | Concluído |
400 | A variante não consegue iniciar. O corpo contém o motivo |
404 | A variante não existe |
Blocos gravados
Seção intitulada “Blocos gravados”GET /api/ott/channel/storage?id=<channel_id>/<variant>Retorna o arquivo da variante como blocos contínuos. Uma lacuna na gravação inicia um novo bloco. Disponível para admin e observer.
Resposta:
[ { "start_time": 1747485787, "size": 1572864000, "duration": 3600 }]- start_time: Início do bloco como timestamp Unix.
- size: Tamanho do bloco em bytes.
- duration: Duração do bloco em segundos.
Retorna 204 se o canal não tem armazenamento, e 404 se a variante não existe. Para obter os clipes de preview em MP4 do arquivo, leia Preview API.
Exportar uma playlist M3U
Seção intitulada “Exportar uma playlist M3U”PUT /api/ott/channel/exportm3uCria uma playlist M3U a partir da lista que você envia. O Alta adiciona os parâmetros de arquivo aos canais que têm armazenamento, e os parâmetros de EPG aos canais que têm tvg_id ou tvg_logo. Disponível para admin e observer.
O corpo é um objeto. Cada item tem o id do canal, o name para a playlist e o address completo da playlist no OTT Server:
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" } }'Resposta (texto simples):
#EXTM3U#EXTINF:-1 tvg-id="101" catchup="append" catchup-days="2" catchup-source="?start=${start}", Newshttp://alta.example.com:8101/news/index.m3u8Saiba mais sobre os parâmetros da playlist em Exportar playlist M3U8.