इस पेज का अनुवाद Cloud Translation API से किया गया है.

YouTube Player API Reference for iframe Embeds

iFrame Player API आपको अपनी वेबसाइट पर YouTube वीडियो प्लेयर एम्बेड करने और JavaScript का इस्तेमाल करके, प्लेयर को कंट्रोल करने की सुविधा देता है.

एपीआई के JavaScript फ़ंक्शन का इस्तेमाल करके, आप वीडियो चलाने के लिए सूची बना सकते हैं, उन्हें चला सकते हैं, रोक सकते हैं या बंद कर सकते हैं; प्लेयर की आवाज़ कम या ज़्यादा कर सकते हैं; या चल रहे वीडियो की जानकारी हासिल कर सकते हैं. आपके पास ऐसे इवेंट लिसनर जोड़ने का विकल्प भी होता है जो प्लेयर के कुछ इवेंट के हिसाब से एक्ज़ीक्यूट होंगे. जैसे, खिलाड़ी की स्थिति में बदलाव होना.

इस गाइड में iFrame API को इस्तेमाल करने का तरीका बताया गया है. यह अलग-अलग तरह के उन इवेंट की पहचान करता है जिन्हें एपीआई भेज सकता है. साथ ही, यह भी बताता है कि उन इवेंट का जवाब देने के लिए इवेंट लिसनर कैसे लिखें. इसमें अलग-अलग JavaScript फ़ंक्शन के बारे में भी जानकारी दी गई है. इन फ़ंक्शन की मदद से वीडियो प्लेयर को कंट्रोल किया जा सकता है. साथ ही, प्लेयर पैरामीटर को कंट्रोल किया जा सकता है. इनका इस्तेमाल प्लेयर को अपनी पसंद के मुताबिक बनाने के लिए किया जा सकता है.

ज़रूरी शर्तें

यह ज़रूरी है कि उपयोगकर्ता के ब्राउज़र पर HTML5 postMessage सुविधा काम करती हो. ज़्यादातर आधुनिक ब्राउज़र postMessage का समर्थन करते हैं.

एम्बेड किए गए प्लेयर में कम से कम 200 पिक्सेल x 200 पिक्सेल का व्यूपोर्ट होना चाहिए. अगर प्लेयर कंट्रोल दिखाता है, तो ये कंट्रोल के लिए काफ़ी बड़े होने चाहिए, ताकि व्यूपोर्ट का साइज़ कम से कम साइज़ से छोटा न हो. हमारा सुझाव है कि 16:9 प्लेयर कम से कम 480 पिक्सल चौड़ा और 270 पिक्सल लंबा होना चाहिए.

iFrame API का इस्तेमाल करने वाले किसी भी वेब पेज को नीचे दिए गए JavaScript फ़ंक्शन को भी लागू करना होगा:

onYouTubeIframeAPIReady – जब पेज, प्लेयर एपीआई के लिए JavaScript को डाउनलोड करना पूरा कर लेगा, तब एपीआई इस फ़ंक्शन को कॉल करेगा. इसके बाद, आप अपने पेज पर एपीआई का इस्तेमाल कर पाएंगे. इसलिए, यह फ़ंक्शन ऐसे प्लेयर ऑब्जेक्ट बना सकता है जिन्हें आपको पेज लोड होने पर दिखाना है.

प्रारंभ करना

नीचे दिया गया सैंपल एचटीएमएल पेज एक एम्बेड किया गया प्लेयर बनाता है. इस प्लेयर से वीडियो लोड होगा और इसे छह सेकंड के लिए चलाया जाएगा. इसके बाद, वीडियो चलना बंद हो जाएगा. एचटीएमएल में नंबर वाली टिप्पणियों को उदाहरण के नीचे दी गई सूची में समझाया गया है.

<!DOCTYPE html>
<html>
  <body>
    <!-- 1. The <iframe> (and video player) will replace this <div> tag. -->
    <div id="player"></div>

    <script>
      // 2. This code loads the IFrame Player API code asynchronously.
      var tag = document.createElement('script');

      tag.src = "https://www.youtube.com/iframe_api";
      var firstScriptTag = document.getElementsByTagName('script')[0];
      firstScriptTag.parentNode.insertBefore(tag, firstScriptTag);

      // 3. This function creates an <iframe> (and YouTube player)
      //    after the API code downloads.
      var player;
      function onYouTubeIframeAPIReady() {
        player = new YT.Player('player', {
          height: '390',
          width: '640',
          videoId: 'M7lc1UVf-VE',
          playerVars: {
            'playsinline': 1
          },
          events: {
            'onReady': onPlayerReady,
            'onStateChange': onPlayerStateChange
          }
        });
      }

      // 4. The API will call this function when the video player is ready.
      function onPlayerReady(event) {
        event.target.playVideo();
      }

      // 5. The API calls this function when the player's state changes.
      //    The function indicates that when playing a video (state=1),
      //    the player should play for six seconds and then stop.
      var done = false;
      function onPlayerStateChange(event) {
        if (event.data == YT.PlayerState.PLAYING && !done) {
          setTimeout(stopVideo, 6000);
          done = true;
        }
      }
      function stopVideo() {
        player.stopVideo();
      }
    </script>
  </body>
</html>

नीचे दिए गए सैंपल में, ऊपर दिए गए सैंपल के बारे में ज़्यादा जानकारी दी गई है:

इस सेक्शन में मौजूद <div> टैग, पेज पर उस जगह की पहचान करता है जहां iFrame API, वीडियो प्लेयर को जगह पर रखेगा. प्लेयर ऑब्जेक्ट का कंस्ट्रक्टर, जिसकी जानकारी वीडियो प्लेयर लोड करना सेक्शन में दी गई है, <div> टैग की पहचान id की मदद से करता है, ताकि यह पक्का किया जा सके कि एपीआई <iframe> को सही जगह पर रखे. खास तौर पर, iFrame API, <div> टैग को <iframe> टैग से बदल देगा.

