Captions

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

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 तरीकों को कॉल करते समय, YouTube को वीडियो के साथ अपलोड किए गए ट्रैक को सिंक करने का निर्देश देने के लिए, sync पैरामीटर को true पर सेट किया जा सकता है. अगर वैल्यू false है, तो YouTube अपलोड किए गए कैप्शन ट्रैक में मौजूद टाइम कोड का इस्तेमाल करके यह तय करता है कि कैप्शन कब दिखाने हैं.
snippet.status string
कैप्शन ट्रैक का स्टेटस.

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

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