מסכי תצוגה

פלטפורמת הליבה
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"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
imageUrlstringכתובת URL ציבורית ב-https של התמונה (save_boot_screen)
imageBase64stringהתמונה כ-base64, כשאין כתובת URL (save_boot_screen)
fit"logo" | "fill"(save_boot_screen)
backgroundstringצבע רקע (#RRGGBB) (save_boot_screen)
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
orientation"normal" | "left" | "right" | "inverted"Screen rotation (save_screen_defaults)
airplayEnabledbooleanScreens accept AirPlay (save_screen_defaults)
sessionTimerEnabledbooleanSynchronised session timer (master clock) and its bells (save_screen_defaults)
sonosEnabledbooleanSonos speaker control (save_screen_defaults)
duressEnabledbooleanBluetooth duress button monitoring (save_screen_defaults)
cameraRestreamingEnabledbooleanRestream local camera feeds from the screen (save_screen_defaults)
wifiSupportbooleanCaptive Wi-Fi setup portal (save_screen_defaults)
showSourceNameboolean(save_templated)
showWorkoutNamesboolean(save_templated)
showProgramsInScheduleboolean(save_templated)
programLookaheadDaysintegernullמספר ימים קדימה (0–90), או null ללא הגבלה (save_templated)
showTrainingPhasesboolean(save_templated)
phaseLookaheadDaysintegernullמספר ימים קדימה (0–90), או null ללא הגבלה (save_templated)
showTrainingCampsboolean(save_templated)
campLookaheadDaysintegernullמספר ימים קדימה (0–90), או null ללא הגבלה (save_templated)
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
display_groups_writeמסכי תצוגה

יוצר, משנה שם ומוחק קבוצות של Display Screens במתקן וקובע אילו מסכים נמצאים בהן. קבוצות הן יעדי פרסום (display_publish targets.groupIds) ויעדי פקודות (display_screen_command groupIds). כשניתנים כמה מסכים, קבוצות או יעדים, הכלי פועל על כולם בקריאה אחת; בדקו עם המשתמש לפני שאתם פועלים על רבים.

פעולות:

  • save: שמירת קבוצה. יצירה: name (ואופציונלית screenIds). שינוי שם: groupId (מזהה או השם הנוכחי) ו-name. screenIds מחליף את החברים; מסכים שלא פורטו עוזבים את הקבוצה הזו אבל נשארים בקבוצות האחרות שלהם.
  • delete: מחיקת קבוצה. מוחקת קבוצה: המסכים שלה עוזבים אותה (ונשארים בקבוצות האחרות שלהם) ותוכן שפורסם לקבוצה מוסר מלוח הזמנים. דורשת groupId. מבקשת אישור.

פרמטרים

שםסוגתיאור
action*"save" | "delete"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
groupIdstringמזהה או שם של קבוצה קיימת, כדי לשנות את שמה או את החברים בה
namestringשם הקבוצה (חובה ביצירה) (save)
screenIdsarrayהמסכים בקבוצה; מחליף את החברים הנוכחיים (save)
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
display_hosted_apps_writeמסכי תצוגה

מפרסם אפליקציות HTML סטטיות ("hosted apps", אפליקציות מתארחות) עבור 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"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
appIdstringמזהה של אפליקציה מתארחת קיימת (app_…) שעבורה תפורסם גרסה חדשה
namestringשם האפליקציה (חובה ביצירה) (publish)
filesarrayקובצי האפליקציה. encoding הוא utf8 (ברירת מחדל) או base64 לקבצים בינאריים. (publish)
entrystringקובץ ה-HTML הראשי (ברירת מחדל index.html) (publish)
durationSecnumberזמן ברירת המחדל על המסך ברשימות השמעה, בשניות (publish)
tagsarray(publish)
ownerScope"facility" | "brand" | "organisation"מי הבעלים של תוכן חדש (ברירת מחדל facility). brand ו-organisation דורשים גישה ברמת הארגון כולו. (publish)
publishToobject(publish)
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
versionintegerהגרסה שתהפוך לנוכחית (rollback)
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
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 שאינה מפורסמת, מושהית, display-off, מוגבלת לקהל או ללא Custom Apps; תצוגת טלוויזיה במעגל סגור עם no-cctv, cctv-off (מנהל מתקן מפעיל טלוויזיה במעגל סגור למסכים בהגדרות Display Screens) או no-cameras.

פעולות:

  • list: הצגת פריטי הספרייה. מדיה ואפליקציות (בעמודים; סינון לפי type, kind, תגית או שם), או עם 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)
