YouTube Embedded Players and Player Parameters

نمای کلی

این سند نحوه جاسازی یک پخش کننده YouTube را در برنامه خود توضیح می دهد و همچنین پارامترهایی را که در پخش کننده تعبیه شده YouTube در دسترس هستند را تعریف می کند.

با افزودن پارامترها به URL IFrame، می توانید تجربه پخش را در برنامه خود سفارشی کنید. به عنوان مثال، می‌توانید با استفاده از پارامتر autoplay ویدیوها را به طور خودکار پخش کنید یا با استفاده از پارامتر loop باعث پخش مکرر یک ویدیو شوید. همچنین می‌توانید از پارامتر enablejsapi برای فعال کردن پخش‌کننده از طریق API IFrame Player استفاده کنید.

این صفحه در حال حاضر تمام پارامترهای پشتیبانی شده در هر پخش کننده تعبیه شده YouTube را تعریف می کند. هر تعریف پارامتر، بازیکنانی را که از پارامتر مربوطه پشتیبانی می کنند، شناسایی می کند.

توجه: پخش‌کننده‌های جاسازی‌شده باید دارای دیدی با ابعاد حداقل 200 پیکسل در 200 پیکسل باشند. اگر پخش‌کننده کنترل‌ها را نمایش می‌دهد، باید به اندازه‌ای بزرگ باشد که کنترل‌ها را به‌طور کامل نمایش دهد، بدون اینکه درگاه دید کمتر از حداقل اندازه باشد. ما توصیه می کنیم پخش کننده های 16:9 حداقل 480 پیکسل عرض و 270 پیکسل قد داشته باشند.

یک پخش کننده YouTube را جاسازی کنید

می توانید از یکی از روش های زیر برای جاسازی یک پخش کننده YouTube در برنامه خود و تعیین پارامترهای پخش کننده استفاده کنید. توجه داشته باشید که دستورالعمل‌های زیر نحوه جاسازی پخش‌کننده‌ای را نشان می‌دهد که یک ویدیو را بارگیری می‌کند. بخش زیر نحوه پیکربندی پخش کننده خود را برای بارگذاری لیست پخش یا ویدیوهای آپلود شده توسط کاربر توضیح می دهد.

با استفاده از تگ <iframe> یک پخش کننده را جاسازی کنید

یک تگ <iframe> را در برنامه خود تعریف کنید که در آن URL src محتوایی را که پخش کننده بارگذاری می کند و همچنین سایر پارامترهای پخش کننده را که می خواهید تنظیم کنید مشخص می کند. پارامترهای height و width تگ <iframe> ابعاد پخش کننده را مشخص می کند.

اگر عنصر <iframe> را خودتان ایجاد کنید (به جای استفاده از API IFrame Player برای ایجاد آن)، می توانید پارامترهای پخش کننده را مستقیماً به انتهای URL اضافه کنید. URL دارای فرمت زیر است:

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

تگ <iframe> زیر یک پخش کننده 640x360px را بارگیری می کند که ویدیوی YouTube M7lc1UVf-VE را پخش می کند. از آنجایی که URL پارامتر 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 پخش کننده را جاسازی کنید

دستورالعمل های IFrame Player API را دنبال کنید تا پس از بارگیری کد جاوا اسکریپت Player API، یک پخش کننده ویدیو را در صفحه وب یا برنامه خود وارد کنید. دومین پارامتر در سازنده برای پخش کننده ویدئو، یک شی است که گزینه های پخش کننده را مشخص می کند. در داخل آن شی، ویژگی playerVars پارامترهای بازیکن را شناسایی می کند.

کد HTML و جاوا اسکریپت زیر یک مثال ساده را نشان می دهد که یک پخش کننده YouTube را در عنصر صفحه قرار می دهد که دارای مقدار id ytplayer است. تابع onYouTubePlayerAPIReady() که در اینجا مشخص شده است، هنگامی که کد API IFrame Player بارگیری می شود، به طور خودکار فراخوانی می شود. این کد هیچ پارامتر پخش کننده ای را تعریف نمی کند و همچنین کنترل کننده های رویداد دیگر را تعریف نمی کند. 

