Layar Tampilan

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.

Membuat, mengganti nama, dan menghapus grup Display Screen di fasilitas serta menentukan layar mana yang ada di dalamnya. Grup adalah target penerbitan (display_publish targets.groupIds) dan target perintah (display_screen_command groupIds). Jika beberapa layar, grup, atau target diberikan, alat ini bertindak pada semuanya dalam satu panggilan; tanyakan kepada pengguna sebelum bertindak pada banyak item.

Tindakan:

• save: Simpan grup. Membuat: name (dan opsional screenIds). Mengganti nama: groupId (id atau nama saat ini) dan name. screenIds menggantikan anggota; layar yang tidak dicantumkan keluar dari grup ini tetapi tetap berada di grup lainnya.
• delete: Hapus grup. Menghapus grup: layarnya keluar dari grup tersebut (tetap berada di grup lainnya) dan konten yang diterbitkan ke grup dihapus dari jadwal. Memerlukan groupId. Meminta konfirmasi.

Menerbitkan aplikasi HTML statis ("hosted app") untuk Display Screens. Panggil display_library_read app_guidelines terlebih dahulu untuk ukuran layar, aturan desain, batasan, dan SDK, lalu display_screenshot setelahnya untuk memeriksa hasilnya di layar. Jika beberapa layar, grup, atau target diberikan, alat ini bertindak pada semuanya dalam satu panggilan; tanyakan kepada pengguna sebelum bertindak pada banyak item.

Tindakan:

• publish: Terbitkan hosted app. Membuat hosted app (name + files) atau menerbitkan versi baru (appId + files; versi ini langsung aktif di semua tempat aplikasi ditampilkan, rollback membatalkannya). publishTo juga menampilkannya di layar, seperti display_publish; target merek atau organisasi memerlukan confirm. Memerlukan files. Dapat meminta konfirmasi.
• rollback: Kembalikan hosted app ke versi sebelumnya. Menjadikan versi sebelumnya sebagai versi saat ini lagi, di semua tempat aplikasi ditampilkan. Cantumkan versi dengan display_library_read app_versions. Memerlukan appId, version.

Membaca library konten Display Screens yang terlihat oleh fasilitas: media (gambar, video), aplikasi (halaman web, aplikasi HTML yang di-hosting, aplikasi AI Agent, tampilan CCTV) dan playlist, serta aplikasi AI Agent dan sumber CCTV yang dapat ditambahkan.

