Ekrany wyświetlania

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.

Tworzy grupy ekranów Display Screens w obiekcie, zmienia ich nazwy i je usuwa oraz określa, które ekrany do nich należą. Grupy są celami publikacji (display_publish targets.groupIds) i celami poleceń (display_screen_command groupIds). Gdy podano kilka ekranów, grup lub celów, narzędzie działa na wszystkich w jednym wywołaniu; przed działaniem na wielu z nich uzgodnij to z użytkownikiem.

Akcje:

• save: Zapisz grupę. Tworzenie: name (i opcjonalnie screenIds). Zmiana nazwy: groupId (identyfikator lub bieżąca nazwa) i name. screenIds zastępuje listę członków; ekrany spoza listy opuszczają tę grupę, ale pozostają w swoich innych grupach.
• delete: Usuń grupę. Usuwa grupę: jej ekrany ją opuszczają (pozostają w swoich innych grupach), a treści opublikowane w grupie są usuwane z harmonogramu. Wymaga groupId. Prosi o potwierdzenie.

Publikuje statyczne aplikacje HTML („aplikacje hostowane”) dla Display Screens. Najpierw wywołaj display_library_read app_guidelines, aby poznać rozmiary ekranów, zasady projektowania, limity i SDK, a potem display_screenshot, aby sprawdzić wynik na ekranie. Gdy podano kilka ekranów, grup lub celów, narzędzie działa na wszystkich w jednym wywołaniu; przed działaniem na wielu z nich uzgodnij to z użytkownikiem.

Akcje:

• publish: Opublikuj aplikację hostowaną. Tworzy aplikację hostowaną (name + files) lub publikuje nową wersję (appId + files; wersja zaczyna działać wszędzie, gdzie aplikacja jest wyświetlana, a rollback ją cofa). publishTo dodatkowo umieszcza ją na ekranach, tak jak display_publish; cel na poziomie marki lub organizacji wymaga confirm. Wymaga files. Może prosić o potwierdzenie.
• rollback: Przywróć wcześniejszą wersję aplikacji hostowanej. Ponownie ustawia wcześniejszą wersję jako bieżącą wszędzie, gdzie aplikacja jest wyświetlana. Wersje wyświetlisz za pomocą display_library_read app_versions. Wymaga appId, version.

Odczytuje bibliotekę treści Display Screens widoczną dla obiektu: multimedia (obrazy, filmy), aplikacje (strony internetowe, hostowane aplikacje HTML, aplikacje AI Agent, widoki CCTV) i playlisty, a także aplikacje AI Agent i źródła CCTV, które można dodać.

