Écrans d'affichage

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.

Crée, renomme et supprime les groupes Display Screens d'une installation et définit les écrans qu'ils contiennent. Les groupes sont des cibles de publication (display_publish targets.groupIds) et des cibles de commande (display_screen_command groupIds). Lorsque plusieurs écrans, groupes ou cibles sont indiqués, l'outil agit sur tous en un seul appel ; vérifiez auprès de l'utilisateur avant d'agir sur un grand nombre.

Actions :

• save : enregistrer un groupe. Création : name (et éventuellement screenIds). Renommage : groupId (ID ou nom actuel) et name. screenIds remplace les membres ; les écrans non listés quittent ce groupe mais conservent leurs autres groupes.
• delete : supprimer un groupe. Supprime un groupe : ses écrans le quittent (ils conservent leurs autres groupes) et le contenu publié sur le groupe est retiré de la programmation. Nécessite groupId. Demande une confirmation.

Publie des apps HTML statiques (« apps hébergées ») pour Display Screens. Appelez d'abord display_library_read app_guidelines pour connaître les tailles d'écran, les règles de conception, les limites et le SDK, puis display_screenshot pour vérifier le résultat sur un écran. Lorsque plusieurs écrans, groupes ou cibles sont indiqués, l'outil agit sur tous en un seul appel ; vérifiez auprès de l'utilisateur avant d'agir sur un grand nombre.

Actions :

• publish : publier une app hébergée. Crée une app hébergée (name + files) ou publie une nouvelle version (appId + files ; elle est mise en ligne partout où l'app est affichée, rollback l'annule). publishTo la place aussi sur des écrans, comme display_publish ; une cible de marque ou d'organisation nécessite confirm. Nécessite files. Peut demander une confirmation.
• rollback : restaurer une version d'une app hébergée. Rend de nouveau actuelle une version antérieure, partout où l'app est affichée. Listez les versions avec display_library_read app_versions. Nécessite appId, version.

