Captions

ध्यान दें: YouTube ने 13 मार्च, 2024 को एलान किया था कि वह captions.insert और captions.update एपीआई एंडपॉइंट के लिए, sync पैरामीटर का इस्तेमाल बंद कर रहा है. कैप्शन अपने-आप सिंक होने की सुविधा, YouTube Creator 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
इस संसाधन का 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 – कैप्शन ट्रैक का फ़ॉर्मैट काम नहीं करता.