YouTube Embedded Players and Player Parameters

Tổng quan

Tài liệu này giải thích cách nhúng trình phát YouTube vào ứng dụng của bạn và cũng xác định các thông số sẵn có trong trình phát YouTube được nhúng.

Bằng cách thêm tham số vào URL IFrame, bạn có thể tùy chỉnh trải nghiệm phát trong ứng dụng của mình. Ví dụ: bạn có thể tự động phát video bằng tham số autoplay hoặc khiến video phát liên tục bằng tham số loop. Bạn cũng có thể sử dụng tham số enablejsapi để cho phép kiểm soát trình phát thông qua IFrame Player API.

Trang này hiện xác định tất cả các thông số được hỗ trợ trong bất kỳ trình phát YouTube được nhúng nào. Mỗi định nghĩa thông số xác định trình phát hỗ trợ thông số tương ứng.

Lưu ý: Trình phát nhúng phải có khung nhìn ít nhất là 200px x 200px. Nếu trình phát hiển thị các thành phần điều khiển, thì thành phần này phải đủ lớn để hiển thị đầy đủ các thành phần điều khiển mà không cần thu nhỏ khung nhìn bên dưới kích thước tối thiểu. Chúng tôi khuyên bạn nên sử dụng trình phát 16:9 có chiều rộng tối thiểu là 480 pixel và chiều cao ít nhất là 270 pixel.

Nhúng trình phát YouTube

Bạn có thể sử dụng bất kỳ phương pháp nào sau đây để nhúng trình phát YouTube vào ứng dụng của bạn và chỉ định thông số trình phát. Lưu ý rằng các hướng dẫn bên dưới minh họa cách nhúng trình phát tải một video. Phần sau đây giải thích cách định cấu hình trình phát của bạn để tải danh sách phát hoặc video tải lên của người dùng.

Nhúng trình phát bằng thẻ <iframe>

Xác định thẻ <iframe> trong ứng dụng, trong đó URL src chỉ định nội dung mà trình phát sẽ tải cũng như mọi tham số khác của trình phát mà bạn muốn đặt. Các thông số heightwidth của thẻ <iframe> chỉ định kích thước của trình phát.

Nếu tự tạo phần tử <iframe> (thay vì sử dụng API trình phát IFrame để tạo), bạn có thể trực tiếp nối các tham số trình phát vào cuối URL. URL có định dạng như sau:

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

Thẻ <iframe> bên dưới sẽ tải trình phát 640x360px sẽ phát video YouTube M7lc1UVf-VE. Vì URL này đặt tham số autoplay thành 1 nên video sẽ phát tự động khi trình phát đã tải.

<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>

Nhúng trình phát bằng API Trình phát IFrame

Làm theo hướng dẫn API trình phát iFrame để chèn trình phát video vào trang web hoặc ứng dụng của bạn sau khi mã JavaScript của API trình phát đã tải. Tham số thứ hai trong hàm khởi tạo cho trình phát video là đối tượng chỉ định các tuỳ chọn của trình phát. Trong đối tượng đó, thuộc tính playerVars xác định các thông số của trình phát.

Mã HTML và JavaScript bên dưới hiển thị ví dụ đơn giản chèn trình phát YouTube vào phần tử trang có giá trị idytplayer. Hàm onYouTubePlayerAPIReady() được chỉ định ở đây sẽ được gọi tự động khi mã API IFrame Player tải. Mã này không xác định bất kỳ thông số trình phát nào và cũng không xác định các trình xử lý sự kiện khác.

<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>

Chọn nội dung để phát

Bạn có thể định cấu hình trình phát được nhúng để tải video, danh sách phát hoặc video đã tải lên của người dùng.