tagstringרק פריטים עם התגית הזו (list)
searchstringסינון לפי שם, ללא תלות באותיות רישיות (list)
limitintegerפריטים לעמוד (ברירת מחדל 25, לכל היותר 100) (list, playlists)
cursorstringnextCursor מהעמוד הקודם (list, playlists)
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים. (list, cctv_sources, get, usages, app_versions, check_url, playlists)
contentRefstringmedia#<id>, app#<id> או playlist#<id>, מ-display_library_read list או playlists (get, usages)
appIdstringמזהה אפליקציה מתארחת (app_…) (app_versions)
urlstringכתובת 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: רושמת את הסרטון ומחזירה העלאה חתומה מראש (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"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
urlstringכתובת URL ציבורית ב-https של התמונה או הסרטון (מועדף) (upload_media, create_app, update)
base64stringתוכן הקובץ כ-base64 (עד 20 MB), כשאין כתובת URL (upload_media)
mimeTypestringחובה עם base64, לדוגמה image/png (upload_media, create_video_upload)
namestringשם בספרייה (upload_media, create_video_upload, create_app, update)
tagsarrayתגיות (מחליפות את התגיות הנוכחיות) (upload_media, create_video_upload, create_app, update)
ownerScope"facility" | "brand" | "organisation"מי הבעלים של תוכן חדש (ברירת מחדל facility). brand ו-organisation דורשים גישה ברמת הארגון כולו. (upload_media, create_video_upload, create_app)
durationSecnumberזמן ברירת המחדל על המסך לתמונות, בשניות (upload_media, create_app, update)
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
bytesintegerגודל הקובץ בבתים (create_video_upload)
resolution"720" | "1080" | "1440" | "2160" | "original"הגודל המרבי שאליו הסרטון מומר עבור מסכים (ברירת מחדל 1080; original שומר על הגודל המקורי) (create_video_upload, transcode)
contentRefstringmedia#<id>, app#<id> או playlist#<id>, מ-display_library_read list או playlists (transcode, update, delete, refresh_preview)
kind"url" | "agent-app" | "cctv-view"(create_app)
agentAppIdstringאפליקציות AI Agent: מזהה האפליקציה (create_app)
source"view" | "cameras"תצוגות טלוויזיה במעגל סגור: view (העבירו viewId) או cameras (העבירו cameras) (create_app, update)
viewIdstringתצוגות טלוויזיה במעגל סגור: מזהה Live View (display_library_read cctv_sources) (create_app, update)
camerasarrayתצוגות טלוויזיה במעגל סגור: מזהי מצלמות (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)
showNamesbooleanתצוגות טלוויזיה במעגל סגור: הצגת שמות המצלמות על האריחים (create_app, update)
validFromstringnullמדיה: תאריך ושעה בתבנית ISO שבהם מתחילה ההפעלה; null מנקה (update)
validTostringnullמדיה: תאריך ושעה בתבנית ISO שבהם ההפעלה נעצרת; null מנקה (update)
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
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"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
playlistIdstringמזהה של רשימת השמעה קיימת (pl_…) לעדכון
namestringשם רשימת ההשמעה (חובה ביצירה) (save)
transition"fade" | "none"(save)
ownerScope"facility" | "brand" | "organisation"מי הבעלים של תוכן חדש (ברירת מחדל facility). brand ו-organisation דורשים גישה ברמת הארגון כולו. (save)
itemsarrayהרשימה כולה, לפי הסדר (מחליפה את הפריטים הנוכחיים; שמרו את itemId כדי לשמור פריט). דפי אינטרנט עם frameable: false לא יופעלו. (save)
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
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לאן התוכן הולך. אפשר לשלב כל אחד מאלה. שמות קבוצות עובדים כמו מזהים. brand ו-organisation דורשים גישה ל-Display Screens ברמת הארגון כולו.
content*objectמה להציג: בדיוק אחד מ-contentRef, url, agentAppId או cctv.
mode"now" | "default" | "scheduled" | "takeover"`now`/`default` (ברירת המחדל): מחליף את מה שהיעדים מציגים בדרך כלל. `scheduled`: רק בחלונות ו/או בין from ל-to. `takeover`: קוטע הכול למשך durationMin (או עד שעה מסוימת), ואז מסתיים מעצמו.
windowsarrayחלונות שבועיים באזור הזמן של המתקן. days הם ימי שבוע לפי ISO (1 = יום שני … 7 = יום ראשון); start/end הם "HH:MM" (מותר end "24:00").
fromstringתאריך ושעה בתבנית ISO שבהם פרסום מתוזמן מתחיל
tostringתאריך ושעה בתבנית ISO שבהם פרסום מתוזמן מסתיים
durationMinnumberמשך ההשתלטות בדקות (עד 7 ימים)
untilstringתאריך ושעה בתבנית ISO שבהם השתלטות מסתיימת (במקום durationMin)
priorityintegerמכריע בין פריטים מתוזמנים חופפים (הגבוה גובר)
confirmCctvbooleanהגדירו רק לאחר שהמשתמש אישר במפורש הצגה של טלוויזיה במעגל סגור בשידור חי
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
display_schedule_readמסכי תצוגה

קורא את מה שפורסם ל-Display Screens: עבור מסך אחד, מה הוא מציג ברגע מסוים ולאורך טווח זמן (לאחר הכרעה בין כל השכבות והיעדים שהוא יורש מהם), וכן השיבוצים שמגיעים אליו; או את השיבוצים שפורסמו לקבוצה, למתקן, למותג שלו או לארגון שלו.

מזהי שיבוצים (as_…) ומזהי אצוות (bt_…) הם מה ש-display_schedule_write מעדכן או מוחק. הזמנים בתבנית ISO; החלונות באזור הזמן של המתקן.

פעולות:

  • get: קבלת לוח הזמנים של מסך. מה מסך מציג ב-at (ברירת מחדל עכשיו), ציר הזמן שלו מ-from עד to (ברירת מחדל 24 שעות), וכל שיבוץ שמגיע אליו. דורשת screenId.
  • list_assignments: הצגת שיבוצים. שיבוצים שפורסמו לקבוצה (groupId), או למתקן, למותג שלו או לארגון שלו (target, ברירת מחדל facility). בעמודים, השינוי החדש ביותר ראשון.

פרמטרים

שםסוגתיאור
action*"get" | "list_assignments"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
screenIdstringמזהה מסך (הקוד בן 6 התווים) מ-display_screens_read list (get)
atstringתאריך ושעה בתבנית ISO שבהם לבדוק מה מוצג (ברירת מחדל עכשיו) (get)
fromstringתחילת ציר הזמן בתבנית ISO (ברירת מחדל at, אחרת עכשיו) (get)
tostringסוף ציר הזמן בתבנית ISO (ברירת מחדל 24 שעות אחרי from) (get)
includeExpiredbooleanכולל שיבוצים שהסתיימו
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
groupIdstringמזהה או שם של קבוצת מסכים, מ-display_screens_read groups (list_assignments)
target"facility" | "brand" | "organisation"כשלא ניתן groupId (ברירת מחדל facility) (list_assignments)
limitintegerפריטים לעמוד (ברירת מחדל 25, לכל היותר 100) (list_assignments)
cursorstringnextCursor מהעמוד הקודם (list_assignments)
display_schedule_writeמסכי תצוגה

משנה את מה שפורסם ל-Display Screens: עריכת התזמון, העדיפות או התוכן של שיבוץ (אופציונלית בכל הפרסום שלו), או הסרה של שיבוץ אחד או של פרסום שלם. מצאו מזהים עם display_schedule_read. הסרת תוכן מלוח הזמנים משאירה אותו בספרייה; כדי לסיים השתלטות מוקדם אבל לשמור את ההיסטוריה שלה, השתמשו ב-display_takeover_stop.

פעולות:

  • update: עדכון שיבוץ. משנה את התזמון (חלונות שבועיים, from/to; null מנקה תאריך), העדיפות או התוכן של שיבוץ. applyToBatch מבצע את אותו שינוי בכל יעדי הפרסום. להשתלטות אפשר לשנות רק את שעת הסיום. תוכן של טלוויזיה במעגל סגור דורש confirmCctv לאחר שהמשתמש הסכים. דורשת assignmentId.
  • delete: הסרה מלוח הזמנים. מסירה שיבוץ אחד (assignmentId) או את כל מה שנוצר בפרסום אחד (batchId). המסכים חוזרים בתוך שניות למה שהיו מציגים אחרת. מבקשת אישור.

פרמטרים

שםסוגתיאור
action*"update" | "delete"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
assignmentIdstringשיבוץ אחד (as_…) מ-display_schedule_read
applyToBatchbooleanביצוע אותו שינוי בכל יעדי הפרסום (update)
windowsarrayחלונות שבועיים באזור הזמן של המתקן. days הם ימי שבוע לפי ISO (1 = יום שני … 7 = יום ראשון); start/end הם "HH:MM" (מותר end "24:00"). (update)
fromstringnullתאריך ושעה בתבנית ISO של ההתחלה; null מנקה (update)
tostringnullתאריך ושעה בתבנית ISO של הסיום; null מנקה (update)
priorityintegerמכריע בין פריטים מתוזמנים חופפים (הגבוה גובר) (update)
contentRefstringmedia#<id>, app#<id> או playlist#<id>, מ-display_library_read list או playlists (update)
confirmCctvbooleanהגדירו רק לאחר שהמשתמש אישר במפורש הצגה של טלוויזיה במעגל סגור בשידור חי (update)
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
batchIdstringפרסום שלם (bt_…) מ-display_publish או מ-display_schedule_read, על פני כל היעדים שלו (delete)
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
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). מחזיר תוצאות לכל מסך. כשניתנים כמה מסכים, קבוצות או יעדים, הכלי פועל על כולם בקריאה אחת; בדקו עם המשתמש לפני שאתם פועלים על רבים.

