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.

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.

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.

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.

This parameter indicates whether the video player controls are displayed:

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:

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.

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 methods for loading or queueing a video.

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.

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.

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.

The list parameter, in conjunction with the listType parameter, identifies the content that will load in the player.

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.

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.

This parameter allows you to use a YouTube player that does not display the YouTube logo. Set the parameter value to 1 to prevent the YouTube logo from being displayed in the control bar. However, a small YouTube text label will appear in the top right corner of a paused video when the user hovers over the player.

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.

To ensure secure communication between your website and the YouTube Player API, you need to specify the domain of your website as an origin parameter in the iframe embed URL.

Determine the exact domain (including the protocol, http:// or https://) where your YouTube player will be embedded. For example: https://yourwebsite.com.

Why is this important?

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.

This parameter controls whether videos play inline or fullscreen on iOS. Valid values are:

Prior to the change, this parameter indicates whether the player should show related videos when playback of the initial video ends.

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.

If you set the parameter value to 0, information such as the video title or the name of the uploader will not be displayed in the player before the video starts playing.

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 method, 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.

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.

Plays the currently cued/loaded video. The final player state after this method executes will be playing (1).

Pauses the currently playing video. The final player state after this method executes will be paused (2) unless the player is in the ended (0) state when the method is called, in which case the player state will not change.

Stops and cancels loading of the current video. This method should be reserved for rare situations when you know that the user will not be watching additional video in the player. If your intent is to pause the video, you should just call the pauseVideo method. If you want to change the video that the player is playing, you can call one of the queueing methods without calling stopVideo first.

Seeks to a specified time in the video. If the player is paused when the method is called, it will remain paused. If the method is called from another state (playing, video cued, etc.), the player will play the video.

The player will advance to the closest keyframe before that time unless the player has already downloaded the portion of the video to which the user is seeking. * The allowSeekAhead parameter determines whether the player will make a new request to the server if the seconds parameter specifies a time outside of the currently buffered video data.

It is recommendend that you set this parameter to false while the user drags the mouse along a video progress bar and then set it to true when the user releases the mouse. This approach lets a user scroll to different points of a video without requesting new video streams by scrolling past unbuffered points in the video. When the user releases the mouse button, the player advances to the desired point in the video and requests a new video stream if necessary.

The getPlaybackQuality(), setPlaybackQuality(), and getAvailableQualityLevels() methods are no longer supported (October 24, 2019). In particular, calls to setPlaybackQuality() will be no-op functions, meaning they will not actually have any impact on the viewer’s playback experience.

Fugit fuga est aperiam vel rerum aut maxime. Consequatur vero non sed. Et quibusdam saepe labore iusto accusamus blanditiis quibusdam aliquam aliquam ipsam. Alias dolores quasi eos omnis similique illum molestiae est veritatis nihil aspernatur. Reprehenderit ullam quo qui facere facilis sapiente.

Officiis delectus aut et quia vero. Excepturi dignissimos nihil aspernatur rerum. Illo reprehenderit reiciendis maxime voluptas aut est aperiam. Natus accusamus qui facere eum ut sed minus. Maiores voluptatum enim beatae.

Et voluptatem et qui perspiciatis qui. Et cum est repellat unde ipsa cumque qui et et alias natus. Consequatur hic officia et sit cupiditate earum aut rerum doloribus nostrum quia earum quo iste. Vel laboriosam sequi reprehenderit odio et laborum ut accusamus. Id voluptatem corporis vel culpa exercitationem dignissimos libero sunt.

Ut consequatur eius culpa officia vero maiores exercitationem. Eaque nobis labore et quo delectus blanditiis suscipit dolorum sequi nihil ex recusandae nihil. Laudantium laboriosam quod voluptatem. Voluptatum quasi non esse sint et nulla et ut sint quibusdam. Aliquid est consequatur doloremque minus voluptatem accusamus ab porro facere quibusdam.

Deserunt optio voluptates omnis saepe asperiores suscipit nulla modi doloremque sunt fugiat deleniti vitae saepe. Totam facere deserunt similique minima ipsum similique quaerat iure quibusdam ut. Similique et qui voluptas voluptatum atque minima laudantium cum laborum quis veniam. Magni est quod ex harum sint culpa et id voluptatem aut doloribus iste voluptas commodi. Perferendis officiis quibusdam excepturi nisi optio modi similique.

Hic voluptas ratione nam excepturi sed consequuntur commodi nulla eius sunt. Ipsa quia consequatur aperiam eum doloribus et illum quia excepturi unde quis voluptas sapiente. Ut error quisquam sunt vero sunt est quas. Consequatur nisi alias et dolor molestiae non quo quos. Sint laudantium eum aliquam dolorem enim labore voluptatem quas.

Aut ut quam est molestiae et iusto nihil ut aspernatur dolor vero. Eveniet deleniti eveniet aut delectus assumenda. Sapiente ut et illum et rerum ex. Aperiam ab ratione est eaque numquam voluptatem sit. Non saepe qui dolorem.

Sapiente quia corporis nihil blanditiis et natus optio molestiae sint esse. Id unde cumque molestiae beatae ea aperiam ipsam quas doloribus. Unde quia voluptatibus nisi commodi minus dolorum velit possimus nihil harum quibusdam eius. Et placeat est inventore quod. Incidunt facilis minus dolorem aut hic laudantium impedit odio asperiores est.

This event fires whenever a player has finished loading and is ready to begin receiving API calls. Your application should implement this method if you want to automatically execute certain operations, such as playing the video or displaying information about the video, as soon as the player is ready.

The example below shows a sample method for handling this event. The event object that the API passes to the method has a target property, which identifies the player. The method retrieves the embed code for the currently loaded video, starts to play the video, and displays the embed code in the page element that has an id value of embed-code.

This event fires whenever the player’s state changes. The data property of the event object that the API passes to your event listener method will specify an integer that corresponds to the new player state. Possible values are:

When the player first loads a video, it will broadcast an unstarted (-1) event. When a video is cued and ready to play, the player will broadcast a video cued (5) event. In your code, you can specify the integer values or you can use one of the following namespaced variables:

This event fires whenever the video playback quality changes. It might signal a change in the viewer’s playback environment. See the YouTube Help Center for more information about factors that affect playback conditions or that might cause the event to fire.

The data property value of the event object that the API passes to the event listener method will be a string that identifies the new playback quality. Possible values are:

This event fires whenever the video playback rate changes. For example, if you call the setPlaybackRate(suggestedRate) method, this event will fire if the playback rate actually changes. Your application should respond to the event and should not assume that the playback rate will automatically change when the setPlaybackRate(suggestedRate) method is called. Similarly, your code should not assume that the video playback rate will only change as a result of an explicit call to setPlaybackRate.

The data property value of the event object that the API passes to the event listener method will be a number that identifies the new playback rate. The getAvailablePlaybackRates method returns a list of the valid playback rates for the currently cued or playing video.

This event fires if an error occurs in the player. The API will pass an event object to the event listener method. That object’s data property will specify an integer that identifies the type of error that occurred.

Possible values are:

This event is fired to indicate that the player has loaded (or unloaded) a module with exposed API methods. Your application can listen for this event and then poll the player to determine which options are exposed for the recently loaded module. Your application can then retrieve or update the existing settings for those options.

The following command retrieves an array of module names for which you can set player options:

Currently, the only module that you can set options for is the captions module, which handles closed captioning in the player. Upon receiving an onApiChange event, your application can use the following command to determine which options can be set for the captions module:

By polling the player with this command, you can confirm that the options you want to access are, indeed, accessible. The following commands retrieve and update module options:

The table below lists the options that the API supports:

This event fires any time the browser blocks autoplay or scripted video playback features, collectively referred to as "autoplay". This includes playback attempted with any of the following player APIs:

Most browsers have policies that can block autoplay in desktop, mobile, and other environments if certain conditions are true. Instances where this policy may be triggered include unmuted playback without user interaction, or when a Permissions Policy to permit autoplay on a cross-origin iframe has not been set.

For complete details, refer to browser-specific policies (Apple Safari / Webkit, Google Chrome, Mozilla Firefox) and Mozilla’s autoplay guide.

Loud playback. This example creates a 1280px by 720px video player. The event listener for the onReady event then calls the setVolume method to adjust the volume to the highest setting.

This example sets player parameters to automatically play the video when it loads and to hide the video player’s controls. It also adds event listeners for several events that the API broadcasts.