Requisita o estado de autorizacao do cliente (identifcado por meio de seu clientid), estabelecendo o vínculo inicial entre este e o Ginga CC WebServices

Autentica um cliente e concede acesso às demais API do Ginga CC WebServices.

Observacao:

No primeiro acesso a esta API por clientes não locais, após o passo de autorizacao inicial via 8.1.1 (e ainda via HTTP), o conteúdo retornado no corpo da resposta (objeto JSON) vem criptografado com a chave simétrica estabelecida durante o pareamento. Nos acessos subsequentes, (via HTTPS), esta encriptacao não é mais necessária, bastando aquela que é intrínseca ao HTTPS (comunicacao SSL utilizando o certifcado retornado em serverCert). A chave simétrica pode ser descartada, e apenas o refresh-token é sufciente

Usado quando um cliente não local faz o seu primeiro acesso, e ainda não possui um refresh-token. Consiste na resposta ao campo challenge enviado pelo servidor na API 8.1.1. Esta resposta é gerada com os seguintes passos:

1. decodifcar o challenge, do formato base64 para um bufer binário;
2. decriptografar com a chave simétrica;
3. calcular hash SHA-256 do bufer resultante;
4. criptografar o hash obtido, utilizando a chave simétrica, e novamente converter para base64 ao fnal.

Retorna informações do serviço DTV selecionado no momento, assim como de seu transport stream de origem

Retorna a lista de todos serviços DTV presentes na atual lista de canais do receptor.

A estrutura segue a tripla a seguir: ..

Onde corresponde à numeracao do canal físico e os demais camposseguem as defnições da ABNT NBR 15603-2, Anexo G. Assim, equivale ao valor expresso pelos 3 bits menos signifcativos de service_id, somado de uma unidade. Em cada fragmento da tripla, dígitos zero à esquerda podem ser desconsiderados. Por exemplo, as formas “29.04.01” e “29.4.1” são equivalentes.

Em todas as APIs que utilizam em um fragmento da URL, é válido não apenas utilizar a tripla de identifcacao como também utilizar a string literal current-service, que serve como um alias para o serviço atualmente selecionado.

Retorna informações sobre os componentes disponíveis em um serviço, incluindo o estado

Retorna informações detalhadas de um componente do serviço atual, incluindo o estado

Inicia, interrompe, pausa e/ou altera o estado de exibição de um determinado componente do serviço.

Lista as aplicações interativas Ginga disponíveis no serviço especificado.

Observação:

Toda aplicação que já tenha sido transmitida e que esteja atualmente persistida no AppCatUI, pode ser listada por esta API. Ou seja, não se restringe apenas às aplicações listadas na AIT atual. No caso do {service-context-id} ser diferente do serviço atualmente selecionado, apenas aplicações persistidas no AppCatUI serão retornadas.

O "entryPoint" é uma URL, indicando que o conteúdo da aplicação pode estar na web ou no DSM-CC da emissora.

Se não houver aplicações interativas Ginga vinculadas ao serviço especificado, a API deve retornar uma lista vazia.

Retorna as informações detalhadas da sinalização de uma aplicação interativa Ginga.

Inicia ou interrompe a execução de uma aplicação interativa Ginga.

Permite obter o valor de uma propriedade declarada em um nó de aplicação Ginga-NCL (ou todas as propriedades declaradas neste nó). O nó em questão pode ser o nó 'application/x-ginga-settings'.

Se var-name não estiver especificado, e se não houver propriedades definidas, o campo "nodeProperties" do retorno da API será uma lista vazia.

Permite a leitura de um valor persistido por uma aplicação interativa Ginga.

Se var-name não estiver especificado, e se não houver valores persistidos, o campo "persistentData" do retorno da API será uma lista vazia.

Permite escrever (adicionando ou substituindo) um dado na área de persistência de aplicações Ginga, de modo que possa ser posteriormente lido por estas aplicações.

Utiliza-se o parâmetro de query var-name para identificar o dado, e o valor do campo "varValue" no corpo da mensagem para identificar o novo valor a ser atribuído a este dado. Se este último for omitido, a operação deve excluir a variável da área de persistência.

Variáveis com os prefixos "channel." e "service." seguem o escopo identificado pelo {service-context-id}, escrevendo valores na área de persistência correspondente ao canal e ao serviço em questão.

