Skrin Paparan

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.

Mencipta, menamakan semula dan memadamkan kumpulan Display Screen di sesebuah kemudahan serta menetapkan skrin yang berada di dalamnya. Kumpulan ialah sasaran penerbitan (display_publish targets.groupIds) dan sasaran arahan (display_screen_command groupIds). Apabila beberapa skrin, kumpulan atau sasaran diberikan, alat ini bertindak ke atas kesemuanya dalam satu panggilan; semak dengan pengguna sebelum bertindak ke atas banyak item.

Tindakan:

• save: Simpan kumpulan. Cipta: name (dan secara pilihan screenIds). Namakan semula: groupId (id atau nama semasa) dan name. screenIds menggantikan ahli; skrin yang tidak disenaraikan keluar daripada kumpulan ini tetapi kekal dalam kumpulan lain.
• delete: Padamkan kumpulan. Memadamkan kumpulan: skrinnya keluar daripada kumpulan itu (kekal dalam kumpulan lain) dan kandungan yang diterbitkan kepada kumpulan itu dialih keluar daripada jadual. Memerlukan groupId. Meminta pengesahan.

Menerbitkan aplikasi HTML statik ("hosted apps") untuk Display Screens. Panggil display_library_read app_guidelines dahulu untuk saiz skrin, peraturan reka bentuk, had dan SDK, dan display_screenshot selepas itu untuk menyemak hasilnya pada skrin. Apabila beberapa skrin, kumpulan atau sasaran diberikan, alat ini bertindak ke atas kesemuanya dalam satu panggilan; semak dengan pengguna sebelum bertindak ke atas banyak item.

Tindakan:

• publish: Terbitkan hosted app. Mencipta hosted app (name + files) atau menerbitkan versi baharu (appId + files; versi itu disiarkan di semua tempat aplikasi dipaparkan, dan rollback membatalkannya). publishTo turut meletakkannya pada skrin, seperti display_publish; sasaran jenama atau organisasi memerlukan confirm. Memerlukan files. Mungkin meminta pengesahan.
• rollback: Kembalikan hosted app kepada versi terdahulu. Menjadikan versi terdahulu sebagai versi semasa semula, di semua tempat aplikasi dipaparkan. Senaraikan versi dengan display_library_read app_versions. Memerlukan appId, version.

Membaca pustaka kandungan Display Screens yang boleh dilihat oleh sesebuah kemudahan: media (imej, video), aplikasi (halaman web, aplikasi HTML yang dihoskan, aplikasi Ejen AI, paparan CCTV) dan senarai main, serta aplikasi Ejen AI dan sumber CCTV yang boleh ditambah.

