Schermi di visualizzazione

Piattaforma principale
display_brand_settings_writeSchermi di visualizzazione

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.

Parametri

NomeTipoDescrizione
action*"save_boot_screen" | "reset_boot_screen" | "save_screen_defaults" | "save_templated"Cosa fare; ogni azione è descritta nella descrizione dello strumento.
imageUrlstringURL https pubblico dell'immagine (save_boot_screen)
imageBase64stringL'immagine in base64, quando non c'è un URL (save_boot_screen)
fit"logo" | "fill"(save_boot_screen)
backgroundstringColore di sfondo (#RRGGBB) (save_boot_screen)
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa.
orientation"normal" | "left" | "right" | "inverted"Screen rotation (save_screen_defaults)
airplayEnabledbooleanScreens accept AirPlay (save_screen_defaults)
sessionTimerEnabledbooleanSynchronised session timer (master clock) and its bells (save_screen_defaults)
sonosEnabledbooleanSonos speaker control (save_screen_defaults)
duressEnabledbooleanBluetooth duress button monitoring (save_screen_defaults)
cameraRestreamingEnabledbooleanRestream local camera feeds from the screen (save_screen_defaults)
wifiSupportbooleanCaptive Wi-Fi setup portal (save_screen_defaults)
showSourceNameboolean(save_templated)
showWorkoutNamesboolean(save_templated)
showProgramsInScheduleboolean(save_templated)
programLookaheadDaysintegernullGiorni di anticipo (0–90), oppure null per nessun limite (save_templated)
showTrainingPhasesboolean(save_templated)
phaseLookaheadDaysintegernullGiorni di anticipo (0–90), oppure null per nessun limite (save_templated)
showTrainingCampsboolean(save_templated)
campLookaheadDaysintegernullGiorni di anticipo (0–90), oppure null per nessun limite (save_templated)
confirmbooleanImpostalo solo dopo che l'utente ha confermato l'anteprima restituita dalla prima chiamata
display_groups_writeSchermi di visualizzazione

Crea, rinomina ed elimina i gruppi di schermi Display Screens in una struttura e stabilisce quali schermi ne fanno parte. I gruppi sono destinazioni di pubblicazione (display_publish targets.groupIds) e di comando (display_screen_command groupIds). Quando vengono indicati più schermi, gruppi o destinazioni, agisce su tutti in un'unica chiamata; verifica con l'utente prima di agire su molti.

Azioni:

  • save: salva un gruppo. Creazione: name (e facoltativamente screenIds). Ridenominazione: groupId (ID o nome attuale) e name. screenIds sostituisce i membri; gli schermi non elencati escono da questo gruppo ma restano negli altri.
  • delete: elimina un gruppo. Elimina un gruppo: i suoi schermi ne escono (restano negli altri gruppi) e i contenuti pubblicati sul gruppo vengono rimossi dalla programmazione. Richiede groupId. Chiede conferma.

Parametri

NomeTipoDescrizione
action*"save" | "delete"Cosa fare; ogni azione è descritta nella descrizione dello strumento.
groupIdstringID o nome di un gruppo esistente, per rinominarlo o cambiarne i membri
namestringNome del gruppo (obbligatorio in creazione) (save)
screenIdsarraySchermi del gruppo; sostituisce i membri attuali (save)
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa.
confirmbooleanImpostalo solo dopo che l'utente ha confermato l'anteprima restituita dalla prima chiamata
display_hosted_apps_writeSchermi di visualizzazione

Pubblica app HTML statiche ("app ospitate") per Display Screens. Chiama prima display_library_read app_guidelines per dimensioni degli schermi, regole di design, limiti e SDK, e poi display_screenshot per controllare il risultato su uno schermo. Quando vengono indicati più schermi, gruppi o destinazioni, agisce su tutti in un'unica chiamata; verifica con l'utente prima di agire su molti.

Azioni:

  • publish: pubblica un'app ospitata. Crea un'app ospitata (name + files) o pubblica una nuova versione (appId + files; diventa attiva ovunque l'app venga mostrata, rollback la annulla). publishTo la mette anche sugli schermi, come fa display_publish; una destinazione brand o organizzazione richiede confirm. Richiede files. Può chiedere conferma.
  • rollback: ripristina una versione precedente di un'app ospitata. Rende di nuovo attuale una versione precedente, ovunque l'app venga mostrata. Elenca le versioni con display_library_read app_versions. Richiede appId, version.

Parametri

NomeTipoDescrizione
action*"publish" | "rollback"Cosa fare; ogni azione è descritta nella descrizione dello strumento.
appIdstringID di un'app ospitata esistente (app_…) di cui pubblicare una nuova versione
namestringNome dell'app (obbligatorio in creazione) (publish)
filesarrayI file dell'app. encoding è utf8 (predefinito) o base64 per i file binari. (publish)
entrystringFile HTML di ingresso (predefinito index.html) (publish)
durationSecnumberDurata predefinita sullo schermo nelle playlist, in secondi (publish)
tagsarray(publish)
ownerScope"facility" | "brand" | "organisation"A chi appartengono i nuovi contenuti (predefinito facility). brand e organisation richiedono l'accesso a livello di organizzazione. (publish)
publishToobject(publish)
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa.
versionintegerVersione da rendere attuale (rollback)
confirmbooleanImpostalo solo dopo che l'utente ha confermato l'anteprima restituita dalla prima chiamata
display_library_readSchermi di visualizzazione

Legge la libreria dei contenuti di Display Screens visibile a una struttura: media (immagini, video), app (pagine web, app HTML ospitate, app di Agente AI, viste TVCC) e playlist, oltre alle app di Agente AI e alle sorgenti TVCC che si possono aggiungere.

Ogni elemento ha un contentRef (media#…, app#…, playlist#…) per display_publish e le playlist. ownerScope indica a chi appartiene (facility#, brand# o org#); un contenuto può essere pubblicato solo all'interno del suo proprietario. I media con stato processing non sono ancora pronti; quelli failed vanno caricati di nuovo. Le pagine web con frameable: false non possono essere riprodotte nelle playlist, solo come schermata a pagina intera. Gli elementi con un displayIssue vengono saltati dagli schermi: un'app di Agente AI non pubblicata, in pausa, display-off, con pubblico limitato o senza Custom Apps; una vista TVCC con no-cctv, cctv-off (un amministratore della struttura attiva la TVCC sugli schermi nelle impostazioni di Display Screens) o no-cameras.

Azioni:

  • list: elenca gli elementi della libreria. Media e app (paginati; filtra per type, kind, tag o nome), oppure con type agent-apps le app di Agente AI consentite sugli schermi che puoi pubblicare con display_publish content.agentAppId. Ogni elemento ha un type: media, app o agent-app.
  • cctv_sources: elenca le sorgenti TVCC. Le telecamere della struttura e le viste dal vivo condivise per display_publish content.cctv, e se la TVCC sugli schermi è attiva. Richiede l'accesso TVCC nella struttura.
  • get: recupera un elemento della libreria. Un media, un'app o una playlist tramite contentRef. Richiede contentRef.
  • usages: dove viene usato un contenuto. Le assegnazioni attive della programmazione e le playlist che usano un media o un'app (o le assegnazioni di una playlist). I contenuti in uso non possono essere eliminati. Richiede contentRef.
  • app_versions: elenca le versioni di un'app ospitata. Le versioni di un'app ospitata e quella attuale, per display_hosted_apps_write rollback. Richiede appId.
  • app_guidelines: linee guida per le app ospitate. Dimensioni degli schermi, regole di design, limiti del bundle, il Display App SDK e un modello di partenza. Chiamalo prima di creare un'app per display_hosted_apps_write publish.
  • check_url: controlla una pagina web. Se una pagina web può essere mostrata all'interno delle playlist (alcuni siti rifiutano di essere incorporati in un frame), con indicazioni sul suo aspetto. Le pagine che rifiutano il frame possono comunque essere una schermata a pagina intera. Richiede url.
  • playlists: elenca le playlist. Le playlist visibili alla struttura (paginate), ciascuna con i suoi elementi (contentRef, durata, fit).

Parametri

NomeTipoDescrizione
action*"list" | "cctv_sources" | "get" | "usages" | "app_versions" | "app_guidelines" | "check_url" | "playlists"Cosa fare; ogni azione è descritta nella descrizione dello strumento.
type"media" | "apps" | "agent-apps"Solo un tipo di elemento (predefinito: media e app) (list)
kind"image" | "video" | "url" | "hosted" | "agent-app" | "cctv-view"(list)
tagstringSolo gli elementi con questo tag (list)
searchstringFiltro per nome, senza distinzione tra maiuscole e minuscole (list)
limitintegerElementi per pagina (predefinito 25, massimo 100) (list, playlists)
cursorstringnextCursor della pagina precedente (list, playlists)
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa. (list, cctv_sources, get, usages, app_versions, check_url, playlists)
contentRefstringmedia#<id>, app#<id> o playlist#<id>, da display_library_read list o playlists (get, usages)
appIdstringID dell'app ospitata (app_…) (app_versions)
urlstringURL https pubblico (check_url)
display_library_writeSchermi di visualizzazione

Aggiunge e modifica i contenuti della libreria di Display Screens: carica immagini e video, crea app di pagina web, di Agente AI e di vista TVCC, modifica nomi, tag, durate e date, elimina gli elementi inutilizzati e aggiorna l'anteprima di un'app. Le app HTML ospitate si pubblicano con display_hosted_apps_write; le playlist con display_playlists_write.

Progetta le immagini a 1920×1080 (orizzontale) o 1080×1920 (verticale). I nuovi media partono con stato processing mentre vengono create le versioni per il web; possono essere inseriti subito nelle playlist e vengono riprodotti quando sono pronti. ownerScope: facility (predefinito), brand o organisation (brand e organisation richiedono l'accesso a livello di organizzazione).

Azioni:

  • upload_media: carica un'immagine o un video. Aggiunge un'immagine o un video da un url https pubblico (preferibile; immagini fino a 25 MB, video fino a 200 MB) o in base64 con mimeType (fino a 20 MB). Immagini JPEG, PNG, WebP, GIF; video MP4, WebM, MOV (convertiti in MP4 H.264 fino a 1080p). Video più grandi: create_video_upload.
  • create_video_upload: avvia il caricamento di un video di grandi dimensioni. Per video fino a 2 GB: registra il video e restituisce un caricamento prefirmato (invia il file con PUT a upload.url con upload.headers prima di upload.expiresAt), poi chiama transcode con il relativo contentRef. Richiede name, mimeType, bytes.
  • transcode: elabora un video. Converte un video per gli schermi: dopo create_video_upload, di nuovo dopo un errore, o per un video meno recente che gli schermi non riescono a riprodurre. Richiede contentRef.
  • create_app: aggiunge un'app. Aggiunge una pagina web (kind url, passa url; viene verificato l'inserimento in frame), un'app di Agente AI (kind agent-app, passa agentAppId da display_library_read list type agent-apps) o una vista TVCC (kind cctv-view, di proprietà della struttura, richiede l'accesso TVCC). Richiede kind, name.
  • update: aggiorna un elemento della libreria. Modifica nome, tag o durata di un media o di un'app; validFrom/validTo di un media (ISO, null li cancella; al di fuori di queste date viene saltato); l'url di una pagina web; oppure telecamere, vista, layout o qualità di una vista TVCC. Richiede contentRef.
  • delete: elimina un elemento della libreria. Elimina un media o un'app. Bloccato finché è in una programmazione attiva o in una playlist: l'errore le elenca (rimuovile prima con display_schedule_write delete o display_playlists_write save). Richiede contentRef. Chiede conferma.
  • refresh_preview: aggiorna l'anteprima di un'app. Acquisisce un nuovo screenshot di un'app per l'anteprima nella libreria (ad esempio dopo una modifica della pagina). Richiede contentRef.

Parametri

NomeTipoDescrizione
action*"upload_media" | "create_video_upload" | "transcode" | "create_app" | "update" | "delete" | "refresh_preview"Cosa fare; ogni azione è descritta nella descrizione dello strumento.
urlstringURL https pubblico dell'immagine o del video (preferibile) (upload_media, create_app, update)
base64stringContenuto del file in base64 (massimo 20 MB), quando non c'è un URL (upload_media)
mimeTypestringObbligatorio con base64, ad esempio image/png (upload_media, create_video_upload)
namestringNome nella libreria (upload_media, create_video_upload, create_app, update)
tagsarrayTag (sostituiscono i tag attuali) (upload_media, create_video_upload, create_app, update)
ownerScope"facility" | "brand" | "organisation"A chi appartengono i nuovi contenuti (predefinito facility). brand e organisation richiedono l'accesso a livello di organizzazione. (upload_media, create_video_upload, create_app)
durationSecnumberDurata predefinita sullo schermo per le immagini, in secondi (upload_media, create_app, update)
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa.
bytesintegerDimensione del file in byte (create_video_upload)
resolution"720" | "1080" | "1440" | "2160" | "original"Dimensione massima a cui il video viene convertito per gli schermi (predefinito 1080; original mantiene la dimensione originale) (create_video_upload, transcode)
contentRefstringmedia#<id>, app#<id> o playlist#<id>, da display_library_read list o playlists (transcode, update, delete, refresh_preview)
kind"url" | "agent-app" | "cctv-view"(create_app)
agentAppIdstringApp di Agente AI: l'ID dell'app (create_app)
source"view" | "cameras"Viste TVCC: view (passa viewId) o cameras (passa cameras) (create_app, update)
viewIdstringViste TVCC: ID della vista dal vivo (display_library_read cctv_sources) (create_app, update)
camerasarrayViste TVCC: ID delle telecamere (display_library_read cctv_sources) (create_app, update)
layout"auto" | "1x1" | "2x1" | "1+2" | "2x2" | "1+5" | "2x3" | "3x3"Viste TVCC: disposizione dei riquadri (create_app, update)
quality"auto" | "native" | "1080p" | "720p" | "480p" | "360p" | "240p"Viste TVCC: qualità dello stream (create_app, update)
showNamesbooleanViste TVCC: mostra i nomi delle telecamere sui riquadri (create_app, update)
validFromstringnullMedia: data e ora ISO di inizio della riproduzione; null la cancella (update)
validTostringnullMedia: data e ora ISO di fine della riproduzione; null la cancella (update)
confirmbooleanImpostalo solo dopo che l'utente ha confermato l'anteprima restituita dalla prima chiamata
display_playlists_writeSchermi di visualizzazione

Crea, aggiorna ed elimina le playlist di Display Screens: sequenze ordinate e ripetute di media e app. Le modifiche raggiungono in pochi secondi ogni schermo che mostra la playlist. Pubblica una playlist con display_publish content.contentRef "playlist#".

Azioni:

  • save: salva una playlist. Creazione: name + items (items può essere vuoto). Aggiornamento: playlistId + uno qualsiasi tra name, items, transition; items sostituisce l'intero elenco, quindi invia tutti gli elementi in ordine.
  • delete: elimina una playlist. Elimina una playlist. Bloccato finché è pubblicata da qualche parte: l'errore elenca le assegnazioni da rimuovere prima (display_schedule_write delete). Richiede playlistId. Chiede conferma.

Parametri

NomeTipoDescrizione
action*"save" | "delete"Cosa fare; ogni azione è descritta nella descrizione dello strumento.
playlistIdstringID di una playlist esistente (pl_…) da aggiornare
namestringNome della playlist (obbligatorio in creazione) (save)
transition"fade" | "none"(save)
ownerScope"facility" | "brand" | "organisation"A chi appartengono i nuovi contenuti (predefinito facility). brand e organisation richiedono l'accesso a livello di organizzazione. (save)
itemsarrayL'intero elenco, in ordine (sostituisce gli elementi attuali; mantieni itemId per conservare un elemento). Le pagine web con frameable: false non verranno riprodotte. (save)
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa.
confirmbooleanImpostalo solo dopo che l'utente ha confermato l'anteprima restituita dalla prima chiamata
display_publishSchermi di visualizzazione

Mette contenuti su Display Screens: un media, una playlist, un'app, una pagina web, un'app di Agente AI o una vista dal vivo TVCC, su schermi, gruppi, la struttura, il suo brand o la sua organizzazione.

mode: now (predefinito) sostituisce ciò che le destinazioni mostrano normalmente; scheduled lo mostra solo in finestre settimanali (fuso orario della struttura) e/o tra from e to; takeover interrompe tutto per durationMin (o fino a un orario), poi termina da solo (interrompilo prima con display_takeover_stop). Gli schermi decidono cosa mostrare in base al livello (takeover > scheduled > default), poi in base a quanto è specifica la destinazione (screen > group > facility > brand > organisation).

TVCC: i feed live delle telecamere sono visibili a chiunque si trovi vicino agli schermi. La prima chiamata restituisce requiresConfirmation (codice CCTV_CONFIRMATION_REQUIRED); chiedi all'utente, poi chiama di nuovo con confirmCctv: true. La struttura deve avere attiva l'opzione "Allow CCTV on display screens".

Solo gli schermi in modalità player mostrano i contenuti pubblicati; gli altri sono elencati in warnings. Restituisce un batchId; display_schedule_write delete con questo ID annulla l'intera pubblicazione. Quando vengono indicati più schermi, gruppi o destinazioni, agisce su tutti in un'unica chiamata; verifica con l'utente prima di agire su molti.

Parametri

NomeTipoDescrizione
targets*objectDove vanno i contenuti. Puoi combinare queste opzioni. Funzionano sia i nomi dei gruppi sia gli ID. brand e organisation richiedono l'accesso a Display Screens a livello di organizzazione.
content*objectCosa mostrare: esattamente uno tra contentRef, url, agentAppId o cctv.
mode"now" | "default" | "scheduled" | "takeover"`now`/`default` (il valore predefinito): sostituisce ciò che le destinazioni mostrano normalmente. `scheduled`: solo nelle finestre e/o tra from e to. `takeover`: interrompe tutto per durationMin (o fino a un orario), poi termina da solo.
windowsarrayFinestre settimanali nel fuso orario della struttura. days sono giorni della settimana ISO (1 = lunedì … 7 = domenica); start/end sono "HH:MM" (end "24:00" consentito).
fromstringData e ora ISO di inizio di una pubblicazione programmata
tostringData e ora ISO di fine di una pubblicazione programmata
durationMinnumberDurata del takeover in minuti (massimo 7 giorni)
untilstringData e ora ISO di fine di un takeover (al posto di durationMin)
priorityintegerRisolve i conflitti tra elementi programmati sovrapposti (vince il valore più alto)
confirmCctvbooleanImpostalo solo dopo che l'utente ha confermato esplicitamente la visualizzazione della TVCC dal vivo
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa.
confirmbooleanImpostalo solo dopo che l'utente ha confermato l'anteprima restituita dalla prima chiamata
display_schedule_readSchermi di visualizzazione

Legge ciò che è pubblicato su Display Screens: per uno schermo, cosa mostra in un dato momento e in un intervallo (risolto tra tutti i livelli e le destinazioni da cui eredita) più le assegnazioni che lo raggiungono; oppure le assegnazioni pubblicate su un gruppo, sulla struttura, sul suo brand o sulla sua organizzazione.

Gli ID delle assegnazioni (as_…) e dei batch (bt_…) sono ciò che display_schedule_write aggiorna o elimina. Gli orari sono in formato ISO; le finestre sono nel fuso orario della struttura.

Azioni:

  • get: recupera la programmazione di uno schermo. Cosa mostra uno schermo in at (predefinito: ora), la sua timeline da from a to (predefinito 24 ore) e ogni assegnazione che lo raggiunge. Richiede screenId.
  • list_assignments: elenca le assegnazioni. Le assegnazioni pubblicate su un gruppo (groupId), oppure sulla struttura, sul suo brand o sulla sua organizzazione (target, predefinito facility). Paginate, a partire dalla modifica più recente.

Parametri

NomeTipoDescrizione
action*"get" | "list_assignments"Cosa fare; ogni azione è descritta nella descrizione dello strumento.
screenIdstringID dello schermo (il codice di 6 caratteri) da display_screens_read list (get)
atstringData e ora ISO in cui controllare cosa è in onda (predefinito: ora) (get)
fromstringInizio della timeline in formato ISO (predefinito at, altrimenti ora) (get)
tostringFine della timeline in formato ISO (predefinito 24 ore dopo from) (get)
includeExpiredbooleanIncludi le assegnazioni terminate
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa.
groupIdstringID o nome del gruppo di schermi, da display_screens_read groups (list_assignments)
target"facility" | "brand" | "organisation"Quando non è indicato alcun groupId (predefinito facility) (list_assignments)
limitintegerElementi per pagina (predefinito 25, massimo 100) (list_assignments)
cursorstringnextCursor della pagina precedente (list_assignments)
display_schedule_writeSchermi di visualizzazione

Modifica ciò che è pubblicato su Display Screens: cambia orari, priorità o contenuto di un'assegnazione (facoltativamente per l'intera pubblicazione), oppure rimuove un'assegnazione o un'intera pubblicazione. Trova gli ID con display_schedule_read. Rimuovere un contenuto dalla programmazione lo lascia nella libreria; per terminare in anticipo un takeover mantenendone la cronologia, usa display_takeover_stop.

Azioni:

  • update: aggiorna un'assegnazione. Modifica gli orari (finestre settimanali, from/to; null cancella una data), la priorità o il contenuto di un'assegnazione. applyToBatch applica la stessa modifica a ogni destinazione della pubblicazione. A un takeover si può solo assegnare un nuovo orario di fine. I contenuti TVCC richiedono confirmCctv dopo il consenso dell'utente. Richiede assignmentId.
  • delete: rimuovi dalla programmazione. Rimuove un'assegnazione (assignmentId) o tutto ciò che appartiene a una pubblicazione (batchId). In pochi secondi gli schermi tornano a ciò che mostrerebbero altrimenti. Chiede conferma.

Parametri

NomeTipoDescrizione
action*"update" | "delete"Cosa fare; ogni azione è descritta nella descrizione dello strumento.
assignmentIdstringUn'assegnazione (as_…) da display_schedule_read
applyToBatchbooleanApplica la stessa modifica a ogni destinazione della pubblicazione (update)
windowsarrayFinestre settimanali nel fuso orario della struttura. days sono giorni della settimana ISO (1 = lunedì … 7 = domenica); start/end sono "HH:MM" (end "24:00" consentito). (update)
fromstringnullData e ora ISO di inizio; null la cancella (update)
tostringnullData e ora ISO di fine; null la cancella (update)
priorityintegerRisolve i conflitti tra elementi programmati sovrapposti (vince il valore più alto) (update)
contentRefstringmedia#<id>, app#<id> o playlist#<id>, da display_library_read list o playlists (update)
confirmCctvbooleanImpostalo solo dopo che l'utente ha confermato esplicitamente la visualizzazione della TVCC dal vivo (update)
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa.
batchIdstringUn'intera pubblicazione (bt_…) da display_publish o display_schedule_read, su tutte le sue destinazioni (delete)
confirmbooleanImpostalo solo dopo che l'utente ha confermato l'anteprima restituita dalla prima chiamata
display_screen_commandSchermi di visualizzazione

Invia un comando in tempo reale a Display Screens in una struttura: reload (gli schermi player recuperano di nuovo la programmazione), identify (fa lampeggiare nome e codice dello schermo, per trovarlo nella sede), displayOn/displayOff (il pannello TV), rebootDevice (riavvia il computer dello schermo, 1–2 minuti di schermo nero; richiede confirm: true) o osd (un breve messaggio a schermo; passa message).

Scegli gli schermi con screenIds e/o groupIds (tutti gli schermi di quei gruppi nella struttura), oppure allScreens: true per tutti gli schermi della struttura (in questo caso displayOn/displayOff raggiungono anche gli schermi con contenuti basati su modelli). Restituisce i risultati per schermo. Quando vengono indicati più schermi, gruppi o destinazioni, agisce su tutti in un'unica chiamata; verifica con l'utente prima di agire su molti.

Parametri

NomeTipoDescrizione
screenIdsarrayID degli schermi (i codici di 6 caratteri) da display_screens_read list. Omettili quando usi allScreens.
groupIdsarrayID o nomi dei gruppi di schermi: tutti gli schermi di quei gruppi nella struttura
allScreensbooleanTutti gli schermi della struttura, compresi quelli con contenuti basati su modelli
command*"reload" | "identify" | "displayOn" | "displayOff" | "rebootDevice" | "osd"Cosa fare (rebootDevice richiede confirm)
messagestringTesto per osd
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa.
confirmbooleanImpostalo solo dopo che l'utente ha confermato l'anteprima restituita dalla prima chiamata
display_screens_readSchermi di visualizzazione

Legge i Display Screens di una struttura: li elenca con il loro stato e ciò che è in onda ora e dopo (filtra per gruppo, stato o modalità di visualizzazione), recupera il dettaglio completo e la timeline di uno schermo, oppure elenca i gruppi di schermi con i rispettivi schermi.

La modalità di visualizzazione viene mostrata agli utenti come "Data Source": player è "User managed content", program-builder è "Templated content" (con gli utenti non usare mai il vecchio nome del modulo), url è "Full-page website (Kiosk Mode)". Gli orari sono in formato ISO; viene restituito il fuso orario della struttura.

Azioni:

  • list: elenca gli schermi. Gli schermi della struttura (paginati), ciascuno con stato, ultimo heartbeat, gruppi, tag e ciò che è in onda ora e dopo. Restituisce anche i gruppi.
  • get: recupera uno schermo. Il dettaglio completo di uno schermo (stato, heartbeat, versione del player, errori recenti) e, per gli schermi player, ciò che mostra in un intervallo di tempo (predefinito le prossime 24 ore, massimo 14 giorni). Richiede screenId.
  • groups: elenca i gruppi di schermi. I gruppi di schermi della struttura (paginati), ciascuno con i suoi schermi.

Parametri

NomeTipoDescrizione
action*"list" | "get" | "groups"Cosa fare; ogni azione è descritta nella descrizione dello strumento.
groupIdstringSolo gli schermi di questo gruppo (ID o nome) (list)
status"playing" | "provisioning" | "display-off" | "not-responding" | "offline" | "online"(list)
mode"player" | "program-builder" | "url"(list)
limitintegerElementi per pagina (predefinito 25, massimo 100) (list, groups)
cursorstringnextCursor della pagina precedente (list, groups)
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa.
screenIdstringID dello schermo (il codice di 6 caratteri) da display_screens_read list (get)
fromstringInizio della timeline in formato ISO (predefinito: ora) (get)
tostringFine della timeline in formato ISO (predefinito 24 ore dopo from) (get)
display_screens_writeSchermi di visualizzazioneGestione dei dispositivi

Modifica i Display Screens: abbina un nuovo schermo tramite il codice di abbinamento; rinomina uno schermo, imposta gruppi e tag o cambia la modalità di visualizzazione (mostrata agli utenti come "Data Source"); rigenera il token di uno schermo player; crea un link di anteprima a tempo di uno schermo o di un contenuto; oppure ripristina uno schermo alle impostazioni di fabbrica (lo rimuove dalla struttura).

Modalità di visualizzazione: player ("User managed content"), url ("Full-page website (Kiosk Mode)", passa url, solo https), program-builder ("Templated content"; con gli utenti non usare mai il vecchio nome del modulo). Cambiare modalità ricarica subito lo schermo e cambia ciò che vedono i membri, quindi richiede la conferma dell'utente.

Azioni:

  • update: aggiorna uno schermo. Imposta nome, gruppi (ID o nomi; sostituiscono i gruppi attuali), tag (li sostituiscono) e/o modalità di visualizzazione di uno schermo. Un cambio di modalità restituisce prima requiresConfirmation. Richiede screenId. Può chiedere conferma.
  • rotate_token: rigenera il token dello schermo. Emette un nuovo token per uno schermo player e lo ricarica; il vecchio token smette di funzionare. Usalo quando l'URL del player di uno schermo potrebbe essere stato divulgato. Richiede screenId. Chiede conferma.
  • create_preview_link: crea un link di anteprima. Un link (valido per un tempo limitato) che mostra ciò che mostra uno schermo, o l'aspetto di un contenuto, facoltativamente in un momento futuro. Chiunque abbia il link può visualizzarlo fino alla scadenza.
  • reset: ripristina uno schermo alle impostazioni di fabbrica. Rimuove lo schermo dalla struttura e lo ripristina alle impostazioni di fabbrica; uno schermo spento si ripristina quando torna online, poi mostra la pagina di abbinamento. Passa confirmName: il nome dello schermo esattamente come l'ha digitato l'utente. Richiede Gestione dei dispositivi. Richiede screenId, confirmName. Chiede conferma.
  • pair: abbina un nuovo schermo. Aggiunge un nuovo schermo alla struttura tramite il codice di 6 caratteri mostrato nella pagina di abbinamento, poi lo ricarica. Nelle strutture che hanno solo Display Screens parte in player; se hanno anche i contenuti basati su modelli, lo sceglie mode (predefinito program-builder). Richiede Gestione dei dispositivi. Richiede pairingCode, name. Chiede conferma.

Parametri

NomeTipoDescrizione
action*"update" | "rotate_token" | "create_preview_link" | "reset" | "pair"Cosa fare; ogni azione è descritta nella descrizione dello strumento.
screenIdstringID dello schermo (il codice di 6 caratteri) da display_screens_read list (update, rotate_token, create_preview_link, reset)
namestringNome dello schermo (update, pair)
groupIdsarrayID o nomi dei gruppi; sostituiscono i gruppi attuali (crea i gruppi con display_groups_write save) (update)
tagsarraySostituisce i tag attuali (update)
mode"player" | "program-builder" | "url"Modalità di visualizzazione ("Data Source") (update, pair)
urlstringSito web per la modalità url (https) (update)
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa.
contentRefstringmedia#<id>, app#<id> o playlist#<id>, da display_library_read list o playlists (create_preview_link)
orientation"landscape" | "portrait"Per le anteprime di contentRef (predefinito landscape) (create_preview_link)
atstringData e ora ISO dell'anteprima (predefinito: ora) (create_preview_link)
confirmNamestringIl nome dello schermo, digitato dall'utente per confermare (deve corrispondere esattamente) (reset)
pairingCodestringIl codice che lo schermo mostra nella pagina di abbinamento (0 e O si somigliano) (pair)
contentStreamstringContenuti basati su modelli: lo stream (round) riprodotto, predefinito 1 (pair)
confirmbooleanImpostalo solo dopo che l'utente ha confermato l'anteprima restituita dalla prima chiamata
display_screenshotSchermi di visualizzazione

Acquisisce ciò che uno schermo Display Screens mostra in questo momento e restituisce l'immagine, così puoi controllare il tuo lavoro dopo la pubblicazione (layout, dimensione del testo, niente tagliato o che scorre). Attende fino a 15 secondi la risposta dello schermo; per gli schermi offline la richiesta scade. Restituisce anche un URL del portale per il JPEG (solo per gli utenti che hanno effettuato l'accesso, conservato per 10 minuti).

