Captions

ध्यान दें: YouTube ने 13 मार्च, 2024 को एलान किया था कि वह captions.insert और captions.update एपीआई एंडपॉइंट के लिए, sync पैरामीटर को बंद कर रहा है. YouTube Studio में, कैप्शन अपने-आप सिंक होने की सुविधा अब भी उपलब्ध है. ज़्यादा जानकारी के लिए, एपीआई में बदलाव का इतिहास देखें.

caption संसाधन की मदद से, YouTube कैप्शन ट्रैक के बारे में बताया जा सकता है. कैप्शन ट्रैक एक YouTube वीडियो से जुड़ा होता है.

तरीके

captions संसाधनों के लिए, एपीआई नीचे दिए गए तरीकों के साथ काम करता है:

list
किसी खास वीडियो से जुड़े कैप्शन ट्रैक की सूची पाएं. ध्यान दें कि एपीआई के रिस्पॉन्स में असली कैप्शन शामिल नहीं होते और captions.download तरीके से कैप्शन ट्रैक को वापस पाया जा सकता है. इसे अभी आज़माएं.
डालें
कैप्शन ट्रैक अपलोड करें.
अपडेट
कैप्शन ट्रैक को अपडेट करें. कैप्शन ट्रैक को अपडेट करते समय, ट्रैक का ड्राफ़्ट का स्टेटस बदला जा सकता है, ट्रैक के लिए नई कैप्शन फ़ाइल अपलोड की जा सकती है या ये दोनों काम किए जा सकते हैं.
मिटाएं
कोई खास कैप्शन ट्रैक मिटाएं. इसे अभी आज़माएं.
डाउनलोड करें
कैप्शन ट्रैक डाउनलोड करें. कैप्शन ट्रैक को ओरिजनल फ़ॉर्मैट में तब तक दिखाया जाता है, जब तक अनुरोध में tfmt पैरामीटर और उसकी मूल भाषा के लिए कोई वैल्यू तय नहीं की जाती. ऐसा तब तक होता है, जब तक अनुरोध में tlang पैरामीटर के लिए वैल्यू तय नहीं की जाती.

संसाधन दिखाना

यहां दिया गया JSON स्ट्रक्चर, captions संसाधन का फ़ॉर्मैट दिखाता है:

{
  "kind": "youtube#caption",
  "etag": etag,
  "id": string,
  "snippet": {
    "videoId": string,
    "lastUpdated": datetime,
    "trackKind": string,
    "language": string,
    "name": string,
    "audioTrackType": string,
    "isCC": boolean,
    "isLarge": boolean,
    "isEasyReader": boolean,
    "isDraft": boolean,
    "isAutoSynced": boolean,
    "status": string,
    "failureReason": string
  }
}

प्रॉपर्टी

यहां दी गई टेबल में, इस संसाधन में दिखने वाली प्रॉपर्टी के बारे में बताया गया है:

प्रॉपर्टी
kind string
इससे पता चलता है कि एपीआई रिसॉर्स किस तरह का है. मान youtube#caption होगा.
etag etag
इस संसाधन का ईटैग.
id string
इस आईडी का इस्तेमाल करके, YouTube किसी कैप्शन ट्रैक की खास तरह से पहचान करता है.
snippet object
snippet ऑब्जेक्ट में, कैप्शन के बारे में बुनियादी जानकारी होती है.
snippet.videoId string
YouTube इस आईडी का इस्तेमाल करके, कैप्शन ट्रैक से जुड़े वीडियो की पहचान करता है.
snippet.lastUpdated datetime
कैप्शन ट्रैक को पिछली बार अपडेट किए जाने की तारीख और समय. यह वैल्यू ISO 8601 फ़ॉर्मैट में होती है.
snippet.trackKind string
कैप्शन ट्रैक किस तरह का है.

इस प्रॉपर्टी के लिए मान्य वैल्यू ये हैं:
  • ASR – अपने-आप बोली पहचानने की सुविधा का इस्तेमाल करके बनाया गया कैप्शन ट्रैक.
  • forced – एक कैप्शन ट्रैक तब चलता है, जब प्लेयर में कोई दूसरा ट्रैक न चुना गया हो. उदाहरण के लिए, अगर किसी वीडियो में एलियन को किसी एलियन की भाषा में बात करते हुए दिखाया गया है, तो हो सकता है कि उस वीडियो में सिर्फ़ एलियन की भाषा के सबटाइटल दिखाने के लिए एक ज़बरदस्ती कैप्शन ट्रैक मौजूद हो.
  • standard – सामान्य कैप्शन ट्रैक. यह डिफ़ॉल्ट मान है.
