YouTube Player API Reference for iframe Embeds

IFrame Player API 可讓您在網站上嵌入 YouTube 影片播放器，並使用 JavaScript 控制播放器。

您可以使用 API 的 JavaScript 函式，將影片排入播放佇列、播放、暫停或停止影片、調整播放器音量，或擷取正在播放的影片相關資訊。您也可以新增事件監聽器，在特定播放器事件 (例如播放器狀態變更) 發生時執行。

本指南說明如何使用 IFrame API。這份文件會說明 API 可傳送的不同類型事件，並說明如何撰寫事件監聽器來回應這些事件。並詳細說明您可以呼叫哪些 JavaScript 函式來控制影片播放器，以及可用來進一步自訂播放器的播放器參數。

需求條件

使用者的瀏覽器必須支援 HTML5 postMessage 功能。大多數現代瀏覽器都支援 postMessage。

嵌入式播放器的可視區域大小至少須為 200 x 200 像素。如果播放器顯示控制項，則必須足夠大，才能完整顯示控制項，且不會縮小檢視區，使其小於最小尺寸。建議 16:9 播放器的寬度至少為 480 像素，高度至少為 270 像素。

任何使用 IFrame API 的網頁都必須實作下列 JavaScript 函式：

  • onYouTubeIframeAPIReady：當網頁完成下載播放器 API 的 JavaScript 時，API 就會呼叫這個函式，讓您可以在網頁上使用 API。因此，這個函式可能會在網頁載入時建立您要顯示的播放器物件。

開始使用

以下 HTML 範例網頁會建立內嵌播放器，該播放器會載入影片、播放六秒，然後停止播放。範例下方的清單說明瞭 HTML 中的編號註解。

<!DOCTYPE html>
<html>
  <body>
    <!-- 1. The <iframe> (and video player) will replace this <div> tag. -->
    <div id="player"></div>

    <script>
      // 2. This code loads the IFrame Player API code asynchronously.
      var tag = document.createElement('script');

      tag.src = "https://www.youtube.com/iframe_api";
      var firstScriptTag = document.getElementsByTagName('script')[0];
      firstScriptTag.parentNode.insertBefore(tag, firstScriptTag);

      // 3. This function creates an <iframe> (and YouTube player)
      //    after the API code downloads.
      var player;
      function onYouTubeIframeAPIReady() {
        player = new YT.Player('player', {
          height: '390',
          width: '640',
          videoId: 'M7lc1UVf-VE',
          playerVars: {
            'playsinline': 1
          },
          events: {
            'onReady': onPlayerReady,
            'onStateChange': onPlayerStateChange
          }
        });
      }

      // 4. The API will call this function when the video player is ready.
      function onPlayerReady(event) {
        event.target.playVideo();
      }

      // 5. The API calls this function when the player's state changes.
      //    The function indicates that when playing a video (state=1),
      //    the player should play for six seconds and then stop.
      var done = false;
      function onPlayerStateChange(event) {
        if (event.data == YT.PlayerState.PLAYING && !done) {
          setTimeout(stopVideo, 6000);
          done = true;
        }
      }
      function stopVideo() {
        player.stopVideo();
      }
    </script>
  </body>
</html>

下列清單提供上述範例的詳細資訊：

  1. 本節中的

    標記會指出 IFrame API 在網頁上放置影片播放器的位置。如「載入影片播放器」一節所述，播放器物件的建構函式會根據 id 標示
    標記，確保 API 將

    本範例使用以下程式碼：

    <iframe id="existing-iframe-example"
        width="640" height="360"
        src="https://www.youtube.com/embed/M7lc1UVf-VE?enablejsapi=1"
        frameborder="0"
        style="border: solid 4px #37474F"
></iframe>

