Schermen

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.

Maakt Display Screen-groepen bij een faciliteit aan, wijzigt hun naam, verwijdert ze en bepaalt welke schermen erin zitten. Groepen zijn publicatiedoelen (display_publish targets.groupIds) en opdrachtdoelen (display_screen_command groupIds). Als er meerdere schermen, groepen of doelen worden opgegeven, werkt dit in één aanroep op allemaal; overleg met de gebruiker voordat je op veel tegelijk werkt.

Acties:

• save: Groep opslaan. Aanmaken: name (en optioneel screenIds). Naam wijzigen: groupId (id of huidige naam) en name. screenIds vervangt de leden; schermen die niet in de lijst staan, verlaten deze groep maar behouden hun andere groepen.
• delete: Groep verwijderen. Verwijdert een groep: de schermen verlaten de groep (ze behouden hun andere groepen) en content die naar de groep is gepubliceerd, wordt uit de planning verwijderd. Vereist groupId. Vraagt om bevestiging.

Publiceert statische HTML-apps ("hosted apps") voor Display Screens. Roep eerst display_library_read app_guidelines aan voor schermformaten, ontwerpregels, limieten en de SDK, en daarna display_screenshot om het resultaat op een scherm te controleren. Als er meerdere schermen, groepen of doelen worden opgegeven, werkt dit in één aanroep op allemaal; overleg met de gebruiker voordat je op veel tegelijk werkt.

Acties:

• publish: Hosted app publiceren. Maakt een hosted app aan (name + files) of publiceert een nieuwe versie (appId + files; die gaat live overal waar de app wordt getoond, rollback maakt dit ongedaan). publishTo zet de app ook op schermen, zoals display_publish; een doel op merk- of organisatieniveau vereist confirm. Vereist files. Kan om bevestiging vragen.
• rollback: Hosted app terugdraaien. Maakt een eerdere versie weer actueel, overal waar de app wordt getoond. Toon versies met display_library_read app_versions. Vereist appId, version.

Leest de Display Screens-contentbibliotheek die zichtbaar is voor een faciliteit: media (afbeeldingen, video's), apps (webpagina's, hosted HTML-apps, AI-agent-apps, CCTV-weergaven) en playlists, plus AI-agent-apps en CCTV-bronnen die kunnen worden toegevoegd.