<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، شناسه ویدیوی YouTube برای ویدیویی که می‌خواهید بارگیری کنید در URL src IFrame مشخص شده است.

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

    اگر از YouTube Data API (v3) استفاده می‌کنید، می‌توانید با بازیابی شناسه‌های ویدیو از نتایج جستجو ، منابع آیتم‌های فهرست پخش ، منابع ویدیویی یا منابع دیگر، این نشانی‌های اینترنتی را به صورت برنامه‌نویسی بسازید. پس از دریافت شناسه ویدیو، متن VIDEO_ID را در URL های بالا با آن مقدار جایگزین کنید تا URL پخش کننده ایجاد شود.

  • در حال بارگیری یک لیست پخش

    پارامتر listType player را روی playlist تنظیم کنید. علاوه بر این، پارامتر پخش list را روی شناسه لیست پخش YouTube که می خواهید بارگیری کنید، تنظیم کنید.

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

    توجه داشته باشید که همانطور که در مثال زیر نشان داده شده است باید شناسه لیست پخش را با حروف PL اضافه کنید:

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

    اگر از YouTube Data API (v3) استفاده می‌کنید، می‌توانید با بازیابی شناسه‌های فهرست پخش از نتایج جستجو ، منابع کانال یا منابع فعالیت ، این نشانی‌های اینترنتی را به صورت برنامه‌نویسی بسازید. پس از دریافت شناسه لیست پخش، متن PLAYLIST_ID در URL بالا را با آن مقدار جایگزین کنید.

  • بارگیری ویدیوهای آپلود شده توسط کاربر

    پارامتر listType player را روی user_uploads تنظیم کنید. علاوه بر این، پارامتر پخش list را روی نام کاربری 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]: پخش / مکث
  • پیکان چپ: در ویدیوی فعلی 5 ثانیه به عقب پرش کنید
  • پیکان راست: در ویدیوی فعلی 5 ثانیه جلوتر بپرید
  • فلش بالا: افزایش صدا
  • فلش پایین: کاهش صدا
  • [f]: نمایش تمام صفحه را تغییر دهید
  • [j]: در ویدیوی فعلی 10 ثانیه به عقب پرش کنید
  • [l]: در ویدیوی فعلی 10 ثانیه به جلو بپرید
  • [m]: ویدیو را نادیده یا باصدا کنید
  • [0-9]: پرش به نقطه ای در ویدیو. 0 پرش به ابتدای ویدیو، 1 پرش به نقطه 10 درصد به داخل ویدیو، 2 پرش به نقطه 20 درصد به داخل ویدیو، و غیره.

enablejsapi

 تنظیم مقدار پارامتر روی 1 پخش کننده را قادر می سازد از طریق تماس های API IFrame Player کنترل شود. مقدار پیش فرض 0 است، به این معنی که پخش کننده را نمی توان با استفاده از آن API کنترل کرد.

برای اطلاعات بیشتر در مورد IFrame API و نحوه استفاده از آن، به مستندات IFrame API مراجعه کنید.

end

 این پارامتر زمانی را که پخش کننده باید پخش ویدیو را متوقف کند، بر حسب ثانیه از شروع ویدیو اندازه گیری می کند. مقدار پارامتر یک عدد صحیح مثبت است.

توجه داشته باشید که زمان از ابتدای ویدیو اندازه گیری می شود و نه از مقدار پارامتر start پخش یا پارامتر startSeconds که در توابع YouTube Player API برای بارگیری یا صف بندی یک ویدیو استفاده می شود.

fs

 تنظیم این پارامتر روی 0 از نمایش دکمه تمام صفحه در پخش کننده جلوگیری می کند. مقدار پیش فرض 1 است که باعث می شود دکمه تمام صفحه نمایش داده شود.

hl

 زبان رابط پخش کننده را تنظیم می کند. مقدار پارامتر یک کد زبان دو حرفی ISO 639-1 یا یک منطقه کاملاً مشخص شده است. به عنوان مثال، fr و fr-ca هر دو مقادیر معتبر هستند. سایر کدهای ورودی زبان، مانند برچسب های زبان IETF (BCP 47) نیز ممکن است به درستی مدیریت شوند.

زبان رابط برای نکات ابزار در پخش کننده استفاده می شود و همچنین بر روی تراک عنوان پیش فرض تأثیر می گذارد. توجه داشته باشید که YouTube ممکن است بر اساس ترجیحات زبان فردی کاربر و در دسترس بودن تراک‌های شرح، زبان آهنگ زیرنویس متفاوتی را برای یک کاربر خاص انتخاب کند.

iv_load_policy

 تنظیم مقدار پارامتر روی 1 باعث می شود حاشیه نویسی ویدیو به طور پیش فرض نشان داده شود، در حالی که تنظیم روی 3 باعث می شود حاشیه نویسی ویدیو به طور پیش فرض نشان داده نشود. مقدار پیش فرض 1 است.

list

 پارامتر list ، در ارتباط با پارامتر listType ، محتوایی را که در پخش کننده بارگذاری می شود، مشخص می کند.

  • اگر مقدار پارامتر 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 مشخص کنید، URL جاسازی شده IFrame نیازی به تعیین شناسه ویدیو ندارد.

listType

 پارامتر listType ، در ارتباط با پارامتر list ، محتوایی را که در پخش کننده بارگذاری می شود، مشخص می کند. مقادیر پارامتر معتبر عبارتند از playlist و user_uploads .

