Esta guía le enseñará a crear un widget HTML para los reproductores de INNDS basic. 


 

Reproductores admitidos

Los siguientes reproductores soportan actualmente los widgets HTML.

  • SSSP2
  • SSSP3
  • Tizen (SSSP4, SSSP5 and SSSP6)
  • Brightsign (HD223 and HD224)


 

Cómo crear un widget HTML

Un widget es un archivo zip (debe tener la terminación .zip) que además de una página web e imágenes, etc., contiene un manifiesto. 

Cuando se carga el archivo zip, INNDS buscará un nombre, una miniatura y una página de inicio que utilizará leyendo el manifiesto.  

 

Format manifest / Formato del manifiesto

El manifiesto está en formato json, debe llamarse "manifest.json" y tiene el siguiente aspecto. Donde se imprime el valor o donde dice <required>, estos campos son obligatorios, mientras que <optional> es opcional. El orden en que vienen los atributos no es importante.

 

{
    "name": "<required>",
    "media_type": "application/x-dise-widget",
    "manifest_version": 1,
    "start": "<required>",
    "version": "<optional>",
    "description": "<optional>",
    "thumbnail": "<optional>"
    "created": "<optional>",
    "size": <optional>,
    "hash": "<optional>",
    "privileges": "<optional>"
}
Generic

 

 

  • name
    Nombre a mostrar en el portal, en los contenidos y en las listas de reproducción

  • media_type
    Debe ser "application / x-INNDS-widget". Si no existe, el portal no seguirá extrayendo miniaturas y los jugadores no seguirán cargando el widget.

  • manifest_version
    Por ahora este valor debe ser "1".

  • start
    Proporciona información sobre el nombre de archivo de la página html que se va a mostrar.Se recomienda que la página esté en el nivel raíz.

  • version
    Para uso futuro. Describe la versión del contenido del widget. Puede ser cualquier cadena y está destinado a ser mostrado en el portal.

  • description
    Para uso futuro. Descripción más larga del contenido del widget. Puede ser cualquier cadena y está pensada para ser mostrada en el portal.

  • thumbnail (Required!)
    nombre del archivo que el portal utilizará como imagen en miniatura; se recomienda que el archivo esté en el nivel raíz y tenga una extensión de archivo .png o .jpg

  • created
    Para uso futuro. Hora de creación del contenido del widget. Una marca de tiempo en formato ISO8601. Se supone que aparece en el portal

  • size
    Para uso futuro. Tamaño total en bytes del contenido del widget, para verificar la validez del mismo. Se supone que aparece en el portal.

  • hash
    Para uso futuro. Un hash SHA2 del contenido del widget, para verificar la validez del mismo.

  • privileges
    Describe los derechos que la página web del widget debe tener en su iframe.Leído por el reproductor cuando está cargando el widget.
    Sigue el mismo formato que el atributo "sandbox" de un iframe, véase por ejemplo este lado:
    https://html.com/attributes/iframe-sandbox/
    Si el atributo no existe, por defecto:

allow-forms allow-modals allow-pointer-lock allow-popups allow-scripts allow-same-origin
Generic

 

Ejemplo

Un ejemplo de manifiesto para un widget:

 

{
    "name": "MyWebsite",
    "media_type": "application/x-dise-widget",
    "manifest_version": 1,
    "description": "HTML5-application to show internal information",
    "start": "info.html",
    "thumbnail": "logo.png",
    "privileges": "allow-forms allow-modals allow-pointer-lock allow-popups allow-scripts allow-same-origin"
}
Generic

Un ejemplo de lo que puede contener un widget

cSx-ZQ2DRTqtvHYwrCZZ1Fijkq8paJ-kvQ.png?1613722804

 

Cómo programar un widget

Cómo programar un widget Content library > folder y pulse Upload file. 
Selecciona tu archivo zip y pulsa 'Ok'. 
El portal utilizará el nombre especificado en el manifiesto en lugar del nombre del archivo, así como extraerá y utilizará la miniatura enviada con y especificada en el manifiesto.

 

Acceso a los ajustes personalizados

Un widget tiene acceso a los ajustes personalizados para el reproductor, que se envían como variables de cadena de consulta con la URL de inicio, por ejemplo como: hash/index.html?var-x=abc


Acceder al sistema de archivos del dispositivo

Un widget puede pedir al sistema de archivos del dispositivo que le ayude a descargar contenidos, esos contenidos se descargarán en la misma ubicación que el index.html


Puede encontrar más información y ejemplos al respecto aquí: https://bitbucket.org/INNDSinc/widget-file-access-api/src/develop/

Kas see vastus oli kasulik? 0 Kasutajad peavad seda kasulikuks (0 Hääled)