Gli screenshot possono includere la TVCC dal vivo e i membri inquadrati; non condividerli al di fuori della conversazione.

Parametri

NomeTipoDescrizione
screenId*stringID dello schermo (il codice di 6 caratteri) da display_screens_read list
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa.
display_settings_readSchermi di visualizzazione

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.

Parametri

NomeTipoDescrizione
action*"settings" | "power_schedule" | "power_schedule_preview" | "automations" | "boot_screen" | "screen_defaults" | "templated" | "program_dates" | "templated_schedule"Cosa fare; ogni azione è descritta nella descrizione dello strumento.
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa.
scheduleobjectGli schermi sono accesi durante gli orari con personale (ampliati dagli scostamenti) o nelle finestre settimanali personalizzate, con una regola per le festività. (power_schedule_preview)
facilityIdsarrayPiù ID di struttura, per eseguire la stessa richiesta in ciascuna. Da usare al posto di facilityId. (automations)
fromstringPrima data (YYYY-MM-DD) (templated_schedule)
tostringUltima data (YYYY-MM-DD) (templated_schedule)
display_settings_writeSchermi di visualizzazione

Modifica le impostazioni di Display Screens di una struttura: la Fallback Slate, il polling e il ricaricamento notturno e "Allow CCTV on display screens"; la programmazione di accensione degli schermi; e le automazioni (luminosità, volume della campanella, accensione al check-in). I campi che ometti mantengono i valori attuali. Le impostazioni a livello di brand (schermata di avvio, contenuti basati su modelli) si trovano in display_brand_settings_write.