פרמטרים

שםסוגתיאור
screenIdsarrayמזהי מסכים (הקודים בני 6 התווים) מ-display_screens_read list. השמיטו כשמשתמשים ב-allScreens.
groupIdsarrayמזהים או שמות של קבוצות מסכים: כל המסכים של הקבוצות האלה במתקן
allScreensbooleanכל המסכים במתקן, כולל מסכי Templated content
command*"reload" | "identify" | "displayOn" | "displayOff" | "rebootDevice" | "osd"מה לעשות (rebootDevice דורש confirm)
messagestringטקסט עבור osd
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
display_screens_readמסכי תצוגה

קורא את Display Screens של מתקן: הצגת המסכים עם הסטטוס שלהם ומה מוצג עכשיו ובהמשך (סינון לפי קבוצה, סטטוס או מצב תצוגה), קבלת הפרטים המלאים וציר הזמן של מסך אחד, או הצגת קבוצות מסכים עם המסכים שלהן.

מצב התצוגה מוצג למשתמשים כ-"Data Source": player הוא "User managed content", program-builder הוא "Templated content" (אל תשתמשו מול משתמשים בשם הישן והמיושן של התכונה), url הוא "Full-page website (Kiosk Mode)". הזמנים בתבנית ISO; אזור הזמן של המתקן מוחזר.

