🧀 🗼 🥡 हम अपने स्वयं के इंटरफेस के साथ XBMC के लिए प्लग-इन लिखते हैं: भाग III

प्रविष्टि

यह अपने स्वयं के इंटरफेस के साथ XBMC के लिए प्लग इन लिखने पर लेखों की एक श्रृंखला का भाग III है। पिछले भागों ( भाग I और भाग II ) में, मैंने XBMC प्लगइन इंटरफ़ेस बनाने के बुनियादी सिद्धांतों के बारे में बात की और कुछ सरल उदाहरण दिए। इस भाग में, मैं XBMC के साथ बातचीत करने के लिए विभिन्न APIs के बारे में बहुत संक्षेप में बात करना चाहता हूं, मैंने जो माइक्रो-फ्रेमवर्क प्रदर्शित किया था, वह इंटरफ़ेस के लेआउट को सरल करता है।

3 नवंबर 2014 तक अपडेट करें: पहले दो भागों को लिखते समय, मैंने लेख का तीसरा भाग जल्द ही लिखने का वादा किया था। लेकिन, दुर्भाग्य से, जीवन अपने स्वयं के समायोजन करता है, और तीसरे भाग के लेखन को बेहतर समय तक स्थगित करना पड़ा। अब मैं वादा पूरा करने की कोशिश करूंगा, हालांकि पूर्ण सीमा तक नहीं: माइक्रो-फ्रेमवर्क के बारे में कहानी कुछ सरल होगी।

एपीआई

XBMC के लिए प्लगइन्स लिखने के बारे में एक कहानी विभिन्न एपीआई के बारे में कम से कम एक संक्षिप्त बात के बिना पूरी नहीं होगी जो प्लग-इन को XBMC के साथ बातचीत करने में सक्षम बनाती है। अब तक, लेखों ने इंटरफ़ेस बनाने के लिए एपीआई के साथ काम किया है, लेकिन प्लगइन्स को अन्य कार्यों को करने की आवश्यकता है: मीडिया फ़ाइलों के बारे में जानकारी प्राप्त करना, प्लेबैक को नियंत्रित करना, आदि एक्सबीएमसी में इन कार्यों को करने के लिए 4 मुख्य एपीआई हैं: पायथन एपीआई, अंतर्निहित कार्य (बिल्ट-इन), JSON-RPC प्रोटोकॉल और Infolabels। अगला, हम उनमें से प्रत्येक के बारे में बहुत संक्षेप में बात करेंगे।

पायथन एपीआई

5 पायथन मॉड्यूल का एक सेट: एक्सबीएमसी के साथ बातचीत के लिए xbmc, xbmcgui, xbmcplugin, xbmcaddon, xbmcvfs। मॉड्यूल Python-C API (SWIG) का उपयोग करके C ++ में लिखे गए हैं। नीचे उनका संक्षिप्त विवरण दिया गया है:
xbmc - XBMC के साथ सामान्य बातचीत;
xbmcgui - जीयूआई के साथ बातचीत;
xbmcplugin - सामग्री स्रोत प्लगइन्स का संगठन;
xbmcaddon - विभिन्न प्लग-इन मापदंडों (सेटिंग्स, भाषा फ़ाइलें, आदि) तक पहुंच;
xbmcvfs - फ़ाइल सिस्टम के साथ काम करते हैं।

अंतर्निहित कार्य

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

JSON-RPC प्रोटोकॉल

JSON-RPC पर आधारित XBMC के स्थानीय और रिमोट कंट्रोल के लिए प्रोटोकॉल। सूचना के दो तरफा आदान-प्रदान सहित XBMC के साथ बातचीत के पर्याप्त अवसर प्रदान करता है। XBMC में JSON-RPC प्रोटोकॉल के बारे में और पढ़ें।
JSON-RPC प्रोटोकॉल के माध्यम से स्थानीय प्रबंधन और सूचना के आदान-प्रदान के लिए, xbmc.executeJSONRPC () फ़ंक्शन का उपयोग किया जाता है। इसके अलावा, JSON स्ट्रिंग्स के प्रसंस्करण को आसान बनाने के लिए पायथन मानक पुस्तकालय के साथ json मॉड्यूल शामिल है।
अन्य कंप्यूटरों पर XBMC के साथ रिमोट इंटरैक्शन मानक लाइब्रेरी मॉड्यूल urllib2 का उपयोग करके किया जा सकता है।

Infolabels

XBMC से विभिन्न जानकारी प्राप्त करने के लिए एपीआई। सभी उपलब्ध Infolabels की एक सूची यहां पाई जा सकती है ।
फ़ंक्शन xbmc.getInfoLabel () का उपयोग जानकारी का अनुरोध करने के लिए किया जाता है।

