Pantallas de visualización

Changes Display Screens settings shared by every facility in the facility's brand: the boot screen shown while screens start up, the settings new screens start with, and what templated content shows. Organisation admins only; read the current values and canEdit with display_settings_read boot_screen, screen_defaults or templated.

Actions:

• save_boot_screen: Save the boot screen. Sets the boot screen image (PNG, JPEG or WebP, up to 10 MB, from a public https imageUrl or imageBase64) and/or how it is laid out. Without an image, fit and background re-render the current one. Screens pick it up when they next start. Asks for confirmation.
• reset_boot_screen: Reset the boot screen. Removes the brand's boot screen; screens go back to the default one when they next start. Asks for confirmation.
• save_screen_defaults: Save the screen defaults. The settings a screen starts with when it is paired at one of the brand's facilities. Only the settings you pass change. Screens that are already paired keep their own settings; change those with device_inventory_write configure_screen. Asks for confirmation.
• save_templated: Save templated content settings. What templated content screens and the Schedule show: the data source name, workout names, programs in the Schedule and how far ahead, training phases and how far ahead, and Program Builder training camps (one banner per week) and how far ahead. Asks for confirmation.

Crea, cambia de nombre y elimina grupos de Display Screens en una instalación y define qué pantallas pertenecen a ellos. Los grupos son destinos de publicación (display_publish targets.groupIds) y destinos de comandos (display_screen_command groupIds). Cuando se indican varias pantallas, grupos o destinos, actúa sobre todos ellos en una sola llamada; consulta con el usuario antes de actuar sobre muchos.

Acciones:

• save: Guardar un grupo. Crear: name (y, opcionalmente, screenIds). Cambiar el nombre: groupId (ID o nombre actual) y name. screenIds reemplaza los miembros; las pantallas que no aparecen salen de este grupo, pero conservan sus otros grupos.
• delete: Eliminar un grupo. Elimina un grupo: sus pantallas salen de él (conservan sus otros grupos) y el contenido publicado en el grupo se quita de la programación. Requiere groupId. Pide confirmación.

Publica apps HTML estáticas ("apps alojadas") para Display Screens. Llama primero a display_library_read app_guidelines para conocer los tamaños de pantalla, las reglas de diseño, los límites y el SDK, y después a display_screenshot para comprobar el resultado en una pantalla. Cuando se indican varias pantallas, grupos o destinos, actúa sobre todos ellos en una sola llamada; consulta con el usuario antes de actuar sobre muchos.

Acciones:

• publish: Publicar una app alojada. Crea una app alojada (name + files) o publica una nueva versión (appId + files; se activa en todos los lugares donde se muestra la app y rollback la deshace). publishTo también la coloca en pantallas, como hace display_publish; un destino de marca u organización requiere confirm. Requiere files. Puede pedir confirmación.
• rollback: Revertir una app alojada. Vuelve a convertir una versión anterior en la actual, en todos los lugares donde se muestra la app. Lista las versiones con display_library_read app_versions. Requiere appId, version.

Lee la biblioteca de contenido de Display Screens visible para una instalación: multimedia (imágenes, videos), apps (páginas web, apps HTML alojadas, apps de Agente de IA, vistas de CCTV) y listas de reproducción, además de las apps de Agente de IA y las fuentes de CCTV que se pueden agregar.