Danh sách sau đây giải thích những tuỳ chọn này:

  • Đang tải video

    Để nhúng IFrame, ID video YouTube cho video bạn muốn tải được chỉ định trong URL src của IFrame.

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

    Nếu bạn đang sử dụng API dữ liệu YouTube (v3), bạn có thể xây dựng các URL này theo chương trình bằng cách truy xuất ID video từ kết quả tìm kiếm, tài nguyên mục danh sách phát, tài nguyên video hoặc các tài nguyên khác. Sau khi lấy mã video, hãy thay thế văn bản VIDEO_ID trong các URL ở trên bằng giá trị đó để tạo URL trình phát.

  • Tải danh sách phát

    Đặt tham số trình phát listType thành playlist. Ngoài ra, hãy đặt thông số trình phát list thành mã nhận dạng danh sách phát trên YouTube mà bạn muốn tải.

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

    Lưu ý rằng bạn cần thêm ID PL vào trước danh sách phát ID như được hiển thị trong ví dụ sau:

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

    Nếu bạn đang sử dụng API dữ liệu YouTube (phiên bản 3), bạn có thể xây dựng các URL này theo chương trình bằng cách truy xuất ID danh sách phát từ kết quả tìm kiếm, tài nguyên kênh hoặc tài nguyên hoạt động. Sau khi lấy mã nhận dạng danh sách phát, hãy thay thế văn bản PLAYLIST_ID trong URL ở trên bằng giá trị đó.

  • Tải video đã tải lên của người dùng

    Đặt tham số trình phát listType thành user_uploads. Ngoài ra, hãy đặt thông số trình phát list thành tên người dùng YouTube có video đã tải lên mà bạn muốn tải.

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

Các tham số được hỗ trợ

Tất cả các thông số sau đây là không bắt buộc.

Các tham số

autoplay

Thông số này chỉ định liệu video ban đầu có tự động bắt đầu phát khi trình phát tải hay không. Giá trị được hỗ trợ là 0 hoặc 1. Giá trị mặc định là 0.

Nếu bạn bật tính năng Tự động phát, thì quá trình phát sẽ diễn ra mà người dùng không cần phải tương tác với trình phát. Do đó, tính năng thu thập và chia sẻ dữ liệu phát sẽ diễn ra khi tải trang.

cc_lang_pref

Tham số này chỉ định ngôn ngữ mặc định mà trình phát sẽ sử dụng để hiện phụ đề. Đặt giá trị của thông số thành mã ngôn ngữ ISO 639-1 hai chữ cái.

Nếu bạn sử dụng thông số này và cũng đặt thông số cc_load_policy thành 1, thì trình phát sẽ hiển thị phụ đề bằng ngôn ngữ được chỉ định khi trình phát tải. Nếu bạn cũng không đặt thông số cc_load_policy thì phụ đề sẽ không hiển thị theo mặc định, nhưng sẽ hiển thị bằng ngôn ngữ được chỉ định nếu người dùng chọn bật phụ đề.

cc_load_policy

Việc đặt giá trị của thông số thành 1 sẽ tạo phụ đề hiển thị theo mặc định, ngay cả khi người dùng đã tắt phụ đề. Hành vi mặc định là dựa trên tùy chọn của người dùng.

color

Tham số này chỉ định màu sẽ được sử dụng trong thanh tiến trình video của trình phát để đánh dấu thời lượng video mà người xem đã xem. Các giá trị tham số hợp lệ là redwhite, còn trình phát sử dụng màu đỏ trong thanh tiến trình video theo mặc định. Hãy xem blog của API YouTube để biết thêm thông tin về các tùy chọn màu sắc.

controls

Tham số này cho biết liệu các điều khiển trình phát video có được hiển thị hay không:

  • controls=0 – Các nút điều khiển trình phát không hiển thị trong trình phát.
  • controls=1 (mặc định) – Các nút điều khiển trình phát hiển thị trong trình phát.

disablekb

Việc đặt giá trị của thông số thành 1 khiến người chơi không phản hồi các nút điều khiển bàn phím. Giá trị mặc định là 0, nghĩa là các nút điều khiển đang bật. Các chức năng điều khiển hiện có trên bàn phím là:

  • Phím cách hoặc [k]: Phát / Tạm dừng
  • Mũi tên trái: Tua lại 5 giây trong video hiện tại
  • Mũi tên phải: Tua nhanh 5 giây trong video hiện tại
  • Mũi tên lên: Tăng âm lượng
  • Mũi tên xuống: Giảm âm lượng
  • [f]: Bật/tắt chế độ hiển thị toàn màn hình
  • [j]: Quay lại 10 giây trong video hiện tại
  • [l]: Tua đi 10 giây trong video hiện tại
  • [m]: Tắt tiếng hoặc bật tiếng video
  • [0-9]: Chuyển đến một điểm trong video. 0 chuyển đến đầu video, 1 nhảy đến điểm 10% vào video, 2 nhảy đến điểm 20% vào video, v.v.

