API da Web local

A API Web Local é uma maneira simples de integrar dispositivos externos e acionar conteúdo no Player por meio de uma chamada HTTP de rede local.

A API da Web local é suportada pelo OnSign TV em Android, Windows, Linux, Mac e BrightSign Players.

Importante: Para usar a API da Web Local, esta opção deve estar habilitada nas configurações Player.

 

API Web local para Android Player 9.8.5

Endpoint Método Significado

http://127.0.0.1:5544/trigger/{pattern}

POST

Aciona a reprodução de uma campanha ou de uma Playlist que esteja configurada com uma interatividade contendo o padrão {pattern}.

http://127.0.0.1:5544/campaign/current/stop

POST

Interrompe a reprodução do conteúdo atual, pulando para o próximo no loop.

http://127.0.0.1:5544/attribute/{name}/{value}

PUT

Define o atributo {name} com o valor {value}.

http://127.0.0.1:5544/attribute/{name}

GET

Recupera o atributo {name} como JSON, no formato {"name": "attr_name", "value": "attr_value"}. Se nenhum valor for definido para este atributo ou se o atributo não existir, retorna {"name": "attr_name", "value": null}.

http://127.0.0.1:5544/attributes

GET

Recupera uma lista de todos os atributos atualmente definidos como JSON, no formato {"attributes": [{"name": "attr_name", "value": "attr_value"}]}. Se nenhum valor for definido para um atributo, ele não será listado.

API Web local para Windows/Mac/Linux Player 9.3.9:

Ponto final Método Significado

http://127.0.0.1:5544/trigger/{pattern}

GET, POST

Aciona a reprodução de uma campanha ou de uma Playlist que esteja configurada com uma interatividade contendo o padrão {pattern}.

http://127.0.0.1:5544/campaign/current/stop

GET, POST

Interrompe a reprodução do conteúdo atual, pulando para o próximo no loop.

http://127.0.0.1:5544/playback/status

GET, POST

Recupere o status de reprodução como JSON, no formato {"visible": true, "playing": true}.

http://127.0.0.1:5544/playback/show

GET, POST

Exibe a janela Player. Se a janela já estiver visível, nada acontece.

http://127.0.0.1:5544/playback/hide

GET, POST

Oculta a janela Player. A reprodução continua em segundo plano.

http://127.0.0.1:5544/playback/start

GET, POST

Inicia a reprodução do conteúdo. Se o conteúdo já estiver em reprodução, nada acontece.

http://127.0.0.1:5544/playback/stop

GET, POST

Interrompe a reprodução do conteúdo. Exibe uma tela preta até que a reprodução seja retomada.

OnSign TV Academy - Interatividade com teclado e rede local