लागू करने का तरीका: कैप्शन

यहां दिए गए उदाहरणों में, कैप्शन से जुड़े फ़ंक्शन करने के लिए, YouTube Data API (v3) का इस्तेमाल करने का तरीका बताया गया है.

किसी वीडियो के लिए कैप्शन ट्रैक की सूची पाना

किसी वीडियो के लिए उपलब्ध कैप्शन ट्रैक की सूची देखने के लिए, captions.list तरीका अपनाएं. videoId पैरामीटर की वैल्यू को YouTube वीडियो आईडी पर सेट करें. इससे उस वीडियो की खास पहचान होती है जिसके लिए कैप्शन वापस लाए जा रहे हैं. आपके अनुरोध को OAuth 2.0 का इस्तेमाल करके अनुमति दी जानी चाहिए.

नीचे दिए गए अनुरोध से, Google Stories के YouTube चैनल पर मौजूद किसी वीडियो के कैप्शन की सूची मिलती है:

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.list?
part=snippet
&videoId=PRU2ShMzQRg

कोड सैंपल के लिए, captions.list तरीके का दस्तावेज़ देखें.

कैप्शन ट्रैक बनाना

इस क्वेरी की जांच, APIs Explorer का इस्तेमाल करके नहीं की जा सकती, क्योंकि APIs Explorer में फ़ाइलें अपलोड करने की सुविधा काम नहीं करती. इस तरीके के लिए, फ़ाइलें अपलोड करना ज़रूरी है.

किसी वीडियो के लिए नया कैप्शन ट्रैक अपलोड करने के लिए, एपीआई के captions.insert तरीके का इस्तेमाल किया जा सकता है. ट्रैक अपलोड करते समय, आपको इन caption रिसॉर्स प्रॉपर्टी के लिए वैल्यू देनी होगी:

  • snippet.videoId - इससे उस वीडियो की पहचान होती है जिसमें कैप्शन ट्रैक जोड़ा जा रहा है.
  • snippet.language - कैप्शन ट्रैक की भाषा.
  • snippet.name - कैप्शन ट्रैक का नाम.

कैप्शन ट्रैक अपलोड करते समय, ये अन्य विकल्प उपलब्ध होते हैं:

  • sync पैरामीटर को true पर सेट करने पर, YouTube अपलोड की गई कैप्शन फ़ाइल में मौजूद सभी टाइम कोड को अनदेखा कर देगा. साथ ही, कैप्शन के लिए नए टाइम कोड जनरेट करेगा.

    अगर अपलोड की जा रही ट्रांसक्रिप्ट में टाइम कोड नहीं हैं या आपको लगता है कि आपकी फ़ाइल में मौजूद टाइम कोड गलत हैं और आपको YouTube से उन्हें ठीक करने के लिए कहना है, तो आपको sync पैरामीटर को true पर सेट करना चाहिए.

  • अगर caption रिसॉर्स की snippet.isDraft प्रॉपर्टी को true पर सेट किया जाता है, तो ट्रैक सार्वजनिक तौर पर नहीं दिखेगा.

कोड सैंपल के लिए, captions.insert तरीके का दस्तावेज़ देखें.

कैप्शन ट्रैक डाउनलोड करना

इस क्वेरी की जांच, एपीआई एक्सप्लोरर का इस्तेमाल करके नहीं की जा सकती, क्योंकि एपीआई एक्सप्लोरर में फ़ाइलें डाउनलोड करने की सुविधा काम नहीं करती.

किसी खास कैप्शन ट्रैक को डाउनलोड करने के लिए, captions.download तरीका इस्तेमाल करें. id पैरामीटर की वैल्यू को YouTube कैप्शन ट्रैक आईडी पर सेट करें. यह आईडी, डाउनलोड किए जा रहे कैप्शन ट्रैक की खास तौर पर पहचान करता है. आपके अनुरोध को OAuth 2.0 का इस्तेमाल करके अनुमति दी जानी चाहिए.

v3 API इन विकल्पों के साथ काम करता है:

  • कैप्शन ट्रैक को किसी खास फ़ॉर्मैट में दिखाने के लिए, tfmt पैरामीटर की वैल्यू सेट करें. इससे, आपको अपने पसंदीदा फ़ॉर्मैट की पहचान करने में मदद मिलेगी. पैरामीटर की परिभाषा में, काम करने वाली वैल्यू की सूची होती है.

  • कैप्शन ट्रैक का अनुवाद पाने के लिए, tlang पैरामीटर की वैल्यू को ISO 639-1 के हिसाब से दो अक्षरों वाला भाषा कोड पर सेट करें. इससे, कैप्शन की भाषा की पहचान की जा सकेगी. अनुवाद, Google Translate जैसी मशीन से अनुवाद करने की सुविधा का इस्तेमाल करके जनरेट किया जाता है.

कोड सैंपल के लिए, captions.download तरीके का दस्तावेज़ देखें.

कैप्शन ट्रैक अपडेट करना

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

किसी ट्रैक के ड्राफ़्ट की स्थिति बदलने की सुविधा की जांच करने के लिए, एपीआई एक्सप्लोरर का इस्तेमाल किया जा सकता है. हालांकि, असल कैप्शन ट्रैक को अपडेट करने के लिए, एपीआई एक्सप्लोरर का इस्तेमाल नहीं किया जा सकता. इसकी वजह यह है कि इस टूल में फ़ाइलें अपलोड करने की सुविधा नहीं है.

नीचे दिए गए अनुरोध से, Google Stories के YouTube चैनल पर मौजूद किसी वीडियो के कैप्शन की सूची मिलती है:

इस अनुरोध से, कैप्शन ट्रैक के ड्राफ़्ट की स्थिति को true पर अपडेट कर दिया जाता है. इसका मतलब है कि ट्रैक सार्वजनिक तौर पर नहीं दिखेगा. APIs Explorer में अनुरोध पूरा करने के लिए, आपको कैप्शन ट्रैक की पहचान करने के लिए id प्रॉपर्टी की वैल्यू सेट करनी होगी.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update?
part=snippet

कोड सैंपल के लिए, captions.update तरीके का दस्तावेज़ देखें.

कैप्शन ट्रैक मिटाना

इस उदाहरण में, कैप्शन ट्रैक को मिटाने का तरीका बताया गया है. उदाहरण में ये चरण शामिल हैं:

  • पहला चरण: कैप्शन ट्रैक का आईडी पाना

    किसी वीडियो के लिए, कैप्शन ट्रैक की सूची देखने के लिए, ऊपर दिया गया तरीका अपनाएं. इस सूची का इस्तेमाल, कैप्शन ट्रैक की सूची दिखाने के लिए किया जा सकता है. इसके लिए, हर ट्रैक के आईडी को एक कुंजी के तौर पर इस्तेमाल किया जाता है.

  • दूसरा चरण: ट्रैक मिटाना

    किसी वीडियो को मिटाने के लिए, captions.delete का इस्तेमाल करें. अनुरोध में, id पैरामीटर उस ट्रैक के कैप्शन ट्रैक आईडी की जानकारी देता है जिसे मिटाया जा रहा है. अनुरोध को OAuth 2.0 का इस्तेमाल करके अनुमति दी जानी चाहिए. अगर एपीआई एक्सप्लोरर में इस क्वेरी की जांच की जा रही है, तो आपको id पैरामीटर वैल्यू के लिए, कैप्शन ट्रैक का मान्य आईडी डालना होगा.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.delete?
id=CAPTION_TRACK_ID