enablejsapi

Việc đặt giá trị của tham số thành 1 cho phép kiểm soát trình phát thông qua các lệnh gọi API IFrame dành cho trình phát. Giá trị mặc định là 0, có nghĩa là bạn không thể điều khiển trình phát bằng API đó.

Để biết thêm thông tin về API IFrame và cách sử dụng API này, hãy xem tài liệu về API IFrame.

end

Tham số này chỉ định thời gian, được tính bằng giây kể từ khi bắt đầu video, khi trình phát dừng phát video. Giá trị thông số là một số nguyên dương.

Xin lưu ý rằng thời gian được tính từ đầu video chứ không phải từ giá trị của thông số trình phát start hoặc thông số startSeconds (dùng trong các chức năng của API Trình phát YouTube để tải hoặc đưa video vào hàng đợi).

fs

Việc đặt tham số này thành 0 sẽ ngăn nút toàn màn hình hiển thị trong trình phát. Giá trị mặc định là 1, khiến nút toàn màn hình hiển thị.

hl

Đặt ngôn ngữ giao diện của người chơi. Giá trị thông số là mã ngôn ngữ ISO 639-1 hai chữ cái hoặc ngôn ngữ được chỉ định đầy đủ. Ví dụ: frfr-ca đều là những giá trị hợp lệ. Các mã đầu vào ngôn ngữ khác, chẳng hạn như thẻ ngôn ngữ IETF (BCP 47), cũng có thể được xử lý đúng cách.

Ngôn ngữ giao diện được sử dụng cho chú giải công cụ trong trình phát và cũng ảnh hưởng đến phụ đề mặc định. Lưu ý rằng YouTube có thể chọn ngôn ngữ phụ đề gốc khác cho người dùng cụ thể dựa trên tùy chọn ngôn ngữ riêng của người dùng và tính khả dụng của phụ đề gốc.

iv_load_policy

Việc đặt giá trị của thông số thành 1 sẽ khiến chú thích video hiển thị theo mặc định, trong khi việc đặt thành 3 sẽ khiến chú thích video không hiển thị theo mặc định. Giá trị mặc định là 1.

list

Tham số list cùng với tham số listType giúp xác định nội dung sẽ tải trong trình phát.

  • Nếu giá trị tham số listTypeuser_uploads, thì giá trị tham số list sẽ xác định kênh YouTube có video đã tải lên sẽ được tải.
  • Nếu giá trị tham số listTypeplaylist, thì giá trị tham số list sẽ chỉ định một mã nhận dạng danh sách phát trên YouTube. Trong giá trị tham số, bạn cần thêm mã số PL vào trước mã danh sách phát như trong ví dụ dưới đây.
    https://www.youtube.com/embed?
        listType=playlist
        &list=PLC77007E23FF423C6
  • Nếu giá trị tham số listTypesearch, thì giá trị tham số list sẽ chỉ định truy vấn tìm kiếm. Lưu ý: Chức năng này không còn được dùng nữa và sẽ không còn được hỗ trợ kể từ ngày 15 tháng 11 năm 2020.
Lưu ý: Nếu bạn chỉ định giá trị cho các tham số listlistType, thì URL nhúng IFrame không cần chỉ định mã video.

listType

Tham số listType cùng với tham số list giúp xác định nội dung sẽ tải trong trình phát. Giá trị tham số hợp lệ là playlistuser_uploads.

Nếu bạn chỉ định giá trị cho tham số listlistType, thì URL nhúng IFrame không cần chỉ định mã video.

Lưu ý: Giá trị thông số thứ ba, search, đã ngưng sử dụng và sẽ không còn được hỗ trợ kể từ ngày 15/11/2020.

loop