<script type="text/javascript">
  var tag = document.createElement('script');
  tag.id = 'iframe-demo';
  tag.src = 'https://www.youtube.com/iframe_api';
  var firstScriptTag = document.getElementsByTagName('script')[0];
  firstScriptTag.parentNode.insertBefore(tag, firstScriptTag);

  var player;
  function onYouTubeIframeAPIReady() {
    player = new YT.Player('existing-iframe-example', {
        events: {
          'onReady': onPlayerReady,
          'onStateChange': onPlayerStateChange
        }
    });
  }
  function onPlayerReady(event) {
    document.getElementById('existing-iframe-example').style.borderColor = '#FF6D00';
  }
  function changeBorderColor(playerStatus) {
    var color;
    if (playerStatus == -1) {
      color = "#37474F"; // unstarted = gray
    } else if (playerStatus == 0) {
      color = "#FFFF00"; // ended = yellow
    } else if (playerStatus == 1) {
      color = "#33691E"; // playing = green
    } else if (playerStatus == 2) {
      color = "#DD2C00"; // paused = red
    } else if (playerStatus == 3) {
      color = "#AA00FF"; // buffering = purple
    } else if (playerStatus == 5) {
      color = "#FF6DOO"; // video cued = orange
    }
    if (color) {
      document.getElementById('existing-iframe-example').style.borderColor = color;
    }
  }
  function onPlayerStateChange(event) {
    changeBorderColor(event.data);
  }
</script>

  2. 示例 2：播放音量過大

    這個範例會建立 1280 x 720 像素的影片播放器。onReady 事件的事件監聽器接著會呼叫 setVolume 函式，將音量調到最高設定。

    function onYouTubeIframeAPIReady() {
  var player;
  player = new YT.Player('player', {
    width: 1280,
    height: 720,
    videoId: 'M7lc1UVf-VE',
    events: {
      'onReady': onPlayerReady,
      'onStateChange': onPlayerStateChange,
      'onError': onPlayerError
    }
  });
}

function onPlayerReady(event) {
  event.target.setVolume(100);
  event.target.playVideo();
}

  3. 範例 3： 這個範例會設定播放器參數，讓系統在影片載入時自動播放影片，並隱藏影片播放器的控制項。並為 API 廣播的多個事件新增事件監聽器。

    function onYouTubeIframeAPIReady() {
  var player;
  player = new YT.Player('player', {
    videoId: 'M7lc1UVf-VE',
    playerVars: { 'autoplay': 1, 'controls': 0 },
    events: {
      'onReady': onPlayerReady,
      'onStateChange': onPlayerStateChange,
      'onError': onPlayerError
    }
  });
}

    4. 控制 360 度影片

    本範例使用以下程式碼：

    <style>
  .current-values {
    color: #666;
    font-size: 12px;
  }
</style>
<!-- The player is inserted in the following div element -->
<div id="spherical-video-player"></div>

<!-- Display spherical property values and enable user to update them. -->
<table style="border: 0; width: 640px;">
  <tr style="background: #fff;">
    <td>
      <label for="yaw-property">yaw: </label>
      <input type="text" id="yaw-property" style="width: 80px"><br>
      <div id="yaw-current-value" class="current-values"> </div>
    </td>
    <td>
      <label for="pitch-property">pitch: </label>
      <input type="text" id="pitch-property" style="width: 80px"><br>
      <div id="pitch-current-value" class="current-values"> </div>
    </td>
    <td>
      <label for="roll-property">roll: </label>
      <input type="text" id="roll-property" style="width: 80px"><br>
      <div id="roll-current-value" class="current-values"> </div>
    </td>
    <td>
      <label for="fov-property">fov: </label>
      <input type="text" id="fov-property" style="width: 80px"><br>
      <div id="fov-current-value" class="current-values"> </div>
    </td>
    <td style="vertical-align: bottom;">
      <button id="spherical-properties-button">Update properties</button>
    </td>
  </tr>
</table>