Setiap item mempunyai contentRef (media#…, app#…, playlist#…) untuk display_publish dan senarai main. ownerScope menunjukkan pemiliknya (facility#, brand# atau org#); kandungan hanya boleh diterbitkan dalam lingkungan pemiliknya. Media berstatus processing belum sedia; failed perlu dimuat naik semula. Halaman web dengan frameable: false tidak boleh dimainkan dalam senarai main, hanya sebagai skrin halaman penuh. Item yang mempunyai displayIssue dilangkau oleh skrin: aplikasi Ejen AI yang tidak diterbitkan, dijeda, display-off, terhad kepada khalayak tertentu atau tanpa Custom Apps; paparan CCTV dengan no-cctv, cctv-off (pentadbir kemudahan menghidupkan CCTV untuk skrin dalam tetapan Display Screens) atau no-cameras.

Tindakan:

• list: Senaraikan item pustaka. Media dan aplikasi (berhalaman; tapis mengikut type, kind, tag atau nama), atau dengan type agent-apps, aplikasi Ejen AI yang dibenarkan pada skrin dan boleh Anda terbitkan dengan display_publish content.agentAppId. Setiap item mempunyai type: media, app atau agent-app.
• cctv_sources: Senaraikan sumber CCTV. Kamera kemudahan dan Pandangan Langsung yang dikongsi untuk display_publish content.cctv, serta sama ada CCTV pada skrin dihidupkan. Memerlukan akses CCTV di kemudahan tersebut.
• get: Dapatkan item pustaka. Satu item media, aplikasi atau senarai main mengikut contentRef. Memerlukan contentRef.
• usages: Tempat kandungan digunakan. Tugasan jadual aktif dan senarai main yang menggunakan item media atau aplikasi (atau tugasan bagi senarai main). Kandungan yang sedang digunakan tidak boleh dipadamkan. Memerlukan contentRef.
• app_versions: Senaraikan versi hosted app. Versi hosted app dan versi yang sedang digunakan, untuk display_hosted_apps_write rollback. Memerlukan appId.
• app_guidelines: Garis panduan hosted app. Saiz skrin, peraturan reka bentuk, had berkas, Display App SDK dan templat permulaan. Panggil ini sebelum membina aplikasi untuk display_hosted_apps_write publish.
• check_url: Semak halaman web. Sama ada halaman web boleh dipaparkan dalam senarai main (sesetengah laman enggan dibingkaikan), dengan petunjuk tentang rupanya. Halaman yang enggan dibingkaikan masih boleh menjadi skrin halaman penuh. Memerlukan url.
• playlists: Senaraikan senarai main. Senarai main yang boleh dilihat oleh kemudahan (berhalaman), setiap satu dengan itemnya (contentRef, tempoh, fit).

Menambah dan mengubah kandungan pustaka Display Screens: memuat naik imej dan video, mencipta aplikasi halaman web, aplikasi Ejen AI dan aplikasi paparan CCTV, mengedit nama, tag, tempoh dan tarikh, memadamkan item yang tidak digunakan, dan memuat semula pratonton aplikasi. Aplikasi HTML yang dihoskan diterbitkan dengan display_hosted_apps_write; senarai main dengan display_playlists_write.

Reka bentuk imej pada 1920×1080 (landskap) atau 1080×1920 (potret). Media baharu bermula dengan status processing semasa versi sedia web dihasilkan; media itu boleh dimasukkan ke dalam senarai main serta-merta dan dimainkan sebaik sahaja sedia. ownerScope: facility (lalai), brand atau organisation (brand dan organisation memerlukan akses seluruh organisasi).

Tindakan:

• upload_media: Muat naik imej atau video. Menambah imej atau video daripada url https awam (diutamakan; imej sehingga 25 MB, video sehingga 200 MB) atau base64 dengan mimeType (sehingga 20 MB). Imej JPEG, PNG, WebP, GIF; video MP4, WebM, MOV (ditukar kepada MP4 H.264 sehingga 1080p). Video yang lebih besar: create_video_upload.
• create_video_upload: Mulakan muat naik video besar. Untuk video sehingga 2 GB: merekodkan video dan mengembalikan muat naik prasandatangan (PUT fail ke upload.url dengan upload.headers sebelum upload.expiresAt), kemudian panggil transcode dengan contentRef video itu. Memerlukan name, mimeType, bytes.
• transcode: Proses video. Menukar video untuk skrin: selepas create_video_upload, sekali lagi selepas kegagalan, atau untuk video lama yang tidak dapat dimainkan oleh skrin. Memerlukan contentRef.
• create_app: Tambah aplikasi. Menambah halaman web (kind url, hantar url; disemak untuk pembingkaian), aplikasi Ejen AI (kind agent-app, hantar agentAppId daripada display_library_read list type agent-apps) atau paparan CCTV (kind cctv-view, dimiliki kemudahan, memerlukan akses CCTV). Memerlukan kind, name.
• update: Kemas kini item pustaka. Mengubah nama, tag atau tempoh item media atau aplikasi; validFrom/validTo item media (ISO, null mengosongkan; di luar julat itu item dilangkau); url halaman web; atau kamera, paparan, susun atur atau kualiti paparan CCTV. Memerlukan contentRef.
• delete: Padamkan item pustaka. Memadamkan item media atau aplikasi. Disekat selagi item itu berada dalam jadual aktif atau senarai main: ralat menyenaraikannya (alih keluar dahulu dengan display_schedule_write delete atau display_playlists_write save). Memerlukan contentRef. Meminta pengesahan.
• refresh_preview: Muat semula pratonton aplikasi. Mengambil tangkapan skrin baharu aplikasi untuk pratonton pustakanya (contohnya selepas halaman berubah). Memerlukan contentRef.

Mencipta, mengemas kini dan memadamkan senarai main Display Screens: gelung media dan aplikasi yang tersusun. Perubahan sampai ke setiap skrin yang memaparkan senarai main itu dalam beberapa saat. Terbitkan senarai main dengan display_publish content.contentRef "playlist#".

Tindakan:

• save: Simpan senarai main. Cipta: name + items (items boleh kosong). Kemas kini: playlistId + mana-mana daripada name, items, transition; items menggantikan keseluruhan senarai, jadi hantar setiap item mengikut urutan.
• delete: Padamkan senarai main. Memadamkan senarai main. Disekat selagi senarai main itu diterbitkan di mana-mana: ralat menyenaraikan tugasan yang perlu dialih keluar dahulu (display_schedule_write delete). Memerlukan playlistId. Meminta pengesahan.

Meletakkan kandungan pada Display Screens: item media, senarai main, aplikasi, halaman web, aplikasi Ejen AI atau paparan langsung CCTV, pada skrin, kumpulan, kemudahan, jenamanya atau organisasinya.

mode: now (lalai) menggantikan perkara yang biasanya dipaparkan oleh sasaran; scheduled memaparkannya hanya dalam tetingkap mingguan (zon waktu kemudahan) dan/atau antara from dan to; takeover mengganggu segala-galanya selama durationMin (atau sehingga suatu masa), kemudian tamat dengan sendirinya (hentikan lebih awal dengan display_takeover_stop). Skrin menentukan perkara yang hendak dipaparkan mengikut lapisan (takeover > scheduled > default), kemudian mengikut sejauh mana sasaran itu khusus (screen > group > facility > brand > organisation).

CCTV: suapan kamera langsung boleh dilihat oleh sesiapa sahaja yang berada berhampiran skrin. Panggilan pertama mengembalikan requiresConfirmation (kod CCTV_CONFIRMATION_REQUIRED); tanya pengguna, kemudian panggil semula dengan confirmCctv: true. Kemudahan mesti menghidupkan "Allow CCTV on display screens".

Hanya skrin dalam mod player yang memaparkan kandungan yang diterbitkan; skrin lain disenaraikan dalam warnings. Mengembalikan batchId; display_schedule_write delete dengannya membatalkan keseluruhan penerbitan. Apabila beberapa skrin, kumpulan atau sasaran diberikan, alat ini bertindak ke atas kesemuanya dalam satu panggilan; semak dengan pengguna sebelum bertindak ke atas banyak item.

Membaca perkara yang diterbitkan kepada Display Screens: bagi satu skrin, perkara yang dipaparkannya pada suatu masa dan sepanjang suatu julat (diselesaikan merentas setiap lapisan dan sasaran yang diwarisinya) serta tugasan yang sampai kepadanya; atau tugasan yang diterbitkan kepada kumpulan, kemudahan, jenamanya atau organisasinya.

Id tugasan (as_…) dan id kelompok (bt_…) ialah perkara yang dikemas kini atau dipadamkan oleh display_schedule_write. Masa dalam format ISO; tetingkap dalam zon waktu kemudahan.

Tindakan:

• get: Dapatkan jadual skrin. Perkara yang dipaparkan skrin pada at (lalai sekarang), garis masanya dari from hingga to (lalai 24 jam), dan setiap tugasan yang sampai kepadanya. Memerlukan screenId.
• list_assignments: Senaraikan tugasan. Tugasan yang diterbitkan kepada kumpulan (groupId), atau kepada kemudahan, jenamanya atau organisasinya (target, lalai facility). Berhalaman, perubahan terbaharu dahulu.

Mengubah perkara yang diterbitkan kepada Display Screens: mengedit masa, keutamaan atau kandungan sesuatu tugasan (secara pilihan merentas keseluruhan penerbitannya), atau mengalih keluar satu tugasan atau keseluruhan penerbitan. Cari id dengan display_schedule_read. Mengalih keluar kandungan daripada jadual mengekalkannya dalam pustaka; untuk menamatkan takeover lebih awal tetapi mengekalkan sejarahnya, gunakan display_takeover_stop.

Tindakan:

• update: Kemas kini tugasan. Mengubah masa (tetingkap mingguan, from/to; null mengosongkan tarikh), keutamaan atau kandungan sesuatu tugasan. applyToBatch membuat perubahan yang sama pada setiap sasaran penerbitan. Takeover hanya boleh diberikan masa tamat baharu. Kandungan CCTV memerlukan confirmCctv selepas pengguna bersetuju. Memerlukan assignmentId.
• delete: Alih keluar daripada jadual. Mengalih keluar satu tugasan (assignmentId) atau segala-galanya daripada satu penerbitan (batchId). Skrin kembali kepada perkara yang sepatutnya dipaparkan dalam beberapa saat. Meminta pengesahan.

Menghantar arahan langsung kepada Display Screens di sesebuah kemudahan: reload (skrin player mengambil semula jadualnya), identify (memancarkan nama dan kod skrin, untuk mencarinya di premis), displayOn/displayOff (panel TV), rebootDevice (memulakan semula komputer skrin, kosong selama 1–2 minit; memerlukan confirm: true) atau osd (mesej ringkas pada skrin; hantar message).

Pilih skrin dengan screenIds dan/atau groupIds (setiap skrin dalam kumpulan tersebut di kemudahan itu), atau allScreens: true untuk setiap skrin di kemudahan itu (displayOn/displayOff kemudian turut sampai ke skrin templated content). Mengembalikan keputusan bagi setiap skrin. Apabila beberapa skrin, kumpulan atau sasaran diberikan, alat ini bertindak ke atas kesemuanya dalam satu panggilan; semak dengan pengguna sebelum bertindak ke atas banyak item.

Membaca Display Screens sesebuah kemudahan: menyenaraikannya bersama status dan perkara yang dipaparkan sekarang dan seterusnya (tapis mengikut kumpulan, status atau mod paparan), mendapatkan butiran penuh dan garis masa satu skrin, atau menyenaraikan kumpulan skrin bersama skrinnya.

Mod paparan ditunjukkan kepada pengguna sebagai "Data Source": player ialah "User managed content", program-builder ialah "Templated content" (jangan sekali-kali gunakan nama lama modul itu kepada pengguna), url ialah "Full-page website (Kiosk Mode)". Masa dalam format ISO; zon waktu kemudahan turut dikembalikan.

Tindakan:

• list: Senaraikan skrin. Skrin di kemudahan itu (berhalaman), setiap satu dengan status, degupan jantung terakhir, kumpulan, tag dan perkara yang dipaparkan sekarang dan seterusnya. Turut mengembalikan kumpulan.
• get: Dapatkan skrin. Butiran penuh satu skrin (status, degupan jantung, versi player, ralat terkini) dan, bagi skrin player, perkara yang dipaparkannya sepanjang suatu julat masa (lalai 24 jam seterusnya, maksimum 14 hari). Memerlukan screenId.
• groups: Senaraikan kumpulan skrin. Kumpulan skrin di kemudahan itu (berhalaman), setiap satu dengan skrinnya.

Mengubah Display Screens: memasangkan skrin baharu menggunakan kod pasangannya; menamakan semula skrin, menetapkan kumpulan dan tagnya, atau menukar mod paparannya (ditunjukkan kepada pengguna sebagai "Data Source"); menukar token skrin player; membuat pautan pratonton terhad masa bagi skrin atau kandungan; atau menetapkan semula skrin kepada tetapan kilang (mengalih keluarnya daripada kemudahan).

Mod paparan: player ("User managed content"), url ("Full-page website (Kiosk Mode)", hantar url, https sahaja), program-builder ("Templated content"; jangan sekali-kali gunakan nama lama modul itu kepada pengguna). Menukar mod memuat semula skrin serta-merta dan mengubah perkara yang dilihat oleh ahli, jadi pengguna perlu mengesahkannya.

Tindakan:

• update: Kemas kini skrin. Menetapkan nama skrin, kumpulan (id atau nama; menggantikan kumpulan semasa), tag (menggantikannya) dan/atau mod paparan. Perubahan mod mengembalikan requiresConfirmation terlebih dahulu. Memerlukan screenId. Mungkin meminta pengesahan.
• rotate_token: Tukar token skrin. Mengeluarkan token baharu untuk skrin player dan memuat semulanya; token lama berhenti berfungsi. Gunakan apabila URL player sesuatu skrin mungkin telah bocor. Memerlukan screenId. Meminta pengesahan.
• create_preview_link: Cipta pautan pratonton. Pautan (sah untuk tempoh terhad) yang menunjukkan perkara yang dipaparkan oleh skrin, atau rupa kandungan, secara pilihan pada masa hadapan. Sesiapa sahaja yang mempunyai pautan itu boleh melihatnya sehingga pautan tamat tempoh.
• reset: Tetapkan semula skrin kepada tetapan kilang. Mengalih keluar skrin daripada kemudahan dan menetapkannya semula kepada tetapan kilang; skrin yang dimatikan akan ditetapkan semula apabila ia dalam talian semula, kemudian memaparkan halaman pasangannya. Hantar confirmName: nama skrin tepat seperti yang ditaip oleh pengguna. Memerlukan Pengurusan Peranti. Memerlukan screenId, confirmName. Meminta pengesahan.
• pair: Pasangkan skrin baharu. Menambah skrin baharu kepada kemudahan menggunakan kod 6 aksara pada halaman pasangannya, kemudian memuat semulanya. Kemudahan yang hanya mempunyai Display Screens memulakannya dalam mod player; jika turut mempunyai templated content, mode menentukan pilihannya (lalai program-builder). Memerlukan Pengurusan Peranti. Memerlukan pairingCode, name. Meminta pengesahan.

Menangkap perkara yang sedang dipaparkan oleh Display Screen dan mengembalikan imejnya, supaya Anda boleh menyemak hasil kerja sendiri selepas menerbitkan (susun atur, saiz teks, tiada yang terpotong atau menatal). Menunggu sehingga 15 saat untuk skrin menjawab; skrin luar talian akan tamat masa. Turut mengembalikan URL portal untuk JPEG tersebut (pengguna yang log masuk sahaja, disimpan selama 10 minit).

Tangkapan skrin boleh mengandungi CCTV langsung dan ahli yang kelihatan; jangan kongsikannya di luar perbualan.

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 tetapan Display Screens sesebuah kemudahan: fallback slate, tinjauan dan muat semula malam, dan "Allow CCTV on display screens"; jadual kuasa skrin; dan automasi (kecerahan, kelantangan loceng, kuasa daftar masuk). Medan yang Anda tinggalkan mengekalkan nilai semasanya. Tetapan seluruh jenama (boot screen, templated content) terdapat dalam display_brand_settings_write.

Tindakan:

• save_settings: Simpan tetapan paparan kemudahan. Fallback slate yang dipaparkan apabila tiada apa-apa yang dijadualkan, selang tinjauan (30–300 s), masa muat semula malam (HH:mm) dan allowCctv. Menghidupkan allowCctv memerlukan pengesahan pengguna dan pentadbir kemudahan yang mempunyai akses CCTV. Mungkin meminta pengesahan.
• save_power_schedule: Simpan jadual kuasa. Mengubah bila skrin dihidupkan dan dimatikan; medan yang Anda hantar digabungkan ke dalam jadual yang disimpan. Mengembalikan masa hidup/mati bagi 7 hari seterusnya. Semak dengan display_settings_read power_schedule_preview terlebih dahulu. Memerlukan schedule.
• save_automations: Simpan automasi paparan. Mengubah tetapan kecerahan automatik, kelantangan loceng dan kuasa daftar masuk. Kemudahan kemudian mengekalkan tetapannya sendiri dan bukannya lalai global.

Menamatkan takeover Display Screens yang sedang berjalan serta-merta: bagi satu penerbitan (batchId daripada display_publish), bagi sasaran (lalai: takeover yang diterbitkan kepada keseluruhan kemudahan), atau dengan allScreens bagi setiap takeover yang diterbitkan kepada kemudahan, skrinnya atau kumpulannya. Takeover jenama dan organisasi hanya dihentikan melalui batchId. Skrin kembali kepada kandungan berjadual atau lalai dalam beberapa saat; mengembalikan bilangan takeover yang dihentikan. Apabila beberapa skrin, kumpulan atau sasaran diberikan, alat ini bertindak ke atas kesemuanya dalam satu panggilan; semak dengan pengguna sebelum bertindak ke atas banyak item.

Mengawal skrin templated content (mod paparan "Templated content" dalam display_screens_read): memuatkan program latihan bagi sesuatu hari pada skrin tersebut, atau mengawal pemasa pusingan. Skrin User managed content dan laman web halaman penuh tidak pernah terjejas.

Tindakan:

• load_program: Muatkan program latihan. Memuatkan program latihan bagi sesuatu tarikh (YYYY-MM-DD, lalai hari ini) daripada sumber data kemudahan pada setiap skrin templated content di satu atau beberapa kemudahan; skrin dimuat semula dalam beberapa saat. Gunakannya untuk memaparkan latihan hari ini atau hari lain, atau apabila skrin memaparkan latihan yang salah. Beberapa kemudahan memerlukan confirm. Mungkin meminta pengesahan.
• clock: Kawal pemasa pusingan. Memainkan, menjeda, memulakan semula atau menghentikan pemasa pusingan pada skrin templated content, membisukan atau menyahbisukan bunyi pusingan, menetapkan kelantangan loceng (setvolume dengan volume 0–100) atau meminta keadaannya. Memerlukan templated content di kemudahan tersebut. Memerlukan command.