YouTube Embedded Players and Player Parameters

खास जानकारी

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

IFrame यूआरएल में पैरामीटर जोड़कर, अपने ऐप्लिकेशन में वीडियो चलाने के अनुभव को पसंद के मुताबिक बनाया जा सकता है. उदाहरण के लिए, autoplay पैरामीटर का इस्तेमाल करके, वीडियो अपने-आप चल सकता है. इसके अलावा, ऐसा भी हो सकता है कि loop पैरामीटर का इस्तेमाल करके, वीडियो बार-बार चले. enablejsapi पैरामीटर का इस्तेमाल करके, प्लेयर को IFrame Player API के ज़रिए कंट्रोल किया जा सकता है.

फ़िलहाल, यह पेज YouTube के एम्बेड किए गए किसी भी प्लेयर में काम करने वाले सभी पैरामीटर की जानकारी देता है. हर पैरामीटर की परिभाषा, उन प्लेयर की पहचान करती है जो उससे जुड़े पैरामीटर के साथ काम करते हैं.

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

YouTube प्लेयर जोड़ना

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

<iframe> टैग इस्तेमाल करके, किसी प्लेयर को जोड़ें

अपने ऐप्लिकेशन में <iframe> टैग के बारे में बताएं. इस src यूआरएल में, कॉन्टेंट लोड करने वाले प्लेयर के साथ-साथ ऐसे दूसरे पैरामीटर की जानकारी दी जाती है जिन्हें आपको सेट करना है. <iframe> टैग के height और width पैरामीटर से प्लेयर के डाइमेंशन की जानकारी मिलती है.

अगर आपने खुद <iframe> एलिमेंट बनाया है, तो इसे बनाने के लिए IFrame Player API का इस्तेमाल करने के बजाय, सीधे यूआरएल के आखिर में प्लेयर के पैरामीटर जोड़ें. यूआरएल का फ़ॉर्मैट ऐसा होता है:

https://www.youtube.com/embed/VIDEO_ID

नीचे दिया गया <iframe> टैग, 640x360 पिक्सल प्लेयर को लोड करेगा, जो YouTube वीडियो M7lc1UVf-VE को चलाएगा. जब यूआरएल, autoplay पैरामीटर को 1 पर सेट करता है, तो प्लेयर के लोड होने पर वीडियो अपने-आप चलने लगता है.

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

IFrame Player API का इस्तेमाल करके कोई प्लेयर जोड़ें

प्लेयर एपीआई का JavaScript कोड लोड होने के बाद, अपने वेब पेज या ऐप्लिकेशन में वीडियो प्लेयर जोड़ने के लिए IFrame Player API के निर्देशों का पालन करें. वीडियो प्लेयर के लिए कंस्ट्रक्टर में दूसरा पैरामीटर, वह ऑब्जेक्ट है जो प्लेयर के विकल्पों की जानकारी देता है. उस ऑब्जेक्ट में, playerVars प्रॉपर्टी, प्लेयर पैरामीटर की पहचान करती है.

नीचे दिया गया एचटीएमएल और JavaScript कोड, एक आसान उदाहरण दिखाता है. इस उदाहरण में, एक YouTube प्लेयर को ऐसे पेज एलिमेंट में डाला गया है जिसमें id की वैल्यू ytplayer है. यहां बताया गया onYouTubePlayerAPIReady() फ़ंक्शन, अपने-आप तब कॉल किया जाता है, जब Iframe Player API कोड लोड किया जाता है. यह कोड किसी भी प्लेयर पैरामीटर को तय नहीं करता है और न ही अन्य इवेंट हैंडलर को तय करता है.

<div id="ytplayer"></div>

<script>
  // Load the IFrame Player API code asynchronously.
  var tag = document.createElement('script');
  tag.src = "https://www.youtube.com/player_api";
  var firstScriptTag = document.getElementsByTagName('script')[0];
  firstScriptTag.parentNode.insertBefore(tag, firstScriptTag);

  // Replace the 'ytplayer' element with an <iframe> and
  // YouTube player after the API code downloads.
  var player;
  function onYouTubePlayerAPIReady() {
    player = new YT.Player('ytplayer', {
      height: '360',
      width: '640',
      videoId: 'M7lc1UVf-VE'
    });
  }
</script>

चलाने के लिए कॉन्टेंट चुनें

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

इन विकल्पों की जानकारी नीचे दी गई सूची में दी गई है:

  • वीडियो लोड हो रहा है

    Iframe एम्बेड करने के लिए, Iframe के src यूआरएल में उस वीडियो का YouTube वीडियो आईडी दिया गया है जिसे आपको लोड करना है.

    https://www.youtube.com/embed/VIDEO_ID

    YouTube Data API (v3) का इस्तेमाल करने पर, खोज के नतीजों, प्लेलिस्ट आइटम रिसॉर्स, वीडियो संसाधनों या अन्य रिसॉर्स से वीडियो आईडी वापस लेकर, प्रोग्राम के हिसाब से इन यूआरएल को बनाया जा सकता है. वीडियो का आईडी पाने के बाद, प्लेयर में यूआरएल बनाने के लिए ऊपर दिए गए यूआरएल के VIDEO_ID टेक्स्ट को उस वैल्यू से बदलें.

  • प्लेलिस्ट लोड करना

    listType प्लेयर पैरामीटर को playlist पर सेट करें. इसके अलावा, list प्लेयर पैरामीटर को उस YouTube प्लेलिस्ट आईडी पर सेट करें जिसे लोड करना है.

    https://www.youtube.com/embed?listType=playlist&list=PLAYLIST_ID

    ध्यान दें कि आपको प्लेलिस्ट आईडी के आगे PL अक्षर जोड़ने होंगे, जैसा कि नीचे दिए गए उदाहरण में दिखाया गया है:

    https://www.youtube.com/embed?listType=playlist&list=PLC77007E23FF423C6

    अगर YouTube डेटा एपीआई (v3) का इस्तेमाल किया जा रहा है, तो प्रोग्राम के हिसाब से इन यूआरएल को बनाया जा सकता है. इसके लिए, खोज के नतीजों, चैनल संसाधनों या गतिविधि संसाधनों से प्लेलिस्ट आईडी वापस पाएं. प्लेलिस्ट आईडी पाने के बाद, ऊपर दिए गए यूआरएल के PLAYLIST_ID टेक्स्ट की जगह वह वैल्यू डालें.

  • उपयोगकर्ता के अपलोड किए गए वीडियो लोड हो रहे हैं

    listType प्लेयर पैरामीटर को user_uploads पर सेट करें. इसके अलावा, list प्लेयर के YouTube पैरामीटर को उस YouTube उपयोगकर्ता नाम पर सेट करें जिसके अपलोड किए गए वीडियो आपको लोड करने हैं.

    https://www.youtube.com/embed?listType=user_uploads&list=USERNAME

काम करने वाले पैरामीटर

नीचे दिए गए सभी पैरामीटर वैकल्पिक हैं.

पैरामीटर

autoplay

इस पैरामीटर से पता चलता है कि प्लेयर के लोड होने पर, शुरुआती वीडियो अपने-आप चलने लगेगा. 0 या 1 का इस्तेमाल किया जा सकता है. डिफ़ॉल्ट वैल्यू 0 है.

अगर आपने वीडियो अपने-आप चलने की सुविधा चालू की है, तो वीडियो प्लेयर में उपयोगकर्ता के साथ किसी तरह का इंटरैक्शन नहीं होने पर भी, वीडियो चलाने की सुविधा मिलती है. इसलिए, पेज के लोड होने पर, वीडियो का डेटा इकट्ठा और शेयर किया जाएगा.

cc_lang_pref

यह पैरामीटर उस डिफ़ॉल्ट भाषा के बारे में बताता है जिसका इस्तेमाल प्लेयर, कैप्शन दिखाने के लिए करेगा. पैरामीटर की वैल्यू, ISO 639-1 दो अक्षर वाले भाषा कोड पर सेट करें.

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

cc_load_policy

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

color

इस पैरामीटर से उस रंग का पता चलता है जिसका इस्तेमाल प्लेयर के वीडियो प्रगति बार में किया जाएगा, ताकि हाइलाइट किए गए वीडियो की संख्या का पता चल सके. मान्य पैरामीटर वैल्यू red और white हैं. डिफ़ॉल्ट रूप से, प्लेयर वीडियो के प्रोग्रेस बार में लाल रंग का इस्तेमाल करता है. रंगों के विकल्पों के बारे में ज़्यादा जानकारी के लिए YouTube API ब्लॉग देखें.

controls

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

  • controls=0 – प्लेयर में दिखने वाले प्लेयर के कंट्रोल नहीं दिखते.
  • controls=1 (डिफ़ॉल्ट) – प्लेयर के कंट्रोल, प्लेयर में दिखते हैं.

disablekb

पैरामीटर की वैल्यू 1 पर सेट करने पर, हो सकता है कि प्लेयर कीबोर्ड कंट्रोल का जवाब न दे. डिफ़ॉल्ट वैल्यू 0 है. इसका मतलब है कि कीबोर्ड कंट्रोल की सुविधा चालू है. फ़िलहाल, इन कीबोर्ड कंट्रोल का इस्तेमाल किया जा सकता है:

  • स्पेसबार या [k]: चलाएं / रोकें
  • बाईं ओर तीर का निशान: मौजूदा वीडियो में पांच सेकंड पीछे जाएं
  • राइट ऐरो: मौजूदा वीडियो में पांच सेकंड आगे जाएं
  • ऐरो ऐरो: आवाज़ तेज़ करें
  • ऐरो डाउन: आवाज़ कम करें
  • [f]: फ़ुल-स्क्रीन डिसप्ले पर टॉगल करें
  • [j]: मौजूदा वीडियो में 10 सेकंड पीछे जाएं
  • [l]: मौजूदा वीडियो में 10 सेकंड आगे जाएं
  • [m]: वीडियो को म्यूट या अनम्यूट करें
  • [0-9]: वीडियो के किसी पॉइंट पर जाएं. 0 वीडियो की शुरुआत में जाता है, 1 वीडियो में पॉइंट 10% तक जाता है, 2 वीडियो पर 20% पॉइंट तक जाता है.

enablejsapi

पैरामीटर की वैल्यू 1 पर सेट करने पर, प्लेयर को IFrame प्लेयर एपीआई कॉल से कंट्रोल किया जा सकता है. डिफ़ॉल्ट वैल्यू 0 है. इसका मतलब है कि प्लेयर को उस एपीआई से कंट्रोल नहीं किया जा सकता.

IFrame API और इसके इस्तेमाल के तरीके के बारे में ज़्यादा जानने के लिए, IFrame API दस्तावेज़ देखें.

end

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

ध्यान दें कि वीडियो की शुरुआत से ही, समय को मापा जाता है. start प्लेयर पैरामीटर या startSeconds पैरामीटर की वैल्यू से समय को मेज़र नहीं किया जाता. इसका इस्तेमाल, YouTube Player API फ़ंक्शन में, वीडियो लोड करने या उसे सूची में जोड़ने के लिए किया जाता है.

fs

इस पैरामीटर को 0 पर सेट करने पर, प्लेयर में फ़ुलस्क्रीन बटन नहीं दिखता. डिफ़ॉल्ट वैल्यू 1 होती है, जिसकी वजह से फ़ुलस्क्रीन बटन दिखता है.

hl

प्लेयर की इंटरफ़ेस भाषा सेट करता है. पैरामीटर वैल्यू, ISO 639-1 दो अक्षर वाला भाषा कोड या पूरी तरह से बताई गई स्थान-भाषा है. उदाहरण के लिए, fr और fr-ca, दोनों मान्य वैल्यू हैं. भाषा चुनने के अन्य कोड, जैसे कि आईईटीएफ़ भाषा के टैग (बीसीपी 47) को भी सही तरीके से हैंडल किया जा सकता है.

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

iv_load_policy

