PLAYDECK API एक ऐसा निर्माण है जो किसी को भी PLAYDECK के साथ इंटरफ़ेस करने की अनुमति देता है। यह लेख दिखाएगा कि API के साथ विकास कैसे शुरू करें:
इस लेख में:
→ परिचय
→ उदाहरण
→ एपीआई लागू करें
परिचय
PLAYDECK API द्वि-दिश है: आप प्लेआउट स्थिति प्राप्त करते हैं, लेकिन आप PLAYDECK को कमांड भी भेज सकते हैं।.
यह API WebSockets पर आधारित है: ये JavaScript का हिस्सा हैं, इसलिए आप JavaScript, NodeJS या TypeScript में विकास कर सकते हैं। WebSocket पोर्ट 11411 पर स्थिर है और PLAYDECK में हमेशा सक्षम रहता है।.
हमने WebSockets का उपयोग करने का निर्णय लिया, क्योंकि:
- यह दोनों दिशाओं का समर्थन करता है: PLAYDECK से और PLAYDECK तक
- कोई इंस्टॉलेशन आवश्यक नहीं: किसी भी टेक्स्ट-एडिटर का उपयोग करें
- कोई विशिष्ट नेटवर्क सुरक्षा आवश्यक नहीं है।
- HTML के साथ अपना यूज़र इंटरफ़ेस या एनीमेशन बनाना आसान है।
PLAYDECK को क्या भेजा जा सकता है?
- CUE या ब्लॉक्स या क्लिप्स, ओवरले या एक्शन्स चलाएँ
- स्ट्रीम जैसी वीडियो संपत्तियों को शुरू/रोकें
PLAYDECK से क्या प्राप्त किया जा सकता है?
- घटनाएँ (उदाहरण के लिए, एक ब्लॉक या क्लिप शुरू हो गया है)
- प्लेआउट स्थिति (उदाहरण के लिए क्या चल रहा है और शेष ब्लॉक समय)
- सामग्री (उदाहरण के लिए ब्लॉक्स और क्लिप्स के साथ पूरी प्लेलिस्ट)
उदाहरण
1) साथी
PLAYDECK मॉड्यूल में bitfocus Companion द्वारा PLAYDECK API का उपयोग किया जा रहा है। यह आपको API की क्षमताओं का त्वरित अनुभव प्रदान करता है:
https://playdeck.tv/howto/companion/
2) निदेशक का दृश्य
यह API डायरेक्टर व्यू द्वारा भी उपयोग की जाती है, जो PLAYDECK का हिस्सा है। आप HTML टेम्प्लेट्स यहाँ पा सकते हैं:
सी:\उपयोगकर्ता\पब्लिक\दस्तावेज़\जॉयइवेंटमीडिया\प्लेडेक\एचटीएमएल-टेम्प्लेट्स\डायरेक्टर-व्यू
3) HTML ओवरले
एपीआई का उपयोग कुछ HTML अवलोकन उदाहरणों में भी किया जाता है, जिन्हें आप यहाँ पा सकते हैं:
सी:\उपयोगकर्ता\पब्लिक\दस्तावेज़\जॉयइवेंटमीडिया\प्लेडेक\एचटीएमएल-टेम्पलेट्स\ओवरले-टेम्पलेट्स
एपीआई लागू करें
हमने आपके लिए एक चलती हुई स्क्रिप्ट को जल्दी से समीक्षा करने के लिए कुछ उदाहरण तैयार किए हैं। कृपया इन्हें क्रम से देखें, क्योंकि ये एक-दूसरे पर आधारित हैं।.
सुझाव 1: आप किसी भी HTML फ़ाइल पर डबल-क्लिक करके उसे ब्राउज़र में खोल सकते हैं और स्क्रिप्ट/API शुरू कर सकते हैं।
सुझाव 2: आप IP पता बदलने के लिए फ़ाइल “WebSocketSDK\Version.js” को संपादित कर सकते हैं।
1) नेटिव कनेक्शन (एपीआई के बिना)
आइए कुछ बहुत ही न्यूनतावादी चीज़ से शुरू करें:
c:\Users\Public\Documents\JoyEventMedia\Playdeck\HTML-Templates\Automation-And-UI\SampleMinimalistic.html
यह मूल जावास्क्रिप्ट कोड के साथ PLAYDECK के लिए वेबसॉकेट खोलेगा और पहले ब्लॉक में पहले क्लिप को प्ले करने का कमांड भेजेगा।.
एक और उदाहरण यह है, जहाँ आप HTML में बटनों पर क्लिक करके PLAYDECK में प्लेआउट शुरू कर सकते हैं:
c:\Users\Public\Documents\JoyEventMedia\Playdeck\HTML-Templates\Automation-And-UI\SampleUserInterface.html
2) न्यूनतम कनेक्शन (API के साथ)
यह उदाहरण एपीआई का परिचय देगा:
c:\Users\Public\Documents\JoyEventMedia\Playdeck\HTML-Templates\Automation-And-UI\SampleMinimalisticSDK.html
यह “WebSocketAPI” उपफ़ोल्डर का उपयोग करता है और इसमें इसका मुख्य स्क्रिप्ट “AppInterface.js” शामिल है, जो पूरे API के लिए एक तरह का “लोडर” है।.
API अब आपके WebSocket कनेक्शन को PLAYDECK के साथ संभाल लेगी, इसलिए आपको इसे मैन्युअली कोड करने की आवश्यकता नहीं है। API जावास्क्रिप्ट के लिए एक टेम्पलेट फ्रेमवर्क भी प्रदान करती है। टेम्पलेट का नाम फ़ाइल नाम से लिया जाता है, इसलिए इसका मिलना आवश्यक है। कई पूर्व-परिभाषित फ़ंक्शन उपलब्ध हैं। इस उदाहरण में हम केवल “Start” का उपयोग करते हैं: यह फ़ंक्शन API द्वारा तब कॉल किया जाएगा जब PLAYDECK के साथ WebSocket कनेक्शन सफलतापूर्वक स्थापित हो जाएगा। इस उदाहरण में यह चैनल 1 का पहला क्लिप प्ले करेगा।.
3) और फ्रेमवर्क फ़ंक्शन
“Start” के अलावा और भी कई फ्रेमवर्क फ़ंक्शन उपलब्ध हैं:
c:\Users\Public\Documents\JoyEventMedia\Playdeck\HTML-Templates\Automation-And-UI\SamplePlayRandomClip.html
कृपया सभी उपलब्ध फ़ंक्शन्स के लिए JS फ़ाइल में टिप्पणियाँ देखें।.
यदि आप ब्राउज़र कंसोल (आमतौर पर F12 से) खोलते हैं, तो आप “console.log” निर्देशों की प्रतिक्रिया देख सकते हैं।.
4) परियोजना डेटा पार्स करें
सभी क्लिप्स तक पहुँचने के लिए “DataProject” फ़ंक्शन उपलब्ध है और यह उदाहरण दिखाता है कि प्रोजेक्ट डेटा को कैसे सूचीबद्ध किया जाए:
c:\Users\Public\Documents\JoyEventMedia\Playdeck\HTML-Templates\Automation-And-UI\SampleShowPlaylist.html
5) कस्टम शेड्यूल का नमूना
अंतिम उदाहरण PLAYDECK के बाहर कस्टम शेड्यूलिंग के लिए एक पूर्ण, कार्यशील और संपूर्ण स्क्रिप्ट दिखाता है:
c:\Users\Public\Documents\JoyEventMedia\Playdeck\HTML-Templates\Automation-And-UI\SampleWeeklySchedule.html