इन एपीआई की क्षमताओं को आंशिक रूप से ओवरलैप किया जाता है, और एक ही ऑपरेशन को अक्सर अलग-अलग तरीकों से किया जा सकता है।

नोट: 11.0 संस्करण तक, XBMC में एक Web-API भी था जो आपको URL-एन्कोडेड नोटेशन में कमांड्स का उपयोग करके XBMC को नियंत्रित करने की अनुमति देता था। हालाँकि, संस्करण 12.0 से शुरू होकर, इसे अतिरेक के कारण हटा दिया गया है, क्योंकि JSON-RPC बहुत अधिक सुविधाएँ प्रदान करता है।

PyXBMCt - प्लगइन इंटरफ़ेस लेआउट को सरल बनाने के लिए माइक्रोफ़्रामवर्क

जैसा कि आप लेखों की इस श्रृंखला के पिछले भागों से देख सकते हैं, विंडो / WindowDialog वर्गों और नियंत्रण वर्ग के वंशजों के आधार पर प्लगइन इंटरफ़ेस बनाने के लिए एपीआई बहुत सुविधाजनक नहीं है: आपको पूर्ण निर्देशांक के साथ काम करना होगा, और इंटरफ़ेस का ग्राफिक डिजाइन पूरी तरह से डेवलपर के साथ रहता है।

माइक्रो-फ्रेमवर्क बनाने का विचार जो प्लग-इन इंटरफ़ेस के निर्माण को सरल करेगा (स्वाभाविक रूप से, एक्सबीएमसी पायथन एपीआई की क्षमताओं के भीतर) पैदा हुआ था जब मैंने उपशीर्षक डाउनलोड करने के लिए अपना प्लग-इन लिखा था। संस्करण 13.0 से पहले XBMC में, उपशीर्षक प्लग-इन पूरी तरह से स्टैंड-अलोन स्क्रिप्ट थे, और इंटरफ़ेस का निर्माण डेवलपर की जिम्मेदारी थी। वैसे, संस्करण 13.0 में उपशीर्षक प्लग-इन की वास्तुकला पूरी तरह से बदल दी गई है, और अब वे सामग्री स्रोत प्लग-इन के समान काम करते हैं, और आधार कोड XBMC है (वैसे, 14 वें संस्करण से मीडिया केंद्र को कोडी कहा जाएगा)।
इंटरफ़ेस तत्वों के पूर्ण निर्देशांक से परेशान न होने के लिए, मैंने विंडो / विंडोडायॉग / कंट्रोल कक्षाओं के चारों ओर एक आवरण लिखा है, जो ग्रिड ज्यामिति प्रबंधक की समानता को लागू करता है, और डिफ़ॉल्ट एक्सबीएमसी त्वचा - कॉन्फ्लुएंस से ली गई बनावट के साथ पूरी चीज़ को सजाया है। यह बहुत अच्छी तरह से निकला, और मैंने इसके आधार पर एक पूर्ण विकसित माइक्रो-फ्रेमवर्क बनाने का फैसला किया। PyQt को एक नमूने के रूप में लिया गया था, इसलिए रूपरेखा का नाम PyXBMCt रखा गया।

फ्रेमवर्क 4 बेस कनवर्टर क्लासेस और 9 रेडी-टू-यूज़ विजेट्स प्रदान करता है, या, जैसा कि उन्हें एक्सबीएमसी में कहा जाता है, नियंत्रण। ग्रिड ज्यामिति प्रबंधक स्क्रीन पर नियंत्रण रखने के लिए जिम्मेदार है, और इंटरैक्टिव नियंत्रण PyQt में सिग्नल-स्लॉट तंत्र के समान कार्यों / विधियों से जुड़े हैं। PyQt / PySide से परिचित लोगों को PyXBMCt को दो तरीकों से सीखना चाहिए।

स्पष्टता के लिए, एक बहुत ही सरल उदाहरण पर विचार करें।
PyXBMCt माइक्रो-फ्रेमवर्क आधिकारिक XBMC / कोडी रिपॉजिटरी में मौजूद है, इसलिए, इसका उपयोग करने के लिए, आपको अपनी प्लग-इन फ़ाइल के addon.xml अनुभाग में निम्न पंक्ति को जोड़ने की आवश्यकता है (प्लग-इन आर्किटेक्चर पर अधिक विवरण के लिए):

<import addon="script.module.pyxbmct" version="1.1.4"/>