Azioni:

  • save_settings: salva le impostazioni di visualizzazione della struttura. La Fallback Slate mostrata quando non c'è nulla in programmazione, l'intervallo di polling (30–300 s), l'orario del ricaricamento notturno (HH:mm) e allowCctv. Attivare allowCctv richiede la conferma dell'utente e un amministratore della struttura con accesso TVCC. Può chiedere conferma.
  • save_power_schedule: salva la programmazione di accensione. Modifica quando gli schermi si accendono e si spengono; i campi che passi vengono uniti alla programmazione salvata. Restituisce gli orari di accensione e spegnimento dei prossimi 7 giorni. Controlla prima con display_settings_read power_schedule_preview. Richiede schedule.
  • save_automations: salva le automazioni di visualizzazione. Modifica le impostazioni di luminosità automatica, volume della campanella e accensione al check-in. La struttura mantiene quindi le proprie impostazioni al posto di quelle predefinite globali.

Parametri

NomeTipoDescrizione
action*"save_settings" | "save_power_schedule" | "save_automations"Cosa fare; ogni azione è descritta nella descrizione dello strumento.
slateobject(save_settings)
pollIntervalSecinteger(save_settings)
nightlyReloadTimestringHH:mm (save_settings)
allowCctvbooleanConsenti la TVCC sugli schermi (save_settings)
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa.
scheduleobjectGli schermi sono accesi durante gli orari con personale (ampliati dagli scostamenti) o nelle finestre settimanali personalizzate, con una regola per le festività. (save_power_schedule)
autoPowerDisplaysbooleanAttivazione/disattivazione della precedente automazione di accensione (sostituita dalla programmazione di accensione) (save_automations)
minsBeforeOpenDisplayOnintegerPrecedente automazione di accensione: minuti prima dell'apertura (save_automations)
minsAfterCloseDisplayOffintegerPrecedente automazione di accensione: minuti dopo la chiusura (save_automations)
displaysOnCheckInbooleanAccendi gli schermi quando qualcuno effettua il check-in (save_automations)
minsLastCheckInDisplayOffintegerCon displaysOnCheckIn: minuti dopo l'ultimo check-in trascorsi i quali gli schermi si spengono (save_automations)
enableAutoBrightnessbooleanPassa dalla luminosità diurna a quella notturna (save_automations)
dayTriggerType"auto" | "staffed" | "custom"Quando inizia la luminosità diurna (save_automations)
dayTimeStartstringPer dayTriggerType custom: HH:mm (ora della struttura) (save_automations)
dayOffsetMinutesintegerMinuti dopo l'alba o l'apertura (save_automations)
dayBrightnessLevelintegerLuminosità diurna, % (save_automations)
nightTriggerType"auto" | "staffed" | "custom"Quando inizia la luminosità notturna (save_automations)
nightTimeStartstringPer nightTriggerType custom: HH:mm (ora della struttura) (save_automations)
nightOffsetMinutesintegerMinuti dopo il tramonto o prima della chiusura (save_automations)
nightBrightnessLevelintegerLuminosità notturna, % (save_automations)
bellMasterLevelintegerVolume generale della campanella, % (save_automations)
bellClubHoursLevelintegerVolume della campanella negli orari con personale, % (save_automations)
bellExtendedHoursLevelintegerVolume della campanella negli orari estesi, % (save_automations)
enableBellAutoVolumebooleanSegui la programmazione del volume della campanella (save_automations)
bellVolumeScheduleobjectFasce settimanali del volume della campanella per giorno della settimana (mon … sun); sostituisce l'intera programmazione (save_automations)
confirmbooleanImpostalo solo dopo che l'utente ha confermato l'anteprima restituita dalla prima chiamata
display_takeover_stopSchermi di visualizzazione

