Autoplay YouTube

Overview

This document explains how to embed a YouTube player in your application and also defines the parameters that are available in the YouTube embedded player.

Nội dung chính Show

Embed a YouTube player
Embed a player using an

Embed a player using the IFrame Player API

Follow the IFrame Player API instructions to insert a video player in your web page or application after the Player API's JavaScript code has loaded. The second parameter in the constructor for the video player is an object that specifies player options. Within that object, the playerVars property identifies player parameters.

The HTML and JavaScript code below shows a simple example that inserts a YouTube player into the page element that has an id value of ytplayer. The onYouTubePlayerAPIReady() function specified here is called automatically when the IFrame Player API code has loaded. This code does not define any player parameters and also does not define other event handlers.

Select content to play

You can configure your embedded player to load a video, a playlist, or a user's uploaded videos.

The following list explains these options:
- Loading a video
  
  For an IFrame embed, the YouTube video ID for the video that you want to load is specified in the IFrame's src URL.
  https://www.youtube.com/embed/VIDEO_ID
  If you are using the YouTube Data API (v3), you can programmatically construct these URLs by retrieving video IDs from search results, playlist item resources, video resources, or other resources. After obtaining a video ID, replace the VIDEO_ID text in the URLs above with that value to create the player URL.
- Loading a playlist
  
  Set the listType player parameter to playlist. In addition, set the list player parameter to the YouTube playlist ID that you want to load.
  https://www.youtube.com/embed?listType=playlist&list=PLAYLIST_ID
  Note that you need to prepend the playlist ID with the letters PL as shown in the following example:
  https://www.youtube.com/embed?listType=playlist&list=PLC77007E23FF423C6
  If you are using the YouTube Data API (v3), you can programmatically construct these URLs by retrieving playlist IDs from search results, channel resources, or activity resources. After obtaining a playlist ID, replace the PLAYLIST_ID text in the URL above with that value.
- Loading a user's uploaded videos
  
  Set the listType player parameter to user_uploads. In addition, set the list player parameter to the YouTube username whose uploaded videos you want to load.
  https://www.youtube.com/embed?listType=user_uploads&list=USERNAME
Supported parameters

All of the following parameters are optional.
Parameters
autoplay
This parameter specifies whether the initial video will automatically start to play when the player loads. Supported values are 0 or 1. The default value is 0.

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.
cc_lang_pref
This parameter specifies the default language that the player will use to display captions. Set the parameter's value to an ISO 639-1 two-letter language code.

If you use this parameter and also set the cc_load_policy parameter to 1, then the player will show captions in the specified language when the player loads. If you do not also set the cc_load_policy parameter, then captions will not display by default, but will display in the specified language if the user opts to turn captions on.
cc_load_policy
Setting the parameter's value to 1 causes closed captions to be shown by default, even if the user has turned captions off. The default behavior is based on user preference.
color
This parameter specifies the color that will be used in the player's video progress bar to highlight the amount of the video that the viewer has already seen. Valid parameter values are red and white, and, by default, the player uses the color red in the video progress bar. See the YouTube API blog for more information about color options.