Assim como em 8.3.5, as variáveis persistentes devem ser prefixadas por "channel.", "service." ou "shared.".

Toda aplicação que já tenha sido transmitida e que esteja atualmente persistida no AppCatUI, pode ser referenciada por esta API. Ou seja, não se restringe apenas às aplicações listadas na AIT atual. No caso do {service-context-id} ser diferente do serviço atualmente selecionado, apenas aplicações persistidas no AppCatUI e variáveis cuja duração se estenda ao serviço corrente no momento da escrita podem ser referenciadas.

As variáveis escritas por ambos os formatos de requisição podem ser lidas pelas aplicações normalmente, independentemente do {appid}. No entanto, uma variável escrita pelo formato (2) não pode ser lida pelo formato (1) da API de leitura por não ficar associada a nenhum {appid} em particular, enquanto que o contrário pode sim ser aplicado.

Permite a leitura de um valor persistido por uma aplicação interativa Ginga, utilizando o identificador "ginga" em vez do appid.

Se var-name não estiver especificado, e se não houver valores persistidos, o campo "persistentData" do retorno da API será uma lista vazia.

Permite escrever (adicionando ou substituindo) um dado na área de persistência de aplicações Ginga, utilizando o identificador "ginga" em vez do appid.

Utiliza-se o parâmetro de query var-name para identificar o dado, e o valor do campo "varValue" no corpo da mensagem para identificar o novo valor a ser atribuído a este dado. Se este último for omitido, a operação deve excluir a variável da área de persistência.

Variáveis com os prefixos "channel." e "service." seguem o escopo identificado pelo {service-context-id}, escrevendo valores na área de persistência correspondente ao canal e ao serviço em questão.

Toda aplicação que já tenha sido transmitida e que esteja atualmente persistida no AppCatUI, pode ser referenciada por esta API. Ou seja, não se restringe apenas às aplicações listadas na AIT atual. No caso do {service-context-id} ser diferente do serviço atualmente selecionado, apenas aplicações persistidas no AppCatUI e variáveis cuja duração se estenda ao serviço corrente no momento da escrita podem ser referenciadas.

As variáveis escritas por ambos os formatos de requisição podem ser lidas pelas aplicações normalmente, independentemente do {appid}. No entanto, uma variável escrita pelo formato (2) não pode ser lida pelo formato (1) da API de leitura por não ficar associada a nenhum {appid} em particular, enquanto que o contrário pode sim ser aplicado.

Permite acessar a estrutura e o conteúdo de arquivos transmitidos no carrossel DSM-CC de uma aplicação Ginga.

Permite acessar a estrutura e o conteúdo de arquivos transmitidos em um carrossel DSM-CC. Para isso, utilizam-se component-tag e carousel-id para identificá-los.

Caso o carrossel, especificado por carousel-id, não esteja carregado ou a sua descarga ainda não esteja concluída, o erro 301 é retornado imediatamente e a implementação do middleware fica responsável por iniciar a descarga do carrossel em questão, caso ela ainda não tenha sido iniciada.

Permite registrar-se como um listener para a recepção de stream events transmitidos em um carrossel DSM-CC identificado.

Abre um socket server em uma porta atribuída dinamicamente e devolve a informação necessária para que a aplicação possa conectar-se e receber os stream events (por exemplo, em Ginga-NCL via módulo Lua tcp; ou em HTML5 via WebSocket).

A quantidade de listeners/filtros disponibilizados pela plataforma para esta funcionalidade fica a critério da implementação do receptor DTVi.

Permite cancelar um listener de stream events, previamente registrado atraves da API 8.3.9

Lista nós (medias, contexts e switches) em um documento NCL transportado em uma aplicação Ginga-NCL que esteja em execução.

Permite executar uma transição na máquina de estados de um dos eventos monitorados de um nó em um documento NCL transportado em uma aplicação Ginga-NCL que esteja em execução.

Permite executar uma transição na máquina de estados de um dos eventos monitorados de um nó em um documento NCL transportado em uma aplicação Ginga-NCL que esteja em execução.

Permite que uma aplicação Ginga registre uma nova lista de grupos e subgrupos de teclas para a sua utilização. Grupos e subgrupos de teclas são representados de acordo com a semântica da variável "channel.keyCapture" do NCL (ver ABNT NBR 15606-2).