snippet.language string
कैप्शन ट्रैक की भाषा. प्रॉपर्टी की वैल्यू BCP-47 भाषा का टैग है.
snippet.name string
कैप्शन ट्रैक का नाम. यह नाम इस तरह से बनाया जाता है कि वीडियो चलाने के दौरान, उपयोगकर्ता को यह नाम एक विकल्प के तौर पर दिखे. नाम में ज़्यादा से ज़्यादा 150 वर्ण हो सकते हैं.
snippet.audioTrackType string
कैप्शन ट्रैक से जुड़ा ऑडियो ट्रैक किस तरह का है.

इस प्रॉपर्टी के लिए मान्य वैल्यू ये हैं:
  • commentary – यह कैप्शन ट्रैक, किसी ऐसे वैकल्पिक ऑडियो ट्रैक से जुड़ा होता है जिसमें कमेंट्री शामिल होती है. जैसे, डायरेक्ट्री कमेंट्री.
  • descriptive – कैप्शन ट्रैक किसी ऐसे वैकल्पिक ऑडियो ट्रैक से जुड़ा होता है जिसमें जानकारी देने वाला अतिरिक्त ऑडियो शामिल होता है.
  • primary – कैप्शन ट्रैक, वीडियो के मुख्य ऑडियो ट्रैक से जुड़ा होता है. यह वह ऑडियो ट्रैक होता है जिसे आम तौर पर वीडियो के साथ जोड़ा जाता है.
  • unknown – यह डिफ़ॉल्ट वैल्यू है.
snippet.isCC boolean
इससे पता चलता है कि ट्रैक में उन लोगों के लिए सबटाइटल हैं जो सुन नहीं सकते या जिन्हें कम सुनाई देता है. डिफ़ॉल्ट वैल्यू false है.
snippet.isLarge boolean
इससे पता चलता है कि कैप्शन ट्रैक में, दृष्टि बाधित लोगों के लिए बड़े टेक्स्ट का इस्तेमाल किया गया है या नहीं. डिफ़ॉल्ट वैल्यू false है.
snippet.isEasyReader boolean
इससे पता चलता है कि कैप्शन ट्रैक को "आसानी से पढ़ने" की सुविधा के हिसाब से फ़ॉर्मैट किया गया है या नहीं. इसका मतलब है कि यह भाषा सीखने वाले लोगों के लिए, थर्ड क्लास लेवल पर है. डिफ़ॉल्ट वैल्यू false है.
snippet.isDraft boolean
इससे पता चलता है कि कैप्शन ट्रैक एक ड्राफ़्ट है या नहीं. अगर वैल्यू true है, तो ट्रैक सार्वजनिक रूप से नहीं दिखेगा. डिफ़ॉल्ट वैल्यू false है.
snippet.isAutoSynced boolean
इससे पता चलता है कि YouTube ने कैप्शन ट्रैक को वीडियो के ऑडियो ट्रैक के साथ सिंक किया है या नहीं. अगर कैप्शन ट्रैक को अपलोड करते समय, सिंक करने का साफ़ तौर पर अनुरोध किया गया था, तो वैल्यू true होगी. उदाहरण के लिए, captions.insert या captions.update तरीकों को कॉल करते समय, sync पैरामीटर को true पर सेट किया जा सकता है. इससे YouTube को अपलोड किए गए ट्रैक को वीडियो के साथ सिंक करने का निर्देश मिलेगा. अगर वैल्यू false है, तो YouTube अपलोड किए गए कैप्शन ट्रैक में मौजूद टाइम कोड का इस्तेमाल करके, यह तय करता है कि कैप्शन कब दिखाने हैं.
snippet.status string
कैप्शन ट्रैक का स्टेटस.

इस प्रॉपर्टी के लिए मान्य वैल्यू ये हैं:
  • failed
  • serving
  • syncing
snippet.failureReason string
YouTube किस वजह से कैप्शन ट्रैक को प्रोसेस नहीं कर पाया. यह प्रॉपर्टी सिर्फ़ तब दिखती है, जब state प्रॉपर्टी की वैल्यू failed हो.

इस प्रॉपर्टी के लिए मान्य वैल्यू ये हैं:
  • processingFailed – YouTube अपलोड किए गए कैप्शन ट्रैक को प्रोसेस नहीं कर सका.
  • unknownFormat – कैप्शन ट्रैक के फ़ॉर्मैट की पहचान नहीं हुई.
  • unsupportedFormat – कैप्शन ट्रैक का फ़ॉर्मैट काम नहीं करता.