Cada elemento tiene un contentRef (media#…, app#…, playlist#…) para display_publish y las listas de reproducción. ownerScope indica quién es su propietario (facility#, brand# u org#); el contenido solo se puede publicar dentro de su propietario. El contenido multimedia con estado processing aún no está listo; failed debe volver a subirse. Las páginas web con frameable: false no se pueden reproducir en listas de reproducción, solo como pantalla de página completa. Las pantallas omiten los elementos con displayIssue: una app de Agente de IA sin publicar, en pausa, display-off, con audiencia limitada o sin Custom Apps; una vista de CCTV con no-cctv, cctv-off (un administrador de la instalación activa el CCTV para las pantallas en la configuración de Display Screens) o no-cameras.

Acciones:

• list: Listar los elementos de la biblioteca. Multimedia y apps (paginado; filtra por type, kind, etiqueta o nombre) o, con type agent-apps, las apps de Agente de IA permitidas en pantallas que puedes publicar con display_publish content.agentAppId. Cada elemento tiene un type: media, app o agent-app.
• cctv_sources: Listar las fuentes de CCTV. Las cámaras de la instalación y las Vistas en vivo compartidas para display_publish content.cctv, y si el CCTV en pantallas está activado. Requiere acceso al CCTV en la instalación.
• get: Obtener un elemento de la biblioteca. Un elemento multimedia, una app o una lista de reproducción por contentRef. Requiere contentRef.
• usages: Dónde se usa el contenido. Las asignaciones activas de la programación y las listas de reproducción que usan un elemento multimedia o una app (o las asignaciones de una lista de reproducción). El contenido en uso no se puede eliminar. Requiere contentRef.
• app_versions: Listar las versiones de una app alojada. Las versiones de una app alojada y cuál es la actual, para display_hosted_apps_write rollback. Requiere appId.
• app_guidelines: Pautas para apps alojadas. Tamaños de pantalla, reglas de diseño, límites del paquete, el Display App SDK y una plantilla inicial. Llámala antes de crear una app para display_hosted_apps_write publish.
• check_url: Comprobar una página web. Si una página web se puede mostrar dentro de listas de reproducción (algunos sitios no permiten que se incrusten en un marco), con indicaciones sobre cómo se ve. Las páginas que no permiten el marco pueden seguir mostrándose como pantalla de página completa. Requiere url.
• playlists: Listar las listas de reproducción. Las listas de reproducción visibles para la instalación (paginado), cada una con sus elementos (contentRef, duración, ajuste).

Agrega y cambia contenido de la biblioteca de Display Screens: sube imágenes y videos, crea apps de página web, de Agente de IA y de vista de CCTV, edita nombres, etiquetas, duraciones y fechas, elimina elementos sin usar y actualiza la vista previa de una app. Las apps HTML alojadas se publican con display_hosted_apps_write; las listas de reproducción, con display_playlists_write.

Diseña las imágenes a 1920×1080 (horizontal) o 1080×1920 (vertical). El contenido multimedia nuevo empieza en processing mientras se crean las versiones aptas para la web; se puede agregar a listas de reproducción de inmediato y se reproduce cuando está listo. ownerScope: facility (predeterminado), brand u organisation (brand y organisation requieren acceso a toda la organización).

Acciones:

• upload_media: Subir una imagen o un video. Agrega una imagen o un video desde una url https pública (preferible; imágenes de hasta 25 MB, videos de hasta 200 MB) o en base64 con mimeType (hasta 20 MB). Imágenes JPEG, PNG, WebP y GIF; videos MP4, WebM y MOV (convertidos a MP4 H.264 de hasta 1080p). Para videos más grandes: create_video_upload.
• create_video_upload: Iniciar la subida de un video grande. Para videos de hasta 2 GB: registra el video y devuelve una subida prefirmada (envía el archivo con PUT a upload.url con upload.headers antes de upload.expiresAt) y, después, llama a transcode con su contentRef. Requiere name, mimeType, bytes.
• transcode: Procesar un video. Convierte un video para las pantallas: después de create_video_upload, de nuevo tras un error o para un video antiguo que las pantallas no pueden reproducir. Requiere contentRef.
• create_app: Agregar una app. Agrega una página web (kind url, pasa url; se comprueba si permite el marco), una app de Agente de IA (kind agent-app, pasa agentAppId de display_library_read list type agent-apps) o una vista de CCTV (kind cctv-view, propiedad de la instalación, requiere acceso al CCTV). Requiere kind, name.
• update: Actualizar un elemento de la biblioteca. Cambia el nombre, las etiquetas o la duración de un elemento multimedia o una app; validFrom/validTo de un elemento multimedia (ISO, null lo borra; fuera de ese período se omite); la url de una página web; o las cámaras, la vista, la disposición o la calidad de una vista de CCTV. Requiere contentRef.
• delete: Eliminar un elemento de la biblioteca. Elimina un elemento multimedia o una app. Está bloqueado mientras esté en una programación activa o en una lista de reproducción: el error las indica (quítalo primero con display_schedule_write delete o display_playlists_write save). Requiere contentRef. Pide confirmación.
• refresh_preview: Actualizar la vista previa de una app. Toma una nueva captura de pantalla de una app para su vista previa en la biblioteca (por ejemplo, después de que cambió la página). Requiere contentRef.

Crea, actualiza y elimina listas de reproducción de Display Screens: secuencias ordenadas y en bucle de contenido multimedia y apps. Los cambios llegan en segundos a todas las pantallas que muestran la lista de reproducción. Publica una lista de reproducción con display_publish content.contentRef "playlist#".

Acciones:

• save: Guardar una lista de reproducción. Crear: name + items (items puede estar vacío). Actualizar: playlistId + cualquiera de name, items, transition; items reemplaza la lista completa, así que envía todos los elementos en orden.
• delete: Eliminar una lista de reproducción. Elimina una lista de reproducción. Está bloqueado mientras esté publicada en algún lugar: el error indica las asignaciones que debes quitar primero (display_schedule_write delete). Requiere playlistId. Pide confirmación.

Coloca contenido en Display Screens: un elemento multimedia, una lista de reproducción, una app, una página web, una app de Agente de IA o una vista en vivo de CCTV, en pantallas, grupos, la instalación, su marca o su organización.

mode: now (predeterminado) reemplaza lo que los destinos muestran normalmente; scheduled lo muestra solo en franjas semanales (zona horaria de la instalación) y/o entre from y to; takeover interrumpe todo durante durationMin (o hasta una hora) y luego termina solo (detenlo antes con display_takeover_stop). Las pantallas deciden qué mostrar por capa (takeover > scheduled > default) y luego según lo específico que sea el destino (screen > group > facility > brand > organisation).

Circuito cerrado de televisión: las transmisiones en vivo de las cámaras son visibles para cualquier persona cerca de las pantallas. La primera llamada devuelve requiresConfirmation (código CCTV_CONFIRMATION_REQUIRED); pregunta al usuario y vuelve a llamar con confirmCctv: true. La instalación debe tener activado "Allow CCTV on display screens".

Solo las pantallas en modo player muestran contenido publicado; las demás aparecen en warnings. Devuelve un batchId; display_schedule_write delete con ese ID deshace toda la publicación. Cuando se indican varias pantallas, grupos o destinos, actúa sobre todos ellos en una sola llamada; consulta con el usuario antes de actuar sobre muchos.

Lee lo que está publicado en Display Screens: para una pantalla, lo que muestra en un momento dado y durante un intervalo (resuelto en todas las capas y destinos de los que hereda), además de las asignaciones que le llegan; o las asignaciones publicadas en un grupo, la instalación, su marca o su organización.

Los ID de asignación (as_…) y de lote (bt_…) son los que display_schedule_write actualiza o elimina. Las horas están en formato ISO; las franjas, en la zona horaria de la instalación.

Acciones:

• get: Obtener la programación de una pantalla. Lo que muestra una pantalla en at (predeterminado: ahora), su línea de tiempo de from a to (predeterminado: 24 horas) y todas las asignaciones que le llegan. Requiere screenId.
• list_assignments: Listar las asignaciones. Las asignaciones publicadas en un grupo (groupId) o en la instalación, su marca o su organización (target, predeterminado: facility). Paginado, con el cambio más reciente primero.

Cambia lo que está publicado en Display Screens: edita el horario, la prioridad o el contenido de una asignación (opcionalmente en toda su publicación), o quita una asignación o una publicación completa. Encuentra los ID con display_schedule_read. Al quitar contenido de la programación, este permanece en la biblioteca; para terminar un takeover antes de tiempo pero conservar su historial, usa display_takeover_stop.

Acciones:

• update: Actualizar una asignación. Cambia el horario (franjas semanales, from/to; null borra una fecha), la prioridad o el contenido de una asignación. applyToBatch aplica el mismo cambio a todos los destinos de la publicación. A un takeover solo se le puede cambiar la hora de finalización. El contenido de CCTV requiere confirmCctv después de que el usuario lo haya aceptado. Requiere assignmentId.
• delete: Quitar de la programación. Quita una asignación (assignmentId) o todo lo de una publicación (batchId). En segundos, las pantallas vuelven a lo que mostrarían de otro modo. Pide confirmación.

Envía un comando en tiempo real a Display Screens en una instalación: reload (las pantallas player vuelven a obtener su programación), identify (muestra brevemente el nombre y el código de la pantalla, para encontrarla en el lugar), displayOn/displayOff (el panel del televisor), rebootDevice (reinicia la computadora de la pantalla, que queda en blanco 1–2 minutos; requiere confirm: true) u osd (un mensaje breve en pantalla; pasa message).

Elige las pantallas con screenIds y/o groupIds (todas las pantallas de esos grupos en la instalación), o con allScreens: true para todas las pantallas de la instalación (en ese caso, displayOn/displayOff también llegan a las pantallas de templated content). Devuelve los resultados por pantalla. Cuando se indican varias pantallas, grupos o destinos, actúa sobre todos ellos en una sola llamada; consulta con el usuario antes de actuar sobre muchos.

Lee las Display Screens de una instalación: las lista con su estado y lo que se muestra ahora y a continuación (filtra por grupo, estado o modo de visualización), obtiene el detalle completo y la línea de tiempo de una pantalla, o lista los grupos de pantallas con sus pantallas.

El modo de visualización se muestra a los usuarios como "Data Source": player es "User managed content", program-builder es "Templated content" (nunca digas "Program Builder" a los usuarios) y url es "Full-page website (Kiosk Mode)". Las horas están en formato ISO; se devuelve la zona horaria de la instalación.

Acciones:

• list: Listar las pantallas. Las pantallas de la instalación (paginado), cada una con su estado, última señal de actividad, grupos, etiquetas y lo que se muestra ahora y a continuación. También devuelve los grupos.
• get: Obtener una pantalla. El detalle completo de una pantalla (estado, señal de actividad, versión del reproductor, errores recientes) y, para las pantallas player, lo que muestra en un intervalo de tiempo (predeterminado: las próximas 24 horas, máximo 14 días). Requiere screenId.
• groups: Listar los grupos de pantallas. Los grupos de pantallas de la instalación (paginado), cada uno con sus pantallas.

Cambia Display Screens: vincula una pantalla nueva con su código de vinculación; cambia el nombre de una pantalla, define sus grupos y etiquetas o cambia su modo de visualización (que se muestra a los usuarios como "Data Source"); rota el token de una pantalla player; crea un enlace de vista previa de duración limitada de una pantalla o de un contenido; o restablece una pantalla a los valores de fábrica (la quita de la instalación).

Modos de visualización: player ("User managed content"), url ("Full-page website (Kiosk Mode)", pasa url, solo https), program-builder ("Templated content"; nunca digas "Program Builder" a los usuarios). Cambiar el modo vuelve a cargar la pantalla de inmediato y cambia lo que ven los miembros, por lo que requiere la confirmación del usuario.

Acciones:

• update: Actualizar una pantalla. Define el nombre, los grupos (ID o nombres; reemplazan los grupos actuales), las etiquetas (las reemplaza) y/o el modo de visualización de una pantalla. Un cambio de modo devuelve primero requiresConfirmation. Requiere screenId. Puede pedir confirmación.
• rotate_token: Rotar el token de la pantalla. Emite un token nuevo para una pantalla player y la vuelve a cargar; el token anterior deja de funcionar. Úsalo cuando la URL del reproductor de una pantalla pueda haberse filtrado. Requiere screenId. Pide confirmación.
• create_preview_link: Crear un enlace de vista previa. Un enlace (válido durante un tiempo limitado) que muestra lo que muestra una pantalla o cómo se ve un contenido, opcionalmente en un momento futuro. Cualquier persona con el enlace puede verlo hasta que caduque.
• reset: Restablecer una pantalla a los valores de fábrica. Quita la pantalla de la instalación y la restablece a los valores de fábrica; una pantalla apagada se restablece la próxima vez que se conecta y luego muestra su página de vinculación. Pasa confirmName: el nombre de la pantalla exactamente como lo escribió el usuario. Requiere Gestión de dispositivos. Requiere screenId, confirmName. Pide confirmación.
• pair: Vincular una pantalla nueva. Agrega una pantalla nueva a la instalación con el código de 6 caracteres de su página de vinculación y luego la vuelve a cargar. En las instalaciones que solo tienen Display Screens se inicia en player; si también tienen templated content, lo elige mode (predeterminado: program-builder). Requiere Gestión de dispositivos. Requiere pairingCode, name. Pide confirmación.

Captura lo que muestra una Display Screen en este momento y devuelve la imagen, para que puedas comprobar tu propio trabajo después de publicar (disposición, tamaño del texto, que nada quede cortado ni se desplace). Espera hasta 15 segundos a que la pantalla responda; en las pantallas desconectadas se agota el tiempo de espera. También devuelve una URL del portal para el JPEG (solo para usuarios que iniciaron sesión, se conserva durante 10 minutos).

Las capturas de pantalla pueden incluir CCTV en vivo y miembros a la vista; no las compartas fuera de la conversación.

Reads Display Screens settings for a facility: the fallback slate, polling and nightly reload, CCTV on screens; the screen power schedule (with the next days' on/off times); automations (brightness, bell volume, check-in power, round timer state); the brand's boot screen, screen defaults and templated content settings; and, with templated content, the scheduled program dates and the templated schedule.

Actions:

• settings: Get facility display settings. The fallback slate (message, background, logo, facility name), polling interval, nightly reload time and whether CCTV may be shown on screens.
• power_schedule: Get the power schedule. When screens turn on and off: the saved schedule (or the older automations' equivalent), the facility time zone and the on/off times for the next 7 days.
• power_schedule_preview: Preview a power schedule. The on/off times a schedule would give over the next 7 days, without saving it. Needs schedule.
• automations: Get display automations. Automatic brightness (day/night levels and triggers), bell volume levels and schedule (decimal hours, 6.5 = 06:30), check-in power, and the round timer state, for one or several facilities. usesGlobalDefaults is true until the facility saves its own.
• boot_screen: Get the brand's boot screen. The image the facility's brand shows while screens start up (fit, background, image URLs) and whether you can change it (organisation admins).
• screen_defaults: Get the brand's screen defaults. The settings a screen starts with when it is paired at one of the brand's facilities (orientation, screen mirroring, session timer, speaker control, duress monitoring, camera restreaming, Wi-Fi support) and whether you can change them (organisation admins). Screens that are already paired keep their own settings; see device_inventory_read for those.
• templated: Get the brand's templated content settings. What templated content screens and the Schedule show for the facility's brand (source name, workout names, programs and training phases, look-ahead days) and whether you can change it (organisation admins).
• program_dates: List scheduled program dates. The dates with a workout program, from the start of this month to the brand's look-ahead. Needs templated content (Program Builder) at the facility.
• templated_schedule: Get the templated schedule. Programs and training phases between two dates (YYYY-MM-DD, at most 62 days), as the brand shows them. Needs templated content (Program Builder) at the facility. Needs from, to.

Cambia la configuración de Display Screens de una instalación: la pantalla de respaldo, el sondeo y la recarga nocturna, y "Allow CCTV on display screens"; el horario de encendido de las pantallas; y las automatizaciones (brillo, volumen de la campana, encendido al registrar la entrada). Los campos que omitas conservan sus valores actuales. La configuración de toda la marca (pantalla de arranque, templated content) está en display_brand_settings_write.

Acciones:

• save_settings: Guardar la configuración de visualización de la instalación. La pantalla de respaldo que se muestra cuando no hay nada programado, el intervalo de sondeo (30–300 s), la hora de la recarga nocturna (HH:mm) y allowCctv. Activar allowCctv requiere la confirmación del usuario y un administrador de la instalación con acceso al CCTV. Puede pedir confirmación.
• save_power_schedule: Guardar el horario de encendido. Cambia cuándo se encienden y apagan las pantallas; los campos que pases se combinan con el horario guardado. Devuelve las horas de encendido y apagado de los próximos 7 días. Compruébalo primero con display_settings_read power_schedule_preview. Requiere schedule.
• save_automations: Guardar las automatizaciones de visualización. Cambia la configuración del brillo automático, el volumen de la campana y el encendido al registrar la entrada. A partir de entonces, la instalación conserva su propia configuración en lugar de los valores predeterminados globales.

Termina ahora los takeovers de Display Screens en curso: de una publicación (batchId de display_publish), de destinos (predeterminado: los takeovers publicados en toda la instalación) o, con allScreens, todos los takeovers publicados en la instalación, sus pantallas o sus grupos. Los takeovers de marca y de organización solo se detienen por batchId. En segundos, las pantallas vuelven a su contenido programado o predeterminado; devuelve cuántos se detuvieron. Cuando se indican varias pantallas, grupos o destinos, actúa sobre todos ellos en una sola llamada; consulta con el usuario antes de actuar sobre muchos.

Controla las pantallas de templated content (modo de visualización "Templated content" en display_screens_read): carga en ellas el programa de entrenamiento de un día o controla el temporizador de rondas. Las pantallas de User managed content y de sitio web de página completa nunca se ven afectadas.

Acciones:

• load_program: Cargar un programa de entrenamiento. Carga el programa de entrenamiento de una fecha (YYYY-MM-DD, predeterminado: hoy) desde la fuente de datos de la instalación en todas las pantallas de templated content de una o varias instalaciones; las pantallas se vuelven a cargar en segundos. Úsalo para mostrar el entrenamiento de hoy o de otro día, o cuando las pantallas muestran uno incorrecto. Varias instalaciones requieren confirm. Puede pedir confirmación.
• clock: Controlar el temporizador de rondas. Inicia, pausa, reinicia o detiene el temporizador de rondas en las pantallas de templated content, silencia o activa los sonidos de las rondas, ajusta el volumen de la campana (setvolume con volume 0–100) o consulta su estado. Requiere templated content en la instalación. Requiere command.