פעולות:

  • list: הצגת מסכים. המסכים במתקן (בעמודים), כל אחד עם סטטוס, פעימת החיים האחרונה, קבוצות, תגיות ומה מוצג עכשיו ובהמשך. מחזירה גם את הקבוצות.
  • get: קבלת מסך. הפרטים המלאים של מסך אחד (סטטוס, פעימת חיים, גרסת הנגן, שגיאות אחרונות) ועבור מסכי player, מה הוא מציג לאורך טווח זמן (ברירת מחדל 24 השעות הבאות, לכל היותר 14 ימים). דורשת screenId.
  • groups: הצגת קבוצות מסכים. קבוצות המסכים במתקן (בעמודים), כל אחת עם המסכים שלה.

פרמטרים

שםסוגתיאור
action*"list" | "get" | "groups"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
groupIdstringרק מסכים בקבוצה הזו (מזהה או שם) (list)
status"playing" | "provisioning" | "display-off" | "not-responding" | "offline" | "online"(list)
mode"player" | "program-builder" | "url"(list)
limitintegerפריטים לעמוד (ברירת מחדל 25, לכל היותר 100) (list, groups)
cursorstringnextCursor מהעמוד הקודם (list, groups)
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
screenIdstringמזהה מסך (הקוד בן 6 התווים) מ-display_screens_read list (get)
fromstringתחילת ציר הזמן בתבנית ISO (ברירת מחדל עכשיו) (get)
tostringסוף ציר הזמן בתבנית 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"; אל תשתמשו מול משתמשים בשם הישן והמיושן של התכונה). שינוי מצב טוען את המסך מחדש מיד ומשנה את מה שהחברים רואים, ולכן דורש אישור מהמשתמש.