Elk item heeft een contentRef (media#…, app#…, playlist#…) voor display_publish en playlists. ownerScope geeft aan wie de eigenaar is (facility#, brand# of org#); content kan alleen binnen de eigenaar worden gepubliceerd. Media met status processing zijn nog niet klaar; failed moet opnieuw worden geüpload. Webpagina's met frameable: false kunnen niet in playlists worden afgespeeld, alleen als volledig scherm. Items met een displayIssue worden door schermen overgeslagen: een AI-agent-app die niet gepubliceerd, gepauzeerd, display-off of beperkt tot een doelgroep is of geen Custom Apps heeft; een CCTV-weergave met no-cctv, cctv-off (een faciliteitbeheerder zet CCTV voor schermen aan in de Display Screens-instellingen) of no-cameras.

Acties:

• list: Bibliotheekitems tonen. Media en apps (gepagineerd; filter op type, kind, tag of name), of met type agent-apps de AI-agent-apps die op schermen zijn toegestaan en die je kunt publiceren met display_publish content.agentAppId. Elk item heeft een type: media, app of agent-app.
• cctv_sources: CCTV-bronnen tonen. De camera's en gedeelde Live Views van de faciliteit voor display_publish content.cctv, en of CCTV op schermen is ingeschakeld. Vereist CCTV-toegang bij de faciliteit.
• get: Bibliotheekitem ophalen. Eén media-item, app of playlist op basis van contentRef. Vereist contentRef.
• usages: Waar content wordt gebruikt. De live planningstoewijzingen en playlists die een media-item of app gebruiken (of de toewijzingen voor een playlist). Content die in gebruik is, kan niet worden verwijderd. Vereist contentRef.
• app_versions: Versies van een hosted app tonen. De versies van een hosted app en welke actueel is, voor display_hosted_apps_write rollback. Vereist appId.
• app_guidelines: Richtlijnen voor hosted apps. Schermformaten, ontwerpregels, bundellimieten, de Display App SDK en een startersjabloon. Roep dit aan voordat je een app bouwt voor display_hosted_apps_write publish.
• check_url: Webpagina controleren. Of een webpagina in playlists kan worden getoond (sommige sites weigeren in een frame te worden geladen), met hints over hoe die eruitziet. Pagina's die framing weigeren, kunnen nog steeds als volledig scherm worden getoond. Vereist url.
• playlists: Playlists tonen. Playlists die zichtbaar zijn voor de faciliteit (gepagineerd), elk met de items (contentRef, duration, fit).

Voegt content toe aan de Display Screens-bibliotheek en wijzigt die: afbeeldingen en video's uploaden, apps maken voor webpagina's, AI-agent-apps en CCTV-weergaven, namen, tags, duur en datums bewerken, ongebruikte items verwijderen en het voorbeeld van een app vernieuwen. Hosted HTML-apps worden gepubliceerd met display_hosted_apps_write; playlists met display_playlists_write.

Ontwerp afbeeldingen op 1920×1080 (liggend) of 1080×1920 (staand). Nieuwe media starten als processing terwijl webgeschikte versies worden gemaakt; ze kunnen meteen in playlists worden gezet en worden afgespeeld zodra ze klaar zijn. ownerScope: facility (standaard), brand of organisation (brand en organisation vereisen organisatiebrede toegang).

Acties:

• upload_media: Afbeelding of video uploaden. Voegt een afbeelding of video toe via een openbare https-url (voorkeur; afbeeldingen tot 25 MB, video's tot 200 MB) of base64 met mimeType (tot 20 MB). Afbeeldingen in JPEG, PNG, WebP, GIF; video's in MP4, WebM, MOV (geconverteerd naar H.264 MP4 tot 1080p). Grotere video's: create_video_upload.
• create_video_upload: Upload van een grote video starten. Voor video's tot 2 GB: registreert de video en retourneert een presigned upload (PUT het bestand naar upload.url met upload.headers vóór upload.expiresAt), en roep daarna transcode aan met de contentRef. Vereist name, mimeType, bytes.
• transcode: Video verwerken. Converteert een video voor schermen: na create_video_upload, opnieuw na een fout, of voor een oudere video die schermen niet kunnen afspelen. Vereist contentRef.
• create_app: App toevoegen. Voegt een webpagina toe (kind url, geef url door; wordt gecontroleerd op framing), een AI-agent-app (kind agent-app, geef agentAppId door uit display_library_read list type agent-apps) of een CCTV-weergave (kind cctv-view, eigendom van de faciliteit, vereist CCTV-toegang). Vereist kind, name.
• update: Bibliotheekitem bijwerken. Wijzigt de naam, tags of duur van een media-item of app; validFrom/validTo van een media-item (ISO, null wist; daarbuiten wordt het overgeslagen); de url van een webpagina; of de cameras, view, layout of quality van een CCTV-weergave. Vereist contentRef.
• delete: Bibliotheekitem verwijderen. Verwijdert een media-item of app. Geblokkeerd zolang het in een live planning of playlist staat: de foutmelding toont welke (verwijder ze eerst met display_schedule_write delete of display_playlists_write save). Vereist contentRef. Vraagt om bevestiging.
• refresh_preview: Voorbeeld van een app vernieuwen. Maakt een nieuwe screenshot van een app voor het bibliotheekvoorbeeld (bijvoorbeeld nadat de pagina is gewijzigd). Vereist contentRef.

Maakt Display Screens-playlists aan, werkt ze bij en verwijdert ze: geordende lussen van media en apps. Wijzigingen bereiken binnen enkele seconden elk scherm dat de playlist toont. Publiceer een playlist met display_publish content.contentRef "playlist#".

Acties:

• save: Playlist opslaan. Aanmaken: name + items (items mag leeg zijn). Bijwerken: playlistId + een of meer van name, items, transition; items vervangt de hele lijst, dus stuur elk item in de juiste volgorde.
• delete: Playlist verwijderen. Verwijdert een playlist. Geblokkeerd zolang die ergens is gepubliceerd: de foutmelding toont de toewijzingen die je eerst moet verwijderen (display_schedule_write delete). Vereist playlistId. Vraagt om bevestiging.

Zet content op Display Screens: een media-item, playlist, app, webpagina, AI-agent-app of live CCTV-weergave, op schermen, groepen, de faciliteit, het merk of de organisatie.

mode: now (standaard) vervangt wat de doelen normaal tonen; scheduled toont het alleen in wekelijkse tijdvensters (tijdzone van de faciliteit) en/of tussen from en to; takeover onderbreekt alles gedurende durationMin (of tot een bepaald tijdstip) en eindigt daarna vanzelf (eerder stoppen met display_takeover_stop). Schermen bepalen wat ze tonen eerst op laag (takeover > scheduled > default) en daarna op hoe specifiek het doel is (screen > group > facility > brand > organisation).

CCTV: live camerabeelden zijn zichtbaar voor iedereen bij de schermen. De eerste aanroep retourneert requiresConfirmation (code CCTV_CONFIRMATION_REQUIRED); vraag het de gebruiker en roep daarna opnieuw aan met confirmCctv: true. Bij de faciliteit moet "Allow CCTV on display screens" zijn ingeschakeld.

Alleen schermen in player-modus tonen gepubliceerde content; andere worden vermeld in warnings. Retourneert een batchId; display_schedule_write delete daarmee maakt de hele publicatie ongedaan. Als er meerdere schermen, groepen of doelen worden opgegeven, werkt dit in één aanroep op allemaal; overleg met de gebruiker voordat je op veel tegelijk werkt.

Leest wat er naar Display Screens is gepubliceerd: voor één scherm wat het op een bepaald moment en over een periode toont (bepaald over elke laag en elk doel waarvan het overerft) plus de toewijzingen die het bereiken; of de toewijzingen die zijn gepubliceerd naar een groep, de faciliteit, het merk of de organisatie.

Toewijzings-id's (as_…) en batch-id's (bt_…) zijn wat display_schedule_write bijwerkt of verwijdert. Tijden zijn ISO; tijdvensters zijn in de tijdzone van de faciliteit.

Acties:

• get: Planning van een scherm ophalen. Wat een scherm toont op at (standaard nu), de tijdlijn van from tot to (standaard 24 uur) en elke toewijzing die het bereikt. Vereist screenId.
• list_assignments: Toewijzingen tonen. Toewijzingen die zijn gepubliceerd naar een groep (groupId), of naar de faciliteit, het merk of de organisatie (target, standaard facility). Gepagineerd, nieuwste wijziging eerst.

Wijzigt wat er naar Display Screens is gepubliceerd: bewerk de timing, prioriteit of content van een toewijzing (optioneel voor de hele publicatie), of verwijder één toewijzing of een hele publicatie. Zoek id's op met display_schedule_read. Content die uit de planning wordt verwijderd, blijft in de bibliotheek; gebruik display_takeover_stop om een takeover eerder te beëindigen en de geschiedenis te behouden.

Acties:

• update: Toewijzing bijwerken. Wijzigt de timing (wekelijkse tijdvensters, from/to; null wist een datum), prioriteit of content van een toewijzing. applyToBatch voert dezelfde wijziging door voor elk doel van de publicatie. Een takeover kan alleen een nieuwe eindtijd krijgen. CCTV-content vereist confirmCctv nadat de gebruiker heeft ingestemd. Vereist assignmentId.
• delete: Uit de planning verwijderen. Verwijdert één toewijzing (assignmentId) of alles van één publicatie (batchId). Schermen gaan binnen enkele seconden terug naar wat ze anders zouden tonen. Vraagt om bevestiging.

Stuurt een live opdracht naar Display Screens bij een faciliteit: reload (playerschermen halen hun planning opnieuw op), identify (laat de naam en code van het scherm knipperen, om het ter plaatse te vinden), displayOn/displayOff (het tv-paneel), rebootDevice (herstart de computer van het scherm, 1–2 minuten zwart; vereist confirm: true) of osd (een kort bericht op het scherm; geef message door).

Kies schermen met screenIds en/of groupIds (elk scherm van die groepen bij de faciliteit), of allScreens: true voor elk scherm bij de faciliteit (displayOn/displayOff bereiken dan ook schermen met templated content). Retourneert resultaten per scherm. Als er meerdere schermen, groepen of doelen worden opgegeven, werkt dit in één aanroep op allemaal; overleg met de gebruiker voordat je op veel tegelijk werkt.

Leest de Display Screens van een faciliteit: toon ze met hun status en wat er nu en straks wordt getoond (filter op groep, status of weergavemodus), haal de volledige details en tijdlijn van één scherm op, of toon schermgroepen met hun schermen.

De weergavemodus wordt aan gebruikers getoond als "Data Source": player is "User managed content", program-builder is "Templated content" (gebruik tegenover gebruikers altijd "Templated content"), url is "Full-page website (Kiosk Mode)". Tijden zijn ISO; de tijdzone van de faciliteit wordt meegeleverd.

Acties:

• list: Schermen tonen. Schermen bij de faciliteit (gepagineerd), elk met status, laatste heartbeat, groepen, tags en wat er nu en straks wordt getoond. Retourneert ook de groepen.
• get: Scherm ophalen. De volledige details van één scherm (status, heartbeat, playerversie, recente fouten) en, voor playerschermen, wat het over een periode toont (standaard de komende 24 uur, max. 14 dagen). Vereist screenId.
• groups: Schermgroepen tonen. Schermgroepen bij de faciliteit (gepagineerd), elk met de bijbehorende schermen.

Wijzigt Display Screens: koppel een nieuw scherm met de koppelcode; wijzig de naam van een scherm, stel de groepen en tags in of wijzig de weergavemodus (aan gebruikers getoond als "Data Source"); vernieuw het token van een playerscherm; maak een tijdelijke voorbeeldlink van een scherm of content; of zet een scherm terug naar de fabrieksinstellingen (verwijdert het uit de faciliteit).

Weergavemodi: player ("User managed content"), url ("Full-page website (Kiosk Mode)", geef url door, alleen https), program-builder ("Templated content"; gebruik tegenover gebruikers altijd "Templated content"). Een moduswijziging laadt het scherm direct opnieuw en verandert wat leden zien, dus de gebruiker moet dit bevestigen.

Acties:

• update: Scherm bijwerken. Stelt de naam, groepen (id's of namen; vervangt de huidige groepen), tags (vervangt ze) en/of weergavemodus van een scherm in. Een moduswijziging retourneert eerst requiresConfirmation. Vereist screenId. Kan om bevestiging vragen.
• rotate_token: Schermtoken vernieuwen. Geeft een nieuw token uit voor een playerscherm en laadt het opnieuw; het oude token werkt niet meer. Gebruik dit als de player-URL van een scherm mogelijk is uitgelekt. Vereist screenId. Vraagt om bevestiging.
• create_preview_link: Voorbeeldlink maken. Een link (beperkte tijd geldig) die toont wat een scherm toont, of hoe content eruitziet, optioneel op een toekomstig tijdstip. Iedereen met de link kan deze bekijken tot hij verloopt.
• reset: Scherm terugzetten naar fabrieksinstellingen. Verwijdert het scherm uit de faciliteit en zet het terug naar de fabrieksinstellingen; een uitgeschakeld scherm wordt gereset zodra het weer online komt en toont daarna zijn koppelpagina. Geef confirmName door: de schermnaam precies zoals de gebruiker die heeft getypt. Vereist Apparaatbeheer. Vereist screenId, confirmName. Vraagt om bevestiging.
• pair: Nieuw scherm koppelen. Voegt een nieuw scherm toe aan de faciliteit met de code van 6 tekens op de koppelpagina en laadt het daarna opnieuw. Bij faciliteiten met alleen Display Screens start het op player; als er ook templated content is, bepaalt mode dit (standaard program-builder). Vereist Apparaatbeheer. Vereist pairingCode, name. Vraagt om bevestiging.

Legt vast wat een Display Screen op dit moment toont en retourneert de afbeelding, zodat je je eigen werk na het publiceren kunt controleren (opmaak, tekstgrootte, niets afgesneden of scrollend). Wacht tot 15 seconden op antwoord van het scherm; bij offline schermen treedt een time-out op. Retourneert ook een portal-URL voor de JPEG (alleen voor aangemelde gebruikers, 10 minuten bewaard).

Screenshots kunnen live CCTV en leden in beeld bevatten; deel ze niet buiten het gesprek.

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.

Wijzigt de Display Screens-instellingen van een faciliteit: de Fallback Slate, polling en nachtelijk herladen, en "Allow CCTV on display screens"; het aan/uit-schema van de schermen; en automatiseringen (helderheid, belvolume, inschakelen bij inchecken). Velden die je weglaat, behouden hun huidige waarden. Instellingen voor het hele merk (opstartscherm, templated content) staan in display_brand_settings_write.

Acties:

• save_settings: Weergave-instellingen van de faciliteit opslaan. De Fallback Slate die wordt getoond als er niets is gepland, het pollinginterval (30–300 s), het tijdstip van nachtelijk herladen (HH:mm) en allowCctv. Voor het inschakelen van allowCctv zijn bevestiging door de gebruiker en een faciliteitbeheerder met CCTV-toegang nodig. Kan om bevestiging vragen.
• save_power_schedule: Aan/uit-schema opslaan. Wijzigt wanneer schermen aan- en uitgaan; de velden die je doorgeeft, worden samengevoegd met het opgeslagen schema. Retourneert de aan/uit-tijden voor de komende 7 dagen. Controleer eerst met display_settings_read power_schedule_preview. Vereist schedule.
• save_automations: Weergave-automatiseringen opslaan. Wijzigt de instellingen voor automatische helderheid, belvolume en inschakelen bij inchecken. De faciliteit houdt daarna eigen instellingen aan in plaats van de globale standaardwaarden.

Beëindigt lopende Display Screens-takeovers direct: voor één publicatie (batchId uit display_publish), voor doelen (standaard: takeovers die naar de hele faciliteit zijn gepubliceerd), of met allScreens voor elke takeover die naar de faciliteit, haar schermen of hun groepen is gepubliceerd. Takeovers op merk- en organisatieniveau stoppen alleen via batchId. Schermen keren binnen enkele seconden terug naar hun geplande of standaardcontent; retourneert hoeveel er zijn gestopt. Als er meerdere schermen, groepen of doelen worden opgegeven, werkt dit in één aanroep op allemaal; overleg met de gebruiker voordat je op veel tegelijk werkt.

Bedient schermen met templated content (weergavemodus "Templated content" in display_screens_read): laad het workoutprogramma van een dag of bedien de rondetimer. Schermen met User managed content en volledige websites worden nooit beïnvloed.

Acties:

• load_program: Workoutprogramma laden. Laadt het workoutprogramma van een datum (YYYY-MM-DD, standaard vandaag) uit de gegevensbron van de faciliteit op elk scherm met templated content bij een of meer faciliteiten; schermen laden binnen enkele seconden opnieuw. Gebruik dit om de workout van vandaag of een andere dag te tonen, of als schermen de verkeerde tonen. Meerdere faciliteiten vereisen confirm. Kan om bevestiging vragen.
• clock: Rondetimer bedienen. Start, pauzeert, herstart of stopt de rondetimer op schermen met templated content, dempt rondegeluiden of zet ze weer aan, stelt het belvolume in (setvolume met volume 0–100) of vraagt de status op. Vereist templated content bij de faciliteit. Vereist command.