<script type="text/javascript">
  var tag = document.createElement('script');
  tag.id = 'iframe-demo';
  tag.src = 'https://www.youtube.com/iframe_api';
  var firstScriptTag = document.getElementsByTagName('script')[0];
  firstScriptTag.parentNode.insertBefore(tag, firstScriptTag);

  var PROPERTIES = ['yaw', 'pitch', 'roll', 'fov'];
  var updateButton = document.getElementById('spherical-properties-button');

  // Create the YouTube Player.
  var ytplayer;
  function onYouTubeIframeAPIReady() {
    ytplayer = new YT.Player('spherical-video-player', {
        height: '360',
        width: '640',
        videoId: 'FAtdv94yzp4',
    });
  }

  // Don't display current spherical settings because there aren't any.
  function hideCurrentSettings() {
    for (var p = 0; p < PROPERTIES.length; p++) {
      document.getElementById(PROPERTIES[p] + '-current-value').innerHTML = '';
    }
  }

  // Retrieve current spherical property values from the API and display them.
  function updateSetting() {
    if (!ytplayer || !ytplayer.getSphericalProperties) {
      hideCurrentSettings();
    } else {
      let newSettings = ytplayer.getSphericalProperties();
      if (Object.keys(newSettings).length === 0) {
        hideCurrentSettings();
      } else {
        for (var p = 0; p < PROPERTIES.length; p++) {
          if (newSettings.hasOwnProperty(PROPERTIES[p])) {
            currentValueNode = document.getElementById(PROPERTIES[p] +
                                                       '-current-value');
            currentValueNode.innerHTML = ('current: ' +
                newSettings[PROPERTIES[p]].toFixed(4));
          }
        }
      }
    }
    requestAnimationFrame(updateSetting);
  }
  updateSetting();

  // Call the API to update spherical property values.
  updateButton.onclick = function() {
    var sphericalProperties = {};
    for (var p = 0; p < PROPERTIES.length; p++) {
      var propertyInput = document.getElementById(PROPERTIES[p] + '-property');
      sphericalProperties[PROPERTIES[p]] = parseFloat(propertyInput.value);
    }
    ytplayer.setSphericalProperties(sphericalProperties);
  }
