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.

Los Widgets HTML también pueden ser alojados como una página web, entonces puede programar su página web como un elemento de la lista de reproducción


Versiones soportadas

Versión 1.32.12 y posteriores


Funciones

Estas son algunas de las cosas que puede hacer con los Widgets HTML.

 

  • Acceder a los archivos locales del reproductor.
    El archivo index.html funciona como cualquier otro archivo index que pueda enlazar con elementos en el PC local, que en este caso es un reproductor.
    Por ejemplo, puede añadir '<img src="C:\folder\x.jpg"> y mostrará esta imagen.

  • Un widget tiene acceso a las configuraciones personalizadas para el reproductor, que se envían como variables querystring con la URL de inicio. Por ejemplo una variable llamada TestId con un valor de 1234, la URL solicitada por el reproductor será https://domain.com/index.html?TestId=1234

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>",
    "thumbnail": "<required>",
    "version": "<optional>",
    "description": "<optional>",
    "created": "<optional>",
    "size": <optional>,
    "hash": "<optional>",
    "privileges": "<optional>"
}
Genérico

 

  • name
    Nombre que se 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 reproductores 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.

  • thumbnail
    Nombre del archivo que el portal utilizará como miniatura. Se recomienda que el archivo esté en el nivel raíz y tenga una extensión de archivo .png o .jpg

  • 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.
  • created
    Para uso futuro. Hora de creación del contenido del widget. Una marca de tiempo en formato ISO8601. Se supone que debe aparecer 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 debe tener la página web del widget en su iframe.
    Lo lee el reproductor cuando carga el widget.
    Sigue el mismo formato que el atributo "sandbox" de un iframe, véase por ejemplo esta página:
    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
Genérico

 

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"
}
Genérico

Un ejemplo de lo que puede contener un widget

To4pR_8bLSAPXUTQWHNCIIK9RO06ZOtGbA.png?1616061872

 


Cómo programar un widget

En el portal, vaya a Content library > folder y pulse Upload file. 
Seleccione su archivo zip y pulse '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.

¿Fue útil la respuesta? 0 Los Usuarios han Encontrado Esto Útil (0 Votos)