หน้าจอแสดงผล
แพลตฟอร์มหลักdisplay_brand_settings_writeหน้าจอแสดงผล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.
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "save_boot_screen" | "reset_boot_screen" | "save_screen_defaults" | "save_templated" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
imageUrl | string | URL แบบ https สาธารณะของรูปภาพ (save_boot_screen) |
imageBase64 | string | รูปภาพในรูปแบบ base64 เมื่อไม่มี URL (save_boot_screen) |
fit | "logo" | "fill" | (save_boot_screen) |
background | string | สีพื้นหลัง (#RRGGBB) (save_boot_screen) |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
orientation | "normal" | "left" | "right" | "inverted" | Screen rotation (save_screen_defaults) |
airplayEnabled | boolean | Screens accept AirPlay (save_screen_defaults) |
sessionTimerEnabled | boolean | Synchronised session timer (master clock) and its bells (save_screen_defaults) |
sonosEnabled | boolean | Sonos speaker control (save_screen_defaults) |
duressEnabled | boolean | Bluetooth duress button monitoring (save_screen_defaults) |
cameraRestreamingEnabled | boolean | Restream local camera feeds from the screen (save_screen_defaults) |
wifiSupport | boolean | Captive Wi-Fi setup portal (save_screen_defaults) |
showSourceName | boolean | (save_templated) |
showWorkoutNames | boolean | (save_templated) |
showProgramsInSchedule | boolean | (save_templated) |
programLookaheadDays | integernull | จำนวนวันล่วงหน้า (0–90) หรือ null หากไม่จำกัด (save_templated) |
showTrainingPhases | boolean | (save_templated) |
phaseLookaheadDays | integernull | จำนวนวันล่วงหน้า (0–90) หรือ null หากไม่จำกัด (save_templated) |
showTrainingCamps | boolean | (save_templated) |
campLookaheadDays | integernull | จำนวนวันล่วงหน้า (0–90) หรือ null หากไม่จำกัด (save_templated) |
confirm | boolean | ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันตัวอย่างที่ได้จากการเรียกครั้งแรกแล้วเท่านั้น |
display_groups_writeหน้าจอแสดงผลสร้าง เปลี่ยนชื่อ และลบกลุ่ม Display Screen ที่สถานที่ และกำหนดว่าหน้าจอใดอยู่ในกลุ่ม กลุ่มเป็นเป้าหมายการเผยแพร่ (display_publish targets.groupIds) และเป้าหมายคำสั่ง (display_screen_command groupIds) เมื่อระบุหลายหน้าจอ หลายกลุ่ม หรือหลายเป้าหมาย เครื่องมือนี้จะดำเนินการกับทั้งหมดในการเรียกครั้งเดียว โปรดสอบถามผู้ใช้ก่อนดำเนินการกับรายการจำนวนมาก
การดำเนินการ:
- save: บันทึกกลุ่ม สร้าง: name (และ screenIds หากต้องการ) เปลี่ยนชื่อ: groupId (ID หรือชื่อปัจจุบัน) และ name โดย screenIds จะแทนที่สมาชิกเดิม หน้าจอที่ไม่อยู่ในรายการจะออกจากกลุ่มนี้แต่ยังคงอยู่ในกลุ่มอื่น ๆ
- delete: ลบกลุ่ม ลบกลุ่มหนึ่ง หน้าจอในกลุ่มจะออกจากกลุ่ม (แต่ยังคงอยู่ในกลุ่มอื่น ๆ) และเนื้อหาที่เผยแพร่ไปยังกลุ่มจะถูกนำออกจากกำหนดการ ต้องระบุ groupId จะขอการยืนยัน
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "save" | "delete" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
groupId | string | ID หรือชื่อของกลุ่มที่มีอยู่ เพื่อเปลี่ยนชื่อหรือเปลี่ยนสมาชิก |
name | string | ชื่อกลุ่ม (จำเป็นเมื่อสร้าง) (save) |
screenIds | array | หน้าจอในกลุ่ม จะแทนที่สมาชิกปัจจุบัน (save) |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
confirm | boolean | ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันตัวอย่างที่ได้จากการเรียกครั้งแรกแล้วเท่านั้น |
display_hosted_apps_writeหน้าจอแสดงผลเผยแพร่แอป HTML แบบสแตติก ("แอปที่โฮสต์") สำหรับ Display Screens เรียก display_library_read app_guidelines ก่อนเพื่อดูขนาดหน้าจอ กฎการออกแบบ ข้อจำกัด และ SDK แล้วเรียก display_screenshot หลังจากนั้นเพื่อตรวจสอบผลลัพธ์บนหน้าจอ เมื่อระบุหลายหน้าจอ หลายกลุ่ม หรือหลายเป้าหมาย เครื่องมือนี้จะดำเนินการกับทั้งหมดในการเรียกครั้งเดียว โปรดสอบถามผู้ใช้ก่อนดำเนินการกับรายการจำนวนมาก
การดำเนินการ:
- publish: เผยแพร่แอปที่โฮสต์ สร้างแอปที่โฮสต์ (name + files) หรือเผยแพร่เวอร์ชันใหม่ (appId + files โดยเวอร์ชันใหม่จะเริ่มใช้งานทุกที่ที่แสดงแอปนี้ และ rollback จะยกเลิกได้) publishTo จะนำแอปขึ้นหน้าจอด้วย เช่นเดียวกับ display_publish หากเป้าหมายเป็นแบรนด์หรือองค์กรต้องใช้ confirm ต้องระบุ files อาจขอการยืนยัน
- rollback: ย้อนกลับแอปที่โฮสต์ ทำให้เวอร์ชันก่อนหน้ากลับมาเป็นเวอร์ชันปัจจุบันอีกครั้งในทุกที่ที่แสดงแอปนี้ ดูรายการเวอร์ชันได้ด้วย display_library_read app_versions ต้องระบุ appId, version
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "publish" | "rollback" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
appId | string | ID ของแอปที่โฮสต์ที่มีอยู่ (app_…) ที่จะเผยแพร่เวอร์ชันใหม่ |
name | string | ชื่อแอป (จำเป็นเมื่อสร้าง) (publish) |
files | array | ไฟล์ของแอป encoding เป็น utf8 (ค่าเริ่มต้น) หรือ base64 สำหรับไฟล์ไบนารี (publish) |
entry | string | ไฟล์ HTML หลัก (ค่าเริ่มต้น index.html) (publish) |
durationSec | number | เวลาแสดงบนหน้าจอเริ่มต้นในเพลย์ลิสต์ เป็นวินาที (publish) |
tags | array | (publish) |
ownerScope | "facility" | "brand" | "organisation" | ผู้เป็นเจ้าของเนื้อหาใหม่ (ค่าเริ่มต้น facility) โดย brand และ organisation ต้องมีสิทธิ์เข้าถึงทั้งองค์กร (publish) |
publishTo | object | (publish) |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
version | integer | เวอร์ชันที่จะตั้งเป็นเวอร์ชันปัจจุบัน (rollback) |
confirm | boolean | ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันตัวอย่างที่ได้จากการเรียกครั้งแรกแล้วเท่านั้น |
display_library_readหน้าจอแสดงผลอ่านคลังเนื้อหาของ Display Screens ที่สถานที่มองเห็นได้ ได้แก่ สื่อ (รูปภาพ วิดีโอ) แอป (หน้าเว็บ แอป HTML ที่โฮสต์ แอป AI Agent มุมมองกล้องวงจรปิด) และเพลย์ลิสต์ รวมถึงแอป AI Agent และแหล่งกล้องวงจรปิดที่เพิ่มได้
แต่ละรายการมี contentRef (media#…, app#…, playlist#…) สำหรับ display_publish และเพลย์ลิสต์ ownerScope แสดงผู้เป็นเจ้าของ (facility#, brand# หรือ org#) และเนื้อหาจะเผยแพร่ได้เฉพาะภายในขอบเขตของเจ้าของเท่านั้น สื่อที่มีสถานะ processing ยังไม่พร้อมใช้งาน ส่วน failed ต้องอัปโหลดใหม่ หน้าเว็บที่มี frameable: false จะเล่นในเพลย์ลิสต์ไม่ได้ แสดงได้เฉพาะเป็นหน้าจอแบบเต็มหน้าเท่านั้น หน้าจอจะข้ามรายการที่มี displayIssue ได้แก่ แอป AI Agent ที่ยังไม่เผยแพร่ หยุดชั่วคราว ปิดการแสดงผล จำกัดผู้ชม หรือไม่มี Custom Apps และมุมมองกล้องวงจรปิดที่เป็น no-cctv, cctv-off (ผู้ดูแลสถานที่เปิดกล้องวงจรปิดสำหรับหน้าจอได้ในการตั้งค่า Display Screens) หรือ no-cameras
การดำเนินการ:
- list: แสดงรายการในคลัง สื่อและแอป (แบ่งหน้า กรองตาม type, kind, tag หรือ name) หรือเมื่อใช้ type agent-apps จะแสดงแอป AI Agent ที่อนุญาตบนหน้าจอซึ่งคุณเผยแพร่ได้ด้วย display_publish content.agentAppId แต่ละรายการมี type ได้แก่ media, app หรือ agent-app
- cctv_sources: แสดงรายการแหล่งกล้องวงจรปิด กล้องของสถานที่และ Live Views ที่แชร์สำหรับ display_publish content.cctv และสถานะว่าเปิดกล้องวงจรปิดบนหน้าจออยู่หรือไม่ ต้องมีสิทธิ์เข้าถึงกล้องวงจรปิดที่สถานที่
- get: ดูรายการในคลัง สื่อ แอป หรือเพลย์ลิสต์หนึ่งรายการตาม contentRef ต้องระบุ contentRef
- usages: ตำแหน่งที่ใช้เนื้อหา การกำหนดในกำหนดการที่ใช้งานอยู่และเพลย์ลิสต์ที่ใช้สื่อหรือแอปนั้น (หรือการกำหนดของเพลย์ลิสต์) เนื้อหาที่กำลังใช้งานจะลบไม่ได้ ต้องระบุ contentRef
- app_versions: แสดงรายการเวอร์ชันของแอปที่โฮสต์ เวอร์ชันของแอปที่โฮสต์และเวอร์ชันที่เป็นปัจจุบัน สำหรับ display_hosted_apps_write rollback ต้องระบุ appId
- app_guidelines: แนวทางสำหรับแอปที่โฮสต์ ขนาดหน้าจอ กฎการออกแบบ ข้อจำกัดของบันเดิล Display App SDK และเทมเพลตเริ่มต้น เรียกใช้ก่อนสร้างแอปสำหรับ display_hosted_apps_write publish
- check_url: ตรวจสอบหน้าเว็บ ตรวจว่าหน้าเว็บแสดงภายในเพลย์ลิสต์ได้หรือไม่ (บางเว็บไซต์ไม่อนุญาตให้แสดงในเฟรม) พร้อมคำแนะนำเกี่ยวกับลักษณะการแสดงผล หน้าที่ไม่อนุญาตให้แสดงในเฟรมยังคงใช้เป็นหน้าจอแบบเต็มหน้าได้ ต้องระบุ url
- playlists: แสดงรายการเพลย์ลิสต์ เพลย์ลิสต์ที่สถานที่มองเห็นได้ (แบ่งหน้า) แต่ละรายการพร้อมรายการย่อย (contentRef, duration, fit)
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "list" | "cctv_sources" | "get" | "usages" | "app_versions" | "app_guidelines" | "check_url" | "playlists" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
type | "media" | "apps" | "agent-apps" | เฉพาะรายการประเภทเดียว (ค่าเริ่มต้น: สื่อและแอป) (list) |
kind | "image" | "video" | "url" | "hosted" | "agent-app" | "cctv-view" | (list) |
tag | string | เฉพาะรายการที่มีแท็กนี้ (list) |
search | string | ตัวกรองชื่อที่ไม่คำนึงถึงตัวพิมพ์เล็กใหญ่ (list) |
limit | integer | จำนวนรายการต่อหน้า (ค่าเริ่มต้น 25 สูงสุด 100) (list, playlists) |
cursor | string | nextCursor จากหน้าก่อนหน้า (list, playlists) |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ (list, cctv_sources, get, usages, app_versions, check_url, playlists) |
contentRef | string | media#<id>, app#<id> หรือ playlist#<id> จาก display_library_read list หรือ playlists (get, usages) |
appId | string | ID ของแอปที่โฮสต์ (app_…) (app_versions) |
url | string | URL แบบ https สาธารณะ (check_url) |
display_library_writeหน้าจอแสดงผลเพิ่มและเปลี่ยนเนื้อหาในคลังของ Display Screens ได้แก่ อัปโหลดรูปภาพและวิดีโอ สร้างแอปหน้าเว็บ แอป AI Agent และแอปมุมมองกล้องวงจรปิด แก้ไขชื่อ แท็ก ระยะเวลา และวันที่ ลบรายการที่ไม่ได้ใช้งาน และรีเฟรชตัวอย่างของแอป แอป HTML ที่โฮสต์เผยแพร่ด้วย display_hosted_apps_write ส่วนเพลย์ลิสต์ใช้ display_playlists_write
ออกแบบรูปภาพที่ขนาด 1920×1080 (แนวนอน) หรือ 1080×1920 (แนวตั้ง) สื่อใหม่จะเริ่มต้นด้วยสถานะ processing ขณะสร้างเวอร์ชันที่พร้อมสำหรับเว็บ โดยใส่ลงในเพลย์ลิสต์ได้ทันทีและจะเล่นเมื่อพร้อม ownerScope: facility (ค่าเริ่มต้น), brand หรือ organisation (brand และ organisation ต้องมีสิทธิ์เข้าถึงทั้งองค์กร)
การดำเนินการ:
- upload_media: อัปโหลดรูปภาพหรือวิดีโอ เพิ่มรูปภาพหรือวิดีโอจาก url แบบ https สาธารณะ (แนะนำ รูปภาพไม่เกิน 25 MB วิดีโอไม่เกิน 200 MB) หรือ base64 พร้อม mimeType (ไม่เกิน 20 MB) รองรับรูปภาพ JPEG, PNG, WebP, GIF และวิดีโอ MP4, WebM, MOV (แปลงเป็น H.264 MP4 สูงสุด 1080p) สำหรับวิดีโอขนาดใหญ่กว่านี้ ใช้ create_video_upload
- create_video_upload: เริ่มอัปโหลดวิดีโอขนาดใหญ่ สำหรับวิดีโอไม่เกิน 2 GB: บันทึกวิดีโอและส่งคืนการอัปโหลดแบบ presigned (PUT ไฟล์ไปยัง upload.url พร้อม upload.headers ก่อน upload.expiresAt) จากนั้นเรียก transcode ด้วย contentRef ของวิดีโอนั้น ต้องระบุ name, mimeType, bytes
- transcode: ประมวลผลวิดีโอ แปลงวิดีโอสำหรับหน้าจอ: หลัง create_video_upload เมื่อลองใหม่หลังจากล้มเหลว หรือสำหรับวิดีโอเก่าที่หน้าจอเล่นไม่ได้ ต้องระบุ contentRef
- create_app: เพิ่มแอป เพิ่มหน้าเว็บ (kind url ระบุ url และจะตรวจสอบการแสดงในเฟรม) แอป AI Agent (kind agent-app ระบุ agentAppId จาก display_library_read list type agent-apps) หรือมุมมองกล้องวงจรปิด (kind cctv-view เป็นของสถานที่ และต้องมีสิทธิ์เข้าถึงกล้องวงจรปิด) ต้องระบุ kind, name
- update: อัปเดตรายการในคลัง เปลี่ยนชื่อ แท็ก หรือระยะเวลาของสื่อหรือแอป validFrom/validTo ของสื่อ (ISO, null คือล้างค่า และนอกช่วงนี้จะถูกข้าม) url ของหน้าเว็บ หรือกล้อง มุมมอง เลย์เอาต์ หรือคุณภาพของมุมมองกล้องวงจรปิด ต้องระบุ contentRef
- delete: ลบรายการในคลัง ลบสื่อหรือแอป จะลบไม่ได้ขณะที่อยู่ในกำหนดการที่ใช้งานอยู่หรือเพลย์ลิสต์ โดยข้อผิดพลาดจะแสดงรายการเหล่านั้น (นำออกด้วย display_schedule_write delete หรือ display_playlists_write save ก่อน) ต้องระบุ contentRef จะขอการยืนยัน
- refresh_preview: รีเฟรชตัวอย่างของแอป ถ่ายภาพหน้าจอใหม่ของแอปสำหรับตัวอย่างในคลัง (เช่น หลังจากหน้าเว็บเปลี่ยนแปลง) ต้องระบุ contentRef
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "upload_media" | "create_video_upload" | "transcode" | "create_app" | "update" | "delete" | "refresh_preview" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
url | string | URL แบบ https สาธารณะของรูปภาพหรือวิดีโอ (แนะนำ) (upload_media, create_app, update) |
base64 | string | เนื้อหาไฟล์ในรูปแบบ base64 (สูงสุด 20 MB) เมื่อไม่มี URL (upload_media) |
mimeType | string | จำเป็นเมื่อใช้ base64 เช่น image/png (upload_media, create_video_upload) |
name | string | ชื่อในคลัง (upload_media, create_video_upload, create_app, update) |
tags | array | แท็ก (แทนที่แท็กปัจจุบัน) (upload_media, create_video_upload, create_app, update) |
ownerScope | "facility" | "brand" | "organisation" | ผู้เป็นเจ้าของเนื้อหาใหม่ (ค่าเริ่มต้น facility) โดย brand และ organisation ต้องมีสิทธิ์เข้าถึงทั้งองค์กร (upload_media, create_video_upload, create_app) |
durationSec | number | เวลาแสดงบนหน้าจอเริ่มต้นสำหรับรูปภาพ เป็นวินาที (upload_media, create_app, update) |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
bytes | integer | ขนาดไฟล์เป็นไบต์ (create_video_upload) |
resolution | "720" | "1080" | "1440" | "2160" | "original" | ขนาดสูงสุดที่จะแปลงวิดีโอสำหรับหน้าจอ (ค่าเริ่มต้น 1080 ส่วน original จะคงขนาดเดิม) (create_video_upload, transcode) |
contentRef | string | media#<id>, app#<id> หรือ playlist#<id> จาก display_library_read list หรือ playlists (transcode, update, delete, refresh_preview) |
kind | "url" | "agent-app" | "cctv-view" | (create_app) |
agentAppId | string | แอป AI Agent: ID ของแอป (create_app) |
source | "view" | "cameras" | มุมมองกล้องวงจรปิด: view (ระบุ viewId) หรือ cameras (ระบุ cameras) (create_app, update) |
viewId | string | มุมมองกล้องวงจรปิด: ID ของ Live View (display_library_read cctv_sources) (create_app, update) |
cameras | array | มุมมองกล้องวงจรปิด: ID ของกล้อง (display_library_read cctv_sources) (create_app, update) |
layout | "auto" | "1x1" | "2x1" | "1+2" | "2x2" | "1+5" | "2x3" | "3x3" | มุมมองกล้องวงจรปิด: เลย์เอาต์ของช่องภาพ (create_app, update) |
quality | "auto" | "native" | "1080p" | "720p" | "480p" | "360p" | "240p" | มุมมองกล้องวงจรปิด: คุณภาพสตรีม (create_app, update) |
showNames | boolean | มุมมองกล้องวงจรปิด: แสดงชื่อกล้องบนช่องภาพ (create_app, update) |
validFrom | stringnull | สื่อ: วันที่และเวลาแบบ ISO ที่เริ่มเล่น null คือล้างค่า (update) |
validTo | stringnull | สื่อ: วันที่และเวลาแบบ ISO ที่หยุดเล่น null คือล้างค่า (update) |
confirm | boolean | ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันตัวอย่างที่ได้จากการเรียกครั้งแรกแล้วเท่านั้น |
display_playlists_writeหน้าจอแสดงผลสร้าง อัปเดต และลบเพลย์ลิสต์ของ Display Screens ซึ่งเป็นการวนเล่นสื่อและแอปตามลำดับ การเปลี่ยนแปลงจะไปถึงทุกหน้าจอที่แสดงเพลย์ลิสต์ภายในไม่กี่วินาที เผยแพร่เพลย์ลิสต์ด้วย display_publish content.contentRef "playlist#
การดำเนินการ:
- save: บันทึกเพลย์ลิสต์ สร้าง: name + items (items เว้นว่างได้) อัปเดต: playlistId + name, items หรือ transition อย่างใดก็ได้ โดย items จะแทนที่รายการทั้งหมด จึงต้องส่งทุกรายการตามลำดับ
- delete: ลบเพลย์ลิสต์ ลบเพลย์ลิสต์หนึ่ง จะลบไม่ได้ขณะที่เผยแพร่อยู่ที่ใดก็ตาม โดยข้อผิดพลาดจะแสดงการกำหนดที่ต้องนำออกก่อน (display_schedule_write delete) ต้องระบุ playlistId จะขอการยืนยัน
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "save" | "delete" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
playlistId | string | ID ของเพลย์ลิสต์ที่มีอยู่ (pl_…) ที่จะอัปเดต |
name | string | ชื่อเพลย์ลิสต์ (จำเป็นเมื่อสร้าง) (save) |
transition | "fade" | "none" | (save) |
ownerScope | "facility" | "brand" | "organisation" | ผู้เป็นเจ้าของเนื้อหาใหม่ (ค่าเริ่มต้น facility) โดย brand และ organisation ต้องมีสิทธิ์เข้าถึงทั้งองค์กร (save) |
items | array | รายการทั้งหมดตามลำดับ (แทนที่รายการปัจจุบัน และคง itemId ไว้เพื่อเก็บรายการนั้น) หน้าเว็บที่มี frameable: false จะไม่เล่น (save) |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
confirm | boolean | ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันตัวอย่างที่ได้จากการเรียกครั้งแรกแล้วเท่านั้น |
display_publishหน้าจอแสดงผลนำเนื้อหาขึ้น Display Screens ได้แก่ สื่อ เพลย์ลิสต์ แอป หน้าเว็บ แอป AI Agent หรือภาพสดจากกล้องวงจรปิด ไปยังหน้าจอ กลุ่ม สถานที่ แบรนด์ หรือองค์กรของสถานที่
mode: now (ค่าเริ่มต้น) แทนที่สิ่งที่เป้าหมายแสดงตามปกติ scheduled แสดงเฉพาะในช่วงเวลารายสัปดาห์ (เขตเวลาของสถานที่) และ/หรือระหว่าง from และ to ส่วน takeover ขัดจังหวะทุกอย่างเป็นเวลา durationMin (หรือจนถึงเวลาที่กำหนด) แล้วสิ้นสุดเอง (หยุดก่อนเวลาได้ด้วย display_takeover_stop) หน้าจอจะตัดสินว่าจะแสดงอะไรตามชั้น (takeover > scheduled > default) จากนั้นตามความเฉพาะเจาะจงของเป้าหมาย (screen > group > facility > brand > organisation)
กล้องวงจรปิด: ภาพสดจากกล้องจะมองเห็นได้โดยทุกคนที่อยู่ใกล้หน้าจอ การเรียกครั้งแรกจะส่งคืน requiresConfirmation (รหัส CCTV_CONFIRMATION_REQUIRED) ให้สอบถามผู้ใช้ แล้วเรียกอีกครั้งด้วย confirmCctv: true สถานที่ต้องเปิด "Allow CCTV on display screens" ไว้
เฉพาะหน้าจอในโหมด player เท่านั้นที่แสดงเนื้อหาที่เผยแพร่ หน้าจออื่นจะแสดงอยู่ใน warnings ส่งคืน batchId ซึ่งใช้กับ display_schedule_write delete เพื่อยกเลิกการเผยแพร่ทั้งหมดได้ เมื่อระบุหลายหน้าจอ หลายกลุ่ม หรือหลายเป้าหมาย เครื่องมือนี้จะดำเนินการกับทั้งหมดในการเรียกครั้งเดียว โปรดสอบถามผู้ใช้ก่อนดำเนินการกับรายการจำนวนมาก
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
targets* | object | ปลายทางของเนื้อหา ใช้ร่วมกันได้หลายรายการ ใช้ชื่อกลุ่มแทน ID ได้ brand และ organisation ต้องมีสิทธิ์เข้าถึง Display Screens ทั้งองค์กร |
content* | object | สิ่งที่จะแสดง: ระบุ contentRef, url, agentAppId หรือ cctv เพียงอย่างเดียวเท่านั้น |
mode | "now" | "default" | "scheduled" | "takeover" | `now`/`default` (ค่าเริ่มต้น): แทนที่สิ่งที่เป้าหมายแสดงตามปกติ `scheduled`: เฉพาะในช่วงเวลาที่กำหนด และ/หรือระหว่าง from และ to `takeover`: ขัดจังหวะทุกอย่างเป็นเวลา durationMin (หรือจนถึงเวลาที่กำหนด) แล้วสิ้นสุดเอง |
windows | array | ช่วงเวลารายสัปดาห์ตามเขตเวลาของสถานที่ days เป็นวันในสัปดาห์แบบ ISO (1 = วันจันทร์ … 7 = วันอาทิตย์) ส่วน start/end อยู่ในรูปแบบ "HH:MM" (end ใช้ "24:00" ได้) |
from | string | วันที่และเวลาแบบ ISO ที่การเผยแพร่ตามกำหนดการเริ่มต้น |
to | string | วันที่และเวลาแบบ ISO ที่การเผยแพร่ตามกำหนดการสิ้นสุด |
durationMin | number | ระยะเวลา Takeover เป็นนาที (สูงสุด 7 วัน) |
until | string | วันที่และเวลาแบบ ISO ที่ Takeover สิ้นสุด (ใช้แทน durationMin) |
priority | integer | ตัดสินระหว่างรายการตามกำหนดการที่ทับซ้อนกัน (ค่าสูงกว่าจะได้แสดง) |
confirmCctv | boolean | ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันอย่างชัดเจนให้แสดงภาพสดจากกล้องวงจรปิดแล้วเท่านั้น |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
confirm | boolean | ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันตัวอย่างที่ได้จากการเรียกครั้งแรกแล้วเท่านั้น |
display_schedule_readหน้าจอแสดงผลอ่านสิ่งที่เผยแพร่ไปยัง Display Screens: สำหรับหน้าจอหนึ่ง คือสิ่งที่แสดง ณ เวลาหนึ่งและตลอดช่วงเวลา (ตัดสินจากทุกชั้นและทุกเป้าหมายที่หน้าจอสืบทอดมา) พร้อมการกำหนดที่ไปถึงหน้าจอนั้น หรือการกำหนดที่เผยแพร่ไปยังกลุ่ม สถานที่ แบรนด์ หรือองค์กรของสถานที่
ID ของการกำหนด (as_…) และ ID ของชุด (bt_…) คือสิ่งที่ display_schedule_write ใช้อัปเดตหรือลบ เวลาเป็นแบบ ISO และช่วงเวลาอิงตามเขตเวลาของสถานที่
การดำเนินการ:
- get: ดูกำหนดการของหน้าจอ สิ่งที่หน้าจอแสดง ณ
at(ค่าเริ่มต้นคือตอนนี้) ไทม์ไลน์จากfromถึงto(ค่าเริ่มต้น 24 ชั่วโมง) และทุกการกำหนดที่ไปถึงหน้าจอนั้น ต้องระบุ screenId - list_assignments: แสดงรายการการกำหนด การกำหนดที่เผยแพร่ไปยังกลุ่ม (groupId) หรือไปยังสถานที่ แบรนด์ หรือองค์กรของสถานที่ (target ค่าเริ่มต้น facility) แบ่งหน้า เรียงจากการเปลี่ยนแปลงล่าสุด
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "get" | "list_assignments" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
screenId | string | ID ของหน้าจอ (รหัส 6 ตัวอักษร) จาก display_screens_read list (get) |
at | string | วันที่และเวลาแบบ ISO ที่จะตรวจสอบสิ่งที่แสดง (ค่าเริ่มต้นคือตอนนี้) (get) |
from | string | จุดเริ่มต้นไทม์ไลน์แบบ ISO (ค่าเริ่มต้นคือ at หรือตอนนี้) (get) |
to | string | จุดสิ้นสุดไทม์ไลน์แบบ ISO (ค่าเริ่มต้น 24 ชั่วโมงหลังจาก from) (get) |
includeExpired | boolean | รวมการกำหนดที่สิ้นสุดแล้ว |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
groupId | string | ID หรือชื่อกลุ่มหน้าจอ จาก display_screens_read groups (list_assignments) |
target | "facility" | "brand" | "organisation" | เมื่อไม่ได้ระบุ groupId (ค่าเริ่มต้น facility) (list_assignments) |
limit | integer | จำนวนรายการต่อหน้า (ค่าเริ่มต้น 25 สูงสุด 100) (list_assignments) |
cursor | string | nextCursor จากหน้าก่อนหน้า (list_assignments) |
display_schedule_writeหน้าจอแสดงผลเปลี่ยนสิ่งที่เผยแพร่ไปยัง Display Screens: แก้ไขเวลา ลำดับความสำคัญ หรือเนื้อหาของการกำหนด (เลือกใช้กับการเผยแพร่ทั้งหมดได้) หรือนำการกำหนดหนึ่งรายการหรือการเผยแพร่ทั้งหมดออก ค้นหา ID ได้ด้วย display_schedule_read การนำเนื้อหาออกจากกำหนดการจะยังคงเก็บเนื้อหาไว้ในคลัง หากต้องการสิ้นสุด Takeover ก่อนเวลาแต่เก็บประวัติไว้ ให้ใช้ display_takeover_stop
การดำเนินการ:
- update: อัปเดตการกำหนด เปลี่ยนเวลา (ช่วงเวลารายสัปดาห์ from/to และ null คือล้างวันที่) ลำดับความสำคัญ หรือเนื้อหาของการกำหนด applyToBatch จะเปลี่ยนแบบเดียวกันกับทุกเป้าหมายของการเผยแพร่ Takeover เปลี่ยนได้เฉพาะเวลาสิ้นสุดใหม่ เนื้อหากล้องวงจรปิดต้องใช้ confirmCctv หลังจากผู้ใช้ยินยอม ต้องระบุ assignmentId
- delete: นำออกจากกำหนดการ นำการกำหนดหนึ่งรายการ (assignmentId) หรือทุกอย่างจากการเผยแพร่หนึ่งครั้ง (batchId) ออก หน้าจอจะกลับไปแสดงสิ่งที่ควรแสดงตามปกติภายในไม่กี่วินาที จะขอการยืนยัน
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "update" | "delete" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
assignmentId | string | การกำหนดหนึ่งรายการ (as_…) จาก display_schedule_read |
applyToBatch | boolean | เปลี่ยนแบบเดียวกันกับทุกเป้าหมายของการเผยแพร่ (update) |
windows | array | ช่วงเวลารายสัปดาห์ตามเขตเวลาของสถานที่ days เป็นวันในสัปดาห์แบบ ISO (1 = วันจันทร์ … 7 = วันอาทิตย์) ส่วน start/end อยู่ในรูปแบบ "HH:MM" (end ใช้ "24:00" ได้) (update) |
from | stringnull | วันที่และเวลาแบบ ISO ที่เริ่มต้น null คือล้างค่า (update) |
to | stringnull | วันที่และเวลาแบบ ISO ที่สิ้นสุด null คือล้างค่า (update) |
priority | integer | ตัดสินระหว่างรายการตามกำหนดการที่ทับซ้อนกัน (ค่าสูงกว่าจะได้แสดง) (update) |
contentRef | string | media#<id>, app#<id> หรือ playlist#<id> จาก display_library_read list หรือ playlists (update) |
confirmCctv | boolean | ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันอย่างชัดเจนให้แสดงภาพสดจากกล้องวงจรปิดแล้วเท่านั้น (update) |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
batchId | string | การเผยแพร่ทั้งหมด (bt_…) จาก display_publish หรือ display_schedule_read ครอบคลุมทุกเป้าหมาย (delete) |
confirm | boolean | ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันตัวอย่างที่ได้จากการเรียกครั้งแรกแล้วเท่านั้น |
display_screen_commandหน้าจอแสดงผลส่งคำสั่งแบบเรียลไทม์ไปยัง Display Screens ที่สถานที่: reload (หน้าจอ player ดึงกำหนดการใหม่) identify (กะพริบชื่อและรหัสของหน้าจอ เพื่อค้นหาหน้าจอในสถานที่) displayOn/displayOff (แผงจอทีวี) rebootDevice (รีสตาร์ทคอมพิวเตอร์ของหน้าจอ จอจะว่างเปล่า 1–2 นาที ต้องใช้ confirm: true) หรือ osd (ข้อความสั้นบนหน้าจอ ระบุ message)
เลือกหน้าจอด้วย screenIds และ/หรือ groupIds (ทุกหน้าจอในกลุ่มเหล่านั้นที่สถานที่) หรือ allScreens: true สำหรับทุกหน้าจอที่สถานที่ (displayOn/displayOff จะไปถึงหน้าจอ Templated content ด้วย) ส่งคืนผลลัพธ์แยกตามหน้าจอ เมื่อระบุหลายหน้าจอ หลายกลุ่ม หรือหลายเป้าหมาย เครื่องมือนี้จะดำเนินการกับทั้งหมดในการเรียกครั้งเดียว โปรดสอบถามผู้ใช้ก่อนดำเนินการกับรายการจำนวนมาก
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
screenIds | array | ID ของหน้าจอ (รหัส 6 ตัวอักษร) จาก display_screens_read list ไม่ต้องระบุเมื่อใช้ allScreens |
groupIds | array | ID หรือชื่อกลุ่มหน้าจอ: ทุกหน้าจอในกลุ่มเหล่านั้นที่สถานที่ |
allScreens | boolean | ทุกหน้าจอที่สถานที่ รวมถึงหน้าจอ Templated content |
command* | "reload" | "identify" | "displayOn" | "displayOff" | "rebootDevice" | "osd" | สิ่งที่ต้องการทำ (rebootDevice ต้องใช้ confirm) |
message | string | ข้อความสำหรับ osd |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
confirm | boolean | ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันตัวอย่างที่ได้จากการเรียกครั้งแรกแล้วเท่านั้น |
display_screens_readหน้าจอแสดงผลอ่าน Display Screens ของสถานที่: แสดงรายการหน้าจอพร้อมสถานะ และสิ่งที่แสดงอยู่ตอนนี้และถัดไป (กรองตามกลุ่ม สถานะ หรือโหมดการแสดงผล) ดูรายละเอียดทั้งหมดและไทม์ไลน์ของหน้าจอหนึ่ง หรือแสดงรายการกลุ่มหน้าจอพร้อมหน้าจอในกลุ่ม
โหมดการแสดงผลจะแสดงต่อผู้ใช้เป็น "Data Source": player คือ "User managed content" ส่วน program-builder คือ "Templated content" (เมื่อพูดกับผู้ใช้ ให้เรียกว่า "Templated content" เสมอ ห้ามใช้ชื่อเดิม) และ url คือ "Full-page website (Kiosk Mode)" เวลาเป็นแบบ ISO และจะส่งคืนเขตเวลาของสถานที่ด้วย
การดำเนินการ:
- list: แสดงรายการหน้าจอ หน้าจอที่สถานที่ (แบ่งหน้า) แต่ละหน้าจอพร้อมสถานะ heartbeat ล่าสุด กลุ่ม แท็ก และสิ่งที่แสดงอยู่ตอนนี้และถัดไป ส่งคืนกลุ่มด้วย
- get: ดูหน้าจอ รายละเอียดทั้งหมดของหน้าจอหนึ่ง (สถานะ heartbeat เวอร์ชัน player ข้อผิดพลาดล่าสุด) และสำหรับหน้าจอ player จะแสดงสิ่งที่หน้าจอแสดงตลอดช่วงเวลา (ค่าเริ่มต้น 24 ชั่วโมงถัดไป สูงสุด 14 วัน) ต้องระบุ screenId
- groups: แสดงรายการกลุ่มหน้าจอ กลุ่มหน้าจอที่สถานที่ (แบ่งหน้า) แต่ละกลุ่มพร้อมหน้าจอในกลุ่ม
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "list" | "get" | "groups" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
groupId | string | เฉพาะหน้าจอในกลุ่มนี้ (ID หรือชื่อ) (list) |
status | "playing" | "provisioning" | "display-off" | "not-responding" | "offline" | "online" | (list) |
mode | "player" | "program-builder" | "url" | (list) |
limit | integer | จำนวนรายการต่อหน้า (ค่าเริ่มต้น 25 สูงสุด 100) (list, groups) |
cursor | string | nextCursor จากหน้าก่อนหน้า (list, groups) |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
screenId | string | ID ของหน้าจอ (รหัส 6 ตัวอักษร) จาก display_screens_read list (get) |
from | string | จุดเริ่มต้นไทม์ไลน์แบบ ISO (ค่าเริ่มต้นคือตอนนี้) (get) |
to | string | จุดสิ้นสุดไทม์ไลน์แบบ ISO (ค่าเริ่มต้น 24 ชั่วโมงหลังจาก from) (get) |
display_screens_writeหน้าจอแสดงผลการจัดการอุปกรณ์เปลี่ยนแปลง Display Screens: จับคู่หน้าจอใหม่ด้วยรหัสจับคู่ เปลี่ยนชื่อหน้าจอ กำหนดกลุ่มและแท็ก หรือเปลี่ยนโหมดการแสดงผล (แสดงต่อผู้ใช้เป็น "Data Source") หมุนเวียนโทเค็นของหน้าจอ player สร้างลิงก์ตัวอย่างแบบจำกัดเวลาของหน้าจอหรือเนื้อหา หรือรีเซ็ตหน้าจอเป็นค่าจากโรงงาน (นำหน้าจอออกจากสถานที่)
โหมดการแสดงผล: player ("User managed content") url ("Full-page website (Kiosk Mode)" ระบุ url เฉพาะ https) program-builder ("Templated content" เมื่อพูดกับผู้ใช้ ให้เรียกว่า "Templated content" เสมอ ห้ามใช้ชื่อเดิม) การเปลี่ยนโหมดจะโหลดหน้าจอใหม่ทันทีและเปลี่ยนสิ่งที่สมาชิกเห็น จึงต้องให้ผู้ใช้ยืนยัน
การดำเนินการ:
- update: อัปเดตหน้าจอ ตั้งค่าชื่อ กลุ่ม (ID หรือชื่อ แทนที่กลุ่มปัจจุบัน) แท็ก (แทนที่แท็กเดิม) และ/หรือโหมดการแสดงผลของหน้าจอ การเปลี่ยนโหมดจะส่งคืน requiresConfirmation ก่อน ต้องระบุ screenId อาจขอการยืนยัน
- rotate_token: หมุนเวียนโทเค็นของหน้าจอ ออกโทเค็นใหม่ให้หน้าจอ player และโหลดหน้าจอใหม่ โทเค็นเดิมจะใช้งานไม่ได้อีก ใช้เมื่อ URL ของ player ของหน้าจออาจรั่วไหล ต้องระบุ screenId จะขอการยืนยัน
- create_preview_link: สร้างลิงก์ตัวอย่าง ลิงก์ (ใช้ได้ในเวลาจำกัด) ที่แสดงสิ่งที่หน้าจอแสดง หรือลักษณะของเนื้อหา โดยเลือกดู ณ เวลาในอนาคตได้ ทุกคนที่มีลิงก์จะดูได้จนกว่าลิงก์จะหมดอายุ
- reset: รีเซ็ตหน้าจอเป็นค่าจากโรงงาน นำหน้าจอออกจากสถานที่และรีเซ็ตเป็นค่าจากโรงงาน หน้าจอที่ปิดเครื่องอยู่จะรีเซ็ตเมื่อกลับมาออนไลน์ครั้งถัดไป แล้วแสดงหน้าจับคู่ ระบุ confirmName: ชื่อหน้าจอตรงตามที่ผู้ใช้พิมพ์ ต้องมี การจัดการอุปกรณ์ ต้องระบุ screenId, confirmName จะขอการยืนยัน
- pair: จับคู่หน้าจอใหม่ เพิ่มหน้าจอใหม่ให้สถานที่ด้วยรหัส 6 ตัวอักษรบนหน้าจับคู่ แล้วโหลดหน้าจอใหม่ สถานที่ที่มีเฉพาะ Display Screens จะเริ่มหน้าจอในโหมด player หากมี Templated content ด้วย mode จะเป็นตัวเลือก (ค่าเริ่มต้น program-builder) ต้องมี การจัดการอุปกรณ์ ต้องระบุ pairingCode, name จะขอการยืนยัน
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "update" | "rotate_token" | "create_preview_link" | "reset" | "pair" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
screenId | string | ID ของหน้าจอ (รหัส 6 ตัวอักษร) จาก display_screens_read list (update, rotate_token, create_preview_link, reset) |
name | string | ชื่อหน้าจอ (update, pair) |
groupIds | array | ID หรือชื่อกลุ่ม แทนที่กลุ่มปัจจุบัน (สร้างกลุ่มได้ด้วย display_groups_write save) (update) |
tags | array | แทนที่แท็กปัจจุบัน (update) |
mode | "player" | "program-builder" | "url" | โหมดการแสดงผล ("Data Source") (update, pair) |
url | string | เว็บไซต์สำหรับโหมด url (https) (update) |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
contentRef | string | media#<id>, app#<id> หรือ playlist#<id> จาก display_library_read list หรือ playlists (create_preview_link) |
orientation | "landscape" | "portrait" | สำหรับตัวอย่างของ contentRef (ค่าเริ่มต้น landscape) (create_preview_link) |
at | string | วันที่และเวลาแบบ ISO ที่จะแสดงตัวอย่าง (ค่าเริ่มต้นคือตอนนี้) (create_preview_link) |
confirmName | string | ชื่อหน้าจอที่ผู้ใช้พิมพ์เพื่อยืนยัน (ต้องตรงกันทุกตัวอักษร) (reset) |
pairingCode | string | รหัสที่หน้าจอแสดงบนหน้าจับคู่ (0 และ O มีลักษณะคล้ายกัน) (pair) |
contentStream | string | Templated content: สตรีม (รอบ) ที่เล่น ค่าเริ่มต้น 1 (pair) |
confirm | boolean | ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันตัวอย่างที่ได้จากการเรียกครั้งแรกแล้วเท่านั้น |
display_screenshotหน้าจอแสดงผลจับภาพสิ่งที่ Display Screen แสดงอยู่ในขณะนี้และส่งคืนรูปภาพ เพื่อให้คุณตรวจสอบงานของตัวเองหลังการเผยแพร่ได้ (เลย์เอาต์ ขนาดข้อความ ไม่มีส่วนใดถูกตัดหรือเลื่อน) รอให้หน้าจอตอบกลับได้สูงสุด 15 วินาที หน้าจอที่ออฟไลน์จะหมดเวลา และส่งคืน URL ของพอร์ทัลสำหรับไฟล์ JPEG ด้วย (เฉพาะผู้ใช้ที่ลงชื่อเข้าใช้ เก็บไว้ 10 นาที)
ภาพหน้าจออาจมีภาพสดจากกล้องวงจรปิดและสมาชิกที่อยู่ในภาพ อย่าแชร์ภาพเหล่านี้นอกการสนทนา
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
screenId* | string | ID ของหน้าจอ (รหัส 6 ตัวอักษร) จาก display_screens_read list |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
display_settings_readหน้าจอแสดงผล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.
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "settings" | "power_schedule" | "power_schedule_preview" | "automations" | "boot_screen" | "screen_defaults" | "templated" | "program_dates" | "templated_schedule" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
schedule | object | หน้าจอจะเปิดในช่วงเวลาที่มีพนักงานประจำ (ขยายตามค่าชดเชย) หรือช่วงเวลารายสัปดาห์ที่กำหนดเอง พร้อมกฎสำหรับวันหยุด (power_schedule_preview) |
facilityIds | array | ID ของหลายสถานที่ เพื่อเรียกใช้คำขอเดียวกันในแต่ละสถานที่ ใช้แทน facilityId (automations) |
from | string | วันที่เริ่มต้น (YYYY-MM-DD) (templated_schedule) |
to | string | วันที่สิ้นสุด (YYYY-MM-DD) (templated_schedule) |
display_settings_writeหน้าจอแสดงผลเปลี่ยนการตั้งค่า Display Screens ของสถานที่ ได้แก่ Fallback Slate การโพลและการโหลดใหม่ทุกคืน และ "Allow CCTV on display screens" กำหนดการเปิดปิดหน้าจอ และระบบอัตโนมัติ (ความสว่าง ระดับเสียงกริ่ง การเปิดหน้าจอเมื่อเช็กอิน) ฟิลด์ที่คุณไม่ได้ระบุจะคงค่าปัจจุบันไว้ การตั้งค่าระดับแบรนด์ (หน้าจอบูต Templated content) อยู่ใน display_brand_settings_write
การดำเนินการ:
- save_settings: บันทึกการตั้งค่าการแสดงผลของสถานที่ Fallback Slate ที่แสดงเมื่อไม่มีสิ่งใดตามกำหนดการ ช่วงเวลาการโพล (30–300 s) เวลาโหลดใหม่ทุกคืน (HH:mm) และ allowCctv การเปิด allowCctv ต้องให้ผู้ใช้ยืนยัน และต้องเป็นผู้ดูแลสถานที่ที่มีสิทธิ์เข้าถึงกล้องวงจรปิด อาจขอการยืนยัน
- save_power_schedule: บันทึกกำหนดการเปิดปิด เปลี่ยนเวลาที่หน้าจอเปิดและปิด โดยฟิลด์ที่คุณระบุจะรวมเข้ากับกำหนดการที่บันทึกไว้ ส่งคืนเวลาเปิด/ปิดของ 7 วันถัดไป ตรวจสอบด้วย display_settings_read power_schedule_preview ก่อน ต้องระบุ schedule
- save_automations: บันทึกระบบอัตโนมัติของการแสดงผล เปลี่ยนการตั้งค่าความสว่างอัตโนมัติ ระดับเสียงกริ่ง และการเปิดหน้าจอเมื่อเช็กอิน หลังจากนั้นสถานที่จะใช้การตั้งค่าของตัวเองแทนค่าเริ่มต้นส่วนกลาง
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "save_settings" | "save_power_schedule" | "save_automations" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
slate | object | (save_settings) |
pollIntervalSec | integer | (save_settings) |
nightlyReloadTime | string | HH:mm (save_settings) |
allowCctv | boolean | อนุญาตให้แสดงกล้องวงจรปิดบนหน้าจอแสดงผล (save_settings) |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
schedule | object | หน้าจอจะเปิดในช่วงเวลาที่มีพนักงานประจำ (ขยายตามค่าชดเชย) หรือช่วงเวลารายสัปดาห์ที่กำหนดเอง พร้อมกฎสำหรับวันหยุด (save_power_schedule) |
autoPowerDisplays | boolean | เปิด/ปิดระบบอัตโนมัติการเปิดปิดแบบเดิม (กำหนดการเปิดปิดใช้แทนแล้ว) (save_automations) |
minsBeforeOpenDisplayOn | integer | ระบบอัตโนมัติการเปิดปิดแบบเดิม: จำนวนนาทีก่อนเปิดทำการ (save_automations) |
minsAfterCloseDisplayOff | integer | ระบบอัตโนมัติการเปิดปิดแบบเดิม: จำนวนนาทีหลังปิดทำการ (save_automations) |
displaysOnCheckIn | boolean | เปิดหน้าจอเมื่อมีผู้เช็กอิน (save_automations) |
minsLastCheckInDisplayOff | integer | เมื่อใช้ displaysOnCheckIn: จำนวนนาทีหลังการเช็กอินครั้งล่าสุดที่หน้าจอจะปิด (save_automations) |
enableAutoBrightness | boolean | สลับระหว่างความสว่างกลางวันและกลางคืน (save_automations) |
dayTriggerType | "auto" | "staffed" | "custom" | เวลาที่ความสว่างกลางวันเริ่มต้น (save_automations) |
dayTimeStart | string | สำหรับ dayTriggerType custom: HH:mm (เวลาของสถานที่) (save_automations) |
dayOffsetMinutes | integer | จำนวนนาทีหลังรุ่งเช้าหรือหลังเปิดทำการ (save_automations) |
dayBrightnessLevel | integer | ความสว่างกลางวัน, % (save_automations) |
nightTriggerType | "auto" | "staffed" | "custom" | เวลาที่ความสว่างกลางคืนเริ่มต้น (save_automations) |
nightTimeStart | string | สำหรับ nightTriggerType custom: HH:mm (เวลาของสถานที่) (save_automations) |
nightOffsetMinutes | integer | จำนวนนาทีหลังพลบค่ำ หรือก่อนปิดทำการ (save_automations) |
nightBrightnessLevel | integer | ความสว่างกลางคืน, % (save_automations) |
bellMasterLevel | integer | ระดับเสียงกริ่งหลัก, % (save_automations) |
bellClubHoursLevel | integer | ระดับเสียงกริ่งในช่วงเวลาที่มีพนักงานประจำ, % (save_automations) |
bellExtendedHoursLevel | integer | ระดับเสียงกริ่งในช่วงเวลาขยาย, % (save_automations) |
enableBellAutoVolume | boolean | ใช้ตามกำหนดการระดับเสียงกริ่ง (save_automations) |
bellVolumeSchedule | object | ช่วงระดับเสียงกริ่งรายสัปดาห์แยกตามวัน (mon … sun) แทนที่กำหนดการทั้งหมด (save_automations) |
confirm | boolean | ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันตัวอย่างที่ได้จากการเรียกครั้งแรกแล้วเท่านั้น |
display_takeover_stopหน้าจอแสดงผลสิ้นสุด Takeover ของ Display Screens ที่กำลังทำงานอยู่ทันที: สำหรับการเผยแพร่หนึ่งครั้ง (batchId จาก display_publish) สำหรับเป้าหมาย (ค่าเริ่มต้น: Takeover ที่เผยแพร่ไปยังทั้งสถานที่) หรือใช้ allScreens สำหรับทุก Takeover ที่เผยแพร่ไปยังสถานที่ หน้าจอ หรือกลุ่มของหน้าจอ Takeover ระดับแบรนด์และองค์กรจะหยุดได้ด้วย batchId เท่านั้น หน้าจอจะกลับไปแสดงเนื้อหาตามกำหนดการหรือเนื้อหาเริ่มต้นภายในไม่กี่วินาที และส่งคืนจำนวนที่หยุด เมื่อระบุหลายหน้าจอ หลายกลุ่ม หรือหลายเป้าหมาย เครื่องมือนี้จะดำเนินการกับทั้งหมดในการเรียกครั้งเดียว โปรดสอบถามผู้ใช้ก่อนดำเนินการกับรายการจำนวนมาก
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
batchId | string | การเผยแพร่ Takeover (bt_…) จาก display_publish |
targets | object | ปลายทางของเนื้อหา ใช้ร่วมกันได้หลายรายการ ใช้ชื่อกลุ่มแทน ID ได้ brand และ organisation ต้องมีสิทธิ์เข้าถึง Display Screens ทั้งองค์กร |
allScreens | boolean | ทุก Takeover ที่เผยแพร่ไปยังสถานที่ หน้าจอ หรือกลุ่มของหน้าจอ |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
display_templated_writeหน้าจอแสดงผลควบคุมหน้าจอ Templated content (โหมดการแสดงผล "Templated content" ใน display_screens_read): โหลดโปรแกรมการออกกำลังกายของวันหนึ่งลงหน้าจอ หรือควบคุมตัวจับเวลารอบ หน้าจอ User managed content และหน้าจอเว็บไซต์แบบเต็มหน้าจะไม่ได้รับผลกระทบ
การดำเนินการ:
- load_program: โหลดโปรแกรมการออกกำลังกาย โหลดโปรแกรมการออกกำลังกายของวันที่ที่ระบุ (YYYY-MM-DD ค่าเริ่มต้นคือวันนี้) จากแหล่งข้อมูลของสถานที่ลงในทุกหน้าจอ Templated content ที่สถานที่หนึ่งหรือหลายแห่ง หน้าจอจะโหลดใหม่ภายในไม่กี่วินาที ใช้เพื่อแสดงการออกกำลังกายของวันนี้หรือวันอื่น หรือเมื่อหน้าจอแสดงโปรแกรมผิด หากมีหลายสถานที่ต้องใช้ confirm อาจขอการยืนยัน
- clock: ควบคุมตัวจับเวลารอบ เล่น หยุดชั่วคราว เริ่มใหม่ หรือหยุดตัวจับเวลารอบบนหน้าจอ Templated content ปิดหรือเปิดเสียงของรอบ ตั้งระดับเสียงกริ่ง (setvolume พร้อม volume 0–100) หรือสอบถามสถานะ ต้องมี Templated content ที่สถานที่ ต้องระบุ command
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "load_program" | "clock" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
facilityIds | array | ID ของหลายสถานที่ เพื่อเรียกใช้คำขอเดียวกันในแต่ละสถานที่ ใช้แทน facilityId (load_program) |
date | string | วันที่ของการออกกำลังกาย YYYY-MM-DD (ค่าเริ่มต้นคือวันนี้) (load_program) |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
command | "getstate" | "play" | "pause" | "restart" | "stop" | "mute" | "unmute" | "setvolume" | (clock) |
volume | integer | สำหรับ setvolume: ระดับเสียงกริ่ง, % (clock) |
confirm | boolean | ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันตัวอย่างที่ได้จากการเรียกครั้งแรกแล้วเท่านั้น |