अवर्गीकृत

प्लेडेक एपीआई

२६ अक्टूबर, २०२५ द्वारा

हमारे मानक REST API (OpenAPI 3) और WebSocket इंटरफ़ेस का उपयोग करके PLAYDECK को स्क्रिप्ट्स, ऑटोमेशन सिस्टम और कस्टम यूज़र इंटरफ़ेस में एकल पोर्ट पर रीयल-टाइम नियंत्रण के लिए एकीकृत करें।.

इस लेख में:
→ मुझे किस इंटरफ़ेस की आवश्यकता है?
→ REST API क्विकस्टार्ट
→ इंटरैक्टिव एपीआई संदर्भ
→ वेबसॉकेट रीयल-टाइम चैनल
→ विरासत टीसीपी कमांड इनपुट
→ एकीकरण उदाहरण

मुझे किस इंटरफ़ेस की आवश्यकता है?

PLAYDECK आपकी एकीकरण आवश्यकताओं के अनुसार विभिन्न इंटरफेस प्रदान करता है। सही प्रोटोकॉल और पोर्ट चुनने के लिए निम्नलिखित अवलोकन का उपयोग करें:

उपयोग मामलाअनुशंसित इंटरफ़ेसबंदरगाह
स्क्रिप्ट्स, cURL, पोस्टमैन, कस्टम HTTP इंटीग्रेशनआरईएसटी एपीआई एपीआई संस्करण 1 (ओपनएपीआई 3)11411
लाइव स्थिति, इवेंट्स, HTML ओवरले, बिटफ़ोकस कंपैनियनवेबसॉकेट चैनल11411
तैयार नियंत्रण सतहेंबिटफ़ोकस कंपैनियन (वेबसॉकेट के माध्यम से)11411
विरासत टीसीपी क्लाइंट्स / मौजूदा स्वचालन पाइपलाइनेंटीसीपी कमांड्स इन11375

सिफारिश: अधिकांश नए एकीकरण परियोजनाओं को के साथ शुरू किया जाना चाहिए। आरईएसटी एपीआई. में स्विच करें या इसे इसके साथ मिलाएँ वेबसॉकेट केवल तभी जब आपको निरंतर, कम विलंबता वाले स्थिति अपडेट या वास्तविक-समय के इवेंट ट्रिगर की आवश्यकता हो।.

REST API क्विकस्टार्ट

जब PLAYDECK चल रहा होता है, तो HTTP REST API स्वचालित रूप से पोर्ट पर उपलब्ध होती है। 11411 (बिल्ट-इन वेब रिमोट के समान सेवा साझा करना)।.

आधार यूआरएल

http://HOST:11411/api/v1


बदलें मेज़बान आपकी PLAYDECK मशीन के वास्तविक आईपी पते के साथ, जो के अंतर्गत पाया जाता है। सेटिंग्स ➔ नेटवर्क ➔ डेवलपर एपीआई.

PLAYDECK के अंदर परीक्षण

परीक्षण शुरू करने के लिए आपको बाहरी उपकरणों की आवश्यकता नहीं है। खोलें सेटिंग्स ➔ नेटवर्क ➔ डेवलपर एपीआई सॉफ़्टवेयर एप्लिकेशन के भीतर, UI से सीधे नमूना अनुरोध भेजने या इंटरैक्टिव दस्तावेज़ीकरण लॉन्च करने के लिए।.

HTTP अनुरोध उदाहरण

1. सेवा स्वास्थ्य जाँच:

GET /api/v1/health HTTP/1.1
होस्ट: HOST:11411


2. Playout स्थिति प्राप्त करें (JSON प्रतिक्रिया):

GET /api/v1/status HTTP/1.1
होस्ट: HOST:11411


3. Playout चैनल 1 पर प्ले ट्रिगर करें:

POST /api/v1/channels/1/play HTTP/1.1
होस्ट: HOST:11411


4. Playout चैनल 1 पर ब्लॉक 1, क्लिप 2 चलाएँ:

POST /api/v1/channels/1/play/1/2 HTTP/1.1
होस्ट: HOST:11411


कई क्रियाएँ लक्षित नियंत्रण के लिए वैकल्पिक पथ पैरामीटर स्वीकार करती हैं (जैसे ब्लॉक/क्लिप आईडी, टाइमकोड ऑफ़सेट, या ओवरले आईडी)।.

विरासत कमांड एस्केप हैच

यदि आपको HTTP के माध्यम से क्लासिक PLAYDECK कमांड भाषा की पूरी कवरेज चाहिए, तो आप पाइप-फ़ॉर्मैटेड कमांड्स को समर्पित कमांड्स एंडपॉइंट में भेज सकते हैं:

POST /api/v1/commands HTTP/1.1
Host: HOST:11411
Content-Type: application/json

{
  "command": "play",
  "args": ["1", "1", "2"]
}


नोट: वर्तमान संस्करण में स्थानीय क्षेत्र नेटवर्क (LAN) संचालन के लिए किसी API कुंजी या प्रमाणीकरण टोकन की आवश्यकता नहीं है।.

इंटरैक्टिव एपीआई संदर्भ