פעולות:

  • update: עדכון מסך. מגדירה את השם, הקבוצות (מזהים או שמות; מחליפים את הקבוצות הנוכחיות), התגיות (מחליפות אותן) ו/או מצב התצוגה של מסך. שינוי מצב מחזיר קודם requiresConfirmation. דורשת screenId. עשויה לבקש אישור.
  • rotate_token: החלפת טוקן המסך. מנפיקה טוקן חדש למסך player וטוענת אותו מחדש; הטוקן הישן מפסיק לעבוד. השתמשו בה כשכתובת ה-URL של הנגן של מסך עלולה הייתה לדלוף. דורשת 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"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
screenIdstringמזהה מסך (הקוד בן 6 התווים) מ-display_screens_read list (update, rotate_token, create_preview_link, reset)
namestringשם המסך (update, pair)
groupIdsarrayמזהים או שמות של קבוצות; מחליפים את הקבוצות הנוכחיות (צרו קבוצות עם display_groups_write save) (update)
tagsarrayמחליף את התגיות הנוכחיות (update)
mode"player" | "program-builder" | "url"מצב תצוגה ("Data Source") (update, pair)
urlstringאתר אינטרנט למצב url (https) (update)
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
contentRefstringmedia#<id>, app#<id> או playlist#<id>, מ-display_library_read list או playlists (create_preview_link)
orientation"landscape" | "portrait"לתצוגות מקדימות של contentRef (ברירת מחדל landscape) (create_preview_link)
atstringתאריך ושעה בתבנית ISO שעבורם תוצג התצוגה המקדימה (ברירת מחדל עכשיו) (create_preview_link)
confirmNamestringשם המסך, כפי שהמשתמש הקליד אותו לאישור (חייב להתאים בדיוק) (reset)
pairingCodestringהקוד שהמסך מציג בדף הצימוד שלו (0 ו-O נראים דומים) (pair)
contentStreamstringTemplated content: הזרם (round) שהמסך מפעיל, ברירת מחדל 1 (pair)
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
display_screenshotמסכי תצוגה

מצלם את מה ש-Display Screen מציג ברגע זה ומחזיר את התמונה, כדי שתוכלו לבדוק את העבודה שלכם אחרי פרסום (פריסה, גודל טקסט, ששום דבר לא נחתך או גולל). ממתין עד 15 שניות לתגובת המסך; למסכים לא מקוונים יפוג הזמן. מחזיר גם כתובת URL בפורטל של קובץ ה-JPEG (למשתמשים מחוברים בלבד, נשמרת למשך 10 דקות).

צילומי מסך עלולים לכלול טלוויזיה במעגל סגור בשידור חי וחברים שנראים בתמונה; אל תשתפו אותם מחוץ לשיחה.

פרמטרים

שםסוגתיאור
screenId*stringמזהה מסך (הקוד בן 6 התווים) מ-display_screens_read list
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
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"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
scheduleobjectהמסכים פועלים בשעות הנוכחות של הצוות (מורחבות לפי ההיסטים) או בחלונות השבועיים המותאמים אישית, עם כלל לחגים. (power_schedule_preview)
facilityIdsarrayכמה מזהי מתקנים, כדי להריץ את אותה בקשה בכל אחד מהם. השתמשו בזה במקום facilityId. (automations)
fromstringהתאריך הראשון (YYYY-MM-DD) (templated_schedule)
tostringהתאריך האחרון (YYYY-MM-DD) (templated_schedule)
display_settings_writeמסכי תצוגה