Note: Setting the color parameter to white will disable the modestbranding option.
controls
This parameter indicates whether the video player controls are displayed:
- controls=0 Player controls do not display in the player.
- controls=1 (default) Player controls display in the player.
disablekb
Setting the parameter's value to 1 causes the player to not respond to keyboard controls. The default value is 0, which means that keyboard controls are enabled. Currently supported keyboard controls are:
- Spacebar or [k]: Play / Pause
- Arrow Left: Jump back 5 seconds in the current video
- Arrow Right: Jump ahead 5 seconds in the current video
- Arrow Up: Volume up
- Arrow Down: Volume Down
- [f]: Toggle full-screen display
- [j]: Jump back 10 seconds in the current video
- [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 point 10% into the video, 2 jumps to the point 20% into the video, and so forth.
enablejsapi
Setting the parameter's value to 1 enables the player to be controlled via IFrame Player API calls. The default value is 0, which means that the player cannot be controlled using that API.

For more information on the IFrame API and how to use it, see the IFrame API documentation.
end
This parameter specifies the time, measured in seconds from the start of the video, when the player should stop playing the video. The parameter value is a positive integer.

Note that the time is measured from the beginning of the video and not from either the value of the start player parameter or the startSeconds parameter, which is used in YouTube Player API functions for loading or queueing a video.
fs
Setting this parameter to 0 prevents the fullscreen button from displaying in the player. The default value is 1, which causes the fullscreen button to display.
hl
Sets the player's interface language. The parameter value is an ISO 639-1 two-letter language code or a fully specified locale. For example, fr and fr-ca are both valid values. Other language input codes, such as IETF language tags (BCP 47) might also be handled properly.

The interface language is used for tooltips in the player and also affects the default caption track. Note that YouTube might select a different caption track language for a particular user based on the user's individual language preferences and the availability of caption tracks.
iv_load_policy
Setting the parameter's value to 1 causes video annotations to be shown by default, whereas setting to 3 causes video annotations to not be shown by default. The default value is 1.
list
The list parameter, in conjunction with the listType parameter, identifies the content that will load in the player.
- If the listType parameter value is user_uploads, then the list parameter value identifies the YouTube channel whose uploaded videos will be loaded.
- If the listType parameter value is playlist, then the list parameter value specifies a YouTube playlist ID. In the parameter value, you need to prepend the playlist ID with the letters PL as shown in the example below.
  https://www.youtube.com/embed?
  listType=playlist
  &list=PLC77007E23FF423C6
- If the listType parameter value is search, then the list parameter value specifies the search query. Note: This functionality is deprecated and will no longer be supported as of 15 November 2020.
Note: If you specify values for the list and listType parameters, the IFrame embed URL does not need to specify a video ID.

listType
The listType parameter, in conjunction with the list parameter, identifies the content that will load in the player. Valid parameter values are playlist and user_uploads.

If you specify values for the list and listType parameters, the IFrame embed URL does not need to specify a video ID.

Note: A third parameter value, search, has been deprecated and will no longer be supported as of 15 November 2020.
loop
In the case of a single video player, a setting of 1 causes the player to play the initial video again and again. In the case of a playlist player (or custom player), the player plays the entire playlist and then starts again at the first video.

Supported values are 0 and 1, and the default value is 0.

Note: This parameter has limited support in IFrame embeds. To loop a single video, set the loop parameter value to 1 and set the playlist parameter value to the same video ID already specified in the Player API URL:
https://www.youtube.com/embed/VIDEO_ID?playlist=VIDEO_ID&loop=1
modestbranding
This parameter lets you use a YouTube player that does not show a YouTube logo. Set the parameter value to 1 to prevent the YouTube logo from displaying in the control bar. Note that a small YouTube text label will still display in the upper-right corner of a paused video when the user's mouse pointer hovers over the player.
origin
This parameter provides an extra security measure for the IFrame API and is only supported for IFrame embeds. If you are using the IFrame API, which means you are setting the enablejsapi parameter value to 1, you should always specify your domain as the origin parameter value.
playlist
This parameter specifies a comma-separated list of video IDs to play. If you specify a value, the first video that plays will be the VIDEO_ID specified in the URL path, and the videos specified in the playlist parameter will play thereafter.
playsinline
This parameter controls whether videos play inline or fullscreen on iOS. Valid values are:
- 0: Results in fullscreen playback. This is currently the default value, though the default is subject to change.
- 1: Results in inline playback for mobile browsers and for WebViews created with the allowsInlineMediaPlayback property set to YES.
rel
Note: This parameter is changing on or after September 25, 2018.

Prior to the change, this parameter indicates whether the player should show related videos when playback of the initial video ends.
- If the parameter's value is set to 1, which is the default value, then the player does show related videos.
- If the parameter's value is set to 0, then the player does not show related videos.
After the change, you will not be able to disable related videos. Instead, if the rel parameter is set to 0, related videos will come from the same channel as the video that was just played.
start
This parameter causes the player to begin playing the video at the given number of seconds from the start of the video. The parameter value is a positive integer. Note that similar to the seekTo function, the player will look for the closest keyframe to the time you specify. This means that sometimes the play head may seek to just before the requested time, usually no more than around two seconds.
widget_referrer
This parameter identifies the URL where the player is embedded. This value is used in YouTube Analytics reporting when the YouTube player is embedded in a widget, and that widget is then embedded in a web page or application. In that scenario, the origin parameter identifies the widget provider's domain, but YouTube Analytics should not identify the widget provider as the actual traffic source. Instead, YouTube Analytics uses the widget_referrer parameter value to identify the domain associated with the traffic source.
Revision history
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 YouTubes 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

Top List Top

Autoplay YouTube

Overview

Embed a player using the IFrame Player API

Select content to play

Supported parameters

autoplay

cc_lang_pref

cc_load_policy

color

controls

disablekb

enablejsapi

end

fs

hl

iv_load_policy

list

listType

loop

modestbranding

origin

playlist

playsinline

rel

start

widget_referrer

Revision history

April 27, 2021

October 15, 2020

October 13, 2020

August 23, 2018

August 16, 2018

September 15, 2017

June 12, 2017

November 1, 2016

October 20, 2016

August 11, 2016

December 18, 2015

August 19, 2015

March 9, 2015

October 14, 2014

July 18, 2014

January 28, 2014

May 10, 2013

July 20, 2012

June 5, 2012

May 4, 2012

May 3, 2012

March 29, 2012

August 11, 2011

June 8, 2011

February 14, 2011

February 3, 2011

Bài Viết Liên Quan

Quảng Cáo

Có thể bạn quan tâm

Toplist được quan tâm

Quảng cáo

Xem Nhiều

Quảng cáo

Chúng tôi

Điều khoản

Trợ giúp

Mạng xã hội