विकल्प के तौर पर, <iframe> एलिमेंट को सीधे पेज पर भी रखा जा सकता है. वीडियो प्लेयर लोड करना सेक्शन में, इसे करने का तरीका बताया गया है.
इस सेक्शन में मौजूद कोड, iFrame Player API JavaScript कोड को लोड करता है. इस उदाहरण में, एपीआई कोड को डाउनलोड करने के लिए डीओएम बदलाव का इस्तेमाल किया गया है, ताकि यह पक्का किया जा सके कि कोड एसिंक्रोनस तरीके से लिया गया है. (<script> टैग की async विशेषता, जो एसिंक्रोनस डाउनलोड भी चालू करती है, अभी तक सभी मॉडर्न ब्राउज़र पर काम नहीं करती है, जैसा कि इस स्टैक ओवरफ़्लो जवाब में बताया गया है.
प्लेयर एपीआई कोड डाउनलोड होते ही onYouTubeIframeAPIReady फ़ंक्शन काम करेगा. कोड का यह हिस्सा एक ग्लोबल वैरिएबल player को परिभाषित करता है, जो आपके ज़रिए एम्बेड किए जा रहे वीडियो प्लेयर की जानकारी देता है. इसके बाद फ़ंक्शन, वीडियो प्लेयर ऑब्जेक्ट बनाता है.
onReady इवेंट ट्रिगर होने पर onPlayerReady फ़ंक्शन काम करेगा. इस उदाहरण में, फ़ंक्शन से पता चलता है कि वीडियो प्लेयर तैयार होने पर, उसे चलना शुरू होना चाहिए.
प्लेयर की स्थिति में बदलाव होने पर एपीआई, onPlayerStateChange फ़ंक्शन को कॉल करेगा. इससे यह पता चल सकता है कि प्लेयर चल रहा है, रुका हुआ है, खत्म हो चुका है वगैरह. फ़ंक्शन से पता चलता है कि जब प्लेयर की स्थिति 1 (चल रही है) हो, तो वीडियो को छह सेकंड तक चलाना चाहिए. इसके बाद, वीडियो को रोकने के लिए stopVideo फ़ंक्शन को कॉल करना चाहिए.

वीडियो प्लेयर लोड करना

एपीआई का JavaScript कोड लोड होने के बाद, एपीआई onYouTubeIframeAPIReady फ़ंक्शन को कॉल करेगा. इसके बाद, अपने पेज पर वीडियो प्लेयर डालने के लिए, YT.Player ऑब्जेक्ट बनाया जा सकता है. नीचे दिया गया एचटीएमएल का हिस्सा, ऊपर दिए गए उदाहरण में दिया गया onYouTubeIframeAPIReady फ़ंक्शन दिखाता है:

var player;
function onYouTubeIframeAPIReady() {
  player = new YT.Player('player', {
    height: '390',
    width: '640',
    videoId: 'M7lc1UVf-VE',
    playerVars: {
      'playsinline': 1
    },
    events: {
      'onReady': onPlayerReady,
      'onStateChange': onPlayerStateChange
    }
  });
}

वीडियो प्लेयर का कंस्ट्रक्टर इन पैरामीटर के बारे में बताता है:

पहला पैरामीटर या तो डीओएम एलिमेंट या एचटीएमएल एलिमेंट के id के बारे में बताता है, जहां एपीआई प्लेयर वाला <iframe> टैग शामिल करेगा.

iFrame API, बताए गए एलिमेंट को प्लेयर वाले <iframe> एलिमेंट से बदल देगा. अगर बदले जा रहे एलिमेंट की डिसप्ले स्टाइल, शामिल किए गए <iframe> एलिमेंट से अलग है, तो इससे आपके पेज के लेआउट पर असर पड़ सकता है. डिफ़ॉल्ट रूप से, <iframe>, inline-block एलिमेंट के तौर पर दिखता है.
दूसरा पैरामीटर एक ऑब्जेक्ट है, जो प्लेयर के विकल्पों के बारे में बताता है. ऑब्जेक्ट में ये प्रॉपर्टी शामिल हैं:
- width (नंबर) – वीडियो प्लेयर की चौड़ाई. डिफ़ॉल्ट वैल्यू 640 है.
- height (नंबर) – वीडियो प्लेयर की ऊंचाई. डिफ़ॉल्ट वैल्यू 390 है.
- videoId (स्ट्रिंग) – YouTube वीडियो का आईडी, जो उस वीडियो की पहचान करता है जिसे प्लेयर लोड करेगा.
- playerVars (ऑब्जेक्ट) – ऑब्जेक्ट की प्रॉपर्टी, प्लेयर पैरामीटर की पहचान करती हैं, जिनका इस्तेमाल प्लेयर को पसंद के मुताबिक बनाने के लिए किया जा सकता है.
- events (ऑब्जेक्ट) – ऑब्जेक्ट की प्रॉपर्टी, उन इवेंट की पहचान करती हैं जिन्हें एपीआई ट्रिगर करता है. साथ ही, उन फ़ंक्शन (इवेंट लिसनर) की भी पहचान करता है जिन्हें एपीआई इन इवेंट के होने पर कॉल करेगा. उदाहरण में, कंस्ट्रक्टर से पता चलता है कि onPlayerReady फ़ंक्शन, onReady इवेंट के ट्रिगर होने पर एक्ज़ीक्यूट होगा. साथ ही, यह भी बताता है कि onPlayerStateChange फ़ंक्शन onStateChange इवेंट के ट्रिगर होने पर काम करेगा.

जैसा कि शुरू करना सेक्शन में बताया गया है, अपने पेज पर कोई खाली <div> एलिमेंट लिखने के बजाय, प्लेयर एपीआई का JavaScript कोड <iframe> एलिमेंट से बदल देगा. इसलिए, <iframe> टैग खुद बनाया जा सकता है. उदाहरण सेक्शन के पहले उदाहरण में, ऐसा करने का तरीका बताया गया है.

<iframe id="player" type="text/html" width="640" height="390"
  src="http://www.youtube.com/embed/M7lc1UVf-VE?enablejsapi=1&origin=http://example.com"
  frameborder="0"></iframe>

ध्यान दें कि अगर <iframe> टैग लिखा जाता है, तो YT.Player ऑब्जेक्ट बनाते समय, आपको width और height के लिए वैल्यू तय करने की ज़रूरत नहीं है. ये वैल्यू, <iframe> टैग के एट्रिब्यूट या videoId और प्लेयर पैरामीटर के तौर पर बताई जाती हैं. इन वैल्यू की जानकारी src के यूआरएल में दी गई है. सुरक्षा के अतिरिक्त उपाय के तौर पर, आपको यूआरएल में origin पैरामीटर भी शामिल करना चाहिए. साथ ही, यूआरएल स्कीम (http:// या https://) और होस्ट पेज के पूरे डोमेन को पैरामीटर की वैल्यू के तौर पर शामिल करना चाहिए. हालांकि, origin का इस्तेमाल करना ज़रूरी नहीं है. हालांकि, इसे शामिल करना ज़रूरी नहीं है. हालांकि, यह आपके पेज में तीसरे पक्ष की नुकसान पहुंचाने वाली JavaScript को गलत तरीके से डाले जाने और आपके YouTube प्लेयर के कंट्रोल को हाइजैक होने से बचाता है.

उदाहरण सेक्शन में, वीडियो प्लेयर ऑब्जेक्ट बनाने के कुछ और उदाहरण भी दिखाए गए हैं.

ऑपरेशंस

प्लेयर एपीआई के तरीकों को कॉल करने के लिए, आपको सबसे पहले उस प्लेयर ऑब्जेक्ट का रेफ़रंस लेना होगा जिसे आपको कंट्रोल करना है. इस दस्तावेज़ के शुरू करना और वीडियो प्लेयर लोड करना सेक्शन में बताए गए तरीके से, आपको YT.Player ऑब्जेक्ट बनाकर रेफ़रंस मिलता है.

फ़ंक्शन

फ़ंक्शन की सूची बनाने की सुविधा

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

सूची बनाने वाले फ़ंक्शन को कॉल करने के लिए, एपीआई दो अलग-अलग सिंटैक्स के साथ काम करता है.

आर्ग्युमेंट सिंटैक्स के लिए यह ज़रूरी है कि फ़ंक्शन के आर्ग्युमेंट, तय क्रम में शामिल किए जाएं.
ऑब्जेक्ट सिंटैक्स से, किसी ऑब्जेक्ट को एक पैरामीटर के तौर पर पास किया जा सकता है. साथ ही, उन फ़ंक्शन आर्ग्युमेंट के लिए ऑब्जेक्ट प्रॉपर्टी तय की जा सकती है जिन्हें आपको सेट करना है. इसके अलावा, एपीआई ऐसी अन्य फ़ंक्शन के साथ भी काम कर सकता है जो आर्ग्युमेंट सिंटैक्स के साथ काम नहीं करता.

उदाहरण के लिए, loadVideoById फ़ंक्शन को इनमें से किसी भी तरीके से कॉल किया जा सकता है. ध्यान दें कि ऑब्जेक्ट सिंटैक्स, endSeconds प्रॉपर्टी के साथ काम करता है. यह आर्ग्युमेंट सिंटैक्स पर काम नहीं करता.

आर्ग्यूमेंट सिंटैक्स
```
loadVideoById("bHQqvYy5KYo", 5, "large")
```

ऑब्जेक्ट सिंटैक्स

loadVideoById({'videoId': 'bHQqvYy5KYo',
               'startSeconds': 5,
               'endSeconds': 60});

वीडियो की सूची बनाने की सुविधाएं

cueVideoById

आर्ग्यूमेंट सिंटैक्स

player.cueVideoById(videoId:String,
                    startSeconds:Number):Void

ऑब्जेक्ट सिंटैक्स

player.cueVideoById({videoId:String,
                     startSeconds:Number,
                     endSeconds:Number}):Void

यह फ़ंक्शन, वीडियो के थंबनेल को लोड करता है और प्लेयर को वीडियो चलाने के लिए तैयार करता है. जब तक playVideo() या seekTo() पर कॉल नहीं किया जाता, तब तक प्लेयर FLV का अनुरोध नहीं करता.

ज़रूरी videoId पैरामीटर, चलाए जाने वाले वीडियो का YouTube वीडियो आईडी बताता है. YouTube Data API में, video संसाधन की id प्रॉपर्टी, आईडी के बारे में बताती है.
वैकल्पिक startSeconds पैरामीटर, एक फ़्लोट/इंटीजर को स्वीकार करता है. साथ ही, यह उस समय को तय करता है जिससे playVideo() को कॉल किए जाने पर वीडियो चलना शुरू होना चाहिए. अगर startSeconds वैल्यू तय करने के बाद seekTo() को कॉल किया जाता है, तो प्लेयर seekTo() कॉल में बताए गए समय से चलेगा. जब वीडियो चुना जाएगा और वह चलने के लिए तैयार हो जाएगा, तब प्लेयर video cued इवेंट (5) ब्रॉडकास्ट करेगा.
वैकल्पिक endSeconds पैरामीटर, सिर्फ़ ऑब्जेक्ट सिंटैक्स में काम करता है. यह फ़्लोट/इंटीजर को स्वीकार करता है. साथ ही, यह उस समय के बारे में भी बताता है जब playVideo() को कॉल किए जाने पर, वीडियो चलना बंद हो जाना चाहिए. अगर endSeconds वैल्यू तय करने के बाद, seekTo() को कॉल किया जाता है, तो endSeconds वैल्यू काम नहीं करेगी.

loadVideoById

आर्ग्यूमेंट सिंटैक्स

player.loadVideoById(videoId:String,
                     startSeconds:Number):Void

ऑब्जेक्ट सिंटैक्स

player.loadVideoById({videoId:String,
                      startSeconds:Number,
                      endSeconds:Number}):Void

यह फ़ंक्शन, तय किए गए वीडियो को लोड करता है और चलाता है.

ज़रूरी videoId पैरामीटर, चलाए जाने वाले वीडियो का YouTube वीडियो आईडी बताता है. YouTube Data API में, video संसाधन की id प्रॉपर्टी, आईडी के बारे में बताती है.
वैकल्पिक startSeconds पैरामीटर, फ़्लोट/इंटीजर को स्वीकार करता है. अगर यह बताया गया है, तो वीडियो सबसे नज़दीकी कीफ़्रेम से तय किए गए समय तक शुरू होगा.
वैकल्पिक endSeconds पैरामीटर, फ़्लोट/इंटीजर को स्वीकार करता है. अगर इसके बारे में बताया जाता है, तो तय समय पर वीडियो चलना बंद हो जाएगा.

cueVideoByUrl

आर्ग्यूमेंट सिंटैक्स

player.cueVideoByUrl(mediaContentUrl:String,
                     startSeconds:Number):Void

ऑब्जेक्ट सिंटैक्स

player.cueVideoByUrl({mediaContentUrl:String,
                      startSeconds:Number,
                      endSeconds:Number}):Void

ज़रूरी mediaContentUrl पैरामीटर में YouTube प्लेयर का पूरी तरह क्वालिफ़ाइड यूआरएल मौजूद है, जिसका फ़ॉर्मैट http://www.youtube.com/v/VIDEO_ID?version=3 है.
वैकल्पिक startSeconds पैरामीटर, एक फ़्लोट/इंटीजर को स्वीकार करता है. साथ ही, यह उस समय को तय करता है जिससे playVideo() को कॉल किए जाने पर वीडियो चलना शुरू होना चाहिए. अगर startSeconds को तय करने के बाद seekTo() को कॉल किया जाता है, तो seekTo() कॉल में बताए गए समय से प्लेयर चलेगा. जब वीडियो क्यू के लिए तैयार हो जाएगा और उसे चलाए जाने के लिए तैयार हो जाएगा, तब प्लेयर video cued इवेंट (5) ब्रॉडकास्ट करेगा.
वैकल्पिक endSeconds पैरामीटर, सिर्फ़ ऑब्जेक्ट सिंटैक्स में काम करता है. यह फ़्लोट/इंटीजर को स्वीकार करता है. साथ ही, यह उस समय के बारे में भी बताता है जब playVideo() को कॉल किए जाने पर, वीडियो चलना बंद हो जाना चाहिए. अगर endSeconds वैल्यू तय करने के बाद, seekTo() को कॉल किया जाता है, तो endSeconds वैल्यू काम नहीं करेगी.

loadVideoByUrl

आर्ग्यूमेंट सिंटैक्स

player.loadVideoByUrl(mediaContentUrl:String,
                      startSeconds:Number):Void

ऑब्जेक्ट सिंटैक्स

player.loadVideoByUrl({mediaContentUrl:String,
                       startSeconds:Number,
                       endSeconds:Number}):Void

यह फ़ंक्शन, तय किए गए वीडियो को लोड करता है और चलाता है.

ज़रूरी mediaContentUrl पैरामीटर में YouTube प्लेयर का पूरी तरह क्वालिफ़ाइड यूआरएल मौजूद है, जिसका फ़ॉर्मैट http://www.youtube.com/v/VIDEO_ID?version=3 है.
वैकल्पिक startSeconds पैरामीटर, फ़्लोट/इंटीजर को स्वीकार करता है और वीडियो के शुरू होने के समय के बारे में बताता है. अगर startSeconds (नंबर कोई फ़्लोट हो सकता है) बताया गया है, तो वीडियो तय किए गए समय तक, सबसे नज़दीक वाले मुख्य-फ़्रेम से शुरू होगा.
वैकल्पिक endSeconds पैरामीटर, सिर्फ़ ऑब्जेक्ट सिंटैक्स में काम करता है. यह फ़्लोट/इंटीजर को स्वीकार करता है. साथ ही, यह उस समय के बारे में भी बताता है जब वीडियो चलना बंद हो जाना चाहिए.

सूचियों के लिए फ़ंक्शन की सूची बनाना

cuePlaylist और loadPlaylist फ़ंक्शन की मदद से, प्लेलिस्ट लोड की जा सकती है और उसे चलाया जा सकता है. अगर इन फ़ंक्शन को कॉल करने के लिए ऑब्जेक्ट सिंटैक्स का इस्तेमाल किया जा रहा है, तो उपयोगकर्ता के अपलोड किए गए वीडियो की सूची को भी सूची में जोड़ा (या लोड) किया जा सकता है.

फ़ंक्शन, इस आधार पर अलग-अलग तरह से काम करते हैं कि उन्हें आर्ग्युमेंट सिंटैक्स का इस्तेमाल करके कॉल किया गया है या ऑब्जेक्ट सिंटैक्स का. इसलिए, कॉल करने के दोनों तरीकों के बारे में नीचे बताया गया है.

cuePlaylist

आर्ग्यूमेंट सिंटैक्स
```
player.cuePlaylist(playlist:String|Array,
                   index:Number,
                   startSeconds:Number):Void
```
चुनी गई प्लेलिस्ट को सूची में जोड़ देता है. जब प्लेलिस्ट चुनी जाएगी और वह चलने के लिए तैयार होगी, तब प्लेयर video cued इवेंट (5) ब्रॉडकास्ट करेगा.
- ज़रूरी playlist पैरामीटर, YouTube वीडियो आईडी का कलेक्शन तय करता है. YouTube Data API में, video संसाधन की id प्रॉपर्टी उस वीडियो के आईडी की पहचान करती है.
- वैकल्पिक index पैरामीटर, प्लेलिस्ट के पहले वीडियो के इंडेक्स को बताता है. यह पैरामीटर, शून्य पर आधारित इंडेक्स का इस्तेमाल करता है और पैरामीटर की डिफ़ॉल्ट वैल्यू 0 होती है. इसलिए, डिफ़ॉल्ट सेटिंग, प्लेलिस्ट का पहला वीडियो लोड करने और चलाने का डिफ़ॉल्ट तरीका है.
- वैकल्पिक startSeconds पैरामीटर, फ़्लोट/इंटीजर को स्वीकार करता है. साथ ही, यह उस समय को तय करता है जब playVideo() फ़ंक्शन को कॉल किया जाता है, जब प्लेलिस्ट का पहला वीडियो चलना शुरू होता है. अगर startSeconds वैल्यू तय करने के बाद seekTo() को कॉल किया जाता है, तो प्लेयर seekTo() कॉल में बताए गए समय से चलेगा. अगर आपने कोई प्लेलिस्ट चुनी है और फिर playVideoAt() फ़ंक्शन को कॉल किया है, तो प्लेयर तय किए गए वीडियो की शुरुआत में चलना शुरू हो जाएगा.
ऑब्जेक्ट सिंटैक्स
```
player.cuePlaylist({listType:String,
                    list:String,
                    index:Number,
                    startSeconds:Number}):Void
```
वीडियो की सूची को सूची में जोड़ देता है. यह सूची कोई प्लेलिस्ट या उपयोगकर्ता के अपलोड किए गए वीडियो फ़ीड हो सकती है. खोज के नतीजों की सूची को सूची में जोड़ने की सुविधा बंद कर दी गई है. यह सुविधा 15 नवंबर, 2020 से काम नहीं करेगी.
सूची में शामिल होने के बाद, प्लेयर video cued इवेंट (5) ब्रॉडकास्ट करेगा.
- listType प्रॉपर्टी की वैकल्पिक प्रॉपर्टी से यह पता चलता है कि किस तरह के नतीजे फ़ीड को वापस लाया जा रहा है. मान्य वैल्यू, playlist और user_uploads हैं. search एट्रिब्यूट की काम न करने वाली वैल्यू, 15 नवंबर, 2020 से काम नहीं करेगी. डिफ़ॉल्ट वैल्यू playlist है.
- ज़रूरी list प्रॉपर्टी में एक कुंजी मौजूद होती है, जो वीडियो की उस सूची की पहचान करती है जिसे YouTube को दिखाना चाहिए.
  - अगर listType प्रॉपर्टी की वैल्यू playlist है, तो list प्रॉपर्टी, प्लेलिस्ट आईडी या वीडियो आईडी के कलेक्शन की जानकारी देती है. YouTube Data API में, playlist संसाधन की id प्रॉपर्टी किसी प्लेलिस्ट के आईडी की पहचान करती है, और video संसाधन की id प्रॉपर्टी, वीडियो आईडी की पहचान करती है.
  - अगर listType प्रॉपर्टी की वैल्यू user_uploads है, तो list प्रॉपर्टी उस उपयोगकर्ता की पहचान करती है जिसके अपलोड किए गए वीडियो दिखाए जाएंगे.
  - अगर listType प्रॉपर्टी की वैल्यू search है, तो list प्रॉपर्टी से खोज क्वेरी का पता चलता है. ध्यान दें: यह सुविधा बंद है और 15 नवंबर, 2020 से काम नहीं करेगी.
- वैकल्पिक index प्रॉपर्टी, सूची में चलने वाले पहले वीडियो के इंडेक्स के बारे में बताती है. यह पैरामीटर, शून्य पर आधारित इंडेक्स का इस्तेमाल करता है और पैरामीटर की डिफ़ॉल्ट वैल्यू 0 होती है. इसलिए, सूची का पहला वीडियो लोड करने और चलाने का डिफ़ॉल्ट तरीका होता है.
- वैकल्पिक startSeconds प्रॉपर्टी, फ़्लोट/इंटीजर को स्वीकार करती है. साथ ही, यह उस समय के बारे में बताती है जब playVideo() फ़ंक्शन को कॉल किया जाता है, तो सूची का पहला वीडियो चलना शुरू होने का समय तय करता है. अगर startSeconds वैल्यू तय करने के बाद seekTo() को कॉल किया जाता है, तो प्लेयर seekTo() कॉल में बताए गए समय से चलेगा. अगर कोई लिस्ट चुनने के बाद playVideoAt() फ़ंक्शन को कॉल किया जाता है, तो प्लेयर तय किए गए वीडियो की शुरुआत में चलना शुरू हो जाएगा.

loadPlaylist

आर्ग्यूमेंट सिंटैक्स
```
player.loadPlaylist(playlist:String|Array,
                    index:Number,
                    startSeconds:Number):Void
```
यह फ़ंक्शन, चुनी गई प्लेलिस्ट को लोड करता है और उसे चलाता है.
- ज़रूरी playlist पैरामीटर, YouTube वीडियो आईडी का कलेक्शन तय करता है. YouTube Data API में, video संसाधन की id प्रॉपर्टी, वीडियो आईडी के बारे में बताती है.
- वैकल्पिक index पैरामीटर, प्लेलिस्ट के पहले वीडियो के इंडेक्स को बताता है. यह पैरामीटर, शून्य पर आधारित इंडेक्स का इस्तेमाल करता है और पैरामीटर की डिफ़ॉल्ट वैल्यू 0 होती है. इसलिए, डिफ़ॉल्ट सेटिंग, प्लेलिस्ट का पहला वीडियो लोड करने और चलाने का डिफ़ॉल्ट तरीका है.
- वैकल्पिक startSeconds पैरामीटर, एक फ़्लोट/इंटीजर को स्वीकार करता है. साथ ही, यह उस समय को तय करता है जब से प्लेलिस्ट का पहला वीडियो चलना शुरू होना चाहिए.
ऑब्जेक्ट सिंटैक्स
```
player.loadPlaylist({list:String,
                     listType:String,
                     index:Number,
                     startSeconds:Number}):Void
```
यह फ़ंक्शन, तय की गई सूची को लोड करता है और उसे चलाता है. यह सूची कोई प्लेलिस्ट या उपयोगकर्ता के अपलोड किए गए वीडियो फ़ीड हो सकती है. खोज के नतीजों की सूची लोड करने की सुविधा बंद कर दी गई है. 15 नवंबर, 2020 से यह सुविधा काम नहीं करेगी.
- listType प्रॉपर्टी की वैकल्पिक प्रॉपर्टी से यह पता चलता है कि किस तरह के नतीजे फ़ीड को वापस लाया जा रहा है. मान्य वैल्यू, playlist और user_uploads हैं. search एट्रिब्यूट की काम न करने वाली वैल्यू, 15 नवंबर, 2020 से काम नहीं करेगी. डिफ़ॉल्ट वैल्यू playlist है.
- ज़रूरी list प्रॉपर्टी में एक कुंजी मौजूद होती है, जो वीडियो की उस सूची की पहचान करती है जिसे YouTube को दिखाना चाहिए.
  - अगर listType प्रॉपर्टी की वैल्यू playlist है, तो list प्रॉपर्टी, प्लेलिस्ट आईडी या वीडियो आईडी के कलेक्शन की जानकारी देती है. YouTube Data API में, playlist संसाधन की id प्रॉपर्टी प्लेलिस्ट के आईडी के बारे में बताती है और video संसाधन की id प्रॉपर्टी, वीडियो आईडी के बारे में बताती है.
  - अगर listType प्रॉपर्टी की वैल्यू user_uploads है, तो list प्रॉपर्टी उस उपयोगकर्ता की पहचान करती है जिसके अपलोड किए गए वीडियो दिखाए जाएंगे.
  - अगर listType प्रॉपर्टी की वैल्यू search है, तो list प्रॉपर्टी से खोज क्वेरी का पता चलता है. ध्यान दें: यह सुविधा बंद है और 15 नवंबर, 2020 से काम नहीं करेगी.
- वैकल्पिक index प्रॉपर्टी, सूची में चलने वाले पहले वीडियो के इंडेक्स के बारे में बताती है. यह पैरामीटर, शून्य पर आधारित इंडेक्स का इस्तेमाल करता है और पैरामीटर की डिफ़ॉल्ट वैल्यू 0 होती है. इसलिए, सूची का पहला वीडियो लोड करने और चलाने का डिफ़ॉल्ट तरीका होता है.
- वैकल्पिक startSeconds प्रॉपर्टी, फ़्लोट/इंटीजर को स्वीकार करती है. साथ ही, यह उस समय के बारे में बताती है जिससे सूची का पहला वीडियो चलना शुरू होना चाहिए.

प्लेबैक कंट्रोल और प्लेयर की सेटिंग

कोई वीडियो चलाना

player.playVideo():Void: इस समय क्यू/लोड किया गया वीडियो चलाता है. इस फ़ंक्शन के चलने के बाद, प्लेयर की आखिरी स्थिति playing (1) होगी.

ध्यान दें: किसी वीडियो को आधिकारिक तौर पर देखे जाने की संख्या में तब ही गिना जाता है, जब उसे प्लेयर में नेटिव प्ले बटन से शुरू किया गया हो.

player.pauseVideo():Void: अभी चल रहे वीडियो को रोकता है. इस फ़ंक्शन के लागू होने के बाद, प्लेयर की आखिरी स्थिति paused (2) होगी. ऐसा तब तक होगा, जब तक फ़ंक्शन कॉल किए जाने के समय प्लेयर, ended (0) स्थिति में न हो. ऐसे में, प्लेयर की स्थिति में कोई बदलाव नहीं होगा.

player.stopVideo():Void: इससे मौजूदा वीडियो लोड होने की प्रोसेस रुक जाती है और रद्द हो जाती है. जब आपको पता हो कि उपयोगकर्ता, प्लेयर में कोई दूसरा वीडियो नहीं देख रहा है, तब इस फ़ंक्शन को खास स्थितियों के लिए रिज़र्व करना चाहिए. अगर आपको वीडियो रोकना है, तो आपको सिर्फ़ pauseVideo फ़ंक्शन को कॉल करना चाहिए. अगर आपको प्लेयर के चलाए जा रहे वीडियो को बदलना है, तो पहले stopVideo को कॉल किए बिना, सूची में शामिल किसी फ़ंक्शन को कॉल किया जा सकता है.

अहम जानकारी: pauseVideo फ़ंक्शन, प्लेयर को paused (2) वाली स्थिति में छोड़ देता है. वहीं, stopVideo फ़ंक्शन से प्लेयर को किसी गेम पर नहीं चलाया जा सकता. इनमें ended (0), paused (2), video cued (5) या unstarted (-1) शामिल हैं.

player.seekTo(seconds:Number, allowSeekAhead:Boolean):Void

वीडियो में किसी खास समय पर ले जाने वाला कॉन्टेंट. अगर फ़ंक्शन को कॉल करते समय प्लेयर को रोका गया है, तो वह रुका हुआ रहेगा. अगर फ़ंक्शन को किसी दूसरी स्थिति (playing, video cued वगैरह) से कॉल किया जाता है, तो प्लेयर वीडियो चलाएगा.

seconds पैरामीटर उस समय की पहचान करता है, जब प्लेयर को आगे बढ़ना चाहिए.

वीडियो प्लेयर इस समय से पहले ही सबसे नज़दीकी कीफ़्रेम पर पहुंच जाएगा. ऐसा तब तक होगा, जब तक प्लेयर ने वीडियो के उस हिस्से को डाउनलोड न कर लिया हो जिसे दर्शक ढूंढ रहा है.
allowSeekAhead पैरामीटर से यह तय होता है कि अगर seconds पैरामीटर, बफ़र किए गए मौजूदा वीडियो डेटा के बाहर का समय तय करता है, तो प्लेयर, सर्वर से नया अनुरोध करेगा या नहीं.

हमारा सुझाव है कि आप इस पैरामीटर को false पर सेट करें. ऐसा तब करें, जब उपयोगकर्ता माउस को वीडियो प्रोग्रेस बार पर खींचें और छोड़ें. इसके बाद, जब उपयोगकर्ता माउस छोड़ दे, तब इसे true पर सेट करें. इस तरीके से लोग बिना बफ़र किए हुए पॉइंट पर स्क्रोल करके, नई वीडियो स्ट्रीम का अनुरोध किए बिना वीडियो के अलग-अलग पॉइंट पर स्क्रोल कर सकते हैं. जब उपयोगकर्ता माउस का बटन छोड़ता है, तो प्लेयर वीडियो में मनचाहे बिंदु पर चला जाता है और ज़रूरत होने पर नई वीडियो स्ट्रीम का अनुरोध करता है.

360 डिग्री वाले वीडियो चलाने की सुविधा को कंट्रोल करना

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

player.getSphericalProperties():Object

यह उन प्रॉपर्टी की जानकारी हासिल करता है जिनसे वीडियो चलाने के लिए, दर्शक का मौजूदा नज़रिया या व्यू की जानकारी मिलती है. इसके अलावा:

इस ऑब्जेक्ट में सिर्फ़ 360° वीडियो के लिए जानकारी अपने-आप भर जाती है, जिन्हें स्फ़ेरिकल वीडियो भी कहा जाता है.
अगर मौजूदा वीडियो 360 डिग्री वाला वीडियो नहीं है या किसी ऐसे डिवाइस से कॉल किया जाता है जिस पर यह सुविधा काम नहीं करती, तो फ़ंक्शन एक खाली ऑब्जेक्ट दिखाता है.
साथ काम करने वाले मोबाइल डिवाइसों पर, अगर enableOrientationSensor प्रॉपर्टी true पर सेट है, तो यह फ़ंक्शन एक ऐसा ऑब्जेक्ट दिखाता है जिसमें fov प्रॉपर्टी की सही वैल्यू होती है और अन्य प्रॉपर्टी 0 पर सेट होती है.

ऑब्जेक्ट में ये प्रॉपर्टी शामिल हैं:

प्रॉपर्टी
`yaw`	[0, 360) की रेंज में मौजूद कोई संख्या, जो व्यू के हॉरिज़ॉन्टल ऐंगल को डिग्री में दिखाती है. इससे पता चलता है कि उपयोगकर्ता किस हद तक बाईं या दाईं ओर मुड़ता है. निष्पक्ष स्थिति, वीडियो के केंद्र को इसके समकोणीय प्रोजेक्शन में दिखाती है. यह 0° दिखाती है और जैसे ही दर्शक बाईं ओर मुड़ता है, यह मान बढ़ता है.
`pitch`	[-90, 90] की रेंज में मौजूद कोई संख्या, जो व्यू के वर्टिकल ऐंगल को डिग्री में दिखाती है. इससे पता चलता है कि उपयोगकर्ता, व्यू को ऊपर या नीचे देखने के लिए किस हद तक अडजस्ट करता है. न्यूट्रल पोज़िशन, वीडियो के बीच वाले हिस्से को इक्विरेक्टैंग्युलर प्रोजेक्शन में दिखाती है. यह 0° दिखाती है. जैसे-जैसे दर्शक ऊपर की ओर देखता है, यह वैल्यू बढ़ जाती है.
`roll`	[-180, 180] की रेंज में मौजूद कोई संख्या, जो डिग्री में व्यू के घड़ी की दिशा में या घड़ी की विपरीत दिशा में घुमाने वाला कोण दिखाती है. न्यूट्रल पोज़िशन, जिसमें इक्विरेक्टैंग्युलर प्रोजेक्शन में हॉरिज़ॉन्टल ऐक्सिस, व्यू के हॉरिज़ॉन्टल ऐक्सिस के समानांतर होता है. यह 0° दिखाता है. व्यू के घड़ी की दिशा में घूमने पर वैल्यू बढ़ती है और व्यू की उलटी दिशा में घटता है. ध्यान दें कि एम्बेड किए गए प्लेयर में, व्यू के रोल को अडजस्ट करने के लिए यूज़र इंटरफ़ेस नहीं है. रोल में बदलाव करने के लिए, इनमें से किसी एक तरीके का इस्तेमाल किया जा सकता है: व्यू को रोल आउट करने के लिए, मोबाइल ब्राउज़र में स्क्रीन की दिशा दिखाने वाले सेंसर का इस्तेमाल करें. अगर ओरिएंटेशन सेंसर चालू है, तो `getSphericalProperties` फ़ंक्शन हमेशा `roll` प्रॉपर्टी की वैल्यू के रूप में `0` दिखाता है. अगर स्क्रीन की दिशा बताने वाला सेंसर बंद है, तो इस एपीआई का इस्तेमाल करके रोल को शून्य में न करने वाली वैल्यू पर सेट करें.
`fov`	[30, 120] की रेंज में मौजूद ऐसी संख्या जो व्यू के फ़ील्ड-ऑफ़-व्यू को डिग्री में दिखाती है. इसे व्यूपोर्ट के लंबे किनारे से मापा जाता है. छोटे किनारे इस तरह अपने-आप अडजस्ट हो जाते हैं कि यह व्यू के आसपेक्ट रेशियो (लंबाई-चौड़ाई का अनुपात) के अनुपात में हो जाए. डिफ़ॉल्ट वैल्यू 100 डिग्री होती है. मान को कम करना वीडियो सामग्री पर ज़ूम इन करने और मान को बढ़ाने जैसा है. इस वैल्यू को या तो एपीआई का इस्तेमाल करके या फ़ुल स्क्रीन मोड में वीडियो के माउसव्हील का इस्तेमाल करके, अडजस्ट किया जा सकता है.

player.setSphericalProperties(properties:Object):Void

360 डिग्री वाले वीडियो को चलाने के लिए, वीडियो की स्क्रीन की दिशा सेट करता है. (अगर मौजूदा वीडियो गोलाकार नहीं है, तो इनपुट के बावजूद यह तरीका नो-ऑप होता है.)

प्लेयर व्यू, properties ऑब्जेक्ट में किसी भी ज्ञात प्रॉपर्टी के मान दिखाने के लिए अपडेट करके इस तरीके को जवाब देता है. व्यू में, ऐसी दूसरी प्रॉपर्टी के लिए भी वैल्यू बनी रहती हैं जो उस ऑब्जेक्ट में शामिल नहीं हैं.

इसके अलावा:

अगर ऑब्जेक्ट में अनजान और/या ऐसी प्रॉपर्टी हैं जिनकी जानकारी नहीं है, तो प्लेयर उन्हें अनदेखा कर देता है.
जैसा कि इस सेक्शन की शुरुआत में बताया गया है, सभी मोबाइल डिवाइसों पर 360 डिग्री वीडियो चलाने की सुविधा उपलब्ध नहीं है.
डिफ़ॉल्ट रूप से, काम करने वाले मोबाइल डिवाइसों पर यह फ़ंक्शन सिर्फ़ fov प्रॉपर्टी सेट करता है. 360 डिग्री वाले वीडियो चलाने के लिए, yaw, pitch, और roll प्रॉपर्टी पर इसका कोई असर नहीं पड़ता. ज़्यादा जानकारी के लिए, यहां दी गई enableOrientationSensor प्रॉपर्टी देखें.

फ़ंक्शन में पास किए गए properties ऑब्जेक्ट में ये प्रॉपर्टी शामिल हैं:

प्रॉपर्टी
`yaw`	ऊपर परिभाषा देखें.
`pitch`	ऊपर परिभाषा देखें.
`roll`	ऊपर परिभाषा देखें.
`fov`	ऊपर परिभाषा देखें.
`enableOrientationSensor`	ध्यान दें: यह प्रॉपर्टी, सिर्फ़ उन डिवाइसों पर 360 डिग्री वाले वीडियो देखने के अनुभव पर असर डालती है जिन पर यह सुविधा काम करती है.यह एक बूलियन वैल्यू होती है. इससे पता चलता है कि iFrame एम्बेड को उन इवेंट का जवाब देना चाहिए या नहीं जो इस्तेमाल किए जा सकने वाले डिवाइस के ओरिएंटेशन में बदलाव करते हैं, जैसे कि मोबाइल ब्राउज़र का `DeviceOrientationEvent`. पैरामीटर की डिफ़ॉल्ट वैल्यू `true` है. साथ काम करने वाले मोबाइल डिवाइस वैल्यू `true` होने पर, एम्बेड किया गया प्लेयर सिर्फ़ डिवाइस की गतिविधि पर निर्भर करता है. इसकी मदद से, 360 डिग्री वीडियो चलाने के लिए `yaw`, `pitch`, और `roll` प्रॉपर्टी में बदलाव किया जा सकता है. हालांकि, एपीआई की मदद से `fov` प्रॉपर्टी को अब भी बदला जा सकता है और किसी मोबाइल डिवाइस पर `fov` प्रॉपर्टी को बदलने का सिर्फ़ एपीआई ही एक तरीका है. यह डिफ़ॉल्ट व्यवहार है. अगर वैल्यू `false` है, तो डिवाइस की मूवमेंट से, वीडियो देखने के 360° व्यू पर कोई असर नहीं पड़ता. साथ ही, `yaw`, `pitch`, `roll`, और `fov` प्रॉपर्टी को एपीआई की मदद से सेट करना ज़रूरी है. ऐसे मोबाइल डिवाइस जिन पर ऐप्लिकेशन काम नहीं करता `enableOrientationSensor` प्रॉपर्टी की वैल्यू का असर, वीडियो चलाने के अनुभव पर नहीं पड़ता.

प्लेलिस्ट में वीडियो चलाना

player.nextVideo():Void

यह फ़ंक्शन, प्लेलिस्ट का अगला वीडियो लोड करता है और चलाता है.

अगर प्लेलिस्ट का आखिरी वीडियो देखे जाने के दौरान player.nextVideo() को कॉल किया जाता है और प्लेलिस्ट को लगातार चलने के लिए (loop) पर सेट किया गया है, तो प्लेयर लोड हो जाएगा और सूची का पहला वीडियो चलाएगा.
अगर प्लेलिस्ट का आखिरी वीडियो देखे जाने के दौरान player.nextVideo() को कॉल किया जाता है और प्लेलिस्ट को लगातार चलाने के लिए सेट नहीं किया गया है, तो वीडियो चलना बंद हो जाएगा.

player.previousVideo():Void

यह फ़ंक्शन, प्लेलिस्ट के पिछले वीडियो को लोड करता है और चलाता है.

अगर प्लेलिस्ट का पहला वीडियो देखे जाने के दौरान player.previousVideo() को कॉल किया जाता है और प्लेलिस्ट को लगातार चलने के लिए (loop) पर सेट किया गया है, तो प्लेयर लोड हो जाएगा और सूची का आखिरी वीडियो चलाएगा.
अगर प्लेलिस्ट का पहला वीडियो देखे जाने के दौरान player.previousVideo() को कॉल किया जाता है और प्लेलिस्ट को लगातार चलाने के लिए सेट नहीं किया गया है, तो प्लेयर पहले प्लेलिस्ट वीडियो को शुरू से रीस्टार्ट करेगा.

player.playVideoAt(index:Number):Void

यह फ़ंक्शन, प्लेलिस्ट में बताए गए वीडियो को लोड करता है और चलाता है.

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

प्लेयर का वॉल्यूम बदलना

player.mute():Void: प्लेयर को म्यूट करता है.

player.unMute():Void: प्लेयर को अनम्यूट करता है.

player.isMuted():Boolean: प्लेयर के म्यूट होने पर true दिखाएगा. अगर ऐसा नहीं है, तो false दिखाएगा.

player.setVolume(volume:Number):Void: वॉल्यूम को सेट करता है. 0 और 100 के बीच का पूर्णांक स्वीकार करता है.

player.getVolume():Number: यह प्लेयर का मौजूदा वॉल्यूम दिखाता है. यह 0 और 100 के बीच का पूर्णांक होता है. ध्यान दें कि प्लेयर के म्यूट होने पर भी, getVolume() से आवाज़ सुनाई देगी.

प्लेयर का साइज़ सेट करना

player.setSize(width:Number, height:Number):Object: प्लेयर वाले <iframe> के साइज़ को पिक्सल में सेट करता है.

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

player.getPlaybackRate():Number: यह फ़ंक्शन, चल रहे वीडियो के चलाने की दर की जानकारी हासिल करता है. वीडियो चलाने की डिफ़ॉल्ट दर 1 है. इससे पता चलता है कि वीडियो सामान्य रफ़्तार पर चल रहा है. वीडियो चलाने की दरों में 0.25, 0.5, 1, 1.5, और 2 जैसी वैल्यू शामिल हो सकती हैं.

player.setPlaybackRate(suggestedRate:Number):Void: यह फ़ंक्शन, मौजूदा वीडियो के लिए वीडियो चलाने की सुझाई गई दर सेट करता है. अगर वीडियो चलाने की दर में बदलाव होता है, तो यह सिर्फ़ उस वीडियो के लिए बदलेगी जिसे पहले से ही क्यू में दिखाया जा रहा है या चलाया जा रहा है. अगर आपने सुझाए गए किसी वीडियो के लिए वीडियो चलाने की दर सेट की है, तो यह दर तब भी लागू रहेगी, जब playVideo फ़ंक्शन को कॉल किया जाएगा या उपयोगकर्ता ने सीधे प्लेयर कंट्रोल की मदद से वीडियो चलाया होगा. साथ ही, वीडियो या प्लेलिस्ट (cueVideoById, loadVideoById वगैरह) को क्यू या लोड करने के लिए, फ़ंक्शन को कॉल करने से वीडियो चलाने की दर 1 पर रीसेट हो जाएगी.

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

getAvailablePlaybackRates तरीका, चल रहे वीडियो के लिए वीडियो चलाने की संभावित दरों की जानकारी देगा. हालांकि, अगर suggestedRate पैरामीटर को इस्तेमाल न किए जा सकने वाले पूर्णांक या फ़्लोट वैल्यू पर सेट किया जाता है, तो प्लेयर उस वैल्यू को 1 की दिशा में इस्तेमाल की जा सकने वाली सबसे नज़दीकी वैल्यू तक कम कर देगा.

player.getAvailablePlaybackRates():Array: यह फ़ंक्शन, वीडियो चलाने की उन दरों का सेट दिखाता है जिनमें मौजूदा वीडियो उपलब्ध है. इसकी डिफ़ॉल्ट वैल्यू 1 है. इसका मतलब है कि वीडियो सामान्य स्पीड में चल रहा है.

यह फ़ंक्शन, वीडियो चलाने की सबसे धीमी से लेकर सबसे तेज़ स्पीड तक के क्रम में नंबर का कलेक्शन दिखाता है. अगर प्लेयर पर वीडियो चलाने की अलग-अलग स्पीड काम नहीं करती, तब भी अरे में हमेशा कम से कम एक वैल्यू (1) होनी चाहिए.

प्लेलिस्ट के लिए प्लेबैक व्यवहार सेट करना

player.setLoop(loopPlaylists:Boolean):Void

इस फ़ंक्शन से यह पता चलता है कि क्या वीडियो प्लेयर को प्लेलिस्ट को लगातार चलाना चाहिए या उसे प्लेलिस्ट के आखिरी वीडियो के खत्म होने के बाद चलाना बंद करना चाहिए. डिफ़ॉल्ट तौर पर, प्लेलिस्ट लूप में नहीं चलती हैं.

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

ज़रूरी loopPlaylists पैरामीटर, लूप में चलने वाले व्यवहार की पहचान करता है.

अगर पैरामीटर की वैल्यू true है, तो वीडियो प्लेयर लगातार प्लेलिस्ट चलाएगा. किसी प्लेलिस्ट का आखिरी वीडियो चलाने के बाद, वीडियो प्लेयर, प्लेलिस्ट की शुरुआत में वापस जाएगा और उसे फिर से चलाता है.
अगर पैरामीटर की वैल्यू false है, तो वीडियो प्लेयर की प्लेलिस्ट का आखिरी वीडियो चलने के बाद वीडियो चलना बंद हो जाएगा.

player.setShuffle(shufflePlaylist:Boolean):Void

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

अगर कोई दूसरी प्लेलिस्ट लोड की जाती है या उसका विकल्प चुना जाता है, तो यह सेटिंग बनी नहीं रहेगी. इसका मतलब है कि अगर कोई प्लेलिस्ट लोड की जाती है, तो setShuffle फ़ंक्शन को कॉल करें और फिर दूसरी प्लेलिस्ट लोड करें. ऐसा करने पर, दूसरी प्लेलिस्ट शफ़ल नहीं होगी.

ज़रूरी shufflePlaylist पैरामीटर बताता है कि YouTube को प्लेलिस्ट शफ़ल करनी चाहिए या नहीं.

अगर पैरामीटर वैल्यू true है, तो YouTube, प्लेलिस्ट का क्रम शफ़ल कर देगा. अगर आपने फ़ंक्शन को ऐसी प्लेलिस्ट को शफ़ल करने का निर्देश दिया है जिसे पहले ही शफ़ल किया जा चुका है, तो YouTube, क्रम को फिर से शफ़ल कर देगा.
अगर पैरामीटर की वैल्यू false है, तो YouTube प्लेलिस्ट के क्रम को वापस उसके मूल क्रम में बदल देगा.

वीडियो चलाने की स्थिति

player.getVideoLoadedFraction():Float: 0 और 1 के बीच की कोई संख्या दिखाता है जो वीडियो के बफ़र किए गए हिस्से के प्रतिशत के बारे में बताती है. यह तरीका, अब काम नहीं करने वाले getVideoBytesLoaded और getVideoBytesTotal तरीकों की तुलना में ज़्यादा भरोसेमंद नंबर दिखाता है.

player.getPlayerState():Number

प्लेयर की स्थिति दिखाता है. संभावित वैल्यू ये हैं:

-1 – शुरू नहीं किया गया
0 – खत्म हुआ
1 – चलाया जा रहा है
2 – रोका गया
3 – बफ़र हो रहा है
5 – वीडियो का सुझाव दिया गया

player.getCurrentTime():Number: वीडियो चलना शुरू होने के बाद से सेकंड में बीता हुआ समय देता है.

player.getVideoStartBytes():Number: 31 अक्टूबर, 2012 से काम नहीं कर रहा है. वीडियो फ़ाइल लोड होना शुरू होने के बाद, बाइट की संख्या दिखाता है. (यह तरीका अब हमेशा 0 की वैल्यू दिखाता है.) एक उदाहरण: उपयोगकर्ता किसी ऐसे पॉइंट पर आगे बढ़ता है जो अब तक लोड नहीं हुआ है. इसके बाद, प्लेयर वीडियो के उस सेगमेंट को चलाने के लिए नया अनुरोध करता है जो अब तक लोड नहीं हुआ है.

player.getVideoBytesLoaded():Number: 18 जुलाई, 2012 से काम करना बंद कर दिया गया है. इसके बजाय, getVideoLoadedFraction तरीके का इस्तेमाल करके, बफ़र किए गए वीडियो का प्रतिशत पता करें.

इस तरीके से, 0 से 1000 के बीच की वैल्यू मिलती है. इससे लोड हुए वीडियो के कुल हिस्से का अनुमान लगाया जाता है. getVideoBytesLoaded वैल्यू को getVideoBytesTotal वैल्यू से भाग देकर, लोड किए गए वीडियो के हिस्से का हिसाब लगाया जा सकता है.

player.getVideoBytesTotal():Number: 18 जुलाई, 2012 से काम करना बंद कर दिया गया है. इसके बजाय, getVideoLoadedFraction तरीके का इस्तेमाल करके, बफ़र किए गए वीडियो का प्रतिशत पता करें.

यह फ़ंक्शन, हाल ही में लोड किए गए/चलाए जा रहे वीडियो या वीडियो के साइज़ का अनुमान दिखाता है. इसके अलावा, यह जानकारी भी बाइट में दिखाता है.

इस तरीके से हमेशा 1000 वैल्यू मिलती है. getVideoBytesLoaded वैल्यू को getVideoBytesTotal वैल्यू से भाग देकर, लोड किए गए वीडियो के हिस्से का हिसाब लगाया जा सकता है.

वीडियो की जानकारी वापस हासिल की जा रही है

player.getDuration():Number: अभी चल रहे वीडियो की अवधि को सेकंड में दिखाता है. ध्यान दें कि getDuration(), वीडियो का मेटाडेटा लोड होने तक 0 दिखाएगा. आम तौर पर, ऐसा वीडियो चलना शुरू होने के तुरंत बाद होता है.

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

player.getVideoUrl():String: लोड किए गए/चलाए जा रहे वीडियो के लिए, YouTube.com का यूआरएल दिखाता है.

player.getVideoEmbedCode():String: लोड किए गए/चलाए जा रहे वीडियो के लिए एम्बेड कोड दिखाता है.

प्लेलिस्ट की जानकारी वापस हासिल की जा रही है

player.getPlaylist():Array: यह फ़ंक्शन, प्लेलिस्ट में क्रम के हिसाब से वीडियो आईडी का कलेक्शन दिखाता है. डिफ़ॉल्ट रूप से, यह फ़ंक्शन वीडियो के आईडी उसी क्रम में दिखाएगा जिसे प्लेलिस्ट के मालिक ने तय किया है. हालांकि, अगर आपने प्लेलिस्ट के क्रम को शफ़ल करने के लिए, setShuffle फ़ंक्शन को कॉल किया है, तो getPlaylist() फ़ंक्शन की रिटर्न वैल्यू, शफ़ल किए गए क्रम को दिखाएगी.

player.getPlaylistIndex():Number

यह फ़ंक्शन, प्लेलिस्ट के उस वीडियो का इंडेक्स दिखाता है जो अभी चल रहा है.

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

इवेंट लिसनर को जोड़ना या हटाना

player.addEventListener(event:String, listener:String):Void: बताए गए event के लिए, लिसनर फ़ंक्शन जोड़ता है. नीचे दिया गया इवेंट सेक्शन, उन अलग-अलग इवेंट की पहचान करता है जिन्हें प्लेयर ट्रिगर कर सकता है. लिसनर एक ऐसी स्ट्रिंग है जो उस फ़ंक्शन के बारे में बताती है जो तय किए गए इवेंट के ट्रिगर होने पर काम करेगा.

player.removeEventListener(event:String, listener:String):Void: बताई गई event के लिए, लिसनर फ़ंक्शन को हटाता है. listener एक ऐसी स्ट्रिंग है जो उस फ़ंक्शन की पहचान करती है जो तय किए गए इवेंट के सक्रिय होने पर अब काम नहीं करेगा.

डीओएम नोड को ऐक्सेस और उनमें बदलाव करना

player.getIframe():Object: यह तरीका, एम्बेड किए गए <iframe> के लिए डीओएम नोड दिखाता है.

player.destroy():Void: उस <iframe> को हटाता है जिसमें प्लेयर है.

इवेंट

एम्बेड किए गए प्लेयर में बदलाव करने पर, एपीआई आपके ऐप्लिकेशन को सूचना देने के लिए इवेंट ट्रिगर करता है. जैसा कि पिछले सेक्शन में बताया गया है, YT.Player ऑब्जेक्ट बनाते समय इवेंट लिसनर जोड़कर इवेंट की सदस्यता ली जा सकती है. साथ ही, addEventListener फ़ंक्शन का भी इस्तेमाल किया जा सकता है.

एपीआई इनमें से हर फ़ंक्शन के लिए, एकमात्र तर्क के तौर पर एक इवेंट ऑब्जेक्ट पास करेगा. इवेंट ऑब्जेक्ट में ये प्रॉपर्टी हैं:

इवेंट का target, इवेंट से जुड़े वीडियो प्लेयर की पहचान करता है.
इवेंट के data से, इवेंट के लिए काम की वैल्यू पता चलती है. ध्यान दें कि onReady और onAutoplayBlocked इवेंट से, data प्रॉपर्टी के बारे में पता नहीं चलता.

नीचे दी गई सूची में उन इवेंट के बारे में बताया गया है जिन्हें एपीआई ट्रिगर करता है:

onReady

जब भी कोई प्लेयर लोड हो जाता है और एपीआई कॉल पाने के लिए तैयार होता है, तब यह इवेंट ट्रिगर होता है. अगर आपको, प्लेयर के तैयार होते ही वीडियो चलाने या वीडियो की जानकारी दिखाने जैसी कुछ कार्रवाइयां अपने-आप करने की सुविधा चालू करनी है, तो आपके ऐप्लिकेशन को यह फ़ंक्शन लागू करना चाहिए.

नीचे दिए गए उदाहरण में, इस इवेंट को मैनेज करने के लिए एक सैंपल फ़ंक्शन दिखाया गया है. एपीआई, फ़ंक्शन को जो इवेंट ऑब्जेक्ट पास करता है उसमें एक target प्रॉपर्टी होती है, जो प्लेयर की पहचान करती है. यह फ़ंक्शन, हाल ही में लोड किए गए वीडियो से एम्बेड कोड हासिल करता है, वीडियो चलाना शुरू करता है, और पेज एलिमेंट में एम्बेड कोड को दिखाता है, जिसकी id वैल्यू embed-code होती है.

function onPlayerReady(event) {
  var embedCode = event.target.getVideoEmbedCode();
  event.target.playVideo();
  if (document.getElementById('embed-code')) {
    document.getElementById('embed-code').innerHTML = embedCode;
  }
}

onStateChange

जब भी खिलाड़ी की स्थिति बदलती है, तब यह इवेंट सक्रिय होता है. इवेंट ऑब्जेक्ट की data प्रॉपर्टी, जिसे एपीआई आपके इवेंट लिसनर फ़ंक्शन को पास करता है, एक ऐसा पूर्णांक तय करेगी जो प्लेयर की नई स्थिति से मेल खाए. आपको ये वैल्यू दिख सकती हैं:

-1 (शुरू नहीं हुई है)
0 (खत्म हो गया)
1 (चलाया जा रहा है)
2 (रोका गया)
3 (बफ़रिंग)
5 (वीडियो क्यू किया गया).

जब प्लेयर पहली बार किसी वीडियो को लोड करेगा, तब इससे unstarted (-1) इवेंट ब्रॉडकास्ट होगा. जब कोई वीडियो चुना जाएगा और वह चलने के लिए तैयार होगा, तो प्लेयर video cued (5) इवेंट ब्रॉडकास्ट करेगा. अपने कोड में, पूर्णांक वैल्यू तय की जा सकती है या इनमें से किसी एक नेमस्पेस किए गए वैरिएबल का इस्तेमाल किया जा सकता है:

YT.PlayerState.ENDED
YT.PlayerState.PLAYING
YT.PlayerState.PAUSED
YT.PlayerState.BUFFERING
YT.PlayerState.CUED

onPlaybackQualityChange

जब भी वीडियो की क्वालिटी बदलती है, तब यह इवेंट ट्रिगर होता है. ऐसा हो सकता है कि दर्शक के वीडियो चलाने के माहौल में बदलाव हो. वीडियो चलाने की स्थितियों या किसी इवेंट के चालू होने की वजहों के बारे में ज़्यादा जानने के लिए, YouTube के सहायता केंद्र पर जाएं.

इवेंट लिसनर फ़ंक्शन को एपीआई से पास की गई data प्रॉपर्टी की वैल्यू, एक स्ट्रिंग होगी, जो वीडियो की नई क्वालिटी की पहचान करती है. आपको ये वैल्यू दिख सकती हैं:

small
medium
large
hd720
hd1080
highres

onPlaybackRateChange: वीडियो चलाने की दर में बदलाव होने पर, यह इवेंट चालू हो जाता है. उदाहरण के लिए, अगर setPlaybackRate(suggestedRate) फ़ंक्शन को कॉल किया जाता है, तो वीडियो चलाने की दर में असल में बदलाव होने पर यह इवेंट सक्रिय हो जाएगा. आपके ऐप्लिकेशन को इवेंट का जवाब देना चाहिए. साथ ही, उसे यह नहीं लगना चाहिए कि setPlaybackRate(suggestedRate) फ़ंक्शन को कॉल करने पर, वीडियो चलाने की दर अपने-आप बदल जाएगी. इसी तरह, आपके कोड को यह नहीं मानना चाहिए कि सिर्फ़ setPlaybackRate पर अश्लील कॉल करने से ही वीडियो चलाने की दर बदलेगी.

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

onError

प्लेयर में कोई गड़बड़ी होने पर यह इवेंट सक्रिय होता है. एपीआई, इवेंट लिसनर फ़ंक्शन को एक event ऑब्जेक्ट पास करेगा. उस ऑब्जेक्ट की data प्रॉपर्टी एक पूर्णांक तय करेगी, जिससे यह पता चलेगा कि किस तरह की गड़बड़ी हुई है. आपको ये वैल्यू दिख सकती हैं:

2 – अनुरोध में एक अमान्य पैरामीटर वैल्यू है. उदाहरण के लिए, यह गड़बड़ी तब होती है, जब कोई ऐसा वीडियो आईडी दिया जाता है जिसमें 11 वर्ण नहीं होते या फिर वीडियो आईडी में विस्मयादिबोधक चिह्न या तारे के निशान जैसे अमान्य वर्ण होते हैं.
5 – अनुरोध की गई सामग्री को HTML5 प्लेयर में नहीं चलाया जा सकता या HTML5 प्लेयर से जुड़ी कोई दूसरी गड़बड़ी हुई है.
100 – अनुरोध किया गया वीडियो नहीं मिला. यह गड़बड़ी तब होती है, जब किसी वीडियो को हटा दिया गया हो (किसी वजह से) या उसे निजी के तौर पर मार्क किया गया हो.
101 – अनुरोध किए गए वीडियो का मालिक उसे एम्बेड किए गए प्लेयर में चलाने की अनुमति नहीं देता.
150 – यह गड़बड़ी 101 जैसी ही है. यह 101 की गड़बड़ी है!

onApiChange

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

यहां दिया गया निर्देश, मॉड्यूल के नामों का कलेक्शन हासिल करता है, जिसके लिए प्लेयर के विकल्प सेट किए जा सकते हैं:

player.getOptions();

फ़िलहाल, सिर्फ़ captions मॉड्यूल के लिए विकल्प सेट किए जा सकते हैं. यह प्लेयर में सबटाइटल को मैनेज करता है. onApiChange इवेंट मिलने पर, आपका ऐप्लिकेशन इस कमांड का इस्तेमाल करके यह तय कर सकता है कि captions मॉड्यूल के लिए कौनसे विकल्प सेट किए जा सकते हैं:

player.getOptions('captions');

प्लेयर को इस निर्देश से पोल करके, यह पुष्टि की जा सकती है कि आपको जिन विकल्पों को ऐक्सेस करना है वे वाकई ऐक्सेस किए जा सकते हैं. ये निर्देश, मॉड्यूल के विकल्पों को वापस लाते और अपडेट करते हैं:

Retrieving an option:
player.getOption(module, option);

Setting an option
player.setOption(module, option, value);

नीचे दी गई टेबल में उन विकल्पों की सूची दी गई है जो एपीआई पर काम करते हैं:

मॉड्यूल	विकल्प	कंपनी का ब्यौरा
captions	fontSize	यह विकल्प प्लेयर में दिखने वाले कैप्शन के फ़ॉन्ट के साइज़ में बदलाव करता है. मान्य वैल्यू `-1`, `0`, `1`, `2`, और `3` हैं. इसका डिफ़ॉल्ट साइज़ `0` है और सबसे छोटा साइज़ `-1` है. इस विकल्प को `-1` से नीचे के पूर्णांक पर सेट करने से, कैप्शन का सबसे छोटा साइज़ दिखेगा. वहीं, इस विकल्प को `3` से ज़्यादा पूर्णांक पर सेट करने पर, कैप्शन का सबसे बड़ा साइज़ दिखेगा.
captions	reload	यह विकल्प, चल रहे वीडियो के सबटाइटल के डेटा को फिर से लोड करता है. विकल्प की वैल्यू फिर से पाने पर, वैल्यू `null` होगी. सबटाइटल के डेटा को फिर से लोड करने के लिए, वैल्यू को `true` पर सेट करें.

onAutoplayBlocked

जब भी ब्राउज़र अपने-आप चलने वाली या स्क्रिप्ट किए गए वीडियो चलाने की सुविधाओं को ब्लॉक करता है, तब यह इवेंट ट्रिगर होता है. इन सुविधाओं को एक साथ "अपने-आप चलने की सुविधा" कहा जाता है. इसमें, इनमें से किसी भी प्लेयर एपीआई के साथ वीडियो चलाने की कोशिश शामिल है:

autoplay पैरामीटर
loadPlaylist फ़ंक्शन
loadVideoById फ़ंक्शन
loadVideoByUrl फ़ंक्शन
playVideo फ़ंक्शन

ज़्यादातर ब्राउज़र में ऐसी नीतियां होती हैं जो कुछ खास शर्तों के सही होने पर, डेस्कटॉप, मोबाइल, और अन्य प्लैटफ़ॉर्म पर वीडियो अपने-आप चलने की सुविधा को रोक सकती हैं. इस नीति के ट्रिगर होने पर, लोगों के इंटरैक्शन के बिना ही, अनम्यूट किया गया वीडियो चलाया जा सकता है. इसके अलावा, क्रॉस-ऑरिजिन iframe पर, वीडियो अपने-आप चलने की सुविधा के लिए, अनुमतियों की नीति के सेट न होने पर भी ऐसा हो सकता है.

पूरी जानकारी के लिए, ब्राउज़र से जुड़ी नीतियां (Apple Safari / Webkit, Google Chrome, Mozilla Firefox) और Mozilla की ऑटोप्ले गाइड देखें.

उदाहरण

`YT.Player` ऑब्जेक्ट बनाए जा रहे हैं

पहला उदाहरण: मौजूदा <iframe> के साथ एपीआई का इस्तेमाल करना

इस उदाहरण में, पेज पर मौजूद <iframe> एलिमेंट पहले से ही उस प्लेयर के बारे में बताता है जिसके साथ एपीआई का इस्तेमाल किया जाएगा. ध्यान दें कि या तो प्लेयर के src यूआरएल को enablejsapi पैरामीटर को 1 पर सेट करना चाहिए या <iframe> एलिमेंट के enablejsapi एट्रिब्यूट को true पर सेट करना चाहिए.

प्लेयर के तैयार होने पर onPlayerReady फ़ंक्शन, प्लेयर के चारों ओर मौजूद बॉर्डर का रंग बदलकर नारंगी कर देता है. इसके बाद, onPlayerStateChange फ़ंक्शन प्लेयर के चारों ओर मौजूद बॉर्डर का रंग बदलता है. ऐसा प्लेयर की मौजूदा स्थिति के हिसाब से किया जाता है. उदाहरण के लिए, प्लेयर के चलने के दौरान रंग हरा, रोके जाने पर लाल, बफ़र करते समय नीला, और अन्य रंगों का इस्तेमाल.

इस उदाहरण में इस कोड का इस्तेमाल किया गया है:
```
<iframe id="existing-iframe-example"
        width="640" height="360"
        src="https://www.youtube.com/embed/M7lc1UVf-VE?enablejsapi=1"
        frameborder="0"
        style="border: solid 4px #37474F"
></iframe>

<script type="text/javascript">
  var tag = document.createElement('script');
  tag.id = 'iframe-demo';
  tag.src = 'https://www.youtube.com/iframe_api';
  var firstScriptTag = document.getElementsByTagName('script')[0];
  firstScriptTag.parentNode.insertBefore(tag, firstScriptTag);

  var player;
  function onYouTubeIframeAPIReady() {
    player = new YT.Player('existing-iframe-example', {
        events: {
          'onReady': onPlayerReady,
          'onStateChange': onPlayerStateChange
        }
    });
  }
  function onPlayerReady(event) {
    document.getElementById('existing-iframe-example').style.borderColor = '#FF6D00';
  }
  function changeBorderColor(playerStatus) {
    var color;
    if (playerStatus == -1) {
      color = "#37474F"; // unstarted = gray
    } else if (playerStatus == 0) {
      color = "#FFFF00"; // ended = yellow
    } else if (playerStatus == 1) {
      color = "#33691E"; // playing = green
    } else if (playerStatus == 2) {
      color = "#DD2C00"; // paused = red
    } else if (playerStatus == 3) {
      color = "#AA00FF"; // buffering = purple
    } else if (playerStatus == 5) {
      color = "#FF6DOO"; // video cued = orange
    }
    if (color) {
      document.getElementById('existing-iframe-example').style.borderColor = color;
    }
  }
  function onPlayerStateChange(event) {
    changeBorderColor(event.data);
  }
</script>
```
दूसरा उदाहरण: तेज़ आवाज़ में वीडियो चलाना

इस उदाहरण में, 1280 पिक्सल x 720 पिक्सल का वीडियो प्लेयर बनाया गया है. इसके बाद, onReady इवेंट का लिसनर, setVolume फ़ंक्शन को कॉल करता है, ताकि वॉल्यूम को सबसे ज़्यादा पर सेट किया जा सके.
```
function onYouTubeIframeAPIReady() {
  var player;
  player = new YT.Player('player', {
    width: 1280,
    height: 720,
    videoId: 'M7lc1UVf-VE',
    events: {
      'onReady': onPlayerReady,
      'onStateChange': onPlayerStateChange,
      'onError': onPlayerError
    }
  });
}

function onPlayerReady(event) {
  event.target.setVolume(100);
  event.target.playVideo();
}
```
उदाहरण 3: यह उदाहरण वीडियो के लोड होने पर उसे अपने-आप चलाने और वीडियो प्लेयर के कंट्रोल छिपाने के लिए, प्लेयर पैरामीटर को सेट करता है. एपीआई की मदद से ब्रॉडकास्ट होने वाले कई इवेंट के लिए, यह इवेंट लिसनर भी जोड़ता है.
```
function onYouTubeIframeAPIReady() {
  var player;
  player = new YT.Player('player', {
    videoId: 'M7lc1UVf-VE',
    playerVars: { 'autoplay': 1, 'controls': 0 },
    events: {
      'onReady': onPlayerReady,
      'onStateChange': onPlayerStateChange,
      'onError': onPlayerError
    }
  });
}
```

360 डिग्री वाले वीडियो कंट्रोल करना

इस उदाहरण में इस कोड का इस्तेमाल किया गया है:

<style>
  .current-values {
    color: #666;
    font-size: 12px;
  }
</style>
<!-- The player is inserted in the following div element -->
<div id="spherical-video-player"></div>

<!-- Display spherical property values and enable user to update them. -->
<table style="border: 0; width: 640px;">
  <tr style="background: #fff;">
    <td>
      <label for="yaw-property">yaw: </label>
      <input type="text" id="yaw-property" style="width: 80px"><br>
      <div id="yaw-current-value" class="current-values"> </div>
    </td>
    <td>
      <label for="pitch-property">pitch: </label>
      <input type="text" id="pitch-property" style="width: 80px"><br>
      <div id="pitch-current-value" class="current-values"> </div>
    </td>
    <td>
      <label for="roll-property">roll: </label>
      <input type="text" id="roll-property" style="width: 80px"><br>
      <div id="roll-current-value" class="current-values"> </div>
    </td>
    <td>
      <label for="fov-property">fov: </label>
      <input type="text" id="fov-property" style="width: 80px"><br>
      <div id="fov-current-value" class="current-values"> </div>
    </td>
    <td style="vertical-align: bottom;">
      <button id="spherical-properties-button">Update properties</button>
    </td>
  </tr>
</table>

<script type="text/javascript">
  var tag = document.createElement('script');
  tag.id = 'iframe-demo';
  tag.src = 'https://www.youtube.com/iframe_api';
  var firstScriptTag = document.getElementsByTagName('script')[0];
  firstScriptTag.parentNode.insertBefore(tag, firstScriptTag);

  var PROPERTIES = ['yaw', 'pitch', 'roll', 'fov'];
  var updateButton = document.getElementById('spherical-properties-button');

  // Create the YouTube Player.
  var ytplayer;
  function onYouTubeIframeAPIReady() {
    ytplayer = new YT.Player('spherical-video-player', {
        height: '360',
        width: '640',
        videoId: 'FAtdv94yzp4',
    });
  }

  // Don't display current spherical settings because there aren't any.
  function hideCurrentSettings() {
    for (var p = 0; p < PROPERTIES.length; p++) {
      document.getElementById(PROPERTIES[p] + '-current-value').innerHTML = '';
    }
  }

  // Retrieve current spherical property values from the API and display them.
  function updateSetting() {
    if (!ytplayer || !ytplayer.getSphericalProperties) {
      hideCurrentSettings();
    } else {
      let newSettings = ytplayer.getSphericalProperties();
      if (Object.keys(newSettings).length === 0) {
        hideCurrentSettings();
      } else {
        for (var p = 0; p < PROPERTIES.length; p++) {
          if (newSettings.hasOwnProperty(PROPERTIES[p])) {
            currentValueNode = document.getElementById(PROPERTIES[p] +
                                                       '-current-value');
            currentValueNode.innerHTML = ('current: ' +
                newSettings[PROPERTIES[p]].toFixed(4));
          }
        }
      }
    }
    requestAnimationFrame(updateSetting);
  }
  updateSetting();

  // Call the API to update spherical property values.
  updateButton.onclick = function() {
    var sphericalProperties = {};
    for (var p = 0; p < PROPERTIES.length; p++) {
      var propertyInput = document.getElementById(PROPERTIES[p] + '-property');
      sphericalProperties[PROPERTIES[p]] = parseFloat(propertyInput.value);
    }
    ytplayer.setSphericalProperties(sphericalProperties);
  }
</script>

Android वेबव्यू Media Integrity API का इंटिग्रेशन

YouTube ने Android वेबव्यू Media Integrity API का दायरा बढ़ा दिया है. इससे, एम्बेड किए गए ऐप्लिकेशन के भरोसेमंद होने की पुष्टि करने के लिए, Android ऐप्लिकेशन में एम्बेड किए गए मीडिया प्लेयर के साथ-साथ, एम्बेड किए गए मीडिया प्लेयर भी चालू हो जाएंगे. इस बदलाव के बाद, एम्बेड करने वाले ऐप्लिकेशन, YouTube को अपने-आप प्रमाणित किया गया ऐप्लिकेशन आईडी भेज देते हैं. इस एपीआई के इस्तेमाल से इकट्ठा किया गया डेटा, ऐप्लिकेशन का मेटाडेटा (पैकेज का नाम, वर्शन नंबर, और साइनिंग सर्टिफ़िकेट) और डिवाइस की पुष्टि करने वाला टोकन होता है. इसे Google Play services से जनरेट किया जाता है.

डेटा का इस्तेमाल, ऐप्लिकेशन और डिवाइस इंटिग्रिटी की पुष्टि करने के लिए किया जाता है. इसे एन्क्रिप्ट (सुरक्षित) किया जाता है और इसे तीसरे पक्षों के साथ शेयर नहीं किया जाता. साथ ही, एक तय समय के बाद मिटा दिया जाता है. ऐप्लिकेशन डेवलपर, वेबव्यू Media Integrity API में अपने ऐप्लिकेशन की पहचान को कॉन्फ़िगर कर सकते हैं. कॉन्फ़िगरेशन में, ऑप्ट-आउट करने का विकल्प भी शामिल है.

पुनरीक्षण इतिहास

June 24, 2024

The documentation has been updated to note that YouTube has extended the Android WebView Media Integrity API to enable embedded media players, including YouTube player embeds in Android applications, to verify the embedding app's authenticity. With this change, embedding apps automatically send an attested app ID to YouTube.

November 20, 2023

The new onAutoplayBlocked event API is now available. This event notifies your application if the browser blocks autoplay or scripted playback. Verification of autoplay success or failure is an established paradigm for HTMLMediaElements, and the onAutoplayBlocked event now provides similar functionality for the IFrame Player API.

April 27, 2021

The Getting Started and Loading a Video Player sections have been updated to include examples of using a playerVars object to customize the player.

October 13, 2020

Note: This is a deprecation announcement for the embedded player functionality that lets you configure the player to load search results. This announcement affects the IFrame Player API's queueing functions for lists, cuePlaylist and loadPlaylist.

This change will become effective on or after 15 November 2020. After that time, calls to the cuePlaylist or loadPlaylist functions that set the listType property to search will generate a 4xx response code, such as 404 (Not Found) or 410 (Gone). This change also affects the list property for those functions as that property no longer supports the ability to specify a search query.

As an alternative, you can use the YouTube Data API's search.list method to retrieve search results and then load selected videos in the player.

October 24, 2019

The documentation has been updated to reflect the fact that the API no longer supports functions for setting or retrieving playback quality. As explained in this YouTube Help Center article, to give you the best viewing experience, YouTube adjusts the quality of your video stream based on your viewing conditions.

The changes explained below have been in effect for more than one year. This update merely aligns the documentation with current functionality:

The getPlaybackQuality, setPlaybackQuality, and getAvailableQualityLevels functions are no longer supported. In particular, calls to setPlaybackQuality will be no-op functions, meaning they will not actually have any impact on the viewer's playback experience.
The queueing functions for videos and playlists -- cueVideoById, loadVideoById, etc. -- no longer support the suggestedQuality argument. Similarly, if you call those functions using object syntax, the suggestedQuality field is no longer supported. If suggestedQuality is specified, it will be ignored when the request is handled. It will not generate any warnings or errors.
The onPlaybackQualityChange event is still supported and might signal a change in the viewer's playback environment. See the Help Center article referenced above for more information about factors that affect playback conditions or that might cause the event to fire.

May 16, 2018

The API now supports features that allow users (or embedders) to control the viewing perspective for 360° videos:

The getSphericalProperties function retrieves the current orientation for the video playback. The orientation includes the following data:
- yaw - represents the horizontal angle of the view in degrees, which reflects the extent to which the user turns the view to face further left or right
- pitch - represents the vertical angle of the view in degrees, which reflects the extent to which the user adjusts the view to look up or down
- roll - represents the rotational angle (clockwise or counterclockwise) of the view in degrees.
- fov - represents the field-of-view of the view in degrees, which reflects the extent to which the user zooms in or out on the video.
The setSphericalProperties function modifies the view to match the submitted property values. In addition to the orientation values described above, this function supports a Boolean field that indicates whether the IFrame embed should respond to DeviceOrientationEvents on supported mobile devices.

This example demonstrates and lets you test these new features.

June 19, 2017

This update contains the following changes:

Documentation for the YouTube Flash Player API and YouTube JavaScript Player API has been removed and redirected to this document. The deprecation announcement for the Flash and JavaScript players was made on January 27, 2015. If you haven't done so already, please migrate your applications to use IFrame embeds and the IFrame Player API.

August 11, 2016

This update contains the following changes:

The newly published YouTube API Services Terms of Service ("the Updated Terms"), discussed in detail on the YouTube Engineering and Developers Blog, provides a rich set of updates to the current Terms of Service. In addition to the Updated Terms, which will go into effect as of February 10, 2017, this update includes several supporting documents to help explain the policies that developers must follow.

The full set of new documents is described in the revision history for the Updated Terms. In addition, future changes to the Updated Terms or to those supporting documents will also be explained in that revision history. You can subscribe to an RSS feed listing changes in that revision history from a link in that document.

June 29, 2016

This update contains the following changes:

The documentation has been corrected to note that the onApiChange method provides access to the captions module and not the cc module.

June 24, 2016

The Examples section has been updated to include an example that demonstrates how to use the API with an existing <iframe> element.

January 6, 2016

The clearVideo function has been deprecated and removed from the documentation. The function no longer has any effect in the YouTube player.

December 18, 2015

European Union (EU) laws require that certain disclosures must be given to and consents obtained from end users in the EU. Therefore, for end users in the European Union, you must comply with the EU User Consent Policy. We have added a notice of this requirement in our YouTube API Terms of Service.

April 28, 2014

This update contains the following changes:

The new removeEventListener function lets you remove a listener for a specified event.

March 25, 2014

This update contains the following changes:

The Requirements section has been updated to note that embedded players must have a viewport that is at least 200px by 200px. If a player displays controls, it must be large enough to fully display the controls without shrinking the viewport below the minimum size. We recommend 16:9 players be at least 480 pixels wide and 270 pixels tall.

July 23, 2013

This update contains the following changes:

The Overview now includes a video of a 2011 Google I/O presentation that discusses the iframe player.

October 31, 2012

This update contains the following changes:

The Queueing functions section has been updated to explain that you can use either argument syntax or object syntax to call all of those functions. Note that the API may support additional functionality in object syntax that the argument syntax does not support.

In addition, the descriptions and examples for each of the video queueing functions have been updated to reflect the newly added support for object syntax. (The API's playlist queueing functions already supported object syntax.)
When called using object syntax, each of the video queueing functions supports an endSeconds property, which accepts a float/integer and specifies the time when the video should stop playing when playVideo() is called.
The getVideoStartBytes method has been deprecated. The method now always returns a value of 0.

August 22, 2012

This update contains the following changes:

The example in the Loading a video player section that demonstrates how to manually create the <iframe> tag has been updated to include a closing </iframe> tag since the onYouTubeIframeAPIReady function is only called if the closing </iframe> element is present.

August 6, 2012

This update contains the following changes:

The Operations section has been expanded to list all of the supported API functions rather than linking to the JavaScript Player API Reference for that list.
The API supports several new functions and one new event that can be used to control the video playback speed:
- Functions
  - getAvailablePlaybackRates – Retrieve the supported playback rates for the cued or playing video. Note that variable playback rates are currently only supported in the HTML5 player.
  - getPlaybackRate – Retrieve the playback rate for the cued or playing video.
  - setPlaybackRate – Set the playback rate for the cued or playing video.
- Events
  - onPlaybackRateChange – This event fires when the video's playback rate changes.

July 19, 2012

This update contains the following changes:

The new getVideoLoadedFraction method replaces the now-deprecated getVideoBytesLoaded and getVideoBytesTotal methods. The new method returns the percentage of the video that the player shows as buffered.
The onError event may now return an error code of 5, which indicates that the requested content cannot be played in an HTML5 player or another error related to the HTML5 player has occurred.
The Requirements section has been updated to indicate that any web page using the IFrame API must also implement the onYouTubeIframeAPIReady function. Previously, the section indicated that the required function was named onYouTubePlayerAPIReady. Code samples throughout the document have also been updated to use the new name.

Note: To ensure that this change does not break existing implementations, both names will work. If, for some reason, your page has an onYouTubeIframeAPIReady function and an onYouTubePlayerAPIReady function, both functions will be called, and the onYouTubeIframeAPIReady function will be called first.
The code sample in the Getting started section has been updated to reflect that the URL for the IFrame Player API code has changed to http://www.youtube.com/iframe_api. To ensure that this change does not affect existing implementations, the old URL (http://www.youtube.com/player_api) will continue to work.

July 16, 2012

This update contains the following changes:

The Operations section now explains that the API supports the setSize() and destroy() methods. The setSize() method sets the size in pixels of the <iframe> that contains the player and the destroy() method removes the <iframe>.

June 6, 2012

This update contains the following changes:

We have removed the experimental status from the IFrame Player API.
The Loading a video player section has been updated to point out that when inserting the <iframe> element that will contain the YouTube player, the IFrame API replaces the element specified in the constructor for the YouTube player. This documentation change does not reflect a change in the API and is intended solely to clarify existing behavior.

In addition, that section now notes that the insertion of the <iframe> element could affect the layout of your page if the element being replaced has a different display style than the inserted <iframe> element. By default, an <iframe> displays as an inline-block element.

March 30, 2012

This update contains the following changes:

The Operations section has been updated to explain that the IFrame API supports a new method, getIframe(), which returns the DOM node for the IFrame embed.

March 26, 2012

This update contains the following changes:

The Requirements section has been updated to note the minimum player size.

YouTube Player API Reference for iframe Embeds

ज़रूरी शर्तें

प्रारंभ करना

वीडियो प्लेयर लोड करना

ऑपरेशंस

फ़ंक्शन

फ़ंक्शन की सूची बनाने की सुविधा

वीडियो की सूची बनाने की सुविधाएं

सूचियों के लिए फ़ंक्शन की सूची बनाना

प्लेबैक कंट्रोल और प्लेयर की सेटिंग

कोई वीडियो चलाना

360 डिग्री वाले वीडियो चलाने की सुविधा को कंट्रोल करना

प्लेलिस्ट में वीडियो चलाना

प्लेयर का वॉल्यूम बदलना

प्लेयर का साइज़ सेट करना

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

प्लेलिस्ट के लिए प्लेबैक व्यवहार सेट करना

वीडियो चलाने की स्थिति

वीडियो की जानकारी वापस हासिल की जा रही है

प्लेलिस्ट की जानकारी वापस हासिल की जा रही है

इवेंट लिसनर को जोड़ना या हटाना

डीओएम नोड को ऐक्सेस और उनमें बदलाव करना

इवेंट

उदाहरण

YT.Player ऑब्जेक्ट बनाए जा रहे हैं

360 डिग्री वाले वीडियो कंट्रोल करना

Android वेबव्यू Media Integrity API का इंटिग्रेशन

पुनरीक्षण इतिहास

June 24, 2024

November 20, 2023

April 27, 2021

October 13, 2020

October 24, 2019

May 16, 2018

June 19, 2017

August 11, 2016

June 29, 2016

June 24, 2016

January 6, 2016

December 18, 2015

April 28, 2014

March 25, 2014

July 23, 2013

October 31, 2012

August 22, 2012

August 6, 2012

July 19, 2012

July 16, 2012

June 6, 2012

March 30, 2012

March 26, 2012

`YT.Player` ऑब्जेक्ट बनाए जा रहे हैं