Lit la bibliothèque de contenu Display Screens visible par une installation : médias (images, vidéos), apps (pages web, apps HTML hébergées, apps d'Agent IA, vues de vidéosurveillance) et playlists, ainsi que les apps d'Agent IA et les sources de vidéosurveillance qui peuvent être ajoutées.

Chaque élément possède un contentRef (media#…, app#…, playlist#…) pour display_publish et les playlists. ownerScope indique son propriétaire (facility#, brand# ou org#) ; un contenu ne peut être publié qu'au sein de son propriétaire. Un média avec le statut processing n'est pas encore prêt ; failed doit être téléversé de nouveau. Les pages web avec frameable: false ne peuvent pas être lues dans les playlists, seulement en écran pleine page. Les éléments avec un displayIssue sont ignorés par les écrans : une app d'Agent IA non publiée, en pause, display-off, à audience limitée ou sans Custom Apps ; une vue de vidéosurveillance avec no-cctv, cctv-off (un administrateur de l'installation active la vidéosurveillance sur les écrans dans les paramètres Display Screens) ou no-cameras.

Actions :

• list : lister les éléments de la bibliothèque. Médias et apps (paginés ; filtre par type, kind, tag ou name), ou, avec type agent-apps, les apps d'Agent IA autorisées sur les écrans que vous pouvez publier avec display_publish content.agentAppId. Chaque élément a un type : media, app ou agent-app.
• cctv_sources : lister les sources de vidéosurveillance. Les caméras de l'installation et les Live Views partagées pour display_publish content.cctv, et si la vidéosurveillance sur les écrans est activée. Nécessite un accès à la vidéosurveillance dans l'installation.
• get : obtenir un élément de la bibliothèque. Un média, une app ou une playlist par contentRef. Nécessite contentRef.
• usages : où le contenu est utilisé. Les affectations de programmation en cours et les playlists qui utilisent un média ou une app (ou les affectations d'une playlist). Un contenu utilisé ne peut pas être supprimé. Nécessite contentRef.
• app_versions : lister les versions d'une app hébergée. Les versions d'une app hébergée et celle qui est actuelle, pour display_hosted_apps_write rollback. Nécessite appId.
• app_guidelines : consignes pour les apps hébergées. Tailles d'écran, règles de conception, limites de paquet, le Display App SDK et un modèle de départ. Appelez cette action avant de créer une app pour display_hosted_apps_write publish.
• check_url : vérifier une page web. Indique si une page web peut s'afficher dans les playlists (certains sites refusent d'être intégrés dans un cadre), avec des indications sur son rendu. Les pages qui refusent l'intégration peuvent quand même servir d'écran pleine page. Nécessite url.
• playlists : lister les playlists. Les playlists visibles par l'installation (paginées), chacune avec ses éléments (contentRef, duration, fit).

Ajoute et modifie le contenu de la bibliothèque Display Screens : téléverser des images et des vidéos, créer des apps de page web, d'Agent IA et de vue de vidéosurveillance, modifier les noms, tags, durées et dates, supprimer les éléments inutilisés et actualiser l'aperçu d'une app. Les apps HTML hébergées se publient avec display_hosted_apps_write ; les playlists avec display_playlists_write.

Concevez les images en 1920×1080 (paysage) ou 1080×1920 (portrait). Un nouveau média démarre au statut processing pendant la création des versions adaptées au web ; il peut être ajouté immédiatement aux playlists et est lu dès qu'il est prêt. ownerScope : facility (par défaut), brand ou organisation (brand et organisation nécessitent un accès à l'échelle de l'organisation).

Actions :

• upload_media : téléverser une image ou une vidéo. Ajoute une image ou une vidéo depuis une url https publique (recommandé ; images jusqu'à 25 MB, vidéos jusqu'à 200 MB) ou en base64 avec mimeType (jusqu'à 20 MB). Images JPEG, PNG, WebP, GIF ; vidéos MP4, WebM, MOV (converties en MP4 H.264 jusqu'à 1080p). Vidéos plus volumineuses : create_video_upload.
• create_video_upload : démarrer le téléversement d'une vidéo volumineuse. Pour les vidéos jusqu'à 2 GB : enregistre la vidéo et renvoie un téléversement présigné (envoyez le fichier par PUT à upload.url avec upload.headers avant upload.expiresAt), puis appelez transcode avec son contentRef. Nécessite name, mimeType, bytes.
• transcode : traiter une vidéo. Convertit une vidéo pour les écrans : après create_video_upload, de nouveau après un échec, ou pour une vidéo plus ancienne que les écrans ne peuvent pas lire. Nécessite contentRef.
• create_app : ajouter une app. Ajoute une page web (kind url, indiquez url ; l'intégration dans un cadre est vérifiée), une app d'Agent IA (kind agent-app, indiquez agentAppId issu de display_library_read list type agent-apps) ou une vue de vidéosurveillance (kind cctv-view, appartenant à l'installation, nécessite un accès à la vidéosurveillance). Nécessite kind, name.
• update : mettre à jour un élément de la bibliothèque. Modifie le nom, les tags ou la durée d'un média ou d'une app ; les validFrom/validTo d'un média (ISO, null efface ; en dehors de cette période, il est ignoré) ; l'url d'une page web ; ou les caméras, la vue, la disposition ou la qualité d'une vue de vidéosurveillance. Nécessite contentRef.
• delete : supprimer un élément de la bibliothèque. Supprime un média ou une app. Bloqué tant qu'il figure dans une programmation en cours ou une playlist : l'erreur les liste (retirez-les d'abord avec display_schedule_write delete ou display_playlists_write save). Nécessite contentRef. Demande une confirmation.
• refresh_preview : actualiser l'aperçu d'une app. Prend une nouvelle capture d'écran d'une app pour son aperçu dans la bibliothèque (par exemple après une modification de la page). Nécessite contentRef.

Crée, met à jour et supprime les playlists Display Screens : des boucles ordonnées de médias et d'apps. Les modifications atteignent en quelques secondes tous les écrans qui affichent la playlist. Publiez une playlist avec display_publish content.contentRef "playlist#".

Actions :

• save : enregistrer une playlist. Création : name + items (items peut être vide). Mise à jour : playlistId + au choix name, items, transition ; items remplace toute la liste, envoyez donc chaque élément dans l'ordre.
• delete : supprimer une playlist. Supprime une playlist. Bloqué tant qu'elle est publiée quelque part : l'erreur liste les affectations à retirer d'abord (display_schedule_write delete). Nécessite playlistId. Demande une confirmation.

Place du contenu sur Display Screens : un média, une playlist, une app, une page web, une app d'Agent IA ou une vue en direct de vidéosurveillance, sur des écrans, des groupes, l'installation, sa marque ou son organisation.

mode : now (par défaut) remplace ce que les cibles affichent normalement ; scheduled l'affiche uniquement pendant des créneaux hebdomadaires (fuseau horaire de l'installation) et/ou entre from et to ; takeover interrompt tout pendant durationMin (ou jusqu'à une heure donnée), puis se termine de lui-même (arrêt anticipé avec display_takeover_stop). Les écrans déterminent quoi afficher par couche (takeover > scheduled > default), puis selon la précision de la cible (screen > group > facility > brand > organisation).

Vidéosurveillance : les flux de caméras en direct sont visibles par toute personne proche des écrans. Le premier appel renvoie requiresConfirmation (code CCTV_CONFIRMATION_REQUIRED) ; demandez à l'utilisateur, puis appelez de nouveau avec confirmCctv: true. L'option "Allow CCTV on display screens" doit être activée pour l'installation.

Seuls les écrans en mode lecteur affichent le contenu publié ; les autres sont listés dans warnings. Renvoie un batchId ; display_schedule_write delete avec cet ID annule toute la publication. Lorsque plusieurs écrans, groupes ou cibles sont indiqués, l'outil agit sur tous en un seul appel ; vérifiez auprès de l'utilisateur avant d'agir sur un grand nombre.

Lit ce qui est publié sur Display Screens : pour un écran, ce qu'il affiche à un instant donné et sur une période (résolu à travers chaque couche et chaque cible dont il hérite), ainsi que les affectations qui l'atteignent ; ou les affectations publiées sur un groupe, l'installation, sa marque ou son organisation.

Les ID d'affectation (as_…) et de lot (bt_…) sont ceux que display_schedule_write met à jour ou supprime. Les heures sont au format ISO ; les créneaux sont dans le fuseau horaire de l'installation.

Actions :

• get : obtenir la programmation d'un écran. Ce qu'un écran affiche à at (maintenant par défaut), sa chronologie de from à to (24 heures par défaut) et chaque affectation qui l'atteint. Nécessite screenId.
• list_assignments : lister les affectations. Les affectations publiées sur un groupe (groupId), ou sur l'installation, sa marque ou son organisation (target, facility par défaut). Paginé, modification la plus récente en premier.

Modifie ce qui est publié sur Display Screens : changer les horaires, la priorité ou le contenu d'une affectation (éventuellement sur toute sa publication), ou retirer une affectation ou une publication entière. Trouvez les ID avec display_schedule_read. Retirer un contenu de la programmation le laisse dans la bibliothèque ; pour terminer un Takeover plus tôt tout en conservant son historique, utilisez display_takeover_stop.

Actions :

• update : mettre à jour une affectation. Modifie les horaires (créneaux hebdomadaires, from/to ; null efface une date), la priorité ou le contenu d'une affectation. applyToBatch applique la même modification à toutes les cibles de la publication. Seule l'heure de fin d'un Takeover peut être modifiée. Un contenu de vidéosurveillance nécessite confirmCctv une fois l'accord de l'utilisateur obtenu. Nécessite assignmentId.
• delete : retirer de la programmation. Retire une affectation (assignmentId) ou tout le contenu d'une publication (batchId). Les écrans reviennent en quelques secondes à ce qu'ils afficheraient sinon. Demande une confirmation.

Envoie une commande en direct aux Display Screens d'une installation : reload (les écrans lecteurs récupèrent de nouveau leur programmation), identify (fait clignoter le nom et le code de l'écran, pour le repérer sur place), displayOn/displayOff (la dalle du téléviseur), rebootDevice (redémarre l'ordinateur de l'écran, 1 à 2 minutes d'écran vide ; nécessite confirm: true) ou osd (un court message à l'écran ; indiquez message).

Choisissez les écrans avec screenIds et/ou groupIds (tous les écrans de ces groupes dans l'installation), ou allScreens: true pour tous les écrans de l'installation (displayOn/displayOff atteignent alors aussi les écrans de Templated content). Renvoie les résultats par écran. Lorsque plusieurs écrans, groupes ou cibles sont indiqués, l'outil agit sur tous en un seul appel ; vérifiez auprès de l'utilisateur avant d'agir sur un grand nombre.

Lit les Display Screens d'une installation : les lister avec leur statut et ce qui est affiché maintenant et ensuite (filtre par groupe, statut ou mode d'affichage), obtenir le détail complet et la chronologie d'un écran, ou lister les groupes d'écrans avec leurs écrans.

Le mode d'affichage est présenté aux utilisateurs sous le nom "Data Source" : player correspond à "User managed content", program-builder à "Templated content" (ne dites jamais "Program Builder" aux utilisateurs), url à "Full-page website (Kiosk Mode)". Les heures sont au format ISO ; le fuseau horaire de l'installation est renvoyé.

Actions :

• list : lister les écrans. Les écrans de l'installation (paginés), chacun avec son statut, son dernier signal de vie, ses groupes, ses tags et ce qui est affiché maintenant et ensuite. Renvoie aussi les groupes.
• get : obtenir un écran. Le détail complet d'un écran (statut, signal de vie, version du lecteur, erreurs récentes) et, pour les écrans lecteurs, ce qu'il affiche sur une période (par défaut les 24 prochaines heures, 14 jours max.). Nécessite screenId.
• groups : lister les groupes d'écrans. Les groupes d'écrans de l'installation (paginés), chacun avec ses écrans.

Modifie les Display Screens : associer un nouvel écran grâce à son code d'association ; renommer un écran, définir ses groupes et ses tags ou changer son mode d'affichage (présenté aux utilisateurs sous le nom "Data Source") ; renouveler le jeton d'un écran lecteur ; créer un lien d'aperçu à durée limitée d'un écran ou d'un contenu ; ou réinitialiser un écran aux paramètres d'usine (il est retiré de l'installation).

Modes d'affichage : player ("User managed content"), url ("Full-page website (Kiosk Mode)", indiquez url, https uniquement), program-builder ("Templated content" ; ne dites jamais "Program Builder" aux utilisateurs). Changer de mode recharge immédiatement l'écran et modifie ce que voient les membres ; l'utilisateur doit donc confirmer.

Actions :

• update : mettre à jour un écran. Définit le nom d'un écran, ses groupes (ID ou noms ; remplacent les groupes actuels), ses tags (les remplacent) et/ou son mode d'affichage. Un changement de mode renvoie d'abord requiresConfirmation. Nécessite screenId. Peut demander une confirmation.
• rotate_token : renouveler le jeton de l'écran. Émet un nouveau jeton pour un écran lecteur et le recharge ; l'ancien jeton cesse de fonctionner. À utiliser lorsque l'URL du lecteur d'un écran a pu fuiter. Nécessite screenId. Demande une confirmation.
• create_preview_link : créer un lien d'aperçu. Un lien (valable pour une durée limitée) qui montre ce qu'affiche un écran, ou le rendu d'un contenu, éventuellement à une date future. Toute personne disposant du lien peut le consulter jusqu'à son expiration.
• reset : réinitialiser un écran aux paramètres d'usine. Retire l'écran de l'installation et le réinitialise ; un écran éteint est réinitialisé à sa prochaine connexion, puis affiche sa page d'association. Indiquez confirmName : le nom de l'écran exactement tel que l'utilisateur l'a saisi. Nécessite Gestion d'appareils. Nécessite screenId, confirmName. Demande une confirmation.
• pair : associer un nouvel écran. Ajoute un nouvel écran à l'installation grâce au code à 6 caractères affiché sur sa page d'association, puis le recharge. Dans les installations qui n'ont que Display Screens, il démarre sur player ; si elles ont aussi le Templated content, mode choisit (program-builder par défaut). Nécessite Gestion d'appareils. Nécessite pairingCode, name. Demande une confirmation.

Capture ce qu'affiche un Display Screen à cet instant et renvoie l'image, pour que vous puissiez vérifier votre travail après la publication (mise en page, taille du texte, rien de coupé ni de défilant). Attend jusqu'à 15 secondes la réponse de l'écran ; les écrans hors ligne expirent. Renvoie aussi une URL de portail pour le JPEG (utilisateurs connectés uniquement, conservée 10 minutes).

Les captures d'écran peuvent contenir de la vidéosurveillance en direct et des membres visibles ; ne les partagez pas en dehors de la conversation.

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.

Modifie les paramètres Display Screens d'une installation : le Fallback Slate, l'interrogation périodique et le rechargement nocturne, et "Allow CCTV on display screens" ; la programmation d'alimentation des écrans ; et les automatisations (luminosité, volume de la sonnerie, allumage à l'enregistrement). Les champs omis conservent leur valeur actuelle. Les paramètres à l'échelle de la marque (écran de démarrage, Templated content) se trouvent dans display_brand_settings_write.

Actions :

• save_settings : enregistrer les paramètres d'affichage de l'installation. Le Fallback Slate affiché lorsque rien n'est programmé, l'intervalle d'interrogation (30–300 s), l'heure du rechargement nocturne (HH:mm) et allowCctv. Activer allowCctv nécessite la confirmation de l'utilisateur et un administrateur de l'installation disposant d'un accès à la vidéosurveillance. Peut demander une confirmation.
• save_power_schedule : enregistrer la programmation d'alimentation. Modifie les heures d'allumage et d'extinction des écrans ; les champs transmis sont fusionnés dans la programmation enregistrée. Renvoie les heures d'allumage et d'extinction des 7 prochains jours. Vérifiez d'abord avec display_settings_read power_schedule_preview. Nécessite schedule.
• save_automations : enregistrer les automatisations d'affichage. Modifie les paramètres de luminosité automatique, de volume de la sonnerie et d'allumage à l'enregistrement. L'installation conserve alors ses propres paramètres au lieu des valeurs par défaut globales.

Termine immédiatement les Takeovers Display Screens en cours : pour une publication (batchId issu de display_publish), pour des cibles (par défaut : les Takeovers publiés sur toute l'installation), ou avec allScreens pour tous les Takeovers publiés sur l'installation, ses écrans ou leurs groupes. Les Takeovers de marque et d'organisation ne s'arrêtent que par batchId. Les écrans reviennent en quelques secondes à leur contenu programmé ou par défaut ; renvoie le nombre de Takeovers arrêtés. Lorsque plusieurs écrans, groupes ou cibles sont indiqués, l'outil agit sur tous en un seul appel ; vérifiez auprès de l'utilisateur avant d'agir sur un grand nombre.

Pilote les écrans de Templated content (mode d'affichage "Templated content" dans display_screens_read) : y charger le programme d'entraînement d'un jour, ou contrôler le minuteur de rounds. Les écrans User managed content et site web pleine page ne sont jamais concernés.

Actions :

• load_program : charger un programme d'entraînement. Charge le programme d'entraînement d'une date (YYYY-MM-DD, aujourd'hui par défaut) depuis la source de données de l'installation sur tous les écrans de Templated content d'une ou de plusieurs installations ; les écrans se rechargent en quelques secondes. À utiliser pour afficher la séance du jour ou d'un autre jour, ou lorsque les écrans affichent la mauvaise. Plusieurs installations nécessitent confirm. Peut demander une confirmation.
• clock : contrôler le minuteur de rounds. Lance, met en pause, redémarre ou arrête le minuteur de rounds sur les écrans de Templated content, coupe ou rétablit les sons des rounds, règle le volume de la sonnerie (setvolume avec volume 0–100) ou demande son état. Nécessite le Templated content dans l'installation. Nécessite command.