Trong trường hợp một trình phát video, chế độ cài đặt 1 sẽ khiến trình phát phát video ban đầu nhiều lần. Trong trường hợp trình phát danh sách phát (hoặc trình phát tùy chỉnh), trình phát sẽ phát toàn bộ danh sách phát, sau đó bắt đầu lại ở video đầu tiên.

Giá trị được hỗ trợ là 01, và giá trị mặc định là 0.

Lưu ý: Tham số này chỉ hỗ trợ hạn chế trong tính năng nhúng IFrame. Để tạo vòng lặp cho một video, hãy đặt giá trị tham số loop thành 1 và đặt giá trị tham số playlist thành cùng một mã video đã được chỉ định trong URL API trình phát:
https://www.youtube.com/embed/VIDEO_ID?playlist=VIDEO_ID&loop=1

modestbranding

Lưu ý: Tham số này không được dùng nữa và không có hiệu lực. Hãy xem thông báo về việc ngừng cung cấp để biết thêm thông tin.

origin

Tham số này cung cấp biện pháp bảo mật bổ sung cho API IFrame và chỉ được hỗ trợ cho các lượt nhúng IFrame. Nếu bạn đang sử dụng API IFrame, có nghĩa là bạn đang đặt giá trị tham số enablejsapi thành 1, bạn phải luôn chỉ định miền của mình làm giá trị tham số origin.

playlist

Thông số này chỉ định một danh sách ID video được phân tách bằng dấu phẩy để phát. Nếu bạn chỉ định một giá trị, video đầu tiên phát sẽ là VIDEO_ID được chỉ định trong đường dẫn URL và các video được chỉ định trong thông số playlist sẽ phát sau đó.

playsinline

Thông số này kiểm soát việc phát video nội tuyến hay toàn màn hình trên iOS. Các giá trị hợp lệ là:

  • 0: Kết quả là phát lại toàn màn hình. Đây hiện là giá trị mặc định, mặc định có thể thay đổi.
  • 1: Kết quả khi phát nội tuyến cho trình duyệt trên thiết bị di động và cho WebViews được tạo với thuộc tính allowsInlineMediaPlayback được đặt thành YES.

rel

Lưu ý: Tham số này sẽ thay đổi vào hoặc sau ngày 25 tháng 9 năm 2018.

Trước khi thay đổi, thông số này cho biết liệu trình phát có hiển thị các video có liên quan hay không khi quá trình phát lại video ban đầu kết thúc.
  • Nếu giá trị của thông số được đặt thành 1 (giá trị mặc định) thì trình phát sẽ hiển thị các video có liên quan.
  • Nếu giá trị của thông số được đặt thành 0, thì trình phát sẽ không hiển thị các video có liên quan.
Sau khi thực hiện thay đổi, bạn sẽ không thể tắt các video có liên quan. Thay vào đó, nếu tham số rel được đặt thành 0, thì các video có liên quan sẽ đến từ cùng một kênh với video vừa phát.

start

Tham số này khiến trình phát bắt đầu phát video vào số giây nhất định kể từ lúc bắt đầu video. Giá trị thông số là một số nguyên dương. Xin lưu ý rằng tương tự như hàm seekTo, trình phát sẽ tìm khung hình chính gần nhất với thời điểm bạn chỉ định. Điều này có nghĩa là đôi khi đầu phát có thể tìm kiếm ngay trước thời gian yêu cầu, thường không quá 2 giây.

widget_referrer

Tham số này xác định URL mà trình phát được nhúng. Giá trị này được sử dụng trong báo cáo YouTube Analytics khi trình phát YouTube được nhúng vào tiện ích con và sau đó tiện ích con này được nhúng vào trang web hoặc ứng dụng. Trong trường hợp đó, thông số origin sẽ xác định miền của nhà cung cấp tiện ích nhưng YouTube Analytics không được xác định nhà cung cấp tiện ích là nguồn lưu lượng truy cập thực tế. Thay vào đó, YouTube Analytics sử dụng giá trị thông số widget_referrer để xác định miền liên kết với nguồn lưu lượng truy cập.

Lịch sử sửa đổi

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.