</script>

    Android WebView Media Integrity API 整合

    YouTube 已擴充 Android WebView Media Integrity API，讓嵌入式媒體播放器 (包括 Android 應用程式中嵌入的 YouTube 播放器) 能夠驗證嵌入式應用程式的真實性。這項變更後，嵌入的應用程式會自動將已認證的應用程式 ID 傳送至 YouTube。透過使用這個 API 收集的資料包括應用程式中繼資料 (套件名稱、版本編號和簽署憑證)，以及 Google Play 服務產生的裝置認證權杖。

    這項資料會用於驗證應用程式和裝置的完整性。系統會對這類資料進行加密，並在固定的保留期限過後刪除，不會與第三方分享。應用程式開發人員可以在 WebView Media Integrity API 中設定應用程式身分。設定支援選擇不採用選項。

    修訂版本記錄

    June 24, 2024

    The documentation has been updated to note that YouTube has extended the Android WebView Media Integrity API to enable embedded media players, including YouTube player embeds in Android applications, to verify the embedding app's authenticity. With this change, embedding apps automatically send an attested app ID to YouTube.

    November 20, 2023

    The new onAutoplayBlocked event API is now available. This event notifies your application if the browser blocks autoplay or scripted playback. Verification of autoplay success or failure is an established paradigm for HTMLMediaElements, and the onAutoplayBlocked event now provides similar functionality for the IFrame Player API.

    April 27, 2021

    The Getting Started and Loading a Video Player sections have been updated to include examples of using a playerVars object to customize the player.

    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 IFrame Player API's queueing functions for lists, cuePlaylist and loadPlaylist.

    This change will become effective on or after 15 November 2020. After that time, calls to the cuePlaylist or loadPlaylist functions that set the listType property to search will generate a 4xx response code, such as 404 (Not Found) or 410 (Gone). This change also affects the list property for those functions as that property no longer supports the ability to specify a search query.

    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.

    October 24, 2019

    The documentation has been updated to reflect the fact that the API no longer supports functions for setting or retrieving playback quality. As explained in this YouTube Help Center article, to give you the best viewing experience, YouTube adjusts the quality of your video stream based on your viewing conditions.

    The changes explained below have been in effect for more than one year. This update merely aligns the documentation with current functionality:

    • The getPlaybackQuality, setPlaybackQuality, and getAvailableQualityLevels functions are no longer supported. In particular, calls to setPlaybackQuality will be no-op functions, meaning they will not actually have any impact on the viewer's playback experience.
    • The queueing functions for videos and playlists -- cueVideoById, loadVideoById, etc. -- no longer support the suggestedQuality argument. Similarly, if you call those functions using object syntax, the suggestedQuality field is no longer supported. If suggestedQuality is specified, it will be ignored when the request is handled. It will not generate any warnings or errors.
    • The onPlaybackQualityChange event is still supported and might signal a change in the viewer's playback environment. See the Help Center article referenced above for more information about factors that affect playback conditions or that might cause the event to fire.

    May 16, 2018

    The API now supports features that allow users (or embedders) to control the viewing perspective for 360° videos:

    • The getSphericalProperties function retrieves the current orientation for the video playback. The orientation includes the following data:
      • yaw - represents the horizontal angle of the view in degrees, which reflects the extent to which the user turns the view to face further left or right
      • pitch - represents the vertical angle of the view in degrees, which reflects the extent to which the user adjusts the view to look up or down
      • roll - represents the rotational angle (clockwise or counterclockwise) of the view in degrees.
      • fov - represents the field-of-view of the view in degrees, which reflects the extent to which the user zooms in or out on the video.
    • The setSphericalProperties function modifies the view to match the submitted property values. In addition to the orientation values described above, this function supports a Boolean field that indicates whether the IFrame embed should respond to DeviceOrientationEvents on supported mobile devices.

    This example demonstrates and lets you test these new features.

    June 19, 2017

    This update contains the following changes:

    • Documentation for the YouTube Flash Player API and YouTube JavaScript Player API has been removed and redirected to this document. The deprecation announcement for the Flash and JavaScript players was made on January 27, 2015. If you haven't done so already, please migrate your applications to use IFrame embeds and the IFrame Player API.

    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.

    June 29, 2016

    This update contains the following changes:

    • The documentation has been corrected to note that the onApiChange method provides access to the captions module and not the cc module.

    June 24, 2016

    The Examples section has been updated to include an example that demonstrates how to use the API with an existing tag since the onYouTubeIframeAPIReady function is only called if the closing element is present.

    August 6, 2012

    This update contains the following changes:

    • The Operations section has been expanded to list all of the supported API functions rather than linking to the JavaScript Player API Reference for that list.

    • The API supports several new functions and one new event that can be used to control the video playback speed:

      • Functions

        • getAvailablePlaybackRates – Retrieve the supported playback rates for the cued or playing video. Note that variable playback rates are currently only supported in the HTML5 player.
        • getPlaybackRate – Retrieve the playback rate for the cued or playing video.
        • setPlaybackRate – Set the playback rate for the cued or playing video.

      • Events

    July 19, 2012

    This update contains the following changes:

    • The new getVideoLoadedFraction method replaces the now-deprecated getVideoBytesLoaded and getVideoBytesTotal methods. The new method returns the percentage of the video that the player shows as buffered.

    • The onError event may now return an error code of 5, which indicates that the requested content cannot be played in an HTML5 player or another error related to the HTML5 player has occurred.

    • The Requirements section has been updated to indicate that any web page using the IFrame API must also implement the onYouTubeIframeAPIReady function. Previously, the section indicated that the required function was named onYouTubePlayerAPIReady. Code samples throughout the document have also been updated to use the new name.

      Note: To ensure that this change does not break existing implementations, both names will work. If, for some reason, your page has an onYouTubeIframeAPIReady function and an onYouTubePlayerAPIReady function, both functions will be called, and the onYouTubeIframeAPIReady function will be called first.

    • The code sample in the Getting started section has been updated to reflect that the URL for the IFrame Player API code has changed to http://www.youtube.com/iframe_api. To ensure that this change does not affect existing implementations, the old URL (http://www.youtube.com/player_api) will continue to work.

    July 16, 2012

    This update contains the following changes:

    • The Operations section now explains that the API supports the setSize() and destroy() methods. The setSize() method sets the size in pixels of the