Każdy element ma contentRef (media#…, app#…, playlist#…) do użycia w display_publish i playlistach. ownerScope wskazuje właściciela (facility#, brand# lub org#); treści można publikować tylko w obrębie ich właściciela. Multimedia ze statusem processing nie są jeszcze gotowe; failed wymaga ponownego przesłania. Strony internetowe z frameable: false nie mogą być odtwarzane w playlistach, tylko jako ekran pełnostronicowy. Elementy z displayIssue są pomijane przez ekrany: aplikacja AI Agent, która jest nieopublikowana, wstrzymana, ma wyłączone wyświetlanie, ograniczoną grupę odbiorców lub nie ma Custom Apps; widok CCTV z no-cctv, cctv-off (administrator obiektu włącza CCTV na ekranach w ustawieniach Display Screens) lub no-cameras.

Akcje:

• list: Wyświetl elementy biblioteki. Multimedia i aplikacje (stronicowane; filtrowanie według type, kind, tag lub name) albo, z type agent-apps, aplikacje AI Agent dozwolone na ekranach, które można opublikować za pomocą display_publish content.agentAppId. Każdy element ma typ: media, app lub agent-app.
• cctv_sources: Wyświetl źródła CCTV. Kamery obiektu i udostępnione Live Views dla display_publish content.cctv oraz informacja, czy CCTV na ekranach jest włączone. Wymaga dostępu do CCTV w obiekcie.
• get: Pobierz element biblioteki. Jeden element multimedialny, aplikacja lub playlista według contentRef. Wymaga contentRef.
• usages: Gdzie treść jest używana. Aktywne przypisania w harmonogramie i playlisty, które używają elementu multimedialnego lub aplikacji (albo przypisania playlisty). Używanych treści nie można usunąć. Wymaga contentRef.
• app_versions: Wyświetl wersje aplikacji hostowanej. Wersje aplikacji hostowanej i informacja, która jest bieżąca, na potrzeby display_hosted_apps_write rollback. Wymaga appId.
• app_guidelines: Wytyczne dotyczące aplikacji hostowanych. Rozmiary ekranów, zasady projektowania, limity pakietu, Display App SDK i szablon startowy. Wywołaj przed zbudowaniem aplikacji dla display_hosted_apps_write publish.
• check_url: Sprawdź stronę internetową. Czy stronę internetową można wyświetlać w playlistach (niektóre witryny nie pozwalają na osadzanie w ramkach), wraz ze wskazówkami, jak wygląda. Strony, które nie pozwalają na osadzanie, mogą nadal być ekranem pełnostronicowym. Wymaga url.
• playlists: Wyświetl playlisty. Playlisty widoczne dla obiektu (stronicowane), każda z elementami (contentRef, duration, fit).

Dodaje i zmienia treści w bibliotece Display Screens: przesyłanie obrazów i filmów, tworzenie aplikacji typu strona internetowa, aplikacja AI Agent i widok CCTV, edycja nazw, tagów, czasów wyświetlania i dat, usuwanie nieużywanych elementów oraz odświeżanie podglądu aplikacji. Hostowane aplikacje HTML publikuje się za pomocą display_hosted_apps_write, a playlisty za pomocą display_playlists_write.

Projektuj obrazy w rozdzielczości 1920×1080 (poziomo) lub 1080×1920 (pionowo). Nowe multimedia mają najpierw status processing, dopóki nie powstaną wersje gotowe do wyświetlania; można je od razu dodać do playlist, a odtwarzanie zacznie się po ich przygotowaniu. ownerScope: facility (domyślnie), brand lub organisation (brand i organisation wymagają dostępu w całej organizacji).

Akcje:

• upload_media: Prześlij obraz lub film. Dodaje obraz lub film z publicznego adresu https url (zalecane; obrazy do 25 MB, filmy do 200 MB) albo z base64 z mimeType (do 20 MB). Obrazy JPEG, PNG, WebP, GIF; filmy MP4, WebM, MOV (konwertowane do H.264 MP4, maksymalnie 1080p). Większe filmy: create_video_upload.
• create_video_upload: Rozpocznij przesyłanie dużego filmu. Dla filmów do 2 GB: rejestruje film i zwraca wstępnie podpisane przesyłanie (wyślij plik metodą PUT na upload.url z upload.headers przed upload.expiresAt), a następnie wywołaj transcode z jego contentRef. Wymaga name, mimeType, bytes.
• transcode: Przetwórz film. Konwertuje film dla ekranów: po create_video_upload, ponownie po niepowodzeniu lub dla starszego filmu, którego ekrany nie mogą odtworzyć. Wymaga contentRef.
• create_app: Dodaj aplikację. Dodaje stronę internetową (kind url, przekaż url; sprawdzana pod kątem osadzania w ramkach), aplikację AI Agent (kind agent-app, przekaż agentAppId z display_library_read list type agent-apps) lub widok CCTV (kind cctv-view, należy do obiektu, wymaga dostępu do CCTV). Wymaga kind, name.
• update: Zaktualizuj element biblioteki. Zmienia nazwę, tagi lub czas wyświetlania elementu multimedialnego albo aplikacji; validFrom/validTo elementu multimedialnego (ISO, null czyści; poza tym zakresem element jest pomijany); url strony internetowej; albo kamery, widok, układ lub jakość widoku CCTV. Wymaga contentRef.
• delete: Usuń element biblioteki. Usuwa element multimedialny lub aplikację. Zablokowane, dopóki element jest w aktywnym harmonogramie lub playliście: błąd zawiera ich listę (najpierw usuń je za pomocą display_schedule_write delete lub display_playlists_write save). Wymaga contentRef. Prosi o potwierdzenie.
• refresh_preview: Odśwież podgląd aplikacji. Wykonuje nowy zrzut ekranu aplikacji do podglądu w bibliotece (na przykład po zmianie strony). Wymaga contentRef.

Tworzy, aktualizuje i usuwa playlisty Display Screens: uporządkowane pętle multimediów i aplikacji. Zmiany docierają do każdego ekranu wyświetlającego playlistę w ciągu kilku sekund. Opublikuj playlistę za pomocą display_publish content.contentRef "playlist#".

Akcje:

• save: Zapisz playlistę. Tworzenie: name + items (items może być puste). Aktualizacja: playlistId + dowolne z name, items, transition; items zastępuje całą listę, więc wyślij wszystkie elementy w kolejności.
• delete: Usuń playlistę. Usuwa playlistę. Zablokowane, dopóki playlista jest gdziekolwiek opublikowana: błąd zawiera listę przypisań, które trzeba najpierw usunąć (display_schedule_write delete). Wymaga playlistId. Prosi o potwierdzenie.

Umieszcza treści na Display Screens: element multimedialny, playlistę, aplikację, stronę internetową, aplikację AI Agent lub podgląd na żywo z CCTV, na ekranach, w grupach, w obiekcie, jego marce lub organizacji.

mode: now (domyślnie) zastępuje to, co cele zwykle wyświetlają; scheduled wyświetla treść tylko w cotygodniowych przedziałach czasu (strefa czasowa obiektu) i/lub między from a to; takeover przerywa wszystko na czas durationMin (lub do określonej godziny), a następnie kończy się samoczynnie (wcześniej zatrzymasz je za pomocą display_takeover_stop). Ekrany ustalają, co wyświetlić, najpierw według warstwy (takeover > scheduled > default), a potem według szczegółowości celu (screen > group > facility > brand > organisation).

CCTV: obraz z kamer na żywo widzi każdy, kto jest w pobliżu ekranów. Pierwsze wywołanie zwraca requiresConfirmation (kod CCTV_CONFIRMATION_REQUIRED); zapytaj użytkownika, a następnie wywołaj ponownie z confirmCctv: true. Obiekt musi mieć włączoną opcję "Allow CCTV on display screens".

Opublikowane treści wyświetlają tylko ekrany w trybie player; pozostałe są wymienione w warnings. Zwraca batchId; display_schedule_write delete z tym identyfikatorem cofa całą publikację. Gdy podano kilka ekranów, grup lub celów, narzędzie działa na wszystkich w jednym wywołaniu; przed działaniem na wielu z nich uzgodnij to z użytkownikiem.

Odczytuje, co jest opublikowane na Display Screens: dla jednego ekranu, co wyświetla w danym momencie i w danym okresie (ustalone na podstawie wszystkich warstw i celów, z których dziedziczy), wraz z przypisaniami, które do niego docierają; albo przypisania opublikowane w grupie, obiekcie, jego marce lub organizacji.

Identyfikatory przypisań (as_…) i partii (bt_…) to elementy, które display_schedule_write aktualizuje lub usuwa. Czasy są w formacie ISO; przedziały czasu są w strefie czasowej obiektu.

Akcje:

• get: Pobierz harmonogram ekranu. Co ekran wyświetla w chwili at (domyślnie teraz), jego oś czasu od from do to (domyślnie 24 godziny) i każde przypisanie, które do niego dociera. Wymaga screenId.
• list_assignments: Wyświetl przypisania. Przypisania opublikowane w grupie (groupId) albo w obiekcie, jego marce lub organizacji (target, domyślnie facility). Stronicowane, od najnowszej zmiany.

Zmienia to, co jest opublikowane na Display Screens: edycja czasu, priorytetu lub treści przypisania (opcjonalnie w całej publikacji) albo usunięcie jednego przypisania lub całej publikacji. Identyfikatory znajdziesz za pomocą display_schedule_read. Usunięcie treści z harmonogramu pozostawia ją w bibliotece; aby wcześniej zakończyć przejęcie, ale zachować jego historię, użyj display_takeover_stop.

Akcje:

• update: Zaktualizuj przypisanie. Zmienia czas (cotygodniowe przedziały czasu, from/to; null czyści datę), priorytet lub treść przypisania. applyToBatch wprowadza tę samą zmianę we wszystkich celach publikacji. W przypadku przejęcia można zmienić tylko godzinę zakończenia. Treści CCTV wymagają confirmCctv po wyrażeniu zgody przez użytkownika. Wymaga assignmentId.
• delete: Usuń z harmonogramu. Usuwa jedno przypisanie (assignmentId) lub wszystko z jednej publikacji (batchId). W ciągu kilku sekund ekrany wracają do treści, którą wyświetlałyby w przeciwnym razie. Prosi o potwierdzenie.

Wysyła polecenie na żywo do Display Screens w obiekcie: reload (ekrany w trybie player ponownie pobierają harmonogram), identify (wyświetla na chwilę nazwę i kod ekranu, aby można go było znaleźć na miejscu), displayOn/displayOff (panel telewizora), rebootDevice (ponownie uruchamia komputer ekranu, 1–2 minuty bez obrazu; wymaga confirm: true) lub osd (krótki komunikat na ekranie; przekaż message).

Wybierz ekrany za pomocą screenIds i/lub groupIds (wszystkie ekrany tych grup w obiekcie) albo allScreens: true dla wszystkich ekranów w obiekcie (displayOn/displayOff docierają wtedy również do ekranów z treściami szablonowymi). Zwraca wyniki dla każdego ekranu. Gdy podano kilka ekranów, grup lub celów, narzędzie działa na wszystkich w jednym wywołaniu; przed działaniem na wielu z nich uzgodnij to z użytkownikiem.

Odczytuje Display Screens obiektu: lista ekranów z ich stanem oraz bieżącą i następną treścią (filtrowanie według grupy, stanu lub trybu wyświetlania), pełne szczegóły i oś czasu jednego ekranu albo lista grup ekranów z ich ekranami.

Tryb wyświetlania jest pokazywany użytkownikom jako "Data Source": player to "User managed content", program-builder to "Templated content" (wobec użytkowników zawsze używaj tej nazwy, nigdy wewnętrznego identyfikatora trybu), url to "Full-page website (Kiosk Mode)". Czasy są w formacie ISO; zwracana jest strefa czasowa obiektu.

Akcje:

• list: Wyświetl ekrany. Ekrany w obiekcie (stronicowane), każdy ze stanem, ostatnim sygnałem aktywności, grupami, tagami oraz bieżącą i następną treścią. Zwraca też grupy.
• get: Pobierz ekran. Pełne szczegóły jednego ekranu (stan, sygnał aktywności, wersja odtwarzacza, ostatnie błędy) oraz, w przypadku ekranów w trybie player, co wyświetla w danym okresie (domyślnie przez następne 24 godziny, maksymalnie 14 dni). Wymaga screenId.
• groups: Wyświetl grupy ekranów. Grupy ekranów w obiekcie (stronicowane), każda z jej ekranami.

Zmienia Display Screens: sparowanie nowego ekranu za pomocą kodu parowania; zmiana nazwy ekranu, ustawienie jego grup i tagów lub przełączenie trybu wyświetlania (pokazywanego użytkownikom jako "Data Source"); rotacja tokenu ekranu w trybie player; utworzenie ograniczonego czasowo linku do podglądu ekranu lub treści; albo przywrócenie ustawień fabrycznych ekranu (usuwa go z obiektu).

Tryby wyświetlania: player ("User managed content"), url ("Full-page website (Kiosk Mode)", przekaż url, tylko https), program-builder ("Templated content"; wobec użytkowników zawsze używaj tej nazwy, nigdy wewnętrznego identyfikatora trybu). Zmiana trybu od razu przeładowuje ekran i zmienia to, co widzą klienci, dlatego wymaga potwierdzenia przez użytkownika.

Akcje:

• update: Zaktualizuj ekran. Ustawia nazwę ekranu, grupy (identyfikatory lub nazwy; zastępują bieżące grupy), tagi (zastępują bieżące) i/lub tryb wyświetlania. Zmiana trybu najpierw zwraca requiresConfirmation. Wymaga screenId. Może prosić o potwierdzenie.
• rotate_token: Zmień token ekranu. Wydaje nowy token dla ekranu w trybie player i go przeładowuje; stary token przestaje działać. Użyj, gdy adres URL odtwarzacza ekranu mógł wyciec. Wymaga screenId. Prosi o potwierdzenie.
• create_preview_link: Utwórz link do podglądu. Link (ważny przez ograniczony czas), który pokazuje, co wyświetla ekran lub jak wygląda treść, opcjonalnie w przyszłym terminie. Każdy, kto ma link, może go wyświetlić do czasu jego wygaśnięcia.
• reset: Przywróć ustawienia fabryczne ekranu. Usuwa ekran z obiektu i przywraca jego ustawienia fabryczne; wyłączony ekran zostanie zresetowany, gdy następnym razem połączy się z siecią, a potem wyświetli stronę parowania. Przekaż confirmName: nazwę ekranu dokładnie tak, jak wpisał ją użytkownik. Wymaga Device Management. Wymaga screenId, confirmName. Prosi o potwierdzenie.
• pair: Sparuj nowy ekran. Dodaje nowy ekran do obiektu za pomocą 6-znakowego kodu ze strony parowania, a następnie go przeładowuje. W obiektach, które mają tylko Display Screens, ekran zaczyna w trybie player; jeśli obiekt ma też treści szablonowe, tryb wybiera mode (domyślnie program-builder). Wymaga Device Management. Wymaga pairingCode, name. Prosi o potwierdzenie.

Przechwytuje to, co ekran Display Screens wyświetla w tej chwili, i zwraca obraz, aby można było sprawdzić efekt po publikacji (układ, rozmiar tekstu, brak przyciętych lub przewijanych elementów). Czeka do 15 sekund na odpowiedź ekranu; dla ekranów offline upływa limit czasu. Zwraca też adres URL portalu do pliku JPEG (tylko dla zalogowanych użytkowników, przechowywany przez 10 minut).

Zrzuty ekranu mogą zawierać obraz CCTV na żywo i widocznych członków; nie udostępniaj ich poza rozmową.

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.

Zmienia ustawienia Display Screens obiektu: fallback slate, odpytywanie i nocne przeładowanie oraz "Allow CCTV on display screens"; harmonogram zasilania ekranów; oraz automatyzacje (jasność, głośność dzwonka, zasilanie przy zameldowaniu). Pominięte pola zachowują bieżące wartości. Ustawienia na poziomie marki (ekran rozruchowy, treści szablonowe) są w display_brand_settings_write.

Akcje:

• save_settings: Zapisz ustawienia wyświetlania obiektu. Fallback slate wyświetlany, gdy nic nie jest zaplanowane, interwał odpytywania (30–300 s), godzina nocnego przeładowania (HH:mm) i allowCctv. Włączenie allowCctv wymaga potwierdzenia przez użytkownika i administratora obiektu z dostępem do CCTV. Może prosić o potwierdzenie.
• save_power_schedule: Zapisz harmonogram zasilania. Zmienia godziny włączania i wyłączania ekranów; przekazane pola są scalane z zapisanym harmonogramem. Zwraca godziny włączenia i wyłączenia na następne 7 dni. Najpierw sprawdź za pomocą display_settings_read power_schedule_preview. Wymaga schedule.
• save_automations: Zapisz automatyzacje wyświetlania. Zmienia ustawienia automatycznej jasności, głośności dzwonka i zasilania przy zameldowaniu. Obiekt zachowuje wtedy własne ustawienia zamiast globalnych ustawień domyślnych.

Natychmiast kończy trwające przejęcia Display Screens: dla jednej publikacji (batchId z display_publish), dla celów (domyślnie: przejęcia opublikowane w całym obiekcie) lub z allScreens dla wszystkich przejęć opublikowanych w obiekcie, na jego ekranach lub w ich grupach. Przejęcia na poziomie marki i organizacji można zatrzymać tylko za pomocą batchId. W ciągu kilku sekund ekrany wracają do zaplanowanej lub domyślnej treści; zwraca liczbę zatrzymanych przejęć. Gdy podano kilka ekranów, grup lub celów, narzędzie działa na wszystkich w jednym wywołaniu; przed działaniem na wielu z nich uzgodnij to z użytkownikiem.

Steruje ekranami z treściami szablonowymi (tryb wyświetlania "Templated content" w display_screens_read): ładuje na nie program treningowy na dany dzień lub steruje licznikiem rund. Nie wpływa na ekrany z treściami zarządzanymi przez użytkownika ani na ekrany z witryną pełnostronicową.

Akcje:

• load_program: Załaduj program treningowy. Ładuje program treningowy na daną datę (YYYY-MM-DD, domyślnie dzisiaj) ze źródła danych obiektu na każdy ekran z treściami szablonowymi w jednym lub kilku obiektach; ekrany przeładowują się w ciągu kilku sekund. Użyj, aby pokazać dzisiejszy lub inny trening albo gdy ekrany pokazują niewłaściwy. Kilka obiektów wymaga confirm. Może prosić o potwierdzenie.
• clock: Steruj licznikiem rund. Uruchamia, wstrzymuje, restartuje lub zatrzymuje licznik rund na ekranach z treściami szablonowymi, wycisza lub włącza dźwięki rund, ustawia głośność dzwonka (setvolume z volume 0–100) lub pobiera jego stan. Wymaga treści szablonowych w obiekcie. Wymaga command.