Pular para o conteúdo
Produtos

API de receptores

Um receptor é um stream de entrada: um UDP multicast, uma origem HTTP ou HLS, ou uma câmera RTSP. Um canal recebe o vídeo dele de um receptor. Saiba mais sobre as origens suportadas em Receptores.

{
"id": "news-source",
"enable": true,
"name": "News source",
"source": "udp://239.1.1.1:1234",
"user_agent": "Alta"
}
  • id: ID do receptor. Somente na requisição de criação. Se você o omitir, o Alta gera um UUID.
  • enable: Inicia o receptor.
  • name: Nome do receptor. Se você o omitir na requisição de criação, o Alta usa o ID.
  • source: URL do stream de entrada.
  • user_agent (opcional): Cabeçalho User-Agent para origens HTTP.
Terminal window
POST /api/ott/receiver

Exemplo:

Terminal window
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}'

Retorna 204, ou 409 se já existir um receptor com este ID.

Terminal window
GET /api/ott/receiver?id=<receiver_id>

Retorna o objeto do receptor sem o campo id, ou 404. Disponível para admin e observer.

Terminal window
PUT /api/ott/receiver?id=<receiver_id>

Envie todos os campos: enable, name, source e user_agent. Um campo que você omitir é apagado. Se enable for omitido, o receptor é desativado.

Terminal window
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"}'

Quando a origem, o nome ou o enable mudam, o Alta reinicia o receptor e os canais que o usam. Se um canal não conseguir iniciar, a resposta é 200 com um objeto cujo valor é o motivo:

{ "-": "reason of the error" }

Desativar um receptor também desativa os canais que o usam.

Terminal window
DELETE /api/ott/receiver?id=<receiver_id>

Para os canais que usam o receptor e depois o remove. Os canais permanecem na configuração e ficam desativados. Antes de ativá-los novamente, defina outro receptor com Atualizar um canal. Retorna 204, ou 404.

Terminal window
GET /api/ott/receiver/status

Retorna o tráfego de todos os receptores por ID. Use-o para obter a lista de IDs de receptores. Disponível para admin e observer.

Resposta:

{
"receivers": {
"news-source": { "totalBytes": "1.5 GB", "speed": "4.2 Mbit/s" }
}
}
  • totalBytes: Dados recebidos desde o início, como texto para exibição.
  • speed: Velocidade atual, como texto para exibição.

O Alta pode criar receptores e canais a partir de uma playlist M3U. A importação tem duas etapas: ler a playlist e depois importar os itens que você selecionar.

1. Leia uma playlist de uma URL:

Terminal window
GET /api/ott/receiver/importm3u?id=<playlist_url>

O Alta baixa a URL a partir do servidor, não do seu computador. O servidor precisa alcançar o endereço. Retorna 422 se o download falhar.

Para ler uma playlist de um arquivo seu, envie-a como uma string Base64 no corpo JSON de uma requisição POST para /api/ott/receiver/importm3u.

Terminal window
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')\""

Resposta:

[
{
"id": "1",
"name": "News",
"channel_path": "news",
"address": "udp://239.1.1.1:1234"
}
]

2. Importe os itens selecionados:

Terminal window
PUT /api/ott/receiver/importm3u

O corpo é um objeto com os itens a importar, no mesmo formato. Cada item precisa de address e channel_path.

Terminal window
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 item, o Alta cria um receptor desativado e o canal <channel_path>/main. Ative-os com Atualizar um receptor e Iniciar e parar.

CódigoDescrição
204Todos os itens foram importados
200Alguns itens foram ignorados. O corpo os agrupa pelo motivo: o canal já existe, ou já existe um receptor com esta origem
400Um item não tem endereço ou não tem caminho de canal
413Mais de 256 itens