משנה את הגדרות Display Screens של מתקן: מסך הגיבוי, תשאול וטעינה מחדש לילית, ו-"Allow CCTV on display screens"; לוח הזמנים של הפעלת המסכים; ואוטומציות (בהירות, עוצמת הפעמון, הפעלה בצ'ק-אין). שדות שלא תכללו ישמרו על הערכים הנוכחיים שלהם. הגדרות ברמת המותג (מסך האתחול, Templated content) נמצאות ב-display_brand_settings_write.

פעולות:

  • save_settings: שמירת הגדרות התצוגה של המתקן. מסך הגיבוי שמוצג כשלא מתוזמן דבר, מרווח התשאול (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"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
slateobject(save_settings)
pollIntervalSecinteger(save_settings)
nightlyReloadTimestringHH:mm (save_settings)
allowCctvbooleanהתרת הצגת טלוויזיה במעגל סגור במסכי התצוגה (save_settings)
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
scheduleobjectהמסכים פועלים בשעות הנוכחות של הצוות (מורחבות לפי ההיסטים) או בחלונות השבועיים המותאמים אישית, עם כלל לחגים. (save_power_schedule)
autoPowerDisplaysbooleanאוטומציית ההפעלה הישנה מופעלת/כבויה (לוח הזמנים של ההפעלה מחליף אותה) (save_automations)
minsBeforeOpenDisplayOnintegerאוטומציית ההפעלה הישנה: דקות לפני הפתיחה (save_automations)
minsAfterCloseDisplayOffintegerאוטומציית ההפעלה הישנה: דקות אחרי הסגירה (save_automations)
displaysOnCheckInbooleanהדלקת המסכים כשמישהו מבצע צ'ק-אין (save_automations)
minsLastCheckInDisplayOffintegerעם displaysOnCheckIn: כמה דקות אחרי הצ'ק-אין האחרון המסכים נכבים (save_automations)
enableAutoBrightnessbooleanמעבר בין בהירות יום לבהירות לילה (save_automations)
dayTriggerType"auto" | "staffed" | "custom"מתי בהירות היום מתחילה (save_automations)
dayTimeStartstringעבור dayTriggerType custom: HH:mm (שעון המתקן) (save_automations)
dayOffsetMinutesintegerדקות אחרי הזריחה או הפתיחה (save_automations)
dayBrightnessLevelintegerבהירות יום, % (save_automations)
nightTriggerType"auto" | "staffed" | "custom"מתי בהירות הלילה מתחילה (save_automations)
nightTimeStartstringעבור nightTriggerType custom: HH:mm (שעון המתקן) (save_automations)
nightOffsetMinutesintegerדקות אחרי רדת הלילה, או לפני הסגירה (save_automations)
nightBrightnessLevelintegerבהירות לילה, % (save_automations)
bellMasterLevelintegerעוצמת הפעמון הראשית, % (save_automations)
bellClubHoursLevelintegerעוצמת הפעמון בשעות הנוכחות של הצוות, % (save_automations)
bellExtendedHoursLevelintegerעוצמת הפעמון בשעות המורחבות, % (save_automations)
enableBellAutoVolumebooleanמעקב אחר לוח הזמנים של עוצמת הפעמון (save_automations)
bellVolumeScheduleobjectמקטעים שבועיים של עוצמת הפעמון לכל יום בשבוע (mon … sun); מחליף את כל לוח הזמנים (save_automations)
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
display_takeover_stopמסכי תצוגה

מסיים מיד השתלטויות פעילות של Display Screens: עבור פרסום אחד (batchId מ-display_publish), עבור יעדים (ברירת מחדל: השתלטויות שפורסמו למתקן כולו), או עם allScreens עבור כל השתלטות שפורסמה למתקן, למסכים שלו או לקבוצות שלהם. השתלטויות של מותג וארגון נעצרות רק לפי batchId. המסכים חוזרים לתוכן המתוזמן או לתוכן ברירת המחדל שלהם בתוך שניות; מחזיר כמה השתלטויות נעצרו. כשניתנים כמה מסכים, קבוצות או יעדים, הכלי פועל על כולם בקריאה אחת; בדקו עם המשתמש לפני שאתם פועלים על רבים.

פרמטרים

שםסוגתיאור
batchIdstringפרסום ההשתלטות (bt_…) מ-display_publish
targetsobjectלאן התוכן הולך. אפשר לשלב כל אחד מאלה. שמות קבוצות עובדים כמו מזהים. brand ו-organisation דורשים גישה ל-Display Screens ברמת הארגון כולו.
allScreensbooleanכל השתלטות שפורסמה למתקן, למסכים שלו או לקבוצות שלהם
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
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"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
facilityIdsarrayכמה מזהי מתקנים, כדי להריץ את אותה בקשה בכל אחד מהם. השתמשו בזה במקום facilityId. (load_program)
datestringתאריך האימון, YYYY-MM-DD (ברירת מחדל היום) (load_program)
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
command"getstate" | "play" | "pause" | "restart" | "stop" | "mute" | "unmute" | "setvolume"(clock)
volumeintegerעבור setvolume: עוצמת הפעמון, % (clock)
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה