This document provides reference information for the YouTube JavaScript player API.

Contents

Overview

The JavaScript API allows users to control the YouTube embedded video players via JavaScript. Calls can be made to play, pause, seek to a certain time in a video, set the volume, mute the player, and other useful functions.

Requirements

The end user must have Flash Player 8 or higher installed to view everything correctly. Because of this requirement, we suggest using SWFObject to embed the SWF and detect the user's Flash Player version.

Getting Started

Note: To test any of these calls, you must have your file running on a webserver, as the Flash player restricts calls between local files and the internet.

To enable the JavaScript API, you must pass the URL parameter enablejsapi=1 in the URL of the player you wish to control. For example, you'd want to use the following URL to embed the SWF.

http://www.youtube.com/v/VIDEO_ID&enablejsapi=1

This enables the JavaScript API handlers in the player, and also tells the player to alert the containing HTML page via a callback when the player is loaded and ready to receive JavaScript calls. When the player is ready, the JavaScript function onYouTubePlayerReady will be called.

You may optionally pass in a playerapiid parameter, which will identify the player when the onYouTubePlayerReady callback is invoked. Whatever value is passed in as playerapiid will be passed back to onYouTubePlayerReady as the first argument.

http://www.youtube.com/v/VIDEO_ID&enablejsapi=1&playerapiid=ytplayer

See the examples below for more detailed information about how to embed a YouTube player SWF into your page.

Operations

In order to call the player API methods, you must first get a reference to the player object you wish to control. This can be done by calling getElementById() on the object or embed tag containing the player SWF if using SWFObject to embed the player SWF.

Functions

player.playVideo():Void

Plays the currently cued/loaded video.

player.pauseVideo():Void

Pauses the currently playing video.

player.stopVideo():Void

Stops the current video. This also closes the NetStream object and cancels the loading of the video. Once stopVideo() is called, a video cannot be resumed without reloading the player or loading a new video (chromeless player only). When calling stopVideo(), the player will first broadcast an end event (0), followed by an unstarted event (-1).

player.clearVideo():Void

Clears the video display. Useful if you want to clear the video remnant after calling stopVideo().

player.getVideoBytesLoaded():Number

Returns the number of bytes loaded for the current video.

player.getVideoBytesTotal():Number

Returns the size in bytes of the currently loaded/playing video.

player.getVideoStartBytes():Number

Returns the number of bytes the video file started loading from. Example scenario: the user seeks ahead to a point that hasn't loaded yet, and the player makes a new request to play a segment of the video that hasn't loaded yet.

player.mute():Void

Mutes the player.

player.unMute():Void

Unmutes the player.

player.isMuted():Boolean

Returns true if the player is muted, false if not.

player.setVolume(volume):Void

Sets the volume. Accepts an integer between 0-100.

player.getVolume():Void

Returns the player's current volume, an integer between 0-100. Note that getVolume() will return the volume even if the player is muted.

player.seekTo(seconds, allowSeekAhead):Void

Seeks to the specified time of the video in seconds. The allowSeekAhead determines whether or not the player will make a new request to the server if seconds is beyond the currently loaded video data. Note that seekTo() will look for the closest keyframe before the seconds specified. This means that sometimes the play head may seek to just before the requested time, usually no more than ~2 seconds.

player.getPlayerState():Number

Returns the state of the player. Possible values are unstarted (-1), ended (0), playing (1), paused (2), buffering (3), video cued (5).

player.getCurrentTime():Number

Returns the current time in seconds of the current video.

player.getDuration():Number

Returns the duration in seconds of the currently playing video. Note that getDuration() will return 0 until the video's metadata is loaded, which normally happens just after the video starts playing.

player.addEventListener(event, listener):Void

Adds a listener function for the specified event.

player.setSize(newWidth, newHeight):Void

Sets the size in pixels of the player.

player.getVideoUrl():String

Returns the YouTube.com URL for the currently loaded/playing video.

player.getVideoEmbedCode():String

Returns the embed code for the currently loaded/playing video.

Events

onStateChange

Fired whenever the player's state changes. Possible values are unstarted (-1), ended (0), playing (1), paused (2), buffering (3), video cued (5). When the SWF is first loaded, it will broadcast an unstarted (-1) event. When the video is cued and ready to play, it will broadcast a video cued event (5).