اگر مقادیری را برای پارامترهای list و listType مشخص کنید، URL جاسازی شده IFrame نیازی به تعیین شناسه ویدیو ندارد.

توجه: مقدار پارامتر سوم، search ، منسوخ شده است و از 15 نوامبر 2020 دیگر پشتیبانی نخواهد شد.

loop

 در مورد یک پخش کننده ویدیو، تنظیم 1 باعث می شود که پخش کننده ویدیوی اولیه را بارها و بارها پخش کند. در مورد پخش کننده لیست پخش (یا پخش کننده سفارشی)، پخش کننده کل لیست پخش را پخش می کند و سپس در اولین ویدیو دوباره شروع می کند.

مقادیر پشتیبانی شده 0 و 1 و مقدار پیش فرض 0 است.

توجه: این پارامتر در تعبیه‌های IFrame پشتیبانی محدودی دارد. برای حلقه زدن یک ویدیو، مقدار پارامتر loop را روی 1 تنظیم کنید و مقدار پارامتر playlist را روی همان شناسه ویدیویی که قبلاً در URL API Player مشخص شده است تنظیم کنید: 
https://www.youtube.com/embed/VIDEO_ID?playlist=VIDEO_ID&loop=1

modestbranding

 توجه: این پارامتر منسوخ شده است و تاثیری ندارد. برای اطلاعات بیشتر به اطلاعیه انصراف مراجعه کنید.

origin

 این پارامتر یک معیار امنیتی اضافی برای API IFrame فراهم می کند و فقط برای جاسازی های IFrame پشتیبانی می شود. اگر از IFrame API استفاده می کنید، به این معنی که مقدار پارامتر enablejsapi را روی 1 تنظیم می کنید، همیشه باید دامنه خود را به عنوان مقدار پارامتر origin مشخص کنید.

playlist

 این پارامتر فهرستی از شناسه‌های ویدیویی جدا شده با کاما را برای پخش مشخص می‌کند. اگر مقداری را مشخص کنید، اولین ویدیویی که پخش می‌شود VIDEO_ID مشخص‌شده در مسیر URL خواهد بود و ویدیوهای مشخص‌شده در پارامتر playlist پس از آن پخش خواهند شد.

playsinline

 این پارامتر کنترل می‌کند که ویدیوها به صورت درون خطی یا تمام صفحه در iOS پخش شوند. مقادیر معتبر عبارتند از:

  • 0 : نتایج در پخش تمام صفحه. این در حال حاضر مقدار پیش‌فرض است، اگرچه پیش‌فرض ممکن است تغییر کند.
  • 1 : نتایج در پخش درون خطی برای مرورگرهای تلفن همراه و برای WebViews ایجاد شده با ویژگی allowsInlineMediaPlayback که روی YES تنظیم شده است.

rel

 توجه: این پارامتر در تاریخ 25 سپتامبر 2018 یا پس از آن در حال تغییر است.

قبل از تغییر، این پارامتر نشان می‌دهد که آیا پخش‌کننده باید ویدیوهای مرتبط را هنگام پایان پخش ویدیوی اولیه نشان دهد یا خیر.
  • اگر مقدار پارامتر روی 1 تنظیم شود که مقدار پیش‌فرض است، پخش‌کننده ویدیوهای مرتبط را نشان می‌دهد.
  • اگر مقدار پارامتر روی 0 تنظیم شود، پخش کننده ویدیوهای مرتبط را نشان نمی دهد.
پس از تغییر، نمی‌توانید ویدیوهای مرتبط را غیرفعال کنید. در عوض، اگر پارامتر rel روی 0 تنظیم شده باشد، ویدیوهای مرتبط از همان کانال ویدیویی که به تازگی پخش شده است می آیند.

start

 این پارامتر باعث می شود که پخش کننده شروع به پخش ویدیو در تعداد ثانیه معین از شروع ویدیو کند. مقدار پارامتر یک عدد صحیح مثبت است. توجه داشته باشید که مشابه تابع seekTo ، پخش کننده به دنبال نزدیکترین فریم کلیدی به زمانی که شما تعیین کرده اید می گردد. این بدان معنی است که گاهی اوقات ممکن است هد پخش درست قبل از زمان درخواستی، معمولاً بیش از دو ثانیه به دنبال آن باشد.

widget_referrer

 این پارامتر نشانی اینترنتی را که پخش کننده در آن جاسازی شده است مشخص می کند. هنگامی که پخش کننده YouTube در یک ویجت جاسازی شده است، این مقدار در گزارش YouTube Analytics استفاده می شود، و سپس آن ویجت در یک صفحه وب یا برنامه جاسازی می شود. در آن سناریو، پارامتر 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.