डिस्प्ले स्क्रीन
कोर प्लेटफ़ॉर्म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 | छवि का सार्वजनिक https URL (save_boot_screen) |
imageBase64 | string | URL न होने पर, base64 के रूप में छवि (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डिस्प्ले स्क्रीनDisplay Screens के लिए स्थैतिक HTML ऐप्स ("hosted apps") प्रकाशित करता है। स्क्रीन आकार, डिज़ाइन नियमों, सीमाओं और SDK के लिए पहले display_library_read app_guidelines कॉल करें, और बाद में स्क्रीन पर परिणाम जाँचने के लिए 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 सामग्री Library पढ़ता है: मीडिया (छवियाँ, वीडियो), ऐप्स (वेब पेज, होस्टेड HTML ऐप्स, एआई एजेंट ऐप्स, सीसीटीवी व्यू) और प्लेलिस्ट, साथ ही वे एआई एजेंट ऐप्स और सीसीटीवी स्रोत जिन्हें जोड़ा जा सकता है।
प्रत्येक आइटम का display_publish और प्लेलिस्ट के लिए एक contentRef (media#…, app#…, playlist#…) होता है। ownerScope दिखाता है कि इसका स्वामी कौन है (facility#, brand# या org#); सामग्री केवल उसके स्वामी के भीतर ही प्रकाशित की जा सकती है। status processing वाला मीडिया अभी तैयार नहीं है; failed को फिर से अपलोड करना होगा। frameable: false वाले वेब पेज प्लेलिस्ट में नहीं चल सकते, केवल पूर्ण-पेज स्क्रीन के रूप में। displayIssue वाले आइटम स्क्रीन द्वारा छोड़ दिए जाते हैं: ऐसा एआई एजेंट ऐप जो unpublished, paused, display-off, audience-limited है या जिसमें Custom Apps नहीं है; no-cctv, cctv-off (सुविधा एडमिन Display Screens सेटिंग्स में स्क्रीन के लिए सीसीटीवी चालू करता है) या no-cameras वाला सीसीटीवी व्यू।
क्रियाएँ:
- list: Library आइटम सूचीबद्ध करें। मीडिया और ऐप्स (पेज में; type, kind, tag या name से फ़िल्टर करें), या type agent-apps के साथ स्क्रीन पर अनुमत वे एआई एजेंट ऐप्स जिन्हें आप display_publish content.agentAppId से प्रकाशित कर सकते हैं। प्रत्येक आइटम का एक type होता है: media, app या agent-app।
- cctv_sources: सीसीटीवी स्रोत सूचीबद्ध करें। display_publish content.cctv के लिए सुविधा के कैमरे और साझा Live View, और यह कि स्क्रीन पर सीसीटीवी चालू है या नहीं। सुविधा में सीसीटीवी पहुँच आवश्यक है।
- get: Library आइटम प्राप्त करें। 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 | सार्वजनिक https URL (check_url) |
display_library_writeडिस्प्ले स्क्रीनDisplay Screens Library सामग्री जोड़ता और बदलता है: छवियाँ और वीडियो अपलोड करें, वेब पेज, एआई एजेंट ऐप और सीसीटीवी व्यू ऐप्स बनाएँ, नाम, टैग, अवधि और तिथियाँ संपादित करें, अप्रयुक्त आइटम हटाएँ, और किसी ऐप का पूर्वावलोकन रीफ़्रेश करें। होस्टेड HTML ऐप्स display_hosted_apps_write से प्रकाशित किए जाते हैं; प्लेलिस्ट display_playlists_write से।
छवियाँ 1920×1080 (लैंडस्केप) या 1080×1920 (पोर्ट्रेट) पर डिज़ाइन करें। नया मीडिया processing के रूप में शुरू होता है जबकि वेब-तैयार संस्करण बनाए जाते हैं; इसे तुरंत प्लेलिस्ट में डाला जा सकता है और तैयार होते ही यह चलने लगता है। ownerScope: facility (डिफ़ॉल्ट), brand या organisation (brand और organisation के लिए संगठन-व्यापी पहुँच आवश्यक है)।
क्रियाएँ:
- upload_media: छवि या वीडियो अपलोड करें। किसी सार्वजनिक https url (पसंदीदा; छवियाँ 25 MB तक, वीडियो 200 MB तक) या mimeType के साथ base64 (20 MB तक) से छवि या वीडियो जोड़ता है। JPEG, PNG, WebP, GIF छवियाँ; MP4, WebM, MOV वीडियो (1080p तक H.264 MP4 में बदले जाते हैं)। बड़े वीडियो: create_video_upload।
- create_video_upload: बड़े वीडियो का अपलोड शुरू करें। 2 GB तक के वीडियो के लिए: वीडियो दर्ज करता है और एक presigned अपलोड लौटाता है (upload.expiresAt से पहले upload.headers के साथ फ़ाइल को upload.url पर PUT करें), फिर उसके contentRef के साथ transcode कॉल करें। name, mimeType, bytes आवश्यक हैं।
- transcode: वीडियो प्रोसेस करें। स्क्रीन के लिए वीडियो बदलता है: create_video_upload के बाद, किसी विफलता के बाद दोबारा, या ऐसे पुराने वीडियो के लिए जिसे स्क्रीन नहीं चला सकतीं। contentRef आवश्यक है।
- create_app: ऐप जोड़ें। एक वेब पेज (kind url, url दें; फ़्रेमिंग के लिए जाँचा जाता है), एक एआई एजेंट ऐप (kind agent-app, display_library_read list type agent-apps से agentAppId दें) या एक सीसीटीवी व्यू (kind cctv-view, सुविधा के स्वामित्व वाला, सीसीटीवी पहुँच आवश्यक) जोड़ता है। kind, name आवश्यक हैं।
- update: Library आइटम अपडेट करें। किसी मीडिया आइटम या ऐप का नाम, टैग या अवधि; किसी मीडिया आइटम का validFrom/validTo (ISO, null साफ़ करता है; इनके बाहर इसे छोड़ दिया जाता है); किसी वेब पेज का url; या किसी सीसीटीवी व्यू के कैमरे, व्यू, लेआउट या गुणवत्ता बदलता है। contentRef आवश्यक है।
- delete: Library आइटम हटाएँ। किसी मीडिया आइटम या ऐप को हटाता है। जब तक यह किसी लाइव शेड्यूल या प्लेलिस्ट में है, अवरुद्ध रहता है: त्रुटि उन्हें सूचीबद्ध करती है (पहले उन्हें display_schedule_write delete या display_playlists_write save से हटाएँ)। contentRef आवश्यक है। पुष्टि माँगता है।
- refresh_preview: ऐप का पूर्वावलोकन रीफ़्रेश करें। ऐप के Library पूर्वावलोकन के लिए उसका नया स्क्रीनशॉट लेता है (उदाहरण के लिए पेज बदलने के बाद)। contentRef आवश्यक है।
पैरामीटर
| नाम | प्रकार | विवरण |
|---|---|---|
action* | "upload_media" | "create_video_upload" | "transcode" | "create_app" | "update" | "delete" | "refresh_preview" | क्या करना है; प्रत्येक क्रिया का वर्णन टूल विवरण में है। |
url | string | छवि या वीडियो का सार्वजनिक https URL (पसंदीदा) (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 | Library नाम (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 | एआई एजेंट ऐप्स: ऐप ID (create_app) |
source | "view" | "cameras" | सीसीटीवी व्यू: view (viewId दें) या cameras (cameras दें) (create_app, update) |
viewId | string | सीसीटीवी व्यू: Live View ID (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 पर सामग्री लगाता है: एक मीडिया आइटम, प्लेलिस्ट, ऐप, वेब पेज, एआई एजेंट ऐप या सीसीटीवी लाइव व्यू, स्क्रीन, समूहों, सुविधा, उसके ब्रांड या उसके संगठन पर।
mode: now (डिफ़ॉल्ट) लक्ष्यों पर सामान्य रूप से दिखने वाली सामग्री को बदल देता है; scheduled इसे केवल साप्ताहिक विंडो (सुविधा के समय क्षेत्र में) में और/या from और to के बीच दिखाता है; takeover durationMin तक (या किसी समय तक) बाकी सब कुछ बाधित करता है, फिर अपने आप समाप्त हो जाता है (समय से पहले रोकने के लिए display_takeover_stop)। स्क्रीन तय करती हैं कि क्या दिखाना है, पहले लेयर के अनुसार (takeover > scheduled > default), फिर इस अनुसार कि लक्ष्य कितना विशिष्ट है (screen > group > facility > brand > organisation)।
सीसीटीवी: लाइव कैमरा फ़ीड स्क्रीन के पास मौजूद किसी को भी दिखाई देती हैं। पहली कॉल requiresConfirmation (code CCTV_CONFIRMATION_REQUIRED) लौटाती है; उपयोगकर्ता से पूछें, फिर confirmCctv: true के साथ दोबारा कॉल करें। सुविधा में "Allow CCTV on display screens" चालू होना चाहिए।
केवल player-mode स्क्रीन प्रकाशित सामग्री दिखाती हैं; अन्य स्क्रीन 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 | display_screens_read list से स्क्रीन ID (6-अक्षरों वाला कोड) (get) |
at | string | यह जाँचने के लिए ISO दिनांक-समय कि क्या चल रहा है (डिफ़ॉल्ट अभी) (get) |
from | string | ISO टाइमलाइन प्रारंभ (डिफ़ॉल्ट at, अन्यथा अभी) (get) |
to | string | ISO टाइमलाइन समाप्ति (डिफ़ॉल्ट from के 24 घंटे बाद) (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 पर प्रकाशित सामग्री बदलता है: किसी असाइनमेंट का समय, प्राथमिकता या सामग्री संपादित करें (वैकल्पिक रूप से उसके पूरे प्रकाशन में), या एक असाइनमेंट या पूरा प्रकाशन हटाएँ। display_schedule_read से ID खोजें। शेड्यूल से सामग्री हटाने पर वह Library में बनी रहती है; किसी takeover को उसका इतिहास रखते हुए समय से पहले समाप्त करने के लिए display_takeover_stop का उपयोग करें।
क्रियाएँ:
- update: असाइनमेंट अपडेट करें। किसी असाइनमेंट का समय (साप्ताहिक विंडो, from/to; null किसी तिथि को साफ़ करता है), प्राथमिकता या सामग्री बदलता है। applyToBatch प्रकाशन के हर लक्ष्य पर वही बदलाव करता है। किसी takeover का केवल समाप्ति समय बदला जा सकता है। सीसीटीवी सामग्री के लिए उपयोगकर्ता की सहमति के बाद confirmCctv आवश्यक है। assignmentId आवश्यक है।
- delete: शेड्यूल से हटाएँ। एक असाइनमेंट (assignmentId) या किसी एक प्रकाशन की सारी सामग्री (batchId) हटाता है। स्क्रीन कुछ ही सेकंड में वही दिखाने लगती हैं जो वे अन्यथा दिखातीं। पुष्टि माँगता है।
पैरामीटर
| नाम | प्रकार | विवरण |
|---|---|---|
action* | "update" | "delete" | क्या करना है; प्रत्येक क्रिया का वर्णन टूल विवरण में है। |
assignmentId | string | display_schedule_read से एक असाइनमेंट (as_…) |
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 | display_publish या display_schedule_read से एक पूरा प्रकाशन (bt_…), उसके सभी लक्ष्यों पर (delete) |
confirm | boolean | केवल तभी सेट करें जब उपयोगकर्ता ने पहली कॉल से लौटाए गए पूर्वावलोकन की पुष्टि कर दी हो |
display_screen_commandडिस्प्ले स्क्रीनकिसी सुविधा में Display Screens को लाइव कमांड भेजता है: reload (प्लेयर स्क्रीन अपना शेड्यूल फिर से प्राप्त करती हैं), identify (स्क्रीन का नाम और कोड फ़्लैश करता है, ताकि उसे स्थल पर खोजा जा सके), displayOn/displayOff (TV पैनल), rebootDevice (स्क्रीन के कंप्यूटर को रीस्टार्ट करता है, 1–2 मिनट तक खाली; confirm: true आवश्यक) या osd (एक छोटा ऑन-स्क्रीन संदेश; message दें)।
screenIds और/या groupIds (सुविधा में उन समूहों की हर स्क्रीन) से स्क्रीन चुनें, या सुविधा की हर स्क्रीन के लिए allScreens: true (तब displayOn/displayOff templated content स्क्रीन तक भी पहुँचते हैं)। प्रति-स्क्रीन परिणाम लौटाता है। जब कई स्क्रीन, समूह या लक्ष्य दिए जाते हैं, तो यह एक ही कॉल में उन सभी पर कार्य करता है; कई पर कार्य करने से पहले उपयोगकर्ता से पूछ लें।
पैरामीटर
| नाम | प्रकार | विवरण |
|---|---|---|
screenIds | array | display_screens_read list से स्क्रीन ID (6-अक्षरों वाले कोड)। 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 पढ़ता है: उन्हें उनकी स्थिति और अभी तथा आगे क्या चल रहा है, इसके साथ सूचीबद्ध करें (समूह, स्थिति या display mode से फ़िल्टर करें), किसी एक स्क्रीन का पूरा विवरण और टाइमलाइन प्राप्त करें, या स्क्रीन समूहों को उनकी स्क्रीन के साथ सूचीबद्ध करें।
Display mode उपयोगकर्ताओं को "Data Source" के रूप में दिखाया जाता है: player "User managed content" है, program-builder "Templated content" है (उपयोगकर्ताओं से हमेशा "Templated content" ही कहें), url "Full-page website (Kiosk Mode)" है। समय ISO में हैं; सुविधा का समय क्षेत्र लौटाया जाता है।
क्रियाएँ:
- list: स्क्रीन सूचीबद्ध करें। सुविधा की स्क्रीन (पेज में), प्रत्येक की स्थिति, अंतिम heartbeat, समूह, टैग और अभी तथा आगे क्या चल रहा है। समूह भी लौटाता है।
- get: स्क्रीन प्राप्त करें। एक स्क्रीन का पूरा विवरण (स्थिति, heartbeat, प्लेयर संस्करण, हाल की त्रुटियाँ) और, प्लेयर स्क्रीन के लिए, वह किसी समय सीमा में क्या दिखाती है (डिफ़ॉल्ट अगले 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 | display_screens_read list से स्क्रीन ID (6-अक्षरों वाला कोड) (get) |
from | string | टाइमलाइन का ISO प्रारंभ (डिफ़ॉल्ट अभी) (get) |
to | string | टाइमलाइन की ISO समाप्ति (डिफ़ॉल्ट from के 24 घंटे बाद) (get) |
display_screens_writeडिस्प्ले स्क्रीनडिवाइस प्रबंधनDisplay Screens बदलता है: किसी नई स्क्रीन को उसके पेयरिंग कोड से पेयर करें; किसी स्क्रीन का नाम बदलें, उसके समूह और टैग सेट करें, या उसका display mode बदलें (उपयोगकर्ताओं को "Data Source" के रूप में दिखाया जाता है); किसी प्लेयर स्क्रीन का टोकन रोटेट करें; किसी स्क्रीन या सामग्री का समय-सीमित पूर्वावलोकन लिंक बनाएँ; या किसी स्क्रीन को फ़ैक्टरी रीसेट करें (उसे सुविधा से हटा देता है)।
Display mode: player ("User managed content"), url ("Full-page website (Kiosk Mode)", url दें, केवल https), program-builder ("Templated content"; उपयोगकर्ताओं से हमेशा "Templated content" ही कहें)। mode बदलने से स्क्रीन तुरंत रीलोड होती है और सदस्यों को दिखने वाली सामग्री बदल जाती है, इसलिए उपयोगकर्ता की पुष्टि आवश्यक है।
क्रियाएँ:
- update: स्क्रीन अपडेट करें। किसी स्क्रीन का नाम, समूह (ID या नाम; वर्तमान समूहों को बदल देते हैं), टैग (उन्हें बदल देते हैं) और/या display mode सेट करता है। mode बदलने पर पहले requiresConfirmation लौटाता है। screenId आवश्यक है। पुष्टि माँग सकता है।
- rotate_token: स्क्रीन टोकन रोटेट करें। किसी प्लेयर स्क्रीन के लिए नया टोकन जारी करता है और उसे रीलोड करता है; पुराना टोकन काम करना बंद कर देता है। तब उपयोग करें जब किसी स्क्रीन का प्लेयर 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" | क्या करना है; प्रत्येक क्रिया का वर्णन टूल विवरण में है। |
screenId | string | display_screens_read list से स्क्रीन ID (6-अक्षरों वाला कोड) (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 mode के लिए वेबसाइट (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: वह स्ट्रीम (round) जो यह चलाती है, डिफ़ॉल्ट 1 (pair) |
confirm | boolean | केवल तभी सेट करें जब उपयोगकर्ता ने पहली कॉल से लौटाए गए पूर्वावलोकन की पुष्टि कर दी हो |
display_screenshotडिस्प्ले स्क्रीनकोई Display Screen अभी क्या दिखा रही है उसे कैप्चर करता है और छवि लौटाता है, ताकि आप प्रकाशित करने के बाद अपना काम जाँच सकें (लेआउट, टेक्स्ट का आकार, कुछ भी कटा हुआ या स्क्रॉल होता हुआ नहीं)। स्क्रीन के उत्तर के लिए 15 सेकंड तक प्रतीक्षा करता है; ऑफ़लाइन स्क्रीन का समय समाप्त हो जाता है। JPEG के लिए एक पोर्टल URL भी लौटाता है (केवल साइन-इन किए गए उपयोगकर्ताओं के लिए, 10 मिनट तक रखा जाता है)।
स्क्रीनशॉट में लाइव सीसीटीवी और दिखाई दे रहे सदस्य शामिल हो सकते हैं; उन्हें बातचीत के बाहर साझा न करें।
पैरामीटर
| नाम | प्रकार | विवरण |
|---|---|---|
screenId* | string | display_screens_read list से स्क्रीन ID (6-अक्षरों वाला कोड) |
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 | स्क्रीन पर सीसीटीवी की अनुमति ("Allow CCTV on display screens") (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डिस्प्ले स्क्रीनचल रहे Display Screens takeover को अभी समाप्त करता है: किसी एक प्रकाशन के लिए (display_publish से batchId), लक्ष्यों के लिए (डिफ़ॉल्ट: पूरी सुविधा पर प्रकाशित takeover), या allScreens के साथ सुविधा, उसकी स्क्रीन या उनके समूहों पर प्रकाशित हर takeover के लिए। ब्रांड और संगठन takeover केवल batchId से रुकते हैं। स्क्रीन कुछ ही सेकंड में अपनी शेड्यूल की गई या डिफ़ॉल्ट सामग्री पर लौट आती हैं; लौटाता है कि कितने takeover रुके। जब कई स्क्रीन, समूह या लक्ष्य दिए जाते हैं, तो यह एक ही कॉल में उन सभी पर कार्य करता है; कई पर कार्य करने से पहले उपयोगकर्ता से पूछ लें।
पैरामीटर
| नाम | प्रकार | विवरण |
|---|---|---|
batchId | string | display_publish से takeover प्रकाशन (bt_…) |
targets | object | सामग्री कहाँ जाती है। इनमें से किसी को भी मिलाएँ। समूह के नाम भी ID की तरह काम करते हैं। brand और organisation के लिए संगठन-व्यापी Display Screens पहुँच आवश्यक है। |
allScreens | boolean | सुविधा, उसकी स्क्रीन या उनके समूहों पर प्रकाशित हर takeover |
facilityId | string | सुविधा ID। जब कनेक्टेड सुविधा ही आपकी अभीष्ट सुविधा हो, तो वैकल्पिक। |
display_templated_writeडिस्प्ले स्क्रीनtemplated content स्क्रीन (display_screens_read में display mode "Templated content") को नियंत्रित करता है: उन पर किसी दिन का वर्कआउट प्रोग्राम लोड करें, या राउंड टाइमर नियंत्रित करें। User managed content और पूर्ण-पेज वेबसाइट स्क्रीन कभी प्रभावित नहीं होतीं।
क्रियाएँ:
- load_program: वर्कआउट प्रोग्राम लोड करें। एक या कई सुविधाओं की हर templated content स्क्रीन पर सुविधा के डेटा स्रोत से किसी तिथि का वर्कआउट प्रोग्राम (YYYY-MM-DD, डिफ़ॉल्ट आज) लोड करता है; स्क्रीन कुछ ही सेकंड में रीलोड होती हैं। आज का या किसी अन्य दिन का वर्कआउट दिखाने के लिए, या जब स्क्रीन गलत वर्कआउट दिखा रही हों, तब इसका उपयोग करें। कई सुविधाओं के लिए 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 | केवल तभी सेट करें जब उपयोगकर्ता ने पहली कॉल से लौटाए गए पूर्वावलोकन की पुष्टि कर दी हो |