पैरामीटर की वैल्यू 1 पर सेट करने से, वीडियो एनोटेशन डिफ़ॉल्ट रूप से दिखते हैं. वहीं, 3 पर सेट होने पर डिफ़ॉल्ट रूप से वीडियो एनोटेशन नहीं दिखते. डिफ़ॉल्ट वैल्यू 1 है.

list

listType पैरामीटर के साथ-साथ list पैरामीटर, उस कॉन्टेंट की पहचान करता है जो प्लेयर में लोड होगा.

  • अगर listType पैरामीटर की वैल्यू user_uploads है, तो list पैरामीटर की वैल्यू उस YouTube चैनल की पहचान करती है जिसके अपलोड किए गए वीडियो लोड होंगे.
  • अगर listType पैरामीटर की वैल्यू playlist है, तो list पैरामीटर की वैल्यू में YouTube प्लेलिस्ट आईडी की जानकारी होती है. पैरामीटर वैल्यू में, आपको प्लेलिस्ट आईडी के आगे PL अक्षर जोड़ने होंगे. जैसा कि नीचे दिए गए उदाहरण में दिखाया गया है.
    https://www.youtube.com/embed?
        listType=playlist
        &list=PLC77007E23FF423C6
  • अगर listType पैरामीटर की वैल्यू search है, तो list पैरामीटर की वैल्यू खोज क्वेरी के बारे में बताती है. ध्यान दें: यह सुविधा अब काम नहीं करती है. यह 15 नवंबर, 2020 से बंद हो जाएगी.
ध्यान दें: list और listType पैरामीटर के लिए वैल्यू तय करने पर, IFrame एम्बेड यूआरएल को वीडियो आईडी डालने की ज़रूरत नहीं है.

listType

list पैरामीटर के साथ-साथ listType पैरामीटर, उस कॉन्टेंट की पहचान करता है जो प्लेयर में लोड होगा. मान्य पैरामीटर वैल्यू playlist और user_uploads हैं.

अगर आप list और listType पैरामीटर के लिए वैल्यू तय करते हैं, तो IFrame एम्बेड यूआरएल को वीडियो आईडी बताने की ज़रूरत नहीं है.

ध्यान दें: तीसरे पैरामीटर की वैल्यू search बंद कर दी गई है और यह 15 नवंबर, 2020 से काम नहीं करेगी.

loop

किसी वीडियो प्लेयर के मामले में, 1 की सेटिंग की वजह से, प्लेयर पहली बार वीडियो को बार-बार चला सकता है. किसी प्लेलिस्ट प्लेयर या कस्टम प्लेयर के मामले में, प्लेयर पूरी प्लेलिस्ट चलाता है और फिर पहले वीडियो पर फिर से शुरू होता है.

वैल्यू, 0 और 1 के साथ काम करती है. डिफ़ॉल्ट वैल्यू 0 होती है.

ध्यान दें: इस पैरामीटर में Iframe एम्बेड करने की सुविधा सीमित है. किसी एक वीडियो को लूप में चलाने के लिए, loop पैरामीटर की वैल्यू को 1 पर सेट करें और playlist पैरामीटर की वैल्यू को, प्लेयर एपीआई के यूआरएल में पहले से तय वीडियो आईडी पर सेट करें:
https://www.youtube.com/embed/VIDEO_ID?playlist=VIDEO_ID&loop=1

modestbranding

ध्यान दें: यह पैरामीटर अब काम नहीं करता. ज़्यादा जानकारी के लिए, डेटा रोकने का एलान देखें.

origin

यह पैरामीटर IFrame API के लिए एक अतिरिक्त सुरक्षा माप देता है और सिर्फ़ IFrame एम्बेड करने के लिए काम करता है. अगर I iFrame API का इस्तेमाल किया जा रहा है, तो इसका मतलब है कि enablejsapi पैरामीटर की वैल्यू को 1 पर सेट किया जा रहा है. इसलिए, आपको अपने डोमेन को हमेशा origin पैरामीटर की वैल्यू के तौर पर बताना चाहिए.

playlist