onError

Fired when an error in the player occurs. Currently there is only one error code, which is 100 for "Video not found." This occurs when a video has been removed (for any reason), or it has been marked as private or non-embeddable by the user.

Special Events

onYouTubePlayerReady(playerid)

Called when the player is fully loaded and the API is ready to receive calls. If a playerapiid is passed into the player via URL arguments, then it will be passed to this function. This function must be implemented in the HTML page containing the YouTube player.

Examples

Embedding the YouTube player using SWFObject

We recommend using SWFObject to embed any players that will be accessed using the JavaScript API. This will allow you to detect the end user's Flash Player version (the JavaScript API requires Flash Player 8 or higher), and also will get rid of the 'Click to activate this control' box when using Internet Explorer to view the player. To enabled the API in the SWF, you must pass in the parameter enablejsapi=1.

See below for an example of using the script to embed a YouTube player with the JavaScript API enabled, and with a playerapiid of ytplayer.

  <script type="text/javascript" src="swfobject.js"></script>    
  <div id="ytapiplayer">
    You need Flash player 8+ and JavaScript enabled to view this video.
  </div>

  <script type="text/javascript">

    var params = { allowScriptAccess: "always" };
    var atts = { id: "myytplayer" };
    swfobject.embedSWF("http://www.youtube.com/v/VIDEO_ID&enablejsapi=1&playerapiid=ytplayer", 
                       "ytapiplayer", "425", "356", "8", null, null, params, atts);

  </script>

The allowScriptAccess parameter in the code is needed to allow the player SWF to call functions on the containing HTML page, since the player is hosted on a different domain from the HTML page.

The only attribute we're passing in is the id of the embed object — in this case, myytplayer. This id is what we'll use to get a reference to the player using getElementById().

swfobject.embedSWF will load the player from YouTube and embed it onto your page.

swfobject.embedSWF(swfUrlStr, replaceElemIdStr, widthStr, heightStr, swfVersionStr, xiSwfUrlStr, flashvarsObj, parObj, attObj)

• swfUrlStr - This is the URL of the SWF. Note that we have appended the enablejsapi and playerapiid parameters to the normal YouTube SWF URL to enable JavaScript API calls.
• replaceElemIdStr - This is the HTML DIV id to replace with the embed content. In the example above, it is ytapiplayer.
• widthStr - Width of the player.
• heightStr - Height of the player.
• swfVersionStr - The minimum required version for the user to see the content. In this case, version 8 or above is needed. If the user does not have 8 or above, they will see the default line of text in the HTML DIV.
• xiSwfUrlStr - (Optional) Specifies the URL of your express install SWF. Not used in this example.
• flashVarsObj - (Optional) Specifies your FlashVars in name:value pairs. Not used in this example.
• parObj - (Optional) The parameters for the embed object. In this case, we've set allowScriptAccess.
• AttObj - (Optional) The attributes for the embed object. In this case, we've set the id to myytplayer.

See the SWFObject documentation for further explanation.

Getting the Player Reference

Once the player is ready, it wil call onYouTubePlayerReady.

To get the reference to the player, use getElementById(). Once you have the object, you can start making calls to the API.

    function onYouTubePlayerReady(playerId) {
      ytplayer = document.getElementById("myytplayer");
    }

Issuing Calls

You can now call functions using the player reference. For example, if you wanted to play the video when a user clicked a link, it would look like this:

function play() {
  if (ytplayer) {
    ytplayer.playVideo();
  }
}

<a href="javascript:void(0);" onclick="play();">Play</a>

Or simply,

 <a href="javascript:ytplayer.playVideo()">Play</a> 

Subscribing to Events

Subscribe to events by adding an event listener to the player reference. For example, to get notified when the player's state changes, add an event listener for onStateChange and include a callback function.

function onYouTubePlayerReady(playerId) {
  ytplayer = document.getElementById("myytplayer");
  ytplayer.addEventListener("onStateChange", "onytplayerStateChange");
}

function onytplayerStateChange(newState) {
   alert("Player's new state: " + newState);
}

Here is a simple example displaying much of the functionality. View the source to see what's going on under the hood.

Back to top