अब जब आप एक रिपॉजिटरी या ज़िप फ़ाइल से अपना प्लगइन इंस्टॉल करते हैं, तो माइक्रो-फ़्रेमवर्क स्वचालित रूप से आधिकारिक रिपॉजिटरी से ऊपर आ जाएगा। इसके अलावा, कोडी 14.0 "हेलिक्स" में, मैन्युअल रूप से सर्विस प्लग इन स्थापित करना संभव है, और PyXBMCt प्लगइन को पहले से स्थापित किया जा सकता है।
एक साधारण उदाहरण के रूप में, स्वाभाविक रूप से, "हैलो वर्ल्ड" लें:

नमस्ते दुनिया

 # -*- coding: utf-8 -*- #   PyXBMCt. import pyxbmct.addonwindow as pyxbmct class MyWindow(pyxbmct.AddonDialogWindow): def __init__(self, title=''): #    . super(MyWindow, self).__init__(title) #     ,     (Grid): # 2   3 . self.setGeometry(350, 150, 2, 3) #   . label = pyxbmct.Label('This is a PyXBMCt window.', alignment=pyxbmct.ALIGN_CENTER) #    . self.placeControl(label, 0, 0, columnspan=3) #  . button = pyxbmct.Button('Close') #    . self.placeControl(button, 1, 1) #     . self.setFocus(button) #    . self.connect(button, self.close) #     . self.connect(pyxbmct.ACTION_NAV_BACK, self.close) #   . window = MyWindow('Hello, World!') #   . window.doModal() #      . del window

यदि सब कुछ सही ढंग से किया जाता है, तो बटन के साथ एक विंडो स्क्रीन पर दिखाई देगी:

अब, एक विस्तृत विश्लेषण। पंक्ति संख्याओं को प्रदर्शित करने के लिए, उपयुक्त फ़ंक्शन के साथ पाठ संपादक का उपयोग करें, उदाहरण के लिए नोटपैड ++। मुझे लगता है कि जो लोग PyQt / PySide या अन्य "वयस्क" GUI फ्रेमवर्क से परिचित हैं वे तुरंत समझ जाएंगे कि क्या है, इसलिए मैं स्पष्ट चीजों को छोड़ देता हूं।

पंक्ति 13: self.setGeometry () विधि विंडो की चौड़ाई और ऊंचाई निर्धारित करती है, साथ ही अभिभावक विंडो के समन्वय ग्रिड का संकल्प जिसमें नियंत्रण रखा जाता है। सिद्धांत पूरी तरह से QtGui.QGridLayout लिंकर के अनुरूप है। डिफ़ॉल्ट रूप से, विंडो को स्क्रीन के केंद्र में रखा जाता है, लेकिन यदि वांछित है, तो आप इस पद्धति के अतिरिक्त मापदंडों के रूप में विंडो के सटीक निर्देशांक निर्दिष्ट कर सकते हैं।

लाइन 17: self.placeControl () विधि ग्रिड में चयनित नियंत्रण रखता है। वास्तविक QtGui.QGridLayout के रूप में, नियंत्रण कई पंक्तियों और स्तंभों पर कब्जा कर सकता है।
चेतावनी! किसी भी नियंत्रण उदाहरण के तरीकों (उदाहरण के लिए, सेटलैबेल) को लेबल के पाठ को बदलने के लिए कहा जाना चाहिए, क्योंकि इस नियंत्रण को विंडो में स्थानकंट्रोल () का उपयोग करके जोड़ा जाता है। अन्यथा, विभिन्न ग्लिच संभव हैं, मजाकिया हैं और बहुत नहीं हैं।

लाइन 23: सेटफोकस () विधि चयनित नियंत्रण पर प्रारंभिक ध्यान केंद्रित करती है। यदि आपके पास कोई इंटरैक्टिव नियंत्रण है, तो यह विधि आवश्यक है , अन्यथा आप कीबोर्ड / रिमोट कंट्रोल से अपने प्लगइन को नियंत्रित नहीं कर सकते हैं।
यदि आपके पास कई इंटरैक्टिव नियंत्रण हैं, तो आपको उनके बीच नेविगेशन नियमों को कॉन्फ़िगर करने की भी आवश्यकता है (पिछले भागों को देखें)।