यह पैरामीटर, वीडियो आईडी की कॉमा-सेपरेटेड लिस्ट बताता है. अगर आप कोई मान डालते हैं, तो चलने वाला पहला वीडियो यूआरएल पाथ में बताया गया VIDEO_ID होगा और उसके बाद playlist पैरामीटर में बताए गए वीडियो चलेंगे.

playsinline

यह पैरामीटर कंट्रोल करता है कि वीडियो, iOS पर इनलाइन चलाएं या फ़ुल स्क्रीन पर. मान्य मान हैं:

  • 0: फ़ुलस्क्रीन मोड में वीडियो चलाने के नतीजे. फ़िलहाल, यह डिफ़ॉल्ट वैल्यू है, हालांकि डिफ़ॉल्ट में बदलाव हो सकता है.
  • 1: मोबाइल ब्राउज़र और इनलाइन प्रॉपर्टी, जिन्हें YES पर सेट की गई allowsInlineMediaPlayback प्रॉपर्टी का इस्तेमाल करके बनाया गया है.WebViews

rel

ध्यान दें: यह पैरामीटर 25 सितंबर, 2018 को या उसके बाद बदला जा रहा है.

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

start

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

widget_referrer

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

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

August 15, 2023

Note: This is a deprecation announcement for the modestbranding parameter.

The modestbranding parameter is deprecated and will have no effect. To align with YouTube's branding requirements, the player now determines the appropriate branding treatment based on a combination of factors, including player size, other API parameters (e.g. controls), and additional signals.

April 27, 2021

The playsinline parameter definition has been updated slightly to explain that the parameter pertains to both mobile browsers on iOS and iOS WebViews.

October 15, 2020

The autoplay parameter definition has been updated to explain that if you enable Autoplay, playback will occur without any user interaction with the player; playback data collection and sharing will therefore occur upon page load.

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 player's list and listType parameters.

This change will become effective on or after 15 November 2020. After that time, setting the listType parameter value to search will generate a 4xx response code, such as 404 (Not Found) or 410 (Gone).

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.

In addition to the change described above, the showinfo parameter, which was deprecated in 2018, has been removed from this document.

August 23, 2018

Note: This is a deprecation announcement for the showinfo parameter. In addition, the behavior for the rel parameter is changing. Titles, channel information, and related videos are an important part of YouTube’s core user experience, and these changes help to make the YouTube viewing experience consistent across different platforms.

  • The behavior for the rel parameter is changing on or after September 25, 2018. The effect of the change is that you will not be able to disable related videos. However, you will have the option of specifying that the related videos shown in the player should be from the same channel as the video that was just played.

    To be more specific:
    • Prior to the change, if the parameter's value is set to 0, then the player does not show related videos.
    • After the change, if the rel parameter is set to 0, the player will show related videos that are from the same channel as the video that was just played.
  • The showinfo parameter, which indicates whether the player should display information like the video title and uploader before the video starts playing, is also being deprecated. Following the change, the channel avatar and video title will always display before playback begins, when playback is paused, and when playback ends. The avatar being displayed is new behavior that will be consistent across all embedded players.

These changes will become effective on or after September 25, 2018. After that time, the showinfo parameter will be ignored. The behavior following the changes is consistent with the current default behavior for embedded players with the exception of the channel avatar changes mentioned above.

August 16, 2018

The cc_lang_pref parameter can be used to specify the default language that the player will use to display captions. This parameter can be used in conjunction with the cc_load_policy parameter to automatically show captions in the specified language during playback.

September 15, 2017

The controls parameter's definition has been updated to remove references to the deprecated Flash (AS3) player. The value 2 has been deprecated as it was originally designed to provide a performance improvement for embeds that loaded a Flash player.

June 12, 2017

The new widget_referrer parameter helps to enable more accurate YouTube Analytics reporting when the YouTube player is embedded in a widget, and that widget is then embedded in a web page or application.

November 1, 2016

This document has been updated to remove references to the deprecated Flash (AS3) player as well as to parameters only supported by that player. The YouTube Flash player was deprecated in January 2015.

October 20, 2016

This update contains the following changes:

  • The disablekb parameter definition has been corrected to note that the default value is 0, which means that keyboard controls are enabled. A value of 1 indicates that keyboard controls should be disabled.

    The list of keyboard controls that the player supports has also been updated to include the following:

    • [f]: Toggle full-screen display
    • [j]: Jump back 10 seconds in the current video
    • [k]: Play / Pause
    • [l]: Jump ahead 10 seconds in the current video
    • [m]: Mute or unmute the video
    • [0-9]: Jump to a point in the video. 0 jumps to the beginning of the video, 1 jumps to the time 10% into the video, 2 jumps to the point 20% into the video, and so forth.

    In addition, the effect of pressing the [arrow left] or [arrow right] keys has changed. These keys now jump 5 seconds back (arrow left) or ahead (arrow right) in the current video.

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.

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.

August 19, 2015

  • The autohide parameter has been deprecated for the HTML5 player. In HTML5 players, the video progress bar and player controls display or hide automatically. That behavior corresponds to an autohide setting of 1.

  • The theme parameter has been deprecated for the HTML5 player. HTML5 players now always use the dark theme.

March 9, 2015

  • The document has been updated to reflect the fact that YouTube <object> embeds, the YouTube Flash Player API and the YouTube JavaScript Player API have all been deprecated as of January 27, 2015. A deprecation warning appears in several sections of this document to help point readers to the IFrame Player API as an alternative.

  • The definition of the autohide parameter has been updated to clarify the meaning of the parameter's values. The default behavior (autohide=2) is that if the player has a 16:9 or 4:3 aspect ratio, the player's video progress bar and player controls display or hide automatically. Otherwise, those controls are visible throughout the video.

  • The definition of the hl parameter has been updated to note that the parameter value could be an ISO 639-1 two-letter language code or a fully specified locale. For example, fr and fr-ca are both valid parameter values.

  • The definition of the enablejsapi parameter has been reworded to clarify that the parameter enables a player to be controlled via API calls. The API could be either the IFrame Player API or the JavaScript Player API.

October 14, 2014

July 18, 2014

  • The new hl parameter can be used to set the player's interface language. The interface language is used for tooltips in the player and also affects the default caption track. The selected caption track may also depend on the availability of caption tracks and user's individual language preferences.

    The parameter's value is an ISO 639-1 two-letter language code, though other language input codes, such as IETF language tags (BCP 47) may also be handled properly.

  • The definition of the playsinline parameter, which only affects HTML5 players on iOS, has been modified slightly. The definition now notes that setting the parameter value to 1 causes inline playback only for UIWebViews created with the allowsInlineMediaPlayback property set to TRUE.

January 28, 2014

  • The playsinline parameter controls whether videos play inline or fullscreen in an HTML5 player on iOS. Setting the value to 1 causes inline playback.

  • The Selecting content to play section has been updated to explain how to find YouTube video IDs and playlist IDs using the YouTube Data API (v3) rather than the older API version.

  • The controls parameter's definition has been updated to reflect the fact that the parameter value only affects the time that the Flash player actually loads in IFrame embeds. In addition, for IFrame embeds, the parameter value also determines when the controls display in the player. If you set the parameter's value to 2, then the controls display and the Flash player loads after the user initiates the video playback.

May 10, 2013

This update contains the following changes:

July 20, 2012

This update contains the following changes:

  • The definition of the controls parameter has been updated to reflect support for a parameter value of 2 and to explain that, for AS3 players, the parameter value determines the time when the Flash player actually loads. If the controls parameter is set to 0 or 1, the Flash player loads immediately. If the parameter value is 2, the Flash player does not load until the video playback is initiated.

June 5, 2012

This update contains the following changes:

  • The HTML5 player now supports the color, modestbranding, and rel parameters, and the definitions for these parameters have been updated accordingly.

  • The definition of the showinfo parameter has been updated to explain how that if the player is loading a playlist, and you explicitly set the parameter value to 1, then, upon loading, the player will also display thumbnail images for the videos in the playlist. Note that this functionality is only supported for the AS3 player since that is the only player that can load a playlist.

May 4, 2012

This update contains the following changes:

  • The showinfo parameter's definition has been updated to reflect the fact that the HTML5 player supports this parameter.

May 3, 2012

This update contains the following changes:

  • The new end parameter specifies the time, measured in seconds from the start of the video, when the player should stop playing a video. Note that the time when playback is stopped is measured from the beginning of the video and not from the value of either the start player parameter or the startSeconds parameter, which is used in YouTube Player API functions for loading or queueing a video.

March 29, 2012

This update contains the following changes:

  • The new Embedding a YouTube player section explains different ways to embed a YouTube player in your application. This section covers manual IFrame embeds, IFrame embeds that use the IFrame Player API, and AS3 and AS2 object embeds. This section incorporates information from the old Example usage section, which has been removed.

  • The new Selecting content to play section explains how to configure the player to load a video, a playlist, search results for a specified query, or uploaded videos for a specified user.

  • The new list and listType parameters let you specify the content that the player should load. You can specify a playlist, a search query, or a particular user's uploaded videos.

  • The definitions of the fs and rel parameters have been updated to more clearly explain the default parameter values for the AS3 player.

  • The border, color1, egm, hd, and showsearch parameters, which are all only supported for the deprecated AS2 Player API, have been moved to a new section named deprecated parameters only used in the AS2 Player API.

  • The document no longer provides a way to filter the parameter list to only display parameters supported in either the AS3, AS2, or HTML5 player. Instead, each parameter definition has been updated to identify the players that support that parameter.

August 11, 2011

This update contains the following changes:

  • The new theme and color parameters let you customize the appearance of the embedded player's player controls. See the YouTube API blog for more information.

June 8, 2011

This update contains the following changes:

  • The new modestbranding parameter lets you use a YouTube player that does not show a YouTube logo. As of this release, the parameter was only supported for the AS3 embedded player and for IFrame embeds that loaded the AS3 player. As of June 5, 2012, the HTML5 player also supported this parameter.

February 14, 2011

This update contains the following changes:

  • The documentation has been updated to note that the AS2 Player API has been deprecated. The deprecation of the AS2 Player API was actually announced on October 14, 2009.

February 3, 2011

This update contains the following changes:

  • The documentation has been updated to identify parameters supported in the HTML5 (IFrame) embedded player.

  • The document now displays all of the parameters supported in any of YouTube's embedded players (HTML5, AS3, AS2).

  • The following parameters are supported in the AS2 player but have been deprecated for the newer AS3 and HTML5 players: border, color1, color2, egm, hd, and showsearch.

    In addition, the loop parameter has limited support in the AS3 player and in IFrame embeds, which could load either an AS3 or HTML player. Currently, the loop parameter only works in the AS3 player when used in conjunction with the playlist parameter. To loop a single video, set the loop parameter to 1 and set the playlist parameter value to the same video ID already specified in the Player API URL:

    https://www.youtube.com/v/VIDEO_ID?version=3&loop=1&playlist=VIDEO_ID

    Similarly, the controls and playlist parameters are supported in the AS3 and HTML5 players but are not and will not be supported in the AS2 player.

    As noted above, IFrame embeds can load either an AS3 or HTML5 player. Though some parameters are not supported in both players, an IFrame embed that loads the AS3 player will support all parameters that work with that player and ignore all other parameters. Similarly, an IFrame embed that loads the HTML5 player will support all parameters that work with that player while ignoring all other parameters.

  • The parameter list has been updated to include the autohide parameter, which indicates whether the player's video controls will automatically hide after a video begins playing.

  • The parameter list has been updated to include the controls parameter, which indicates whether the player's video controls will display at all. (Player controls do display by default.)

  • The parameter list has been updated to include the playlist parameter, which specifies a comma-separated list of video IDs to play.

  • The definition of the fs has been updated to note that the fullscreen option will not work if you load the YouTube player into another SWF.

  • The example at the end of the document has been updated to use the embedded AS3 player instead of the embedded AS2 player. The parameters used in the example have also been updated to only include parameters that the AS3 player supports.

    In addition, the instructions for constructing the URLs that contain player parameters have been updated to reflect the URL formats used by the AS3 and AS2 embedded and chromeless players as well as by the HTML5 player.