API web local

Integración de software y sistemas externos a su reproductor de TV OnSign

La API web local es una forma sencilla de integrar dispositivos externos y activar contenido en el player a través de una llamada HTTP de red local.

La API web local es compatible con OnSign TV en Android, Windows, Linux, Mac y reproductores de BrightSign.

Importante

Para utilizar la API web local, esta opción debe estar habilitada en los ajustes del player.

 

 

API web local para Android Player 9.8.5

Punto final Método Significado
http://127.0.0.1:5544/trigger/{pattern} POST Activa la reproducción de una campaña o una playlist que esté configurada con una interactividad que contenga el patrón {pattern}.
http://127.0.0.1:5544/campaign/current/stop POST Detiene la reproducción del contenido actual y salta al siguiente en el bucle.
http://127.0.0.1:5544/attribute/{name}/{value} PUT Establece el atributo {name} con el valor {value}.
http://127.0.0.1:5544/attribute/{name} GET Recupera el atributo denominado {name} como JSON, en el formato {"name": "attr_name", "value": "attr_value"}. Si no se establece ningún valor para este atributo o el atributo no existe, devuelve {"name": "attr_name", "value": null}.
http://127.0.0.1:5544/attributes GET Recupera una lista de todos los atributos configurados actualmente como JSON , en el formato {"attributes": [{"name": "attr_name", "value": "attr_value"}]}. Si no se configura ningún valor para un atributo, no se incluye en la lista.

API web local para reproductor Windows/Mac/Linux 9.3.9:

Punto final Método Significado
http://127.0.0.1:5544/trigger/{pattern} GET, POST Activa la reproducción de una campaña o una playlist que esté configurada con una interactividad que contenga el patrón {pattern}.
http://127.0.0.1:5544/campaign/current/stop GET, POST Detiene la reproducción del contenido actual y salta al siguiente en el bucle.
http://127.0.0.1:5544/playback/status GET, POST Recupere el estado de reproducción como JSON , en el formato {"visible": true, "playing": true}.
http://127.0.0.1:5544/playback/show GET, POST Muestra la ventana del reproductor. Si la ventana ya está visible, no sucede nada.
http://127.0.0.1:5544/playback/hide GET, POST Oculta la ventana del reproductor. La reproducción se realiza en segundo plano.
http://127.0.0.1:5544/playback/start GET, POST Comienza a reproducir el contenido. Si el contenido ya se está reproduciendo, no sucede nada.
http://127.0.0.1:5544/playback/stop GET, POST Detiene la reproducción de contenido. Muestra una pantalla negra hasta que se reanuda la reproducción.