इस इंटरफ़ेस के लिए संपूर्ण मशीन-पठनीय अनुबंध OpenAPI 3 विनिर्देश दस्तावेज़ के रूप में प्रदान किया गया है।.

➔ डाउनलोड: ओपनएपीआई विनिर्देश (YAML)

इंटरैक्टिव ब्राउज़िंग, पेलोड निरीक्षण, और आपके सक्रिय PLAYDECK इंस्टेंस पर सीधे “Try it out” परीक्षण के लिए:

  1. प्रक्षेपण प्लेडेक.
  2. पर जाएँ सेटिंग्स ➔ नेटवर्क ➔ डेवलपर एपीआई और क्लिक करें ओपन एपीआई संदर्भ.
  3. वैकल्पिक रूप से, उसी नेटवर्क के किसी भी कंप्यूटर पर वेब ब्राउज़र खोलें और इस पते पर जाएँ: http://HOST:11411/api/v1/docs

यह दस्तावेज़ीकरण पृष्ठ गतिशील रूप से सभी उपलब्ध REST एंडपॉइंट्स, आवश्यक पैरामीटर, स्कीमा परिभाषाएँ और अपेक्षित प्रतिक्रिया पेलोड्स को सूचीबद्ध करता है।.

    वेबसॉकेट रीयल-टाइम चैनल

    बंदरगाह 11411 एक साथ WebSocket कनेक्शनों को संभालता है। यह द्वि-दिशीय चैनल विशेष रूप से उन संचालनों के लिए डिज़ाइन किया गया है जिन्हें निरंतर डेटा स्ट्रीमिंग की आवश्यकता होती है:

    • सतत Playout स्थिति: उच्च-आवृत्ति प्लेबैक स्थिति ट्रैकिंग और टाइमकोड अपडेट्स।.
    • इवेंट ट्रिगर्स: क्लिप, ब्लॉक या प्लेलिस्ट के शुरू होने, रुकने या लूप होने पर तत्काल सूचनाएँ।.
    • क्लासिक पाइप कमांड्स: के रूप में स्वरूपित मूल नियंत्रण कमांड्स की प्रत्यक्ष प्रक्रिया <play|1|...>.

    आधिकारिक बिटफ़ोकस कंपैनियन प्लेडेक मॉड्यूल, का वेब रिमोट यूआई, कस्टम HTML ग्राफिक्स ओवरले, और Director View टेम्प्लेट्स इस विशिष्ट रीयल-टाइम चैनल का उपयोग करते हैं। कमांड्स और इवेंट प्रकारों के लिए संपूर्ण सिंटैक्स दस्तावेज़ीकरण सीधे एप्लिकेशन पैकेज या आपकी स्थानीय टेम्प्लेट निर्देशिका में पाया जा सकता है:

    वेब रिमोट यूआई:
c:\Program Files\JoyEventMedia\Playdeck\html\webremote.html

HTML-टेम्पलेट्स:
C:\Users\Public\Documents\JoyEventMedia\Playdeck\HTML-Templates\
या
c:\Users\\AppData\Local

    विरासत टीसीपी कमांड इनपुट

    मौजूदा प्रसारण स्वचालन अवसंरचना के साथ पिछड़ी संगतता बनाए रखने के लिए, PLAYDECK पोर्ट पर आने वाले कच्चे TCP कनेक्शनों को स्वीकार करना जारी रखता है। 11375.

    यह सेटिंग के अंतर्गत प्रबंधित की जाती है सेटिंग्स ➔ नेटवर्क ➔ इनकमिंग ➔ टीसीपी कमांड्स इन. पेलोड सिंटैक्स वेबसॉकेट चैनल और REST द्वारा उपयोग किए जाने वाले पाइप-से-अलग किए गए प्रारूप से मेल खाता है। /api/v1/कमांड्स अंत बिंदु.

    • डेवलपर नोट: सभी क्लीन-शीट विकास परियोजनाओं और नए स्क्रिप्ट एकीकरण के लिए, हम कच्चे TCP सॉकेट्स के बजाय REST API का उपयोग करने की पुरजोर सिफारिश करते हैं।.

    एकीकरण उदाहरण

    • बिटफोकस साथी: WebSockets पर हमारे उत्पादन-तैयार नेटिव मॉड्यूल का उपयोग करके भौतिक हार्डवेयर नियंत्रण सतहों की त्वरित तैनाती।.
    • वेब रिमोट: पोर्ट पर किसी भी ब्राउज़र के माध्यम से सुलभ पूर्ण-सुविधा संपन्न उत्पादन नियंत्रण इंटरफ़ेस 11411.
    • निदेशक दृश्य और HTML ओवरले: लाइव स्टेटस बाइंडिंग प्रदर्शित करने वाले अंतर्निर्मित वेब टेम्पलेट्स।.
    • कस्टम सॉफ़्टवेयर उपकरण: हमारी OpenAPI विनिर्देश से उत्पन्न मानक HTTP क्लाइंट्स का उपयोग करके त्वरित एप्लिकेशन विकास, वैकल्पिक रूप से टेलीमेट्री के लिए WebSockets द्वारा समर्थित।.

    प्रश्न या कस्टम वर्कफ़्लो आवश्यकताएँ? हमारी इंजीनियरिंग टीम से संपर्क करें [email protected].