A identificação individual de cada tecla depende do ambiente de execução, Ginga-NCL ou Ginga-HTML5, e do conjunto de teclas suportados pelo motor HTML5, no caso de aplicações Ginga-HTML5 (ver ABNT NBR 15606-10).

A atribuição desta lista não é cumulativa, mas sim uma substituição simples da lista anterior.

Observação:

Caso o valor de "keyset" seja uma lista vazia, todas as teclas reservadas são liberadas.

Permite que uma aplicação Ginga verifique a lista de grupos e subgrupos de teclas atualmente reservados para a sua utilização.

Esta API deve ser acessível apenas a clientes locais associados.

Permite o envio de um comando de edição a uma aplicação Ginga-NCL em execução. Comandos de edição permitem a alteração do conteúdo e comportamento de uma aplicação Ginga-NCL em tempo de execução. Esta API oferece o mesmo comportamento da classe de eventos 'edit' do módulo Lua 'event', conforme descrito em ABNT NBR 15606-2. Desta forma, comandos de edição enviados por meio desta API alteram apenas a apresentação do documento e não o documento em si.

Permite o envio de um comando de edição a uma aplicação Ginga-NCL em execução. Comandos de edição permitem a alteração do conteúdo e comportamento de uma aplicação Ginga-NCL em tempo de execução. Esta API oferece o mesmo comportamento da classe de eventos 'edit' do módulo Lua 'event', conforme descrito em ABNT NBR 15606-2. Desta forma, comandos de edição enviados por meio desta API alteram apenas a apresentação do documento e não o documento em si.

Assume-se o documento principal (ponto de entrada) da aplicação.

Caso a plataforma seja capaz de filtrar e retransmitir pacotes MPEG-TS transmitidos nos PID especificados, a implementação deve disponibilizar acesso a estes por meio de uma URL definida dinamicamente.

A quantidade de streams simultâneos disponibilizados pela plataforma para esta funcionalidade fica a critério da implementação do receptor DTVi. A implementação do Ginga CC WebServices deve disponibilizar o conteúdo da mídia utilizando RTSP como protocolo de controle, em conjunto com RTP para a entrega dos fluxos de mídia propriamente ditos.

É possível que alguns dos PID especificados estejam ausentes e/ou deixem de ser transmitidos no serviço, comprometendo a retransmissão no fluxo RTSP/RTP dos pacotes MPEG-TS relativos a esses PID. O cliente deve ser capaz de identificar intermitências no fluxo RTP e deve estar livre para implementar heurísticas de sua escolha, a fim de se desconectar do servidor RTSP/RTP, no caso de detecção de falhas na transmissão.

Inicia, interrompe, pausa e/ou altera o estado de reprodução de um exibidor de mídia.

As operações a serem realizadas são especificadas no corpo da mensagem em formato de objeto JSON, seguindo a mesma semântica e o formato definidos em 8.2.6.

O uso do campo "url" permite especificar o conteúdo a ser reproduzido pelo exibidor de mídia, e pode ser omitido caso a exibição já esteja em andamento.

Permite liberar um recurso de stream previamente aberto por meio da API 8.5.1.

Retorna a hora informada na TOT sendo transmitida no transport stream associado ao serviço atualmente selecionado.

Retorna uma estrutura JSON com as informações da NIT transmitida no transport stream associado ao service-context-id especificado.

Retorna uma estrutura JSON com as informações da SDT transmitida no transport stream associado ao service-context-id especificado.

Retorna uma estrutura JSON com as informações da PAT transmitida no transport stream associado ao service-context-id especificado.

Retorna uma estrutura JSON com as informações da BAT transmitida no transport stream associado ao service-context-id especificado.

Retorna uma estrutura JSON com as informações da PMT correspondente ao service-context-id especificado.

Retorna uma estrutura JSON com as informações da grade de programação (EPG) correspondente ao service-context-id especificado.

Retorna uma estrutura JSON consolidada com informações da grade de programação (EPG) que tenham sido capturadas nos demais canais da lista.

Retorna uma estrutura JSON com as informações da BIT transmitida no transport stream associado ao service-context-id especificado.

Retorna uma lista com os exibidores de mídia (players) disponíveis no receptor.

Retorna informações sobre um exibidor de mídia específico, identificado pelo seu ID.

Permite consultar um conjunto de características, capacidades e recursos da plataforma, como: tamanho físico de tela, resolução das camadas de exibição, dispositivos de entrada e de rede compatíveis etc.