लाइनें 25 और 27: self.connect () विधि फंक्शन / विधि के साथ कीबोर्ड ईवेंट के नियंत्रण या संख्यात्मक कोड को जोड़ती है। स्वाभाविक रूप से, एक फ़ंक्शन संदर्भ का उपयोग यहां किया जाता है (कोष्ठक () के बिना), और फ़ंक्शन कॉल नहीं। आप यहां लैम्ब्डा का भी उपयोग कर सकते हैं - ठीक उसी तरह जैसे असली पाइक में।
आप केवल उन नियंत्रणों को लिंक कर सकते हैं जो सक्रिय होने पर एक घटना उत्पन्न करते हैं: ये बटन , रेडियोबटन और सूची हैं । अन्य नियंत्रण घटनाओं को उत्पन्न नहीं करते हैं, और उन्हें बांधना बेकार है।
नियंत्रण (कीबोर्ड, माउस, जॉयस्टिक, आदि) द्वारा उत्पन्न घटनाओं के संख्यात्मक कोड यहां पाए जा सकते हैं । PyXBMCt में आमतौर पर उपयोग की जाने वाली घटनाओं के लिए प्रतीकात्मक नाम शामिल हैं।
संख्यात्मक कोड ACTION_PREVIOUS_MENU या 10 (डिफ़ॉल्ट कीबोर्ड पर ESC कुंजी है) हमेशा क्लोज़ () पद्धति से जुड़ा होता है जो विंडो को बंद करता है और पुन: असाइन नहीं किया जा सकता है। यह सुनिश्चित करना है कि प्लगइन विंडो हमेशा बंद हो सकती है।

लाइन 35: उपयोग के बाद, विंडो इंस्टेंस को जबरन हटा दिया जाता है (विंडो इंस्टेंस का विध्वंसक और इसके साथ जुड़ी सभी वस्तुओं को कहा जाता है)। यहां मुद्दा यह है कि किसी कारण से कचरा संग्रहकर्ता प्लगइन पूरा होने के बाद xbmcgui वर्गों की वस्तुओं को नहीं हटाता है, जिससे मेमोरी लीक हो सकती है। इसलिए, xbmcgui / PyXBMCt पर आधारित खुली खिड़कियों को स्मृति से जबरन हटाया जाना चाहिए।

PyXBMCt का उपयोग करने का एक व्यावहारिक उदाहरण मेरे ex.ua.alternative प्लगइन में देखा जा सकता है, जहां साइट के लिए एक लॉगिन विंडो बनाने के लिए माइक्रो-फ्रेमवर्क का उपयोग किया जाता है:

Ex.ua पर लॉगिन विंडो

आप नीचे दिए गए लिंक (अंग्रेजी) पर PyXBMCt के बारे में अधिक जान सकते हैं।

PyXBMCt क्विकस्टार्ट गाइड ।

PyXBMCt वर्गों और विधियों का स्वचालित रूप से निर्मित प्रलेखन ।

गीथूब पर PyXBMCt भंडार ।

आधिकारिक मंच XBMC (कोडी) पर विषय ।

एक प्लगइन PyXBMCt (स्पॉइलर के नीचे स्क्रीनशॉट) की क्षमताओं का प्रदर्शन करता है ।

स्क्रीनशॉट PyXBMCt डेमो

बेशक, PyXBMCt के आधार पर बनाया गया प्लग-इन इंटरफ़ेस एक्सएमएल त्वचा पर आधारित इंटरफ़ेस के लिए क्षमताओं और "सजावट" में हीन है। हालाँकि, कई मामलों में इसकी क्षमताएं काफी हैं, और जो लोग विशेष रूप से PyQt / PySide में "डेस्कटॉप" GUI फ्रेमवर्क से परिचित हैं, वे PyXBMCt को बहुत जल्दी सीख सकते हैं।

निष्कर्ष

यह XBMC (कोडी) के लिए प्लगइन्स लिखने पर लेखों की श्रृंखला का समापन करता है। दुर्भाग्य से, कई परिस्थितियों के कारण, तीसरा भाग काफी देरी से सामने आता है, लेकिन, जैसा कि वे कहते हैं, "पहले से कहीं अधिक देर से बेहतर।"

PS InfoLabels के बारे में जानकारी जोड़ी गई।

पिछले लेख

एक्सबीएमसी के लिए एक सरल प्लगइन का विस्तृत शरीर रचना विज्ञान ।
हम अपने स्वयं के इंटरफ़ेस के साथ XBMC के लिए प्लग-इन लिख रहे हैं: भाग I - सिद्धांत और सबसे सरल उदाहरण ।
हम अपने स्वयं के इंटरफेस के साथ XBMC के लिए प्लग-इन लिख रहे हैं: भाग II - संवाद और सजावट ।

हम अपने स्वयं के इंटरफेस के साथ XBMC के लिए प्लग-इन लिखते हैं: भाग III - एपीआई और माइक्रो-फ्रेमवर्क