Setiap item memiliki contentRef (media#…, app#…, playlist#…) untuk display_publish dan playlist. ownerScope menunjukkan pemiliknya (facility#, brand# atau org#); konten hanya dapat diterbitkan dalam lingkup pemiliknya. Media dengan status processing belum siap; failed perlu diunggah ulang. Halaman web dengan frameable: false tidak dapat diputar di playlist, hanya sebagai layar satu halaman penuh. Item dengan displayIssue dilewati oleh layar: aplikasi AI Agent yang tidak diterbitkan, dijeda, display-off, dibatasi audiensnya, atau tanpa Custom Apps; tampilan CCTV dengan no-cctv, cctv-off (admin fasilitas mengaktifkan CCTV untuk layar di pengaturan Display Screens) atau no-cameras.

Tindakan:

• list: Cantumkan item library. Media dan aplikasi (berhalaman; filter menurut type, kind, tag, atau name), atau dengan type agent-apps, aplikasi AI Agent yang diizinkan di layar yang dapat Anda terbitkan dengan display_publish content.agentAppId. Setiap item memiliki type: media, app, atau agent-app.
• cctv_sources: Cantumkan sumber CCTV. Kamera fasilitas dan Tampilan Langsung yang dibagikan untuk display_publish content.cctv, serta apakah CCTV di layar diaktifkan. Memerlukan akses CCTV di fasilitas.
• get: Dapatkan item library. Satu item media, aplikasi, atau playlist berdasarkan contentRef. Memerlukan contentRef.
• usages: Tempat konten digunakan. Penetapan jadwal aktif dan playlist yang menggunakan item media atau aplikasi (atau penetapan untuk playlist). Konten yang sedang digunakan tidak dapat dihapus. Memerlukan contentRef.
• app_versions: Cantumkan versi hosted app. Versi-versi hosted app dan versi mana yang saat ini digunakan, untuk display_hosted_apps_write rollback. Memerlukan appId.
• app_guidelines: Panduan hosted app. Ukuran layar, aturan desain, batasan bundel, Display App SDK, dan templat awal. Panggil ini sebelum membuat aplikasi untuk display_hosted_apps_write publish.
• check_url: Periksa halaman web. Apakah halaman web dapat ditampilkan di dalam playlist (beberapa situs menolak dibingkai), dengan petunjuk tentang tampilannya. Halaman yang menolak pembingkaian tetap dapat menjadi layar satu halaman penuh. Memerlukan url.
• playlists: Cantumkan playlist. Playlist yang terlihat oleh fasilitas (berhalaman), masing-masing dengan itemnya (contentRef, duration, fit).

Menambahkan dan mengubah konten library Display Screens: mengunggah gambar dan video, membuat aplikasi halaman web, aplikasi AI Agent, dan aplikasi tampilan CCTV, mengedit nama, tag, durasi, dan tanggal, menghapus item yang tidak digunakan, serta memperbarui pratinjau aplikasi. Aplikasi HTML yang di-hosting diterbitkan dengan display_hosted_apps_write; playlist dengan display_playlists_write.

Desain gambar dengan ukuran 1920×1080 (lanskap) atau 1080×1920 (potret). Media baru dimulai dengan status processing selagi versi yang siap untuk web dibuat; media dapat langsung dimasukkan ke playlist dan diputar setelah siap. ownerScope: facility (default), brand atau organisation (brand dan organisation memerlukan akses di seluruh organisasi).

Tindakan:

• upload_media: Unggah gambar atau video. Menambahkan gambar atau video dari url https publik (disarankan; gambar hingga 25 MB, video hingga 200 MB) atau base64 dengan mimeType (hingga 20 MB). Gambar JPEG, PNG, WebP, GIF; video MP4, WebM, MOV (dikonversi ke H.264 MP4 hingga 1080p). Video yang lebih besar: create_video_upload.
• create_video_upload: Mulai unggahan video besar. Untuk video hingga 2 GB: mencatat video dan mengembalikan unggahan presigned (lakukan PUT file ke upload.url dengan upload.headers sebelum upload.expiresAt), lalu panggil transcode dengan contentRef-nya. Memerlukan name, mimeType, bytes.
• transcode: Proses video. Mengonversi video untuk layar: setelah create_video_upload, sekali lagi setelah kegagalan, atau untuk video lama yang tidak dapat diputar oleh layar. Memerlukan contentRef.
• create_app: Tambahkan aplikasi. Menambahkan halaman web (kind url, berikan url; diperiksa untuk pembingkaian), aplikasi AI Agent (kind agent-app, berikan agentAppId dari display_library_read list type agent-apps) atau tampilan CCTV (kind cctv-view, dimiliki fasilitas, memerlukan akses CCTV). Memerlukan kind, name.
• update: Perbarui item library. Mengubah nama, tag, atau durasi item media atau aplikasi; validFrom/validTo item media (ISO, null menghapusnya; di luar rentang tersebut item dilewati); url halaman web; atau kamera, tampilan, tata letak, atau kualitas tampilan CCTV. Memerlukan contentRef.
• delete: Hapus item library. Menghapus item media atau aplikasi. Diblokir selama item ada di jadwal aktif atau playlist: pesan galat mencantumkannya (hapus terlebih dahulu dengan display_schedule_write delete atau display_playlists_write save). Memerlukan contentRef. Meminta konfirmasi.
• refresh_preview: Perbarui pratinjau aplikasi. Mengambil tangkapan layar baru dari aplikasi untuk pratinjau library-nya (misalnya setelah halaman berubah). Memerlukan contentRef.

Membuat, memperbarui, dan menghapus playlist Display Screens: putaran berurutan berisi media dan aplikasi. Perubahan sampai ke setiap layar yang menampilkan playlist dalam hitungan detik. Terbitkan playlist dengan display_publish content.contentRef "playlist#".

Tindakan:

• save: Simpan playlist. Membuat: name + items (items boleh kosong). Memperbarui: playlistId + salah satu dari name, items, transition; items menggantikan seluruh daftar, jadi kirim setiap item secara berurutan.
• delete: Hapus playlist. Menghapus playlist. Diblokir selama playlist diterbitkan di mana pun: pesan galat mencantumkan penetapan yang harus dihapus terlebih dahulu (display_schedule_write delete). Memerlukan playlistId. Meminta konfirmasi.

Menampilkan konten di Display Screens: item media, playlist, aplikasi, halaman web, aplikasi AI Agent, atau tampilan langsung CCTV, di layar, grup, fasilitas, mereknya, atau organisasinya.

mode: now (default) menggantikan apa yang biasanya ditampilkan target; scheduled menampilkannya hanya dalam jendela mingguan (zona waktu fasilitas) dan/atau antara from dan to; takeover menyela semuanya selama durationMin (atau hingga waktu tertentu), lalu berakhir dengan sendirinya (hentikan lebih awal dengan display_takeover_stop). Layar menentukan apa yang ditampilkan menurut lapisan (takeover > scheduled > default), lalu menurut seberapa spesifik targetnya (screen > group > facility > brand > organisation).

CCTV: siaran kamera langsung dapat dilihat oleh siapa pun di dekat layar. Panggilan pertama mengembalikan requiresConfirmation (kode CCTV_CONFIRMATION_REQUIRED); tanyakan kepada pengguna, lalu panggil lagi dengan confirmCctv: true. Fasilitas harus mengaktifkan "Allow CCTV on display screens".

Hanya layar dalam mode player yang menampilkan konten yang diterbitkan; layar lainnya dicantumkan di warnings. Mengembalikan batchId; display_schedule_write delete dengan batchId tersebut membatalkan seluruh penerbitan. Jika beberapa layar, grup, atau target diberikan, alat ini bertindak pada semuanya dalam satu panggilan; tanyakan kepada pengguna sebelum bertindak pada banyak item.

Membaca apa yang diterbitkan ke Display Screens: untuk satu layar, apa yang ditampilkannya pada suatu waktu dan selama suatu rentang (ditentukan di semua lapisan dan target yang diwarisinya) serta penetapan yang menjangkaunya; atau penetapan yang diterbitkan ke grup, fasilitas, mereknya, atau organisasinya.

Id penetapan (as_…) dan id batch (bt_…) adalah yang diperbarui atau dihapus oleh display_schedule_write. Waktu dalam format ISO; jendela waktu dalam zona waktu fasilitas.

Tindakan:

• get: Dapatkan jadwal layar. Apa yang ditampilkan layar pada at (default sekarang), linimasanya dari from hingga to (default 24 jam), dan setiap penetapan yang menjangkaunya. Memerlukan screenId.
• list_assignments: Cantumkan penetapan. Penetapan yang diterbitkan ke grup (groupId), atau ke fasilitas, mereknya, atau organisasinya (target, default facility). Berhalaman, perubahan terbaru lebih dulu.

Mengubah apa yang diterbitkan ke Display Screens: mengedit waktu, prioritas, atau konten penetapan (opsional di seluruh penerbitannya), atau menghapus satu penetapan atau seluruh penerbitan. Temukan id dengan display_schedule_read. Menghapus konten dari jadwal tetap menyimpannya di library; untuk mengakhiri takeover lebih awal tetapi mempertahankan riwayatnya, gunakan display_takeover_stop.

Tindakan:

• update: Perbarui penetapan. Mengubah waktu (jendela mingguan, from/to; null menghapus tanggal), prioritas, atau konten penetapan. applyToBatch menerapkan perubahan yang sama ke setiap target penerbitan. Takeover hanya dapat diberi waktu berakhir baru. Konten CCTV memerlukan confirmCctv setelah pengguna setuju. Memerlukan assignmentId.
• delete: Hapus dari jadwal. Menghapus satu penetapan (assignmentId) atau semua yang berasal dari satu penerbitan (batchId). Layar kembali ke apa yang seharusnya ditampilkan dalam hitungan detik. Meminta konfirmasi.

Mengirim perintah langsung ke Display Screens di fasilitas: reload (layar player mengambil ulang jadwalnya), identify (menampilkan nama dan kode layar secara berkedip, untuk menemukannya di lokasi), displayOn/displayOff (panel TV), rebootDevice (memulai ulang komputer layar, kosong selama 1–2 menit; memerlukan confirm: true) atau osd (pesan singkat di layar; berikan message).

Pilih layar dengan screenIds dan/atau groupIds (setiap layar dalam grup tersebut di fasilitas), atau allScreens: true untuk setiap layar di fasilitas (displayOn/displayOff kemudian juga menjangkau layar templated content). Mengembalikan hasil per layar. Jika beberapa layar, grup, atau target diberikan, alat ini bertindak pada semuanya dalam satu panggilan; tanyakan kepada pengguna sebelum bertindak pada banyak item.

Membaca Display Screens milik fasilitas: mencantumkannya beserta status serta apa yang sedang dan akan tampil (filter menurut grup, status, atau mode tampilan), mendapatkan detail lengkap dan linimasa satu layar, atau mencantumkan grup layar beserta layarnya.

Mode tampilan ditampilkan kepada pengguna sebagai "Data Source": player adalah "User managed content", program-builder adalah "Templated content" (selalu gunakan nama ini kepada pengguna, jangan nama lamanya), url adalah "Full-page website (Kiosk Mode)". Waktu dalam format ISO; zona waktu fasilitas dikembalikan.

Tindakan:

• list: Cantumkan layar. Layar di fasilitas (berhalaman), masing-masing dengan status, heartbeat terakhir, grup, tag, serta apa yang sedang dan akan tampil. Juga mengembalikan grup.
• get: Dapatkan layar. Detail lengkap satu layar (status, heartbeat, versi player, galat terbaru) dan, untuk layar player, apa yang ditampilkannya selama rentang waktu tertentu (default 24 jam ke depan, maks. 14 hari). Memerlukan screenId.
• groups: Cantumkan grup layar. Grup layar di fasilitas (berhalaman), masing-masing dengan layarnya.

Mengubah Display Screens: memasangkan layar baru dengan kode pemasangannya; mengganti nama layar, mengatur grup dan tagnya, atau mengganti mode tampilannya (ditampilkan kepada pengguna sebagai "Data Source"); merotasi token layar player; membuat tautan pratinjau berbatas waktu untuk layar atau konten; atau melakukan reset pabrik pada layar (menghapusnya dari fasilitas).

Mode tampilan: player ("User managed content"), url ("Full-page website (Kiosk Mode)", berikan url, hanya https), program-builder ("Templated content"; selalu gunakan nama ini kepada pengguna, jangan nama lamanya). Mengganti mode langsung memuat ulang layar dan mengubah apa yang dilihat anggota, sehingga memerlukan konfirmasi pengguna.

Tindakan:

• update: Perbarui layar. Mengatur nama layar, grup (id atau nama; menggantikan grup saat ini), tag (menggantikannya) dan/atau mode tampilan. Perubahan mode mengembalikan requiresConfirmation terlebih dahulu. Memerlukan screenId. Dapat meminta konfirmasi.
• rotate_token: Rotasi token layar. Menerbitkan token baru untuk layar player dan memuat ulang layar tersebut; token lama berhenti berfungsi. Gunakan jika URL player layar mungkin bocor. Memerlukan screenId. Meminta konfirmasi.
• create_preview_link: Buat tautan pratinjau. Tautan (berlaku untuk waktu terbatas) yang menunjukkan apa yang ditampilkan layar, atau tampilan konten, opsional pada waktu mendatang. Siapa pun yang memiliki tautan dapat melihatnya hingga kedaluwarsa.
• reset: Reset pabrik layar. Menghapus layar dari fasilitas dan melakukan reset pabrik; layar yang mati akan direset saat online berikutnya, lalu menampilkan halaman pemasangannya. Berikan confirmName: nama layar persis seperti yang diketik pengguna. Memerlukan Manajemen Perangkat. Memerlukan screenId, confirmName. Meminta konfirmasi.
• pair: Pasangkan layar baru. Menambahkan layar baru ke fasilitas dengan kode 6 karakter di halaman pemasangannya, lalu memuat ulang layar tersebut. Fasilitas yang hanya memiliki Display Screens memulainya dalam mode player; jika juga memiliki templated content, mode yang menentukan (default program-builder). Memerlukan Manajemen Perangkat. Memerlukan pairingCode, name. Meminta konfirmasi.

Menangkap apa yang ditampilkan Display Screen saat ini dan mengembalikan gambarnya, sehingga Anda dapat memeriksa hasil kerja Anda setelah menerbitkan (tata letak, ukuran teks, tidak ada yang terpotong atau bergulir). Menunggu hingga 15 detik sampai layar merespons; layar yang luring akan mengalami batas waktu habis. Juga mengembalikan URL portal untuk JPEG (hanya untuk pengguna yang sudah masuk, disimpan selama 10 menit).

Tangkapan layar dapat memuat CCTV langsung dan anggota yang terlihat; jangan bagikan di luar percakapan.

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.

Mengubah pengaturan Display Screens fasilitas: Fallback Slate, polling dan pemuatan ulang malam hari, serta "Allow CCTV on display screens"; jadwal daya layar; dan otomatisasi (kecerahan, volume bel, daya saat check-in). Kolom yang tidak Anda isi mempertahankan nilai saat ini. Pengaturan untuk seluruh merek (boot screen, templated content) ada di display_brand_settings_write.

Tindakan:

• save_settings: Simpan pengaturan tampilan fasilitas. Fallback Slate yang ditampilkan saat tidak ada yang dijadwalkan, interval polling (30–300 dtk), waktu pemuatan ulang malam hari (HH:mm), dan allowCctv. Mengaktifkan allowCctv memerlukan konfirmasi pengguna dan admin fasilitas dengan akses CCTV. Dapat meminta konfirmasi.
• save_power_schedule: Simpan jadwal daya. Mengubah kapan layar menyala dan mati; kolom yang Anda berikan digabungkan ke jadwal yang disimpan. Mengembalikan waktu nyala/mati untuk 7 hari ke depan. Periksa terlebih dahulu dengan display_settings_read power_schedule_preview. Memerlukan schedule.
• save_automations: Simpan otomatisasi tampilan. Mengubah pengaturan kecerahan otomatis, volume bel, dan daya saat check-in. Fasilitas kemudian menggunakan pengaturannya sendiri, bukan default global.

Mengakhiri takeover Display Screens yang sedang berjalan sekarang: untuk satu penerbitan (batchId dari display_publish), untuk target (default: takeover yang diterbitkan ke seluruh fasilitas), atau dengan allScreens untuk setiap takeover yang diterbitkan ke fasilitas, layarnya, atau grupnya. Takeover merek dan organisasi hanya dapat dihentikan dengan batchId. Layar kembali ke konten terjadwal atau default dalam hitungan detik; mengembalikan jumlah yang dihentikan. Jika beberapa layar, grup, atau target diberikan, alat ini bertindak pada semuanya dalam satu panggilan; tanyakan kepada pengguna sebelum bertindak pada banyak item.

Mengontrol layar templated content (mode tampilan "Templated content" di display_screens_read): memuat program latihan suatu hari pada layar tersebut, atau mengontrol pengatur waktu putaran. Layar User managed content dan situs web satu halaman penuh tidak pernah terpengaruh.

Tindakan:

• load_program: Muat program latihan. Memuat program latihan suatu tanggal (YYYY-MM-DD, default hari ini) dari sumber data fasilitas di setiap layar templated content di satu atau beberapa fasilitas; layar dimuat ulang dalam hitungan detik. Gunakan untuk menampilkan latihan hari ini atau hari lain, atau jika layar menampilkan latihan yang salah. Beberapa fasilitas memerlukan confirm. Dapat meminta konfirmasi.
• clock: Kontrol pengatur waktu putaran. Memutar, menjeda, memulai ulang, atau menghentikan pengatur waktu putaran di layar templated content, membisukan atau mengaktifkan suara putaran, mengatur volume bel (setvolume dengan volume 0–100), atau menanyakan statusnya. Memerlukan templated content di fasilitas. Memerlukan command.