YouTube Player API Reference for iframe Embeds

IFrame प्लेयर एपीआई आपको अपनी वेबसाइट पर YouTube वीडियो प्लेयर एम्बेड करने देता है और JavaScript का इस्तेमाल करके प्लेयर को कंट्रोल करने देता है.

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

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

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

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

एम्बेड किए गए प्लेयर में कम से कम 200 पिक्सल गुणा 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, वीडियो प्लेयर को दिखाएगा. प्लेयर ऑब्जेक्ट के लिए कंस्ट्रक्टर, जो वीडियो प्लेयर लोड हो रहा है सेक्शन में बताया गया है, यह अपने id से <div> टैग की पहचान करता है, ताकि यह पक्का किया जा सके कि एपीआई <iframe> को सही जगह पर रखता है. खास तौर पर, IFrame API <div> टैग को <iframe> टैग से बदल देगा.

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

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

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

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

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

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

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

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

cuePlaylist
  • आर्ग्युमेंट सिंटैक्स

    player.cuePlaylist(playlist:String|Array,
                       index:Number,
                       startSeconds:Number):Void
    बताई गई प्लेलिस्ट को सूची में जोड़ देता है. प्लेलिस्ट खत्म होने के बाद, प्लेयर में video cued इवेंट (5) का ब्रॉडकास्ट शुरू होगा.
    • ज़रूरी playlist पैरामीटर, YouTube वीडियो आईडी की श्रेणी तय करता है. YouTube डेटा एपीआई में, 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 डेटा एपीआई में, 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 डेटा एपीआई में, 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 डेटा एपीआई में, 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 फ़ंक्शन 0 को roll प्रॉपर्टी की वैल्यू के तौर पर हमेशा दिखाता है.
  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 एक स्ट्रिंग है जो उस फ़ंक्शन की पहचान करती है जो अब बताए गए इवेंट के सक्रिय होने पर काम नहीं करेगा.

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

player.getIframe():Object
इस तरीके से, एम्बेड किए गए <iframe> के लिए डीओएम नोड मिलता है.
player.destroy():Void
खिलाड़ी वाले <iframe> को हटाता है.

इवेंट

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

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

  • इवेंट की target उस इवेंट से जुड़े वीडियो प्लेयर की पहचान करती है.
  • इवेंट की data, इवेंट के लिए काम की वैल्यू तय करती है. ध्यान दें कि onReady इवेंट, 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 फ़ॉन्ट का साइज़ इस विकल्प से प्लेयर में दिखने वाले कैप्शन के फ़ॉन्ट का साइज़ अडजस्ट हो जाता है.

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

मोबाइल पर विचार

स्क्रिप्ट अपने-आप चलने और स्क्रिप्ट चलाने की सुविधा

कुछ मोबाइल ब्राउज़र (जैसे, Chrome और Safari) में HTML5 <video> एलिमेंट सिर्फ़ तब ही वीडियो चलाने की अनुमति देता है, जब इसे उपयोगकर्ता इंटरैक्शन (जैसे कि प्लेयर पर टैप करना) से शुरू किया जाता है. यहां Apple के दस्तावेज़ से एक उद्धरण दिया गया है:

"चेतावनी: उपयोगकर्ता के खर्च पर मोबाइल नेटवर्क पर अनचाहे डाउनलोड रोकने के लिए, iOS पर Safari में एम्बेड किया गया मीडिया अपने-आप नहीं चल सकता — उपयोगकर्ता हमेशा वीडियो चलाना शुरू करता है."

इस पाबंदी की वजह से, autoplay, playVideo(), loadVideoById() जैसे फ़ंक्शन और पैरामीटर सभी मोबाइल एनवायरमेंट में काम नहीं करेंगे.

उदाहरण

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();
    }
    
  • तीसरा उदाहरण: यह उदाहरण प्लेयर के पैरामीटर को, वीडियो लोड होने पर वीडियो चलाने और वीडियो प्लेयर के कंट्रोल को छिपाने के लिए सेट करता है. यह एपीआई के ब्रॉडकास्ट किए जाने वाले कई इवेंट के लिए, सुनने वालों को भी जोड़ता है.

    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>

बदलावों का इतिहास

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.