Termina subito i takeover di Display Screens in corso: per una pubblicazione (batchId da display_publish), per destinazioni (predefinito: i takeover pubblicati sull'intera struttura), oppure con allScreens per ogni takeover pubblicato sulla struttura, sui suoi schermi o sui loro gruppi. I takeover di brand e organizzazione si interrompono solo tramite batchId. In pochi secondi gli schermi tornano ai contenuti programmati o predefiniti; restituisce quanti takeover sono stati interrotti. Quando vengono indicati più schermi, gruppi o destinazioni, agisce su tutti in un'unica chiamata; verifica con l'utente prima di agire su molti.

Parametri

NomeTipoDescrizione
batchIdstringLa pubblicazione del takeover (bt_…) da display_publish
targetsobjectDove vanno i contenuti. Puoi combinare queste opzioni. Funzionano sia i nomi dei gruppi sia gli ID. brand e organisation richiedono l'accesso a Display Screens a livello di organizzazione.
allScreensbooleanOgni takeover pubblicato sulla struttura, sui suoi schermi o sui loro gruppi
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa.
display_templated_writeSchermi di visualizzazione

Controlla gli schermi con contenuti basati su modelli (modalità di visualizzazione "Templated content" in display_screens_read): carica su di essi il programma di allenamento di un giorno o controlla il timer dei round. Gli schermi con User managed content e con sito web a pagina intera non vengono mai interessati.

Azioni:

  • load_program: carica un programma di allenamento. Carica il programma di allenamento di una data (YYYY-MM-DD, predefinito oggi) dall'origine dati della struttura su ogni schermo con contenuti basati su modelli in una o più strutture; gli schermi si ricaricano in pochi secondi. Usalo per mostrare l'allenamento di oggi o di un altro giorno, o quando gli schermi mostrano quello sbagliato. Più strutture richiedono confirm. Può chiedere conferma.
  • clock: controlla il timer dei round. Avvia, mette in pausa, riavvia o ferma il timer dei round sugli schermi con contenuti basati su modelli, disattiva o riattiva i suoni dei round, imposta il volume della campanella (setvolume con volume 0–100) o ne chiede lo stato. Richiede i contenuti basati su modelli nella struttura. Richiede command.

Parametri

NomeTipoDescrizione
action*"load_program" | "clock"Cosa fare; ogni azione è descritta nella descrizione dello strumento.
facilityIdsarrayPiù ID di struttura, per eseguire la stessa richiesta in ciascuna. Da usare al posto di facilityId. (load_program)
datestringData dell'allenamento, YYYY-MM-DD (predefinito oggi) (load_program)
facilityIdstringID della struttura. Facoltativo quando intendi la struttura connessa.
command"getstate" | "play" | "pause" | "restart" | "stop" | "mute" | "unmute" | "setvolume"(clock)
volumeintegerPer setvolume: volume della campanella, % (clock)
confirmbooleanImpostalo solo dopo che l'utente ha confermato l'anteprima restituita dalla prima chiamata