Permite consultar os sistemas de DRM suportados na plataforma, e por meio de quais bibliotecas é possível decodificar e exibir o conteúdo multimídia criptografado.

Desta forma, a aplicação é capaz de consultar primeiro as capacidades da plataforma, e implementar adequadamente a decodificação e a exibição do conteúdo multimídia.

Oferece uma forma padronizada que permite a uma aplicação instalada no receptor (independentemente de sua origem e ambiente de execução) registrar os filtros de URL para o acesso posterior via deep links.

Os filtros de URL são registrados obedecendo ao padrão ":///".

Lista as aplicações-alvo atualmente instaladas, com seu estado atual e filtros de URL registrados (de acordo com o padrão ":///").

A API não lista todas as aplicações-alvo instaladas no receptor DTVi indiscriminadamente, mas sim aquelas que tenham registrado filtros compatíveis com o parâmetro obrigatório .

O parâmetro opcional permite restringir o filtro ainda mais, para incluir apenas a aplicação-alvo especificada.

Observação:

Todas as aplicações registradas por meio da API 8.6.3 devem ser listadas por meio desta API. Adicionalmente, caso a plataforma suporte o registro de filtros de deep links por meio de outros mecanismos, as aplicações que fizeram esse registro podem também ser listadas.

Se não houver aplicações-alvo atualmente instaladas, a API deve retornar uma lista vazia.

Lista as aplicações-alvo atualmente instaladas, com seu estado atual e filtros de URL registrados (de acordo com o padrão ":///").

A API não lista todas as aplicações-alvo instaladas no receptor DTVi indiscriminadamente, mas sim aquelas que tenham registrado filtros compatíveis com o parâmetro obrigatório .

Observação:

Todas as aplicações registradas por meio da API 8.6.3 devem ser listadas por meio desta API. Adicionalmente, caso a plataforma suporte o registro de filtros de deep links por meio de outros mecanismos, as aplicações que fizeram esse registro podem também ser listadas.

Se não houver aplicações-alvo atualmente instaladas, a API deve retornar uma lista vazia.

Permite (1) ativar uma aplicação-alvo, a partir de uma URL customizada (que pode conter a ação de deep link a ser efetuada), ou (2) alterar o estado e/ou a prioridade de uma aplicação-alvo por meio de seu targetId.

Observação:

Alguns comportamentos do uso de deep links ficam facultativos à implementação do receptor. Exemplos:

• A exibição ou não de um pop-up de confirmação antes da execução do deep link (e a gravação ou não dessa primeira confirmação para usos subsequentes);
• O encerramento ou não do contexto de serviço DTV (e, por conseguinte da aplicação Ginga atual), automaticamente quando da execução de um deep link.
• Mesmo que a aplicação específica tratadora de um deep link não esteja instalada, o sistema operacional do receptor pode ser capaz de identificar sua origem, e executar o portal ou loja de aplicações que permita ao usuário fazer a instalação desta aplicação.

Oferece uma forma padronizada que permite que uma aplicação-alvo, após ativada a partir de uma URL customizada, obtenha o valor desta última URL.

Desta forma, a aplicação pode, durante sua inicialização, tratar uma ação de deep link a ser efetuada.

Vincula o serviço atualmente selecionado como um contexto de serviço passível de ser acessado pelas APIs do Ginga CC WebServices.

Observação:

Esta API pressupõe uso obrigatório de parâmetros de cabeçalho na requisição HTTP. O parâmetro "bind-token" faz com que seu valor seja acrescentado a uma lista de tokens autorizados, associados ao serviço em questão.

Obrigatoriamente esta API só deve ser válida quando chamada por meio de um cliente local associado. Ou seja, quando a emissora quiser autorizar uma aplicação presente no ambiente doméstico, a acessar seu conteúdo (e, sobretudo, identificá-lo corretamente), a autorização é efetuada por meio de uma aplicação Ginga (Ginga-HTML5 ou Ginga-NCL) enviada em seu sinal, que fará a requisição a esta API do Ginga CC WebServices.

Uma vez feito este processo de vinculação, aplicações no ambiente doméstico (devidamente autenticadas) passarão a ter este privilégio de acessar o serviço da emissora, sem depender que a aplicação Ginga entre em execução novamente, economizando recursos.