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>

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

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

    विकल्प के तौर पर, <iframe> एलिमेंट को सीधे पेज पर भी डाला जा सकता है. वीडियो प्लेयर लोड करना सेक्शन में, ऐसा करने का तरीका बताया गया है.

  2. इस सेक्शन में दिया गया कोड, IFrame Player API का JavaScript कोड लोड करता है. इस उदाहरण में, एपीआई कोड को डाउनलोड करने के लिए, DOM बदलाव का इस्तेमाल किया गया है. इससे यह पक्का किया जाता है कि कोड को एसिंक्रोनस तरीके से फ़ेच किया गया है या नहीं. (<script> टैग की async एट्रिब्यूट, जो एसिंक्रोनस डाउनलोड को भी चालू करती है. यह सभी मॉडर्न ब्राउज़र में काम नहीं करती, जैसा कि इस स्टैक ओवरफ़्लो जवाब में बताया गया है.

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

  4. onPlayerReady फ़ंक्शन, onReady इवेंट के ट्रिगर होने पर काम करेगा. इस उदाहरण में, फ़ंक्शन बताता है कि वीडियो प्लेयर तैयार होने के बाद, उसे चलना शुरू करना चाहिए.

  5. प्लेयर की स्थिति बदलने पर एपीआई, 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
    }
  });
}

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

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

    IFrame API, बताए गए एलिमेंट को प्लेयर वाले <iframe> एलिमेंट से बदल देगा. इससे, आपके पेज के लेआउट पर असर पड़ सकता है. ऐसा तब होता है, जब बदले जा रहे एलिमेंट की डिसप्ले स्टाइल, शामिल किए गए <iframe> एलिमेंट से अलग होती है. डिफ़ॉल्ट रूप से, <iframe>, inline-block एलिमेंट के तौर पर दिखता है.

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

जैसा कि शुरू करना सेक्शन में बताया गया है कि अपने पेज पर कोई खाली <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

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

  • ज़रूरी 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

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

  • ज़रूरी 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 पैरामीटर से पता चलता है कि खिलाड़ी को कितने समय तक आगे बढ़ना है.

    प्लेयर उस समय से पहले सबसे नज़दीकी मुख्य-फ़्रेम पर चलेगा, जब तक कि प्लेयर ने वीडियो का वह हिस्सा पहले ही डाउनलोड न कर लिया हो जिसे उपयोगकर्ता ढूंढ रहा है.

  • अगर seconds पैरामीटर, फ़िलहाल बफ़र किए गए वीडियो डेटा के बाहर का समय तय करता है, तो allowSeekAhead पैरामीटर से यह तय होता है कि प्लेयर, सर्वर को कोई नया अनुरोध करेगा या नहीं.

    हमारा सुझाव है कि जब उपयोगकर्ता माउस को वीडियो प्रोग्रेस बार पर खींचकर ले जाए, तब आप इस पैरामीटर को 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° होती है. जब व्यू घड़ी की दिशा में घूमता है, तो यह वैल्यू बढ़ जाती है और व्यू के घड़ी की उलटी दिशा में घूमने पर घट जाती है.

ध्यान दें कि एम्बेड किया गया प्लेयर, व्यू के रोल में बदलाव करने के लिए यूज़र इंटरफ़ेस पेश नहीं करता. रोल में बदलाव करने के लिए, इनमें से किसी भी तरीके का इस्तेमाल किया जा सकता है:
  1. व्यू के लिए रोल देने के लिए मोबाइल ब्राउज़र में ओरिएंटेशन सेंसर का इस्तेमाल करें. अगर ओरिएंटेशन सेंसर चालू है, तो getSphericalProperties फ़ंक्शन, हमेशा roll प्रॉपर्टी की वैल्यू के तौर पर 0 दिखाता है.
  2. अगर ओरिएंटेशन सेंसर बंद है, तो इस एपीआई का इस्तेमाल करके, रोल को ज़ीरो वैल्यू पर सेट करें.
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 एक स्ट्रिंग है, जो उस फ़ंक्शन की पहचान करती है जो बताए गए इवेंट के ट्रिगर होने पर अब काम नहीं करेगा.

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

player.getIframe():Object
यह तरीका एम्बेड किए गए <iframe> के लिए DOM नोड दिखाता है.
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
जब भी ब्राउज़र, अपने-आप चलने वाले या स्क्रिप्ट किए गए वीडियो चलाने की सुविधाओं को ब्लॉक करता है, तो यह इवेंट चालू हो जाता है. इन सुविधाओं को "ऑटोप्ले" भी कहा जाता है. इसमें, इनमें से किसी भी प्लेयर एपीआई से वीडियो चलाने की कोशिश की गई है:

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

पूरी जानकारी के लिए, ब्राउज़र के हिसाब से बनी नीतियां (Apple Safari / Webkit, Google Chrome, Mozilla Firefox) और Mozilla की अपने-आप चलने वाली गाइड देखें.

उदाहरण

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

  • उदाहरण 1: मौजूदा <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>

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

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:

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

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.